item_rename

Changes the item IDs for duplicate part numbers in a naming pattern in a Multi-Site Collaboration environment. The item_rename utility works in conjunction with the item_relink utility. The main reason for renaming duplicates is to avoid a naming conflict while bringing in copies of the primary data that was previously created. The Bypass option enables or disables special bypass object protections for Teamcenter administrators, allowing you to freely access any object in the database to perform maintenance. When running this utility, you must use the Bypass option and the user ID must be infodba. Naming pattern You can use the -prefix, -suffix, or -f arguments to embed a renaming pattern for the duplicate data objects. If these arguments are not used, the system applies a default naming pattern. The default naming pattern adds the DUP_ prefix to the duplicate item IDs. For example, if the duplicate item ID is ABC123, after the item_rename utility runs the duplicate item ID is DUP_ABC123. The -prefix and -suffix switches enable you to add character strings to the item IDs to form new item IDs. The -f switch supplies a file that contains a list of item ID cross-references. If the -f argument is specified, the system ignores the -prefix and -suffix switches. Cross-reference file format The -f switch generates a file that contains a list of item ID cross-references, specifically the duplicate item ID and the renamed duplicate item ID. Each set of item IDs is contained in a single 80-byte line. The duplicate item ID precedes the renamed duplicate item ID. The duplicate item ID and the renamed duplicate item ID must be separated by at least one blank space, although more are allowed. Leading blanks may appear before the duplicate item ID or padding blanks may appear after the renamed duplicate item ID. The system administrator manually creates the cross-reference file. The system administrator must know how to match the item ID replicas and the item ID duplicates. Exception If any unexpected Teamcenter internal errors occur, the utility stops processing the duplicate that has a problem, logs an error message to the report file, and then processes the next duplicate in the replacement folder. The item_rename utility is used only with Multi-Site Collaboration. Syntax item_rename [-u=user-id {-p=password | -pf=password-file} -g=group] -replace=folder-name -rename | -verify [-prefix= prefix-added-to-item-id | -suffix= suffix-added-to-item-id | -f=file-name] -report=file-name [-h] Arguments -u Specifies the user ID. This is a user with Teamcenter 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. -g Specifies the group associated with the user. If used without a value, the user's default group is assumed. -replace Specifies the name of the folder that holds the items that are currently duplicates but that should be replicas. -prefix Specifies the prefix added to the item ID of duplicates to form the new item IDs. -suffix Specifies the suffix added to the item ID of duplicates to form the new item IDs. -f Specifies the file containing item ID cross-reference records. The cross-reference is comprised of the duplicate item ID and the renamed duplicate item ID for each duplicate item ID. This data is contained in a single 80-byte line in the file. The item_relink utility also uses this file. -verify Requests verification of the existence of renamed items. -rename Performs the rename function. -report Generates a report and outputs it to standard output if the file name is not supplied. -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 The following restrictions must be understood and adhered to when using the item_rename utility: Must use the Bypass option, and the user ID must be infodba. The -replace argument must be supplied. Either the -rename or -verify argument must be supplied. A default naming pattern is used if either the -prefix, -suffix, or -f arguments are not supplied. Examples The best practice is to run item_rename with the -verify switch to do a quick search for any objects with the chosen naming pattern. If any exist, choose a different naming pattern for all objects. Enter the following command on a single line to verify the items in the replacement folder and generate a report called rename.rpt. Assume that the naming pattern adds the prefix AAA to the item ID. Copy Item_rename -u=infodba -p=infodba -replace=replacement -prefix=AAA -verify -report=rename.rpt If any items in the database have the same item ID as the chosen naming pattern, error messages beginning with ***ERROR are logged on the rename.rpt file. Change the naming pattern and run the item_rename utility again. Otherwise, use the same command line in step 1, and replace the -verify argument with the -rename argument to rename the items. Related Topics TC XML and PLM XML Configuration for Data Import and Export Multi-Site Collaboration