For Each in a List Flow Step

Use the For Each in a List flow step to repeat a set of actions on a collection of items.

In this flow step, you define the collection of data. Then in your flow, nested under the For Each step, you add child flow steps that define the actions you want to perform on this collection.

Tip: You can use the helper code flow.loopItem() in a child step to reference a specific item in the collection. This may be helpful for targeting list items with specific features.

Note: When inside a For Each In a List step, you can only reference the input of the for each step, flow configs, and steps that are nested inside the for each step. For Each loops cannot see any steps outside the For Each loop. The best practice is to pass the data in a part of the For Each loop input.

On the App Xchange platform, the For Each step processes all items simultaneously, but the output of each iteration will be in the same order as the input.

Step Inputs

A For Each in a List step expects a collection or dataset as its input. In the Edit Step menu, you can configure the step as needed for your collection.

Step Detail

• List: Define the collection of data. For example:

This value identifies data that is coming from a set of budget items created by a previous flow step.

• Wait for all action responses: This option is off by default. Toggle this option if you want each child flow step to run and complete associated actions before proceding to the next flow step.

Step Outputs

When a For Each step runs, the child steps nested under the For Each in a List step are executed in parallel against each object in the collection. The output of the For Each step is the processed collection of data.

You can view the flow run status of a For Each in a List step from the Run Details page. When fetching the run data of a For Each in a List step, each run of the child flow steps is displayed as a numbered iteration. A maximum of five iterations are displayed at a time, prioritizing iterations that produced a code exception. The total amount of exceptions is displayed at the top of the visualization.

You can select an individual iteration to view the segment of code that produced the exception. Typically, a code change will fix all repeated exceptions. However, if you need to view additional iterations for further debugging, select Download JSON to view the full run details. 

Example Use Case

In most cases, the For Each in a List flow step is used to execute some sort of action on a dataset. Child Stop steps are commonly used to indicate the success or failure of these actions.

For example, consider a Filter flow step that sorts out Vista records with missing or mismatched job phases. You can add a For Each step to pass each Vista record to a child Connector Action flow step that adds Vista job phase data. You can then add two child Stop Flow steps to indicate if the job phase was added successfully or if the action failed.

In this scenario, the For Each in a List might have this setup:

This is how the For Each step might look with its substeps:

This means, for each job phase you add to Vista from ProjectSight, the flow will do the following:

1. Add a Vista job phase record if one does not already exist.

2. Stop the flow and send one of the following outcomes.

   • If adding the job phase record succeeded, send a message saying it was successful.

   • If adding the job phase record failed, send a message to indicate there was an error.

Was this helpful? Give us feedback.