prune_named_references

Finds, removes, and deletes named references from associated datasets. Associated datasets containing no named references after the prune operation are deleted. The named references can be obtained from saved query results. A provided saved query, ImanFileNamedRefsQ, uses the following search criteria: The Original File Name attribute is the original_file_name of the ImanFile file. The Last Modified Date attribute is the last_modified_date of the ImanFile. The Name value is the type name of the associated dataset. The Type value is the type name of the associated business object related to the dataset with a Specification relationship. You can use prune_named_references to perform the following tasks: Query the named references through an existing saved query. The query input contains the name of the existing saved query, the name-value map of the entry named, and the value of the saved query. The query output contains the candidates of the named reference to be pruned in an XML file with the UID, original_file_name, last_modified_date, size of the file stored in volume, and the class name of the named references. Prune the named references. The input candidates to be pruned are stored in an XML file that has the same format as the query results. You can edit the query results file in a Microsoft Excel file and use that as the input to the prune operation. Query and prune. The utility queries the candidates using the query information and then prunes all the candidates from the query results. Syntax prune_named_references -u=user-id {-p=password | -pf=password-file} [-g=group] [-encrypt={true | false}] [-mode={prune | query | all}] [-class=class_name ] [-savedQueryInfo=savedQueryInfoFile -queryOut=queryResultsFile] | [-pruneNamedRefs=pruneInputFile] [-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. -encrypt If set to true, specifies password encryption. -mode query Query the named references with the specified savedQueryInfo file and write the results to the queryOut file. prune Prune the named references in file specified by the pruneNamedRefs file. all Query the named references with savedQueryInfo file and prune all the named references obained from query results -class Specifies the class name of the candidates for pruning; the default class name is ImanFile. -savedQueryInfo Specifies the required XML file query and all modes; contains the saved query name and the name value map. An example input file follows: Copy

-queryOut Specifies the XML file to contain the named references from the query results. -pruneNamedRefs Specifies the XML file to contain the named references to be pruned. -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 You must be a Teamcenter administrator to execute this utility. Examples Query candidates: Copy prune_named_references -u=admin_id -p=admin_password -pf -g=admin -mode=query -savedQueryInfo=d:\myWork\queryInfo.xml -queryOut=d:\myWork\queryOut.xml Run the prune operation: Copy prune_named_references -u=admin_id -p=admin_password -pf -g=admin -mode=prune - pruneNamedRefs =d:\myWork\queryOut.xml Query for candidates and prune the candidates: Copy prune_named_references -u=admin_id -p=admin_password -pf -g=admin -mode=all - savedQueryInfo=d:\myWork\queryInfo.xml