For Each Wizard

This content applies to legacy design tools (such as K2 Studio, K2 for Visual Studio, or the Silverlight-based K2 workflow design tool). If you have upgraded from K2 blackpearl 4.7 to K2 Five, these tools may still be available in your environment. These legacy tools may not be available in new installations of K2 Five. These legacy tools may also not be available, supported, or behave as described, in future updates or versions of K2. Please see the legacy component support policy for more information about support for these components.

This wizard is found on the General Events node.

What does it do?

The For Each wizard creates dynamic reference and index fields to loop through items from an item collection.

How is it used?

The For Each wizard can be used in any scenario where an item collection must be converted into a list of items where something must be to done to each item in the list. This wizard is typically used in conjunction with the Create Reference wizard. The source list can be one of the following:

  • An Item Reference created in the workflow
  • An item collection from the Context Browser, such as a SmartObject List method
  • A semicolon-delimited text
  • It is important to note that a loop back must be manually created from the last outcome in the Next Item outcome path to the For Each event to ensure that the loop is closed. If the loop back to the For Each event is not created, the loop function itself does not occur. See the How to use the For Each wizard section for more detail.

  • Wizards can be edited. For more information see Edit Wizards.

Prerequisites

If an Item Reference or item collection is used as the source list of items , this must exist before dragging the For Each wizard onto the canvas.

Provide the Source, Reference and Index for use in the creation of the list.

Field Description Sample Value
Source The source list to loop through. It can be one of the following:
  • Item Reference created in the workflow. The Item Reference must contain a list or collection of items. One can only use a single item reference that returns a list of values.
  • Item collection dragged and dropped from the Context Browser
  • Semi-colon delimited text. Specify multiple collections by using a semi-colon.
Select a value from the drop down list, type semicolon-delimited text or drag and drop a field from the Context Browser. Click the toggle button to change the type of input
Reference The name of the Reference to be created. The field is auto-populated using the SmartObject selected. Specify another name if required. Type text in the field
Index The Index name used to create a Data Field which in turn serves as a unique identifier for each item in the list in order for the wizard to keep track of the items. The workflow automatically creates two outcomes for the For Each wizard (see next section for example):
  • Next Item - Index field used to determine if there is a next item
  • No More Items - Index field used to determine if there are no remaining items
 Type text in the field. No user actions are required to create the outcomes

The For Each wizard automatically creates two outcomes as part of the workflow. These outcomes are used to determine whether the loop should continue or not.

Outcome rules are created for each outcome. As long as the outcome rule for the Next Item resolves to true, the loop continues.

It is important to take note of the steps to follow when using the For Each wizard as failing to do so might result in unexpected behavior. The next steps can be followed as a guide to complete the workflow steps necessary to use the For Each wizard:

  • Create a source list to loop through
  • Drag the For Each wizard onto the canvas
  • Configure the wizard
  • Add more workflow steps to the Next Item outcome if required. One example is to send an email using the email address of the Item Reference created. Multiple workflow steps can be added to this outcome if required
  • Manually create a loop back from the last outcome in the Next Item path to the For Each wizard step by linking the outcome to the For Each as shown below. As a result, for every item in the collection, it will send an email to all email addresses within the collection until no items remain in the list. The workflow then continues to the No More Items outcome.

  • Continue configuring the workflow as required
  • The Create Reference wizard can be used with the For Each wizard as outputs from the Create Reference wizard are displayed as a flat list which is converted to a list of items within the For Each wizard.
  • A loop back should be created from the last outcome in the Next Item outcome path to the For Each wizard to ensure that the loop is closed.
  • If the loop back to the For Each wizard is not created, the loop function does not occur.