Admin Job Chains

From Obsidian Scheduler
(Redirected from Job Chains)
Jump to: navigation, search

Job chains can be viewed and managed from within the Jobs tab.


Job Chain Listing

Existing job chains can be viewed by clicking the View Chains link in the navigation bar below the tabs. You may optionally filter by selecting one or more source jobs to see which jobs are chained from those selected jobs. All or None links at the top of the selector allow you to easily make multiple selections or deselections. The selector title will indicate how many options are chosen at a given time. Click Reload to refresh the results table.

Clicking the link Chain Jobs links in the table will bring you to the Job Chain edit screen.

To create a new Job Chain, click the Add Chain link in the top left of the results table, or Add Chain in the navigation bar from any place underneath the Jobs tab.


Chain Tree View

Complex chain setups can be difficult to understand at times. To facilitate understanding how the chains relate to each other, Obsidian provides a tree view of chains as of version 3.3.0. Click on the View Tree link at the top of the table to view the tree diagram.

Enabled jobs are always shown as a root job in addition to any chain source jobs not found in another tree. If a job is not Enabled and is found in another chain tree, it will not be shown as a root job.

Asterisks (*) mark jobs that will not be executed due to their current job state (e.g. Disabled or Ad Hoc Active).

Hash signs (#) mark the target job of a chain that is not currently active.


Adding or Updating a Job Chain

When adding or updating a job chain, a source and target job must be selected, along with at least one trigger state.

The source job indicates the job whose completion will trigger the target job to be run.

The trigger states indicate which source job termination states will trigger the target job run. Default trigger states are selected when creating a new chain since they are the commonly used options, but they may be changed to whatever is required.

A description is optional for use on the View Chains page. A description is generated if none is provided.

A schedule is optional and can be specified to restrict which times the target job may be spawned - if the source job terminates at a time that doesn't match the schedule, the target job will not be created.

When Conditional is selected as a trigger state, you must specify one or more conditions. In addition, only one of the Completed and Conditional state may be selected. See the Conditional Chaining Configuration below for more details on saving Conditional triggers.

Note: The question mark icon that appears next to the form title indicates inline help. Click on the icon to see help related to the current page.


Conditional Chaining Configuration

As of Obsidian 1.4, conditional chaining is supported. Conditional triggers are similar to Completed triggers, in that they only fire when a job successfully completes. The Conditional state, however, lets you indicate various output conditions which determine if the chain is triggered.

If you select the Conditional trigger state, the Result Conditions area will be revealed below the state selector. In this section, you must specify at least one condition which is used to determine if the chain will fire. Each condition must be matched for the chain to be triggered. See Job chains for complete details on how conditional chaining works.

Each condition has the following fields, all of which are mandatory when presented: Variable Name, Operator, and Value. Note that the Value field is not shown for the Exists/Not Exists operators, and supports multiple values for the In/Not In operators.

To add an extra condition, click the Add Condition link above the Save button. To remove an unwanted condition, click the Remove Condition link to the right of that condition.

When using In/Not In operators, you may specify one or more values. To add a value, click the Add Value link to the right of the value field. To remove an unwanted value, click the Remove link right next to that value.

Always ensure you click the Save button to confirm your changes and validate your conditions.


Confirming Changes

Once you've completed your desired changes, click the Save button at the bottom of the form or the button in the left navigation area. You will either receive a save confirmation message as below, or a validation error message.



As of Obsidian 2.6, you can delete a job chain configuration. We recommend you use this feature sparingly on long-obsolete chains. When you attempt to delete a job chain, Obsidian will ask for your confirmation.

Deleting a job chain in Obsidian assumes you are fine with losing the chaining evaluation results. Jobs will continue to show as either Chained or Chain Skipped, but the evaluation details will no longer be available.