Data sharing utilities
migrate_organization
Allows you to create a global organization for your Multi-Site environment. Organization objects that have been duplicated across multiple sites can be changed to replicas of an owning organization site. You use the utility first to identify duplicate objects between two sites. After identifying objects that must be made replicas, use the utility make the identified duplicate objects replicas of the owning organization site objects. Caution You must follow the process for migrating organization objects to successfully create your global organization. The order that you migrate objects, indicated in the process, must be followed to avoid errors when using this utility. You must run this utility at the owning site only; you can migrate objects to only one site at a time. Note You must set the IDSM_global_dsa_sites_permitted_to_push_admin_data preference using this utility. The effort required to roll back undesired changes is not trivial if this preference is not set correctly. Syntax migrate_organization [-u=user-id {-p=password | -pf=password-file} -g=group] {-f=compare_organization -report=report-file-name | make_replica} { [-user_id=userid1,userid2, … | -role_name=rolename1,rolename2, … | -group_name=group1,group2, … | -person_name=person1,person2, …] | [-classoffile=class-name -filename=input-file ] } {-site=remote-site-name} [-h] Arguments -u Specifies the user ID. This is a user with Teamcenter administration privileges. Note 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 password. This argument is mutually exclusive with the -pf argument. -pf Specifies the password file. 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. If used without a value, the user's default group is assumed. -f Specifies the name of the function. Following functions are valid: compare_organization Identifies the duplicate and missing organization objects at the remote site (specified by -site argument) and the current site. The remote site is specified using the -site argument and the output is written to the file specified by the -report argument. make_replica Makes the object specified by the -user_id, -group_name, -role_name, or -person_name argument replica objects at the target (remote) site. This command must be used only at the site that is intended to be the owning site for organization objects. One class of object must be specified but only one class can be in a command. Alternatively, the -classoffile and -file_name arguments can be specified to use a file containing the objects to be replicated. See restriction 4. -report Specifies the file name of the report generated by the compare_organization function. -user_id Specifies an ID of a user to change to a replica object at the remote site. You can specify multiple IDs separated by commas. -group_name Specifies the full name of a group to change to a replica object at the remote site. You can specify multiple group names separated by commas. -role_name Specifies the name of a role to change to a replica object at the remote site. You can specify multiple role names separated by commas. -person_name Specifies the name of a person to change to a replica object at the remote site. You can specify multiple person names separated by commas. -classoffile Specifies the class of objects contained in the input file. Valid only with the -filename argument. The -classoffile argument can specify: User The file must contain user IDs of User class objects. Role The file must contain role names of Role class objects. Group The file must contain full group names of Group class objects. Person The file must contain person names of Person class objects. --filename Specifies the name of a file that contains a list of identifiers for objects of a specified class. Valid only with the -classoffile argument. Note All objects in the file must be separated by a new line character. -site Specifies the remote site name. -h Displays help for this utility. Environment As specified in Setting up a Teamcenter command-line environment. Files As specified in Log files produced by Teamcenter. Restrictions You must set the IDSM_global_dsa_sites_permitted_to_push_admin_dat preference at the remote site specifying the sites that are allowed to push organization data to the local site. You must perform the premigration tasks described in Multi-Site Collaboration before using this utility with the make_replica function. You must perform the premigration tasks described in Multi-Site Collaboration before using this utility with the make_replica function. The make_replica function must be run only at the owning site of global organization data. To migrate a user, the related Person object must be migrated first. To migrate a role, for each associated GroupMember object, its User object must already be migrated. To migrate a group, all of the roles related to the group must be migrated first. Only a top-level group can be migrated. Specifying a sub-group fails. All sub-groups of the specified group are automatically migrated. Examples Generate a report (cvg_cgn.txt) file showing the duplicate objects between the current site and the remote site (cgn). Copy migrate_organization -u=Tc-admin-user -p=password -g=group -f=compare_organization -report=cvg_cgn.txt -site=cgn Make the users identified in the cgn_user_rpl.txt file replica objects at the remote site (cgn). Copy migrate_organization -u=Tc-admin-user -p=password -g=group -f=make_replica -file=cgn_user_rpl.txt -classoffile=User -site=cgn Make the identified group objects (ptrain_dev, frame_prod) replica objects at the remote site (cgn). Copy migrate_organization -u=Tc-admin-user -p=password -g=group -f=make_replica -group=ptrain_dev, frame_prod -site=cgn Related Topics TC XML and PLM XML Configuration for Data Import and Export Multi-Site Collaboration
Source: https://docs.sw.siemens.com/documentation/external/PL20251212545240207/en-US/tc_help/utilities_reference/avt1737253695886/migrate_organization.html · retrieved Fri Jul 31 2026 00:00:00 GMT+0000 (Coordinated Universal Time)