data_share

Used for various Multi-Site Collaboration operations, such as publishing and unpublishing objects collectively and sending objects to remote sites. It can be used as a deployment tool during the initial Multi-Site Collaboration implementation phase or as a day-to-day tool for performing functions that previously were available only through the user interface. This utility is especially helpful in setting up and maintaining a hub configuration. 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 are stored in the remote site FMS server cache (FSC); otherwise, the replica files are stored in the remote system volume. 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. The utility also supports TC XML transfers for of 4th Generation Design (4GD) data. The 4GD relation data mapping is controlled by the TC_cms_relation_optset_map preference. Use this preference when you want to control the relations that are included or excluded when replicating a 4GD object. This utility supports part family templates and part family members. Use this utility to: Mass publish objects to one or more Object Directory Services (ODS) sites. Mass unpublish objects from one or more ODS sites. Publish or unpublish an entire assembly. List ODS sites currently defined in the local database and authorized for publication. Send objects to other sites. Delete obsolete publication records at the ODS. Check current status of authorized publication sites. List ODS sites to which an object is published. Import an item from a remote site. Export 4GD data in TC XML format. Data can be input to this utility in the following forms: Input file Folder name Object ID template When sending objects to a specific user and/or group at a remote site using the -owning_user and -owning_group arguments, the following rules apply: If both the specified user and group exist at the importing site, the imported objects are owned by the user and group regardless of whether or not the user is a member of the group. If only the user is specified or if the group is specified but does not exist at the importing site, the user's default group at the importing site is the owning group of the imported objects. If only the group is specified or if the user is specified but does not exist at the importing site, the user context of the remote IDSM process is the owning user of the imported objects. Avoiding 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 export or import. It may also exclude associated object, such as JT for promoted and deformed bodies. You can replicate the APN objects 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 replicating 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_share [-u=user-id {-p=password | -pf=password-file} -g=group] -f={function} [-site=remote-site-name1 -site=remote-site-name2... ] [-owning_user=remote-user] [-owning_group=remote-group] {-item_id={item-id | template} | -folder=folder-name | -name=workspace-object | -filename=input-file | [-key=keyAttr1=keyVal1,keyAttr2=keyVal2…,keyAttrN=keyValN | -itemKeyFile=file-name] | [-itemRevisionKeysFile=file-name]} [-class=wso-class-name | -classoffile=class-name] [-include=relation-type1 -include=relation-type2...] [-exclude=relation-type1 -exclude=relation-type2...] [-revision-selector | -rev=rev-id ] [-include_bom] [-include_modified_only] [-assert_precise] [-transfer] [-attach] [-exclude_files] [-latest_ds_version] [-exclude_folder_contents] [-include_bc] [-include_supercedures] [-include_pfmembers] [-include_pftemplates] [-pf_bom_treatment=option] [-qry_name=query-name -qry_attr=attr-name1 -qry_val=attr-value1[-qry_attr=attr-name2 -qry_val=attr-value2...]] [-oaat] [-continue_on_error] [batch_size=number-objects-per-batch] [-report=report-file-name] [-user=user-id] [-group=group-name] [-error_file=error-file-name] [-exclude_variant_options] [-dir] [-mapping_rule=rule-file-name] [-batch_variant_options] [-batch_objects=class-for-deferred-objects] [-batch_file=file-name-for-deferred-objects] [-include_dist_comp] [-lightweightobject] [-log] [-checkpoint [-compress_ind_files=S | I | N] ] [-transaction_id=transaction-id] [-tcx_data_load [-migration_sync]] [-status] [-cleanup_transaction [-transaction_id=transaction-id | -before_last_process_date=date] ] [-restart] [-commit_ixr] [-list_transactions] [-optionset | -optionset=optionset-name [-de_incl_rlz_bom] [-workset_include_relz_de] [-4gd_id=object-id -class=4gd-class-name] ] [-all_roles] [-all_subgroups] [-all_groupmembers] [-include_4gd_baseline_content] [-parallelize=owner-processes,remote-processes] [-override_options=option1:value1,option2:value2, ...] [-session_options=option1:value1,option2:value2, ...] [-volume_file_list=volume_list] [-h] Arguments Entries in parentheses are accepted abbreviations for arguments. -u Specifies the user ID. This is generally a user with administration privileges. Be aware that when data_share is run by a system administrator, Has Bypass ACL is set and access control list rules are bypassed. 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. -f Specifies the function to be performed; you must specify one of the following: send Sends objects to the specified remote sites. The objects to send are determined by the -item_id, -folder, -filename, -4gd_id, -all_subgroups, -all_roles, or -all_groupmembers arguments. publish (pub) Publishes objects to the given ODS sites. The objects to publish are determined by the -item_id, -folder, or -filename arguments. Cannot be used with the -all_subgroups, -all_roles, or -all_groupmembers arguments. unpublish (unp) Unpublishes objects from the given ODS sites. The objects to unpublish are determined by the -item_id, -folder or -filename arguments. Cannot be used with the -all_subgroups, -all_roles, or -all_groupmembers arguments. delete_pubrec (dpr) Deletes obsolete publication records for the specified object from the local database. This must be run at the ODS site containing the publication record to be deleted. Only privileged users may use this function. Requires the -item_id argument with specific item ID; no wildcards or other arguments are supported with this function. Note To be used only if the primary object has been deleted but publication records still exist at the ODS site. register (reg) Registers item IDs to the central item ID registry. unregister (unreg) Unregisters item IDs from the central item ID registry. The register and unregister functions must be supplied with the -item_id or -filename argument. To unregister deleted items, you must run this utility at the central item ID registry site. delete_exprec (dxr) Deletes export records for the specified sites for objects listed in the text file identified by the -filename and -classoffile arguments. It does not traverse item structure. Only privileged users may use this function. Note To be used only as a last resort after attempting to delete export records using the -verify argument of the data_sync utility. list_ods (lo) Lists the authorized ODS sites, which consist of the default ODS site and the sites specified by the ODS_publication_sites preference. check_ods (co) Lists the availability of authorized ODS sites. list_pub_info (lpi) Lists publication information about objects. Must be run at the owning site. find_duplicates (fd) Compares all of the item IDs at the remote site specified by the -site argument. The item IDs searched for may be filtered with the -item_id, -created_before, and -created_after arguments. The output may be directed to a file using the -report argument. The output is formatted to csv style, using comma-separated values. -created_before Restricts searches for duplicate items to those created at the target site before the specified date. -created_after Restricts searches for duplicate items to those created at the target site after a specified date. remote_checkout Check out replica objects on a remote site, for example, Copy data_share –f=remote_checkout –filename=uid.txt –classoffile=Tagstring checkin_replica_co Check in replica objects on a remote site. Specify the object to check in with –rep_co_tag. Must be used with -session_options as shown in the following example. Copy data_share –f=checkin_replica_co –rep_co_tag=obj_uid –session_options=debug:true list_remote_co (lremco) Lists primary objects that are checked out by remote users based on the specified user ID, group name, and site name. If no user, group, or site is specified, all remote checkouts are listed. list_replica_co (lrepco) Lists replica objects that are checked out from a remote site based on the specified user ID, group name, and site name. If no user, group, or site is specified, all replica checkouts are listed. cancel_remote_co (cremco) Cancels all remote checkouts based on the specified user ID, group name, and site name. If no user, group, or site is specified, all remote checkouts are canceled. Note Use this argument at the owning site only. cancel_replica_co (crepco) Cancels replica checkouts based on the specified user ID, group name, and site name. Canceling a replica checkout also cancels the remote checkout at the owning site. If no user, group, or site is specified, all replica checkouts are canceled. Note Use this argument at the owning site only. remote_import (ri) Imports the item specified by the -item_id argument from the owning site or the site specified by the -site argument. If the item is a replica at the local site, it is imported from the owning site and any site specified in the command is ignored. When you specify the -optionset argument, Multi-Site uses a TC XML payload to exchange data. For 4GD data, you must specify the -optionset argument. Note Wildcard characters cannot be used in the -item_id argument. You can also use this argument to import a list of items from an input file designated by the -filename argument. The input file must contain UIDs for the items to be imported, and the -classoffile argument value must be set to Tagstring when using an input file. You can use the sync_on_demand utility to generate a file that contains UIDs of items of an assembly enclosed within square brackets ([ ]) or other designated separator. You can then write a script to collect the UIDs into the input file. The data_share arguments related to variants and line of usage (LOU) cannot be used with the remote_import argument. By default, items are processed sequentially. Use -bulk with -f=remote_import to process the items in a single operation. offline_export Exports the objects to the directory on the file system specified by -dir. -meta_file Generates only metadata files without exporting objects. Used only with offline_export and offline_import. Typically used for data migration. offline_import Used with -dir, imports the objects to the directory on the file system. -bypass_site_check Import metadata file to a site other than the original target site. Used only with offline_import. -meta_file Generates only metadata files without importing objects. Used only with offline_export and offline_import. Typically used for data migration. register_migration_data Registers the Teamcenter objects to be migrated between different Teamcenter releases. See Migrating Teamcenter data to a newer version of Teamcenter. install_http_proxy_user Installs a proxy user at the site specified with -site or update the details of the proxy user at the site specified with -site. With install_http_proxy_user, use the following arguments to specify the proxy user details: -proxy_user=proxy_user_name -proxy_group=proxy_user_group -proxy_role=proxy_user_role -proxy_user_pwd=proxy_user_password See Configure Multi-Site authentication using secondary LDAP servers configured with TcSS. remove_http_proxy_user Uninstalls the proxy user at the site specified with -site. See Configure Multi-Site authentication using secondary LDAP servers configured with TcSS. -dir Specifies the local directory in or from which objects are imported or exported. Required with -f=offline_export and -f=offline_import. -site Specifies the name of the site to which objects are published or from which they are unpublished. It can be given multiple times in a command line. -owning_user (ou) Specifies the user ID of the user at the remote sites to which the objects are sent. The specified user owns the objects being sent. See Restrictions. -owning_group (og) Specifies the name of the group at the remote sites to which the objects are sent. The group owns the objects being sent. See Restrictions. -item_id (item) Specifies the item ID or template of items to process. It is mutually exclusive with the -folder, -filename, -keyFileName, -name and -key arguments. It is required for the -delete_pubrec argument. -folder (fl) Specifies the name of a Teamcenter folder containing the list of objects to process. It is mutually exclusive with the -name, -filename, and -item_id arguments. During a remote import, if the named folder does not exist at the replica site, the utility generates an error message. If the folder is empty at the replica site, the utility does not pull any objects from the remote site. If the folder exists and has content, the objects that it contains are imported from the remote site. Note If the -include_bom argument is used with the -folder argument, only the ItemRevision objects (and objects related to them) in the folder are replicated. The folder itself is not replicated. -name Specifies the name of a single workspace object to be precessed. If not an item, use the -class argument to specify the class of the object. It is mutually exclusive with the -folder, -filename, and -item_id arguments. For organization objects, this argument accepts the following attributes: User objects require a user_ID attribute. Role objects require a role_name attribute. Group objects require the groups full name that uniquely identifies the group. Person objects require a user_name attribute. Note You can use a text file containing a list of all organization objects of the same type that you want to export using the -classoffile and -filename arguments. -filename (fn) Specifies the name of the input file containing the list of IDs or names of objects to process. File entries are treated as IDs for Items and ItemRevisions objects and as names for other classes of objects. It is mutually exclusive with the -name, -folder, -item_id, -key, -itemKeysFile, and -itemRevisionKeysFile arguments. If the input file contains names, the -classoffile argument is required. -key Specifies the keys of the items to process, 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. -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 -itemRevisionKeysFile Specifies the name of the file containing the keys of the item revisions to process. It is mutually exclusive with the -item_id argument. -class (cl) Specifies the Teamcenter class of the object specified by the -name, -key, or -4gd_id argument. This argument is valid only with the -name or, when the -optionset argument is specified, with the -4gd_id argument. The default class is Item. For organization objects, this argument accepts Role, User, Group, and Person classes. -classoffile (cof) Specifies the class of the objects listed in the input text file given with the -filename argument. If not defined, the default class is Item. It is required if the input file has names instead of IDs. For organization objects, this argument accepts Role, User, Group, and Person classes. -include Specifies a relation type to include. This can be specified multiple times in a command line. The database name (not the display name) of the relation type must be used. For best TC XML performance, use a closure rule for relation instead of include/exclude. -exclude Specifies a relation type to be excluded from the operation. This can be specified multiple times in a command line. The database name (not the display name) of the relation type must be used. The list of relation types to be included is determined by either the TC_relation_required_on_export (export without transferring ownership) or TC_relation_required_on_transfer (export with transfer of ownership) preferences. The IMAN_master_form relation cannot be used as an argument for the -exclude argument. The following relations cannot be used as an argument for the -exclude argument unless they are not included as a value in the preference for the location: IMAN_requirement IMAN_specification For best TC XML performance, use a closure rule for relation instead of include/exclude. -revision-selector Identifies the item revisions to send. It is also used as the revision rule for identifying components when processing assemblies. When used with the -include_bom argument while publishing or unpublishing, it determines which revisions' BVR to follow in traversing the assembly tree. If no revision selector is specified, the default selector is all_revisions. The valid revision selectors are as follows: all_revisions Sends all revisions. it is not valid when publishing. latest_revision Processes only the latest revision regardless of release status. This is the default if no revision selector is given when publishing or unpublishing. selected_revision Process only the selected revision. latest_working Processes only the latest working revision. latest_released Processes only the latest released revision with any release status. latest_working_or_any Sends only the latest working revision. If none, the latest released revision is processed. release_status Processes only the latest released revision with the given release status. all_released _revs Sends all revisions with a release status; it is not valid when publishing. -rev Specifies the ID of a specific item revision to be sent to a remote site. It is valid only with the -item_id argument and with the -send function, and is mutually exclusive with revision selectors. You can use the -rev and -include_bom arguments together to send a precise assembly by including the -assert_precise argument. For 4GD content, you can set this argument as -rev=baseline_rev along with the following arguments set as -4gd=baseline_id and -class=MdloBasline to select specific 4GD baseline content. -include_bom (bom) Includes assembly components when sending, publishing, or unpublishing. A revision selector is required when publishing or unpublishing an assembly; if no revision selector is given, the latest_revision selector is used as the default. When sending, the default selector is all_revisions. If not specified, this argument defaults to off. This argument does not traverse the component relationships of subassemblies. This allows you to send the subassemblies in separate transactions. Using multiple, simultaneous transactions to transfer very large assemblies and their subassemblies separately provides improved scalability and performance. Note This argument, although similar to the rich client Include Entire BOM remote export option, may not export the same set of objects. The Include Entire BOM option traverses all components, subassemblies, and subassembly component relationships that can result in unacceptable performance for very large assemblies. -include_modified_only Includes only modified item objects, resulting in improved performance. For example, if an item has revisions A and B, where B is the new revision, only revision B and its dataset are sent to the remote site. -assert_precise (ap) Specifies that the assembly is precise. The -rev and -include_bom arguments can be used together for precise assemblies only. You must include this argument to send a specific revision of an assembly to a remote site. -transfer (tf) Transfers site ownership when sending objects. Site ownership is not transferred by default. -attach (att) Attaches an object to the appropriate parent item or revision at the receiving site when sending an attachment with transfer of site ownership. Use this for situations in which you attach a dataset to a replica, such as a JT file, and you want to send the JT file to the owning site with transfer of site ownership and attached to the appropriate parent item or revision. -exclude_files (exf) Excludes dataset files. -latest_ds_version (ldv) Sends only the latest dataset version. Unless this argument is specified, all dataset versions are sent. -exclude_folder_contents (efc) Excludes the contents of folders being exported. -include_bc (ibc) Identifies the BomChange objects associated with the affected assemblies to send. If not specified, BomChange objects are not sent. -include_supercedures (isc) Identifies the supercedure objects associated with the BomChange objects to send. If not specified, supercedure objects are not sent. -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. -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. -oaat Forces the utility to process one object at a time. Normally, this utility processes all objects in a batch. If there is a failure on any top-level object, the entire batch fails. With this option, the other objects are successfully processed when one object fails. The log file indicates which object failed. The disadvantage to using this argument is the utility takes longer to process objects individually. This argument is valid only if you specify the send function. -continue_on_error (con) Specifies processing is continue if there is an error on an optional object such as a reference or manifestation. This argument is not valid when transferring site ownership. Outputs the error in a report file and continues processing the other items. The -report argument must be specified to see the error. -batch_size (bs) Specifies the number of objects per batch; a new process is created per batch. The default batch size is 1000. The value must be a positive integer. -batch_size is useful when processing thousands of objects, because it helps avoid memory and disk space shortage problems. -report (rep) Specifies to output a report to the specified file. -user Specifies the user ID. -group Specifies the group name. -error_file (err) Specifies the name of the output error report when sending assemblies. -mapping_rule Specifies the name of the .xslt file detailing the object transformation rules needed when transferring objects to a site with a different schema. You can create this .xslt file by running the plmxml_tm_edit_xsl utility with the -action=export argument on the transfer mode on which the transformation rules are attached. You can specify mapping transfer modes for Advanced Multi-Schema Exchanger to use for Multi-Site TC XML importing and exporting using the TC_tms_site_interop_transfer_mode and TC_tms_export_mapping_transfer_mode preferences. These preferences do not affect Briefcase and PLM XML importing and exporting with Advanced Multi-Schema Exchanger. -exclude_variant_options (evo) Indicates all variant options are to be excluded during a send operation. -batch_variant_options (bvo) Indicates all variant options are sent separately in batch mode. -batch_objects (bo) Indicates all objects of the given classes are sent separately in batch mode. Separate each class name with a comma. The list cannot contain spaces. The following table is a list of supported classes for this argument: Dataset ImanRelation PSOccurrence Folder MEAppearancePathNode VariantExpression Form NamedVariantExpression (Not supported by Multi-Site Collaboration.) VariantExpressionBlLock (Not supported by Multi-Site Collaboration.) -batch_file (bof) Indicates all objects of the classes in the specified file are sent separately in batch mode. List each class name separately on a line in the file. For a list of supported classes for this argument, see the table for the description of the batch_objects argument. -include_dist_comp Includes distributed components during import. This argument is valid only in conjunction with the -remote_import argument. -lightweightobject (lwo) Send the specified lightweight object unique identifier in the specified file. For example, Copy data_share –f=send –site=site2 –filename=uid.txt –classoffile=Tagstring –lwo=ImanExportRecord -log Specifies detailed log information is written to the log file. -checkpoint (cp) Initiates a checkpoint transaction; that is, a transaction that can be restarted at the point of failing. This argument is valid only with send function. It is not valid with the -transfer argument. 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, it 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 for a fast sync transaction if used with the -optionset argument. A fast sync transaction provides improved performance when synchronizing data using the data_sync utility. -tcx_data_load Improves performance by disabling Multi-Site Collaboration business logic such as AM rule checks and in-process workflow data checks. This argument is intended only for migration scenarios. Warning Use -tcx_data_load only in controlled migration scenarios. Disabling business logic in standard operation scenarios may cause unexpected changes in your data. -tcx_data_load can be used with the send, remote_import, and offline_export functions. -migration_sync Reports unsynchronized data in support of migration scenarios. Used with -tcx_data_load, for example, Copy data_share –migration_sync –tcx_data_load –since=YYYY-MM-DD:HH:NN –f=offline_export –dir=c:\outofsync -status (stat) Displays the status of a given transaction ID. If the -site switch is given, only status of the given sites are displayed. If no -site switch 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 switch is given, the status of the local site and all target sites is returned. -cleanup_transaction (ct) Removes transient data generated during a checkpoint transaction or fast synchronization transactions if used with the -optionset argument. For checkpoint transactions, the 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. -restart (rs) Restarts a given transaction at the point of failure. Valid only with the -f=send function. -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. -list_transactions (lt) Lists all uncleaned checkpoint transactions or fast sync transactions if used with the -optionset argument. 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 determine 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. -all_subgroups Exports all subgroups of the selected group. Parent groups are always exported. This argument is valid only when the -class or -classoffile argument is set to Group. -all_roles Exports all roles associated with the selected group. All roles for subgroups are included if the -all_subgroups argument is also specified. If not specified, only the default role is exported. This argument is valid only when the -class or -classoffile argument is set to Group. -all_groupmembers When exporting a User object, exports all GroupMember objects related to the selected user. When exporting groups or groups and subgroups (-all_subgroups argument), exports all GroupMember objects related to any role that is exported. You must specify one of the following arguments to use this argument: -class=User -classoffile=User -class=Group -classoffile=Group If this argument is not specified when exporting User class objects, only the default group related to the user is exported. If this argument is not specified when exporting Group class objects, no GroupMember objects are exported. -optionset Exports 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 Exports the source objects of a design element (Type:Cpd0DesignElement). You must specify a 4GD object using the -4gd_id, -key, or -itemKeyFile argument. You must specify the -optionset argument and specify a 4GD object using the -4gd_id, -key, or -itemKeyFile argument. -workset_incl_relz_de Exports the source objects of a design element (Cpd0DesignElement) in a workset (Cpd0Workset). You must specify a 4GD object using the -4gd_id, -key, or -itemKeyFile argument. 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 transfer of multiple objects. To export unique partition object use multifield key attributes supplied in the -key argument, see Examples. -parallelize Specifies that parallel processing is enabled at the owning site and remote site when replicating data. -parallelize is valid only with the -optionset and -send functions. -parallelize is not valid with -transfer. The number of additional to use processes at each site is defined by setting -parallelize to two comma-separated values. The first value specifies the number of additional processes to use at the owning site. The second value specifies the number of additional processes to use on the remote site. For example, to specify 5 additional processes on the owning site and 7 additional processes on the remote site, set -parallelize to 5,7. -parallelize supports replication to a single site. Ownership transfer is not supported. Note Be judicious when specifying the number of additional processes to use at each site. If the workstation is powerful, with unused CPU cores and RAM, using parallel processes can improve performance. However, specifying parallel processing on less powerful workstations may overtax the workstations, draining system resources. -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 exporting BOM structures, set to true to exclude APNs from being exported. opt_include_rendering Set to true to include the rendering dataset in the exported data. opt_include_ice When exporting EngChange lists, set to true to export IncrementalChangeElement items. opt_exp_all_wso Set to true to export secondary objects for all relations. Use with care as this may result in a very large amount of data being exported. -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 an import 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 export only an island of data. Do not export across islands. -volume_file_list Generates a text file listing the volume file paths associated with successfully imported or exported items. This information is particularly useful when migrating data. Used with -offline_import and -meta_file. -h Displays help for this utility. Environment As specified in Setting up a Teamcenter command-line environment. Files As specified in the Log files produced by Teamcenter. Restrictions When sending objects to a specific user and/or group at a remote site using the -owning_user and -owning_group arguments, the following rules apply: To use this utility, you must be a user with system administration privileges or be granted authorization by a user with system administration privileges. If both the specified user and group exist at the importing site, the imported objects are owned by the user and group regardless of whether or not the user is a member of the group. If only the user is specified or if the group is specified but does not exist at the importing site, the user's default group at the importing site is the owning group of the imported objects. If only the group is specified or if the user is specified but does not exist at the importing site, the user context of the remote IDSM process is the owning user of the imported objects. If variant options are excluded using the -exclude_variant_options argument, it is implied that they cannot be sent separately in batch mode. Therefore, the -exclude_variant_options argument cannot be used with either -batch_variant_options, -batch_objects=variant-expression, or with the -batch_file arguments when the given file includes the class name VariantExpression. Any number of objects can be sent separately in batch mode. Class names of objects can be given in a comma-delimited list with the -batch_objects argument or listed in a file whose name is specified in the -batch_file argument. The -item_id, -name, -filename, -folder, -key, -itemKeyFile, -itemRevisionKeysFile, and -4gd_id arguments are mutually exclusive Traversal-free synchronization is not supported for remote import (-f=remote_import. If the replica does not exist at the importing site, only the -4gd_id and -item_id arguments support the remote import function. (-f=remote_import). For objects specified by -filename, multifield -key, -name, or -class arguments, replicas must exist on the importing site. All arguments supported for the send function (-f=send) with the -optionset argument are supported for remote import. Examples Required log-in information is omitted from the following examples. To send a list of items specified in a text file to two sites: Copy data_share -f=send -filename=my_item_list.txt -site=Site1 -site=Site2 To send a list of items specified in a text file and output a report; continue processing if a nonfatal error is found: Copy data_share -f=send -filename=my_list.txt -site=Site1 -report=rep.txt -coe To send a precise assembly to a remote site: Copy data_share -f=send -item_id=xyz -rev=A -include_bom -assert_precise To transfer ownership of a given item: Copy data_share -f=send -transfer -item_id=item123 -site=Site1 To publish an assembly item and all its components using the latest revision rule to determine components: Copy data_share -f=publish -item_id=Engine100 -site=Ods1 -include_bom To publish an assembly item and all its components using the latest released revision rule to determine components: Copy data_share -f=publish -item_id=Item1 -site=Ods1 -include_bom -latest_released To unpublish an assembly item and all its components from multiple ODS sites using the default revision rule latest revision: Copy data_share -f=unpublish -item_id=Item1 -site=Ods1 -site=Ods2 -include_bom To delete a publication record in the local database: Note Use this only if the primary object has been deleted, but the publication record still exists. Copy data_share -f=delete_pubrec -item_id=ObsoleteItem1 To list the authorized ODS sites: Copy data_share -f=list_ods To check availability of the authorized ODS sites: Copy data_share -f=check_ods To get publication information about a list of objects in a folder: Copy data_share -f=list_pub_info -folder=myFolder To send an item to a specific remote user and group: Copy data_share -f=send -item_id=xyz -site=Site1 -owning_user=joe -owning_group=engg To send an item to a site using a different schema. In this scenario, Advanced Multi-Schema Exchanger is used to create the transformation rules to use when exchanging files. After attaching the rules to the transfer mode, the rules are extracted to a .xsl file using the plmxml_tm_edit_xsl utility with the -action=export argument on the transfer mode. Copy data_share –f=send –item_id=0001 site=site2 -mapping_rule=c:\mapping.xslt When publishing thousands of items and you get errors after publishing several hundreds or even thousands of items, reduce the batch size: Copy data_share -f=publish -item_id=A* -site=Site1 -batch_size=200 To publish an engineering change object and all its associated change objects: Copy data_share -f=publish -item_id=CR0001 -site=Ods1 -include_bom 0-include_bc -include_supercedures To register an item ID with the central item ID registry: Copy data_share -f=register -item_id=myItem To find duplicate item IDs at another site: Copy data_share -f=find_duplicates -item_id=00* -site=Site1 To list all objects that are checked out by remote users: Copy data_share -f=list_remote_co To list all objects that are checked out by user justin at Site2: Copy data_share -f=list_remote_co -user=justin -site=Site2 To cancel check out of all objects by user joseph at Site2: Copy data_share -f=cancel_remote_co -user=joseph -site=Site2 To list all replica objects that are checked out by local group engg from remote site Site1: Copy data_share -f=list_replica_co -site=Site1 To cancel all replica objects that are checked out by user davis from Site1: Copy data_share -f=cancel_replica_co -user=davis -site=Site1 To cancel remote checkout on a given item: Copy data_share -f=cancel_remote_co -item_id=item123 To cancel remote checkouts on the datasets listed in the dataset.lst file: Copy data_share -f=cancel_remote_co -filename=dataset.lst -class=Dataset To cancel replica checkouts on the datasets in uniquely named folder: Copy data_share -f=cancel_replica_co -folder=unique_folder_xyz To exclude all variant options during a send operation: Copy data_share -f=send -item_id=CR0002 -site=remote1 -exclude_variant_options To batch send all variant options during a send operation: Copy data_share -f=send -item_id=CR0002 -site=remote1 -batch_variant_options -batch_size=10000 To batch send one or more classes of objects during a send operation: Copy data_share -f=send -item_id=CR0002 -site=remote1 -batch_objects=class1,class2 -batch_size=10000 To batch send one or more classes of objects given in a text file during a send operation: Copy data_share -f=send -item_id=CR0002 -site=remote1 -batch_file=my_list.txt -batch_size=10000 To import an item from a remote site (Site2): Copy data_share -f=remote_import -site=Site2 -item_id=xyz To import the objects of an assembly using a file (UIDs_list.txt) containing a list of UIDs: Copy data_share -f=ri -filename=UIDs_list.txt -classoffile=Tagstring To initiate a checkpoint transaction at three specified sites: Copy data_share -f=send -checkpoint -item_id=item123 -site=Site2 -site=Site3 -site=Site4 To export a role that does not have any group members from the TopGrp1 group: Copy data_share -class=group -name=TopGrp1 -f=send -all_groupmembers -site=Site2 Include the rendering dataset and IncrementalChangeElement items in the exported data: Copy data_share -f=send -item_id=xxx -site=site2 -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_share -f=send -item_id=xxx -site=site2 -session_options=ForceUpdateOnImport:true To return status for a transaction ID of AhEZaOnRAAAMfD and no -site argument is specified: Copy data_share -f=status -trid=AhEZaOnRAAAMfD The output is similar to the following: Copy Site1: sending export data to all target sites (06-Nov-2007.14:31:28) Site2: transmitting data (06-Nov-2007.14:35:31) Site3: importing data (06-Nov-2007.14:34:29) Site4: error 100107 - site not currently available (06-Nov-2007.14:32:26) Site5: transaction complete (06-Nov-2007.14:40:10) The time stamp represents the last time the status was updated. To return status at a receiving site and no -site argument is specified: Copy Site3: importing batch 5 out of 50 (06-Nov-2007.14:34:29) At a receiving site, only the status of the local site is obtained; the status of other sites involved in a transaction are not available. To restart a given transaction for a given site: Copy data_share -f=send -transaction_id=AhEZaOnRAAAMfD -restart -site=Site3 To update export records at site Site4 using a transaction ID of AhEZaOnRAAAMfD: Copy data_share -f=commit_ixr -trid=AhEZaOnRAAAMfD -site=Site4 To clean up records with a transaction ID of AhEZaOnRAAAMfD: Copy data_share -f=cleanup_transaction -trid=AhEZaOnRAAAMfD To list checkpoint transactions: Copy data_share -f=list_transactions The output is similar to the following: Copy Transactions initiated by local site: AhEZaOnRAAAMfD - active BxyzZaOnRAAXYZ - inactive Transactions initiated by remote sites: ZaOnRAAAYXCDA - Site3 To send the casCD001 collaborative design object to the site2 site: Copy data_share -f=send -4gd_id=casCD001 -class=Cpd0CollaborativeDesign -site=site2 To transfer architecture breakdown structures between sites, you must execute the following steps sequentially: Push the design assembly. Copy data_share -f=send -item_id=design-assembly-item_id -site=remote-site-id -exclude=IMAN_reference -exclude=IMAN_based_on -exclude=IMAN_snapshot -exclude=IMAN_3D_snap_shot -exclude=IMAN_external_object_link -exclude=TC_Generic_Architecture -bo=VariantExpression, MEAppearancePathNode -bs=1000 -ldv Push the LOUHOLDER object and synchronize the BOM view revision. Copy data_share -f=send -item_id= -site= -include_bom -exclude=IMAN_reference -exclude=IMAN_based_on -exclude=IMAN_snapshot -bvo -bo=PSOccurrence -bs=20 -bvrsync -report=/rpt Push the architecture breakdown structure excluding the NVEs. Copy data_share -f=send -item_id= -rev=001 -site= -exclude=IMAN_3D_snap_shot -exclude=IMAN_reference -exclude=IMAN_external_object_link -exclude=IMAN_based_on -evo -bo=MEAppearancePathNode -bs=2000 -ldv Push the NVEs. Copy data_share -f=send -item_id= -rev=001 -site= -exclude=IMAN_3D_snap_shot -exclude=IMAN_external_object_link -exclude=IMAN_based_on -bo=MEAppearancePathNode -bs=2000 -ldv To send a 4GD object and output a report: Copy data_share -f=send -4gd_id=Ste2_DE0524 -cof=Cpd0DesignElement -site=Site1 -optionset -report=4GD_rep.txt To send a list of 4GD objects specified in a text file using parallel processing and output a report: Copy data_share -f=send -filename=my_4GD_list.txt -cof=Cpd0DesignElement -site=Site1 -optionset -parallelize=6,8 -report=rep.txt To send a specific 4GD partition object and output a report: Copy data_share -f=send class=Cpd0DesignElement -key=ptn0partition_id=CD001_id,ptn0partition_scheme_type=SchemeFunctional_CD001, partitionptn0source_object=partition_source_CD001,mdl0model_object=model_CD001, mdl0revision_id=model__id=001/A site=Site1 -optionset -report=rep.txt To clean up fast synchronization 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 use the TC_cms_relation_optset_map preference to include or exclude relations: Add the relation and option set to the TC_cms_relation_optset_map preference, for example: Copy IMAN_rendering, opt_rel_rendering In the PLM XML/TC XML Export Import Administration application, expand the TransferOptionSet, click MultiSiteOptSet, and add the opt_rel_rendering option with the default value set to false. Expand ClosureRule, click MultiSiteDefaultCR, and add the following clause: Copy CLASS:WorkspaceObject:CLASS:Dataset:RelationP2S:IMAN_rendering: SKIP:$opt_rel_rendering==false; This clause states, from any WorkspaceObject, find the dataset using IMAN_rendering relation, and when the relation is opt_rel_rendering, skip the dataset during export. It means the default is to always exclude the IMAN_rendering relation for an exported object. To include the IMAN_rendering in the export using the data_share utility, type: Copy data_share -include=IMAN_rendering -optionset Related Topics TC XML and PLM XML Configuration for Data Import and Export Multi-Site Collaboration