Skip to main content Skip to footer

XML Documentation

Version: 2.0.2 

Retrieved: 2025-10-09 15:16:28


XML

The module is used to shift between XML => Objects and Objects => XML. When XML is sent in it can be represented by string/byte[].

This module is designed to be located in the middle of a flow.

Settings

Name Requirements Purpose Default
Source Property Length: 0-64 The property where the XML or Object is located. Mandatory if source is XML data
Target Property Length: 0-64 The property to write the XML or Object to. Mandatory if target is XML. This property is added to the incoming message or changed if it already exists. data

Examples

Converting from XML to Object

When converting from XML the Source Property is mandatory to set. The data type of the XML to convert can be string or byte[].

Input

If Source Property is xml the expected input might be:

{ "xml": "<person><name>steve</name><age>45</age></person>"

Output

If Target Property is obj the result of the conversion will be written to the property obj on the output like:

    {
    "xml":
        "<person><name>steve</name><age>45</age></person>",
    "obj":
      { person: { "name": "steve", "age": "45" } }
    }

Note: if you leave Target Property empty (allowed when converting to object) you would get only the object as output: { person: { "name": "steve", "age": "45" } }

Converting from Object to XML

When converting from Object the Source Property is NOT mandatory to set.

Input

If Source Property is data.person the expected input might be:

{ 'data': {'person': {'name':'steve', 'age':45} } }

Output

When converting to XML the Target Property is mandatory to set. If Target Property is xml the result of the conversion will be written to the property xml on the output like:

    {
        "xml":"<person><name>steve</name><age>45</age></person>",
        "data":{
            "person":{
                "name": "steve",
                "age": 45
            }
        }
    }

Note: if you would use the same Target Property as Source Property you will overwrite the Source with the Target. So if you use data as both source and target you will get: { "data": "<person><name>steve</name><age>45</age></person>" }