Skip to main content
Version: Current

Iterator

Description​

Iterates over a specified collection of items, processing each one at a time. For each item, the activity follows the Next path, executing the configured set of actions before moving to the subsequent item. Once all items have been processed (or if the collection is empty), the activity follows the Done path to complete the workflow.

Common settings​

Use Process Data to bind supported inputs to workflow values or upstream outputs. See Common Activity Features for shared execution, error-handling, and output-persistence settings. Availability depends on the activity.

Design-Time Configuration​

Display Text  ​

Specifies the name of the activity as displayed in the process.

Items  ​

Defines the collection of items to be iterated.

Output​

Current Item  ​

Represents the item currently being processed in the iteration.

Item Index  ​

Indicates the zero-based index of the current item.

Iteration Number  ​

Indicates the one-based iteration count.

Total Items  ​

Represents the total number of items in the collection.

Has More Items  ​

Indicates whether additional items remain to be processed (true if more items exist; otherwise false).

Flow Outcome​

Determines the workflow path based on the iteration state.

Next  ​

Triggered once for each item in the collection. Connect this path to the activities that should execute for every iteration.

Done  ​

Triggered once after all items have been processed, or immediately if the collection is empty. Connect this path to continue the workflow after the loop completes.

Execution settings​

Configure Wait All Incoming when execution paths converge, and On Error for failure handling. Select Inherit where available to use the workflow-level error policy.

Example: Process each email​

  1. Bind Items to Read IMAP Email → Emails.
  2. Connect Next to the activities that process one email. Bind those activities to the iterator's Current Item fields.
  3. Connect the final activity in that body back to Iterator. Each return advances to the next item.
  4. Connect Done to the activity that should run after the loop.

The collection is evaluated when the loop starts. Item Index begins at 0, while Iteration Number begins at 1. After the collection is exhausted, Done is emitted and Current Item is cleared; consume the item on the Next path. An empty collection follows Done immediately.

Help improve this page