38 almwin(Acs)

Name

almwin: A a Tk/Tcl script to provide Graphical User Interface (GUI) to the Alarm Window configuration file "almwin.cfg".

Syntax

almwin.tcl

Arguments

none

Description

A Graphical User Interface (GUI) to edit the contents of the Alarm Window configuration file ("almwin.cfg").

The almwin.tcl script allows the user to edit the contents of the alarm window configuration with a Graphical User Interface instead of editing the configuration file with a text editor. The "almwin.cfg" file describes the alarm zone windows displayed by ithe AccessPoint Console ("acsterm"). This tk/tcl script allows the user to create, modify and delete alarm zone windows, and preview them onscreen before saving the configuration.

The "almwin.cfg" file is used to define a user's presentation and grouping (zones) of alarms.

There are twenty-two (22) "colon delimited" (:) fields per line (one line per Alarm Window) that the user may specify either manually with an editor (like "vi") or graphicly with the "almwin.tcl" GUI interface.

Configuration File

The number of Alarm Windows per console session, tagname or description display options, display location, and many other options are controlled by an Alarm Window Configuration File named "almwin.cfg". There is an entry in the "dbmap" file to indicate where the "almwin.cfg" file is located:

almwin:/u/acsadm/Data/almwin.cfg

The default location is in the "$ACSHOME/Data" directory.

The format of the "almwin.cfg: file is:

t:x:y:tufg:tubg:tafg:tabg:wfg:wbg:n|f|N|F:n|l|m:

   n|v|h:summ:disp:row:col:t|d|b:Y|N:A|U:Y|N:Y|N:

   gs|ALL

Where the "coded characters" represent twenty-two (22) "colon delimited" (:) fields in single line records (one line per Alarm Window) to configure multiple Alarm Windows for the user's Console. The "vertical bar" (|) indicates that only one of the "coded characters" may be chosen for the field. A line that begins with a "pound sign" (#) is ignored and treated as a comment.

Configuration Fields

The fields for each line (for each configured Alarm Window) are as follows:

(field 1) t:

Replace the "t" with an alphanumeric text string of up to 32 characters to represent the "title" or "label" of the Alarm Window.

(field 2) x:

Replace the "x" with the CRT absolute coordinate (in pixels) in the "X" direction (left to right) for the upper left corner of the Alarm Window.

(field 3) y:

Replace the "y" with the CRT absolute coordinate (in pixels) in the "Y" direction (top to bottom) for the upper left corner of the Alarm Window.

(field 4) tufg:

Replace the "tufg" with the Foreground color index (0-31) for Tag Name or Description or Tag Name and Description of the Unacknowledged point in alarm.

(field 5) tubg:

Replace the "tubg" with the Background color index (0-31) for Tag Name or Description or Tag Name and Description of the Unacknowledged point in alarm.

(field 6) tafg:

Replace the "tafg" with the Foreground color index (0-31) for Tag Name or Description or Tag Name and Description of the Acknowledged point in alarm.

(field 7) tabg:

Replace the "tabg" with the Background color index (0-31) for Tag Name or Description or Tag Name and Description of the Acknowledged point in alarm.

(field 8) wfg:

Replace the "wfg" with the Foreground color index (0-31) for the Alarm Window label and the Alarm Window command pushbuttons.

(field 9) wbg:

Replace the "wbg" with the Background color index (0-31) for the Alarm Window label and the Alarm Window command pushbuttons.

(field 10) n|f|F|N:

Choice of one of the four (4) literal codes to effect the Alarm Window frame, defined as follows:

f:: Do provide a frame for the window and do allow the window to be "Lowered" under other windows.
n:: Do not provide a frame for the window but do allow the window to be "Lowered" under other windows.
(Note: An Alarm Window without a frame cannot be moved).
F:: Do provide a frame for the window but do not allow the window to be "Lowered" under other windows. Force the window to be "Raised" above all other windows.
N:: Do not provide a frame for the window but do not allow the window to be "Lowered" under other windows. Force the window to be "Raised" above all other windows.
(Note: An Alarm Window without a frame cannot be moved).

(field 11) n|l|m:

Choice of one of the three (3) literal codes to effect the Alarm Window title bar for movement, defined as follows:

m:: Do provide a title bar to allow the user to move the Alarm Window.
l:: Do provide a label for the Alarm Window but do not allow the user to move the Alarm Window.
n:: Do not label the Alarm Window and do not allow the user to move the Alarm Window.

(field 12) n|v|h:

Choice of one of the three (3) literal codes to effect the Alarm Window command pushbuttons, defined as follows:

n:: Do not provide the Alarm Window command pushbuttons.
v:: Do provide the Alarm Window with Command pushbuttons, arranged in a vertical manner.
h:: Do provide the Alarm Window with Command pushbuttons, arranged in a horizontal manner.

(field 13) summ:

Replace the "summ" with the base Name (without the ".acn" extension) and Path from the "Screens" directory of screen to called as a New Window (or as a Go To in the Console's main window, per "field 21" setting) from Summary command pushbutton in the Alarm Window. Up to 127 character are allowed in this field.

A blank space in this field is valid and will cause the Summary command pushbutton to be omitted from the Alarm Window (even if pushbuttons are enabled).

(field 14) disp:

Replace the "disp" with the base Name (without the ".acn" extension) and Path from the "Screens" directory of screen to called as a New Window (or as a Go To in the Console's main window, per "field 21" setting) from Display command pushbutton in the Alarm Window. Up to 127 character are allowed in this field.

A blank space in this field is valid and will cause the Display command pushbutton to be omitted from the Alarm Window (even if pushbuttons are enabled).

(field 15) row:

Replace the "row" with the number of rows of tag names, descriptions or tag/descriptions to be displayed in the Alarm Window.

(field 16) col:

Replace the "col" with the number of columns of tag names, descriptions or tag/descriptions to be displayed in the Alarm Window.

(field 17) t|d|b:

Choice of one of the three literal codes to effect the display of the points in alarm in the Alarm Window, defined as follows:

t:: Display 16 character tagname.
d:: Display 32 character description.
b:: Display 49 character tagname, space and description (16 + 1 + 32 = 49).

(field 18) Y|N:

Choice of one of either literal code Y or N to effect whether the Alarm Window will be closed when empty, defined as follows:

Y:: Do close the Alarm Window when no alarms are present.
N:: Do not close the Alarm Window when no alarms are present.

(field 19) A|U:

Choice of one of either literal code A or U to effect whether the Alarm Window will display both Acknowledged and Unacknowledged points in alarm or just Unacknowledged points in alarm, defined as follows:

A:: Display All points in alarm: both Acknowledged and Unacknowledged.
U:: Display only Unacknowledged alarms in the Alarm Window.

(field 20) Y|N:

Choice of one of either literal code Y or N to effect whether the Alarm Window will produce an audible alarm, defined as follows:

Y:: Do produce an audible alarm when Unacknowledged alarms are present in the the ALarm Zone Window.
N:: Do not produce an audible alarm when Unacknowledged alarms are present in the the ALarm Zone Window.

(field 21) Y|N:

Choice of one of either literal code Y or N to effect whether the Alarm Window will cause a New Window to be displayed or will cause a Go To in the Console's Main Window to be effected, defined as follows:

Y:: Use Console's Main Window, i.e. Go To.
N:: Use a New Window.

(field 22) gs|ALL:

Choice of one of either the Group Specification number or the literal code ALL to effect the group of alarm points (ZONE) to be reported in the Alarm Window, defined as follows:

gs:: Replace the "gs" with the member number of the Group Specification (GS) that contains the list of points to be monitored and reported in this Alarm Window.
ALL:: Literal "ALL" to indicate that all points are to be monitored and reported in this Alarm Window.

See Also

acsterm(Acs), Configuration User's Guide