Reporting server

The Capture data is stored in a Reporting database. You can define how this data should be handled.

In an on-premise multi-tenant environment, the "Enable Reporting" feature and the retention period settings (for documents and unprocessed incomplete messages) are not available in the TotalAgility Designer (System setting > Reporting Server). These settings are available on the "Create Tenant" page of the Kofax TotalAgility Tenant Management System. See the Kofax TotalAgility Tenant Management System Help for more information.

Enable Reporting
By default, Enable the Reporting feature is clear, which means all the reporting server settings are not enabled. Select this option to enable sending the information for the Reporting component and processing Reporting messages. setting. If you try to clear the setting once enabled, you are prompted to confirm deleting any unprocessed reporting data from the staging database before saving the change. You can choose to delete or retain the data by selecting either option.
  • Yes: All the reporting data is deleted and cannot be recovered.

  • No: The unprocessed reporting data is retained in the staging database.

Reporting warehouse ETL agent

The period within which the Reporting service performs the Transform and Load steps of the whole Extract/Transform/Load process.

By default, these steps are executed between 0 Hrs 0 Mins and 23 Hrs and 59 Mins.

For the on-premise multi-tenant and Azure environments, the system tasks are created per-tenant basis with a one-minute interval between the tasks for one tenant. Each task is handled separately, and appropriate pairs of Staging/Warehouse databases are processed with one pair per system task.

  • This setting is configured once per TotalAgility installation for an on-premise environment, and per tenant for on-premise multi-tenant and Azure environments.

  • Using this setting, you can narrow down the processing of only the Warehouse database to tenants' nightly hours and improve Warehouse database availability for customers.

Data retention period
Specify the following for Data retention period:
  • Documents: The period for which the data associated with the documents can be stored. (Default: 30 days)

  • Unprocessed incomplete messages: The period for which the unprocessed incomplete messages can be stored. (Default: 30 days)

Reporting escalation
You can set the thresholds to launch the escalation process.
  • Maximum single increase: The maximum single increase value of the Reporting escalation. (Default: 50,000, minimum set to 10000)

  • Consecutive increase: The consecutive increase of the Reporting escalation. (Default: 3, and minimum set to 1)

  • Escalation process: Select a process to launch for Reporting escalation.

    If the required process is not available, you can create a new process with the specified name. On clicking OK, a new process is generated with the following input variables as initialization parameters.

    Initialization parameter

    Variable type

    Purpose

    ESCALATION_REASON

    String

    The reasons for escalation such as "Daily threshold value is exceeded", "The count of consecutive increases", "Data loss imminent", and "ETL (Extract, Transform, and Load) processing issue."

    MAX_SINGLE_INCREASE

    Long

    Maximum single increase of Reporting escalation.

    CONSECUTIVE_INCREASES

    Long

    Number of consecutive increases.

    NO_OF_WSA_MESSAGES

    Long

    Number of WSA (Web Security Appliance) messages nearing removal.

    NO_OF_ETL_JOBS

    Long

    Number of ETL jobs that are not completed.