Collection letter generation

Overview

The Collection letter generation is a standalone job automatically creating collection letters for sending.

Trigger a job

To trigger a complete document processing job, follow these steps:

  1. Navigate to the Batch Dashboard module.
  2. On the upper right corner, select Collection Letter Generation from the dropdown list.
  3. Click the Trigger button in the Executions section.
  4. In the Trigger Job popup window, enter valid values to the mandatory trigger configurations.
  5. Click the Trigger button.

Once the execution is completed, the job will be listed in the Executions table. The output file is stored in the specified Output Path in the Trigger configurations.

Trigger configurations

The following parameters are mandatory when triggering this job:

Parameter Description
Template Code Unique identifier for the template used to generate or format the output files.
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.
Archive Path XML Specific archive directory for storing processed XML output files.
Error Path PDF Directory where PDF files that encountered errors during processing are saved.
Error Path XML Directory where XML files that failed processing are stored.
Manifest Path Location where the system writes or stores the manifest file summarizing processed data or outputs.

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.