From 06fb529a84d4e7d70b3aca68c33b2980049d5973 Mon Sep 17 00:00:00 2001 From: Aijana Schumann Date: Tue, 11 Feb 2020 15:44:17 +0100 Subject: Update documentation for odlux Update help texts for all odlux apps to include new functionality Issue-ID: SDNC-1065 Signed-off-by: Aijana Schumann Change-Id: I35b60a950b758f3bc3c182a01646d6d746ed2240 Signed-off-by: Aijana Schumann --- docs/guides/onap-user/pnfFault.rst | 41 +++++++++++++++++++------------------- 1 file changed, 20 insertions(+), 21 deletions(-) (limited to 'docs/guides/onap-user/pnfFault.rst') diff --git a/docs/guides/onap-user/pnfFault.rst b/docs/guides/onap-user/pnfFault.rst index ff3a1ac47..5e54547a9 100644 --- a/docs/guides/onap-user/pnfFault.rst +++ b/docs/guides/onap-user/pnfFault.rst @@ -13,24 +13,23 @@ the severity level (warning, minor, major, critical). Views ----- -The graphical user interface is separated in three views. +The graphical user interface is separated into three views. Current Alarms ~~~~~~~~~~~~~~ -It list all current active faults in the network. In addition it also -list alarms sent by the SDN controller itself, which detects connections -losses to the NetConf server (connectionLossOAM) or which detects -connection loss to a devices via a mediator to a device -(connectionLossNeOAM). +Lists all current active faults in the network. In addition, it also +lists alarms sent by the SDN controller itself, which detects connection +losses to the NetConf server (connectionLossOAM) or to a device via a +mediator to a device (connectionLossNeOAM). Alarm Notifications ~~~~~~~~~~~~~~~~~~~ -As long as the view is open, it lists all alarm notification 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. +As long as the view is open, all alarm notifications received by the SDN +Controller are listed. Please note that refreshing the view will start +the collection again. Previous alarm notification can be viewed in the +alarm log. Alarm Log ~~~~~~~~~ @@ -42,18 +41,18 @@ Implementation -------------- The application has two parts. While the server is listening for NetConf -notifications to store them in the database the client retrieves the -information from the database and displays them in a grid view. +notifications to store them in the database, the client retrieves the +information from the database and displays them in a table. -The server synchronizes with the current alarm lists of the devices and -calculates based on raise and clear notifications the current alarm -status of the network. The current alarms are stored in a database. In -addition all Problem Notifications received by the SDN controller are -stored. There is no logic implemented on the client. +The server synchronizes with the current alarm lists of the devices. +Based on raised and cleared notifications, the current alarm status of +the network is calculated. The current alarms are stored in a database. +In addition, all Problem Notifications received by the SDN controller +are stored. There is no logic implemented on the client side. -An alarm status bar on top of each graphical user interface informs the +An alarm status bar in the header of the web application informs the operator about the health status of the network. -The OpenDaylight DLUX web application uses web sockets for updating the -graphical user interface in case of Problem Notification (devices) and -Connection Status Notifications (ODL). +The OpenDaylight-DLUX web application uses web sockets to update the +graphical user interface of the Problem Notifications (devices) and +Connection Status Notifications (ODL) in real-time. -- cgit 1.2.3-korg