Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

SectionSettingDefaultRequiredPurpose
cleanuptime_zoneUTCnoSpecifies the time zone that is applied to the start time and period of the Cleanup Service

period
noSpecifies weekdays on which the Cleanup Service is performed. The first day of week is assumed to be Monday. When initially installing JS7 then the distribution includes the value: 1,2,3,4,5,6,7. Without this setting the Cleanup Service will not start.

period_begin01:00:00noSpecifies the start time of the Cleanup Service for the given period, e.g. on a daily basis.

period_end04.00:00noSpecifies the end of the period which the Cleanup Service is allowed to run for. If the Cleanup Service completes its task first then it will stop before the indicated time. However, it will not continue to run beyond the indicated time. 

force_cleanupfalseno

If set to true, specifies that the Cleanup Service will be forcibly executed. By default the Cleanup Service will stop if it detects activity of the History Service. The setting allows the Cleanup Service to pause the History Service for a configurable duration.

When the setting is set to true, then the following settings are considered:

  • history_pause_duration: period for which the History Service is paused.
  • history_pause_delay: delay after the History Service is resumed from a pause for which the Cleanup Service will wait to restart.

history_pause_duration60sno

When the force_cleanup setting is set to true then the History Service will be paused for the indicated duration or for completion of cleanup whichever occurs first. While the History Service is paused, no new history entries about execution of orders and tasks are made available in JOC Cockpit. On completion of the History Service pause any pending history entries will be processed.


history_pause_delay30snoWhen the force_cleanup setting is set to true and the History Service pause is completed, then the Cleanup Service will wait for the indicated delay and will restart if further purge of the database is required.

batch_size1000noSpecifies 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 if Services are operating on the database in parallel.

max_pool_size8no

Specifies the maximum number of database connections used by the service.

Availability starting with

Jira
serverSOS JIRA
serverId6dc67751-9d67-34cd-985b-194a8cdc9602
keyJOC-1366


order_history_age90dnoSpecifies 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_age90dnoSpecifies the retention period for orders and task logs. Any logs older than the value specified will be purged. Note that this value should not exceed the value of the cleanup_order_history_age setting as otherwise navigation to logs cannot be provided by the JOC Cockpit GUI.

file_transfer_history_age90dnoSpecifies the retention period for file transfer history entries. Any entries older than the value specified will be purged.

audit_log_age90dnoSpecifies the retention period for the Audit Log. Any audit log entries older than the value specified will be purged.

daily_plan_history_age30dnoSpecifies the retention period for the history of submissions with the Daily Plan. Any history entries older than the value specified will be purged.

monitoring_history_age1dnoSpecifies the retention period for entries in the Monitor view. As this suggests to be a tactical view longer retention periods are not recommended.

notification_history_age1dnoSpecifies the retention period for notifications, e.g. about job errors and warnings. As notifications are typically handled on the same day longer retention periods are not recommended.

profile_age365dnoSpecifies the retention period for unused profiles, i.e. profiles of user accounts that did not login for the given period.

failed_login_history_age90dnoSpecifies the retention period for the history of failed logins. Unsuccessful logins that occurred before the given period will be purged.

reporting_age365dnoSpecifies the retention periof for JS7 - Reports.

deployment_history_versions10noSpecifies the number of versions per deployed object that should be retained. Such versions can be used to re-deploy an object from an earlier state. Any earlier deployed versions of deployed objects are removed.

...