Introduction

The Batch Manager module enable an easy and powerful way to manage batch processes with thread paralelization, stats, error control and recovery mode out of the box.

The main capabilities are:

• Setup a Batch Job to execute whatever APEX Method you need.
• Set the number of parallel Threads.
• Automated Throttling mechanism to avoid hitting paralell batch limits.
• Customizable Hooks to add extra feature to the Batch Manager.
• Recovery Mode when the batch has not finished correctly.
• Ability to schedule batch executions.
• Out of the Box stats.

The Architecture

The Batch Manager is based both in Apex Classes and Salesforce Objects.

---

title: Batch Manager Architecture

---

erDiagram
  "BatchExecutor Class" ||--||   "BatchJob Class"  : ""
  "BatchJob Class" ||--|| "Batch Job Object" : ""
  "Batch Job Object" ||--}| "Batch Thread Object": ""
  "Batch Job Object" ||--}| "BatchableJob Interface": ""
  "Batch Thread Object" ||--}|  "Batch Request Object": ""

How does it work?

1. The first thing you need to execute a Batch it’s a Batch Job record. In this Record you will need to setup different Job options.
2. Once you have a Job you need to add as many Batch Requests as you want to the Batch Job.
3. In order to execute the Batch you can do it from the Batch Job record Page, from a Flow or through APEX.
4. When the Batch Job is executed:
   1. The number of required threads are calculated based on the Job setup and the number of requests.
   2. The Threads are created.
   3. The different requests are spread around all the different Threads.
   4. The Threads are executed:
   5. For each request in the thread, the Batch Manager will call the processRequest() method from the specified BatchableJob implementation.
   6. The Request will be updated with the resulting status, error, execution date, etc.

Creating Jobs and Requests

Both Batch Jobs and Batch Request are Salesforce Objects, so if you want to create a Batch and its related requests you only need to:

• Create a Batch Job record and setup the different options.
• Create the desired Batch Requests Records and link them to the created Batch Job.

Batch Job Fields

Batch Request Fields

Creating a Job Implementation

In order to create a Batch Job implementation you need to create a Class that implements the BatchableJob interface. Later, you will need to specify the name of this class in the Batch Job Batchable Job Class field.

You can find detailed documentation in the [BatchableJob Interface Documentation]({{< relref “batchablejobinterface” >}})

Number of Threads

The Batch Manager is based in the Salesforce’s Batch functionality, and each thread is related to one Batch. This means, that the governors limits apply and you can only execute a maximun of 5 batch. If you set the Number of Threads to a higher number they will be added to apex Flex Queue.

Keep in mind that the Apex Flex Queue can only hold up to 100 batches, so the Batch Manager will cap any value higher than 100 to the maximun number of available slots in the Apex Flex Queue.
In the future, the Batch Manager will only execute up to 5 threads, and as soon as one finishes, the BatchExecutor will execute the next pending thread if there is any.