Release 2.x‎ > ‎Install - Reference‎ > ‎Config Ref Guide‎ > ‎Converts‎ > ‎Converter‎ > ‎Structures‎ > ‎

Structure

The Structure, used within a Converter, supports the configuration options for specific elements of a Structure hierarchy.  The supported Structure elements are Converter implementation specific.

Syntax


            <Structure id="results">
               <Properties>
                  <Property name="children" value="list"/>
               </Properties>
            </Structure>


Arguments


 Name Required Description Example
 id yes  This is the name of a Structure Element that is being referenced and the Properties will be applied to this Structure Element
 id="results"


Properties


 Name Required Description Example
 children no This Property is currently only used by the JsonConverter class.  

This Property tells the Converter how to process the specified Structure's Child Elements.

If the value is set to "list" ... then the Structure's (id) children (sub-structures) are enclosed in the JSON "[ ... ]" Array notation.

[ {child1} , {child2} , {childN} ]

If this Property is NOT set ... then the Structure's (id) children (sub-structures) are a encoded as discrete JSON elements.

{child1} , {child2} , {childN}

 value="list"


XML Sub-Elements