Iterator - iterate over XML
Search form
Description - Iterate a loop for each portion of an XML document
Runtime Class - com.ibi.agents.XDIterXMLSplit
Parameter Groups
Parameter Type Description * Snip levels integer Number of top-down levels to be snipped from generated documents
* Expression string Describes the XPath location of the element on which to split. When "Evaluate Expression" is not set, enter an XPath expression directly. When "Evaluate Expression" is set, enter an expression that returns an XPath expression.
Evaluate Expression boolean When not set, the Expression parameter contains an XPath expression directly. When set, the Expression parameter is evaluated and the returned value is the XPath expression used for splitting.
XML Namespace Map Provider string If the XPath expression depends on namespaces, supply the name of an XML Namespace Map Provider that contains the required namespace prefixes and URLs.
* Cross Section boolean If set, the iterated portion is included with the remainder of the non-iterated portion of the document; otherwise only the parental path is included.
* Iterating Document State string In addition to content, a document carries state. How should the state be managed at the iterations?
Select from one of the following options:
- Transient {transient} - The looping document's state is carried to the next iteration
- Original {original} - Document state reflects the original document being split
- Reset {reset} - All signals such as error state are reset for each iteration
End Iteration Signal boolean Determines whether an extra iteration is added at the end to emit the End Iteration document. If applicable, the end of iteration signal will be emitted on the end_iteration edge. The default is not to emit the End Iteration document.
* Output document string 'status' - status document will be the out document; 'original' - in document will become the out document; 'accumulations' allow gathering of partial documents but can be memory intensive. Input is what passes from the iterator, output is what is returned for each iteration.
Select from one of the following options:
- Status {status} - Status document
- Original {original} - Document when originally passing into this service
- Loop Accumulation {accumin} - Accumulation of the input loop elements sent from the flow back into the iterator at each pass. The loop may have modified the document passed to the accumulation. For XML, the root name will be the node name. Use of accumulation can result in significant use of memory.
- Iterated Accumulation {accumout} - Accumulation of the output iterated elements of each pass; these are the documents that the loop services receive from the iterator. For XML, the root name will be the node name. Use of accumulation can result in significant use of memory.
XPath Syntax string Determines which syntax level of XPath should be used. The default option selects the syntax level as set in the console global settings.
Select from one of the following options:
- Default {default} - Use global default for XPath
- iWay abbreviated syntax {iway} - Use iWay fast/limited XPath
- XPath 1.0 full syntax {xpath1} - Use full XPath1 version
* - denotes required
Output Events
Runtime Class - com.ibi.agents.XDIterXMLSplit
Parameter Groups
Parameter Type Description * Snip levels integer Number of top-down levels to be snipped from generated documents
* Expression string Describes the XPath location of the element on which to split. When "Evaluate Expression" is not set, enter an XPath expression directly. When "Evaluate Expression" is set, enter an expression that returns an XPath expression.
Evaluate Expression boolean When not set, the Expression parameter contains an XPath expression directly. When set, the Expression parameter is evaluated and the returned value is the XPath expression used for splitting.
XML Namespace Map Provider string If the XPath expression depends on namespaces, supply the name of an XML Namespace Map Provider that contains the required namespace prefixes and URLs.
* Cross Section boolean If set, the iterated portion is included with the remainder of the non-iterated portion of the document; otherwise only the parental path is included.
* Iterating Document State string In addition to content, a document carries state. How should the state be managed at the iterations?
Select from one of the following options:
- Transient {transient} - The looping document's state is carried to the next iteration
- Original {original} - Document state reflects the original document being split
- Reset {reset} - All signals such as error state are reset for each iteration
End Iteration Signal boolean Determines whether an extra iteration is added at the end to emit the End Iteration document. If applicable, the end of iteration signal will be emitted on the end_iteration edge. The default is not to emit the End Iteration document.
* Output document string 'status' - status document will be the out document; 'original' - in document will become the out document; 'accumulations' allow gathering of partial documents but can be memory intensive. Input is what passes from the iterator, output is what is returned for each iteration.
Select from one of the following options:
- Status {status} - Status document
- Original {original} - Document when originally passing into this service
- Loop Accumulation {accumin} - Accumulation of the input loop elements sent from the flow back into the iterator at each pass. The loop may have modified the document passed to the accumulation. For XML, the root name will be the node name. Use of accumulation can result in significant use of memory.
- Iterated Accumulation {accumout} - Accumulation of the output iterated elements of each pass; these are the documents that the loop services receive from the iterator. For XML, the root name will be the node name. Use of accumulation can result in significant use of memory.
XPath Syntax string Determines which syntax level of XPath should be used. The default option selects the syntax level as set in the console global settings.
Select from one of the following options:
- Default {default} - Use global default for XPath
- iWay abbreviated syntax {iway} - Use iWay fast/limited XPath
- XPath 1.0 full syntax {xpath1} - Use full XPath1 version
* - denotes required
Output Events
Parameter Groups
| Parameter | Type | Description | |
|---|---|---|---|
| * | Snip levels | integer | Number of top-down levels to be snipped from generated documents | * | Expression | string | Describes the XPath location of the element on which to split. When "Evaluate Expression" is not set, enter an XPath expression directly. When "Evaluate Expression" is set, enter an expression that returns an XPath expression. | Evaluate Expression | boolean | When not set, the Expression parameter contains an XPath expression directly. When set, the Expression parameter is evaluated and the returned value is the XPath expression used for splitting. | XML Namespace Map Provider | string | If the XPath expression depends on namespaces, supply the name of an XML Namespace Map Provider that contains the required namespace prefixes and URLs. | * | Cross Section | boolean | If set, the iterated portion is included with the remainder of the non-iterated portion of the document; otherwise only the parental path is included. | * | Iterating Document State | string | In addition to content, a document carries state. How should the state be managed at the iterations?
Select from one of the following options:
|
End Iteration Signal | boolean | Determines whether an extra iteration is added at the end to emit the End Iteration document. If applicable, the end of iteration signal will be emitted on the end_iteration edge. The default is not to emit the End Iteration document. | * | Output document | string | 'status' - status document will be the out document; 'original' - in document will become the out document; 'accumulations' allow gathering of partial documents but can be memory intensive. Input is what passes from the iterator, output is what is returned for each iteration.
Select from one of the following options:
|
XPath Syntax | string | Determines which syntax level of XPath should be used. The default option selects the syntax level as set in the console global settings.
Select from one of the following options:
|
* - denotes required
Output Events
| Name | Description |
|---|---|
| OnFailedOperation | Could not perform the operation requested. |
| OnEndIteration | This is the extra iteration added at the end to emit the End Iteration document as requested. |