sync_product_apns

This utility: Enables a site to synchronize product appearance path nodes (APNs) with other sites. Synchronizes the absolute occurrence data that is associated with these APNs. Synchronizes item revision attachments with the RDV_appgrp_toplevel_relation relationship type. In RDV, this attachment type associates part usage occurrence groups with an architecture revision. Part usage occurrence groups are workspace objects that collect one architecture element (APN) and all corresponding part usage occurrences (APNs). A part usage references its architecture element by means of this part usage occurrence group. Because RDV_appgrp_toplevel_relation attachments are handled with this utility, Siemens Digital Industries Software recommends you exclude this relationship when replicating the architecture revision with the data_sync or data_share utilities. This utility is similar to the sync_product_variant_data utility in that it synchronizes occurrence data, occurrence roots, APNs, and so on, while the sync_product_variant_data utility synchronizes variant data, such as variant objects, variant revision objects, item revision expressions, and NVEs. This utility operates in the following modes and each mode has different mandatory and optional arguments: Export to disk Use of 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 Use of 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 Use of the -dir argument without the -site argument indicates that the utility runs in read/import mode. Note that 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_apns[-u=user-id {-p=password | -pf=password-file} -g=group] [-item=item-id | -key=key-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 after exporting sync_product_apns[-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_apns[-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_apns[-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 data 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 the other modes, the directory must exist and must contain export data. -item Item ID of the item of which appearance and absolute occurrence 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. -arch Exports appearance and absolute occurrence data of the architecture items that are associated with the item specified with the -item 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 roll back 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. -apn_roots_only Specifies to only export appearance path node roots and absolute occurrence data qualifiers. If this argument is not specified, these objects are excluded. -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 that generates a detailed 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. -send Specifies that the data is sent directly to the remote ISDM. -browse Specifies to browse objects in the export area without exporting or importing. -u Specifies the user ID. This is a required argument unless the TC_auto_login site preference is set. 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. This is a required argument unless the TC_auto_login site preference is set. -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. This is a required argument unless the TC_auto_login site preference is set. 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. To bypass the export of named variant expressions, set the RDV_export_nve environment variable to FALSE. When using the data_share and data_sync utilities, Siemens Digital Industries Software recommends you exclude APN and NVE synchronization by setting the following environment variables: TC_EXCLUDE_APN=TRUE RDV_export_nve=FALSE Files As specified in Log files produced by Teamcenter. Restrictions None. Examples Export to disk all appearance path nodes, absolute occurrences, and absolute occurrence data on item RDV00190, excluding the item itself: Copy sync_product_apns -u=Tc-admin-user -p=password -g=group -bypass -dir=C:\Temp\RDV00190_apns -item=RDV00190 -site=cologne -site=turin Export to disk all appearance path nodes, absolute occurrences, and absolute occurrence data on item RDV00190, along with data of associated architecture breakdowns: Copy sync_product_apns -u=Tc-admin-user -p=password -g=group -bypass -dir=C:\Temp\RDV00190_apns -item=RDV00190 -arch -site=cologne -site=turin Export to disk all modified appearance path nodes, absolute occurrences, and absolute occurrence data on item RDV00190, and its architecture breakdowns: Copy sync_product_apns -u=Tc-admin-user -p=password -g=group -bypass -dir=C:\Temp\RDV00190_apns -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 appearance path nodes, absolute occurrences, and absolute occurrence data for all revisions of RDV00190 and all revisions of associated architecture breakdown items. Object UIDs are written to the uid.txt text file for later export. Copy sync_product_apns -u=Tc-admin-user -p=password -g=group -bypass -dir=C:\Temp\RDV00190_apns -item=RDV00190 -arch -count -modified_only -site=cologne -site=turin -tag_list=uid.txt Export to disk object index numbers 1,000 through 1,999 of all appearance path nodes, absolute occurrences, and absolute occurrence data of item RDV00190, along with appearance path nodes, absolute occurrences, and absolute occurrence data of associated architecture breakdowns. Objects are exported as determined in example 4. The -exclude_variants argument causes variant and variant revision objects associated with item RDV00190 to be excluded. This allows exporting variant data with the sync_product_variant_data utility in parallel. Copy sync_product_apns -u=Tc-admin-user -p=password -g=group -bypass -dir=C:\Temp\RDV00190_apns -item=RDV00190 -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 appearance path nodes, absolute occurrences, and absolute occurrence data of item RDV00190, along with appearance path nodes, absolute occurrences, and absolute occurrence data of associated architecture breakdowns: Copy sync_product_apns -u=Tc-admin-user -p=password -g=group -bypass -dir=C:\Temp\RDV00190_apns -item=RDV00190 -arch -site=cologne -site=turin -from=1000 -exclude_variants Browse export area: Copy sync_product_apns -u=Tc-admin-user -p=password -g=group -dir=C:\Temp\RDV00190_apns -browse Send export area to Turin’s IDSM: Copy sync_product_apns -u=Tc-admin-user -p=password -g=group -dir=C:\Temp\RDV00190_apns -site=turin Send object index numbers 1,000 through 1,999 in export area to Turin: Copy sync_product_apns -u=Tc-admin-user -p=password -g=group -dir=C:\Temp\RDV00190_apns -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_apns -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_apns-from=1000 -to=2000 Related Topics Structure Management on Rich Client ─ Usage