Settings
The portal can be configured from the Settings view. Edit the settings by clicking on the pencil to the right of each field. The settings values are used to customize the application and brand emails.
Network Management Notifications
Overview
Network Management Notifications is a special notification target that allows Operators and their customers to specify a single endpoint for receiving notifications to manage their platform internally. This notifier is configured by the Operator per customer and provides a secondary channel to receive notifications. The Management platform provides notifications for opening and closing alerts for Base Stations and Applications.
Alerts
There are two alerts systems customers can receive notifications from, Base Stations and Applications. Like the standard emailing interface, customers receive notifications for any new alert of Moderate severity or above. Unlike the email system, notifications are sent when an alert is cleared or closed either automatically or by Senet Operations. Only alerts that are configured to send notifications to a customer are sent via the Management Notifier.
Operators
Only Operators can configure Management Notifiers for themselves or for their customers. Operators also receive a copy of each of their customers notifications on their own notifier. This provides the Operator oversight of activity inside their platform.
Configuration
Use the steps below to view and configure the Management Notifier feature.
- Navigate to Administration -> Settings.
- Press the edit button in the Operator Notifier section at the bottom of the panel. The Operator Notification Target Dialog will appear.
- Configure the end point to send the data to. The required parameters for this notifier are as follows:
Name | Required | Description |
---|---|---|
Message Types | Yes | A list of all the message types you can get messages for. At least one must be selected, unchecking an item from the list will ensure you no longer receive messages of that type. |
HTTP URL | Yes | This is the URL you wish to direct all HTTP POST request to, the body of said request will contain a message in the management notification format. |
Header Keys | No | This is a header name that will be applied as a header to all HTTP POST requests. |
Header Values | No | This is the value that is paired with the header name and is also applied to all HTTP POST requests. |
-
Press Save to persist the changes or Cancel to abandon changes. The new configuration will be used immediately.
-
Management Notification Targets can be created for different customers from within the Customers table.
Network Management Notification API
Network Management Notifications have a basic format and the type of the message determines the body of the message:
Field Descriptions
Field | Description | Values |
---|---|---|
type | The Type of message being sent. | BASE_STATION, APPLICATION |
subType | The format of the message body | ALERT |
data | One or more messages of the subType format |
Alert Type Field Descriptions
Alert type messages contain detailed information about the alert that was either raised or cleared.
Field | Description |
---|---|
count | The number of times the alert has been raised. |
latestSystemInfo | The most recent information about why the alert was raised. |
identifier | The identifier for the alert, this is usually the entity that is being alerted on i.e. Base Station or Application EUI. |
lastOccurrence | A timestamp in ISO format when the alert was last triggered. |
status | The current status of the alert; Open, Cleared, and Closed. |
severity | The severity of the alert; Low, Moderate, High, Urgent. |
name | The name of the alert type, some Examples: No Connection, No SSH Connection, Device Count - Critical, etc. For the full list of alerts, see Base Station Alerts and Application Alerts |
notes | Optional notes provided by the system or Senet Operations. |
firstOccurrence | A timestamp in ISO format when the alert was first triggered. |
Example
{
"type":"APPLICATION",
"subType":"ALERT",
"data":[
{
"count":"3",
"latestystemInfo":"Notifications: 0.0 Threshold: 3000000",
"identifier":"XXXXXXXXXXXXXXXX",
"lastOccurrence":"2019-05-09T19:01:56.765Z",
"status":"cleared",
"severity":"Moderate",
"name":"Low Notification Count",
"notes":"",
"firstOccurrence":"2019-05-09T18:55:16.887Z"
}
]
},
{
"type":"BASE_STATION",
"subType":"ALERT",
"data":[
{
"count":"3",
"latestystemInfo":"Disconnected",
"identifier":"00250C00010186DC",
"lastOccurrence":"2019-05-09T19:01:56.765Z",
"status":"cleared",
"severity":"High",
"name":"No Connection",
"notes":"",
"firstOccurrence":"2019-05-09T18:55:16.887Z"
}
]
}
```