Notification area

Introduction

Display and persistence of notifications

Notifications in multi-server installations

Permission requirements

To view notifications

Introduction:

From Entuity v21.0 P02 upwards, the Notification bell icon in the top right of the browser window notifies you when asynchronous and background tasks and processes are completed, and how many unread notifications you have. Clicking on the icon opens the Notifications form, listing your current read and unread notifications.

In this example, there are 10 unread notifications.

Notifications are raised on tasks and processes relating to the addition or modification of assets and devices, and configuration set sync job success or failure.

Display and persistence of notifications:

User-specificity:

Users only see the notifications generated by their own tasks and process. Users will not see notifications generated by other users. For example, if an admin and a non-admin user log in to the same installation, they will each only see notifications relating to their own changes.

Within the same location/browser:

As soon as a user-initiated background task or process has completed, a notification will appear to the user in the Notification area. If the user has multiple Entuity tabs open in the same browser, the notification will immediately update on all tabs.

Across different locations and/or browsers:

If the user is logged in from different locations and/or different browsers, the Notification area will only be updated after a minimum of 5 minutes.

Tasks and processes initiated via RESTful API:

If a RESTful API-initiated task or process is completed, the notification will be updated immediately.

Lifetime of notifications:

By default, all notifications will persist for 7 days. You can change this via the [userNotification] parameter in entuity.cfg. After this time period, the notification will be deleted, even if it is unread.

If a user is deleted, all their notifications will be deleted as well.

Notifications in multi-server installations:

Notifications are stored on individual servers. This means that notifications are displayed to the user from all servers.

Permission requirements:

There are no tool permission requirements for using Notifications, and so they are available to all users.

To view notifications:

1. Click on the icon to open the Notifications form on the right of the page. The number of unread notifications will be displayed on the icon (in the below example, there are 2 unread notifications).
   
   
   
   
2. The Notifications form will open on the right of the window. This form displays the list of your notifications. Any unread notifications are marked with an icon.
   
   
   
   
3. You can drill down to view a notification's details by clicking its > arrow.
   
   
   
   This will open the Notification Details form for the selected notification, providing description and details, source, start and end timestamps for the selected process, success or error messages for the task or process. You can expand the Details field into a popout dialogue via the icon to better read the message therein.
   
   
   
   
4. You can dismiss/remove notifications from the list by ticking their tick box, or Select All, and clicking Remove.