bmide_instance_delete

Reports and optionally deletes instances for data model elements to support template removal processing. Administrator access is required to run this utility. Syntax bmide_instance_delete -u=user-id {-p=password | -pf=password-file} [-g=group] -template=template -mode=[dryrun | count | export | delete] -instances=business-object-list -file=delta-xml-file-path -tcxmlOutput=tcxml-export-data-file-path -listSupportedElements [-log=log-file-path] [-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 user and password 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 user's password. This argument is mutually exclusive with the -pf argument. -pf Specifies the full path and filename of the password file. For 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 one of the following operation modes: dryrun (default) Reports all instances of the specified input including referencers of each instance. You can use the optional limit argument can be used with this option to limit the number of instances reported by the utility. count Provides a count (only) of instances of the specified input. export Provides TC XML export data file for instance backup and a report of all instances of the specified input including referencers of each instance. delete Attempts to delete instances (along with their referencers) and report the results of the delete activity. Reports the same detail reporting as the export mode. -limit Specifies the number of instances to include in the report. The default is 100. Specify all to include all instances in the report. The total instance count is always included in the report. -instances Specifies the type of instances to include in the report. This argument is mutually exclusive with the -file argument. The argument format is type-qualifier-name:model-element-name. Single or multiple values (comma separated) are permitted. For example: Copy -instances="Type:MyItem" Copy -instances="Type:MyItem,Type:YourItem" The type-qualifier-name options are available from the -listSupportedElements argument. The model-element-name option must be a business object name for the specified type-qualifier-name. -file Specifies the location of the input delta transaction file. This argument is mutually exclusive with the -instances argument. -tcxmlOutput Specifies the location of the TC XML export data file used to back up instances to be deleted. Required with export mode and optional for dryrun and delete modes. It must be a valid XML file. -listSupportedElements Displays the current list of types supported by this utility. -log Specifies file path and name of the log file report for the utility. This argument is optional. -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. Examples To delete business object MyItem type instances: Copy bmide_instance_delete -u=username -p=password -g=dba -mode=delete -tcxmlOutput= -instances="Type:MyItem" To report instances with business object type MyItem and YourItem: Copy bmide_instance_delete -u=username -p=password -g=dba -mode=dryrun -instances="Type:MyItem,Type:YourItem" To delete NoteType business object instances with the name MyNoteType1: Copy bmide_instance_delete -u=username -p=password -g=dba -mode=delete -tcxmlOutput= -instances="NoteType:MyNoteType1" To report Tool business object instances with the name MyTool: Copy bmide_instance_delete -u=username -p=password -g=dba -mode=dryrun -instances="Tool:MyTool" To delete business object MyForm type instances: Copy bmide_instance_delete -u=username -p=password -g=dba -mode=delete -tcxmlOutput= -instances="Type:MyForm" To delete business object MyDataset type instances: Copy bmide_instance_delete -u=username -p=password -g=dba -mode=dryrun -instances="Type:MyDataset" To delete MyItem type instances, NoteType instances with the name MyNoteType1, and Tool instances with the name MyTool: Copy bmide_instance_delete -u=username -p=password -g=dba -mode=delete -tcxmlOutput= -instances="Type:MyItem,NoteType:MyNoteType1,Tool=MyTool" Related Topics BMIDE for Data Model Design