AddAPPalarm
- Last UpdatedJul 05, 2024
- 2 minute read
The function of this Business Logic Tier (BLT) is to add an application alarm.
Syntax
AddAPPalarm <dbname> <ptname> <fldname> <description> <group> <category> <almMsg> <persistent> <flashing> <severity> <purgeTimer> <timestamp> <msec> <dataset> <host> <priorityDisplay>
Note: The above is entered as one line of syntax. The RealTime database (RTDB) must be open before calling AddAppalarm. Use VDB.OpenDatabase() to open the RTDB.
Parameters
|
Name |
Description |
|---|---|
|
dbName |
Any string that is used to filter the alarm summary by table name; this is one of the four parameters used to distinguish a unique alarm. This table does not need to exist in the RTDB. |
|
ptName |
Any string that is used to filter the alarm summary by point name; this is one of the four parameters used to distinguish a unique alarm. This point does not need to exist in the RTDB. |
|
fldName |
Any string that is used to filter the alarm summary by field name; this is one of the four parameters used to distinguish a unique alarm. This field does not need to exist in the RTDB. |
|
description |
A description of the value that is in alarm. |
|
group |
The name of the Area of Responsibility (AOR) group. |
|
category |
The category to which the alarm belongs; this is one of the four parameters used to distinguish a unique alarm. Only one persistent alarm can exist for a point for an alarm category. |
|
message |
Alarm message to display. |
|
persistent |
If false, the alarm will be removed from the alarm summary after acknowledgement. If true, in order to delete/replace the alarm, AddAPPalarm must be called later with the same fldname, category, and persistent to set to false. |
|
flashing |
Determines if the point should flash to indicate the alarm. |
|
severity |
Alarm severity: low, minor, medium, major, high, or critical. |
|
purgetimer |
Purge time 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". Set to 0 to not invoke purge timer functionality. |
|
timestamp |
Timestamp for the alarm, added in the format of number of seconds since January 1, 1970, 00:00 Greenwich Mean Time (GMT). If 0, the system assigns both the timestamp and msec values automatically. |
|
msec |
The number of milliseconds. Part of the combine timestamp value. |
|
dataset |
The dataset name from the database. |
|
host |
Name of the host that generated the alarm. |
|
priorityDisplay |
The name of the priority easy eXtended Operator Station (ezXOS) display to associate with the alarm. The priorityDisplay can be blank. |
Example
AddAPPalarm "myDBName" "myPtName" "myFldName" "my description" "groupName" "myCategory" "the alarmmessage" "no" "yes" "high" 0 0 0 "" "myhostName" "myDisplayName"