Built-in Jobs - Revision history

Craig: Remove pre-4.x version references (4.0.0 is the oldest documented release)

2026-07-31T14:49:47Z

Remove pre-4.x version references (4.0.0 is the oldest documented release)

← Older revision		Revision as of 14:49, 31 July 2026
Line 1:		Line 1:
	Obsidian comes bundled with free [[Admin_Jobs\|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 [[Admin_Jobs\|jobs]] for common tasks. These are provided in addition to [[Scripting Jobs]] to reduce implementation and testing time for common job functions.

	~~As of '''Obsidian 2.7.0''', we~~ have open-sourced our built-in convenience jobs under the [[https://opensource.org/license/mit/ MIT License]]. In the root of the installation folder, you can find the source in <code>obsidian-builtin-job-src.jar</code>.		We have open-sourced our built-in convenience jobs under the [[https://opensource.org/license/mit/ MIT License]]. In the root of the installation folder, you can find the source in <code>obsidian-builtin-job-src.jar</code>.

	= File Processing Jobs =		= File Processing Jobs =
Line 11:		Line 11:
	'''Job Class:''' <code>com.carfey.ops.job.maint.FileCleanupJob</code>		'''Job Class:''' <code>com.carfey.ops.job.maint.FileCleanupJob</code>

	~~''Introduced in version 2.0''~~

	This job deletes files in specified paths based on one or more file masks (using regular expressions).		This job deletes files in specified paths based on one or more file masks (using regular expressions).
Line 46:		Line 45:
	'''Job Class:''' <code>com.carfey.ops.job.maint.FileArchiveJob</code>		'''Job Class:''' <code>com.carfey.ops.job.maint.FileArchiveJob</code>

	~~''Introduced in version 2.0''~~

	This job archives files passed in via a chained job's saved results. Therefore, it is intended to be used as a chained job only. One or more accessible absolute file paths can be passed in via job results called 'file'. Each one will be processed for archiving. For example, if you have a job that generates two files called 'customers.txt' and 'orders.txt', you will use <code>Context.saveJobResult(String, Object)</code> to save a value for each absolute file path (e.g. 'C:/customers.txt' and 'C:/orders.txt').		This job archives files passed in via a chained job's saved results. Therefore, it is intended to be used as a chained job only. One or more accessible absolute file paths can be passed in via job results called 'file'. Each one will be processed for archiving. For example, if you have a job that generates two files called 'customers.txt' and 'orders.txt', you will use <code>Context.saveJobResult(String, Object)</code> to save a value for each absolute file path (e.g. 'C:/customers.txt' and 'C:/orders.txt').
Line 85:		Line 83:
	'''Job Class:''' <code>com.carfey.ops.job.maint.FileScannerJob</code>		'''Job Class:''' <code>com.carfey.ops.job.maint.FileScannerJob</code>

	~~''Introduced in version 2.2''~~

	This job locates files in a directory matching one or more file masks (using Java regular expressions) and stores the result via source job results stored under the name <code>file</code> as absolute paths (Strings).		This job locates files in a directory matching one or more file masks (using Java regular expressions) and stores the result via source job results stored under the name <code>file</code> as absolute paths (Strings).
Line 127:		Line 124:
	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 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>maxAgeDays</code> corresponds to the maximum age for records to retain, including expired job schedules. By default it is set to 366, but you may configure it to any desired value.

	~~As of 3.0.1, the value for <code>maxAgeScheduleDays</code> corresponds to the maximum age for expired job schedules to retain. If this isn't specified, expired job schedules won't be deleted.~~

	~~As of 3.4.0, the value for <code>maxAgeDays</code> is used to prune expired job schedules and <code>maxAgeScheduleDays</code> is no longer used~~.

	'''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.
Line 175:		Line 168:
	== Disabled Job Cleanup Job ==		== Disabled Job Cleanup Job ==

	~~''Introduced in Obsidian 3.7.0''~~

	'''Job Class:''' <code>com.carfey.ops.job.maint.DisabledJobCleanupJob</code>		'''Job Class:''' <code>com.carfey.ops.job.maint.DisabledJobCleanupJob</code>
Line 192:		Line 184:
	'''Job Class:''' <code>com.carfey.ops.job.script.ScriptFileJob</code>		'''Job Class:''' <code>com.carfey.ops.job.script.ScriptFileJob</code>

	~~''Introduced in Obsidian 2.3.1''~~

	This job enables you to specify an existing script, command or other executable to invoke/execute. Validation of the file's existence and executable state is done only at runtime. You must ensure that the file exists or is accessible via environment variables and in an executable state on all Obsidian Hosts in the cluster or restrict the job to the necessary [[Admin_Jobs#Advanced_Options\|Fixed Hosts]]. This job uses [http://docs.oracle.com/javase/7/docs/api/java/lang/ProcessBuilder.html ProcessBuilder], so refer to it for expected behaviour.		This job enables you to specify an existing script, command or other executable to invoke/execute. Validation of the file's existence and executable state is done only at runtime. You must ensure that the file exists or is accessible via environment variables and in an executable state on all Obsidian Hosts in the cluster or restrict the job to the necessary [[Admin_Jobs#Advanced_Options\|Fixed Hosts]]. This job uses [http://docs.oracle.com/javase/7/docs/api/java/lang/ProcessBuilder.html ProcessBuilder], so refer to it for expected behaviour.

	~~As of ''Obsidian 3.8.0'', this~~ job supports best-effort interruption as an [[Implementing_Jobs#Interruptable_Jobs\|Interruptable job]]. It is best effort in that it only destroys the underlying process that invoked the script, but cannot ensure that anything the script has invoked has terminated.		This job supports best-effort interruption as an [[Implementing_Jobs#Interruptable_Jobs\|Interruptable job]]. It is best effort in that it only destroys the underlying process that invoked the script, but cannot ensure that anything the script has invoked has terminated.

	* ''Script with Arguments (1 or more Strings)'' - The first value is a path to the execution script (or other executable), which is typically fully qualified, or relative to the working directory. The additional values are any required arguments for the command. On *nix, if you are invoking a script, you may need to prefix the command with "./", e.g. <code>./script.sh</code>. Corresponds to the [http://docs.oracle.com/javase/7/docs/api/java/lang/ProcessBuilder.html#ProcessBuilder(java.lang.String...) ProcessBuilder(java.lang.String...) constructor].		* ''Script with Arguments (1 or more Strings)'' - The first value is a path to the execution script (or other executable), which is typically fully qualified, or relative to the working directory. The additional values are any required arguments for the command. On *nix, if you are invoking a script, you may need to prefix the command with "./", e.g. <code>./script.sh</code>. Corresponds to the [http://docs.oracle.com/javase/7/docs/api/java/lang/ProcessBuilder.html#ProcessBuilder(java.lang.String...) ProcessBuilder(java.lang.String...) constructor].
Line 227:		Line 218:
	= MySqlBackupJob =		= MySqlBackupJob =

	~~''Introduced in version 2.4''~~

	This is a convenience job to utilize the mysqldump utility to extract a backup and store on the filesystem. A timestamp is appended to the filename prefix specified to protect against overwrites. The optional mysqldump options are not validated and will result in runtime failures if they are invalid. Likewise, all paths specified are not verified and are only required to be available on the scheduler host at runtime. If the mysqldump executable is not found at runtime, change the ''mysqldump Executable'' to have the fully qualified path.		This is a convenience job to utilize the mysqldump utility to extract a backup and store on the filesystem. A timestamp is appended to the filename prefix specified to protect against overwrites. The optional mysqldump options are not validated and will result in runtime failures if they are invalid. Likewise, all paths specified are not verified and are only required to be available on the scheduler host at runtime. If the mysqldump executable is not found at runtime, change the ''mysqldump Executable'' to have the fully qualified path.
Line 245:		Line 235:

	= Shell Script Jobs =		= Shell Script Jobs =
	'''Deprecated ~~as of Obsidian 2.3.1~~.''' Use [[#Script_Job\|Script Job]] instead.		'''Deprecated.''' Use [[#Script_Job\|Script Job]] instead.

	These jobs are provided to give convenient access to shell scripting. ''Not supported on Windows-based platforms.''		These jobs are provided to give convenient access to shell scripting. ''Not supported on Windows-based platforms.''
Line 251:		Line 241:
	== Shell Script Job ==		== Shell Script Job ==

	'''Deprecated ~~as of Obsidian 2.3.1~~.''' Use [[#Script_Job\|Script Job]] instead.		'''Deprecated.''' Use [[#Script_Job\|Script Job]] instead.

	'''Job Class:''' <code>com.carfey.ops.job.script.ShellScriptJob</code>		'''Job Class:''' <code>com.carfey.ops.job.script.ShellScriptJob</code>

	~~''Introduced in version 2.0''~~

	This job enables you to specify the actual contents of a shell script and have it execute on the runtime host. At runtime, the script will be written to disk, marked as executable and then executed. The script is then cleaned up. The shell script provided should be completely self-sufficient with any desired interpreter directives included and no assumptions or expectations of environment variables.		This job enables you to specify the actual contents of a shell script and have it execute on the runtime host. At runtime, the script will be written to disk, marked as executable and then executed. The script is then cleaned up. The shell script provided should be completely self-sufficient with any desired interpreter directives included and no assumptions or expectations of environment variables.

	== Shell Script Execution Job ==		== Shell Script Execution Job ==
	'''Deprecated ~~as of Obsidian 2.3.1~~.''' Use [[#Script_Job\|Script Job]] instead.		'''Deprecated.''' Use [[#Script_Job\|Script Job]] instead.

	'''Job Class:''' <code>com.carfey.ops.job.script.ShellScriptExecutionJob</code>		'''Job Class:''' <code>com.carfey.ops.job.script.ShellScriptExecutionJob</code>

	~~''Introduced in version 2.0''~~

	This job enables you to specify an existing shell script to execute. Validation of the script's existence and executable state is done only at runtime. You must ensure that the script exists in an executable state on all Obsidian Hosts in the cluster or restrict the job to the necessary [[Admin_Jobs#Execution_.26_Pickup\|Fixed Hosts]].		This job enables you to specify an existing shell script to execute. Validation of the script's existence and executable state is done only at runtime. You must ensure that the script exists in an executable state on all Obsidian Hosts in the cluster or restrict the job to the necessary [[Admin_Jobs#Execution_.26_Pickup\|Fixed Hosts]].

Craig: /* Obsidian Execution Statistics Job */

2025-11-26T23:22:12Z

Obsidian Execution Statistics Job

← Older revision		Revision as of 23:22, 26 November 2025
Line 320:		Line 320:
	''Introduced in Obsidian 6.4.0''		''Introduced in Obsidian 6.4.0''

	This job runs against the job activity stored in Obsidian to collect execution statistics. These statistics are then available via the UI, the [[REST_API\|REST API]] and [[Embedded_API\|Embedded API]]. Job statistics use the data stored in job activity (history) and will not collect statistics for any history removed via [[Built-in_Jobs#Job_History_Cleanup_Job\|Job History Cleanup Job]].		This job runs against the job activity stored in Obsidian to collect execution statistics. These statistics are then available via the UI, the [[REST_API\|REST API]] and [[Embedded_API\|Embedded API]]. Job statistics use the data stored in job activity (history) and will not collect statistics for any history removed via [[Built-in_Jobs#Job_History_Cleanup_Job\|Job History Cleanup Job]]. Likely you should align the ''maximumDurationLookback'' configuration value with a value that represents the most data kept. For example, if you keep 6 months of job history, you wouldn't benefit from a ''year'' lookback as the stats would match the ''six month'' stats.

	The job supports the following configuration options:		The job supports the following configuration options:

Craig: /* Obsidian Execution Statistics Job */

2025-11-26T23:20:08Z

Obsidian Execution Statistics Job

← Older revision		Revision as of 23:20, 26 November 2025
Line 320:		Line 320:
	''Introduced in Obsidian 6.4.0''		''Introduced in Obsidian 6.4.0''

	This job runs against the job activity stored in Obsidian to collect execution statistics. These statistics are then available via the UI, the [[REST_API\|REST API]] and [[Embedded_API\|Embedded API]].		This job runs against the job activity stored in Obsidian to collect execution statistics. These statistics are then available via the UI, the [[REST_API\|REST API]] and [[Embedded_API\|Embedded API]]. Job statistics use the data stored in job activity (history) and will not collect statistics for any history removed via [[Built-in_Jobs#Job_History_Cleanup_Job\|Job History Cleanup Job]].

	The job supports the following configuration options:		The job supports the following configuration options:

Craig at 22:48, 26 November 2025

2025-11-26T22:48:31Z

← Older revision		Revision as of 22:48, 26 November 2025
Line 326:		Line 326:
	* ''durationUnit (String)'' - What statistics unit to calculate. Valid values: seconds, minutes, hours. Defaults to minutes. Multiple allowed.		* ''durationUnit (String)'' - What statistics unit to calculate. Valid values: seconds, minutes, hours. Defaults to minutes. Multiple allowed.
	* ''maximumDurationLookback (String)'' - How far back to collect statistics. One of day, two day, three day, five day, week, month, two month, three month, six month, year. Defaults to three month. Large durations will calculate and store stats for smaller durations; e.g. two day includes day.		* ''maximumDurationLookback (String)'' - How far back to collect statistics. One of day, two day, three day, five day, week, month, two month, three month, six month, year. Defaults to three month. Large durations will calculate and store stats for smaller durations; e.g. two day includes day.

			[[File:Obsidian-6.4.0-Obsidian-Execution-Job-Statistics-Config.png]]

Craig: /* Obsidian Execution Statistics Job */

2025-11-25T14:34:01Z

Obsidian Execution Statistics Job

← Older revision		Revision as of 14:34, 25 November 2025
Line 320:		Line 320:
	''Introduced in Obsidian 6.4.0''		''Introduced in Obsidian 6.4.0''

	This job runs against the job activity stored in ~~the~~ Obsidian to collect execution statistics. These statistics are then available via the UI, the [[REST_API\|REST API]] and [[Embedded_API\|Embedded API]].		This job runs against the job activity stored in Obsidian to collect execution statistics. These statistics are then available via the UI, the [[REST_API\|REST API]] and [[Embedded_API\|Embedded API]].

	The job supports the following configuration options:		The job supports the following configuration options:

Craig at 03:16, 25 November 2025

2025-11-25T03:16:55Z

← Older revision		Revision as of 03:16, 25 November 2025
Line 313:		Line 313:
	* ''Basic Authentication Username (optional String)'' - If wanting to add basic authentication, provide username and password.		* ''Basic Authentication Username (optional String)'' - If wanting to add basic authentication, provide username and password.
	* ''Basic Authentication Password (optional String)'' - If wanting to add basic authentication, provide username and password.		* ''Basic Authentication Password (optional String)'' - If wanting to add basic authentication, provide username and password.

			== Obsidian Execution Statistics Job ==

			'''Job Class:''' <code>com.carfey.ops.job.schedule.ObsidianExecutionStatisticsJob</code>

			''Introduced in Obsidian 6.4.0''

			This job runs against the job activity stored in the Obsidian to collect execution statistics. These statistics are then available via the UI, the [[REST_API\|REST API]] and [[Embedded_API\|Embedded API]].

			The job supports the following configuration options:

			* ''durationUnit (String)'' - What statistics unit to calculate. Valid values: seconds, minutes, hours. Defaults to minutes. Multiple allowed.
			* ''maximumDurationLookback (String)'' - How far back to collect statistics. One of day, two day, three day, five day, week, month, two month, three month, six month, year. Defaults to three month. Large durations will calculate and store stats for smaller durations; e.g. two day includes day.

Craig at 03:15, 25 November 2025

2025-11-25T03:15:04Z

← Older revision		Revision as of 03:15, 25 November 2025
Line 313:		Line 313:
	* ''Basic Authentication Username (optional String)'' - If wanting to add basic authentication, provide username and password.		* ''Basic Authentication Username (optional String)'' - If wanting to add basic authentication, provide username and password.
	* ''Basic Authentication Password (optional String)'' - If wanting to add basic authentication, provide username and password.		* ''Basic Authentication Password (optional String)'' - If wanting to add basic authentication, provide username and password.

	~~== Obsidian Execution Statistics Job ==~~

	~~'''Job Class:''' <code>com.carfey.ops.job.schedule.ObsidianExecutionStatisticsJob</code>~~

	~~''Introduced in Obsidian 6.4.0''~~

	This job runs against the job activity stored in the Obsidian to collect execution statistics. These statistics are then available via the UI, the [[REST_API\|REST API]] and [[Embedded_API\|Embedded API]].

	~~The job supports the following configuration options:~~

	* ''durationUnit (String)'' - What statistics unit to calculate. Valid values: seconds, minutes, hours. Defaults to minutes. Multiple allowed.
	* ''maximumDurationLookback (String)'' - How far back to collect statistics. One of day, two day, three day, five day, week, month, two month, three month, six month, year. Defaults to three month. Large durations will calculate and store stats for smaller durations; e.g. two day includes day.

Craig: /* Miscellaneous Jobs */

2025-11-25T03:10:22Z

Miscellaneous Jobs

← Older revision		Revision as of 03:10, 25 November 2025
Line 271:		Line 271:

	== Database File Export Job ==		== Database File Export Job ==

			'''Job Class:''' <code>com.carfey.ops.job.db.DatabaseFileExportJob</code>

	''Introduced in Obsidian 5.1.0''		''Introduced in Obsidian 5.1.0''
Line 297:		Line 299:

	== REST Invocation Job ==		== REST Invocation Job ==

			'''Job Class:''' <code>com.carfey.ops.job.rest.RESTInvocationJob</code>

	''Introduced in Obsidian 5.1.0''		''Introduced in Obsidian 5.1.0''
Line 311:		Line 315:

	== Obsidian Execution Statistics Job ==		== Obsidian Execution Statistics Job ==

			'''Job Class:''' <code>com.carfey.ops.job.schedule.ObsidianExecutionStatisticsJob</code>

	''Introduced in Obsidian 6.4.0''		''Introduced in Obsidian 6.4.0''

Craig: /* Obsidian Execution Statistics Job */

2025-11-25T03:01:25Z

Obsidian Execution Statistics Job

← Older revision		Revision as of 03:01, 25 November 2025
Line 314:		Line 314:
	''Introduced in Obsidian 6.4.0''		''Introduced in Obsidian 6.4.0''

	This job runs against the job activity stored in the Obsidian to collect execution statistics. These statistics are then available via the UI, the REST and Embedded ~~APIs~~.		This job runs against the job activity stored in the Obsidian to collect execution statistics. These statistics are then available via the UI, the [[REST_API\|REST API]] and [[Embedded_API\|Embedded API]].

	The job supports the following configuration options:		The job supports the following configuration options:

Craig: /* Miscellaneous Jobs */

2025-11-25T02:58:05Z

Miscellaneous Jobs

← Older revision		Revision as of 02:58, 25 November 2025
Line 309:		Line 309:
	* ''Basic Authentication Username (optional String)'' - If wanting to add basic authentication, provide username and password.		* ''Basic Authentication Username (optional String)'' - If wanting to add basic authentication, provide username and password.
	* ''Basic Authentication Password (optional String)'' - If wanting to add basic authentication, provide username and password.		* ''Basic Authentication Password (optional String)'' - If wanting to add basic authentication, provide username and password.


	== Obsidian Execution Statistics Job ==		== Obsidian Execution Statistics Job ==