1. What Does This Page Cover?

2. Availability

Batch workflows feature:

1. Is available only for paid plans of Creator, with a limited number (refer Things to Know) of batch blocks for each plan
   
2. Can only be created, enabled, and managed by the super admin, admins, and developers, while other users can benefit from the automated execution of repetitive tasks.
   
3. Is available in all data centers
   

3. Overview

4. Batch workflows in Creator

1. You can select a batch size that optimizes the overall script execution time and resource utilization, thus balancing performance with processing efficiency.
   
2. If an error occurs in one of the batches during the batch workflow execution, that particular batch alone will be reverted. This means that an error in one batch doesn't affect the successful execution of other batches in the same batch block.

4.1 Examples of processes that batch workflows can automate

1. Periodic billing - Calculate the total amount periodically for individual billing dates.
2. Invoice generation - Generate sales invoices as per your requirements
3. Payroll processing - Mail monthly salary slips for each employee in your organization.
4. Inventory management - Track the product stock periodically to never go out of stock.
5. Detect fraudulent transactions - Generate monthly statement bills for credit cards to detect frauds.

5. Stages in a Batch Workflow Execution

Note: The Before and After Execution blocks are optional based on your requirements. However, you must configure the script to be executed in the During Execution block.

1. Before Execution of Batch Workflow:  You can define variables, initialize their usage (applicable to be used in other two blocks as well), and configure the required actions to be carried out before the execution of batch workflow begins. Examples of initialization actions include sending notifications before the process begins, webhook calls to fetch stock from inventory and prepare a list from a response, and so on. Learn how

The Before Execution block will be executed first upon start of the batch workflow execution and will be executed only once.

1. During Execution of Batch Workflow: Here, you can configure a single action to be executed for every record in a batch block. This action will be performed for every record when the batch workflow execution is in progress. For example, you can configure to calculate every employee's monthly salary that includes taxes, benefits, and much more. Learn how

The During Execution block will be executed in iteration until all batch blocks in that batch workflow are completed.

1. After Execution of Batch Workflow: You can configure actions to be executed after the execution of all batches to handle both the success and failure scenarios, such as allowing cleanup tasks, displaying respective (success/failure) notifications, and error handling. For example, you can configure to notify an employee through email to  them about their monthly payslip after the successful completion of your batch workflow execution. Learn how

6. Prerequisites

1. You must have a form in your application based on which you can configure a batch workflow.
2. You need to decide when to trigger the batch workflow and an idea of the number of records i.e each batch's size.
   

7. See How it Works

8. Use Cases

1. Perform initialization tasks, including notifications to relevant stakeholders about the commencement of lead processing.

1. Configure the batch size to handle leads in manageable chunks.
   
2. Develop scripts to calculate lead scores based on predefined criteria and assign appropriate lead owners using territory mapping or workload distribution algorithms.

1. Implement actions based on the success or failure of batch execution.
   
2. Notify stakeholders about the completion of lead processing and provide insights into the processed leads, including statistics on lead scores and ownership assignments.
   
3. Thus, this feature enables automated processing of lead data in manageable batches, ensuring efficiency and accuracy.
   

9. Navigation Guide to Create a Batch Workflow

10. Things to Know

1. You can configure batch workflows in the following cases — after successful import of your application's records or at a specified time.
   
2. You can create multiple batch workflows based on the same form with different or identical conditions. 
   
3. All the batches in a batch block will be executed sequentially.
   
4. You can track the status of batch workflow executions through the application logs section. It provides visibility into the queue status, in-progress executions, and completion status (success or failure).
   
5. You can view error logs for the first 5 batch block failures, providing insight into the reasons for execution failures.
   
6. If one or more batches in a block fail, that particular batch alone will be reverted, and the batch workflow will still continue executing other batches. You can view the that block's failure message in logs.
   
7. You can execute batch workflows for batches in sizes of 10, 50, 100, 200, 500, and 1000 records.
   
8. You can create up to 100 batch workflows at a time in your account.
9. You can execute up to a certain number of batch block executions per account in a day based on your pricing plan. 
10. The execution timeout for each batch is set to 1 minute i.e., if a batch block's size is configured as 1000, then the timeout for the execution of those 1000 records will be 1 minute.
    
11. Similarly, the timeout for before and after execution batch blocks is 30 seconds each.

11. Limitations

1. This workflow is currently not supported for integrations forms.
   
2. Users can create up to 5 variables within a batch workflow.
   
3. Only one batch workflow can be executed concurrently for an account (based on creation date). This means that additional batch workflows will be queued for execution, thereby ensuring fair resource allocation and preventing overload on system resources.
   
4. You cannot trigger batch workflows for records imported by portal users in customer portal.
   
5. Each batch workflow is limited to three integration tasks or webhook calls per record execution.

1. The "old" keyword is not supported in batch workflows.
2. You can configure upto 10 CRUD actions like add, update, and delete for each records in a batch workflow.
3. You cannot fetch more than 200 records.
4. Info message cannot exceed 50KB. Otherwise, the message will be truncated.
5. You can send up to a maximum of 3 email notifications with attachments.
   
6. The maximum size of file attachments allowed is 15 MB. If the attachments exceed this limit, the emails will be delivered without them.
   
7. If you want to get the content of the specified file or create a file object using the required content, the respective file size should be less 2 MB.
8. getUrl() and postUrl() tasks are currently not supported.
9. You cannot assign values to global variables. You can still access them using info statement.
10. The following Deluge operations are not supported in batch workflows. 
1. Fetching all values of a field
   
2. Using aggregate functions (except count) on fetched records
   
3. 'Call Function' task 
   
4. Built-in functions such as:
   
1. matches()
   
2. ReplaceAll()
   
3. ReplaceFirst()
   
4. ReplaceAllIgnorecase()
   
5. ReplaceFirstIgnoreCase()
   
6. Compress()
5. Client functions
   

12. Related Topics

1. Understand records
2. Create and manage batch workflows