Table of Contents
User documentation
To operate a network, it is important to get an overview about the currently raised alarms. The application offers basic fault management of devices supporting ONF-TR-532. The alarms are classified according to the severity level (warning, minor, major, critical).
Overview Fault management:
Specification
“Fault” User Interface should be implemented to show the Alarm notifications of the devices.
...
The graphical user interface is separated in three Expansion Panels.into three tabs:
- Current Alarm Notifications
- Alarm Notifications
- Alarm Log
The table view implements the common ux-framework-table supporting sorting, filtering and pagination on the server.
The following panels shows the tables tabs should show a table with its respective data.
1) Current Alarm Notifications
Current Problem List
It lists all current active faults in the network. In addition, it also lists alarms sent by the SDN controller itself, which detects connections connection losses to the NetConf server (connectionLossOAM) or which detects connection loss to a devices device via a mediator to a device (connectionLossNeOAM).
Reload Button
: Reloads/Refresh the Current Problems List
Sync button 
: Clears stuck alarms
The Current Alarm Notification panel shows the table with the below columns.
- icon
- Time Stamp
- Node Name
- Count
- Object Id
- Alarm Type
- Severity
...
Clear stuck alarms
The sync button allows refreshing the current alarms for the visual NEs.
If the alarms are not indicated as active anymore, they will be removed from the list.
Clear stuck Alarm icon will only be available when there are Faults available else it wont be visible.
Export
The "export to CSV" button will export the presented current problem list to a CSV File.
Alarm Notifications
As long as the view is openpage is not fully refreshed (the browser reloaded), it lists all alarm notification notifications reached by the SDN Controller. Please note that refreshing the view will start the collection again. Previous alarm notification can be viewed in the alarm log.
Alarm Notifications should be collected in real-time via websockets.
The Alarm Notification panel shows the table with the below columns.
- icon
- Time Stamp
- Node Name
- Count
- Object Id
- Alarm Type
- Severity
...
Alarm Log
Next to the current currently active alarms, an alarm log lists all alarm notifications of the past.
...
- icon
- Time Stamp
- Node Name
- Count
- Object Id
- Alarm Type
- Sverity
The Fault values are stored on an ElasticSearch database. The REST-API is provided by the ApiGateway.
The index is “sdnevents” the doctype is
- “faultcurrent”- Data for Current Alarm Notifications
- “faultlog”- Data for Alarm Log
- Severity
Reload Button: Reloads/Refresh the Alarm log
Fault status summary view
Elements like Screenshot below:
- Elements are
- Node status, showing the actually connected NEs number
- Alarm Summary view
- If Fault is enabled, status window is visible all the time, independent of the actually selected app.
- If possible location is in the Title area at the right but left of Menue, Help or Logout
- Order of Status element is the same, that is provided by order of left side menus entries
- A click
- onto the Alarm status area link to alarm app and alarm view
- onto the Number of nodes links to the connect app
- The layout needs to be adapted to React/Material layout.
- Design discussion should be done: Is Node status part of Connect App and Fault part of Fault app or is both provided by Fault app?
- Help Button in status bar is provided by help app. Framework provides information about actual selected app.
Screenshot with Summary view
Data Provider
The data is stored in an ElasticSearch database. The Data-Provider provides a REST-API to read the data.
- Current Problem List
- get the current problem list: read-faultcurrent-list
- Alarm Log
- get the alarm log: read-faultlog-list
- Summary View
- get the fault status: read-status
Note: The alarm notifications are only updated via websockets. No REST-API is provided.