Alarm Manager Variables

The following Alarm Manager variables can be scoped into for use in your applications. You must preface these variable names with "\AlarmManager\".

General

Started "True" when the Alarm Manager has started. Alarms must not be registered with the Alarm Manager before this value is true (see Register (Alarm Manager)).

DBSysVal The current alarm database. This can be used to obtain information from the database using DBListGet and DBListSize.

CurrentServer A text name indicating the workstation currently acting as the Alarm Manager server.

RPCStatus The current RPC connection status; a value returned by the RPC Manager's Register subroutine.

Remote Set to true when the alarm source is from a remote workstation. This workstation is not the Server.

BitmapDatabase The object pointer to the Bitmap Database. This is where preloaded bitmaps are stored. (For more details, see the "Bitmap" keyword description above.)

ListChange Value changes or can be changed to indicate a change in the database. It should be set to any valid value that is different from the current value.

AckAll When set to a non-zero value, all unacknowledged alarms are acknowledged. AckAll is reset to zero after this takes place.

AckFilter If set to a valid field filter, all alarms meeting the filter condition will be acknowledged. AckFilter is reset to invalid after this takes place.

FieldValues This is a temporary array used by alarm action modules. This array is filled by the TransferFields subroutine.

Alarm Sounds

Silence When true, alarm sound is turned off for the alarm currently generating a sound.

SoundPriority The priority of the alarm currently generating a sound.

SoundAlarm The object value of the alarm currently generating a sound.

Cycles The number of cycles for which to play tones (< 0 means continuous).

Note: In versions of VTS prior to 7.5, alarm sounds were played using the system speaker (see Beep statement). In VTS versions 7.5 and later, alarm sounds are generated using wave files and can be heard with a sound card and speakers (see PlaySound statement).

Record Configuration

Read from [ALARM_MANAGER] Section in Config.ini, AlarmManager.ini, or workstation.ini. Please refer to Config.ini [ALARM_MANAGER] Section Variables.

FieldCount The number of fields in the alarm.

FieldNames The names of the fields.

FieldSizes The field sizes as defined for the Alarm Manager's database.

Filter Dialog Configuration

Read from [ALARM_MANAGER] Section in Config.ini, AlarmManager.ini, or workstation.ini. Please refer to Config.ini [ALARM_MANAGER] Section Variables.

FilterCount The number of filters in the filter dialog

FilterName The text names for the filters

FilterIndex The field indices for the filters