Complete document processing
Overview
The complete document processing is composed of the following jobs:
- XML to PDF conversion
- Supplemental CSV processing
- Document packaging
Trigger a job
Ensure that the input files are uploaded to the specified paths in the Input Path fields in the Trigger configurations.
To trigger a complete document processing job, follow these steps:
- Navigate to the Batch Dashboard module.
- On the upper right corner, select
Complete Document Processingfrom the dropdown list. - Click the Trigger button in the Executions section.
- In the Trigger Job popup window, enter valid values to the mandatory trigger configurations.
- Click the Trigger button.
When a job is triggered, a live execution window is displayed:
Once the execution is completed, the job will be listed in the Executions table. All output files are stored in the specified Output Path in the Trigger configurations.
Trigger configurations
The following parameters are mandatory when triggering this job:
XML to PDF
| Parameter | Description |
|---|---|
| Template Code | Unique identifier for the template used. |
| Chunk Size | Defines how many records or items are processed per batch during execution. |
| Input Path | Directory location where the system reads or retrieves the source files. |
| Output Path | Folder where processed or generated output files will be saved. |
| Archive Path | Main directory where completed or processed files are stored for long-term retention. |
| Error Path XML | Directory where XML files that failed processing are stored. |
| Error Path PDF | Directory where PDF files that encountered errors during processing are saved. |
| Archive Path XML | Specific archive directory for storing processed XML output files. |
| Manifest Path | Location where the system writes or stores the manifest file summarizing the XML to PDF process. |
Supplemental
| Parameter | Description |
|---|---|
| Chunk Size | Defines how many records or items are processed per batch during execution. |
| Input Path | Directory location where the system reads or retrieves the source CSV files. |
| Output Path | Folder where processed or generated output files will be saved. |
| Archive Path | Main directory where completed or processed files are stored for long-term retention. |
| Error Path | Directory where files that failed processing are stored. |
| Manifest Path | Location where the system writes or stores the manifest file summarizing processed supplemental data. |
| Split Param | Displays the list of parameters in Abbreviation and Columns Names columns. |
| Client Id Columns | Displays the list of Client ID columns in Abbreviation and Columns Names columns. |
| Invoice Date Columns | Displays the list of Invoice Date columns in Abbreviation and Columns Names columns. |
Packaging
| Parameter | Description |
|---|---|
| Chunk Size | Defines how many records or items are processed per batch during execution. |
| Manifest Path | Location where the system writes or stores the manifest file summarizing the packaging process. |
Control flags
The following controls are available:
| Control | Description |
|---|---|
| Notification Email | Email address that will receive status updates or alerts after processing. |
| Move to Archive After Success | Automatically moves successfully processed files to the archive folder. |
| Move to Error on Failure | Sends files that fail processing to the designated error directory. |
| Create Manifest | Generates a manifest file summarizing the details of the processed batch. |
| Auto Approve | Automatically approves the process or output without requiring manual validation. |
Reset to default
When the Reset to Default is clicked, all the fields values will be replaced with the default values.