Skip to content

Document Dispatch Job Queue

In the Document Dispatch module, a job queue automatically takes care of tasks like sending documents, updating their status, cleaning up old attachments, and getting entries ready for dispatch. These tasks run in the background at regular times, so everything works smoothly without needing manual input. This helps keep the document workflow fast, reliable, and well-organized.

New queue entries are created with the status Created before they are processed by their output type. The job queue then updates the status according to the selected dispatch channel and the processing result.

Job Queue Name Description Main Task
Document Dispatch – Prepare Await Entries Identifies all dispatch entries with the status "Awaiting" that have not yet been processed. Checks if entries are ready for the next dispatch step by verifying data completeness and background task completion. Updates status to "In Preparation" when ready.
Document Dispatch – Process Queue Entries Sends all entries marked as "Created" through their assigned dispatch channels. Collects necessary data and attachments, dispatches the documents, updates the status, and logs the result. Delayed B2Brouter entries with the status Created are also processed by this job queue.
Document Dispatch – Clear Sent Queue Attachments Removes attachments from dispatch entries that have already been successfully sent. Clears sent queue attachments to reduce storage usage and maintain system efficiency.
Document Dispatch – Automatic E-Post Letter Status Update Automatically checks and updates the status of letters sent via E-Post. Queries the E-Post system for delivery status and updates the entry accordingly, for example to Sent, Error, or Processing.
Document Dispatch - Unsent Dispatch Entry Crawler Job Queue Finds records that have not been dispatched. Scans your defined tables for documents without a dispatch entry and automatically creates unsent dispatch entries.

B2Brouter Queue Processing

B2Brouter entries are processed through the standard Document Dispatch queue. When a delayed B2Brouter entry has the status Created, the job queue prepares the invoice attachment and sends it to B2Brouter.

During processing, the entry is set to Error before preparation and sending start. This ensures that unsuccessful attempts remain visible in the queue. After a successful submission to B2Brouter, the entry is set to Processing Sending, unless it has already reached Sent.

The queue entry stores the B2Brouter document ID and the response information returned by B2Brouter. Administrators can use the B2Brouter Information action to review this response and the Update B2Brouter Status action to refresh the current B2Brouter status. The status update can reflect B2Brouter statuses such as sent, delivered, failed, and rejected.

Setting up Document Dispatch Job Queue

Job queues can be configured individually to suit your system requirements for example, by defining the starting time, ending time, and the interval in minutes between runs.

Follow these steps to configure a specific Document Dispatch job queue:

  1. Start as Document Dispatch Admin in the Role Center.
  2. Open the Job Queue Entries via the search or by scrolling down to the Job Queue Entries section.
  3. Click on the three dots and select Edit or View to open the Job Queue Entry Card.
  4. To edit the job queue, set it On Hold first.
  5. In the Recurrence Section, you can:
  6. Configure a start and end time for when the job queue should begin and end processing the dispatch entries.
  7. Configure the number of minutes between runs to define the interval at which the job queue will execute.

Setting up Document Dispatch Default Job Queue

It is possible to create default job queues for document dispatch. These queues define how dispatch tasks are processed automatically in the background, ensuring efficient and reliable handling

Follow these steps to create Default Document Dispatch Job Queues:

  1. Start as Document Dispatch Admin in the Role Center.
  2. Navigate to the Job Queue Entries section by scrolling down.
  3. Click Job Queue Entries and select the action Create Default Entries.

See also