Data sharing utilities
data_sync
Synchronizes copies of objects at remote sites with the latest version of the primary object. It also updates publication records when republishing objects. In verify mode, the utility checks the existence of exported objects at the remote sites; if a copy no longer exists at the remote site, the corresponding import export record is deleted from the owning site. The behavior of this utility is controlled by the TC_force_remote_sites_exclude_files preference. If this preference is set to true, the replica files stored in the remote site file server cache (FSC), otherwise the replica files are store in the remote system volume. The data_sync utility uses import export records (IXRs) and publication audit records (PARs), which are attached to the primary copy of an object, to determine whether or not to synchronize a copy or the publication record in the ODS. These records contain information on when the object was last sent to a particular site or last published to an ODS. It then compares these dates with the object's last-modified date and decides whether or not to synchronize the object. Thus, only those objects that were modified since the last successful run of the utility are updated. When updating multiple sites and not all sites are operational, the data_sync utility updates the sites that are available but remembers, using the IXRs and the PARs, which ones were unavailable so they can be updated next time. Once the utility determines which objects and sites to synchronize, it uses the basic Multi-Site Collaboration mechanisms (export, import, IDSM, and ODS) to accomplish its task. For this reason, Siemens Digital Industries Software recommends that the data_sync utility be run in batch mode during off hours so that it does not compete for computing and network resources during business hours. The utility also supports TC XML transfers for 4th Generation Design (4GD) data. The 4GD relation data mapping is controlled by the TC_cms_relation_optset_map preference. You use this preference when you want to control the relations that are included or excluded when a 4GD object is replicated. The data_sync utility supports part family templates and members. It also supports organization classes, specifically, Role, User, Group, and Person classes. Siemens Digital Industries Software recommends the following practices when using the data_sync utility. The term one at a time means one command line invocation. This implies that your script for running data_sync consists of several lines invoking the data_sync utility. Synchronize one site at a time and use the default revision selector of -same_as_last_export. This allows you to use the Smart Sync capability which synchronizes only the revisions and attachments that the remote user specified when replicating an item. Synchronize one class at a time starting with the largest unit, which is Item, and down to the smallest units such as Dataset and Form. Always use the -since switch with the -class switch. This results in improved memory efficiency because replicated objects that have not been modified for some time are excluded from the initial search for objects to be synchronized. Ideally, the date given to the -since switch should be the exact date and time of the last successful run of data_sync. However, if you are not sure about the date and time, use a date and time that you know is prior to the last successful run. When dealing with thousands of objects, data_sync tends to slow down as it loads more and more objects in memory. It handles this problem by cascading its work over several sub-processes. When the original process reaches its batch size, it starts another process and then terminates itself; the sub-process continues where its parent process left off. When it reaches its own batch size, it creates another sub-process, and so on. The optimum batch size varies for each installation depending primarily on the memory (both main memory and virtual memory), so you must determine the optimum batch size for your installation. One tool that can help you do this is the use of the -log switch that records all significant events in the data_sync log file, the file with the .log extension. By analyzing the log file, you can detect at what point data_sync begins to slow down so you can then adjust the batch size accordingly. Note that the use of the -log switch itself can affect the overall efficiency of data_sync so you should turn off the switch once you have determined your optimum batch size. The synchronization process can put a heavy load on the network and the systems so data_sync should be scheduled during non-busy hours such as nights and weekends. Typically, you should run the synchronization script as a cron job to be started at night. It is not necessary to have a separate verify run before synchronization because data_sync always performs a verification before synchronization. View a separate verification run as a cleanup procedure and run it only when the network and the systems are not busy, such as on weekends. Do not use the -disable_modified_only switch unless there is a known problem with the default synchronize modified objects only mode. If you typically share whole assemblies with a site, it is best to use the -filename switch to synchronize specific assemblies and use the -include_bom switch to synchronize any modified components. Note that you may have to use the -force switch in the event the item itself was not modified but you want to synchronize modified components. The behavior of the utility for project relationships on replica objects can be controlled by the TC_sync_projects_with_owning_site preference. This preference is not created by the Teamcenter installation process. To change the default behavior of shared project relationships, you must create the preference. Avoid out-of-memory errors To avoid possible out-of-memory errors when you are replicating architecture revisions, Siemens Digital Industries Software recommends you exclude MEApperancePathNode (APN) objects by setting the following environment variable: Copy TC_EXCLUDE_APN=TRUE This excludes APN objects from the synchronization. It may also exclude associated object, such as JT for promoted and deformed bodies. You can synchronize the APN objects by using the sync_product_apns utility. If you do not set this environment variable, or you set its value to FALSE, you can use the batch feature of this utility to overcome memory limitations when synchronizing large numbers of APNs. For example, you may specify: Copy -batch_objects=MEAppearancePathNode -batch_size=5000 When setting the batch size, consider the number of APNs generated by your business processes and the amount of memory available on your system. Syntax data_sync [-u=user-name {-p=password | -pf=password-file} -g=group] {-class=class-name [-filename=file-name | -itemKeyFile=file-name] | -item_id=template | -key=keyAttr1=keyVal1 [,keyAttr2=keyVal2…,keyAttrN=keyValN]} [-OnlyVIS] {-site=site-name -sync | -republish | -verify} [-f=sync | republish | verify] [-status] [-commit_ixr] [-cleanup_transaction [-transaction_id=transaction-id | -before_last_process_date=date ] | list_transactions] [-pull] [-update] [-replacement_site=site-replacing-extinct-site] [-stubs_only] [-sync_file_stubs] [-force] [-report[=file-name] [-format[=CSV] [-separator[="|" | ","]]]] [-exclude_files] [-disable_modified_only] [-exclude=relation-type1 -exclude=relation-type2...] [-exclude_security_update] [-include=relation-type1 -include=relation-type2...] [-include_bom] [-classoffile=class-name] [-revision-selector] [-latest_ds_version] [-assert_extinct_ods] [-assert_extinct_site] [-exclude_folder_contents] [-since=YYYY-MM-DD:HH:NN] [-qry_name=query-name -qry_attr=attr-name1 -qry_val=attr-value1[-qry_attr=attr-name2 -qry_val=attr-value2...]] [-batch_size=number-of-objects-per-batch] [-deferred_batch_size=batch-size-for-deferred-objects] [-batch_objects=list-of-deferred-classes] [-batch_file=file-name-listing-deferred-classes] [-nonbulk] [-verbose] [-log] [-checkpoint [-compress_ind_files={S | I | N} ] ] [-transaction_id] [-restart] [-optionset | -optionset=optionset-name [-de_incl_rlz_bom] [-workset_include_relz_de] [-4gd_id=object-id -class=4gd-class-name] ] [-include_4gd_baseline_content] [-override_options=option1:value1,option2:value2, ...] [-session_options=option1:value1,option2:value2, ...] [-bp] [-h] Arguments Entries in parentheses are accepted abbreviations for arguments. -u Specifies the user ID. This is generally a user with administration privileges. 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. Caution For HTTP enabled sites, remote site operations log on using the default group for the user supplied with the -u argument. Any value supplied with the -g argument is ignored. -pull Specifies synchronization starts in pull mode, that is, from a replica site. For 4GD objects, you must specify the -optionset argument. This causes the utility to pull the data as a TC XML payload. -class Specifies the class of objects to be searched to determine what objects need synchronization. This does not mean that all objects of the given class are synchronized; only those that were modified since the last time they were exported to the given site(s) are synchronized. See restrictions 1 and 2. -filename (fn) Specifies the name of the input file containing IDs or names of objects to update. See restriction 1. -itemKeyFile Specifies the name of the input file containing the list of item key strings of the items you want to update. The following listing shows sample content of a file for updating a list of items: Copy item_id=export_001
item_id=M2Item1_001,object_name=M2Item_name1,object_type=M2Item1 If the item key file has 4GD object key strings, the corresponding 4GD class must be supplied using the -classoffile(cof)= argument. The following listing shows sample content of a file for updating 4GD data: Copy 4gd_id=DE_Export_001
4gd_id=DE00001_ID,object_name=DE00001_Name,object_desc=DE00001_Desc The 4g_id entry maps to the corresponding unique ID of the 4GD class, for example: Copy Class=Cpd0DesignElement, 4gd_id=cpd0_design_element_id -item_id (item) Specifies the ID or template of items to update. See restriction 1. -key Specifies the item keys of the items to update, the template of the item keys, or the 4GD object key. It is mutually exclusive with the -item_id argument. Use the following format: Copy [keyAttr1=keyVal1] [,keyAttr2=keyVal2]…[,keyAttrN=keyValN] To find the key of an object, use the get_key_string utility. -OnlyVIS Specifies synchronization of only visualization datasets attached directly or indirectly to a replicated item revision with status. See restriction 8. If you use the -OnlyVIS argument, the -batch_size value defaults to 500. -f Specifies the function to be performed; define one of the following functions: sync Initiates the update process. See restrictions 2 and 4. republish (repub) Republishes objects that have been modified since last published. See restriction 2. verify (veri) Note Siemens Digital Industries Software recommends that you always use the -item_id=* argument with the verify function. If you use the -class=item argument with the verify function, it processes only the items that have been modified after their last export. When used with the -update argument, deletes the IXRs of objects for which replicas do not exist at the remote sites. When used without the -update argument, generates a report. See restriction 2. The report returns the following verification verdict codes: 0 Object does not exist. 1 Object exists as a primary copy. 2 Object exists as a replica. 3 Object was replaced by a POM stub. status (stat) Displays the status of a given transaction ID. If the -site argument is given, only status of the given sites is displayed. If no -site argument is given, the status returned depends on whether the command is given at the site that initiated the checkpointed transaction or the site is the receiving end of the transaction. If the command is given at the initiating site and no -site argument is given, the status of the local site and all target sites is returned. commit_ixr (cmi) Updates the export records at the owning site once the data is known to have been successfully imported at a target site. Under normal conditions, the update of the export records are performed automatically by each subprocess that succeeds in completing the send operation to its assigned site. Use this function only if either of the following conditions occur: The failure occurs at the importing site, and the user performs the restart using the item_import utility. The failure occurs after the data is successfully imported by a target site, but a failure occurs just before or during the updating of the export records. You must use at least one -site argument to identify the site or sites for which export records are to be updated. You must execute this function at a node or host that has direct access to the transfer area where the export was performed (if at initiating site) or where the data was transmitted to by the owning site (if at receiving site). You must also have read access to the operating system directory where the export data is placed within the transfer area. If these conditions are not met, an error message is displayed to stdout and the utility returns a nonzero value. cleanup_transaction (ct) Removes transient data generated during a checkpoint transaction or fast sync transactions if used with the -optionset argument. For checkpoint transactions, this transient data consists of the export data and supporting directories and files used to manage the transaction. You must execute this function at a node or host that has direct access to the transfer area where the export was performed (if at initiating site) or where the data was transmitted to by the owning site (if at receiving site). You must also have delete access to the operating system directory where the export data is placed within the transfer area. If these conditions are not met, an error message is displayed to stdout and the utility returns a nonzero value. For fast sync transactions, you must specify either the -transaction_id or -before_last_process_date argument. -before_last_process_date (blpd) Specifies the date used to determine which fast sync transactions to clean up. The date must be supplied in the following format: Copy YYYY-MM-DD:HH:NN:SS YYYY represents the four-digit year value. MM represents the two-digit month value. DD represents the two-digit day of the month. HH represents a two-digit hour value from 0 to 23. NN represents a two-digit minute value from 0 to 59 and SS represents a two-digit second value from 0 to 59. The DD:HH:NN:SS are optional. If they are not specified, the utility uses 12:00 AM of the specified date. Valid only with the -cleanup_transaction argument. list_transactions (lt) Lists all uncleaned checkpoint transactions. An uncleaned transaction is one in which its transient data has not been deleted from the transfer area using the cleanup_transaction function. Active transactions can only be detected at the site that initiated it. The receiving end of a transaction is not able to tell if a transaction is active or not. The list of inactive transactions initiated by the local site and the list of transactions initiated by remote sites are based only on the contents of the transfer area of the node where this command is executed. The list of active transactions initiated by the local site is always complete because it is based on data stored in the local database. You must execute this function at a node or host that has direct access to the transfer area where the export was performed (if at initiating site) or where the data was transmitted to by the owning site (if at receiving site). You must also have read access to the operating system directory where the export data is placed within the transfer area. If these conditions are not met, an appropriate error message is displayed to stdout and the utility returns a nonzero value. -assert_extinct_ods (aeo) Deletes all publication audit record (PAR) objects from the local database for an ODS that no longer exists. This removes any record about objects previously published to the ODS and makes it possible to delete the published objects at a later time. Only the -site and -login switches are required. This is valid only with the -f=verify argument. See restriction 5. -assert_extinct_site (aes) Deletes all import export record (IXR) objects from the local database for a site that no longer exists. This removes any record of objects previously exported to the site and makes it possible to delete the exported objects at a later time. Only the -site and -login arguments are required. This is valid only with the -f=verify argument. See restriction 5. -replacement_site (rs) Specifies the name of the site that replaces the site to be extinct. This argument is valid only with the -assert_extinct_site argument. All objects owned by the extinct site are redirected to the replacement site. -stubs_only Specifies that stubs are processed only when the -replacement_site argument is specified. This argument is valid only with the -assert_extinct_site argument. -sync_file_stubs Processes dataset files excluded from export and updates remote stubs if needed. This argument is valid only when the -class=ImanFile argument is specified. -update (upd) Performs a database update. Must be given in order for the -f=sync, -f=republish, or -f=verify to occur; otherwise, it only does a dry run and generates a report. See restriction 4. -report Generates a synchronization report. If a file name is not supplied, the report is displayed in a shell. When published to a file, the default format is as a comma-delimited .csv file. To use a pipe (|) as a separator, include -format and -separator = "|". For example, Copy data_sync -u=tcadmin -p=password -item_id=iteamA012 -sync -optionset -update -site=site2 -report=report.csv -format=CSV -separator="|" -site Specifies the Teamcenter site to update. This argument can be used multiple times in the command line to synchronize with multiple name-identified sites. -exclude_files (exf) Excludes dataset files. See restriction 6. -exclude Excludes the specified relation type. This argument may be given multiple times and must use the database name (not the display name) of the relation type. See restriction 6.6. For best TC XML performance, use a closure rule for relation instead of include/exclude. -exclude_security_update Excludes items with only changed project or license security data. When these items are not required to be synchronized, excluding them can significantly improve synchronization performance. Items with other changes in addition to project or license security data changes will be synchronized. -include Includes the specified relation type. This argument may be given multiple times and must use the database name (not the display name) of the relation type. Use this argument to force the inclusion of a relation type that may have been excluded during the last export. For best TC XML performance, use a closure rule for relation instead of include/exclude. -exclude_folder_contents (efc) Excludes the contents of a folder. Intended for use with NX part families where family members are stored in a folder that is related to the item. -include_bom (bom) Synchronizes all components of an assembly. This synchronization includes any newly added components to the existing assembly. See restriction 6. -disable_modified_only (dmo) Disables the default behavior of synchronizing subobjects inside an item only if they were modified since the last time the item was exported. Normally, this argument is not used. See restriction 6. -revision-selector Valid only if both the -f=sync and -update arguments are specified. Choose one of the following revision selectors: -all_revisions Synchronizes all revisions. -latest_revision Synchronizes only the latest revision, regardless of the release status. This is the default if no revision selector is specified and more than one site is to be synchronized. If synchronizing only one site, the default selector is same_as_last_export. -latest_working Synchronizes only the latest working (unreleased) revision. -latest_released Synchronizes only the latest released revision with any release status. -latest_working_or_any Synchronizes the latest working revision; if no working revision, synchronizes the latest released revision of any release status. -release_status = release-status-type Synchronizes only the latest released revision with the specified release status type. -all_released_revs Synchronizes all revisions with a release status including in-process item revisions. -same_as_last_export Synchronizes using the options used the last time the item was exported. This is the default if no revision selector is specified and only one site is being synchronized. If synchronizing multiple sites, the default selector is latest_revision. -include_pfmembers Identifies the related part family members to be exported when handling part family templates. -include_pftemplates Identifies the related part family template to be exported when handling part family members. -pf_bom_treatment Identifies the part family objects associated with the assemblies to be exported. The argument must be used in conjunction with the -include_bom argument. Valid arguments are: -members Includes part family member components present in the assembly. -templates Includes part family template rather than part family member components. -all Includes both the part family member components and templates. -none Includes neither the part family member components nor the templates. -latest_ds_version (ldv) Synchronizes only the latest version of datasets. See restriction 6. -force Synchronizes objects regardless of whether they were modified since the last time they were exported. See restriction 3. -since Synchronizes only those objects modified since the specified date and time, which must be specified in YYYY-MM-DD:HH:NN format, where YYYY is the year; MM is the month number from 1 to 12; DD is the day from 1 to 31; HH is the hour from 0 to 23, and NN is the minute from 0 to 59. HH and NN are optional and default to zero, which indicates 12 a.m. of the given date. This is valid only with the -class argument. -verbose Displays maximum amount of information when the utility is run in verbose mode. Typically, nonverbose utility sessions only display error messages. Do not abbreviate this argument to -v. -log Places detailed information in the data_sync.log file. The information includes the start and ending time for each step performed by the data_sync utility. Use this argument to analyze the performance of the utility. -checkpoint (cp) Initiates a checkpoint transaction, that is, a transaction that can be restarted at the point of failing. This argument is valid only when both -f=sync and -update are specified. If specified without the -update argument, this argument is ignored. Valid only with -f=sync. If a noncheckpoint operation is initiated for multiple target sites and some target sites are not currently available based on a preliminary availability check, Teamcenter sends a message to stdout to notify the user about unavailable sites, removes unavailable sites from the target site list, and then performs the operation for the available sites. compress_ind_files (cif) Specifies compression mode to use to compress files in the export directory during a checkpoint transaction. If not specified, creates a single large ZIP file. This argument is valid only with the -checkpoint argument. Valid values are: S Creates a single large ZIP file. I Creates a ZIP file for each individual file, resulting in multiple ZIP files. N No files are compressed. -transaction_id (trid) Specifies a 14-character transaction ID for a given checkpoint-related operation or fast sync transaction. -optionset Sends the data using the TC XML functionality. This method provides better performance for large data transfers and must be used when exporting 4GD data. You can replicate 4GD objects to a remote site when you specify the -optionset argument with the send function. Optionally specify the transfer option set used for the export by setting -optionset to the set name. If you do not specify an option set, the utility uses MultiSiteOptSet as the default transfer option set value. Values of the options listed in the option set govern the object export. The option set must exist at the exporting site. For 4GD objects, you can also specify the -de_incl_rlz_bom and -workset_incl_relz_de arguments. -de_incl_rlz_bom Sends the source objects of a design element (Type:Cpd0DesignElement). You must specify the -optionset argument and specify a 4GD object using the -4gd_id, -key, or -itemKeyFile argument. -workset_incl_relz_de Sends the source objects of a design element (Cpd0DesignElement) in a Workset (Cpd0Workset). You must specify the -optionset argument and specify a 4GD object using the -4gd_id, -key, or -itemKeyFile argument. -4gd_id Specifies a 4GD object identifier or 4GD object pattern. The -class=class-name argument must be specified with the -4gd_id argument. The utility maps the -4gd_id argument to the corresponding unique ID of the 4GD class, for example: Copy Class=Cpd0DesignElement, 4gd_id=cpd0design_element_id A 4GD partition object and 4GD subset definition objects do not have a unique 4GD class ID. Therefore, using -4gd_id for partition objects or subset definition objects may result in the update of multiple objects To export unique partition object use multifield key attributes supplied in the -key argument, see Examples. -restart (rs) Restarts a given transaction at the point of failure. Valid only with the -f=send function. -qry-name Runs a saved Query Builder that defines the list of objects to process. One or more -qry_attr and -qry_val pairs specify the attribute value pairs the objects must match to be processed. -batch_objects (bo) Specifies a list of comma-separated deferred classes. The list must not contain spaces. -batch_file (bof) Specifies the file name of a text file containing a list of deferred classes. Each class name is contained on a separate line. -batch_size (bs) Specifies the number of objects to synchronize per batch. A new process is created for each batch. All workspace objects (not just items) that are synchronized are considered part of a batch. The default batch size is 2000. The maximum value you can specify is 99999. If you enter a value greater than 99999, the utility sets the value of -batch_size to the default. To process items one item at a time, use the -non-bulk argument. -deferred_batch_size (dbs) Specifies the number of objects per batch; a new process is created per batch. The default value is 2000. This value must be a positive integer. Use this argument to process thousands of objects to avoid memory and disk shortage problems. The following classes are supported for deferred objects: Dataset Folder Form ImanRelation MEAppearancePathNode NamedVariantExpression PSOccurrence VariantExpression VariantExpressionBlock -nonbulk Process one object at a time when synchronizing a list of objects. By default, data_sync runs with -batch_size set to a value of 2000. Overriding this default operation with -nonbulk may result in slower performance, but can aid debugging when researching batch synchronization issues. -override_options Override the following default operations by setting the following values to true. (The default value of each is false.) Options and values are separated by colons. Multiple overrides are separated by commas. opt_exclude_apn When syncing BOM structures, set to true to exclude APNs from being synchronized. opt_include_rendering Set to true to include the rendering dataset in the synced data. opt_include_ice When syncing EngChange lists, set to true to sync IncrementalChangeElement items. opt_exp_all_wso Set to true to sync secondary objects for all relations. Use with care as this may result in a very large amount of data being synchronized. -session_options Override the following default session operations by setting the following values to true. (The default value of each is false.) Options and values are separated by colons. Multiple overrides are separated by commas. forceUpdateOnImport Set to true to force an update during a sync if a replica's last saved date (lsd) value or last modified date (lmd) value is greater than the primary object's value. opt_traverse_by_island Set to true to sync only an island of data. Do not sync across islands. -bp Displays best practices information. -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 One of the following arguments must be supplied: -class, -filename, or -item_id. One of the following arguments must be supplied: -f=sync, -republish, or -f=verify. The -force argument can only be used along with the -filename or the -item_id argument. It does not function when used in combination with the -f=verify argument. Unless the -update argument is given, the data_sync utility generates only reports. The -assert_extinct_site and -assert_extinct_ods options can only be used with the -f=verify argument. The -exclude_files, -exclude=, -include_bom, -disable_modified_only and -latest_ds_version options can be used if both the -f=sync and -update arguments are supplied. The -classoffile argument currently supports only the Item, ItemRevision, Dataset, Form, Folder, Role, User, Group, and Person classes. The -include and -update arguments must be supplied with the -OnlyVIS switch. To use this utility, you must be a user with system administration privileges or be granted authorization by a user with system administration privileges. For 4GD data, traversal-free synchronization is not supported in pull mode. All arguments supported for push mode with the -optionset argument are supported in pull mode. Examples Required log-in information is omitted from the following examples. To generate a report of items that must be synchronized for a given site: Copy data_sync -class=Item -site=Site1 -f=sync The report is output to stdout. No synchronization is performed. To synchronize all items copied to a site and output a report to a file: Copy data_sync -class=Item -site=Site1 -f=sync -update -report=report.lst (The default revision selector, -same_as_last_export, is used.) To synchronize the latest released revisions of items: Copy data_sync -class=Item -site=Site1 -f=sync -update -latest_released To synchronize all forms and datasets: Copy data_sync -class=Form -class=Dataset -site=Site1 -f=sync -update To republish all previously published items to the Mfg_ODS ODS: Copy data_sync -class=Item -site=Mfg_ODS, -f=republish -update To check if datasets copied to the Design_Center site still exist and delete the IXR from the primary if a copy is no longer there: Copy data_sync -class=Dataset -site=Design_Center -f=verify -update To force synchronization of a list of items specified in a text file copied to a site and output the report to a file: Copy data_sync -filename="/myhome/itemlist.txt" -classoffile=Item
-site=Site1 -f=sync -update -force -report=report.lst To force synchronization of a single item or items that match a template: Copy data_sync -item_id=Eng* -site=Site1 -f=sync -update -force
-report=rep.lst To synchronize an out-of-date 4GD design element and output the report to a file: Copy data_sync -4gd_id=Ste2_DE0486 -class=Cpd0DesignElement
-site=Site1 -optionset -sync -update -report=4GD_update_rep.txt To destroy all the export records to a known extinct site: Copy data_sync -u=Tc-admin-user -p=password -g=group -site=XSite -f=verify
-update -assert_extinct_site To destroy all the publication records to a known extinct ODS site: Copy data_sync -u=Tc-admin-user -p=password -g=group -site=XSite -f=verify
-assert_extinct_ods To destroy export records, BVRs, and attachments of specific deleted replica item revisions: Copy data_sync -site=S1 -f=verify -update -fn=mylist -cof=ItemRevision The mylist file has item revision names in the following format: item123/A To destroy export records of specific deleted replica datasets: Copy data_sync -site=S1 -f=verify -update -filename=mylist
-classoffile=Dataset The mylist file has dataset names in the following format: dataset123 To start synchronization in pull mode: Copy data_sync -pull -class=Item -site=S1 -update -report=report.lst To force synchronize a list of items specified in a text file in pull mode: Copy data_sync -pull -filename="/myhome/itemlist.txt" -force
-update -report=report.lst To generate a report of which items must be synchronized in pull mode: Copy data_sync -pull -filename="/myhome/itemlist.txt" -site=S1
-f=sync -report=report.lst Include the rendering dataset and IncrementalChangeElement items in the synchronized data: Copy data_sync -sync -update -site=site2 -item_id=xxxx
-override_options=opt_incl_rendering:true,opt_include_ice:true Force updating of the data on the import site even though the last saved dates are the same for the primary and replica: Copy data_sync -sync -update -site=site2 -item_id=xxxx
-session_options=ForceUpdateOnImport:true To synchronize visualization datasets that are under a replicated item revision that has status: Copy data_sync -OnlyVIS -since=2005-01-01:01:01 -site=Site1 -f=sync -update -report=report.lst -include=IMAN_Rendering -include=IMAN_specification To check if items copied to the Design_Center site still exist and delete the IXR from the primary if a copy is no longer there, enter the following command on a single line: Copy data_sync -item_id=* -site=Design_Center -f=verify -update To delete the IXRs of objects whose replicas do not exist at the remote sites, enter the following command on a single line: Copy data_sync -item_id=* -site=Site1 -f=verify -update -report=rep.lst To generate a report of the IXRs, enter the following command on a single line: Copy data_sync -item_id=* -site=Site1 -f=verify -report=rep.lst Both this and the previous example generate reports listing all objects including those that are no longer at the remote site. To synchronize all items copied to a site and output a report to a file with newly added components to existing assembly: Copy data_sync -class=Item -site=Site1 -f=sync -update -include_bom -report=report.rpt To synchronize any particular item transferred to a replica site and output a report to a file with newly added components to existing assembly: Copy data_sync -u=Tc-admin-user -p=password -g=group -item_id=Item1 -site=Site1 -f=sync -update -include_bom -report=report.rpt To synchronize all imanfile objects copied to a site and output a report to a file: Copy data_sync -class=imanfile -site=Site1 -f=sync -update -report=report.lst To force synchronization of imanfile objects for all datasets specified in a text file copied to a site and output the report to a file: Copy data_sync -filename=/myhome/datasetlist-for-imanfiles.txt
-classoffile=imanfile -site=Site1 -f=sync -update -report=report.lst To synchronize files and initiate a checkpoint for three sites: Copy data_sync -f=sync -checkpoint -item_id=item123
-site=Site2 -site=Site3 -site=Site4 -update To force synchronization of files and initiate a checkpoint for three sites: Copy data_sync -f=sync -update -checkpoint -item_id=item123
-site=Site2 -site=Site3 -site=Site4 To check the status of a given transaction: Copy data_sync -f=status -transaction_id=AhEZaOnRAAAMfD To restart a given transaction for a given site: Copy data_sync -f=sync -transaction_id=AhEZaOnRAAAMfD
-restart -site=Site3 To synchronize all 4th Generation Design (4GD) objects copied to a site and output report to a file: Copy data_sync -class=Cpd0DesignElement -site=Site1
-sync -update -report=report.lst To synchronize specific 4GD objects copied to a site and output report to a file: Copy data_sync -4gd_id=DE000001 -class=Cpd0DesignElement
-site=Site1 -sync -update -report=report.lst To clean up fast sync transactions prior to specific last process date, list the available transactions to get the last process dates: Copy data_sync -optionset -lt Clean up the transactions: Copy data_sync -optionset -ct -blpd=2012-12-18:20:10:00 To synchronize MEAppearancePathNode and VariantExpression objects in batch mode with deferred_batch_size: Copy data_sync -item_id=
DS_0401_02A 1997-04-03 15:13:50 Detroit 1997-04-03 12:47:45 Text (Dataset) DS_0401_02A;1 1997-04-03 15:13:40 Detroit 1997-04-03 12:47:48 Text (Dataset) DS_0401_02A;2 1997-04-03 15:13:43 Detroit 1997-04-03 12:47:52 Text (Dataset) 0320_01/A 1997-03-24 15:34:44 Detroit 1997-03-24 15:33:57 Text (Dataset) 0320_01/A;1 1997-03-24 15:34:33 Detroit 1997-03-24 15:34:00 Text (Dataset) 0320_01/A;2 1997-03-24 15:34:38 Detroit 1997-03-24 15:34:04 Text (Dataset) 0320_01/A;3 1997-03-24 15:34:42 Detroit 1997-03-24 15:34:06 Text (Dataset) sueD0324-4;1 1997-03-24 22:04:44 Detroit 1997-03-24 21:57:28 Text (Dataset) sueD0324-4;2 1997-03-24 22:04:48 Detroit 1997-03-24 21:57:32 Text (Dataset) Error Codes Error code 100228 indicates that a Multi-Site Collaboration file transfer operation has failed. The most likely causes are a network connection failure or an abort (crash) of the IDSM process at the remote site. For the former, retry the operation. For the latter, examine the IDSM system log files at the remote site. 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/data_sync.html · retrieved Fri Jul 31 2026 00:00:00 GMT+0000 (Coordinated Universal Time)