The FilterField module enables you to draw a button that filters the alarm list by a specified criterion when clicked. FilterField takes the following parameters:
\AlarmPanel\FilterField(Name, ButtonLabel, PostitLabel, FieldNumber, FieldValue)
Name is the name of the DrawList variable that holds the panel information (see the Name parameter in Displaying an Alarm List – DrawList Module).
ButtonLabel is the text label to display on the button.
PostitLabel is the text to display on the tool tip that appears when the mouse is rested over the button.
FieldNumber is the number of the field in the alarm database on which to do the filtering.
1: Message: The Message database field contains a message identifying each alarm, based on the Description property of each alarm tag. If the Description property has not been provided for an alarm tag, the Message field then contains the name of the alarm tag, as derived from the alarm tag's Name property.
2: Priority: The Priority database field contains a number indicating the priority of each alarm. Alarm priority is based on the alarm priority tag with which each alarm tag is associated.
3: Type: The Type database field contains the type for each alarm. By default, all system alarms in VTS (security, modem, operator logging, and report-related alarms) contain a type of "1000". VTS Programmers who are familiar with the VTS scripting language can specify their own type values for custom alarm tags, and can use the Type field to filter them.
4: Operator: The Operator database field contains the name of the operator related to each alarm or event. For example, when an operator logs on to the system, the security-related event identifies the username of the operator who has logged on. When an alarm is acknowledged, the username of the operator who acknowledged the alarm is identified.
5: Area: The Area database field contains the area for each alarm or event, based on the Area property of each alarm tag. Those events that are related to security occurrences have a default area of "Security".
FieldValue is the value to use for the comparison. Enter a single, valid criterion by which you wish to filter the alarm list (according to the specified alarm database field identified using the FieldNumber parameter). For example, if you've chosen to filter the alarm list by operator username by entering a value of 4 for the FieldNumber parameter, enter the username of the operator for the FieldValue parameter.
Note: VTS includes a built-in tool for drawing a button to acknowledge all unacknowledged alarms without requiring you to alter any code. Information on the Alarm Tools library can be found in "VTS Developer's Guide: Alarm Tools Library". Information specific to the Alarm List tool that enables you to draw such a button on a application page can be found in "VTS Developer's Guide: Ack All Button Alarm Library Tool".