› Cloud operational dashboard › Enable logging

Enable logging

The automation agents (Core Worker and Transformation Server) in TotalAgility poll the database at regular intervals for automatic activities and system tasks to perform.

The Core Worker executes all standard automatic activities and system tasks whilst the Transformation Server executes all Capture-related automatic activities.

You can enable logging and specify a retention period for automatic activities, logged-on users, volume consumption, system tasks, and worker tasks. The retention period determines how long data is retained in the log before it is deleted. This cleanup process applies to entries from all tenants and environments, and controls the database size by regularly removing outdated log data.

For automatic activities, worker tasks, and system tasks, only items with a completed status are deleted, ensuring that long-running tasks can still be tracked. If logging is not enabled for any item, the retention policy removes all existing records for that item.

To enable logging, on the header bar, click Management Console > Logging.

The Logging page appears.

If logging is not enabled, entries are not written to the log.

Enable logging for automatic activities

You can enable logging for the automatic activities across all tenants and all environments for a defined retention period to check if the activities are being completed promptly.

  1. On the header bar, click Management Console > Logging.

    The Logging page appears.

  2. On the Logging page, under Automatic Activities, select Enable Logging. (Default: Clear)
  3. On the Retention Period list, select the retention period for clearing down older data. (Default: Last 12 hours)
  4. Click Save.

    A log entry is written with details of each automatic activity that is performed by the Core Worker or Transformation Server for all tenants and all environments on the deployment. For example, if the retention period for the automatic activities is "Last 9 hours",the completed history is only stored for the last 9 hours.

    Enabling logging for automatic activities is only supported for deployments using TotalAgility 8.1.0; it is not supported for deployments using earlier versions of TotalAgility.

Enable logging for user logons

You can enable logging to monitor the number of logged-on users, and the trends of their login times.

  1. On the Logging page, under Monitor User Logons, select Enable Logging. (Default: Clear)
  2. On the Snapshot Interval list, select the interval in hours. This determines the frequency at which the snapshots are captured. (Default: 0 Hours, Maximum: 24 Hours)
  3. On the Retention Period list, select the retention period for clearing down older data. (Default: Last 28 Days, Minimum: 1 Day)
  4. Click Save.

    The Management Console system task available in the tenant environment takes snapshots of the logged-on users based on the defined interval. A log entry is written with the number of logged-on users per tenant and environment at that particular time.

Enable logging for document volume

You can enable logging for the volume consumption (transformation page count) to view the number of documents being processed.

  1. On the Logging page, under Document Volume Used, select Enable Logging. (Default: Clear)
  2. On the Snapshot Interval list, select the interval in hours. This determines the frequency at which the volume snapshots are captured. (Default: 1 Hour, Maximum: 24 Hours)
  3. On the Retention Period list, select the retention period for clearing down older data. (Default: 1 Day, Maximum: 28 Days)
  4. Click Save.

    The Management Console system task available in the tenant environment takes snapshots of the transformation page count consumed by the tenant based on the defined interval. A log entry is written with the transformation page count consumed per tenant and environment at that particular time.

Enable logging for system tasks and worker tasks

The Core Worker regularly checks for the system tasks to perform for each tenant and environment. Each system task performs one or more (non-system) worker tasks.

For example, the Archiving System Task archives completed jobs by performing individual ArchiveJob worker tasks. It also removes items that have been marked for deletion by performing individual DeleteItem worker tasks. The system tasks and worker tasks are executed asynchronously via thread pools.

Enabling logging for the system or worker tasks is only supported for deployments using TotalAgility 8.1.0; it is not supported for deployments using earlier versions of TotalAgility.

  1. To enable logging for system tasks:
    1. On the Logging page, under System Tasks, select the check box for one or more system tasks as needed. To enable logging for all the system tasks, select the check box for System Task on the table header.
    2. On the Retention Period list, select the retention period for your system tasks. (Default: Last 12 hours)
    3. Click Save.

      A log entry is written with details of each system task that is performed for all tenants and all environments on the deployment.

  2. To enable logging for worker tasks:
    1. On the Logging page, under Worker Tasks, select the check box for one or more worker tasks as needed. To enable logging for all the worker tasks, select the check box for the Worker Task in the header.
    2. On the Retention Period list, select the retention period for your worker tasks. (Default: Last 12 hours)
    3. Click Save.

      A log entry is written with details of each worker task that is performed for all tenants and all environments on the deployment.