XML Iterator

The adapter reads an XML file from any valid URL incrementally into a Technical Process and outputs for each iteration a child element (including all child nodes) of the root element as XML document.

Properties

Operation

Defines the operation executed by the adapter

Possible values:

Iterate: Read child node of the root element
Clear: Reset iterator of an XML Iterator, which has the same ID as the respective XML Iterator with the operation Iterate (see parameter id)

After executing the Iterate operation, execute the Clear operation to avoid possible resource leaks.

Parameters

Adapter

Main adapter class (do not change!)

Possible values: de.softproject.integration.adapter.xmliterator.XmlIterator: Main class (default)

url

URL of the XML document to be read

Possible values:

Any valid URL (e.g. xstore://Project/Folder/File.xml)
URL to a UNC network drive (e.g. file://///storage/share_data/Folder/File.xml)

id

Unique ID of the XML Iterator component within the process context respectively the process instance (if you want to use several XML Iterators iterating independently within the same process context)

Possible values:

0: Use current action ID (number of the process step of the XML Iterator within the current process) as ID; Please note that an XML Iterator may have the same action ID in a sub-process (default)
Any integer number except 0, to uniquely identify the respective XML Iterator component within the process context; Recommendation: use a value >1000, to avoid that an already existing action ID is taken "accidentally"

State values

-1 (error)	An error occurred during the adapter's execution (see X4 Server log).
0 (empty)	The adapter doesn't output data (anymore). This status can be used as stop criterion of a loop within the Technical Process and it indicates that no further data set is available.
1 (successful)	The adapter outputs a result. This status can be used as condition to enter a loop within the Technical Process and it indicates that another data set is available.