Format of List-based Versioning XML File
The XML file used for defining a list-based versioning scheme must conform to the following format:
<?xml version="1.0" encoding="UTF-8"?>
<scheme>
<series name = "myListSeries">
<value>P1</value>
<value>P2</value>
<value>P3</value>
</series>
</scheme>
<scheme>
<series name = "myListSeries">
<value>P1</value>
<value>P2</value>
<value>P3</value>
</series>
</scheme>
 |
You must have the following:
• At least one series
• For each series, a minimum of two value elements
Seed is not required for a list-based scheme but is required for a state-based scheme.
|
In the XML file, the series name can contain any alphanumeric characters other than the period (.) or the at symbol (@). The series name you specify in the XML file is the name you must also append to wt.series.HarvardSeries to form the name used in the argument for the versioning rule content. For example, if the series name is "myListSeries", then the argument to include is "wt.series.HarvardSeries.myListSeries".
For additional information, see ObjRuleObjectVersioning.html.
When loading the XML file, the input schema is validated against the defined XSD. The values contained in the <value> elements can be any set of unique values with the following qualifications:
• A value cannot be empty; it must contain at least one non-white space character.
• A period (.) cannot be used in a value.
• Any white space before or after the value is removed before the value is used.
• The values you specify for the revision labels must be unique within the entire series and specifying the same value multiple times is not allowed; however, you can use the values from one series in another series
 |
It is recommended to use a minimal number of characters for the value so that when complete object identifiers are displayed it is not overly verbose.
|
The order of the values in the file determines the order in which the values are used as the version designator when the object is revised.
|
|
If you revise the scheme, ensure that you do not remove any values that are already in use. Also, removing a series name or a value from a series after the series has been in use causes problems for any existing objects that use the series or series value. For example, those objects could not be revised and the object iteration history could not be displayed. For information about how to allow characters that are no longer in a versioning scheme in the revision labels of existing objects, see Accommodating Legacy Values in Revision Labels.
|
The XML file to be loaded may contain only one scheme. The scheme may contain multiple series. When there are multiple series in the file, each series name must be unique. For example, the following XML file has two series defined:
<?xml version="1.0" encoding="UTF-8"?>
<scheme>
<series name="name1">
<value>P1</value>
<value>P2</value>
<value>P3</value>
</series>
<series name="name2">
<value>A_1</value>
<value>A_3</value>
<value>A_5</value>
<value>A_7</value>
</series>
</scheme>
<scheme>
<series name="name1">
<value>P1</value>
<value>P2</value>
<value>P3</value>
</series>
<series name="name2">
<value>A_1</value>
<value>A_3</value>
<value>A_5</value>
<value>A_7</value>
</series>
</scheme>
There are no out-of-the-box object initialization rules loaded that set versioning to list-based versioning as defined in this section and no out-of-the-box life cycle templates that use list-based versioning.