admin_data_export

Exports administration data to a file. You can use the file to import the data to another site, such as from a test or upgrade environment into a production environment. You can also use the file to compare data between two sites. You can alternatively perform full or partial export of administration data using TEM. Syntax admin_data_export -u=user-ID {-p=password | -pf=password-file} -g=group {-adminDataTypes=data-type1, data-type2,...,data-typeN | all} {-outputPackage=absolute-path-file-name} [-inputCriteria= {attr1=value1,attr2=value2,...,attrN=valueN}] [-listTypes] [-session_options=option1:value1,option2:value2:...] [-h] Arguments -u Specifies the user ID. The user must have administrative privileges. If this argument is used without a value, the operating system user name is used. If Security Services single sign-on (SSO) is enabled for your server, the -u and -p arguments are authenticated externally through SSO rather than being authenticated against the Teamcenter database. If you do not supply these arguments, the utility attempts to join an existing SSO session. If no session is found, you are prompted to enter a user ID and password. -p Specifies the user password. If used without a value, the system assumes a null value. If this argument is not used, the system assumes the user-ID value to be the password. This argument is mutually exclusive with the -pf argument. -pf Specifies the password file. If used without a value, the system assumes a null value. If this argument is not used, the system assumes the user-ID value to be the password. For more information about managing password files, see Manage password files. This argument is mutually exclusive with the -p argument. -g Specifies the group associated with the user. -adminDataTypes Specifies a comma-separated list of administration data types you want to export. You can also specify the all value to export all the administration data types from the local site. -outputPackage Specifies the fully qualified path to the location for the generated export file. -inputCriteria Specifies the criteria used to generate an export file containing a partial amount of the site’s administration data. You must specify the class name of the administration data first, followed by the attributes and their values that identify the data you want to export. If you do not specify this argument, the utility does a full export of all administration data at the site. Following are some examples of input criteria. The attributes and values listed here may not match your Teamcenter data. Admin data type Selection by Class name Example attribute AccessManager Access Control List AM_ACL {ACL_Name=value} LogicalObjects Logical Object Name LogicalObjectsByName {type_name=value1,type_name=value2} Organization User User {user_name=value} Group Group {name=value} Projects Projects TC_Project {project_id=value} Preferences Preference Name PreferenceByName {preference_name=value} Group PreferencesByGroup {group_name=value} Role PreferencesByRole {role_name=value} User PreferencesByUser {user_name=value} Category PreferencesByCategory {category_name=value} RevisionRules Rule RevisionRules {object_name=Latest*} SavedQueries Query Name ImanQuery {query_name=value} Stylesheets Stylesheet Name StylesheetByDatasetName {dataset_name=value} Preference Name StylesheetByPreferenceName {preference_name=value} Subscriptions Subscription ImanSubscription {fnd0Name=val} UnitDefinitions ID UnitDefinitionsById {unit_definition_id=value} WorkflowTemplates Template Name WorkflowTemplatesByName {template_name=value} -listTypes Displays a list of administration data types that can be exported. -session_options Indicates session options that you want the utility to use for the current export. Accepts valid session option-value pairs in a comma delimited format. The option name and value are delimited with a colon. Caution If you do not supply this argument, the opt_traverse_ref_org option value is set to True and the utility skips user information updates. You must export or import organization objects (such as users and groups) before importing other objects. Otherwise, the import of other objects fails. If you supply the opt_traverse_ref_org option with the value set to False, the utility updates user object data. This may cause the user password to change at the importing site. -h Displays the help for this utility. Environment As specified in Manually configure the Teamcenter environment. Files As specified in Log files produced by Teamcenter. Restrictions This utility does not function if the ownership of 4GD replica objects is transferred to the target site. It must be run before any ownership transfers take place. Examples To export all organization, preferences, and projects administration data from a site: Copy admin_data_export -u=admin-username -p=admin-password -g=dba -adminDataTypes=Organization,Preferences,Projects -outputPackage=c:\temp\admin_data\siteA\siteA.zip To list the available administration data types: Copy admin_data_export -u=admin-username -p=admin-password -g=dba -listTypes To do a partial export of only Access Manager rules named System: Copy admin_data_export -u=admin-username -p=admin-password -g=dba -adminDataTypes=AccessManager -inputCriteria=AM_ACL{ACL_Name=System} -outputPackage=c:\temp\admin_data\export_partial_am_system.zip To do a partial export of only Workflow Templates named TCM Release Process: Copy admin_data_export -u=admin-username -p=admin-password -g=dba -adminDataTypes=WorkflowTemplates -inputCriteria="WorkflowTemplatesByName{template_name=TCM Release Process}" -outputPackage=c:\temp\admin_data\export_partial_wftemplate_release.zip To export Access Manager rules with referenced organization data: Copy admin_data_export -u=admin-username -p=admin-password -g=dba -adminDataTypes=AccessManager -session_options=opt_traverse_ref_org:false -outputPackage=c:\temp\admin_data\export_partial_am_system.zip To perform a partial export of organization data, pass the input criteria and session options, with the -opt_traverse_ref_org option value set to False. Example 1 To export the user whose user name is PLMUser: Copy admin_data_export -u=admin-username -p=admin-password -g=dba -adminDataTypes=Organization -outputPackage=C:\Temp\OrganizationPR_User.zip -inputCriteria=User{user_name=PLMUser} -session_options=opt_traverse_ref_org:false Example 2 To export the group having the name PLM: Copy admin_data_export -u=admin-username -p=admin-password -g=dba -adminDataTypes=Organization -outputPackage=C:\Temp\OrganizationPR_Group.zip -inputCriteria=Group{name=PLM} -session_options=opt_traverse_ref_org:false Related Topics TC XML and PLM XML Configuration for Data Import and Export Multi-Site Collaboration