Built-in Jobs: Difference between revisions

From Obsidian Scheduler
Jump to navigationJump to search
No edit summary
No edit summary
Line 1: Line 1:
Obsidian comes bundled with free jobs for common tasks. These are provided in addition to [[Scripting Jobs]] to reduce implementation and testing time for common job functions.
Obsidian comes bundled with free jobs for common tasks. These are provided in addition to [[Scripting Jobs]] to reduce implementation and testing time for common job functions.


= Obsidian Maintenance Jobs =
= Obsidian Maintenance Jobs =
Line 10: Line 9:
This job will delete job history and related records beyond a configurable age in days. This is useful for keeping the database compact and clearing out old, unneeded data.  
This job will delete job history and related records beyond a configurable age in days. This is useful for keeping the database compact and clearing out old, unneeded data.  


The default age in days is set to 365, but you may configure it to any desired value.
The value for <code>maxAgeDays</code> corresponds to the maximum age for records to retain. By default it is set to 365, but you may configure it to any desired value.


''Note:'' We recommend high volume users schedule the job weekly or less frequently and to schedule it for a non-peak time.
'''Note:''' We recommend high volume users schedule the job weekly or less frequently and to schedule it for a non-peak time.


== Log Cleanup Job ==
== Log Cleanup Job ==
This job will delete log database records beyond a configurable age in days. This is useful for keeping the database compact and clearing out old, unneeded data.
The value for <code>maxAgeDays</code> corresponds to the maximum age for records to retain. By default it is set to 365, but you may configure it to any desired value.
The value for <code>level</code> corresponds to the logging level of events to delete. You may specify multiple values, and the "ALL" option will result in all records matching the age setting being deleted. Valid levels to configure are: <code>FATAL</code>, <code>ERROR</code>, <code>WARNING</code>, <code>INFO</code>, <code>DEBUG</code>, and <code>TRACE</code>.
'''Note:''' We recommend high volume users schedule the job weekly or less frequently and to schedule it for a non-peak time.

Revision as of 00:01, 22 April 2013

Obsidian comes bundled with free jobs for common tasks. These are provided in addition to Scripting Jobs to reduce implementation and testing time for common job functions.

Obsidian Maintenance Jobs

These jobs are provided to help maintain the Obsidian installation.

Job History Cleanup Job

This job will delete job history and related records beyond a configurable age in days. This is useful for keeping the database compact and clearing out old, unneeded data.

The value for maxAgeDays corresponds to the maximum age for records to retain. By default it is set to 365, but you may configure it to any desired value.

Note: We recommend high volume users schedule the job weekly or less frequently and to schedule it for a non-peak time.

Log Cleanup Job

This job will delete log database records beyond a configurable age in days. This is useful for keeping the database compact and clearing out old, unneeded data.

The value for maxAgeDays corresponds to the maximum age for records to retain. By default it is set to 365, but you may configure it to any desired value.

The value for level corresponds to the logging level of events to delete. You may specify multiple values, and the "ALL" option will result in all records matching the age setting being deleted. Valid levels to configure are: FATAL, ERROR, WARNING, INFO, DEBUG, and TRACE.

Note: We recommend high volume users schedule the job weekly or less frequently and to schedule it for a non-peak time.