- 08 Sep 2023
- 1 Minute to read
- PDF
Overview of Batch Processing
- Updated on 08 Sep 2023
- 1 Minute to read
- PDF
Enterprise Batch Processing integrates with DocFusion's core capabilities to reliably generate large volumes of documents efficiently. It uses configurable Batch Types to validate and process DocFusion templates with XML data from client systems, then employs asynchronous file streaming and smart queueing to optimize hardware resources and network bandwidth. Large file sizes are also handled efficiently, which caters for documents that contain charts, images or have many pages. Batch processing is implemented via API or can be automated using the Sync Utility that monitors file system folders on a CRON schedule for document processing.
Typical Use-Case
Banks that produce account statements for large volumes of customers transfer their XML data to DocFusions's batch engine. Batches of documents are then processed based on the bank's account statement template. Once complete, client apps retrieve generated documents from the batch, or have a DocFusion workflow started automatically to handle the document, E.g. routing it to the customer via email.
Batching Concepts
Developers integrate with Enterprise Batch Processing using the API. To use batch processing, it's important to understand these concepts:
- Batch Type: Defines the batch processing settings for a batch constituting a specific DocFusion template to use when generating a document from input XML data, the output format (chain), and optionally a workflow.
- Batch: A container for a collection of Batch Records (documents for processing). Batches maintain information regarding their processing status.
- Batch Records: Represents each document within a batch for processing, with its metadata and input data payload.
Prerequisites
While Batch Types are usually created only once as a setup step for batches, it's important to verify that the associated DocFusion template generates correctly before creating batch types for it. This can be done using the previewing functionality of DocFusion Template Designer. It also helps to verify that the XML schema defined in a Batch Type to validate data is consistent with the document template's data model.
For Developers & Integrators
The DocBatch API contains endpoints to complete common batch management, monitoring or processing objectives.
- See the article 'Working with Batches via API' to get an understanding of typical endpoint flows.
- For assistance in the planning and setting up of batch processing for your DocFusion templates, review the article Planning Batch configuration & Batch Types.