Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

This XCommands notifies visualization device / user about a new alarm. As notification the default Windows notification is used.

...

NameTypeMandatory/OptionalDescription
DevicestringOSpecifies the visualization device to be notified by this XCommand. Leave empty to address all devices.
User or Groupcustom / stringOSpecifies 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.
MessagestringMText that is shown in the notification pop-up.
Alarm IDstringOThe ID  ID (WID) of calling Alarm Alarm.
Sound filestringOName of the WAV file. For web visualization, the sound file must be located at in C:\ProgramData\nxa4\external\global. For the PC-based visualization the sound file must be stored at in <Installation directory BMS Platform>\Visualization\ResourceFiles\WAVs.
If not used, the default system sound is played.
Loop soundboolOIf yestrue, the sound is played until the notification pop-up is acknowledged by clicking on it. Default is false.
Show alarm listboolOIf yestrue, the alarm list is shown in the visualization. 
Alarm list viewcustom / stringOSpecifies the view (Main / View1, View2, or View3) in which the alarm list shall be shown. Leave empty to address "Main view".
Show pagecustom / stringOName of the target page that shall be shown when the alarm occurs.
Page viewcustom / stringOSpecifies the view (Main, View1, View2, or View3) in which the page shall be switched. Leave empty to address "Main view".
Variablescustom / stringOThe values of page variables can be defined here. The format is <varname1>=<varval1>,<varname2>=<varval2>,...

...

None.

Possible trigger types

  • All

Article applies to the following products: 

...