Command Line Management of Subtyping

A command line utility is provided for you to change the subtype of existing EPMDocuments when moving from an earlier release to X-20. The change of subtype is applied to all iterations of a given EPMDocumentMaster. Constraint validation is only be done for the latest iteration of each revision, and change of subtype will fail if constraints are violated on these iterations.

The section outlines the behavior of the command line utility. The utility should be executed after upgrade to Windchill 10.0 and before making the upgraded system accessible to all users. Customer should create the required subtypes using Type and Attribute Management utility and then use the utility to change subtypes of existing EPMDocuments.

This utility has two modes.

• Batch Mode: A csv file is processed in this mode. When used in this mode, collection of EPMDocuments will be processed at a time. The criteria for updating the EPMDocuments with a new subtype is specified in the csv file. The command to use the utility in this mode is:

• Single Document Mode: A single EPMDocument is processed in this mode. The command used in this mode is:

java wt.epm.util.SoftTypeChangeUtility <Document CADName>
<Logical ID of new SoftType>[contextName]

In both the modes of operation, the new subtype specified must be a descendent of the “CAD Document” subtype. If the new subtype is not a descendent of “CAD Document,” then the operation is aborted

To operate in batch mode, you create a comma-separated (.csv) file in which you specify:

• The combinations of values of the attribute triplet: authoringApplication, EPMDocumentType, and EPMDocumentSubType

• The internal name of the subtype that is to be set on documents that belong to a particular triplet

You can specify an asterisk symbol '*' for EPMDocumentType and EPMDocumentSubType. For example, if '*' is specified for the parameter EPMDocumentSubType then all the documents of any EPMDocumentSubType that match the specified authoringApplication and EPMDocumentType will be selected. ‘*’ cannot be specified for the authoringApplication.

The EPMDocumentSubType can be left empty to select EPMDocuments that have EPMDocumentSubType as NULL

The format for an entry in the .csv file is:

Following is a description of each entry field.

• EPMDocumentSubType—Specific EPMDocumentSubType or ‘*’ or empty string

If the expected values for these parameters are not specified, then the operation is stopped.

EPMDocSubTypeRB.rbInfo and EPMDocumentTypeRB.rbInfo located at WT_HOME\src\wt\epm folder give complete information about all doc types and subtypes.

The entries of the .csv file are processed one row at a time. The entry made first is processed first. If any subsequent entry selects the same EPMDocument, then its subtype is changed again with the subtype specified in the row that is being processed.

Upon execution, the change of subtype is applied to all iterations of selected EPMDocuments. Constraint validation is only done for latest iteration of each revision of selected EPMDocuments and change of subtype fails if constraints are violated on any of these iterations.

In single document mode, you update one EPMdocument at a time. For each EPM document your command line entry is as follows.

“contextName” is optional and only required when an EPMDocument in a project context has to be changed. When the contextName is not specified, the utility assumes that the specified EPMDocument belongs to either a ‘Product’ or a ‘Library’.

Upon execution, the change of subtype is applied to all iterations of a given EPMDocumentMaster. Constraint validation is only done for latest iteration of each revision and change of subtype will fail if constraints are violated on these iterations.