--- schema_version: "1" id: f4b9ec22e27201d8b7463a3e50501feec08b6a13080071a73954dce1699758b7 title: Manage a Omnistudio Document Generation Batch Process collection: admin version: current locale: en-us portal_url: https://docs.salesforce.com/admin/current/en-us/ind/264-0-0/doc_gen_manage_a_document_generation_batch_process.md canonical_url: https://help.salesforce.com/s/articleView?id=ind.doc_gen_manage_a_document_generation_batch_process.htm&release=264.0.0&type=5 source_site: help.salesforce.com content_type: documentation content_hash: 52e938b6e56af9835a4176bf58fbca50bf04e914e9b55c61fd28c08d07f9087a description: You can run, pause, queue, dequeue, and delete a document generation batch process. You can continue adding document generation processes to a batch while it is In Progress or Queued. You can run only one batch at a time. If multiple batches are queued, they run sequentially. You can’t modify a batch after it reaches completed. products: - Omnistudio Doc Gen release: "264" --- # Manage a Omnistudio Document Generation Batch Process You can run, pause, queue, dequeue, and delete a document generation batch process. You can continue adding document generation processes to a batch while it is In Progress or Queued. You can run only one batch at a time. If multiple batches are queued, they run sequentially. You can’t modify a batch after it reaches completed.

REQUIRED EDITIONS

Available in: Lightning Experience

Available in: Enterprise, Unlimited, Professional, and Developer Editions

User Permissions Needed

To run, pause, queue, dequeue, or delete a document generation batch process:

DocGen Designer

DocGen User

1. From Omnistudio, in the Quick Find box, enter document batch process. 2. From the Document Generation Batch Processes list, locate and open the document batch process that you want to manage. 3. Select Run, Pause, or Cancel. Here's what each action does:

Action	Description	Result	Status
Run	Starts the document generation batch process. You can run only one batch process at a time. Only one batch process can be in progress at a time. To start another, the current batch must complete or be paused or canceled. You can queue additional batches by setting their status to Queued. When no batch is in progress, the system automatically picks up the next queued batch based on the last modified date.	The batch process begins, triggering the individual document generation processes associated with it. Consider an hourly document generation throughput limit of 1000 per hour and a Batch Docgen Percent Limit Per Hour of 80% (0.8). If you have a batch request of 1300 documents, the system processes 800 (80% of 1000) in the first hour. The remaining 500 will be processed in the subsequent hour. This ensures efficient document generation without overloading the system.	When you click Run: The status of the batch process changes to In Progress. The status of each individual document generation process linked to the batch process also changes to In Progress. When the batch process is completed: The status of the batch process changes to Completed. The status of individual document generation processes that were successfully run within the batch changes to Success. If the execution is unsuccessful: If an individual document generation process within the batch fails, its status changes to Failed. If the batch process fails, its status changes to Failed.
Pause	Pauses the currently running batch process.	Halts all associated individual document generation processes.	When you click Pause: The status of the batch process changes to Paused. The status of each individual document generation process linked to the batch process also changes to Paused. If you resume the process, the statuses change to In Progress.
Cancel	Terminates the currently running batch process.	Stops all associated individual document generation processes.	When you click Cancel: The status of the batch process changes to Canceled. The status of each individual document generation process linked to the batch process also changes to Canceled.
Queue	Marks a document generation batch as ready for processing by adding the batch request to a processing queue. Use this action to move the batch to the Queued state so the cron job can process it when no other batch is in progress. The system automatically picks up the next queued batch based on the last most modified date.	The batch status changes from New to Queued. When the cron job finds no batch in In Progress, it updates one Queued batch to In Progress and begins document generation.	When you click Queue: The status of the batch process changes to Queued. When the cron job picks up the batch: The status of the batch process changes to In Progress. When the batch is completed: The status of the batch process changes to Completed.
Dequeue	Removes a batch from a processing queue without canceling it. This action allows you to temporarily remove a batch from the queue without permanently canceling it. Use this action if you need to change a batch that’s already been queued.	The batch status changes from Queued back to New. You can edit the batch and click Queue again when ready. This enables you to make necessary updates and then re-queue the same batch again without having to recreate it.	When you click Dequeue: The status of the batch process changes from Queued back to New. No changes are made to cron job logic. This is a user-triggered action only. When the cron job checks for batches: The batch is no longer in the queue and won’t be picked up for processing.