Skip to content

Document Central Job Queues

Document Central uses job queue entries in Business Central to perform background operations such as archiving, repository synchronization, and retention policies. The extension automatically installs the default entries, but administrators can adjust the intervals or recreate the entries as needed.

Standard Job Queues

Job Queue Purpose Notes / Recommendations Executing Object Parameter String
Document Central Job Queue – Archive Processes the report queue and uploads documents generated by shadow printing to the configured repository. Default interval: every minute. Only relevant if shadow printing is enabled. Codeunit 5227515 ARCHIVE
Document Central Job Queue – Synchronize Document Library Automatically starts synchronization for all document libraries whose status in the synchronization list is "Ready." Default interval: every minute. Not used for manual synchronization: The "Start Synchronization" action triggers a synchronization run without this queue. Codeunit 5227515 SYNCHDOCLIB
Document Central Job Queue – Import / Map Processes imports and mappings of documents from the incoming list. Default interval: every minute. Only relevant for older versions without Document Inbound. Codeunit 5227515 IMPORT
Document Central Job Queue – Cycle Creation Creates and publishes future SharePoint subsites along with document libraries according to the configured cycle in the repository setup (e.g., annual sites for "2025", "2026"). Default interval: first day of the year. Only relevant for SharePoint repositories. Disable for other repository types. Codeunit 5227515 CYCLE
Document Central Job Queue – Clean Uploads Corrects internal upload status values for document entries where the upload to the repository was successful, but the status in Business Central is incorrect. Default interval: every minute. Only relevant for SharePoint repositories. Does not delete BLOB fields, but only corrects an internally used upload status. Codeunit 5227515 CLEANUPLOADS
Document Central Job Queue – Migration Migrates documents from a SharePoint site with basic authentication to the currently configured SharePoint site. The scope of the data to be migrated can be defined. Default interval: every minute. Only required during a SharePoint migration. Codeunit 5227515 MIGRATIONQUEUE
Document Central Job Queue – Search Indexer Indexes documents in Azure Blob Storage to provide full-text search over the repository. Default interval: every hour. Only relevant if Azure Blob Storage with full-text search enabled is used. Codeunit 5227515 SEARCHINDEXER
Document Central Job Queue – Set Retention Label Processes entries in the retention queue and assigns retention labels according to the respective entry. Default interval: every minute. Codeunit 5227515 SYNCRETENTIONLABELS
Document Central Job Queue – Retention Crawler Scans all documents, checks if a retention label is required, and creates corresponding entries in the retention queue. Default interval: every minute. Suitable if the retention feature was activated later. Transfers all documents that, according to configuration, should receive a retention label into the retention queue. Codeunit 5227515 RETENTIONCRAWLER
Document Central Job Queue – Clean BLOB Fields Removes all document BLOBs in the Business Central database (archive queue entries with status Archived, document entries) once the files have been securely stored in an external repository (e.g., SharePoint or Azure Blob Storage) to reduce database size. One-time run (no repetition). Only relevant if external repositories are in use. Used for error analysis and correction when BLOBs were accidentally stored in document BLOB fields in older versions. Use this queue if the document entry table occupies an unusually large amount of storage to check if this is due to the issue. Codeunit 5227515 CLEARBLOBFIELDS
Document Central Job Queue – Delete Expired Retention Deletes document entries whose retention label has expired. Only entries are removed where the property Automatic Deletion is enabled on the label in Document Central. Default interval: every minute. For SharePoint, automatic deletion must be enabled on the label in Microsoft Purview; this setting cannot be changed in Document Central. For Azure Blob Storage, automatic deletion is configured directly on the retention label in Document Central if it is to be used. Codeunit 5227515 DELETEEXPIREDRETENTION
Document Central Job Queue – Recreate Metadata Automatically starts the metadata recreation for all document libraries whose status in the Metadata Recreation list is "Ready." Default interval: every minute. Not used for manual recreations; the "Start Recreation" action runs immediately without this queue. Codeunit 5227515 RECREATEMETA

Info

You can control when and how often queues are executed in Business Central. Execution intervals can be adjusted, or individual queues can be disabled as needed. This can prevent automatic processes from running during a maintenance window.

Additional Usage Notes

Adjusting Execution Intervals

Administrators can adjust the interval of each job queue (e.g., every minute, hourly) to meet performance requirements, maintenance windows, or system load.

Configuring Error Threshold

In the Document Central setup, you can specify how many errors a queue run can have before warnings or notifications are triggered.

Use Cases for Repositories

The following job queues are relevant for SharePoint repositories.

  • Cycle Creation
  • Clean Uploads
  • Synchronize Document Library
  • Migration
  • Set Retention Label
  • Retention Crawler
  • Delete Expired Retention

The following job queues are relevant for Azure Blob Storage repositories.

  • Search Indexer
  • Clean BLOB Fields
  • Synchronize Document Library
  • Set Retention Label
  • Retention Crawler
  • Delete Expired Retention

The following job queues are relevant for all repositories.

  • Archive
  • Import / Map
  • Recreate Metadata

Configuring Error Handling

Through the module setup, you control how many errors a queue run can tolerate:

  1. Navigate to the role center Document Central - Administrator.
  2. Select Setup > Module Setup.
  3. Set the desired threshold in the Job Queue section in the field Maximum Errors per Job Queue.
  4. Save the changes.

Monitoring and Maintenance

  • Regularly check the status of the Document Central queues on the Job Queue Entries page.
  • Analyze entries in the Error status before increasing the allowable error value.
  • Keep dependent queues like Retention Crawler and Set Retention Label on compatible intervals when scheduling changes.
  • In sandbox environments, you can disable unnecessary queues to avoid unnecessary processing.

Info

Check the job queues after an update. In some cases, it may be necessary to restart the job queues to ensure that all processes continue to run correctly and completely. Even if a restart is not always necessary, it is advisable to check the current status of the job queues.

Creating a New Job Queue Entry

Follow these steps to create a new job queue entry:

  1. Start as Document Central Administrator in the role center.
  2. Open the Job Queue Entries via search or by scrolling down to the Job Queue Entries section.
  3. Click on Job Queue Entries to open the drop-down menu.
  4. Click on New.
  5. The Job Queue Entry Card, where you can make individual configurations, will open.

Various configuration options are available to you. You can choose whether to use a report or a codeunit as the executing object. Additionally, execution parameters as well as options for report formats and repetitions can be set. The configuration allows tasks to be executed automatically via the job queue to make processes efficient.

Setting Up Document Central Job Queue Entries

Job queues can be individually configured to meet your system requirements, such as setting the start time, end time, and the interval in minutes between executions.

Follow these steps to configure a specific job queue entry:

  1. Start as Document Central Administrator in the role center.
  2. Open the Job Queue Entries via 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 entry, first set it to On Hold.
  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 shipping entries.
  7. Configure the Number of Minutes Between Executions to set the interval at which the job queue runs.

Creating Standard Document Central Job Queue Entries

It is possible to create standard job queue entries for Document Central. These queues define how shipping tasks are automatically processed in the background to ensure efficient and reliable handling.

Follow these steps to create standard job queue entries:

  1. Start as Document Central Administrator in the role center.
  2. Navigate to the Job Queue Entries section by scrolling down.
  3. Click on Job Queue Entries and select the action Create Default Entries.