sync_product_variant_data

Enables sites to synchronize product variant data with other sites. This utility is similar to the sync_product_apns utility in that it synchronizes variant data, such as variant objects, variant revision objects, item revision expressions, and NVEs while the sync_product_apns utility synchronizes occurrence data, occurrence roots, APNs, and so on. This utility operates in the following modes and each mode has different mandatory and optional arguments: Export to disk Using the -item argument indicates that the utility runs in export mode. Note that either -dir=directory-name or -count are required as indicated with the {|} notation. Send to remote IDSM after exporting Using the -dir and -site arguments indicate that the utility runs in send mode. Directly send to remote IDSM Use of the -send argument sends the data to the remote IDSM without first exporting to disk. Read / import from disk Using the -dir argument without the -site argument indicates that the utility runs in read/import mode. The utility runs in read-only mode if the -browse argument is specified; otherwise, data is imported to the local site Syntax Export to disk sync_product_variant_data [-u=user-id {-p=password | -pf=password-file} -g=group] [-item=item-id | -key=key-id] [-rev=revision-id] [-arch] [-bypass] -site=site-name [-reason=text] {-dir=directory-name [-tag_list=file-name [-from=number] [-to=number] ] | -count[-tag_list=file-name] } [-modified_only] [-debug] [-exclude_variants] [-silent] [-rollback_on_failure] Send to remote IDSM sync_product_variant_data [-u=user-id -p=password | -pf=password-file -g=group]-dir=directory-name -site=site-name [-from=number] [-to=number] [-silent] [-rollback_on_failure] Directly send to remote IDSM sync_product_variant_data[-u=user-id {-p=password | -pf=password-file} -g=group] [-item=item-id | -key=key-id] -site=site-name[-reason=text] [-from=number] [-to=number] {-dir=directory-name [-tag_list=file-name [-from=number] [-to=number]] | -count[-tag_list=file-name] } -send Read / import from disk sync_product_variant_data [-u=user-id {-p=password | -pf=password-file} -g=group] -dir=directory-name [-browse] [-bypass] [-from=number] [-to=number] [-silent] [-rollback_on_failure] Arguments -dir Specifies a local directory name. The utility writes exported area into this directory. If the directory exists, it must not contain export data. For export mode, the directory may or may not exist. If the directory exists, it must not contain exported data, for example, it must not have been used as an export directory in a previous run. For other modes, the directory must exist and must contain export data. -item Specifies the item ID of the item of which variant data is to be exported. -key Specifies the key of the object. The -key argument can be used instead of the -item argument. To find the key of an object, use the get_key_string utility. For more information, see Introduction to multifield keys in BMIDE for Data Model Design. -rev Specifies the revision ID of the item revision of which variant data is to be exported in addition to the variant data of its item. -arch Exports variant data of the architecture items and architecture revisions that are associated with the item specified with the -item argument and the revision specified with the -rev argument. -site This argument cannot be used in read/browse mode. Export mode Specifies the sites to which objects are to be replicated. Upon exporting an object, the utility creates one export record for each site if this object type supports export records. Export records contain the time of export to support incremental replication. If the user requests a rollback at the end of the utility, all export records that were generated during export are rolled back. Send modes Specifies the sites to which objects are to be sent. This mode requires an IDSM service to be available at the remote site. If multiple -site switches are used to specify multiple sites, the export directory is sent to each site sequentially. For better throughput, run separate processes for each site instead of running one process for multiple sites. -count Reports the number of objects to export. If used with the -modified_only argument, the count indicates the number of changed objects that need to be replicated to at least one of the sites specified with the -site argument. If used with the -tag_list argument, a tag list file is written. -exclude_variants Causes the export to exclude objects of either the Variant or VariantRevision class that are attached to the item specified with the -item argument. This argument is useful when exporting in multiple batches. If this option is not set, each batch contains all variant options referenced from its expressions causing multiple batches to contain an overlapping set of objects. Overlapping sets of objects cannot be imported in parallel. -silent Disables rollback capability and rollback confirmation dialog and executes in silent mode. -rollback_on_failure Automatically rolls back on any error code other than ITK_ok. -debug Turns on verbose mode, which generates a detailed report of export and modified dates. -bypass Disables access control. You must have DBA privileges to use this argument. -modified_only Specifies to only export objects that have changed since they were exported to the sites specified by the -site argument. Note If more than one site is specified, the object is exported according to the most out-of-date export record. This can cause some objects to be exported to some sites even though these sites appear to have an up-to-date export record. After completing the export, all sites specified with the -site argument have the same export date for each exported object. -reason Specifies the reason for export. The maximum number of characters is 240. If no reason is specified, the command line of running the export utility is used as the reason text. -from Specifies the index of the first object to be exported. The default value is zero. In Read/import from disk mode, the index refers to the object list in the export data located in the directory specified with the -dir argument. In other modes, the index refers to the tag list file specified with the -tag_list argument. -to Specifies the index of the object following the last object to process. For example if you specify -to=10, the object at index 9 is the last object to be processed. In Read/import from disk mode, the index refers to the object list in the export data located in the directory specified with the -dir argument. In other modes, the index refers to the tag list file specified with the -tag_list argument. -tag_list Specifies a file name containing a list of object UIDs to export. This file is written if the -count argument is specified. If the -count argument is not specified, the file is read. -count Reports the number of objects to export. If used with the -modified_only argument, the count indicates the number of changed objects that need to be replicated to at least one of the sites specified with the -site argument. If used with the -tag_list argument, a tag list file is written. -browse Specifies to browse objects in the export area without exporting or importing. -u Specifies the user ID. This is 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. This argument is mutually exclusive with the -p argument. For more information about managing password files, see Manage password files. -g Specifies the group associated with the user. If used without a value, the user's default group is assumed. -h Displays help for this utility. Environment As specified in Setting up a Teamcenter command-line environment. In addition, to export named variant expressions (NVEs), you must set the RDV_export_nve preference to TRUE. To bypass the export of NVEs, set the RDV_export_nve preference to FALSE. Files As specified in Log files produced by Teamcenter. Restrictions None. Examples Export to disk all variant options and variant revisions of item RDV00190, excluding the item itself: Copy sync_product_variant_data -u=Tc-admin-user -p=password -g=group -bypass -dir=C:\Temp\RDV00190_variant_data -item=RDV00190 -site=cologne -site=turin Export to disk all variant options and variant revisions of item RDV00190 with variant data of associated architecture breakdowns (mostly NVEs): Copy sync_product_variant_data -u=Tc-admin-user -p=password -g=group -bypass -dir=C:\Temp\RDV00190_variant_data -item=RDV00190 -arch -site=cologne -site=turin Export to disk all variant options and variant revisions of item RDV00190 and all modified NVEs on its architecture breakdowns: Copy sync_product_variant_data -u=Tc-admin-user -p=password -g=group -bypass -dir=C:\Temp\RDV00190_variant_data -item=RDV00190 -arch -modified_only -site=cologne -site=turin Determine objects for an incremental update of RDV00190/D to sites Cologne and Turin. This includes variant expressions of RDV00190/D and its associated architecture breakdown revisions (mostly DECLARE and DEFAULT statements) and the NVEs of associated architecture breakdown items. Object UIDs are written to the uid.txt text file for later export. Copy sync_product_variant_data -u=Tc-admin-user -p=password -g=group -bypass -dir=C:\Temp\RDV00190_variant_data -item=RDV00190 -rev=D -arch -count -modified_only -site=cologne -site=turin -exclude_variants -tag_list=uid.txt Export to disk all variant options of item RDV00190 and all variant expressions (mostly DECLARE and DEFAULT statements) on revision D: Copy sync_product_variant_data -u=Tc-admin-user -p=password -g=group -bypass -dir=C:\Temp\RDV00190_variant_data -item=RDV00190 -rev=D -site=cologne -site=turin Export to disk all variant options of item RDV00190 and all variant expressions (mostly DECLARE and DEFAULT statements) on revision D, along with variant data of associated architecture breakdowns (mostly NVEs), and associated architecture breakdown revisions (mostly DECLARE and DEFAULT statements): Copy sync_product_variant_data -u=Tc-admin-user -p=password -g=group -bypass -dir=C:\Temp\RDV00190_variant_data -item=RDV00190 -rev=D -arch -site=cologne -site=turin Export to disk object index numbers 1,000 through 1,999 of all variant expressions (mostly DECLARE and DEFAULT statements) of revision D of item RDV00190, along with variant data of associated architecture breakdowns (mostly NVEs), associated architecture breakdown revisions (mostly DECLARE and DEFAULT statements), and their attached saved variant rules. Objects are exported as determined in example 4. To allow exporting and importing multiple batches in parallel it is recommended to export and import data as described in example 1, before batches as described in this example are exported and imported. The -exclude_variants command line option causes the objects exported in example 1 to be excluded. Otherwise, these variants would be exported into each export batch and upon importing a conflict may arise when importing the same variant object via parallel IDSM processes at the same time. Copy sync_product_variant_data -u=Tc-admin-user -p=password -g=group -bypass -dir=C:\Temp\RDV00190_variant_data -item=RDV00190 -rev=D -arch -site=cologne -site=turin -from=1000 -to=2000 -exclude_variants -tag_list=uid.txt Export to disk object index numbers 1,000 through the end of all variant expressions (mostly DECLARE and DEFAULT statements) on revision D of item RDV00190, along with variant data of associated architecture breakdowns (mostly NVEs), associated architecture breakdown revisions (mostly DECLARE and DEFAULT statements), and their attached saved variant rules: Copy sync_product_variant_data -u=Tc-admin-user -p=password -g=group -bypass -dir=C:\Temp\RDV00190_variant_data -item=RDV00190 -rev=D -arch -site=cologne -site=turin -from=1000 -exclude_variants Browse export area: Copy sync_product_variant_data -u=Tc-admin-user -p=password -g=group -dir=C:\Temp\RDV00190_variant_data -browse Send export area to Turin’s IDSM: Copy sync_product_variant_data -u=Tc-admin-user -p=password -g=group -dir=C:\Temp\RDV00190_variant_data -site=turin Send object index numbers 1,000 through 1,999 in export area to Turin: Copy sync_product_variant_data -u=Tc-admin-user -p=password -g=group -dir=C:\Temp\RDV00190_variant_data -site=turin -from=1000 -to=2000 Browse import area: Copy sync_product_variant_data -u=Tc-admin-user -p=password -g=group -dir=C:\Temp\RDV00190_variant_data -browse Import objects in import area: Copy sync_product_variant_data -u=Tc-admin-user -p=password -g=group -dir=C:\Temp\RDV00190_variant_data Import object index numbers 1,000 through 1,999 in import area: Copy sync_product_variant_data -u=Tc-admin-user -p=password -g=group -dir=C:\Temp\RDV00190_variant_data -from=1000 -to=2000 Export all variant options and variant revisions to the remote site: Copy sync_product_variant -u=Tc-admin-user -p=password -g=group -send -item=xxx -arch -site=yyyy Related Topics Structure Management on Rich Client ─ Usage