Admin Jobs - Revision history

Craig: /* Advanced Options */

2019-05-01T03:15:23Z

Advanced Options

← Older revision		Revision as of 03:15, 1 May 2019
Line 80:		Line 80:

	''Recovery Type'' allows you to specify how the job will be handled when execution does not happen normally within the ''Pickup Buffer'' because of conflicts, server downtime, etc.		''Recovery Type'' allows you to specify how the job will be handled when execution does not happen normally within the ''Pickup Buffer'' because of conflicts, server downtime, etc.

			''Startup/Shutdown Mode'' allows you to specify if the job should fire automatically, independently of any defined schedule, in various startup and shutdown scenarios.

	''Pickup Buffer'' indicates for how many minutes the job is considered within normal execution time from the exact scheduled time. This allows for leniency when dealing with conflicting jobs or with short-term downtime. If a minor delay isn't significant to your job, using a higher buffer can help prevent jobs from being marked missed or conflict missed unnecessarily.		''Pickup Buffer'' indicates for how many minutes the job is considered within normal execution time from the exact scheduled time. This allows for leniency when dealing with conflicting jobs or with short-term downtime. If a minor delay isn't significant to your job, using a higher buffer can help prevent jobs from being marked missed or conflict missed unnecessarily.

Carfey: /* Advanced Options */

2017-09-21T19:26:36Z

Advanced Options

← Older revision		Revision as of 19:26, 21 September 2017
Line 93:		Line 93:
	''Auto Interrupt'' allows you to specify if you wish an [[Implementing_Jobs#Interruptable_Jobs\|Interruptable Job]] to be interrupted when its maximum expected run length is exceeded. Only available as an option for those jobs that adhere to the [[Implementing_Jobs#Interruptable_Jobs\|Interruptable Job]] requirements and have a maximum expected length specified. As of Obsidian 3.4.0.		''Auto Interrupt'' allows you to specify if you wish an [[Implementing_Jobs#Interruptable_Jobs\|Interruptable Job]] to be interrupted when its maximum expected run length is exceeded. Only available as an option for those jobs that adhere to the [[Implementing_Jobs#Interruptable_Jobs\|Interruptable Job]] requirements and have a maximum expected length specified. As of Obsidian 3.4.0.

	''Fixed Hosts'' allows you to indicate that only certain hosts should run this job. You can select one or more hosts which Obsidian knows about. If a host is not listed and will be started later, simply type in the name and click the (+) button to add it to the list. As of Obsidian 2.2.1, a configuration item allows you to specify whether you wish host restrictions to apply on AdHoc jobs or not. On new installations of 2.2.1, it defaults to TRUE while it defaults FALSE (to maintain behaviour from versions before 2.2.1) on upgrades from prior releases. This can be found under '''[[Admin_Scheduler_Settings\|Scheduler Settings]]/Job/adHocJobsRespectFixedHostsRestrictions'''. As of version 4.4, yu may use a Java regular expression to use pattern matching on the host name. For example, a wildcard match for hosts that start with "abc" can be done with a pattern like "abc.". To implement a blacklist of hosts that the job should not run on, a single pattern with negation can be used: "(?!(blacklist-one\|blacklist-two)).".		''Fixed Hosts'' allows you to indicate that only certain hosts should run this job. You can select one or more hosts which Obsidian knows about. If a host is not listed and will be started later, simply type in the name and click the (+) button to add it to the list. As of Obsidian 2.2.1, a configuration item allows you to specify whether you wish host restrictions to apply on AdHoc jobs or not. On new installations of 2.2.1, it defaults to TRUE while it defaults FALSE (to maintain behaviour from versions before 2.2.1) on upgrades from prior releases. This can be found under '''[[Admin_Scheduler_Settings\|Scheduler Settings]]/Job/adHocJobsRespectFixedHostsRestrictions'''. As of version 4.4, you may use a Java regular expression to use pattern matching on the host name. For example, a wildcard match for hosts that start with "abc" can be done with a pattern like "abc.". To implement a blacklist of hosts that the job should not run on, a single pattern with negation can be used: "(?!(blacklist-one\|blacklist-two)).".

	''Host Preference'' indicates that Fixed Hosts are only preferred hosts, and that other available hosts can run the job when none of the preferred hosts are running. When selected, you can also order the hosts using drag & drop. Obsidian will always choose the highest priority host to run the job if one is available.		''Host Preference'' indicates that Fixed Hosts are only preferred hosts, and that other available hosts can run the job when none of the preferred hosts are running. When selected, you can also order the hosts using drag & drop. Obsidian will always choose the highest priority host to run the job if one is available.

Carfey: /* Advanced Options */

2017-09-21T19:26:13Z

Advanced Options

← Older revision		Revision as of 19:26, 21 September 2017
Line 93:		Line 93:
	''Auto Interrupt'' allows you to specify if you wish an [[Implementing_Jobs#Interruptable_Jobs\|Interruptable Job]] to be interrupted when its maximum expected run length is exceeded. Only available as an option for those jobs that adhere to the [[Implementing_Jobs#Interruptable_Jobs\|Interruptable Job]] requirements and have a maximum expected length specified. As of Obsidian 3.4.0.		''Auto Interrupt'' allows you to specify if you wish an [[Implementing_Jobs#Interruptable_Jobs\|Interruptable Job]] to be interrupted when its maximum expected run length is exceeded. Only available as an option for those jobs that adhere to the [[Implementing_Jobs#Interruptable_Jobs\|Interruptable Job]] requirements and have a maximum expected length specified. As of Obsidian 3.4.0.

	''Fixed Hosts'' allows you to indicate that only certain hosts should run this job. You can select one or more hosts which Obsidian knows about. If a host is not listed and will be started later, simply type in the name and click the (+) button to add it to the list. As of Obsidian 2.2.1, a configuration item allows you to specify whether you wish host restrictions to apply on AdHoc jobs or not. On new installations of 2.2.1, it defaults to TRUE while it defaults FALSE (to maintain behaviour from versions before 2.2.1) on upgrades from prior releases. This can be found under '''[[Admin_Scheduler_Settings\|Scheduler Settings]]/Job/adHocJobsRespectFixedHostsRestrictions'''.		''Fixed Hosts'' allows you to indicate that only certain hosts should run this job. You can select one or more hosts which Obsidian knows about. If a host is not listed and will be started later, simply type in the name and click the (+) button to add it to the list. As of Obsidian 2.2.1, a configuration item allows you to specify whether you wish host restrictions to apply on AdHoc jobs or not. On new installations of 2.2.1, it defaults to TRUE while it defaults FALSE (to maintain behaviour from versions before 2.2.1) on upgrades from prior releases. This can be found under '''[[Admin_Scheduler_Settings\|Scheduler Settings]]/Job/adHocJobsRespectFixedHostsRestrictions'''. As of version 4.4, yu may use a Java regular expression to use pattern matching on the host name. For example, a wildcard match for hosts that start with "abc" can be done with a pattern like "abc.". To implement a blacklist of hosts that the job should not run on, a single pattern with negation can be used: "(?!(blacklist-one\|blacklist-two)).".

	''Host Preference'' indicates that Fixed Hosts are only preferred hosts, and that other available hosts can run the job when none of the preferred hosts are running. When selected, you can also order the hosts using drag & drop. Obsidian will always choose the highest priority host to run the job if one is available.		''Host Preference'' indicates that Fixed Hosts are only preferred hosts, and that other available hosts can run the job when none of the preferred hosts are running. When selected, you can also order the hosts using drag & drop. Obsidian will always choose the highest priority host to run the job if one is available.

	''Chain All'' allows you allows you specify the behaviour when this job is to be chained but is executing another instance at that moment. By default, only one newly chained instance will be queued. Choose this option to chain all such occurrences. Each chained target instance is queued for the same minute. Ensure your Pickup Buffer is set large enough for these to be picked up and run in sequence.		''Chain All'' allows you allows you specify the behaviour when this job is to be chained but is executing another instance at that moment. By default, only one newly chained instance will be queued. Choose this option to chain all such occurrences. Each chained target instance is queued for the same minute. Ensure your Pickup Buffer is set large enough for these to be picked up and run in sequence.


	== Schedule ==		== Schedule ==

Craig: /* Nickname, Class and Folder */

2017-03-04T03:31:38Z

Nickname, Class and Folder

← Older revision		Revision as of 03:31, 4 March 2017
Line 69:		Line 69:
	All jobs must have a unique job nickname which identifies the job in logs and event notifications.		All jobs must have a unique job nickname which identifies the job in logs and event notifications.

	The ''Job Class'' selector allows you to choose existing jobs that Obsidian knows about, and you may also manually type in a custom job (hit enter to confirm and validate). When selecting a job, ~~not~~ that it must be available to the ~~admin application~~ (i.e. in the classpath) so that it can retrieve parameter information and validate your configuration. It is not ~~possible~~ to ~~configure a job that cannot be found within~~ the admin ~~web~~ application ~~classpath~~.		The ''Job Class'' selector allows you to choose existing jobs that Obsidian knows about, and you may also manually type in a custom job (hit enter to confirm and validate). When selecting a job, note that it must be available to all the scheduler nodes (i.e. on the classpath) so that it can retrieve parameter information and validate your configuration. It is not required, nor is it suggested, to keep these classes in the web admin application.

	'''Note:''' When selecting or choosing a new job, the defined and custom parameters sections will refresh based on that specific job's parameter definitions.		'''Note:''' When selecting or choosing a new job, the defined and custom parameters sections will refresh based on that specific job's parameter definitions.

Carfey: /* Nickname and Class */

2017-01-15T19:01:00Z

Nickname and Class

← Older revision		Revision as of 19:01, 15 January 2017
Line 66:		Line 66:
	== Job Settings ==		== Job Settings ==

	=== Nickname and ~~Class~~ ===		=== Nickname, Class and Folder ===
	All jobs must have a unique job nickname which identifies the job in logs and event notifications.		All jobs must have a unique job nickname which identifies the job in logs and event notifications.

Line 72:		Line 72:

	'''Note:''' When selecting or choosing a new job, the defined and custom parameters sections will refresh based on that specific job's parameter definitions.		'''Note:''' When selecting or choosing a new job, the defined and custom parameters sections will refresh based on that specific job's parameter definitions.

			The ''Folder'' selector allows you to select an in use folder, or type in a new folder. Clicking the (x) button will clear the selection so you can type in a custom folder. Jobs can be assigned to folders to help grouping and searching for them. You can use nested paths (e.g. A/B) using forward-slashes. Note that back-slashes will be automatically converted to forward slashes, and multiple slashes in succession are collapsed into a single slash. Leading and trailing slashes are stripped for consistency.

	=== Advanced Options ===		=== Advanced Options ===

Carfey: /* Fields */

2017-01-15T18:59:13Z

Fields

← Older revision		Revision as of 18:59, 15 January 2017
Line 21:		Line 21:

	''Clone Job'' opens up the a new job edit screen pre-populated with the selected job's configuration, including parameters and schedules.		''Clone Job'' opens up the a new job edit screen pre-populated with the selected job's configuration, including parameters and schedules.


	== Filtering ==		== Filtering ==

Carfey: /* Job Listing */

2017-01-15T18:59:01Z

Job Listing

← Older revision		Revision as of 18:59, 15 January 2017
Line 6:		Line 6:

	[[Image:JobListing_4.1.png]]		[[Image:JobListing_4.1.png]]

	~~== Exporting Results ==~~
	The current contents of the table can be exported to Excel, CSV or XML by clicking on the corresponding icon in the table header. The download will automatically begin and will include all pages of the current table of results.

	== Fields ==		== Fields ==

Line 21:		Line 17:
	* Submit Run Link (users with Write role only)		* Submit Run Link (users with Write role only)
	* Clone Job Link (users with Write role only)		* Clone Job Link (users with Write role only)

			''Submit Run'' either provides the option to submit a job for immediate or scheduled one-time execution. A job's current state must be either Enabled, Ad Hoc Active or Unscheduled Active to support immediate one-time execution. Otherwise, only future scheduled one-time execution is supported.

			''Clone Job'' opens up the a new job edit screen pre-populated with the selected job's configuration, including parameters and schedules.


			== Filtering ==

	Job records can be optionally filtered by host, status and folder. In the case of each, selecting no options is equivalent to choosing all options . Selected options may be cleared by clicking the (X) next to the dropdown arrow.		Job records can be optionally filtered by host, status and folder. In the case of each, selecting no options is equivalent to choosing all options . Selected options may be cleared by clicking the (X) next to the dropdown arrow.

	When filtering by folder, subfolders are matched when searching by a parent folder. Note that intermediate folders with no contents will be suppressed if they do not offer any search value.		When filtering by folder, subfolders are matched when searching by a parent folder. Note that intermediate folders with no contents will be suppressed if they do not offer any search value.

	''Submit Run'' either provides the option to submit a job for immediate or scheduled one-time execution. A job's current state must be either Enabled, Ad Hoc Active or Unscheduled Active to support immediate one-time execution. Otherwise, only future scheduled one-time execution is supported.

	~~''Clone Job'' opens up the a new job edit screen pre-populated with the selected job's configuration, including parameters and schedules.~~

	== Exporting Results ==		== Exporting Results ==

Carfey: /* Job Listing */

2017-01-15T18:57:26Z

Job Listing

← Older revision		Revision as of 18:57, 15 January 2017
Line 5:		Line 5:
	The default screen shows you a table of existing configured jobs.		The default screen shows you a table of existing configured jobs.

	[[Image:JobListing_4.0.png]]		[[Image:JobListing_4.1.png]]

	== Exporting Results ==		== Exporting Results ==

Carfey: /* Adding & Editing Jobs */

2017-01-15T18:49:14Z

Adding & Editing Jobs

← Older revision		Revision as of 18:49, 15 January 2017
Line 63:		Line 63:


	[[Image:AddJob_4.0.png\|300px]]		[[Image:AddJob_4.1.png\|300px]]

Carfey: /* Fields */

2017-01-15T18:46:03Z

Fields

← Older revision		Revision as of 18:46, 15 January 2017
Line 16:		Line 16:
	* Job Nickname (links to job configuration screen)		* Job Nickname (links to job configuration screen)
	* Job Class		* Job Class
			* Folder
	* Status (current)		* Status (current)
	* Schedule (current)		* Schedule (current)
Line 21:		Line 22:
	* Clone Job Link (users with Write role only)		* Clone Job Link (users with Write role only)

	Job records can be optionally filtered by host and ~~status~~. In the case of each, selecting no options is equivalent to choosing all options . Selected options may be cleared by clicking the (X) next to the dropdown arrow.		Job records can be optionally filtered by host, status and folder. In the case of each, selecting no options is equivalent to choosing all options . Selected options may be cleared by clicking the (X) next to the dropdown arrow.

			When filtering by folder, subfolders are matched when searching by a parent folder. Note that intermediate folders with no contents will be suppressed if they do not offer any search value.

	''Submit Run'' either provides the option to submit a job for immediate or scheduled one-time execution. A job's current state must be either Enabled, Ad Hoc Active or Unscheduled Active to support immediate one-time execution. Otherwise, only future scheduled one-time execution is supported.		''Submit Run'' either provides the option to submit a job for immediate or scheduled one-time execution. A job's current state must be either Enabled, Ad Hoc Active or Unscheduled Active to support immediate one-time execution. Otherwise, only future scheduled one-time execution is supported.