Batch state allows you to execute a Function, Webhook, or Circuit in batches as multiple jobs in an iterative manner.

Collection Path

{
    "employee_list": [
        {
            "name": "John",
            "email": "john@zylker.com",
            "role": "Business Analyst"
        },
        {
            "name": "Helena",
            "email": "helena@zylker.com",
            "role": "Programmer"
        },
        {
            "name": "Mark",
            "email": "mark@zylker.com",
            "role": "QA Analyst"
        }
    ]
}

Collection Variable

Builder View

To configure a Batch state to your circuit:

1. In Builder View, drag and drop the Batch state from the left pane into your circuit or click the required Batch state in your circuit.

2. Under Configuration, update the common state field attributes.

3. In the Collection Path, enter the key that contains the JSON array with the values to be processed by the Batch state in the input JSON.

4. In the Collection Variable, provide a variable name to hold the JSON value or object extracted from the list specified in the Collection Path. The iterated JSON value or object can be accessed using this variable.

5. Using Bind Type, you can bind the Batch state to a Function, Webhook, or Circuit.

In this process, we are binding circuit developed for single employees onboarding and executing as a batch for multiple employees during the employee onboarding process.

6. In the No. of Jobs field, define the number of threads for each batch.
   
7. In the Input/Output section, configure the paths for the Batch state; refer to Input & Output Processing. 

      

‌If you define the Retry option for the Batch state, the retry policy applies only if all iterations of the Batch state fail. For example, if you configure the Retry field in a Batch state with three iterations, the retry policy applies only if all three iterations fail.

Code View

Batch state example:

"Employee Onboarding Tasks": {
      "type": "batch",
      "next": "End",
      "start": true,
      "collection_path": "$.employee_list",
      "collection_variable": "employee",
      "degree": 10,
      "bind": {
           "type": "circuit",
           "circuit_id": "new_employee_onboarding"
      }
}