Configuring Manager Maintenance Jobs
Performing maintenance procedures on a regular basis will ensure that the Manager runs smoothly. By default, Manager installation creates a number of maintenance jobs.
To ensure that the database runs efficiently, configure the maintenance job responsible for deleting old log files. It is recommended that you schedule maintenance jobs to run during off-peak hours.
A fresh install creates default maintenance jobs responsible for deleting old log files and database records. Because a delivery log is generated each time a data transfer occurs, it is critical that these logs be cleared from the system. If left to accumulate, delivery logs will use large amounts of disk space.
The default maintenance jobs are scheduled to run at 2:05 am, based on the server's default time zone. It is important to edit the default job to include contact email addresses for notification in the case of job failure. It is recommended that maintenance jobs be scheduled to run once a day.
A Manager system alarm is triggered if you do not schedule a maintenance job, if a maintenance job fails, or if the maintenance job does not complete in a timely manner. Alarms are indicated in the top left-hand corner of the Manager with the text: Administrator action required. View Alarms.
Note: Do not run the maintenance job at the same time as you are running the Manager backup job. The removal of old files during the maintenance job may cause the backup to fail.
Configure log maintenance to ensure that the logs do not accumulate and take up disk space and impact Manager performance. Settings control how long logs are kept and the amount of disk space devoted to log storage.
Configuring Maintenance Jobs
To configure maintenance jobs:
- In the Manager, navigate to Administration > Manager > Maintenance.
- Click Add.
- Enter a name for the maintenance job.
- Choose whether to Run in test mode. Running the job in test mode runs the maintenance job without deleting any items. This option provides a preview of items that will be deleted. The default is No.
- Configure settings on the Basic and Advanced tabs.
- Allow Database Maintenance to run: Enables or disables database maintenance. The default is Yes.
- Remove reporting objects/web logs older than x days: Defines the number of days that statistics and logs generated by the scheduled job or Manager are kept in the database. The age of a job run is determined by the time at which the job run started. The default value for reporting objects is 30 days. By default, web logs are kept for 60 days.
- Remove interval statistics older than x days: Defines the number of days the interval statistics for a job are kept in the database. Interval statistics are used only to draw/generate transfer graphs and do not appear in reports. The default value is one week. Specifying a lower value reduces the size of the backup and helps the overall performance of the system.
Unscheduled Jobs Maintenance
- Allow Unscheduled Jobs Maintenance to run: Enables or disables the removal and deletion of unscheduled jobs. Examples of unscheduled jobs include jobs that have not run or jobs initiated via the SOAP interface. The default is No.
- Job Groups: Defines job groups from which unscheduled jobs are deleted.
- Remove Unscheduled Jobs not run in past x days: Defines when unscheduled jobs are removed. The default value is 60 days.
- Delete Jobs in error: Enables or disables the removal of jobs with the Jobs in error status. The default value is Yes.
- Allow Log Maintenance to run: Enables or disables log maintenance.
- Keep delivery logs for at least x days: Sets the length of time in days to keep delivery logs. Only delivery logs older than the specified value are removed when the log directory size exceeds the directory size parameter. The default value is 365 days.
- Keep log directory size below (MB): The default value is 1000 MB. When the log directory size is greater than the specified value, log files are sorted in reverse chronological order, and the oldest log file is removed until the directory size is below the specified value. When all the logs that can be removed are removed and the directory size is greater than the value, the job fails and a failure notification is triggered.
- Keep log directory file count below x files: Defines the maximum number of files to store in the log directory. This is an optional parameter and does not have a default value. When the log directory reaches the size specified, files are deleted from oldest to newest.
- Keep logs for at least x days: Defines the minimum number of days a log file will be kept. A log file whose age is less than the specified minimum number of days will not be deleted. Log files older than the specified minimum are deleted only if the log directory size value is exceeded. The default value is 28.
Remove all log files older than x days: Sets the number of day to keep a log file. Log files older than the age limit will be removed, even if the directory size limit has not been reached. The default value is 365 days.
Note: If the Remove all log files older than value is smaller than the Keep logs for at least value, the Keep logs for at least value is used.
Job Template Backup Maintenance
- Allow Job Template Backup Maintenance to Run: Enables or disables job templates backup maintenance. The default value is No.
- Number of Auto Backups to Keep: The default value is 100. Job Template workflow backups are stored in order from newest to oldest.
Large Object Maintenance
- Allow Large Object Maintenance to Run: When Yes is selected, the large object table is cleared during maintenance. The default value is No.
- Number of deleted large objects per transaction: The default value is 10.
Notification and Logging
- Mail notification to: Specifies email addresses to notify when the job runs. Separate multiple addresses with a comma.
- Email Condition: Sets the conditions under which notification emails are sent. The options are On Error, Always, On Transfer and None.
- Notify support when maintenance fails: The default value is No. When Yes is selected, an email is sent to support after three consecutive maintenance failures. This email includes the log files for the failures.
- Log Detail Level: Choose from Error, Warn, Info or Debug. Debug provides the greatest level of detail while Error provides the least. The default level is Info. An increased level of log detail can impact Manager performance.
- Frequency: Sets the frequency of job runs. The default is Daily.
- Start Date/Time: Specifies the date and time at which to run the job. The value is in
- Time Zone: Sets the time zone in which the displayed times are set in the template.
For example, if a solutions developer in an Eastern time zone specifies a start time of 9:00 am and a time zone of PST, the job runs at 9:00 am Pacific Standard Time or noon Eastern Standard Time.