Admin Notifications (3.x.x and earlier): Difference between revisions
No edit summary |
|||
| Line 10: | Line 10: | ||
== Adding or Editing a 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 | 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. | '''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. | |||
In the case of events related to specific jobs, you may select a specific job or choose to subscribe to events for all | To be notified of a class of events, use the ''Add Subscription'' 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. | |||
Changes may be confirmed by clicking the Save button at the bottom of the form, or the one in the left navigation area. | 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 configuration 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, 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 licence key. | |||
* '''System Parameter''' - system parameter changes. Subscribe at the ''Info'' level to be notified when someone makes parameter changes. | |||
[[Image:AddNotification.png]] | [[Image:AddNotification.png]] | ||
Revision as of 22:00, 8 July 2014
The notifications screen allows subscribers to be notified of various scheduler events. 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 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.
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 configuration 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 Infolevel to be notified when someone makes job configuration changes.
- Job Recovery - job recovery activity, 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 licence key.
- System Parameter - system parameter changes. Subscribe at the Info level to be notified when someone makes parameter changes.
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.
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.
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.



