Help Documentation

Main Operator Documentation

Operation Operators

Operation Operators are used to allow Automations to loop over list items and perform actions on each element individually.

The currently available Operation Operators include:

• Add To List - Adds items to the list.
• Iterate - Iterates the list.
• Make A List - Creates a list.
• Merge - Merge branches back together.
• Remove From List - Removes items from the list.

Add to List

Add to List Operator is used in an Automation flow to add items to a list during execution.

Input Fields (Settings)

• Default Configuration: This picklist field enables you to choose a default configuration. This will automatically populate all fields for that operator with default configuration values wherever available.
• List: The list you want to add items to.
• Item to Add: The items you want to add to the list.

Output Fields

• List: The list to which items were added to.
• Item: The items that were added to the list.

Note: When mapping the output fields of this operator to downstream operators, they are to be mapped to the values of the list and not the name of the list.

Iterate

Iterate Operator is used in a Automation flow to go through a list of records one by one and perform actions on each item in that list.

Input Fields (Settings)

• Default Configuration: This picklist field enables you to choose a default configuration. This will automatically populate all fields for that operator with default configuration values wherever available.
• Input List: The list that Iterate operator will loop through.

Output Fields

• Input List: The list that Iterate operator looped through.

Make a List

Make a List Operator is used in an Automation flow to create a list.

Input Fields (Settings)

• Default Configuration: This picklist field enables you to choose a default configuration. This will automatically populate all fields for that operator with default configuration values wherever available.
• List Type: The type of list that is to be created.
• List Name: The name of the list that is to be created.
• Inputs: The items that are to be added to the list.

Output Fields

• List Type: The type of list created.
• List Name: The name of the list created.
• List: The list that is created.

Note: When mapping the output fields of this operator to downstream operators, they are to be mapped to the values of the list and not the name of the list.

Merge

Merge Operator is used to merge branches that are within an Automation flow back together.

This allows for the data from multiple branches to be brought into one operator. The Merge Operator waits for all merged branches to finish before adding the results to the merge.

• You can only connect one operator within a branch to the same Merge Operator.
• However, multiple operators within a branch can be merged to separate Merge Operators, and can be merged to multiple Merge Operators.
• Failures within any branches that are merged will stop the Merge Operator.

Input Fields (Settings)

• Default Configuration: This picklist field enables you to choose a default configuration. This will automatically populate all fields for that operator with default configuration values wherever available.
• (+)Connect Branch
Use the Connect Branch button within the Merge Operation to select the operator within a branch that you want to merge. Continue connecting operators from different branches. Only one operator per branch can be merged in the same Merge Operation. However, different operators within a branch can be merged into multiple Merge Operations.
• Add Field Button (+): Use the plus button to add a new merge connection entry to the end of the current list. There will be two text boxes associated with each entry as described below:
  • Field Name: This will be the name shown within the field map selection tab to reference this value.
  • Field Value: This will be the value output when the field is accessed by another Operator. This can be a value set as a Field Map from another Operator or a static text value specified in the Settings tab.
  • Note:Adding fields with the (+) button does not merge branches. It simply allows you to add additional fields to provide values or to map.

Output Fields

• The Output tab for Merge Operator will show any added fields and the field names applied to them.

Remove From List

Remove from List Operator is used in an Automation flow to remove items from the list.

Input Fields (Settings)

• Default Configuration: This picklist field enables you to choose a default configuration. This will automatically populate all fields for that operator with default configuration values wherever available.
• List: The list you want to remove items from.
• Item to Remove: The items you want to remove from the list.

Output Fields

• List: The list from which items were removed.
• Item: The items that were removed from the list.