In this blog, we will provide a comprehensive guide to understanding the For Each loop in MuleSoft.

What is the For Each loop in MuleSoft?

The For Each loop is a construct that allows developers to iterate over a collection of objects in MuleSoft. The collection can be an array, a list, a map, or any other iterable data structure. The For Each loop executes a set of actions for each element in the collection, enabling developers to perform various operations on the data.

How does the For Each loop work in MuleSoft?

The For Each loop in MuleSoft works by iterating over the elements in the collection and executing a set of actions for each element. The loop can be configured to execute synchronously or asynchronously, depending on the use case.

In MuleSoft, the For Each loop is implemented using the “foreach” component, which is available in the MuleSoft Anypoint Studio palette. Developers can drag and drop the foreach component onto their Mule flow and configure it with the desired collection and set of actions to perform.

Example Use Case

Let’s consider an example use case to understand how the For Each loop works in MuleSoft. Suppose we have a collection of customer orders, and we want to transform the data into a format that can be ingested by our accounting system. We can use the For Each loop to iterate over each order in the collection and perform the necessary data transformation.

Here’s an example MuleSoft flow that uses the For Each loop to transform customer orders:

<flow name="order-processing">
  <http:listener config-ref="HTTP_Listener_Configuration" path="/orders" allowedMethods="GET"/>
  <foreach collection="#[payload]" doc:name="For Each">
    <set-payload value="#[{
        'orderNumber': payload.orderNumber,
        'customerName': payload.customerName,
        'orderTotal': payload.orderTotal
    }]" doc:name="Set Payload"/>
    <http:request config-ref="HTTP_Request_Configuration" path="/accounting" method="POST" doc:name="HTTP"/>
  </foreach>
</flow>