/
XML data specification

XML data specification

XML data is the part of XML file that contains the object configuration of D2000 System or its sections.

Reserved sections

  1. REFERENCES - the section includes the structures representing the object and column references of object

  2. CFGRECORDS - the section includes the structure representing the data of object

  3. MEMBEROFLOGGROUP - the section includes member elements defining the logical group which the given object belongs to

  4. MEMBEROFRESGROUP - the section includes member elements defining the group of object which the given object belongs to

  5. CRC - the section includes the MD5 hash of data

  6. OBJLIFELOGS - the section includes the logs about the object history

The detailed information about the structures defining the objects of D2000 System, the attributes of structures, the value types of attributes and the values the attributes can acquire, can be find by the program to show the actual structure. This listing includes the unsupported objects and enumerated types.

REFERENCES reserved section

The example of section:
(the complete example is here)

<HOBJ_REF> <uid>A25DED0E4DA94B4895A119370E3AF4FB</uid> <name>SV.Limits</name> <objType>D2RECORD</objType> <valType>Rec</valType> </HOBJ_REF> <COL_REF> <col_idx>1</col_idx> <col_name>VHL</col_name> <col_valType>Int</col_valType> </COL_REF> <HOBJ_REF> <uid>USER_VAR</uid> <name>USER_VAR</name> <objType>SYSTEM</objType> <valType>NAN</valType> </HOBJ_REF>

It includes the structures:

  • HOBJ_REF - they represent the object references of object

  • COL_REF - they represent the column references of object (object must be a structure definition or the object refers to it)

Properties of the object references:

  •  minimal attribute name must be set in each object reference

  •  uid, objType and valType attributes are optional

  •  uid attribute has a priority to the name attribute at object references matching

Properties of the column references:

  •  the column reference follows the object reference

  •  minimal attribute col_name must be set in each column reference

  •  col_idx and col_valType attributes in column reference are optional

  •  col_idx attribute has the priority to the col_name attribute at column references matching 

CFGRECORDS reserved section

The example of section:
(the complete example is here)

<TObjItemData> <Id>0</Id> <Name>U.TimeSlice</Name> <Descript>Time Slice</Descript> <Typ>USER_VAR</Typ> <ParentId>USER_VAR</ParentId> <Value_Type>TmR</Value_Type> <CreateTime>08.10.2009 08:10:31.366</CreateTime> <ModifyTime>08.10.2009 08:18:02.938</ModifyTime> ... <uuid>5CB809E9342B7A46BD790A8C7D14C69E</uuid> </TObjItemData> <tUserVarData_Full> <tUserVarData> <MANUAL>True</MANUAL> <MANUAL_VAL/> <FLAGS/> <VALUE_TIME>08.10.2009 08:10:31.379</VALUE_TIME> <MONITOR>False</MONITOR> <SAVE_VALUE>True</SAVE_VALUE> </tUserVarData> <startVal/> </tUserVarData_Full>

This section must contain just the one structure TObjItemData at the beginning. It identifies the object uniquely. The configuration of this object is saved in XML file.
This structure is followed by another structures, they count and name depends on a particular type of object. See the example: the object is of USER_VAR type and contains the structure tUserVarData_Full.

Properties of identification structure:

  • Id attribute represents an Id of object (it is important at XML Import)

  • Name attribute need always to be set

  • uuid attribute has a priority to the Name attribute at object matching

MEMBEROFLOGGROUP reserved section

The example of section:
(the complete example is here)

<member>SELT\CD8FD25EF8A690341B111F5274CDB5AB</member>

Properties of member value:

  • it represents the object classification in the logical groups

  • it must contain the name of logical group (before the sign '\')

  • it can also contain uid of logical group (after the sign '\')

Note: This value affects the object membership in the logical groups at XML Import.

MEMBEROFRESGROUP reserved section

The example of section:
(the complete example is here)

<member>Home_s\04CB44144B2CD8E46955D846D30B0F72</member>

Properties of member value:

  • it represents the object classification in the object groups

  • it must contain the name of object group (before the sign '\')

  • it can also contain uid of the object group (after the sign '\')

  • if the name of object group is enclosed in '[' and ']' the object with children was inserted into group

CRC reserved section

The example of section:
(the complete example is here)

a7a8bda021932a3547e6553cb8980273

The CRC value represents MD5 hash formed from the contents of XML file. It includes data from <ROOT> element (<ROOT> element inclusive) to the row before CRC section (the signs CR, LF or both inclusive). The evaluation of CRC value is important for XML Import and XML Repository.

The evaluation of CRC value:

  • the section is included in data

  • :

    • MD5 hash corresponds to this value - data have not been modified

    • MD5 hash differs from this value - data have been modified

  • the section is not included in data - it is not possible to define whether data have been modified