item_to_part_design

Converts instances of the Item class and its subtypes to specified instances of the Part and Design classes or their subclasses or subtypes. Use this utility if you have existing product structure containing items that you want to convert to separate part and design (CAD) objects. You must create a text file that provides the necessary input for the conversion process. Note that, this utility is now deprecated and will be obsolete soon. Note You must restart the Teamcenter server after running this utility for the new objects to be visible in the rich client. The utility allows you to: Convert all objects in the system or a specified set of objects of a given source type to given target types. Specify the source as the Item class or its subtypes and specify the target as the Part and Design classes, their subclasses, or subtypes. Caution After you run this utility, you cannot revert the changes. You must analyze the impact on business rules (for example, property rules and GRM rules) of the conversion and then plan accordingly. The utility does not check the validity of the business rules. Performance may be poor if you try to convert the entire database or a large structure. If possible, limit the structure size or the number of objects to convert. The following conversions are supported by this utility: Item subtypes to Part subtypes Item subtypes to Design subtypes Item subtypes to Part class Item subtypes to Part subclass Item subtypes to Design class Item subtypes to Design subclass Item class to Part class Item class to Part subclass Item class to Design class Item class to Design subclass Note Item subtypes are secondary business objects that have an Item class. Custom primary business objects that are created as a child of Item are not supported by this utility. The utility operates in three modes: type_based Input from the user is an item class or its subtype, which is a source type. The user specifies a target type. All objects in the database of source type are converted to the target type. item_id_based In this mode, the user specifies a comma-separated list of item IDs, together with the source and the target types. Only the valid item IDs listed in the input file are converted from the source type to the target type. structure_based The user specifies the item identifier of the top-level item in the structure, together with the source and the target types. This mode converts all the valid children of the top-level item to the target type. The user must create a text file that contains input to the entire conversion process. Syntax item_to_part_design [-u=user-id -p=password | -pf=password-file -g=group] {-mode=type_based | item_id_based [-itemid=item-id | -key_property_list=key-id-list] | structure_based [-itemid=item-id | -itemkey=key-id] } -file=input-file-name [-rf=report-file-name] [-dryRun=true/on | false/off] [-h] Arguments -u Specifies the user ID. This is a user with Teamcenter administration privileges. Note 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. -mode Specifies type_based, item_id_based, or structure_based. -itemid Specifies the ID of the item to be exported. Valid only if no input file is specified using the -i option. -itemkey Specifies the key of the object. You can use the -itemid argument or the -itemkey 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. -key_property_list Specifies the key attributes of the object except the item ID. 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. -file This argument is mandatory for all the conversion modes. Specifies the name of the input file containing conversion parameters, including the full path. The input file is a list of key-value pairs. The keys indicate the source and target item types. The input file has the following format: Copy source_class_name=Item class | SubType target_class_name=Part/Design class | SubClass | SubType item_id_list=Name of input file Ensure you use internal names for the source and target. Note The list of item IDs must end with a comma (,). -rf This optional argument specifies the name and location of the report file. If you do not specify a name and location, the system writes the file to C:\temp on Microsoft Windows systems or /tmp on other systems. It is not applicable in type_based mode. -dryRun This optional argument causes the utility to validate if the specified items or structure can be validate, but does not perform the conversion. Valid values are true or on and false or off (case sensitive). It is not applicable in type_based mode. -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 Execute this utility when no other activity is present on the database. This utility changes only the type of item object, its revisions, master form, and revision master form. The storage class of source and target master forms is assumed to be same. If the attributes on the source and target form storage class are different, the utility does not know how to map those attributes. Hence the utility does not change the storage class of the form, but converts the form object itself to the target class. For example, while converting the standard Item class to Design, it performs the following conversion: Before conversion, the item master form (a form storage class) is an item master. After conversion, the design master form (a form storage class) is an item master. The utility converts objects in a particular database. If the objects being converted are exported to different sites, either the replica of the object must be deleted before conversion or replica objects also need to be converted in a similar fashion. If the replica objects are not converted due to change of type, synchronizing of data does not occur. If you use item_id_based mode or structure_based mode, items with export records or conflicting GRM rules are not converted. They are converted if you use type_based mode. The conversion of item subclass instances is not supported. The utility does not support source and target classes or subtypes other than those listed in the description. Any customization of the source object type is not supported after conversion to the target type. If the target is a subclass of Part or Design with custom attributes, those custom attributes of the converted instance or object are populated with default values, if any are defined. If none are defined, the custom attributes are null. Examples The following example uses type_based mode and converts all the objects of a source type to a target type defined in the Sample.txt file: Copy item_to_part_design -u=Tc-admin-user -p=password -g=group -mode=type_based -file="C:\Sample.txt" The contents of Sample.txt are: Copy source_class_name=Item target_class_name=Part The following example uses item_id_based mode and converts all of the valid items listed in the Sample.txt file from source type to target type. No dry run is performed, but a report is written to the ReportFile.txt file. Copy item_to_part_design -u=Tc-admin-user -p=password -g=group -mode=item_id_based -rf="C:\temp\ReportFile.txt" -file="C:\Sample.txt" -dryRun=false The contents of Sample.txt are: Copy source_class_name=Item target_class_name=Part item_id_list=000001,000004,000009, The following example uses item_id_based mode and converts all of the valid items listed in the Sample.txt file from source type to target type. A dry run is performed, and a report is written to the default location. Copy item_to_part_design -u=Tc-admin-user -p=password -g=group -mode=item_id_based -file="C:\Sample.txt" -dryRun=true The contents of Sample.txt are the same as in the previous example. The following example uses structure_based mode and converts all the valid items and children of the specified item identifier from a source type to a target type defined in the Sample.txt file. No dry run is performed, but a report is written to the ReportFile.txt file. Copy item_to_part_design -u=Tc-admin-user -p=password -g=group -mode=structure_based -rf="C:\temp\ReportFile.txt" -file="C:\Sample.txt" -dryRun=false -itemId=000008 The contents of Sample.txt are: Copy source_class_name=Item target_class_name=Part Note item_id_list is not required. The following example uses item_id_based mode with the key_property_list argument. Because the multifield key is defined as item_id,object_type, only the object_type property is given (which is Mfk2Item). Copy item_to_part_design --u=Tc-admin-user -p=password -g=group -mode=item_id_based -key_property_list=object_type=Mfk2Item -file=itemlist.txt Related Topics Structure Management on Rich Client ─ Usage