The iterate mediator implements an EIP (Enterprise Integration Pattern) -similar to the clone mediator and will split the message into number of different messages derived from the parent message by finding matching elements for the XPath expression specified. New messages will be created for each and every matching element and processed in parallel (default behavior) using either the specified sequence or endpoint. Created messages can also be set to process sequentially by setting the optional 'sequential' attribute to 'true'. The original message can be continued or dropped depending on the boolean value of the optional 'continueParent' attribute, in the same way as in the clone mediator. The 'preservePayload' attribute specifies if the original message should be used as a template when creating the splitted messages, and defaults to 'false', in which case the splitted messages would contain the split elements as the SOAP body. The optional 'id' attribute can be used to identify the iterator which created a particular splitted message when nested iterate mediators are used. This is particularly useful when aggregating responses of messages that are created using nested iterate mediators.
Figure1: Iterate Mediator
Iterate Mediator can be configured with the following options.