User Support Application Notifications
The User Support Application (nxuseragent) is a Windows tray application that runs in user sessions and connects to the local NetXMS agent.
Administrators can send text notifications to it; the notification is shown as a pop-up on the desktop of logged-in users.
Sending, viewing, and recalling notifications requires the Manage user support application notifications system right (see User Management Reference).
The server delivers notifications only to nodes where the User Support Application is installed (reported by the Agent.IsUserAgentInstalled metric during configuration poll), and the agent accepts them only from servers listed in MasterServers (see Agent Configuration).
Notification Types
| Type | Behavior |
|---|---|
Instant |
Shown immediately in every User Support Application instance running on the target nodes at the moment of sending. The agent does not store it, so users who log in later do not see it. An instant notification cannot be recalled. |
Delayed |
Shown once per user while the current time is within the validity period (Valid from — Valid until). The agent stores it, so users who log in during the validity period also receive it. |
Startup |
Shown each time the User Support Application starts (typically at user login) while the current time is within the validity period. |
Sending a Notification
-
In the object browser, select one or more objects. Supported objects are nodes with an agent, containers, collectors, racks, clusters, rooms, facilities, power domains, cooling zones, and Infrastructure Services; for a non-node object, the notification goes to the nodes below it. You need read access to every selected object.
-
Right-click and select .
-
Enter the Message text.
-
Select Instant, Delayed, or Startup.
-
For Delayed and Startup, set Valid from and Valid until. Valid until defaults to the current time plus the
UserAgent.DefaultMessageRetentionTimeserver configuration variable (minutes, default 10080 — one week). -
Click OK.
Notifications can also be created from NXSL with the createUserAgentNotification() method; a start and end time of 0 create an instant notification.
Notification List
To see sent notifications, open . The list refreshes automatically when a notification is created or recalled.
| Column | Description |
|---|---|
ID |
Notification identifier |
Objects |
Objects the notification was sent to |
Message |
Message text |
Is recalled |
Yes if the notification was recalled |
Is startup |
Yes for a startup notification |
Start time |
Start of the validity period; empty for instant notifications |
End time |
End of the validity period; empty for instant notifications |
Creation time |
Time the notification was created |
Created by |
User who created the notification |
The filter field matches text in any column. By default the list hides instant notifications created more than one hour ago and delayed or startup notifications whose validity period has ended. The context menu options Show all one time notifications and Show all scheduler notifications show them; both settings are remembered between sessions.
Context menu actions:
- Go to object
-
Opens the target object in the object browser. Available when one notification sent to a single object is selected.
- Recall notification
-
Withdraws the selected notifications from the User Support Application on the target nodes. A recalled notification stays in the list with Is recalled set to Yes. Available only when none of the selected notifications is instant or already recalled.
Notifications cannot be deleted from the list.
The housekeeper removes a delayed or startup notification UserAgent.RetentionTime days after its Valid until time, and an instant notification the same number of days after it was sent (default 30 days, 0 keeps notifications forever; see Server Configuration Variables).