AddSYSalarm
- Last UpdatedApr 24, 2025
- 2 minute read
The function of this Business Logic Tier (BLT) is to add a RealTime service system alarm to the database.
Syntax
AddSYSalarm <key> <category> <messagetxt> <persistent> <flashing> <severity> <purgetimer> <group> <timestamp> <msec> [<host>]
Note: The above is entered as one line of syntax. The RealTime database (RTDB) must be open before calling AddSYSalarm. Use VDB.OpenDatabase() to open the RTDB.
Parameters
|
Name |
Description |
|---|---|
|
key |
A reference key for toggling the inalarm state of an alarm summary entry. |
|
category |
The category to which the alarm belongs. This can be arbitrary. This is used to distinguish similar alarms. The category must be one word without spaces. |
|
messagetxt |
Alarm message to be displayed. |
|
persistent |
This indicates whether or not the alarm remains in the alarm summary after acknowledgement and purge. |
|
flashing |
Indicates whether or not the point should be flashing. |
|
severity |
Alarm severity: low, medium, or high. |
|
purgetimer |
The purge timer is expressed in seconds. The timer starts after the alarm is acknowledged. The alarm is purged from the almsum table if the purge time has expired, and the persistent flag is "no". |
|
group |
The group name. |
|
timestamp |
The timestamp of the alarm, added in the format of number of seconds since January 1, 1970, 00:00 Greenwich Mean Time (GMT). |
|
msec |
Millisecond value of the timestamp. |
|
host |
The name of the host generating the alarm. |
Example
The following adds a test system alarm:
AddSYSalarm "test1" "low_alarm" "test system alarm" "no" "yes" "low" 10 "" 12345 "radserv1"
Comments
Alarms generated solely by executing this Remote Procedure Call (RPC) are transient unless additional RealTime service processing is performed.
The host is optional, but the timestamp and msec parameters are required.