Format of File-based Versioning XML File
The XML file that is loaded for use with file-based versioning must have the following format:
<?xml version="1.0" encoding="UTF-8"?>
<scheme>
<series name = "name1">
<value>P1</value>
<value>P2</value>
<value>P3</value>
</series>
</scheme>
|
|
You must have at least two value elements in your XML file.
|
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 "name1", then the argument to include is "wt.series.HarvardSeries.name1". For additional information, see
Object Versioning.
The values contained in the <value> elements can be any set of unique values with the following qualifications:
• There is no upper limit to the number of characters that can be specified in each value; however, if you use lengthy values, the complete object name can be longer than the user interface field in which it is displayed.
• A value cannot be empty; it must contain at least one non-white space character.
• A value cannot contain the series delimiter that is defined in the wt.properties wt.series.HarvardSeries.delimiter property. The default series delimiter is the period (.).
• 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.
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. |
You can only load one XML file; however, you can include multiple series in the one file. 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>
There are no out-of-the-box object initialization rules loaded that set versioning to file-based versioning as defined in this section and no out-of-the-box life cycle templates that use file-based versioning.
