Format of State-based Versioning XML File
The XML file used for defining a state-based versioning scheme must conform to the following format:
<?xml version="1.0" encoding="UTF-8"?>
<scheme>
<series name="name1">
<seed name="seed_name1">
<value>P1</value>
<value>P2</value>
<value>P3</value>
</seed>
</series>
</scheme>
<scheme>
<series name="name1">
<seed name="seed_name1">
<value>P1</value>
<value>P2</value>
<value>P3</value>
</seed>
</series>
</scheme>
 |
You must have the following:
• At least one series
• At least one seed per series
• For each series, a minimum of two value elements
|
The same general information listed in the earlier list-based formatting section holds for a state-based versioning.
In the out-of-the-box XML file, the seed names correspond to the items in the Version Series drop-down list found in the Life Cycle Template Administration utility. The seed names are used in the One Phase Development and Two Phase Development out-of-the-box life cycle templates. With this setup, the values are used for versioning when the object using the life cycle template is revised in a particular state.
The out-of-the-box XML file contains the seed names and corresponding values, as follows:
|
Seed Name
|
Values in the Seed
|
|---|---|
|
NUMERIC
|
The integers 1 through 99.
|
|
MILSTD
|
The first value of a hyphen (-) followed by the alphabetic characters A through Y and AA through AY, but not including I, O, Q, S, X, AI, AO, AQ, AS, and AX.
|
You can modify the state-based versioning values that are loaded; however, all changes should be made before any parts, documents, or CAD documents that are using this versioning scheme are revised. Changing values that have already been used can cause unpredictable results when versions are being updated.
The out-of-the-box series name used in the loaded XML file is "StateBased". Use this name when defining the versioning rule content that uses the loaded versioning XML file. For example, the argument to include in the versioning rule content for the out-of-the-box XML file is wt.series.HarvardSeries.StateBased.
You can create additional state-based versioning seeds by adding additional seed and value elements to the out-of-the-box XML file loaded into the database. However, the out-of-the-box Version Series drop-down list found in the Life Cycle Template Administration utility and the One Phase Development and Two Phase Development life cycle templates are not automatically updated to use the additional seed names. When adding additional seed names, ensure that the order of the seed names in the file is the same as the order in which the seeds are used in the life cycle.
When making these changes, you must customize the Life Cycle Template Administration utility using the Enumerated Type Customization utility (enumcustomize) and modify the life cycle template you want to use. For details on using this utility, see Enumerated Type Customization Utility.
When making these changes, you must customize the Life Cycle Template Administration utility using the Customize Modeled Enumerations utility and modify the life cycle template you want to use. For details on using this utility, see Customize Modeled Enumerations Utility.
Also, the Life Cycle Template Administration utility is not set up to use a series name other than the series name provided in the out-of-the-box XML file that is loaded. The series name that must be used is StateBased unless you customize the user interface.
When loading the XML file, the input schema is validated against the defined XSD. The seed name contained in the <seed> element is subject to the following qualifications:
• A seed name cannot be empty; it must contain at least one non-white space character.
• A period (.) cannot be used in a value.
• An (@) symbol cannot be used in a value.
• Any white space before or after a seed name is removed before the name is used.
• A seed name is not case sensitive (“seed_name_1” is equivalent to “SEED_NAME_1”).
• The seed names you specify must be unique within the entire series and specifying the same name multiple times is not allowed; however, you can use the seed names from one series in another series.
For additional information about using state-based versioning in your Windchill solution, see State-based Scheme.