UX Maintenance

Owned by sai-neetha.phulmali
Last updated: Mar 17, 2021
4 min read

User documentation

The 'Maintenance' application provides the information of the Network Elements which are set for Maintenance, currently or in the future. User can manage devices to set the maintenance mode so that no unnecessary alarms are created. When the device is in Maintenance alarms are not forwarded to DCAE and when the device maintenance is turned off the alarms will start flowing again.

Users should have access to disable the Maintenance mode or change the maintenance start and end dates at any point of time by using the available options in actions column.

Specification

“Maintenance” User Interface should be implemented to show if the device is in maintenance or not and to manage the maintenance of the device.

Below are the UI elements to be implemented.

Main View

The graphical user interface has a table view.

The table view implements the common ux-framework-table supporting sorting, filtering and pagination on the server.

The table shows the following fields:

  1. Node Name

  2. Notification

  3. Activation State

  4. Start Date

  5. End Date

  6. Actions

    1. +1H

    2. +8H

    3. Edit

    4. Remove

Reload Button: Reloads/Refresh the Maintenance Entries

Following, the columns are specified.

1)      Node Name:

Shows the device name

 

2)     Notification:

symbol indicates notifications are suppressed during its maintenance.

 

3)      Activation State:

'Activation State' is a field for which user have the capability to suppress the notifications when it is in maintenance mode by setting its Activation State. if it is set to 'active', notifications are suppressed else notifications are not suppressed..

Even though when the startDate and endDate is in current time span and if activation state is 'not active' the notifications are still forwarderd.

-when the startDate and endDate is in current time span and if activation state is 'active' the notifications are suppressed.

 

4)      Start Date:

shows the start date of the device maintenance

 

5)      End Date:

shows the end date of the device maintenance

 

6)     Context Menu Actions: Buttons to be implemented to manage the maintenance of the device

 

  1. +1H: This should set the device in Maintenance Mode for the next one hour. (currentTime+1hours). When the button is clicked the modal window should be opened for the confirmation with the pre-existing values.
              

  2. +8H: This should set the device in Maintenance Mode for the next eight hours. (currentTime+8hours). When the button is clicked the modal window should be opened for the confirmation with the pre-existing values.
               

  3. Edit: This should allow the user to set the start and end dates for the device Maintenance.  When the button is clicked the modal window should be opened for the confirmation with the pre-existing values
                

  4. Remove: This should allow the user to disable the Maintenance of the device at any point of time. When the button is clicked the modal window should be opened for the confirmation with the pre-existing values.
                  




Add new maintenance entry

The  button on the top right corner should allow users to add the device in Maintenance as shown below

Rules on startdate and enddate

Even if the date/time for "Start" and "End" is in the past, you can still set the activation state to active.

As per the discussion 27/11 - The start and end dates displayed in the GUI should be UTC datetime with the indication to the user that it is in UTC dateTime.

Data Provider

The Maintenance values are stored in an ElasticSearch database. The REST-API is provided by the Data-Provider.

  1. Entity to create maintenance entry is create-maintenance

  2. Entity to read maintenance list is read-maintenance-list

  3. Entity to delete maintenance entry is delete-maintenance