cleanup_ic_objects

Reverts changes made to an assembly as part of an incremental change (IC) object. This utility analyzes the incremental change object and cleans up the database to nullify the impact of the IC changes. For example, if a PLM XML file that is updating an existing structure in the database is imported using an IC object, this utility can be used to revert the effect the import. This can be very helpful in cases where the PLM XML import failed and the data is not in a consistent state. Note This utility does not restore the database to its original state before the import. This utility can revert the following changes: Adding, removing, or modifying a BOM line. Add an existing item as a BOM line. Add an existing item as a BOM line and occurrence group child. Add an existing item with GDE children as a BOM line and occurrence group child. Add an existing connection as a BOM line and occurrence group child and connect it to GDE BOM lines. Modify a BOM line property. Remove an item BOM line. Remove an item BOM line with GDE children. Remove a connection BOM line. Adding, removing, or modifying a GDE line. Add a GDE line. Modify a GDE line property. Remove a GDE line. Adding, removing, or modifying attachments (forms/datasets). Attach a form/dataset to an item BOM line. Attach a form/dataset to an item BOM line in absolute occurrence context. Attach a form to a GDE line in absolute occurrence context. Attach a form to a connection BOM line in absolute occurrence context. Modify a BOM line form/dataset. Modify a BOM line form/dataset in absolute occurrence context. Remove a BOM line form/dataset. Remove a BOM line form/dataset in absolute occurrence context. A given IC object may contain many ICEs (incremental change elements). Each ICE specifies the change type that was made (add/remove) and the affected object of the change. For add scenarios, the change type is IC_add. When adding a BOM line/GDE line, the affected object is PSOccurrence/GDEOccurrence. This utility deletes the ICE and PSOccurrence/GDEOccurrence. When attaching a dataset/form to a BOM line, the affected object is ImanRelation. This utility deletes the ICE and ImanRelation. The secondary objects of the relation are not deleted. For modify scenarios, the change type is IC_add. When modifying a BOM line property, the affected object is AbsOccData. This utility deletes the AbsOcc data. When modifying a BOM line attachment, the affected object is a copy of the attachment (dataset/form) with the modifications. This utility deletes the modified copy. For remove scenarios, the change type is IC_remove. The affected objects point to the objects that are removed from the structure. This utility deletes the ICE. It automatically restores the removed objects. Syntax cleanup_ic_objects [-u=user-id {-p=password | -pf=password-file} -g=group] { [-ic_id=IC-object-item-ID | -key=IC-object-search-key] [-ic_rev_id=IC-object-rev-ID] } [-dryrun] [-verbose] [-start_date=start-date] [-end_date=end-date] 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. -ic_id Specifies the item ID of the incremental change object whose associated data will be deleted. -key Specifies the search key of the incremental change object. Use the following format: Copy [keyAttr1=keyVal1] [,keyAttr2=keyVal2]…[,keyAttrN=keyValN] To find the key of an object, use the get_key_string utility. For more information, see BMIDE for Data Model Design. -ic_rev_id Specifies the revision ID of the incremental change object whose associated data will be deleted. If this argument is not specified, the latest revision will be used. -dryrun Deletes nothing. Objects are searched and a report is created. -verbose Prints extra information about the objects being deleted. You can combine the -dryrun and -verbose options as follows: No option: Prints errors only. -verbose option only: Prints maximum information, such as what is being searched, how many objects were found, type of objects being deleted, and success/failure message after deletion. -dryrun option only: Prints the number of objects found and the type of objects that will be deleted in a normal run. Both options: Prints all of the information from the -verbose option except the success/failure message. -start_date Changes made after the specified date and time are reverted. Use the format DD-MMM-YYYY HH:MM:SS. For example, 01-Jan-1970 00:00:00 is January 1, 1970. If no time is specified, 00:00:00 is used. -end_date Changes made after the specified date and time are reverted. Use the format DD-MMM-YYYY HH:MM:SS. For example, 01-Jan-1970 00:00:00 is January 1, 1970. If no time is specified, 00:00:00 is used. -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 None. Related Topics TC XML and PLM XML Configuration for Data Import and Export Multi-Site Collaboration