Notification.Alarm
Description
This XCommands notifies visualization device / user about a new alarm. As notification the default Windows notification is used.
Inputs
None.
Parameters
Name | Type | Mandatory/Optional | Description |
|---|---|---|---|
Device | string | O | Specifies the visualization device to be notified by this XCommand. Leave empty to address all devices. |
User or Group | custom / string | O | Specifies the user or group to be notified by this XCommand. Leave empty to address all users. If users and groups have the same name, user has precedence over group. |
Message | string | M | Text that is shown in the notification pop-up. |
Sound file | string | O | Name of the WAV file. For web visualization, the sound file must be located in C:\ProgramData\nxa4\external\global. For the PC-based visualization the sound file must be stored in <Installation directory BMS Platform>\Visualization\ResourceFiles\WAVs. Playing a custom sound file by the PC-based visualization requires the Windows Media Feature Pack to be installed, which is not included in Windows N editions. In that case, follow procedure of this article to update your system. |
Loop sound | bool | O | If true, the sound is played until the notification pop-up is acknowledged by clicking on it. Default is false. |
Alarm list window | custom / string | O | If used, the alarm list is opened in the specified window (“MainWindow”, “SubWindow1”, “SubWindow2”, “SubWindow3”). Leave empty to address "MainWindow". |
Page name | custom / string | O | Name of the target page that shall be shown when the alarm occurs. |
Page view | custom / string | O | Specifies the view (Main / View1, View2, or View3) in which the page shall be switched. Leave empty to address the current view. |
Variables | custom / string | O | The values of page variables can be defined here. The format is <varname1>='<varval1>',<varname2>='<varval2>',... |
Outputs
None.
Possible trigger types
All
Article applies to the following products:
NETx BMS Platform