Show all
Use the Mapping tab to
define XML Parse rules using a graphical tree control.
This tree structure was introduced in V5.5. Click Upgrade to enable the XML Tree Control on any Parse XML rule created prior to Version 5.5. Once the upgrade is complete, you cannot return to the former presentation of the parse rule.
In the tree structure, 
marks an element, and 
marks an attribute.
Double-clicking a tree node displays the Node Properties Panel.
Note Properties Panel — Mapping tab
Field
|
Description
|
| Mapping Mode
|
Choose the method used to map XML elements to properties.
Standard — Parse and extract data from the inbound XML based on the values listed in the selected node and any of its child nodes.Literal XML — Convert the XML content of an element, including its tag, attributes, character data, and/or child element content to a string and then set it as the value of the specified Property.Apply Rule — Invoke a component Parse XML rule to parse the content of the selected element node.
|
| Context Page
|
Optional. Specify a page listed on the Pages & Classes tab to be used as the target for parsed XML data values. You may also specify an embedded Page, Page List, or Page Group property. If a Page Group property is used, the name of the parsed attribute or element is used as the group subscript value. This is useful when [any] is specified as the Node Name value.
|
| Context Class
|
Read-only. Lists the class of the Context Page.
|
| Property
|
Used only for Standard and Literal XML mapping modes. Specify to map the character data of the XML node to.
You may specify a Single Value, Value List, or Value Group property. If a Value Group property is used, the name of the parsed attribute or element is used as the group subscript value. This is useful when [any] is specified as the Node Name value.
|
| Namespace
|
Used only for the Apply Rule mapping mode. Specify the Namespace key part of the parse rule that will be called to parse the element content. This may be different from the Node Namespace value.
|
| Element Name
|
Used only for the Apply Rule mapping mode. Specify the Element Name key part of the parse rule that will be called to parse the element content. This may be different from the Node Name value.
|
Note Properties Panel — Node tab
Field
|
Description
|
| Node Type
|
Specify if the selected node is an Element or Attribute.
|
| Node Name
|
Enter the attribute or element name that the generated parsing code will search for. You may set this value to [any] to indicate that the generated parsing code is to search for any attribute or element node at this location in the tree.
|
| Node Namespace
|
This option is typically set when the parse rule is auto-generated from an XML Schema Definition (XSD), and has no effect on parsing.
|
| Is Optional?
|
This option is typically set when the parse rule is auto-generated from an XML Schema Definition, and has no effect on parsing.
|
| Is Repeating?
|
Select to indicate that the element may appear more than once at this position in the XML data stream. If checked, provide a Page List or Page Group property reference in the Target Property field to map the XML content to repeating clipboard data values.
|
| Is Nillable?
|
This option is typically set when the parse rule is auto-generated from an XML Schema Definition, and has no effect on parsing.
|
| Substitution
|
Indicates whether this element or its content can be substituted at runtime using a different element or complex type definition. This option, as well as the content of the Type Substitution and Element Substitution tables on the XML tab of the parse rule, is typically set when the parse rule is auto-generated from an XML Schema Definition.
By using the Apply Rule mapping mode, the actual component parse rule instance that is applied to parse the element content can be determined dynamically at runtime by matching the type or element name from the inbound XML document with an entry in either the Type Substitution or Element Substitution table. If found, the Class Name specified in the third column of the table will be used to select the most appropriate Parse XML rule to process the element content.
|
Node Properties Panel — Type tab
Field
|
Description
|
| XSD Base Type
|
This option is typically set automatically when the parse rule is auto-generated from an XML Schema Definition, and has no effect on parsing.
|
| Type Name
|
This option is typically set when the parse rule is auto-generated from an XML Schema definition, and has no effect on parsing.
|
| Type Namespace
|
This option is typically set when the parse rule is auto-generated from an XML Schema definition, and has no effect on parsing.
|
| Default Value
|
This option is typically set when the parse rule is auto-generated from an XML Schema definition, and has no effect on parsing.
|
| Value Constraints
|
These values are typically set when the parse rule is auto-generated from an XML Schema Definition, and have no effect on parsing.
|
| Is SOAP Array?
|
This option is typically set when the parse rule is auto-generated from an XML Schema Definition, and has no effect on parsing.
|
Parser Steps (Deprecated)
Parse Type (Deprecated)
Parse XML
form
