Managing Notifications, Subscriptions and Transmissions

The Notification views display information about the device data maintained within Edge Xpert. When you select the NOTIFICATIONS option from the main menu, the following options are listed:

  • Notifications Select this menu option to display the Notifications pane, as described in Managing Notifications
  • Subscriptions Select this menu option to display the Subscriptions pane, as described in Managing Subscriptions
  • Transmissions Select this menu option to display the Transmissions pane, as described in Managing Transmissions

To use the Notification views, you must start edgexpert with the --xpert-manager and the --support-notifications options, as shown below:

edgexpert up --xpert-manager --support-notifications

For further information on the edgexpert command options, see Edge Xpert Command Line Interface Tool.

Managing Notifications

The Notifications pane allows you to view the current list of notifications.

The current notifications display as illustrated below:

Notifications

Adding a Notification

To add a notification, complete the following steps:

  1. Select the Add (+) icon

    The UAdd Notification dialog box displays.

Add Notification
  1. Complete the fields, as described in the following table:
Field Description Value
Slug Unique name for the notification  
Sender The name that is displayed in the notification  
Category The type of notificaton. You can subscribe to a particular category, for more information, see Adding a Subscription Security, Hardware health, Software health
Severity The severity of the notification. Critical severity notifications are handled immediately, Normal severity notifications are processed in a batch Critical, Normal
Content The content of the notification  
Labels Labels to identify the notification. You can define multiple labels. You can subscribe to labels, for more information, see Adding a Subscription  
  1. Select the OK button to add the notification. Selecting the Cancel button closes the dialog box without creating a notification

The new notification appears in the last row of the list of notifications.

Viewing Transmissions

You can view details for notifications that have been processed by selecting the View Transmission icon, as illustrated below:

Add Notification

Note

You can view transmission information for all notifications on the Transmissions pane, as described in Managing Transmissions.

Deleting a Notification

To delete a notification, complete the following steps:

  1. Select the Delete (x) icon from the Action column

    The Confirm Delete dialog box displays.

  2. Select the Delete button to delete the notification. Selecting the Cancel button closes the dialog box without deleting the notification

Managing Subscriptions

The Subscriptions pane allows you to view the current subscriptions to the notifications.

The current subscriptions display as illustrated below:

Subscriptions

Adding a Subscription

To add a subscription, complete the following steps:

  1. Select the Add (+) icon

    The Add Subscription dialog box displays.

Add Subscription
  1. Complete the fields, as described in the following table:
Field Description Value
Slug Unique name for the subscription  
Receiver The receiver of the subscription  
Subscribed Categories The type of notificaton to which to subscribe. You can subscribe to a particular notification category or multiple notification categories Security, Hardware health, Software health
Subscribed Labels The notification labels to which to subscribe. You can subscribe to one or more notification labels. Enter a label and press the Enter button to add a subscribed label  
Subscribed Channels Identifies where the subscription sends the notification. You can define one or more channels in a subscription. Enter the channel and press the Enter button to add a subscribed channel REST URL, email address
  1. Select the OK button to add the subscription. Selecting the Cancel button closes the dialog box without creating a subscription

The new subscription appears in the last row of the list of subscriptions.

Editing a Subscription

To edit the details of the subscription, complete the following steps:

  1. Select the Edit Export (edit) icon from the Action column

    The Edit Subscription dialog box displays.

  2. Update the fields in the Edit Subscription dialog box as required. For information on the fields, see Adding a Subscription, above

  3. Select the OK button to update the subscription details. Selecting the Cancel button closes the dialog box without changing the subscription details

Deleting a Subscription

To delete a subscription, complete the following steps:

  1. Select the Delete (x) icon from the Action column

    The Confirm Delete dialog box displays.

  2. Select the Delete button to delete the subscription. Selecting the Cancel button closes the dialog box without deleting the subscription

Managing Transmissions

The Transmissions pane allows you to view transmission information for all notifications sent for all notifications.

The transmissions tht have been sent display as illustrated below:

Transmissions