Properties XML Encoding

This appendix describes how context variables (properties) are encoded into (and decoded from) XML.

Properties are encoded and decoded only when they are exported or imported using the Properties Editor. Otherwise, Iotellect stores and handles properties as Data Tables. Each property is a single Data Table.

Below is the XML Schema used to encode properties:

An XML schema is a description of a type of XML document, typically expressed in terms of constraints on the structure and content of documents of that type, above and beyond the basic syntax constraints imposed by XML itself. An XML schema provides a view of the document type at a relatively high level of abstraction. For more information, see http://www.w3.org/XML/Schema.

<?xml version="1.0"?>

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeFormDefault="unqualified" elementFormDefault="qualified">

<xs:element name="properties" type="propertiesType"/>

<xs:complexType name="validatorsType">

       <xs:simpleContent>

               <xs:extension base="xs:string">

                       <xs:attribute type="xs:string" name="contentType" use="optional"/>

               </xs:extension>

       </xs:simpleContent>

</xs:complexType>

<xs:complexType name="fieldType">

       <xs:sequence>

               <xs:element type="validatorsType" name="validators" minOccurs="0"/>

               <xs:element type="xs:string" name="help" minOccurs="0"/>

               <xs:element type="selectionValuesType" name="selectionValues" minOccurs="0"/>

               <xs:element type="xs:string" name="group" minOccurs="0"/>

               <xs:element name="defaultValue">

                       <xs:complexType mixed="true">

                               <xs:sequence>

                                       <xs:element type="xs:string" name="nullValue" minOccurs="0"/>

                                       <xs:element type="tableType" name="table" minOccurs="0"/>

                                       <xs:element type="dataType" name="data" minOccurs="0"/>

                               </xs:sequence>

                       </xs:complexType>

               </xs:element>

       </xs:sequence>

       <xs:attribute type="xs:string" name="name" use="optional"/>

       <xs:attribute type="xs:string" name="type" use="optional"/>

       <xs:attribute type="xs:string" name="hidden" use="optional"/>

       <xs:attribute type="xs:string" name="keyfield" use="optional"/>

       <xs:attribute type="xs:string" name="notReplicated" use="optional"/>

       <xs:attribute type="xs:string" name="nullable" use="optional"/>

       <xs:attribute type="xs:string" name="description" use="optional"/>

       <xs:attribute type="xs:string" name="editor" use="optional"/>

       <xs:attribute type="xs:string" name="advanced" use="optional"/>

       <xs:attribute type="xs:string" name="readonly" use="optional"/>

       <xs:attribute type="xs:string" name="inline" use="optional"/>

       <xs:attribute type="xs:string" name="extendableSelectionValues" use="optional"/>

</xs:complexType>

<xs:complexType name="fieldsType">

       <xs:sequence>

               <xs:element type="fieldType" name="field" maxOccurs="unbounded" minOccurs="0"/>

       </xs:sequence>

</xs:complexType>

<xs:complexType name="formatType">

       <xs:sequence>

               <xs:element type="fieldsType" name="fields"/>

               <xs:element type="bindingsType" name="bindings" minOccurs="0"/>

               <xs:element type="validatorsType" name="validators" minOccurs="0"/>

       </xs:sequence>

       <xs:attribute type="xs:int" name="maxRecords" use="optional"/>

       <xs:attribute type="xs:byte" name="minRecords" use="optional"/>

       <xs:attribute type="xs:string" name="reorderable" use="optional"/>

</xs:complexType>

<xs:complexType name="valueType" mixed="true">

       <xs:sequence>

               <xs:element type="xs:string" name="nullValue" minOccurs="0"/>

               <xs:element type="tableType" name="table" minOccurs="0"/>

       </xs:sequence>

       <xs:attribute type="xs:string" name="name" use="optional"/>

</xs:complexType>

<xs:complexType name="recordType" mixed="true">

       <xs:sequence>

               <xs:element type="valueType" name="value" maxOccurs="unbounded" minOccurs="0"/>

       </xs:sequence>

</xs:complexType>

<xs:complexType name="recordsType">

       <xs:sequence>

               <xs:element type="recordType" name="record" maxOccurs="unbounded" minOccurs="0"/>

       </xs:sequence>

</xs:complexType>

<xs:complexType name="tableType">

       <xs:sequence>

               <xs:element type="formatType" name="format"/>

               <xs:element type="recordsType" name="records" minOccurs="0"/>

       </xs:sequence>

</xs:complexType>

<xs:complexType name="entryType">

       <xs:sequence>

               <xs:element type="xs:string" name="string"/>

               <xs:element type="tableType" name="table"/>

       </xs:sequence>

</xs:complexType>

<xs:complexType name="defaultValueType">

       <xs:sequence>

               <xs:element type="xs:string" name="nullValue" minOccurs="0"/>

               <xs:element type="tableType" name="table" minOccurs="0"/>

               <xs:element type="dataType" name="data" minOccurs="0"/>

       </xs:sequence>

</xs:complexType>

<xs:complexType name="bindingType">

       <xs:sequence>

               <xs:element type="xs:string" name="reference"/>

               <xs:element type="xs:string" name="expression"/>

       </xs:sequence>

</xs:complexType>

<xs:complexType name="bindingsType">

       <xs:sequence>

               <xs:element type="bindingType" name="binding" maxOccurs="unbounded" minOccurs="0"/>

       </xs:sequence>

</xs:complexType>

<xs:complexType name="optionType" mixed="true">

       <xs:sequence>

               <xs:element type="xs:string" name="nullValue" minOccurs="0"/>

       </xs:sequence>

       <xs:attribute type="xs:string" name="description" use="optional"/>

</xs:complexType>

<xs:complexType name="selectionValuesType">

       <xs:sequence>

               <xs:element type="optionType" name="option" maxOccurs="unbounded" minOccurs="0"/>

       </xs:sequence>

</xs:complexType>

<xs:complexType name="dataType">

       <xs:sequence>

               <xs:element type="xs:string" name="nullValue"/>

       </xs:sequence>

</xs:complexType>

<xs:complexType name="propertiesType">

       <xs:sequence>

               <xs:element type="entryType" name="entry" maxOccurs="unbounded" minOccurs="0"/>

               <xs:element type="propertiesType" name="properties" minOccurs="0"/>

       </xs:sequence>

       <xs:attribute type="xs:string" name="class" use="optional"/>

</xs:complexType>

</xs:schema>

This XML Schema defines the structure of an XML file with exported context properties. The root element is properties. This element holds all exported properties.

The properties element contains zero or more entry elements. These elements contain individual properties.

The entry element contains two child elements: string and table. The string element holds the property name. The table element holds the Data Table for this property.

Data Tables for properties inside table elements are stored using the Data Tables XML Encoding format.

<?xml version="1.0" ?>

<properties>

<properties class="linked-hash-map">

       <entry>

               <string>connectionProperties</string>

               <table>

                       -- skipped --

               </table>

       </entry>

       <entry>

               <string>performanceTesting</string>

               <table>

                       -- skipped --

               </table>

       </entry>

       <entry>

               <string>genericProperties</string>

               <table>

                       -- skipped --

               </table>

       </entry>

       <entry>

               <string>managedVariables</string>

               <table>

                       -- skipped --

               </table>

       </entry>

       <entry>

               <string>managedFunctions</string>

               <table>

                       -- skipped --

               </table>

       </entry>

       <entry>

               <string>managedEvents</string>

               <table>

                       -- skipped --

               </table>

       </entry>

       <entry>

               <string>statisticsProperties</string>

               <table>

                       -- skipped --

               </table>

       </entry>

       <entry>

               <string>granulator</string>

               <table>

                       -- skipped --

               </table>

       </entry>

       <entry>

               <string>settingSyncOptions</string>

               <table>

                       -- skipped --

               </table>

       </entry>

       <entry>

               <string>ccmConfigurationManagement</string>

               <table>

                       -- skipped --

               </table>

       </entry>

       <entry>

               <string>ccmCompliancePolicies</string>

               <table>

                       -- skipped --

               </table>

       </entry>

</properties>

</properties>

Was this page helpful?

Tell us more

Send

Thank you!