Admin Jobs (3.x.x and earlier)

The job listing and edit pages give you access to the core of Obsidian's functionality - scheduling and configuring jobs. All job-related screens are accessible under the Jobs tab, with secondary navigation underneath for various features. This page discusses listing and modifying jobs. Other job-related features in the administration app are discussed on other pages in the Admin Web Application Guide.

Job Listing

The default screen under the Jobs tab will show you existing configured jobs.

Fields

Fields shown in the job table are:

• Job nickname (links to job configuration screen)
• Job Class
• Schedule (current)
• Status
• Recovery Type
• Pickup Buffer Minutes

Job records can be optionally filtered by host. The Refresh button is used to refresh the results table.

Adding & Editing Jobs

To add a new job, click the Add Job either at the top left of the job results table, or within the sub-navigation bar beneath the tabs.

To edit or view a job's configuration, click the nickname in the results table.

Job Edit Screen

The job edit screen contains multiple configuration items with which you should be familiar.

Note: The question mark icon next to form titles indicates inline help. Click on the icon to view help related to the current item. This is your best source of help when making changes to job details.

Date Fields

Dates and times are used to specify schedule starts and end times.

From and To fields will show user-friendly date and time selectors which enforce a valid date range. If you cannot select a date in the past or future, it is because the date widget is enforcing a valid time, and you may need to edit your from or to times appropriately.

Note: If you wish minute-level specificity, simply manually type your time into the time field in the 24-hour format HH:MM. You do not have to use the time selector.

There is some helpful behaviour when you wish a schedule to be indefinite and immediately active. You do not have to specify times in most common cases:

• Blank from dates will be treated as today's date.
• Blank from times will be treated as the next valid minute.
• Blank to dates will be considered as indefinite (no end).
• Blank to times will be considered as end of day (11:59 PM), or indefinite when the to date is blank.

Defined Parameters

If a job has defined parameters as discussed in Implementing Jobs, this section will show the configurable parameters. The label on the left will indicate the name and type of the parameter.

If the parameter definition allows multiple values, links to the left of the text field will allow you to add or remove values. Note that remove will not appear for the first item, and if you wish to omit the parameter value, simply leave the first field blank.

An asterisk will mark indicate values.

Custom Parameters

In addition to defined parameters, you always have the option of specifying custom parameters, which the job may use in a dynamic fashion. To add a custom parameter, click the 'Add Custom Parameter' link. Custom parameters always allow multiple values since they have no fixed definition, and you may add values by clicking the Add Value and Remove links to the left of the field. Any entered values will be validated against the selected type, and the selected type will determine how they are stored and provided to the job.

Note that the first field has a Remove Parameter link instead of Remove, and it will remove all values for that named custom parameter.