The Iterator object allows you to repeat certain portions of a process flow over all or specified sections of an input document. The number of times a flow is repeated can be based on either a count, the result of a Boolean expression, or the structure of the document itself.

Important: The iWay Registry contains only those classes that support the iWay Samples. Therefore, when using Iterator objects in a Registry‑based project, you must add the iterator classes to the Registry from the base configuration through the iWay Service Manager Administration Console (select Tools, Archive Manager, Import components from managed server, click Next, and select base.) See the iWay Service Manager User’s Guide for details.

The following image shows the Iterator object icon.

The Iterator object works in conjunction with the Loop relation, which defines the path of the flow that is to be iterated. The following image is an example of a process flow using an Iterator object.

When the iterator completion condition is met, execution of the flow continues with the objects after the loop. Despite the appearance of the diagram in the Designer workspace, at completion, the flow ‘jumps’ over the objects inside the loop, otherwise the logic inside the loop would be erroneously executed one additional time.

Some guidelines for using Iterator objects in a process flow are:

• The loop must begin with an Iterator object. The flow cannot branch into an iteration loop.
• Iterator loops can be nested, however, loop lines can not cross.
• Only Execution objects (Service, Iterator, Transform, Process, WebService, SQL, ETL, BI, Email, FTP, File, HTTP, Emitter, Queue) can end a loop.
• Loops cannot be drawn from Control objects (Join, Junction, Decision Switch, Decision Test, Set, Sync, and Debug).

Note: See the iWay Service Manager User’s Guide for information on island, sibling, and status, as used in iWay.