Introduction

• The JS7 - Database will grow according to the number of workflows and jobs being executed. This includes an increase in the amount of data in the following areas:
  • Order History, Task History, Order Logs, Task Logs
    • The JS7 - History includes one record for each execution of an order and a number of records corresponding to the tasks executed with a workflow.
    • In addition, any log output created from jobs is stored in a compressed format.
  • Deployment History
    • Any operation that deploys an object, e.g. a workflow, is recorded, see JS7 - Deployment of Scheduling Objects
  • Daily Plan History
    • The JS7 - Daily Plan Service will create orders for each day which are maintained in the database.
    • In addition, order variables are recorded with the Daily Plan History.
  • Audit Log
    • Each operation modifying the status of an object is recorded, including:
      • orders created and submitted by the Daily Plan Service and by the Daily Plan view,
      • ad hoc orders added by users or clients using the JS7 - REST Web Service API
      • deployments of workflows and related objects
      • operations that suggest intervention such as cancelling, suspending and resuming orders.
    • Both the database Audit Log and the associated log file are stored persistently. See JS7 - Log Files and Locations for more information.

Cleanup Service

The JS7 - Cleanup Service is a background service that purges the database at configurable intervals.

• This service runs in background and is not subject to user intervention from the GUI except for adjustments to its configuration.
• This service is designed to be executed while workflows, jobs and other services are running. As soon as it detects such database related activity it will safely complete the current chunk of its purge transaction and will remain idle until no more database related activity can be detected.
• It is recommended that the Cleanup Service is used and that checks are made to ensure that the settings for frequency and retention periods match your requirements.
• After installation of JS7 the Cleanup Service is active and makes use of the default settings described below.

Configuration

The Cleanup Service can be configured from the JOC Cockpit Administration->Settings View:

Explanation:

• Execution Frequency
  • The days for execution of the service can be specified. If no days are specified then the service will not run and purge of the database remains a task to be completed manually.
  • For each day specified the service will run within the beginning and end of the period specified.
  • It is recommended that days and periods with relaxed scheduling activity are chosen, as this will reduce the number of times the Cleanup Service is interrupted by such activity. However, there will be no interference if workflows are executed while the service is running.
• Objects subject to Purge
  • JS7 - Order History and JS7 - Task History are purged in a common operation. 
  • Order logs and task logs are stored with the Order History and are purged when the specified retention period is exceeded. A frequent use case is to purge logs after a shorter retention period and to retain the execution history for a longer period as logs consume more space in the database. Note that it makes no sense to use a longer retention period for order logs and task logs than for the Order History as the logs would not be accessible by the GUI.
  • The JS7 - Daily Plan History usually is relevant for a shorter period only. It is mostly used to detect if for certain days no orders have been submitted. This is particularly relevant when the Daily Plan is manually managed by users and is not automated with use of the JS7 - Daily Plan Service.
  • For the JS7 - Deployment History the number of deployments per object is specified, e.g. workflow, that should be retained. If this number is exceeded then older deployment history entries will be purged.
  • The purge configuration for the JS7 - Audit Log should be considered with care as it can be subject to compliance requirements.
  • Monitoring and notification history entries by default are purged after the period of one day as longer periods are infrequently used for the JS7 - Monitor view.
• For further information about configuration and logging see JS7 - Cleanup Service.