Default [ALARM_MANAGER] Section and Variables

[ALARM_MANAGER]

; Event bitmaps (see Bitmap below).

Bitmap = 1XX, Active,    7 

Bitmap =  X1X, Trip,     7 

Bitmap =  0XX, Normal,   7 

Bitmap =  X0X, Ack,      7 

Bitmap =  XX0, Enable,   7 

Bitmap =  11X, Almunack, 7 

Bitmap =  01X, Nrmtrip,  7 

; Status bitmaps

Bitmap = 000, Enable,    7 

Bitmap = 100, Almack,    7 

Bitmap = 010, Nrmunack,  7 

Bitmap = 110, Almunack,  7 

Bitmap = 001, Disable,   7 

; Priority bitmaps

Bitmap = 3, High,        7 

Bitmap = 2, Warning,     7 

Bitmap = 1, Event,       7 

; The record fields (see KeyCount and KeyName below).

KEYCOUNT = 7 

KeyName = Message,        0, 80 

KeyName = Priority,       1, -1 

KeyName = Type,           2, -1 

KeyName = HookPointValue, 3, -3

KeyName = Area,           4, 32 

KeyName = HookPointUnits, 5, 15

KeyName = Operator,       6, 32 

; The number of extra lists required (see Lists below).

LISTS = 0 

; The record fields (see FilterCount and FilterName below).

FILTERCOUNT = 5 

FilterName = 0, 1, 0, Message for the alarm 

FilterName = 1, 2, 0, Priority 

FilterName = 2, 3, 0, Type of Alarm 

FilterName = 3, 4, 0, Operator name 

FilterName = 4, 5, 0, Area 

Bitmap OBSOLETE – The first group of variables in the [ALARM_MANAGER] section (Bitmap) are obsolete. The Bitmap variables were used in earlier versions of VTS to specify the event, status, and priority bitmaps that were displayed in the Status and Priority columns of the default alarm list.

Default: N/A

KeyCount Specifies the number of alarm fields that are stored in the alarm database (Alarms.db), as qualified by the number of KeyName variables that follow it.

Note: The KeyCount variable must be defined before any KeyName variables. Any KeyName variables found before the KeyCount variables are ignored.

Default: KeyCount = 7

KeyName Defines the fields in the alarm database (Alarms.db). Each KeyName entry indicates the name of the variable representing each field, the index number for the field in the alarm database, and the data type corresponding to the type of data to be stored in the field. The syntax is as follows:

KeyName = <Name>, <Position>, <Size>

Where:

      Name is the variable name associated with the database field.

      Position is the position of this field within the record (starting at zero and incrementing by one for each subsequent KeyName variable).

      Size is the size of the field.

      A positive size defines the size of a text field.

      A size of zero defines a record of unknown size; any value can be put in the field, but it will not be saved to any file.

      A negative size indicates a numeric data type:

       -1 for a signed short integer (2 bytes).

       -2 for a signed long integer (4 bytes).

       -3 for a signed double-precision floating-point variable (8 bytes).

Note: KeyName entries must appear beneath the KeyCount variable in order to be recognized by VTS. Further, the KeyCount variable must be incremented according to the number of KeyName entries you configure. For example, if you specify 7 KeyName entries, then KeyCount should be set equal to 7.

Default: 

KeyName = Message,         0,   80

KeyName = Priority,        1,   -1

KeyName = Type,            2,   -1

KeyName = HookPointValue,  4,   32

KeyName = Area,            4,   32

KeyName = HookPointUnits,  5,   32

KeyName = Operator,        6,   32

 

Lists Used when extra user-defined lists are required within the alarm database (Alarms.db). The number indicates the number of extra lists required over the default lists (i.e. the Active, Unacknowledged, and Disabled lists that are present by default in the Alarms.db).

Note: Changing the Lists variable makes it necessary for you to delete the Alarms.log and Alarms.db files from your application directory.

Note: Unlike the KeyCount, KeyName, FilterCount, and FilterName variables, the position of the Lists variable under the [ALARM_MANAGER] section is inconsequential.

Default: Lists = 0

FilterCount Indicates the number of filterable keys that you wish to be displayed in the Alarm Filtering dialog ( see "VTS Developer's Guide: Filter Dialog Button").

Note: The FilterCount variable must be defined before any FilterName variables. Any FilterName variables found before the FilterCount variables are ignored.

Default: FilterCount = 5

FilterName Used to define the fields displayed in the Alarm Filtering dialog (see "VTS Developer's Guide: Filter Dialog Button").

The syntax is as follows:

FilterName = <Position>, <Field>, 0, <Description>

Where:

      Position is the position of this filtering item in the Alarm Filtering dialog, starting at 0 (from top to bottom in the list of filterable fields).

      Field is the field number assigned to this filtering item (starting at 1).

      0 must be entered as the fourth parameter.

      Description is the description of this filtering item to be displayed in the Alarm Filtering dialog

Default: 

FilterName = 0, 1, 0, Message for the alarm

FilterName = 1, 2, 0, Priority

FilterName = 2, 3, 0, Type of alarm

FilterName = 3, 4, 0, Operator name

FilterName = 4, 5, 0, Area