Back Forward XML Stream form
Completing the Mapping tab

About XML Stream rules

zzz Show all 

If the Auto-generated XML? option is checked on the XML tab, a graphical tree layout appears on the Mapping tab. You can map elements and attributes to specific properties and define Node or Type definitions:

zzzBasics

Field

Description

Allow Tree Editing?

Enables the XML data to be edited using the tree control. This option is available only if Auto-generated XML? is selected on the XML tab.

Delete Delete an element or attribute and all of its child elements or attributes.
Add Attribute Add an attribute to the selected element.
Add Child Element Add a child element to the selected element.
Update Tree Content Click to update the contents of the tree structure based on the schema defined on the XML tab.

Double-click a tree node to display the Node Properties panel.

zzzCompleting the Node Properties panel — Mapping tab

Field

Description

Mapping Mode

Choose the method used to map XML elements to properties:

  • Standard — Auto-generate XML stream content based on the values listed in the selected node and any of its child nodes.
  • Literal XML — Insert the literal content of the Source Property into the XML stream instead of auto-generating XML content for the selected element.
  • Apply Rule — Insert the content of an existing XML stream instead of generating XML content for the selected element.
Context Page

Optional. Specify a page listed on the Pages & Classes tab or an embedded page or page list property to be used as the source for the XML stream data.

Source Property

Used only for Standard and Literal XML mapping modes. Specify the property to map the XML node from.

Stream Name

Used only for the Apply Rule mapping mode. Specify the XML Stream name to map the node from.

XML Type

Used only for the Apply Rule mapping mode. Enter the XML type of the stream chosen to map the XML node from.

zzzCompleting the Node 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 will appear in the generated XML stream content.

Node Namespace

Optional. Enter the namespace URI value that will be used to add a namespace prefix to the element tag in the generated XML stream content. If not provided, the element tag will not have a prefix and will not be namespace-qualified.

Is Optional?

Select this option to prevent the element or attribute from being added to the generated XML stream content when there is no clipboard data to be mapped.

Is Repeating?

Select this option if the element may appear more than once at this position in the XML stream content. If selected, provide a Page List property reference in the Context Page field or a Value List reference in the Source Property field to populate the XML instance with repeating clipboard data.

Is Nillable?

Select this option to add an empty tag containing the xsi:nil attribute to the generated XML stream content of an XML Stream rule when there is no clipboard data to be mapped. This option overrides the behavior of the Is Optional? option.

Substitution

Indicates whether this element or its content can be substituted at runtime using a different element or complex definition. This has no impact on XML stream generation, but may indicate that further configuration needs to be done to provide the correct results.

zzzCompleting the Node Properties panel — Type tab

Field

Description

XSD Base Type

Optional. Specify the built-in primitive type for this node. This value does not impact stream generation unless the Use SOAP 1.1 Encoding? option on the XML tab is selected. If this option is selected, the value is added to the element tag of the selected node as an xsi:type attribute.

Type Name

Optional. Specify the custom type name used to define this node. This value does not impact stream generation unless the Use SOAP 1.1 Encoding? option on the XML tab is selected. If this option is selected, the value is added to the element tag of the selected node as anxsi:typeattribute. This value overrides the XSD Base Type value.

Type Namespace

Optional. Specify the namespace URI value of the custom type used to define this node. This value does not impact stream generation unless the Use SOAP 1.1 Encoding? option on the XML tab is selected. If this option is selected, the value is added to the element tag of the selected node as an xsi:type attribute.

Default Value

Optional. Specify a value that will be used in the XML stream content when there is no clipboard data to be mapped. If a value is specified, it overrides the behavior of the Is Optional? and Is Nillable? options on the Node tab.

Value Constraints

Choose from a list of restrictions on the value of the selected node. The restrictions are not enforced by Process Commander, but may indicate the cause of validation errors in the application that processes the generated XML content.

Is SOAP Array?

Select this option to add a soapenc:arrayType attribute to the selected element tag for use in an encoded SOAP message. The Use SOAP 1.1 Encoding? option must be selected to enable this feature.

zzz About XML Stream rules