Purpose
- The Cleanup Service is used to purge historic data that are no longer required. This includes data from the JS7 - History, the JS7 - Daily Plan history, the JS7 - Deployment history and the JS7 - Audit Log
- The execution history and logs of orders and tasks is purged.
- The history of submissions to the Daily Plan is purged.
- The deployment history is purged.
- A purge of historic data is performed in order not to fill up the JS7 - Database and to guarantee overall performance at an ongoing basis.
- For organizations that are subject to compliance requirements different retention policies might apply e.g. when it comes to the period for which task logs and audit log entries should be stored. In this situation consider the below mentioned default values for operation of the Cleanup Service and adjust them to your needs. This includes the option not to use the Cleanup Service and to manually purge the JS7 database.
Cleanup Order and Task History
When an order is launched for a workflow then this will create an order log and a task log. The order log includes any output of jobs and instructions in a workflow, the task log is available for each job individually.
Therefore the number of records in the order and task history depends on the number of workflows and jobs executed in a given period. The size of historic records depends on the size of output that is logged by your jobs.
Cleanup Daily Plan History
The JS7 - Daily Plan Service submits orders to any connected Controllers. The history of submissions allows to track the birth of orders, it is not related to the order and task history.
It is considered safe to purge entries from the Daily Plan History after orders completed.
Cleanup Deployment History
The Deployment History stores any objects that are subject to deployment, i.e. that have been forwarded to a Controller. The Deployment History allows to track the lifecycle of an object and to re-deploy objects from an older state.
It is safe to purge deployment history entries if you do not rely on falling back to an earlier version of an object, e.g. of a workflow.
The purge considers the number of versions per object that should be retained.
Cleanup Audit Log
The JS7 - Audit Log holds information about any operation performed to change the state of an object, e.g. to deploy objects, to add orders etc. Depending on the number of deployments and interventions to the cause of order execution the audit log can grow to some considerable size.
Organizations who are subject to compliance requirements should check if retention periods to purge the audit log meets their needs.
Configuration
Location
- The "Settings" menu is available from the JOC Cockpit GUI.
Configuration Items
| Section | Setting | Default | Required | Purpose |
|---|---|---|---|---|
| cleanup | time_zone | UTC | no | Specifies the time zone that is applied to the start time and period of the Cleanup Service |
| period | no | Specifies weekdays on which the Cleanup Service is performed. The first day of week is considered being Monday. When initially installing JS7 then the distribution includes the value: 1,2,3,4,5,6,7 | ||
| period_begin | 01:00 | no | Specifies the start time of the Cleanup Service for the given period, e.g. on a daily basis. | |
| period_end | 04.00 | no | Specifies the end of the period for which the Cleanup Service is allowed to run. If the Cleanup Service is earlier to complete its task then it will stop before the indicated time. However, it will not continue to run beyond the indicated time. | |
| batch_size | 1000 | no | Specifies the number of records that are purged within a single transaction. Increasing this value can improve performance, at the same time it will increase the risk of conflicts with concurrent transactions should parallel Services operate on the database. | |
| order_history_age | 90d | no | Specifies the retention period for the execution history of orders and tasks. Any history entries older than the value specified will be purged. | |
| order_history_logs_age | 90d | no | Specifies the retention period for orders and task logs. Any logs older than the value specified will be purged. Consider that this value should not exceed the value of the cleanup_order_history_age setting as otherwise no navigation to logs can be offered by the JOC Cockpit GUI. | |
| daily_plan_history_age | 90d | no | Specifies the retention period for the history of submissions with the Daily Plan. Any history entries older than the value specified will be purged. | |
| deployment_history_versions | 10 | no | Specifies the number of versions per deployed object that should be retained. Such versions can be used to re-deploy an object from an older state. Any earlier deployed versions of deployed objects are removed. | |
| audit_log_age | 90d | no | Specifies the retention period for the Audit Log. Any audit log entries older than the value specified will be purged. |
Logging
- The Cleanup Service logs general messages, warnings and errors to the
joc.logfile. - More detailed information in addition is logged to the
service-cleanup.logfile. - For details see JS7 - Log Files and Locations
Overview
Content Tools