Admin Notifications (3.x.x and earlier)

The notifications screen allows subscribers to be notified of various scheduler events and job execution. Notifications use the configured SMTP. See Event Notifications for a brief feature description.

Listing Subscribers

The main notifications screen shows the current subscriptions and their details. Click on the subscriber name to edit a user or click the Add Subscriber link in the navigation bar below the tabs to create a new subscriber.

Adding or Editing a Subscriber

When adding or editing a subscriber, a unique email address must be supplied, the subscriber can be made active or inactive. Various events can be subscribed to, and you can subscribe to job execution events based on completion state or their job output.

Note: The question mark icon next to form titles indicates inline help. Click on the icon to view help related to the current item.

General Subscriptions

General subscriptions allow you to subscribe to job-related events, or other events related to Obsidian's operation. Before Obsidian 2.7.0, this was the only type of subscription available.

To be notified of a class of events, use the Add Subscription link to add a new row and select your subscription settings. Rows can be removed with the Remove link to the right of the row.

Some events do not allow specifying a severity level as they are always informational events, and the screen will be updated to reflect that.

In the case of events related to specific jobs, you may select a specific job or choose to subscribe to events for all jobs. Multiple subscriptions may be managed for the same event type if they apply to different target jobs. In addition, you may inactivate a subscription if you decide you may need it later.

Changes may be confirmed by clicking the Save button at the bottom of the form, or the one in the left navigation area.

The following categories can be selected when configuring a general notification subscription:

• Queue - issues running the job queue including database connectivity issues.
• Job Chain - job chaining results. Subscribe at the Info level to receive chain notifications.
• Job Config - job configuration changes. Subscribe at the Info level to be notified when someone makes job configuration changes.
• Job Recovery - job recovery activity, such as Missed or Abandoned jobs, generally on Obsidian startup. The Info level will subscribe you to receive recovery information.
• Job - parent category to the Job categories listed above. Subscribing to this category will effectively subscribe you to the above categories. In addition, subscribing at the Info level will notify you of all job executions, while the Error level will notify you upon job execution failure.
• Licence - events related to key licensing. Subscribing to the Warning level will notify you early of issues verifying the license key.
• System Parameter - system parameter changes. Subscribe at the Info level to be notified when someone makes parameter changes.

Job Execution Subscriptions

As of Obsidian 2.7.0, users now have precise control over when job runs result in notifications. This includes notifications based on particular execution states and job result output. Before this was available, job execution notifications were possible through the Job Run general subscription category.

You can configure any number of separate job execution subscriptions with different configuration. If any the active configurations matches a job execution event, a notification will be sent. For example, you can create one subscription that notifies of any job failures, and add a separate subscription to notify of successful completion of a specific set of jobs.

To configure a new Job Execution Subscription, use the Add Subscription link to add a new row and select your subscription settings. The subscription can be removed with the Remove on the right.

When adding or updating a new subscription, specify the desired trigger states, applicable jobs, and if using the Conditional trigger state, one or more job result conditions.

Trigger states control when job execution results in a notification. Default trigger states are selected when creating a new entry, but they may be changed to whatever is required. Valid trigger states are:

• Completed - corresponds to the same job history status (i.e. when a job completes without an error).
• Died - corresponds to the same job history status (i.e. when a job does not complete normally, potentially triggered by a forceful shutdown).
• Failed - corresponds to the same job history status (i.e. when a job throws an exception).
• Recovery - triggered when a job does not complete normally, and subsequently finishes with the Completed state.
• Conditional - allows you to specify one or more output conditions that must be met to trigger a notification. These conditions match the source job's Job Results. All conditions must be met to trigger the notification, and the job must complete successfully.

In addition to trigger states, you may select zero or more jobs that apply to the subscription, or you can select the All Jobs option to make it apply to all current and future jobs.

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 Job Notification Configuration below for more details on saving Conditional triggers.

Changes may be confirmed by clicking the Save button at the bottom of the form, or the one in the left navigation area.

Conditional Job Notification Configuration

Conditional notification 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 notification is sent.

If you select the Conditional trigger state, the Job 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 notification will occur. Each condition must be matched for the notification to be triggered.

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. 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.

Deleting a Subscriber

As of Obsidian 2.1, you can delete a subscriber from the Edit Subscriber screen by clicking the Delete button and confirming the action.

Note: When a subscriber is deleted, all related notification history is deleted as well. To retain this history, consider deactivating the subscriber instead.

Inactive Subscriptions

You may make a subscriber inactive to that no notifications are sent to the user until it is re-activated.

Likewise, you may wish to only deactivate certain subscription events, in which case the subscriber would still be notified of active subscriptions.

Sent Notifications Screen

This screen lists notification history based on the selected date range and other criteria. It can be accessed by clicking View Notifications in the secondary link bar, which is beneath the main tabs.

Note: Records on this screen indicate that a notification was triggered and that Obsidian attempted to send it. It does not guarantee the send was successful, or that the notification was received.

Fields

Fields shown in the log table are:

• Subscriber
• Event Time
• Event Category (the event classification)
• Event Severity Level
• Event Summary (may be truncated)
• Event Message (may be truncated)

Filtering

Records can be filtered by Date and Time. From and To fields will show user-friendly 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.

Filters by Severity Level and Category are also supported. In the case of each, 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.

Below the filters is a selection box which allows you to choose an auto-refresh interval, so that your results will be constantly updated. You can turn this off by selecting "Don't auto-refresh". Note that auto-refresh will cause your session to stay active indefinitely, so you will remain logged in.

The Refresh button is used to refresh the results table. You may get a notice indicating the search results show too many records. In this case, you may wish to adjust your filter settings.

You may page through results using the paging at the top right of the table, and filter the table's records using the filter input box.

Expanding Rows

Records within the table may show a (+) sign to indicate the row may be expanded to see additional details. This will include full event message and summary if they have been truncated. Click the (+) icon to expand the record, and (-) to collapse it.