Loop

Definition

A Loop works based on Data Set Variables, so it is frequently used after Form and Document Data Lookup actions, however this is not mandatory, since you can use manually created Data Set Variables as well.

Other actions can be added inside a Loop. It will be configured as to compare the information with conditions you will establish and, as long as the break out condition is not met, the Loop will go to the next action inside its own flow.  After all of the inside actions are completed, the Loop End is reached and the next action on the Workflow can be started.

Instructions

Drag and drop the Loop action from the list on the left into the diagram, under the correspondent “+” icon.

Name and Description of both, Loop Start and Loop End boxes, can be customized on the Step Properties panel to the right.

In order to add actions inside the loop, simply drag and drop them under the square icon with a "+" sign.

The Loop will read the information contained on the Data Set Variable selected, run the comparisons, and as long as the break out condition is not met, it will execute the first action on its course. After that action is concluded, the comparisons will be checked again and if the break out condition is once more not met, the second action will be executed, and so on, until it reaches the Loop End. 

If at some point the break out condition is met, the action will not be executed and it will go directly to the Loop End.

Configure

To set up the conditions that will make the action stop looking for information and break out the loop, click on Configure.

Select the Data Set Variable that will be used as main data source.

Then click on + New Condition in order to get the first line of comparison.

Select your first source for the comparison.

• WF Variable: Variables created inside the Workflow you are working on.
• DS Variable: Group of variables created inside the Workflow you are working on.

Select the specific Variable you would like to use.

Indicate the kind of comparison you would like to apply.

The comparison options available on the drop-down list will be subjected to the type of data contained on the first field.

• = : Equal
• <> : Not Equal
• > : Greater Than
• < : Less Than
• >= : Greater Than or Equal
• <= : Less Than or Equal
• Range
• contains
• notcontains
• begins with
• ends with

Select the second source for your comparison.

• WF Variable: Variables created inside the Workflow you are working on.
• DS Variable: Group of variables created inside the Workflow you are working on.
• Value: Compare it with a specific value.

Then select the specific Variable or type in the Value you would like to use.

• If you select incompatible fields for comparison, you will receive an error message on the top of the screen and won't be able to continue.  Make sure you select fields that contain the same kind of data.  
• You can add more comparison lines by clicking on the + New Condition and remove them by selecting it on the left side of the item and clicking on Remove Condition.  

Operators

When more than one line of comparison is added, they can be separated with operators in order to indicate the server exactly what needs to be searched and compared, as well as in which order.

• And: all comparisons, or sets of comparisons, followed by AND need to be TRUE in order for the query to be TRUE. 
• Or: if at least one of the comparisons, or set of comparisons, followed by OR is TRUE, the query will be TRUE.
• Parenthesis: are available in case you need to set priority between the different lines or set of lines. Once you open parenthesis at the beginning of a line, it needs to be closed at the end of the same line or at the end of the group of lines you would like to prioritize.

After all comparisons have been established, click on Save to commit the changes and return to the workflow diagram.