Skip to content

Setting Up the Unsent Dispatch Entry Crawler

The Document Dispatch module allows for the creation of unsent entries within the system. This feature is particularly useful for identifying records that have not yet been dispatched. Unsent entries can be generated for any table and are created automatically via a crawler that runs through a job queue. This job executes every 60 minutes and checks for new unsent entries.

Configuration

To configure the Unsent Dispatch Entry Crawler, follow these steps:

  1. Open the Document Dispatch - Administrator Role Center.
  2. Use the search function to find Document Dispatch | Unsent Dispatch Entry Crawler Configuration.
  3. Open the configuration page.
  4. In the Table field, select the table for which you want to create unsent entries. Use the drill-down feature to choose from a list.
  5. In the Start Date Formula field, enter a date formula that determines how far back the crawler should look for unsent entries. For example, -30D will check for entries from the past 30 days. The current date is used as the reference point.
  6. In the Start Date Field, specify the field in your table that holds the date value to be used for filtering. By default, the system field Created At is used. All date and datetime fields are supported.
  7. In the Crawler Filter section, you can define filters for specific fields:
    a. Use the Field field to select the column to filter.
    b. Use the Field Filter field to specify the filter value.
    If a table relation exists, the drill-down function can help you select field names and values.
  8. Provide a description in the Description field to help distinguish between multiple crawler configurations for the same table. This is for internal use only and does not affect functionality.
  9. Activate the configuration by checking the Active checkbox. If left unchecked, the crawler will not run for this entry.

Using the Crawler

The crawler can be executed in two ways:

Job Queue

The crawler is scheduled to run automatically through a job queue. A default job queue entry is created upon installing the Document Dispatch module. It runs every 60 minutes and processes all active configurations to identify unsent entries.

Info

If the job queue entry was not created automatically, you can add it manually:
Open the Document Dispatch - Administrator Role Center, navigate to Job Queue Entries, and click Create Default Entries.

Manual Execution

You can also run the crawler manually:

  1. Open the Document Dispatch - Administrator Role Center.
  2. Search for and open Document Dispatch | Unsent Dispatch Entry Crawler.
  3. Run the crawler using one of the following options:
    a. Run Crawler for Selected: Runs the crawler for a single (selected) configuration entry, even if it is inactive.
    b. Run Crawler for All Active: Runs the crawler for all active configurations.

See Also