® B0193AU

REV H

I/A Series®
Process Alarm Configuration
October 15, 1999
Foxboro and I/A Series are registered trademarks of The Foxboro Company.
Intel is a trademark of Intel Corporation.
SunOS and Solaris are trademarks of Sun Microsystems, Inc.
UNIX is a registered trademark of X/Open Company Limited.
VENIX is a trademark of VenturCom, Inc.

Copyright 1989-1999 by The Foxboro Company

All rights reserved

SOFTWARE LICENSE AND COPYRIGHT INFORMATION

Before using the Foxboro supplied software supported by this Foxboro documentation, you
should read and understand the following information concerning copyrighted software.
1. The license provisions in the Foxboro Software License for your system govern
your obligations and usage rights to the software described in this documentation.
If any portion of those license provisions is violated, The Foxboro Company will
no longer provide you with support services and assumes no further responsibili-
ties for your system or its operation.
2. All software issued by The Foxboro Company, and copies of the software that you
are specifically permitted to make, are protected in accordance with Federal copy-
right laws. It is illegal to make copies of any software media provided to you by
The Foxboro Company for any purpose other than those purposes mentioned in
the Foxboro Software License.
Contents
Figures............................................................................................................................. vii

Preface.............................................................................................................................. ix
Revision Information .......................................................................................................... x

1. Alarm Configuration Overview ................................................................................... 1

Process Alarm Notification .................................................................................................. 3
System Alarm Notification .................................................................................................. 3

2. Annunciator Configuration ......................................................................................... 5

Annunciator and Annunciator/Numeric Keyboard Information ......................................... 5
Annunciator Keyboard Number Layout ......................................................................... 5
Annunciator/Numeric Keyboard Number Layout .......................................................... 6
Modular Keyboard Information .......................................................................................... 6
Modular Annunciator Keyboard Layout .............................................................................. 7
Annunciator Configuration Via Numbered Location .......................................................... 7
Accessing the Process Alarm Configurators for WP20, WP30, and PW Configuration ....... 9
Alarm Table Configuration for WP20, WP30, and PW .................................................... 10
Alarm Table Size .......................................................................................................... 11
Action Pull-Down Menu .............................................................................................. 12
Adding an Entry to the Annunciator Table .............................................................. 12
Deleting an Entry .................................................................................................... 16
Modifying an Entry ................................................................................................. 17
Saving Alarm Table Changes ................................................................................... 18
Exiting the Alarm Table Configurator ..................................................................... 19
Closing the Action Pull-Down Menu ...................................................................... 19
Alarm Panel Configuration for WP20, WP30, and PW .................................................... 19
Action Pull-Down Menu .............................................................................................. 20
Loading an Annunciator Panel ................................................................................. 21
Changing an Entry ................................................................................................... 23
Deleting an Entry .................................................................................................... 26
Saving Annunciator Panel Changes .......................................................................... 27
Exiting the Alarm Panel Configurator ...................................................................... 27
Closing the Action Pull-Down Menu ...................................................................... 28
Alarm Table Configuration for Model 50 Workstations .................................................... 28
Alarm Panel Configuration for Model 50 Workstations .................................................... 29

iii
B0193AU – Rev H Contents

Annunciator Key Direction to Display Managers ......................................................... 31

Run-Time Annunciator Key Display Redirection .............................................................. 33
Transferring Configured AAtab and AApan Files to the Appropriate Workstations ........... 34
WP20/WP30/PW Files to WP20/WP30/PWs ............................................................. 34
WP20/WP30/PW Files to Model 50 Workstations ...................................................... 36

3. Alarm Displays .......................................................................................................... 39

Display Operation ............................................................................................................. 39
Remote Alarm History Access from Model 50 Workstations ............................................. 40

4. Current Alarm Display Configuration....................................................................... 43

Configuring CAD Options for the WP20, WP30, and PW .............................................. 44
Number of Alarms Per Page ......................................................................................... 45
Number of Seconds Between Screen Refresh ................................................................ 45
Alarm Tag Colors ......................................................................................................... 46
Sort Option .................................................................................................................. 47
CLR ALM Soft Key ...................................................................................................... 47
Return-To-Normal Configuration ................................................................................ 48
Configuring CAD Options for the Model 50 Workstation ............................................... 49
Number of Alarms Per Page ......................................................................................... 50
Number of Seconds Between Screen Refresh ................................................................ 50
Alarm Tag Colors ......................................................................................................... 51
Sort Option .................................................................................................................. 52
CLR ALM Soft Key ...................................................................................................... 52
Return-To-Normal Configuration ................................................................................ 52
Horn Silence ................................................................................................................ 52
Resound Horn .............................................................................................................. 53
Alarm Text String Update Options .............................................................................. 53
Alarm Message Types Saved ......................................................................................... 54
Using the Alternate CAD Soft Keys for Redirection Override ........................................... 55
Configuring an Alarm History Display Soft Key for Redirection Override ........................ 56

5. Alarm Text and Format Configuration for CAD ....................................................... 59

CAD Template Display Files ............................................................................................ 60
Modifying the Alarm Format File ..................................................................................... 61
How Display Manager Processes the CAD ................................................................... 63
Alarm Text Field Types and ID Numbers .................................................................... 64
Examples of Alarm Format Files ................................................................................... 64

iv
Contents B0193AU – Rev H

6. Alarm Horn Configuration........................................................................................ 69

7. Common Alarm Group Configuration ...................................................................... 73

Configuring and Installing the File for CAGs .................................................................... 73
Common Horn Silence ..................................................................................................... 75
Alarm Recovery from a Backup Workstation .................................................................... 76
Display Redirection ........................................................................................................... 76

Appendix A. File Conversion Information..................................................................... 79

50 Series File Conversion Information .............................................................................. 79
Alarm Table Configuration Files .................................................................................. 79
Alarm Panel Configuration Files ................................................................................... 80
WP20/WP30/PW File Conversion Information ............................................................... 81
Alarm Table Configuration Files .................................................................................. 81
Alarm Panel Configuration Files ................................................................................... 82
Horn Configuration File ................................................................................................... 83

Index .............................................................................................................................. 85

v
B0193AU – Rev H Contents

vi
Figures
Accessing the Alarm Table or the Alarm Panel Configuration ................................................. 10
Alarm Table Unconfigured ..................................................................................................... 11
Alarm Table Pull-Down Action Menu .................................................................................... 13
Alarm Table Add Dialog Box .................................................................................................. 14
Alarm Table with Compound Directory Listing ...................................................................... 14
Alarm Table with Block Directory Listing ............................................................................... 15
Alarm Table with Configured Entry ........................................................................................ 16
Alarm Table with Selected Key and Pull-Down Action Menu ................................................. 17
Alarm Table with Modify Box ................................................................................................ 18
Unconfigured Annunciator Panel Table .................................................................................. 20
Annunciator Panel Pull-Down Action Menu .......................................................................... 21
Annunciator Panel Pull-Down Menu ...................................................................................... 22
Annunciator Panel Partially Configured .................................................................................. 22
Annunciator Panel with Add Function Dialog Box ................................................................. 23
Annunciator Panel with Display Listing Directory .................................................................. 24
Annunciator Panel with Program Listing Directory ................................................................. 26
Annunciator Panel with Action Menu Displayed .................................................................... 27
Customized Current Alarm Display ........................................................................................ 59

vii
B0193AU – Rev H Figures

viii
Preface
This document describes each of the process alarm configuration options associated with the
Alarm Alert subsystem and discusses the use of annunciator keyboards for non-50 Series sta-
tions. The information related to 50 Series stations with the Solaris operating system is
addressed in the Workstation Alarm Management (B0193RV) document.
The document is intended to be used by process control engineers. You must have an under-
standing of the process as well as knowledge of both the configured control database and the
process alarm requirements. You should be familiar with the following documents:
♦ Integrated Control Software Concepts (B0193AW)
♦ Integrated Control Configurator (B0193AV)
♦ Process Operations and Displays (B0193MM)
♦ System Operations Guide (B0193CR)
♦ Workstation Alarm Management (B0193RV)
The following abbreviations are used in this document:

AA Alarm Alert Subsystem

AHD Alarm History Display
APC Alarm Panel Configurator
AST Alarm Server Task
ATC Alarm Table Configurator
CAD Current Alarm Display
CAG Common Alarm Group
DM Display Manager
LED Light-Emitting Diode
RAD Recent Alarm Display (WP10 only)

When the term workstation is used it applies to the following workstations unless otherwise
stated: WP10, WP20, WP30, AW50, WP50, and PW workstations.

NOTE
50 Series workstations supporting the SunOS operating system are addressed in
this document.

ix
B0193AU – Rev H Preface

Revision Information
For Release 6.2.1, summaries were added to the beginning of each chapter.

x
1. Alarm Configuration Overview
This chapter gives a general overview of process and system alarms.
There are two basic types of alarms for I/A Series systems: process alarms which indicate prob-
lem or alarm conditions in the control process, and system alarms which indicate problems
related to system health. Devices used to indicate alarm conditions include annunciator pan-
els with annunciator lights (LEDs) and annunciator keyboards. The Sys field that appears in
the top menu bar of any environment indicates system alarms by changing color and/or blink-
ing. Annunciator keyboard horns, console horns, and horns that are external to I/A Series
equipment are also used for audible notification of alarm conditions. Software subsystems
exist that handle system activities relating to alarms. Configurable options are available and
allow you to customize your alarm indications and responses.
In systems with Model 51 stations, there can be multiple Display Managers (DMs) and Alarm
Managers (AMs) as well as dual CRTs (multi-head) on a single workstation. Workstations
with two CRTs can support double the number of annunciator keyboards and two console
horns. For information regarding alarming on Model 51 stations (AW51/WP51), refer to the
Workstation Alarm Management (B0193RV) document.
The workstation’s Alarm Alert subsystem (AA) operates with the following configuration for
alarm notification:
♦ During the configuration of a process control scheme using the Integrated Control
Configurator, you define block and compound information such as process limits,
alarm indicators, priority levels of alarm, alarm criticality as well as the device
groups (printers, historians, and workstations) to receive process alarm notifica-
tion. The Alarm field in the environment menu bar is affected by process alarm
notification.
♦ When System Monitor software is selected during System Configuration, you
indicate the devices (workstations, historians, printers, and so forth.) to receive sys-
tem alarm notification, in addition to the stations to be monitored. The Sys field
in the environment menu bar is affected by system alarm notification.
The AA subsystem also includes the following optional process alarm configuration features
for customizing alarm notification and the handling of alarm conditions:
♦ Alarm Table Configuration (ATC) allows you to assign a block or blocks to each
annunciator light (LED) on an annunciator panel. When a configured block goes
into alarm, the annunciator light associated with the block(s) assigned to the
annunciator key is lit.
♦ Alarm Panel Configuration (APC) allows you to assign user-defined displays, Dis-
play Manager Commands, and/or programs to annunciator keys. When the key is
selected, the assigned display appears, the command is executed, and/or the pro-
gram is run.
♦ Current Alarm Display configuration allows you to configure the following CAD
elements for workstations (except WP10) in the I/A Series network:
♦ The number of alarms on each CAD page for individual workstations.

1
B0193AU – Rev H 1. Alarm Configuration Overview

♦ The number of seconds between screen refresh for individual workstations.

♦ The color of the alarm tag (for example, HIABS) based on the priority of the
alarm and the color of the alarm tag when the alarm is unacknowledged.
♦ The type of sort on CAD for all workstations hosted by a given AP, and for all
DMs for a specified workstation.
♦ The handling of return-to-normal alarm messages on the CAD and the associ-
ated annunciator light.
♦ The function of the Clear Alarm (CLR ALM) soft key on the CAD in terms of
clearing an alarm on the CAD and acknowledging the block from the annun-
ciator light.
♦ For Model 50 workstations, the following additional options are available:
♦ The handling of horn silencing manually or in terms of the status of the
blocks.
♦ The saving of alarm text for use in a process display based on alarm priority
and on alarm message types (in-alarm or both in-alarm and return-to-
normal).
♦ Setting the annunciator LED to go on or to blink via a built-in command.
♦ Current Alarm Display template file and alarm format file (WP30 and WP/AW50
stations) alterations allow you to customize the fields that appear on the CAD –
the location of the fields and the text that appears in each field. You can also have
CAD redirection on a per Display Manager basis.
♦ The horn configuration file allows you to assign a horn to be sounded depending
on the type of alarm (system alarm or process alarm) and, if a process alarm, the
priority level of that alarm (1 to 5). The number and types of horns available are:
♦ Two annunciator keyboard horns
♦ One console horn
♦ Six external horns
♦ A configuration file for Common Alarm Groups (CAG) allows you to configure
one or more of the following options:
♦ Each workstation in the system as part of a logical group of WPs independent
of its host. A workstation can be a member of up to two CAGs.
♦ A backup WP to supply the alarm list and annunciator lights to the WP if the
WP is rebooted.
♦ The Display Managers to which you wish to redirect the displays accessible
from the CAD: Block Detail Display, Top Priority Display, and User Display.
Refer to the following documents for additional information:
♦ Integrated Control Configurator (B0193AV) document and Online Help for com-
plete information on configuring a process control scheme with alarming.
♦ Process Operations and Displays (B0193MM) for a complete explanation of Alarm
Displays and operator actions related to process alarms and system alarms.

2
1. Alarm Configuration Overview B0193AU – Rev H

♦ System Management Displays (B0193JC) Online Help for additional information

regarding system alarms.
♦ Workstation Alarm Management (B0193RV) document and Online Help for alarm
configuration information regarding 50 Series workstations.

Process Alarm Notification

When alarm information is sent to a workstation, the operator is notified as follows:
♦ The Alarm field in the top menu bar of any environment on designated worksta-
tions changes as follows:
♦ Blinking red indicates at least one unacknowledged alarm in the workstation
alarm list (dynamic AA database).
♦ Solid red indicates at least one acknowledged alarm in the workstation alarm
list.
♦ Blinking normal indicates at least one alarm has returned-to-normal but
remains unacknowledged.
♦ Solid normal indicates there are no alarms in the workstation’s alarm list.
♦ If the block in alarm is associated with an annunciator light, the light blinks.
♦ A horn or horns sound depending on the information in the horn configuration
file. (On a WP10, an annunciator horn is sounded when there is a Priority 1 or
Priority 2 alarm independent of the alarm table and alarm panel configurations.)
♦ The alarm status is updated on the faceplate of the Block Detail Display and
Group Displays.
♦ If configured, the alarm status is updated on user graphics indicating alarm
conditions.
♦ Alarm displays such as the Recent Alarm Display (RAD) on a WP10 and the Cur-
rent Alarm Display (CAD) on the other workstations indicate the alarm message.
♦ On a 50 Series station, a process display with the ALMTXT string variable embed-
ded can indicate an alarm message each time the ALMCNT variable is updated.
♦ Designated printers and historians receive the alarm message.
Refer to the Process Operations and Displays (B0193MM) document for information regarding
acknowledging alarms and silencing horns.

System Alarm Notification

When a system alarm related to the health of I/A Series equipment is received, the following
occurs:
♦ The Sys field in the top menu bar of any environment on designated workstations
changes as follows:
♦ Blinking red indicates there is at least one unacknowledged equipment failure.
♦ Solid red indicates there is at least one acknowledged equipment failure.

Process Alarm Notification 3

B0193AU – Rev H 1. Alarm Configuration Overview

♦ Blinking normal indicates there are no current equipment failures but a previ-
ous failure remains unacknowledged.
♦ Solid normal indicates there are no system equipment failures.
♦ Designated printers and historians receive the alarm message.
Refer to the Process Operations and Displays (B0193MM) and the System Management Displays
(B0193JC) documents for information regarding acknowledging system alarms and silencing
system horns.

4
2. Annunciator Configuration
This chapter covers annunciator, annunciator/numeric, and modular keyboards,
alarm table and panel configurations and the functions available from their
menus; and procedures for making file transfers.
Workstation processors can have two different types of annunciator keyboard configurations:
♦ A maximum of two keyboards which can be either annunciator keyboards, annun-
ciator/numeric keyboards, or one of each.
♦ A maximum of two modular keyboards, which can contain either annunciator
panels or annunciator and numeric keyboard panels.

NOTE
Modular keyboards are no longer available, but are supported.

Annunciator and Annunciator/Numeric Keyboard

Information
Each of the keyboards described below contains annunciator lights/keys, a horn silence but-
ton, and a lamp-test button:
♦ The annunciator keyboard consists of an array of 48 light/switch pairs arranged in
a 12-column by four-row matrix.
♦ The annunciator/numeric keyboard consists of 32 light/switch pairs arranged in
an eight-column by four-row matrix, a 16-key numeric keypad for entering
numeric data, and one NUM LOCK light.
The keyboard module identification code corresponds to a letterbug assignment and is indi-
cated by the settings of dip switches (2 to 8) located in the rear of the keyboard housing. The
first dip switch (1) is used to toggle the volume of the annunciator horn between high and low
volume.

Annunciator Keyboard Number Layout

The lights/keys on an annunciator keyboard are numbered as follows:

5
B0193AU – Rev H 2. Annunciator Configuration

4 8 12 16 4 8 12 16 4 8 12 16

3 7 11 15 3 7 11 15 3 7 11 15

2 6 10 14 2 6 10 14 2 6 10 14

1 5 9 13 1 5 9 13 1 5 9 13

Silence Lamp
Horn Test

PANEL 1 PANEL 2 PANEL 3

Annunciator/Numeric Keyboard Number Layout

The lights/keys on an annunciator/numeric keyboard are numbered as follows:

8 7 6 5 4 4 8 12 16 4 8 12 16

3 2 1 16 15 3 7 11 15 3 7 11 15

14 13 12 2 6 10 14 2 6 10 14
9
11 10 1 5 9 13 1 5 9 13
Silence Lamp
Horn Test

PANEL 1 PANEL 2 PANEL 3

(Numeric Keys)

NOTE
For comparison to the modular keyboard, the annunciator and annuncia-
tor/numeric keyboards are shown as divided into three panels.

Modular Keyboard Information

Each workstation processor can have a maximum of two modular keyboards with up to three
panels each for a total of six annunciator panels. The lights (LEDs) on the panels and the
annunciator horn can indicate alarm conditions. Alternately, a numeric keypad can be used in
any of the three panel locations in a modular keyboard.
Each panel contains sixteen annunciator lights/keys for a maximum of ninety-six annunciator
lights and panel keys. Each modular keyboard also includes a red ACK button on the left side
to silence (turn off) the WP horns.

6
2. Annunciator Configuration B0193AU – Rev H

Modular Annunciator Keyboard Layout

The lights/keys on a modular keyboard are numbered as follows:

08 16 08 16 08 16

07 15 07 15 07 15

06 14 06 14 06 14

05 13 05 13 05 13

04 12 04 12 04 12

03 11 03 11 03 11

02 10 02 10 02 10
ACK
01 09 01 09 01 09
PANEL 1 PANEL 2 PANEL 3

Annunciator Configuration Via Numbered Location

Annunciator lights/keys are grouped into three numbered sections or panel locations within
the keyboard. The following table indicates the panel/section numbers associated with a sys-
tem that has two keyboards. In systems with four keyboards, there are designations for
12 panels.

Keyboard 1 Panel 1 Panel 2 Panel 3

Keyboard 2 Panel 4 Panel 5 Panel 6

The annunciator/numeric keyboard has the numeric keypad fixed in the first panel unlike the
modular keyboard where the numeric keypad can be located in any one of three panels. If the
numeric keypad was in Panel 1 on the modular keyboard and you wish to use an annuncia-
tor/numeric keyboard, no changes need to be made to the existing Alarm Table and Alarm
Panel Configuration files.
However, if a numeric keypad was in Panel 2 or 3 (5 or 6) on the modular keyboard and an
Alarm Panel/Table assignment was in Position 1 and/or Position 4 of the modular keyboard,
the existing files must be changed as follows:

New Keyboard Alarm Panel Old Keyboard Alarm Panel

Number Assignment Number Assignment
1 2 or 3
4 5 or 6

Modular Annunciator Keyboard Layout 7

B0193AU – Rev H 2. Annunciator Configuration

Refer to your system configuration printout to determine which identification code (annunci-
ator keyboard) or letterbug (modular keyboard) represents Keyboard 1, and which represents
Keyboard 2. The identification code is located in the rear housing and the letterbug is located
near the cable connections at the back of the keyboard.
Either or both the Alarm Table Configurator and the Alarm Panel Configurator can be
optionally used to configure each annunciator panel or position of lights and keys. When
both process alarm configurators are used, the following three functions are provided:
1. The association of a block or blocks with an annunciator panel light (LED) for
alarm notification via lights.
2. The association of a user-defined display and/or program with each annunciator
key for access to a specific display and/or program at any time. Typically, you
would access the display or program when a block or blocks goes into alarm.
3. The association of user-defined displays with the following Alarm Display soft
keys: LATEST ALARM on the Recent Alarm Display (WP10 only), TOP PRIO,
and USER DISP on the Current Alarm Display and the TOP PRIO on the Alarm
History Display.
With the Alarm Table Configurator, you can assign compound and block names to individual
annunciator lights. These block assignments activate the appropriate annunciator panel lights
when individual blocks go into alarm. Alarm conditions are also shown on the Alarm Dis-
plays, and can be indicated on user-defined displays. All of the following block conditions
affect the state of the annunciator light to which a block or blocks are assigned:
♦ A block alarm condition
♦ A block disabled condition
♦ A block return-to-normal condition
♦ A block unacknowledged/acknowledged condition
When a block is in alarm the annunciator light (LED) can be in one of three states:
1. Blinking, which indicates one or more blocks associated with the annunciator key
are currently unacknowledged. The alarm(s) may or may not currently exist.
2. Solid, which indicates all block alarms associated with the annunciator key have
been acknowledged; however, one or more are still unresolved (all blocks have not
returned to normal).
3. Off, which indicates all blocks associated with the annunciator key are no longer
in alarm and have all been acknowledged.

NOTE
The annun built-in command supports application usage for turning the
annunciator key on or flashing the annunciator key. See the Display Manager
Calls (B0193DF) document.

A disabled block, the configured block return-to-normal condition, and alarms being inhib-
ited also affect the state of the annunciator lights as indicated in the following paragraphs.

8
2. Annunciator Configuration B0193AU – Rev H

A block or blocks currently in alarm can become disabled. This block disable state may be due
to the compound containing blocks being turned off (ON to OFF) or the block changing
from an automatic state to a manual state (AUTO to MAN) provided the block is not config-
ured with the MANALM option.
If the block has an outstanding alarm(s) when it becomes disabled, the annunciator light is
automatically extinquished (as of Release 4.0).
Depending on the return-to-normal configuration (RTN_DROP), when a return-to-normal
condition occurs in the block, the annunciator light responds in one of the following ways:
♦ The annunciator light associated with the block continues to blink until the previ-
ous alarm condition of the block has been acknowledged. An acknowledged
return-to-normal condition causes the annunciator light to go from blinking to off
(this is the default configuration).
♦ The annunciator light associated with the block is automatically extinguished
regardless of the block acknowledgment state.
Depending on the configuration of the Clear Alarm (CLR ALM) soft key on the Current
Alarm Display, when a block alarm is cleared, the annunciator light responds in one of the fol-
lowing ways:
♦ The annunciator light associated with the selected block in alarm is not affected by
the selection of the CLR ALM soft key.
♦ The annunciator light associated with the selected block is automatically extin-
guished when the CLR ALM soft key is selected and the block is acknowledged.
When an annunciator key (unconfigured by APC) associated with an annunciator light (con-
figured by ATC) is pressed, a Block Detail Display appears. It is the Block Detail Display of
the latest block-in-alarm on a WP10 or the highest priority alarm condition for that light that
appears in the CAD.
With the Alarm Panel Configurator you can configure each annunciator key to present a spe-
cific user-defined display for direct access and/or run a user program when pressed. Config-
ured commands can also be executed by Display Manager when the associated annunciator
key is pressed.
The configuration of the Alarm Table and the Alarm Panel provides an association between a
block and a specified display or program. Using the Alarm Display soft keys, you can then
access the display associated with the block in alarm.

Accessing the Process Alarm Configurators for WP20,

WP30, and PW Configuration
The Alarm Table Configurator and the Alarm Panel Configurator are both located in the Pro-
cess Engineer’s Environment. To access either of the Process Alarm Configurators, use the fol-
lowing steps:
1. Select the Sys key from the top menu bar to display the Sys pull-down menu. See
Figure 2-1.
2. From the System pull-down menu, select Change_Env to display a list of
environments.

Accessing the Process Alarm Configurators for WP20, WP30, and PW Configuration 9
B0193AU – Rev H 2. Annunciator Configuration

3. Select Proc_Eng_Env to enter the Process Engineer’s Environment. Enter the

password, if required.
4. Select Config from the top menu of the process engineer’s environment. The Con-
figurator pull-down menu appears.
5. The Alarm Table Configurator and the Alarm Panel Configurator are listed with
all of the configurators. Select the desired process alarm configurator.

NOTE
1. The Alarm Table and Alarm Panel Configurators for the WP20, WP30, and
PW are unavailable on 50 Series workstations. The configuration files for these
workstations are ASCII files that can be created by either a text editor or by
transferring and converting configuration files created on a WP20, WP30, or
PW. Both methods are explained in subsequent sections.
2. Alternately, the Annunciator Configurator on a Model 51 station (as of
Release 4.2) can be used to create these configuration files for a Model 50 work-
station. See the Workstation Alarm Management (B0193RV) document for infor-
mation on the Annunciator Configurator.

Figure 2-1. Accessing the Alarm Table or the Alarm Panel Configuration

Alarm Table Configuration for WP20, WP30, and PW

The Alarm Table Configurator links individual blocks to annunciator lights. When the block
goes into alarm, the light associated with the annunciator key blinks to indicate an alarm. A

10
2. Annunciator Configuration B0193AU – Rev H

block can be assigned to only one light on a given workstation; however, there can be more
than one block assigned to the same light.

NOTE
Alternately, the Alarm Table can be created via a text editor in ASCII format and
converted to the Intel binary format. Refer to Appendix A “File Conversion
Information” for the conversion utilities for WP20, WP30, and PW stations.

Selection of the AlarmTable_Cfg from the Config pull-down menu in the Process Engineer’s
Environment displays the current Alarm Action Table. This table contains the currently con-
figured list of compound/block names and the annunciator panel and light associated with
each. If there is no configuration available, the table is blank.
The top menu bar (Figure 2-2) consists of the following selection fields:
Help – Used to access help information related to the Alarm Table Configurator.
Action – Used to access a pull-down menu of configurator functions.

Figure 2-2. Alarm Table Unconfigured

Alarm Table Size

The size of the Alarm Table is dependent on the workstation for which it is configured as indi-
cated below:

Alarm Table Configuration for WP20, WP30, and PW 11

B0193AU – Rev H 2. Annunciator Configuration

Alarm Table
Workstation Block Entries
WP10 100
WP20, WP30 500
WP50, AW50 2000

NOTE
1. Although PWs do not support annunciator panels, configuring the alarm
table and alarm panel information allows you to access the desired display
related to the block in alarm directly from the Current Alarm Display and the
Alarm History Display.
2. The table for a 50 Series workstation can be created on a WP20 or WP30 but
is limited to 500 entries. Moving the file to the 50 Series workstation, convert-
ing the file for 50 Series workstation use, and adding entries to the file via a text
editor allow you to have an alarm table of 2000 entries. See “Alarm Table Con-
figuration for Model 50 Workstations” on page 28 and “Run-Time Annunciator
Key Display Redirection” on page 33. Alternately, the Annunciator Configura-
tor on a Model 51 workstation as of Release 4.2 can be used to configure files for
Model 50 workstations.
3. The conversion tool on the 50 Series workstation is
/usr/fox/wp/bin/tools/cvtalmtbl. For conversion information, refer to “Run-
Time Annunciator Key Display Redirection” on page 33 and to the Appendix A
“File Conversion Information”.

Action Pull-Down Menu

Select the Action field on the top menu bar to access the Action pull-down menu. This menu
lists all of the configurator functions. Initially, only the Add, Save, and Exit functions are
selectable. See Figure 2-3.
The following sections explain each of the functions in the Action pull-down menu.

Adding an Entry to the Annunciator Table

Select Add to add entries to the Alarm Action Table. The following fields must be completed
to link a block to an annunciator light: compound name, block name, annunciator panel, and
annunciator light. Refer to the “Dialog Box Commands” section of the System Operations
Guide (B0193CR) for more information on dialog box actions.

12
2. Annunciator Configuration B0193AU – Rev H

Figure 2-3. Alarm Table Pull-Down Action Menu

The procedure for configuring blocks to annunciator lights is as follows:

1. Select Add to display an overlay dialog box containing the necessary entry fields.
See Figure 2-4.
2. Select List Compounds to access a directory of all the compounds known to the
system. This list appears on the right side of the screen. See Figure 2-5.
a. From the list of compounds, select the appropriate compound name.
b. Use the double up or down arrows to page through the compound directory
listing, displaying either the previous page or the next page of items.
Over/underscored double arrows move through pages to the top or bottom of
the listing, respectively.
c. Search for the compound, block name or block type by clicking on the desired
search field and entering the appropriate combination of characters and wild-
card (? and/or *). The listing reflects only the items that meet the search
criteria.
3. Select OK to confirm the compound choice and bring up the block directory list-
ing or select Close to close the dialog box without confirming any selection.

Alarm Table Configuration for WP20, WP30, and PW 13

B0193AU – Rev H 2. Annunciator Configuration

Figure 2-4. Alarm Table Add Dialog Box

Figure 2-5. Alarm Table with Compound Directory Listing

14
2. Annunciator Configuration B0193AU – Rev H

Figure 2-6. Alarm Table with Block Directory Listing

4. If the Block Directory is not displayed automatically, select List Blocks to list all
of the blocks associated with the chosen compound. See Figure 2-6.
5. From the list of blocks, select the appropriate block name.
a. Use the double up or down arrows to page through the block directory, dis-
playing either the previous page or the next page of items. Over/underscored
double arrows move through pages to the top or bottom of the directory list-
ing, respectively.
b. Search for the compound, block name, or block type by clicking on the desired
search field and entering the appropriate combination of characters and wild-
card (? and/or *). This listing reflects only the items that meet the search
criteria.
6. After the block is selected, select OK to confirm the block choice and close the
directory listing or select Close to close the dialog box without confirming any
selection. Both the chosen compound and the chosen block are written to the Add
Function dialog box.
7. Click on the Panel field or press the Return key on the Engineer’s keyboard to
select the Panel field. Enter a number from 1 to 6 (or 1 to 12 for multi-head
CRTs on WP51 workstations) to indicate which panel is being configured. When
using the keyboard to enter your choice, press the Enter key or the Return key on
the keyboard to confirm this entry. Otherwise, the entry is not recorded in the
table.

Alarm Table Configuration for WP20, WP30, and PW 15

B0193AU – Rev H 2. Annunciator Configuration

8. At the Key field enter a number from 1 to 16 to indicate which annunciator light
(associated with key) the block in alarm is to blink. Refer to “Annunciator Key-
board Number Layout” on page 5 for a key number layout for each panel.
When using the keyboard, press the Enter key or the Return key on the keyboard
to confirm this entry. Otherwise, the entry is not recorded in the table.
9. Select OK to confirm the Add dialog box information. The dialog box is removed
and the information appears in the Alarm Table. See Figure 2-7.
If you do not wish to write the information to the Alarm Table, select Cancel.
10. Repeat the above procedure for each block that is to be configured to an annuncia-
tor light. Multiple blocks can be assigned to a single light.
11. When all compounds and blocks requiring alarm configuration have been config-
ured, select the Action field in the top menu bar.
Select the Save function to save any additions to the Alarm Action Table.

Figure 2-7. Alarm Table with Configured Entry

Deleting an Entry
The procedure for deleting an entry from the current Alarm Action Table is as follows:
1. Select the entry to be deleted from the Alarm Action Table. The entry becomes
highlighted (different background color).
2. Select the Action field in the top menu bar to access the pull-down action menu.
All options are selectable. See Figure 2-8.

16
2. Annunciator Configuration B0193AU – Rev H

3. Select Delete. The entry is removed from the Alarm Action Table.
4. From the Action menu, select Save to save the current information to the Alarm
Table file.

Modifying an Entry
The procedure for modifying an entry in the current Alarm Action Table is as follows:
1. Select the entry to be modified from the Alarm Action Table listing. The entry
becomes highlighted.
2. Select the Action field in the top menu bar to access the pull-down action menu;
all options are selectable. See Figure 2-8.
3. Select Modify. The Modify Function dialog box appears (similar to the Add
Function dialog box) with the entry information in the various fields. See
Figure 2-9.

Figure 2-8. Alarm Table with Selected Key and Pull-Down Action Menu

Alarm Table Configuration for WP20, WP30, and PW 17

B0193AU – Rev H 2. Annunciator Configuration

Figure 2-9. Alarm Table with Modify Box

4. Select the field to be modified. Enter the necessary change. If using the keyboard
to enter your choice rather than a directory listing, press Enter or Return on the
keyboard to confirm the change. Otherwise, the entry modification is not be
recorded in the table.
Continue to make each of the necessary field modifications.
5. Select OK.
6. From the Action menu, select the Save function to save the modifications to the
Alarm Table file.

Saving Alarm Table Changes

Select the Save option from the Action pull-down menu to save the current Alarm Table
changes. See Figure 2-8.
After saving, the following message appears: Changes will take effect following a reboot of
WP.

! CAUTION
Whenever the WP is rebooted, all lights currently lit on annunciator panels are
turned off and all alarms are cleared from the Current Alarm Display.

If changes have not been saved, when Exit is selected, a dialog box appears asking if you want
to save those changes.

18
2. Annunciator Configuration B0193AU – Rev H

Exiting the Alarm Table Configurator

Select the Exit option from the Action menu to leave the Alarm Table Configurator and
return to the Environment menu.
If changes have been made that have not been saved, the configurator prompts:

Alarm Action Table has been changed.

Save changes before exiting?

YES NO CANCEL

Selecting Yes saves the changes before exiting; No does not save the changes; and Cancel can-
cels the Exit command. Therefore, if you forget to save your changes, the configurator
reminds you to do so before exiting the Alarm Table Configurator.

Closing the Action Pull-Down Menu

Select the Stop Sign or Close icon to remove the Action pull-down menu from the screen
within the configurator. The screen continues to display the Alarm Action Table information.

Alarm Panel Configuration for WP20, WP30, and PW

The Alarm Panel Configurator links user-defined displays and/or programs to annunciator
keys. When an annunciator key is pressed, the user-defined display associated with that key
(and with the block in alarm) appears and/or a program is executed. A link is also provided to
the alarm display soft keys listed below:
♦ Latest Alarm (on Recent Alarm Display and Alarm History Display for the
WP10).
♦ Top Priority Alarm (on Current Alarm Display and Alarm History Display for
other workstations).
♦ User Display (on Current Alarm Display for all workstations except WP10).

NOTE
Alternately, the Alarm Panel can be created via a text editor in ASCII format and
converted to the Intel binary format. Refer to “WP20/WP30/PW File Conver-
sion Information” on page 81 for the conversion utilities.

Selecting the AlarmPanel_Cfg from the Config pull-down menu in the Process Engineer’s
Environment displays a blank Alarm Annunciator Panel Table and the Annunciator Panel
Key Layout. See Figure 2-10.
The top menu bar consists of the following keys:
Help – Used to access help information related to the Alarm Panel Configurator. (Not avail-
able on WP10).
Action – Used to access a pull-down menu of configurator functions.

Alarm Panel Configuration for WP20, WP30, and PW 19

B0193AU – Rev H 2. Annunciator Configuration

Figure 2-10. Unconfigured Annunciator Panel Table

Action Pull-Down Menu

Select the Action field on the top menu bar to access the pull-down menu of configurator
functions. Initially, only the Load, Save, and Exit functions are selectable. See Figure 2-11.
The following sections explain each of the functions.

20
2. Annunciator Configuration B0193AU – Rev H

Figure 2-11. Annunciator Panel Pull-Down Action Menu

Loading an Annunciator Panel

The Load function is used to load one of six annunciator panel tables. The current panel
number and any configuration information is then displayed in the panel on the screen. To
select a panel to be configured:
1. Select Load from the Action pull-down menu to access a list of panels. See
Figure 2-12.
2. Depending on which panel is to be configured, select one of the six panels. The
selected Annunciator Panel Table appears with the panel number and any previ-
ously configured information for that panel. See Figure 2-13.
Refer to “Annunciator Keyboard Number Layout” on page 5 for information regarding the
number associated with the position of each annunciator panel on the keyboard.

Alarm Panel Configuration for WP20, WP30, and PW 21

B0193AU – Rev H 2. Annunciator Configuration

Figure 2-12. Annunciator Panel Pull-Down Menu

Figure 2-13. Annunciator Panel Partially Configured

22
2. Annunciator Configuration B0193AU – Rev H

Changing an Entry
The Change function is used to assign or change the assignment of displays and/or programs
to keys on the selected panel. In order to configure the selected panel follow the procedure
below:
1. Refer to the Annunciator Key Layout on the right side of the screen for the posi-
tion of the key to be configured. In the panel table, select the key to be configured.
The number of the key appears highlighted when selected. The Action menu is
redisplayed showing all the items as selectable.
2. Select Change from the Action menu to assign a display and/or a program to the
selected key. Display Manager commands or script files can also be assigned to the
selected key.
The Add Function dialog box is displayed containing the fields to be completed.
Either a display, a program, or both can be selected to complete the field informa-
tion. See Figure 2-14.

Figure 2-14. Annunciator Panel with Add Function Dialog Box

3. To assign a display to the Display Name entry, refer to Step 3a. To assign a Dis-
play Manager command, refer to Step 3b. To assign a script file, refer to Step 3c.
a. Select List Displays to access a directory dialog box listing all the displays in
the /usr/disp subdirectory. See Figure 2-15. Then choose the appropriate dis-
play and select OK in the bottom corner of the listing dialog box to confirm
your selection. The name of the display appears in the display field in the Add
Function dialog box.

Alarm Panel Configuration for WP20, WP30, and PW 23

B0193AU – Rev H 2. Annunciator Configuration

All displays to be linked to annunciator keys must be located in the subdirec-

tory /usr/disp or be linked to the /usr/disp directory with the VENIX ln com-
mand. Refer to the VENIX User Reference manual for information on the ln
(link) command.
b. Enter a Display Manager command and parameters. The two restrictions to
the Display Manager command are:
♦ The entire command set can be no more than 14 characters.
♦ The command must contain at least one space; it cannot be a single word
command.
Refer to the Display Manager Calls (B0193DF) document for the specifics
regarding Display Manager Commands.

Figure 2-15. Annunciator Panel with Display Listing Directory

The Display entry is always executed after the Program entry.

For example, the following configuration results in the System Management
subsystem being invoked when Key 1 is pressed.

Panel Number 3
Key Display Name Program Name
1 exit 9

24
2. Annunciator Configuration B0193AU – Rev H

With the following configuration, when Key 1 is pressed all blocks that have
either an UNACK or ALMSTA connection present on the base display (not
overlay) and a CRIT value logically less than or equal to that specified in the
command (2 to 5) are acknowledged.

Panel Number 2
Key Display Name Program Name
1 pageack 2

c. Script files containing Display Manager commands can also be created within
the /usr/disp directory to call up displays. These do not need to be made exe-
cutable with the chmod command.
4. To assign a program to the Program entry refer to Step 4a. To assign a Display
Manager command refer to Step 4b. To assign a script file refer to Step 4c.
a. Select List Programs to access a directory dialog box listing all the programs
in the /usr/prog directory. See Figure 2-16. Then choose the appropriate pro-
gram and select OK in the bottom corner of the directory dialog box. The
name of the program appears in the program field within the Add Function
dialog box.
All programs to be linked to annunciator keys must be located in the directory
/usr/prog or be linked to the /usr/prog directory with the VENIX ln com-
mand. Refer to the VENIX User Reference (B0193BV) manual for information
on the ln (link) command.
b. Enter a Display Manager command. The two restrictions to the Display Man-
ager command are those previously stated in Step 3b. The Program entry is
always executed prior to the Display entry.
For example, the following configuration results in the annunciator light being
extinguished prior to the display North_Tower being called up. This occurs
when Key 2 on Panel 3 is pressed.

Panel Number 3
Key Display Name Program Name
2 North_Tower annun 3 2 4

Alarm Panel Configuration for WP20, WP30, and PW 25

B0193AU – Rev H 2. Annunciator Configuration

Figure 2-16. Annunciator Panel with Program Listing Directory

c. Script files can also be created within the /usr/prog directory. These programs
must be made executable with the chmod command.
5. Continue to select keys on the selected panel table and then assign displays and/or
programs to them.
6. From the Action pull-down menu, select Save to save any additions or changes to
the current Annunciator Panel Table before configuring another panel. You must
save your changes to the current panel before accessing another panel or all
changes to the first panel are lost.

Deleting an Entry
The Delete function is used to delete an entry in the Annunciator Panel Table. The procedure
for deleting an entry from the current Annunciator Panel Table is as follows:
1. Select the entry to be deleted from the Annunciator Panel Table. The entry
becomes highlighted (different background color).
2. Select the Action field in the top menu bar to access the pull-down action menu.
See Figure 2-17.
3. Select Delete. The entry is removed from the Annunciator Panel Table. It is neces-
sary to save any changes to the panel table using the Save function in the Action
menu.

26
2. Annunciator Configuration B0193AU – Rev H

NOTE
Be sure the appropriate Annunciator Panel Table is loaded before deleting an
entry.

Figure 2-17. Annunciator Panel with Action Menu Displayed

Saving Annunciator Panel Changes

Select the Save function to save an individual change or a set of changes to a single panel. It is
necessary to save the changes to a panel before loading another panel. Otherwise, the changes
are lost. See Figure 2-17.
If changes have not been saved before Exit or Load is selected, the configurator reminds you
to save the changes associated with the last panel.

Exiting the Alarm Panel Configurator

The Exit function is used to leave the Alarm Panel Configurator and return to the System
Main Menu.
If changes have been made to the current panel that have not been saved, the following dialog
box appears:

Alarm Panel Configuration for WP20, WP30, and PW 27

B0193AU – Rev H 2. Annunciator Configuration

Panel Configuration has been changed.

Save changes before exiting?

YES NO CANCEL

Selecting Yes, saves the current panel changes before exiting; No does not save the changes;
and Cancel cancels the Exit command. Therefore, if you forget to save your changes, the con-
figurator reminds you to do so before exiting the Alarm Panel Configurator.

Closing the Action Pull-Down Menu

The Stop Sign or Close icon is used to remove the Action pull-down menu from the screen
within the configurator. The screen continues to display the Alarm Annunciator Panel Table
information.

Alarm Table Configuration for Model 50 Workstations

On Model 50 workstations, there are three configuration options for both alarm tables and
alarm panels:
♦ Create the file on a non-50 Series workstation (WP10, WP20, WP30, PW) and
convert to ASCII format
♦ Create an ASCII file using the appropriate format
♦ Use a Model 51 workstation (as of Release 4.2) to create the file using the Annun-
ciator Configurator and copy the file to the Model 50 station
If the Alarm Table file is developed on a non-50 Series workstation (WP20/30 or PW), it is
then copied to the 50 Series workstation and converted to ASCII format. Although the alarm
table developed on a non-50 Series workstation is limited to 500 entries (100 on WP10), the
50 Series workstation is capable of handling 2000 entries. Additional entries can be included
in the alarm table file after it has been transferred to the 50 Series workstation and converted
to an ASCII file. The name of the ASCII file should be:
/usr/fox/alarms/<WPLNAM>AAtab
where <WPLNAM> represents the workstation logical name.

NOTE
1. If a Model 51 workstation is available, an alarm table and alarm panel file can
be created using the Annunciator Configurator and moved to the Model 50
workstation.
2. Alternately, an alarm table file and alarm panel file can be created with a text
editor. The format of the file must mimic that outlined in Step 3 in the proce-
dure for enlarging an alarm table. At most, two comment lines (#) may appear at
the top of the file and only at the top.

To enlarge the alarm table created on a non-50 Series station for a 50 Series workstation,

28
2. Annunciator Configuration B0193AU – Rev H

1. Configure the alarm table on a non-50 Series workstation as described in the pre-
vious sections.
2. Transfer the file to the destination 50 Series workstation. Refer to “Transferring
Configured AAtab and AApan Files to the Appropriate Workstations” on page 34
3. Convert the file for the 50 Series workstation using the appropriate tool provided
in the /usr/fox/wp/bin/tools directory.
The output of the conversion is an ASCII file in the following table format:
#COMPOUND BLOCK PANEL KEY
#
COMPOUND1 BLOCK1 1 1
COMPOUND2 BLOCK2 6 10
COMPOUND3 BLOCK3 1 2
4. Use a text editor on the 50 Series workstation to enter additional configuration
information to the alarm table file. The following rules must be observed:
a. There must be no duplicate entries in the list.
b. Valid panel numbers are 1 through 6 (or 1 through 12 for multi-head CRTs on
AW/WP51 stations); valid key numbers are 1 through 16.

Alarm Panel Configuration for Model 50 Workstations

On Model 50 workstations, there are three configuration options for creating both alarm
tables and alarm panels:
♦ Create the file on a non-50 Series workstation (WP10, WP20, WP30, PW)
♦ Create an ASCII file using the appropriate format
♦ Use a Model 51 workstation (with Release 4.2 or later) to create the file using the
Annunciator Configurator and copy to the Model 50 station
The name of the file should be:
/usr/fox/alarms/<WPLNAM>AApan

NOTE
<WPLNAM> represents the workstation logical name.

On the Model 50 workstations, the configuration file is read by the Alarm Server Task at
start-up. The alarm panel configuration file is an ASCII Alarm Server Task (AST) command
file. The configuration information is still divided into the “program” and “display” catego-
ries, with the additional category of “command.” The “command” category is used to indicate
AST commands. The applicable AST commands are:
clralmpnl This command clears out any alarm panel definitions in memory.

Alarm Panel Configuration for Model 50 Workstations 29

B0193AU – Rev H 2. Annunciator Configuration

addalmpnl panel key type path

panel = 1 to 6, identifying the annunciator panel
key = 1 to 16, identifying the key
type = category of definition
P for program
C for command
D for display
path = definition to be added to the specified category if definition is
null; all definitions for the key are deleted.
prtalmpnl (filename)
The current alarm panel definition is printed to a file in DM command
format that can be used as an input file for future alarm panel defini-
tions. If no file name is specified, the default file name is used:
/usr/fox/alarms/<WPLNAM>AApan.prt
There are no predefined paths of /usr/prog and /usr/disp. Any full path name can be used. In
addition, multiple actions can be configured for one key pick. The addalmpnl built-in adds
the path to a “chain” of actions for each category. Multiple calls to addalmpnl increase the
chain of annunciator key actions. To clear the action definition for a key, use the addalmpnl
command without a path argument.
When editing the alarm panel definition file, be aware of the consequences of each “type” of
action; add new definitions accordingly. Also be sure to use double quotes (“”) around multi-
word commands, and use double dollar signs ($$) for WP globals within commands.
The following table identifies the categories of annunciator definitions that are invoked when
the configuration information is accessed:

P C D No Assignment
(Program) (Command) (Display) Default Display
Annunciator Pick: X X X X
TOP PRIO key: X X X
USER DISP key: X

The user display that is invoked for TOP PRIO is based on how the CAD is sorted and is asso-
ciated with the compound:block for the alarm that is the first entry in the CAD list (Entry 1
on Page 1). For example, if the sort is purely chronological, a Priority 4 alarm may have its
graphic invoked instead of the one for the Priority 1 alarm that had occurred several minutes
previously. Also, multiple picks of the annunciator key will not cycle through the display list,
so if no new alarms have occurred, the same display will be called up several times. The assign-
ments are always processed in the following order:
Program
Command
Display
Detail Display

30
2. Annunciator Configuration B0193AU – Rev H

Following is an example of an alarm panel configuration file for a WP50 or an AW50.

ascmd
clralmpnl
addalmpnl 1 1 D /usr/disp/display1
addalmpnl 1 2 P dmcmd run /usr/prog/program1 &
addalmpnl 1 3 P dmcmd run /usr/prog/program2 &
addalmpnl 1 3 D /usr/disp/display2
addalmpnl 1 4 D /usr/disp/display3
addalmpnl 1 10 D $$STO
addalmpnl 6 16 P dmcmd run /usr/prog/program3 &
addalmpnl 6 16 C “” dmcmd msglin “button picked” “”

Annunciator Key Direction to Display Managers

On WP51 workstations, multiple Display Managers can run simultaneously on a single work-
station processor. This ability provides multiple DM windows on:
♦ the same physical screen,
♦ different screens of a dual-headed workstation,
♦ remote screens served by remote X-servers on an Ethernet network.
Additionally, the dual-headed option provides two CRTs for a single workstation with a com-
mon keyboard and pointing device, a common bus for a touchscreen, and it also supports
four annunciator keyboards. Annunciator commands can be configured to be directed to any
DM on any workstation processor on the I/A Series network. Refer to the Display Manager
Calls (B0193DF) document for more information.
Each instance of the DM and each DM window is independent of any other DM. This means
that each DM is configured with its own unique name and functions as though it were run-
ning on a separate processor. At run time, no data or operator actions are shared among the
DMs. However, all instances of the DM interact with a single Alarm Alert subsystem, display-
ing alarm information from a common Alarm Alert database. Any DM can independently call
up and manage a CAD in its window.
All commands configured for an annunciator key must be directed to a specific DM when
that key is pressed. You can configure each annunciator key panel (group of 16 keys) with a
target DM name so that when a key on the panel is pressed, the configured commands are
sent to that target DM. Also, you can configure individual keys on the panel with a target
DM that overrides the keypanel target DM. If you do not configure a target DM for the key
or its panel, it defaults to the letterbug named DM.
You can override an annunciator panel’s configured target DM so that all keys on the panel,
with the exception of those that are individually configured with a target DM name, are redi-
rected to another DM. This redirection stays in effect until you again redirect the panel to
another DM, until you turn the redirection off, or you reboot the workstation. In these cases,
the target DM configuration is once again in effect.
This redirection scheme does not apply to CAD redirection;, but you can configure each
instance of the DM to have its own unique set of CAD redirection parameters, or, you can use
a default configuration defined for all DMs running on the workstation. However, there is
only one set of alarm configuration attributes (alarm colors, refresh rate, lines per page, con-
figurable CAD format, and so forth.) that applies to all DMs on the same workstation.

Alarm Panel Configuration for Model 50 Workstations 31

B0193AU – Rev H 2. Annunciator Configuration

The Alarm Server Task (AST) is responsible for reading the configuration file and directing
the command, display, or program to the appropriate Display Manager.
An additional category is understood by the AST in the addalmpnl command in order to
identify the key’s target Display Manager, that is, the Display Manager to which the associated
configured commands, programs, or displays are sent when the key is pressed. The Type field
should be set to T followed by the target Display Manager name; an example of the format of
the target command is:
addalmpnl 3 14 T dm0005
If the key number (14) specified in a target type (T) command is in the range of 1 to 16, then
the target Display Manager name applies to only that one key.
If the key number used is 0 (zero), then the target Display Manager name is used for all keys
on the specified panel that are not individually configured with a target name. In the follow-
ing example, all key actions configured for on Panel 3 are directed to Display Manager
dm0004 except key number 14, whose actions are directed to Display Manager dm0005.
addalmpnl 3 0 T dm0004
addalmpnl 3 14 T dm0005
If a target Display Manager name is not configured for a key, then the target Display Manager
used by the AST is the default letterbug Display Manager. Following is an example of a con-
figuration file on a 50 Series workstation. Note that the “dmcmd” configuration line prefix is
no longer applicable and that the file starts with the line “ascmd script.”
ascmd script
clralmpnl
addalmpnl 1 0 T dm0001
addalmpnl 1 1 D /usr/menus/d1/display1
addalmpnl 1 2 P /usr/tower/program20
addalmpnl 1 2 D /usr/menus/tower_ovw
addalmpnl 2 0 T WPLBG2
addalmpnl 2 1 D /usr/menus/d2/display1

NOTE
dm0001 is the name of one of multiple DMs.

The Alarm Server Task (AST) that runs is responsible for responding to annunciator key
presses and responding to the following commands:
addalmpnl add an action assignment to an annunciator key
format: addalmpnl Panel# Key# Type Path
Panel# is a value 1 to 12.
Key# is a value 0 to 16, where 0 is used to specify a DM assignment for
the panel.
Type is one of the following: D, P, C, or T.
Path is full path name of a display, program, Display Manager Com-
mand, or target Display Manager name. If path is left blank, all defini-
tions for the particular key are deleted.

32
2. Annunciator Configuration B0193AU – Rev H

clralmpnl clears out any alarm panel definitions in memory

format: clralmpnl
prtalmpnl The alarm panel command definitions that the AST is currently using
in memory is printed to a file. It is printed in the AST alarm panel
command file format that can then be used as an input file, that is, the
actual ASCII alarm configuration file.
format: prtalmpnl [filename]
If no file name is specified, the following default file name is used:
/usr/fox/alarms/<WPLNAM>AApan.prt
loadalmpnl reloads the alarm panel configuration file into the AST’s memory
format: loadalmpnl [filename]
If no file name is specified, then the name defaults to the value of
$ALMPAN from the wp51_glbls file
Similar to the Display Manager’s command interface, the AST also has a command interface.
The list of commands above can be used via this interface. Also similar to the Display Man-
ager interface, the pref mechanism is used to invoke these commands, for example:
pref -WPLBUG ascmd “loadalmpnl /usr/fox/alarms/panel_cfg.new”
Note that the “dmcmd” text used for interfacing to the Display Manager is replaced by the
“ascmd” text for communication with the AST.

Run-Time Annunciator Key Display Redirection

For 50 Series workstations, the default alarm panel configuration allows you to set up each
annunciator key panel with a target DM name so that when a key on that panel is pressed, the
associated key configuration is sent to the target DM to be executed. If no target DM name is
specified in the configuration, it defaults to the letterbug DM. However, this default behavior
can be overridden at any time by redirecting the alarm panel configuration to another DM.
An individual annunciator key can be configured with a target DM. This means that the key
is not to be redirected when the panel is redirected, and the key’s commands are always sent to
the configured DM name regardless of any annunciator panel redirection. If an annunciator
key press is sent to a target DM that is not running, the Alarm Server Task displays a warning
message on the message line of the letterbug DM.
You can redirect panel keys with Display Manager built-in commands as follows:
♦ Set the PANTRGi variable to the name of a new target DM. For PANTRGi, i =
1 to 12 (alarm panel number).
♦ If the PANTRGi variable is null, the display redirection for Panel i is turned off,
and the configured target DM is once again in effect.
♦ PANTRGi variables can be set by a pref command, or by using the Display Man-
ager built-in assignment operator “=.” For example:

Run-Time Annunciator Key Display Redirection 33

B0193AU – Rev H 2. Annunciator Configuration

= PANTRG10 DMFIVE specifies that key presses on Panel 10 should be redi-

rected to the DM named DMFIVE
= PANTRG4 indicates that annunciator key redirection for Panel 4 is
to be turned off and the original configuration be used
pref -DMNAME PANTRG10 DMFOUR these are the pref commands to acomplish the actions
pref -DMNAME PANTRG4 above

♦ Refer to the Display Manager Calls (B0193DF) document for additional

information.
These built-in commands can be used with customized keys to override annunciator key
assignments.

Transferring Configured AAtab and AApan Files to the

Appropriate Workstations
WP20/WP30/PW Files to WP20/WP30/PWs
The Alarm Panel and the Alarm Table can also be configured on another WP or PW and then
transported to the file server associated with the destination workstation.

NOTE
When configuring these two files, keep in mind that the destination WP10 sup-
ports 100 entries in the Alarm Table; WP20, WP30, and PW stations support
500 entries; the 50 Series workstations support 2000 entries.

When created, the files are automatically given names with the current workstation logical
name:
/usr/fox/alarms/<WPLNAM>AApan
/usr/fox/alarms/<WPLNAM>AAtab
After configuration, the Alarm Panel and Alarm Table file names must be changed to reflect
the logical name of the destination workstation. This information is found in the following
files:
♦ /usr/diskless/<WPLBUG>/msgln file on an AP hosting a WP20 or WP30
♦ /usr/diskless/ia16/usr/diskless/<WPLBUG>/msgln file on a 50 Series host
♦ /etc/msgln on a PW
♦ /etc/msgln file on the 50 Series workstations
Use either File Utilities or operating system commands in the VT100 mode to rename the
files with the destination device letterbug, copy the files to a diskette, and load the files on the
appropriate file server associated with the destination device WP.
METHOD 1: Using File Utilities within the Process Engineer’s Environment

34
2. Annunciator Configuration B0193AU – Rev H

1. Rename the two configuration files using the appropriate logical name represented
by <WPLNAM> for the destination device:
/usr/fox/alarms/<WPLNAM>AApan
/usr/fox/alarms/<WPLNAM>AAtab.
Refer to the Rename function under “File Utilities” in the System Operations
Guide.
2. Store the files on a diskette. Refer to the Store On Diskette function under “File
Utilities” described in the System Operations Guide.

NOTE
Be sure to select the /usr/fox/alarms directory and copy the directory.

3. Load the files from the diskette on the appropriate file server. Refer to the Load
From Diskette function in “File Utilities” described in the System Operations
Guide.
METHOD 2: Using the VT100 mode in the Process or Software Engineer’s Environment
1. Rename the two configuration files using the appropriate logical name (repre-
sented by <WPLNAM>) for the destination device:
/usr/fox/alarms/<WPLNAM>AApan
/usr/fox/alarms/<WPLNAM>AAtab
Enter the following UNIX or VENIX system commands:
a. To change to the /usr/fox/alarms directory, enter:
SUPER> cd /usr/fox/alarms
b. To rename each file, enter the following commands:
SUPER> mv <OLDNAME>AApan <WPLNAM>AApan
SUPER> mv <OLDNAME>AAtab <WPLNAM>AAtab
(<OLDNAME> refers to the present name and <WPLNAM> refers to the logi-
cal name of destination device.)
c. To save the files to a formatted diskette in Drive 0, enter the following
commands:
SUPER> cd /
SUPER> tar cvf /dev/fh0 ./usr/fox/alarms/<WPLNAM>*
(The tar cvf command clears the diskette and copies the alarm files designated
by <WPLNAM>*.

NOTE
When working on a 50 Series AP, use the tar command and /dev/fd0 in place of
/dev/fh0 .

d. On the appropriate file server, change to the root directory and restore the files
to that file server using the following commands:

Transferring Configured AAtab and AApan Files to the Appropriate Workstations 35

B0193AU – Rev H 2. Annunciator Configuration

SUPER> cd /
SUPER> tar xvf /dev/fh0
All the files on the diskette are transferred to the hard disk.

NOTE
When working on a 50 Series AP, use the tar command and /dev/fd0 in place of
/dev/fh0.

Refer to the VENIX User Reference Manual for a complete explanation of the VENIX com-
mands, the SunOS User’s Guide, SunOS Reference Manuals, and Solaris Reference Manuals for
UNIX commands.

WP20/WP30/PW Files to Model 50 Workstations

METHOD 1: Using the VT100 mode in the Process or Software Engineer’s Environment for
File Transfers to 50 Series workstations
1. Select the local VT100 mode on the 50 Series workstation from the SftMnt pull-
down menu in the Software Engineer’s or Process Engineer’s Environment.
2. Check to see if the AP containing the alarm panel and alarm table files is mounted
by entering the following command and looking for that AP in the subsequent list:
rmount
If the AP is not currently mounted, mount the AP using the following command:
rmount sourceAP /rem/sourceAP
sourceAP is the letterbug of the AP containing the WP20/30 files to be copied.
3. Change to the alarm files destination directory on the 50 Series workstation using
the following command:
cd /usr/fox/alarm
4. Copy the existing alarm panel and alarm table files to the destination directory
using the following commands:
For Alarm Panel file:
cp /rem/sourceAP/usr/fox/alarms/<WPLNAM>AApan <NEWWPLNAM>AApan
For Alarm Table file:
cp /rem/sourceAP/usr/fox/alarms/<WPLNAM>AAtbl <NEWWPLNAM>AAtbl

NOTE
1. The <WPLNAM> is the logical name of the existing WP20 or WP30 from
which the file is being copied.
2. The <NEWWPLNAM> is the logical name of the 50 Series workstation to
which the file is being copied.
3. Use logical names rather than letterbugs. Note that in some system configura-
tions, the letterbug can be the same as the logical name of the workstation.

36
2. Annunciator Configuration B0193AU – Rev H

Additionally, the horn configuration file and the common alarm group file can be
copied to or created on the 50 Series workstation. Use the following commands to
copy the files:
cp /rem/sourceAP/usr/fox/alarms/horn.cfg.
cp /rem/sourceAP/usr/fox/alarms/commgrp.cfg.
The horn configuration file and the common alarm group file do not need to be
converted when copied from a non-50 Series workstation. They are already in
ASCII format for 50 Series workstation use.
5. The alarm panel and alarm table files must be converted for 50 Series workstation
use. Use the following tools for converting the transferred files:
/usr/fox/wp/bin/tools/cvtalmpnl alarmpanelfile(s)
/usr/fox/wp/bin/tools/cvtalmtbl alarmtablefile(s)
The alarmpanelfile refers to the binary WP20/30 alarm panel configuration file
which is <WPLNAM>AApan where <WPLNAM> is the WP logical name. The
alarmtablefile refers to the binary WP20/30 alarm table configuration file which
is <WPLNAM>AAtab. This naming convention must be maintained. Refer to the
Appendix A “File Conversion Information” for additional conversion information.

Transferring Configured AAtab and AApan Files to the Appropriate Workstations 37

B0193AU – Rev H 2. Annunciator Configuration

38
3. Alarm Displays
This chapter describes alarm display operations and remote alarm history access.
Process alarm displays provide current or historical block alarm message information for
assessing the criticality of the alarm(s) before acknowledging and resolving the condition(s).
The Alarm Displays available for each workstation are:
♦ Current Alarm Display (excluding WP10 workstation)
♦ Recent Alarm Display (WP10 only)
♦ Alarm History Display
Depending on the configuration of the annunciator keys, these alarm displays provide access
to:
♦ Block Detail Displays
♦ Group Displays
♦ User-defined displays
On all workstations (excluding the WP10) the Current Alarm Display and the Alarm History
Display provide access to the Top Priority Alarm Display and a User Display related to the
selected Block Alarm message. The Top Priority Alarm Display varies depending on the new-
est block-in-alarm with the highest priority, and the current configuration of the Alarm Table
and Alarm Panel.

NOTE
Model 51 workstations are addressed in the Workstation Alarm Management
(B0193RV) document. As of Release 4.2 a more comprehensive set of Alarm
Manager displays is available.

Display Operation
Accessing the Top Priority Alarm Display from the Alarm Display provides one of the follow-
ing display types:
1. If the Alarm Table and the Alarm Panel are unconfigured, the Block Detail Dis-
play of the latest block-in-alarm of the highest priority appears according to the
Sort Option configured for the AA database.
2. When both tables are configured, that is, when a block is assigned to an LED via
Alarm Table configuration, and a display is assigned to the annunciator button via
the Alarm Panel configuration, that display appears. This display is the user
display.
The user display is directly related to a previously selected block alarm message on the Current
Alarm Display and the current configuration of the Alarm Table and Alarm Panel. It is your

39
B0193AU – Rev H 3. Alarm Displays

responsibility to determine that the User Display is appropriate and related to the block; that
it is assigned to the proper annunciator button.
1. If no display has been configured using the Alarm Panel configurator, the USER
DISP soft key does not generate a display. The message No Display Configured
appears.
2. When both tables are configured, a user-generated display related to the selected
block is accessed.
When the Current Alarm Display must be maintained on a workstation at all times, display
redirection can be configured in the Common Alarm Group (CAG) configuration file. Refer
to the section on CAG configuration. Selecting one of the CAD soft keys redirects the display
related to the active alarm to another workstation.
The display can be one of the following:
♦ Block detail display for selected alarm
♦ User display related to selected alarm
♦ User display for the highest priority alarm
The DISP LOCL soft key found on a modified Current Alarm Display overrides the config-
ured display redirection. The next display selected via an alarm display soft key, that is, BLK
DTL, TOP PRIO, or USER DISP key, appears on the local workstation. For additional infor-
mation, see Chapter 4 “Current Alarm Display Configuration”.
On the WP10 only, the Recent Alarm Display and Alarm History Display provide access to
the Latest Alarm Display. This display varies depending on the latest unacknowledged block-
in-alarm. The type of display related to the block-in-alarm is dependent on the current con-
figuration of the Annunciator LED Alarm Table and the Annunciator Key Alarm Panel.
When the Latest Alarm Display is accessed, one of the following types of displays appears:
1. If the Alarm Table and the Alarm Panel are unconfigured, the Block Detail Dis-
play of the latest unacknowledged block-in-alarm appears.
2. When both tables are configured, a user-generated display related to the latest
unacknowledged block-in-alarm appears.
See Process Operations and Displays (B0193MM) document for a complete explanation of
Alarm Displays.

Remote Alarm History Access from Model 50

Workstations
The Model 50 workstations do not have a host AP associated with them. However, there is a
requirement that the Alarm History File must be retrieved from a “host” AP. For this purpose,
the AW/WP50 stations have one special AP designated as the “logical host.”
The Display Manager’s startup script rmounts the logical host. The default Historian for
Trending and alarm history is the Historian on this AP. The name of the logical host is found
in the file /etc/fox/loghost.
The following DM commands manage the mounting of remote file systems.

40
3. Alarm Displays B0193AU – Rev H

mount (APname) Unmounts any currently mounted file system and mounts the new one
to /rem/APname. The newly mounted file system must have this
WP50 in its dsamap file, with the correct permissions. A “busy” file is
opened on the remote AP to keep the connection active.
This command without the APname argument displays the currently
mounted AP name on the message line.
The name of the last AP to be mounted is stored in the WP global
REMOTE. This global is not “read” by DM, but only set to the cur-
rent AP as a way for other applications to determine to which AP the
DM is attached.
umount Closes the “busy” file and unmounts the previously mounted file sys-
tem. However, any remote file access still uses the last mount APname.
Remote file access does not require that DM mount a remote file system. An automatic “tem-
porary” mount of remote APs is done if remote files are to be accessed. For temporary
mounts, a umount is done when the file access is completed.
DM identifies files as being remote if they are prefixed with the $REM global. For example,
the alarm history file is defined as $REM/usr/hstorian/almhist.
The $REM flag is an indication to DM that the file is located on the currently defined remote
AP. Subsequent mount commands change the definition of the remote AP, and, for example,
display different alarm history files.
The currently defined remote AP is also the AP where applic commands are run.

Remote Alarm History Access from Model 50 Workstations 41

B0193AU – Rev H 3. Alarm Displays

42
4. Current Alarm Display
Configuration
This chapter covers configuring Current Alarm Display options, including setting
the number of alarms, refresh times, tag colors, sort options and using the clear
alarm key and the return-to-normal configuration for the WP20, WP30, PW
and Model 50 stations. Using soft keys for redirection overrides is also discussed.
The Current Alarm Display (CAD) is a multi-page display of existing and/or unacknowl-
edged process alarm conditions on an I/A Series network. The configurable file options relat-
ing to the Alarm Alert database maintained by the workstation that effect the CAD include:

WP50/
WP20 WP30 AW50 Option Description
X ALMLNS=<value> number of alarms listed per page
X X ALMTIM=<value> number of seconds between screen update
X X ALMCLR=<values> the color of the alarm text associated with
each priority of process alarm and of the
alarm tag as well as the blink attribute
X X X SORT_CFG=<value> type of sort used in the CAD list
X X X CLR_OPT=<value> function of the CLR ALM soft key on the
CAD
X X X RTN_DROP=<value> whether or not alarms that have
Returned-to-Normal but remain unac-
knowledged are kept in the CAD list.
X HRN_OPT=<value> whether manual or automatic silencing
depending on the block statuses
X RESOUND=<value> whether horn is resounded when mute
open is cleared
X ALMPRI=<value> priority of alarm text saved for usage with
the alarm text string variable
X ALMRTNS=<value> whether in-alarm or both in-alarm and
return-to-normal alarm messages are
saved for alarm text (ALMTXT) and
alarm count (ALMCNT) variable updates

Depending on the option, it is either configurable for each workstation or for all the worksta-
tions hosted by the same AP.

43
B0193AU – Rev H 4. Current Alarm Display Configuration

NOTE
The I/A Series system should have a consistent configuration scheme for alarm-
ing options. Each workstation used as an alarm destination should have the same
values for: CLR_OPT, RTN_DROP, and SORT_CFG.

Additionally, the alarm format and alarm text displayed on the CAD can be customized for
the WP30, WP/AW50, and PW. See Chapter 5 “Alarm Text and Format Configuration for
CAD”.
See the Process Operations and Displays (B0193MM) document for a complete explanation of
the Current Alarm Display available on WP20, WP30, WP/AW50, and PW.

Configuring CAD Options for the WP20, WP30, and

PW
The configuration information for changing the default settings on the Current Alarm Dis-
play for:
♦ the number of alarms per page
♦ number of seconds between screen refresh
♦ alarm tag colors including blinking
is found in the following workstation dependent configuration files:
♦ /usr/diskless/<WPLBUG>/init.user on a workstation AP20 or AP10 host or
/usr/fox/ia16/usr/diskless/<WPLBUG>/init.user on a 50 Series host of a WP20
♦ /usr/fox/hi/init.user on a PW
♦ /usr/fox/alarms/alarm.fmt for all WP30s hosted by an AP
The configuration information for changing the default settings on the Current Alarm Dis-
play for:
♦ the order in which the alarms appear on the screen
♦ the CLR ALM soft key
♦ the Return-to-Normal alarm message
is found in the file /usr/fox/hi/gc3[4]_glbls for the WP20[WP30] and the
/usr/fox/hi/init.glbls file on the PW.
Modifying the /usr/fox/hi/gc3[4]_glbls files in the AP affects all the WPs hosted by that AP
as follows:
♦ If gc3_glbls is modified, only the WP20s are affected.
♦ If gc4_glbls is modified, only the WP30s are affected.

44
4. Current Alarm Display Configuration B0193AU – Rev H

NOTE
1. It is recommended that each default file be copied to a backup file for future
reference prior to modification.
2. Modification of the init.user and init.glbls file requires that the workstation
be rebooted.

Number of Alarms Per Page

For the WP20 only, the values available for the alarms per page configuration option are:

ALMLNS=<value> Description
10 Ten alarms per page; when the line is commented with a
# sign, the default option of 10 is used.
20 Twenty alarms per page

To configure the number of alarms per page,

1. Access the appropriate file in the VT100 mode using a text editor:
♦ For a WP20 access the /usr/diskless/<WPLBUG>/init.user file on the AP host
for the workstation.
♦ For a WP30 access the /usr/fox/alarms/alarms.fmt file on the AP host.
♦ For a PW access the /usr/fox/hi/init.user file.
2. Remove the pound (#) sign from the beginning of the line ALMLNS=<value> in the
init.user files for the WP20 and PW.
For the WP30, refer to “Modifying the Alarm Format File” on page 61 for
instructions.
3. Replace the <value> with the desired number of alarms (either 10 or 20) that are to
appear on the CAD.
4. Reboot the workstation.

Number of Seconds Between Screen Refresh

The values available for the screen refresh configuration option are:

ALMTIM=<value> Description
3 to 100 Number of seconds for the WP30. The default is 10 seconds.
4 to 100 Number of seconds for the WP20 and PW. The default is 10 seconds.

To configure the number of seconds between screen refresh,

1. Access the appropriate file in the VT100 mode using a text editor:

Configuring CAD Options for the WP20, WP30, and PW 45

B0193AU – Rev H 4. Current Alarm Display Configuration

♦ For a WP20/30 access the /usr/diskless/<WPLBUG>/init.user file on the AP

host for the workstation or on the 50 Series station host, access the
/usr/fox/ia16/usr/diskless/<WPLBUG>/init.user file.
♦ For a PW access the /usr/fox/hi/init.user file.
2. Remove the pound (#) sign from the beginning of the line ALMTIM=
<number of seconds>.
3. Indicate the desired time between screen refresh.
4. Reboot the workstation.

Alarm Tag Colors

The values available for the alarm tag colors configuration option are found in the system pal-
ette file. The /usr/include/fox/hicolors.h file contains the correlation between the system
default colors and the default system palette numbers, for example, blue = 4.
The values in the line ALMCLR=00,01,05,03,06,08 represent the default colors as follows:

Alarm
Value Priority No. Alarm Priority
01 (Red) 1 Highest
05 (Magenta) 2 .
.
03 (Brown) 3
.
06 (Cyan) 4 .
08 (Gray) 5 Lowest

NOTE
The value 00 is reserved for future use.

The alarm colors associated with the alarm priority tags appear under the following
conditions:
♦ When the alarm is unacknowledged, the tag text defaults to white and the assigned
alarm priority color appears in the background box.
♦ When the alarm is unacknowledged, the tag text changes to the assigned alarm
color and the background box disappears.

NOTE
Default colors are used for backward compatibility. The ability to customize the
system color palette and/or make changes to the ALMCLR option provides for
user-defined alarm tag colors.

To configure the alarm type field colors on the WP20, WP30 or PW CAD:
1. Access the appropriate file in the VT100 mode using a text editor:

46
4. Current Alarm Display Configuration B0193AU – Rev H

♦ For a WP20/30 access the /usr/diskless/<WPLBUG>/init.user file on the AP

host for the workstation.
♦ For a PW access the /usr/fox/hi/init.user file.
2. Remove the pound (#) sign from the line ALMCLR=00,01,05,03,06,08 and indi-
cate the desired color for each of the process alarm tags, for example, HIABS. The
first value (00) is reserved for future use.
3. To change the default alarm tag color for one of the five process alarm priorities,
♦ change the appropriate number in the ALMCLR line.
4. To change the alarm text color for unacknowledged alarms, that is, to override the
default color of white,
♦ append the desired text color value to the end of the string.
For example, appending “04” to the ALMCLR line indicates that the text color for
unacknowledged alarms is the color associated with 4 in the color palette:
ALMCLR=00,01,05,03,06,08,04
5. Reboot the workstation.

Sort Option
The values available for the alarm sort configuration option are:

SORT_CFG=<value> Description
0 Sort first by in-alarm or Return-to-normal, then Acknowledge
state, then Priority, and last by Time. This is the default unless
otherwise specified.
1 Sort first by Acknowledge state, then Priority, and then Time.
2 Sort first by Acknowledge state and then Time.
3 Sort first by Priority and then Time.
4 Sort by Time.

To change the sort option,

1. Access the appropriate file in the VT100 mode using a text editor:
♦ For the WP20 [WP30] access the /usr/fox/hi/gc3[4]_glbls file (AP).
♦ For a PW access the /usr/fox/hi/init.glbls file.
2. Remove the pound (#) sign from the beginning of the line SORT_CFG=<value>.
3. Replace the current value with the value representing the desired sorting sequence.
4. Reboot the workstation.

CLR ALM Soft Key

The values available for the Clear Alarm soft key configuration option are:

Configuring CAD Options for the WP20, WP30, and PW 47

B0193AU – Rev H 4. Current Alarm Display Configuration

CLR_OPT=<value> Description
0 The selected alarm is deleted from the CAD list only on the workstation
from which the selection is made. The associated annunciator LED (if
configured) or any block parameter is unaffected. This is the default
option.
1 The selected alarm is deleted from the CAD lists on all workstations
defined in the same Common Alarm Group(s) as the workstation from
which the selection is made.
2 The selected alarm is deleted from all the CAD lists on all workstations
defined in the same Common Alarm Group(s) as the workstations from
which the selection is made. In addition, the block is marked as acknowl-
edged and the alarm condition of the annunciator LED associated with
the block (if configured) is set to returned-to-normal.

NOTE
The CLR ALM soft key configured with Option 1 or 2 clears the selected alarm
from the CAD on all workstations in the same Common Alarm Group as the
requesting workstation. The alarm is cleared regardless of the annunciator key-
board assignments of the alarm on the different workstations.

To change the function of the CLR ALM soft key,

1. Access the appropriate file in the VT100 mode using a text editor:
♦ For the WP20 [WP30] access the /usr/fox/hi/gc3[4]_glbls file on the host AP.
♦ For a PW access the /usr/fox/hi/init.gbls file.
2. Remove the pound (#) sign from the beginning of the line CLR_OPT=<value>.
3. Replace the current value with the desired value.
4. Reboot the workstation.

Return-To-Normal Configuration
The values available for the return-to-normal configuration option are:

RTN_DROP=<value> Description
0 If the line is RTN_DROP=0, the Return-to-Normal alarm is kept in the
CAD, but the alarm type field is replaced with the text UNACK .
Based on the sort configuration, the entry can also be repositioned in
the CAD list. When the block is acknowledged, this entry is removed
from the CAD list. In addition, the annunciator light associated with a
block that has returned to normal continues to flash only until the
block has been acknowledged. This is the default action.

48
4. Current Alarm Display Configuration B0193AU – Rev H

RTN_DROP=<value> Description
1 If the line is RTN_DROP=1, the Return-to-Normal alarm is removed
from the CAD regardless of the block acknowledgment state. As a result
of this configuration option, UNACK alarm entries never appear on the
CAD. In addition, the annunciator light (blinking or solid) associated
with a block that has returned to normal is extinguished automatically
regardless of the block acknowledgment state.

NOTE
1. If an annunciator key has more than one block assignment currently in alarm,
the annunciator light is affected by all the block conditions associated with that
key.
2. When the AA Subsystem receives a DISABL message, all alarms in the CAD
for the designated compound:block are removed. The system no longer expects
Return-to-Normal messages for those alarms.
3. Refer to the Process Operator’s Guide for additional information regarding dis-
abled blocks with outstanding alarms and return-to-normal conditions.

To change the Return-to-Normal configuration,

1. Access the appropriate file in the VT100 mode using a text editor:
♦ For the WP20 [WP30] access the /usr/fox/hi/gc3[4]_glbls file (AP).
♦ For a PW access the /usr/fox/hi/init.gbls file.
2. Remove the pound (#) sign from the beginning of the line RTN_DROP=<value>.
3. Replace the current value with the desired value.
4. Reboot the workstation.

Configuring CAD Options for the Model 50

Workstation
The configuration information for changing the default settings on the Current Alarm Dis-
play for:
♦ The number of alarms per page
♦ Number of seconds between screen refresh
♦ Alarm tag colors including blinking
♦ The order in which the alarms appear on the screen
♦ The CLR ALM soft key
♦ The Return-to-Normal alarm message
♦ The horn silencing action
♦ The horn resounding action when mute condition is cleared
♦ The priority of the alarms that are saved for use with the alarm text string variable
and the alarm count variable

Configuring CAD Options for the Model 50 Workstation 49

B0193AU – Rev H 4. Current Alarm Display Configuration

♦ The alarm messages (in alarm or in-alarm and return-to-normal messages) saved
for use with the alarm text string variable and the alarm count variable
is found in the following workstation dependent configuration files:
♦ /usr/fox/alarms/alarms.fmt
♦ /usr/fox/wp/data/init.user

NOTE
The file init.user.rel contains the latest set of configurable options available in
the current release for the 50 Series workstations. These can be copied to the
init.user file.

For access to CAD option enhancements copy or append the init.user.rel file to the existing
init.user file prior to making changes to the init.user file. Subsequent changes can then be
made directly to the init.user file. When needed, default options can be accessed from the
init.user.rel file.

NOTE
A comparison of the init.user and the init.user.rel should be made to determine
whether or not to copy or append init.user.rel to init.user.

Number of Alarms Per Page

The values available for alarms per page are ten alarms or 20 alarms. The default is ten alarms
per page.
To configure the number of alarms per page,
1. Access the /usr/alarms/alarms.fmt file in the VT100 mode using a text editor.
2. The following lines appear at the top of the alarms format file:
# template id, number of alarms
1,10
3. Replace the template id and the number of alarms associated with that template
and save the file. See “CAD Template Display Files” on page 60 and “Modifying
the Alarm Format File” on page 61 for additional information regarding the
alarms format file.

Number of Seconds Between Screen Refresh

The values available for the screen refresh configuration option are:

ALMTIM=<value> Description
3 to 100 Number of seconds between screen refresh for the
50 Series workstation. The default is 10 seconds.

To configure the number of seconds between screen refresh,

50
4. Current Alarm Display Configuration B0193AU – Rev H

1. Access the init.user file in the VT100 mode using a text editor.

NOTE
For initial access to new or enhanced CAD options, copy or append the
init.user.rel file to init.user. For subsequent CAD option changes access init.user
directly.

2. Refer to “Number of Seconds Between Screen Refresh” on page 45. The procedure
is the same as for the WP20, WP30, and PW.

Alarm Tag Colors

The standard color palette file for the 50 Series workstation is
/usr/fox/wp/data/sys_pal.wp50. If alarm blink attributes are desired, the optional color palette
file, /usr/fox/wp/data/sys_pal.blink is available with the following additional settings:
♦ Five blinking colors representing the default alarm colors
♦ The blink OFF color set to GRAY, which is the default background screen color
for the CAD display
You can implement alarm text blinking (foreground blink) or alarm background box blinking
(background blink). Either color palette file can be customized on a WP30 workstation and
converted/transferred to a 50 Series workstation. See the Display Engineering for 50 Series
Workstations (B0193MQ) document for conversion information.
The /usr/include/fox/hicolors.h file contains the correlation between the system default col-
ors and the associated standard system palette numbers, for example, 4 = blue.
To configure the alarm type field colors (ALMCLR=<values> and ACKCLR=<values>) with
blink attributes,
1. Make a backup copy of the sys_pal.wp50 file by copying it to the file
sys_pal.wp50.save.
2. Copy the sys_pal.blink file to the sys_pal.wp50 file for access to the default blink
colors.
3. Access the /usr/fox/wp/data/init.user file in the VT100 mode using a text editor.
4. Remove the pound (#) signs from the alarm color and acknowledged alarm color
lines. The lines have the following format where b1 through b5 represent the back-
ground color for Alarm Priorities 1 through 5 and f1 through f5 represent the fore-
ground color for Alarm Priorities 1:
ALMCLR=00,b1,b2,b3,b4,b5,f1,f2,f3,f4,f5
Initially, the lines contain the system default values used with the blink palette file:
ALMCLR=00,07,07,07,07,07,17,21,19,22,24 (blinking foreground
colors)
ACKCLR=00,07,07,07,07,07,01,05,03,06,08
RTNCLR=00,07,07,07,07,07,17,21,19,22,24 (blinking foreground
colors)

Configuring CAD Options for the Model 50 Workstation 51

B0193AU – Rev H 4. Current Alarm Display Configuration

These lines indicate the five text background and five text (foreground) colors for:
unacknowledged alarms, acknowledged alarms, and unacknowledged return-to-
normal alarms.
The first value (00) is reserved for future use.
5. Indicate the desired text background and foreground color for each process alarm
tag (for example, HIABS) when unacknowledged (ALMCLR) and when acknowl-
edged (ACKCLR).
6. Reboot the workstation.

Sort Option
The choices for alarm sequence (SORT_CFG=<value>) are the same as those for the WP20,
WP30, and PW. Refer to “Sort Option” on page 47.
To change the alarm sort sequence,
1. Access the /usr/fox/wp/data/init.user file in the VT100 mode using a text editor.
2. The procedure is the same as for the WP20, WP30, and PW.

CLR ALM Soft Key

The CLR ALM soft key can result in the same actions as described for CLR_OPT=<value> in
“CLR ALM Soft Key” on page 47 for the WP20, WP30 and PW.
To change the function of the CLR ALM soft key,
1. Access the /usr/fox/wp/data/init.user file in the VT100 mode using a text editor.
2. The procedure is the same as for the WP20, WP30, and PW.

Return-To-Normal Configuration
The Return-to-Normal alarm can be configured as described for RTN_DROP=<value> on
page 48.
To change the Return-to-Normal configuration,
1. Access the /usr/fox/wp/data/init.user file in the VT100 mode using a text editor.
2. Refer to “Return-To-Normal Configuration” on page 48. The procedure is the
same as for the WP20, WP30, and PW.

Horn Silence
The values available for the horn silencing apply to the local workstation horn or the horns
throughout the Common Alarm Group are:

HRN_OPT=<value> Description
0 Manual silence only via ACK button on annunciator or alphanumeric
keyboard, any annunciator panel key, and accessing the Alarm field in a
Display Manager I/A Series environment. This option is the default.

52
4. Current Alarm Display Configuration B0193AU – Rev H

HRN_OPT=<value> Description
1 All blocks are acknowledged regardless of priority OR Manual silence.
2 All alarms are returned to normal OR Manual silence.
3 All blocks are acknowledged regardless of priority OR all blocks are
returned to normal OR manual silence.

NOTE
This option applies only to alarms of compound:blocks that have an annuncia-
tor assignment.

To change the Horn Silence configuration,

1. Access the /usr/fox/wp/data/init.user file in the VT100 mode using a text editor.
2. Remove the pound (#) sign from the beginning of the line HRN_OPT=<value>.
3. Replace the current value with the desired value.
4. Reboot the workstation only after all configuration changes have been made to the
file.

Resound Horn

RESOUND=<value> Description
0 Horns not resounded when MUTE condition is cleared. This
option is the default.
1 Horns resounded when MUTE condition is cleared (if alarms had
arrived during the MUTE period that would have caused the
horns to sound).

To change the Resound Horn configuration,

1. Access the /usr/fox/wp/data/init.user file in the VT100 mode using a text editor.
2. Remove the pound (#) sign from the beginning of the line RESOUND=<value>.
3. Replace the current value with the desired value.
4. Reboot the workstation only after all configuration changes have been made to the
file.

Alarm Text String Update Options

This option indicates the priority of alarms that are saved for usage with the alarm text
{$GCLBUG}ALMTXT string variable and the alarm count ALMCNT $GCLBUG variable:

ALMPRI=<value> Description
0 No saves are performed; the feature is turned off.

Configuring CAD Options for the Model 50 Workstation 53

B0193AU – Rev H 4. Current Alarm Display Configuration

ALMPRI=<value> Description
1 Priority 1 alarms received are saved.
2 Priority 1 and 2 alarms received are saved. This option is the default.
3 Priority 1, 2, and 3 alarms received are saved.
4 Priority 1, 2, 3, and 4 alarms received are saved.
5 Priority 1, 2, 3, 4, and 5 alarms received are saved.

The ALMTXT variable is a 60-character text string with the following format:
Compound Block Param hh:mm:ss Pri State AlmType PointName
where:
Pri is the priority of the message
State is ALM for in-alarm and RTN for return-to-normal
PointName may not be present if not configured

NOTE
*appears in place of the parameter for non-analog alarms, such as STATE alarms.

NOTE
1. The ALMTXT variable can be embedded in a process display and updated
when the ALMCNT variable is updated.
2. The Alarm Manager monitors the ALMCNT variable. When the variable
changes, AM can execute a user-defined action. The New Alarms button on the
Alarm Displays flashes, indicating that new alarms have arrived in the Alarm
Alert internal database.

To change the Alarm Text String Update configuration,

1. Access the /usr/fox/wp/data/init.user file in the VT100 mode using a text editor.
2. Remove the pound (#) sign from the beginning of the line ALMPRI=<value>.
3. Replace the current value with the desired value.
4. Reboot the workstation only after all configuration changes have been made to the
file.

Alarm Message Types Saved

The option indicates the types of alarm messages saved for alarm text (ALMTXT) string
updates and the alarm count (ALMCNT) variable.

ALMRTNS=<value> Description
0 The ALMTXT string and/or ALMCNT is updated for in-alarm
messages. This is the default option.

54
4. Current Alarm Display Configuration B0193AU – Rev H

ALMRTNS=<value> Description
1 The ALMTXT string and/or ALMCNT is updated for in-alarm and
return-to-normal messages.

To change the Alarm Message Types Saved configuration,

1. Access the /usr/fox/wp/data/init.user file in the VT100 mode using a text editor.
2. Remove the pound (#) sign from the beginning of the line ALMRTNS=<value>.
3. Replace the current value with the desired value.
4. Reboot the workstation only after all configuration changes have been made to the
file.

Using the Alternate CAD Soft Keys for Redirection

Override
Two button sets are available for the Current Alarm Display – one set with the display redirec-
tion override soft key DISP LOCL and one set without the override soft key. If the DISP
LOCL soft key is required, you must replace the standard CAD button set.
The DISP LOCL soft key acts to temporarily override the optional Display Redirection con-
figuration in the Common Alarm Group (CAG) and present the requested display on the
local workstation. See Chapter 7 “Common Alarm Group Configuration” regarding CAG
configuration for additional information.
To replace the standard CAD button set with a button set including DISP LOCL,
1. Copy the original template(s) to a backup file(s). The template files on the WP20
and PW are: /usr/fox/tmplts/CAD10 and /usr/fox/tmplts/CAD20.
The template files on the WP30 and 50 Series workstations are:
/usr/fox/tmplts/CAD1, /usr/fox/tmplts/CAD2, /usr/fox/tmplts/CAD3, and
/usr/fox/tmplts/CAD4.
2. Within Display Builder, access the template related to the number of alarms con-
figured (10 or 20) per page.
3. Cut the existing buttons located at the bottom of the display.
4. For the 50 Series workstations, import the CAD button set and page numbering as
follows:
a. From the File pull-down menu, select Import to access the Import menu.
b. Select Buttons from the menu listing in the dialog box and select Import.
c. From the next dialog box, select CAD_BUTTONS and select Import to con-
firm the import function. Display Builder automatically accesses the paste
function.
d. When the Display Builder message Click on location to paste objects...
appears, the extents of the object and the name of the object within those
extents appear.

Using the Alternate CAD Soft Keys for Redirection Override 55

B0193AU – Rev H 4. Current Alarm Display Configuration

e. Using the mouse, select the location for the object (button set or page number-
ing). The alternate button set including the DISP LOCL soft key appears at the
selected location.
f. Follow Steps a and b Select CAD_PAGE_GRP to access page numbering for
the CAD and Import to confirm the import function.
g. Follow Steps d and e to complete the import.
h. Select Save from the File pull-down menu to save the current display. The
Save Display dialog box appears with the path and file name.
i. Select Save to save and install the CAD template.
5. For the WP20, WP30, and PW, access the CAD button set as follows:
a. From the Library pull-down menu, select Load Element and from the result-
ing menu, select Buttons.lib.
b. From the list of button elements, select CAD_BUTTONS and OK to confirm
the selection.
c. This alternate button set including the DISP LOCL soft key appears at the bot-
tom of the screen.
d. From the File pull-down menu, select Save Display to save the file. From the
File menu select Configure Display and reinstall the display.
6. Verify that the Current Alarm Display works properly in terms of display redirec-
tion and override redirection.
7. Distribute the modified Current Alarm Display to all APs associated with worksta-
tions where this override capability is desired as well as PWs and 50 Series worksta-
tions. Use the getremfiles utility described in the Display Engineering for 50 Series
Workstations (B0193MQ) document for distributing the files.

Configuring an Alarm History Display Soft Key for

Redirection Override
Display redirection is also available from the Alarm History Display (AHD). Unlike the
CAD, no alternate set of soft keys are available containing a redirection override key. How-
ever, spare keys are available at the bottom of the AHD.
Use the Display Builder/Configurator to modify the existing alarm history display file tem-
plates (/usr/fox/tmplts/AHD10 or /usr/fox/tmplts/ADH20) to incorporate this override
capability.
To configure an AHD soft key for display redirection override,
1. Copy the original template(s) to a backup file(s).
2. Within the Display Configurator, access the appropriate alarm history display file
template (/usr/fox/tmplts/AHD10 or /usr/fox/tmplts/ADH20).
3. Select a spare soft key and configure the “select” attribute to execute the following
command:

56
4. Current Alarm Display Configuration B0193AU – Rev H

dmcmd almredir.
This key is a toggle key; two sequential picks of the soft key causes the redirection
to again be enabled.
4. Install the display file.
5. Verify that the Alarm History Display works properly in terms of display redirec-
tion and override redirection.
6. Distribute the modified Alarm History Display to all APs associated with worksta-
tions where this override capability is desired as well as PWs and 50 Series worksta-
tions. Use the getremfiles utility described in the Display Engineering for 50 Series
Workstations (B0193MQ) document for distributing the files.

Configuring an Alarm History Display Soft Key for Redirection Override 57

B0193AU – Rev H 4. Current Alarm Display Configuration

58
5. Alarm Text and Format
Configuration for CAD
This chapter covers how to customize the content and format of alarm
information on current alarm displays.
This section provides information on alarm text and format configuration for CAD on
WP/AW50, WP30, and PW stations.
In addition to optionally configuring standard elements of the Current Alarm Display, you
can customize both the content and format of the alarm information displayed on the CAD
for WP/AW50, WP30, and PW. See Figure 5-1. The Configurable CAD Display Manager
uses the following two configurable files when the CAD is displayed:
♦ One of four alarm template display files provided, which define the locations and
lengths of each of the text fields in which alarm data can be displayed. The tem-
plate files can be accessed by the Display Builder and Configurator for editing and
installation.
♦ The alarm format file, which defines which parts of the alarm message text
received by the alarm subsystem go into each display field in the alarm template
file. The alarm format file is an ASCII file that can be edited by any text editor.

Figure 5-1. Customized Current Alarm Display

59
B0193AU – Rev H 5. Alarm Text and Format Configuration for CAD

CAD Template Display Files

The Alarm Template file is a display file used for the Current Alarm Display. It contains a text
display field for each line of information from the alarm message that is to be displayed on the
Current Alarm Display. These text fields are coded allowing Display Manager to recognize
them.
The standard alarm templates contain two lines of alarm information for each alarm displayed
(10 or 20 alarms per template). Each alarm has a set of three alarm display fields associated
with it:

Field 1: The first 80-column line of alarm information.

Field 2: The second 80-column line of alarm information.
Field 3: The seven-column Alarm Type field which overlays seven columns of the line
it occupies and displays the alarm type. This field is color-coded to indicate
the priority and acknowledgment state of the alarm.

Four CAD template display files are supplied with the system for the WP30 and 50 Series
workstation. The following configurable alarm templates included with the system are found
in the /usr/fox/tmplts directory:
♦ CAD1 – the template defining the display with ten two-line alarms, using full-
height text. Same as CAD10 on the WP20 and PW for backward compatibility.
♦ CAD2 – the template defining the display with 20 two-line alarms, using half-
height text. Same as CAD20 on the WP20 and PW for backward compatibility.
♦ CAD3 – a new template supplied with the Configurable CAD Display Manager
defining a display with ten one-line alarms, double spaced with full-height text.
♦ CAD4 – a new template supplied with the Configurable CAD Display Manager
defining a display with 20 one-line alarms, single spaced with full-height text.

NOTE
Both CAD3 and CAD4 are the preferred templates for WP/AW50 stations.

Modification of the alarm template display file is via the Display Builder and Configurator.
You edit the display file with the Display Builder and install it using the Display Configurator.
It is strongly recommended that the four standard template files supplied with the system not
be modified. However, if required, the following guidelines must be used:
♦ Always make a backup copy of the known good template display file prior to mod-
ifying the file.
♦ One or more fields out of the three main template fields per alarm (Line 1 <al3>,
Line 2 <al4>, or Overlay <al5>) can be deleted from the alarm entry file. No other
modifications can be made.

60
5. Alarm Text and Format Configuration for CAD B0193AU – Rev H

Alarm Entry 1 <a13> ...................................................................... <a15>

<a14> ...................................................................................

Alarm Entry 2 <a16> ...................................................................... <a18>

<a17> ...................................................................................

♦ The alarm display field coding is “<a1nn>_____...” where “<a1” is an alarm dis-
play field identifier for Display Manager, the “nn” is a decimal number specifying
to which alarm the field belongs (1 through 10 or 1 through 20 depending on the
alarm display template being modified), and “>____” is used to fill out the rest of
the field representing 80 characters for Lines 1 and 2 and seven characters for the
overlay field.
♦ Each set (10 or 20) of alarm display fields is grouped to include the three fields per
alarm as follows for Display Manager interpretation:

Alarm Entry “nn” VALUE

Number Line 1 Line 2 Overlay Field
1 3 4 5
2 6 7 8
3 9 10 11
· · · ·
· · · ·
10 30 31 32
· · · ·
· · · ·
20 60 61 62

The first alarm has fields numbered 3, 4, and 5 indicating the first, second, and
third fields. The second alarm has fields numbered 6, 7, 8. All subsequent alarms
have fields numbered 3x, 3x+1, and 3x+2 for alarm “x.”
♦ Fields can be moved on the display. However, care must be taken to have all fields
for a given alarm adjacent to one another (the fields must “touch”).
♦ None of the three fields per alarm can be located within the rectangle defined by
the maximum extents of any other alarm.
♦ A “pick” or “selection” box encloses all the fields related to an alarm. This box
must be manually moved and/or resized to accommodate any changes made to the
text fields.

Modifying the Alarm Format File

The alarm format file, /usr/fox/alarms/alarms.fmt, is an ASCII file that can be modified
using a text editor, such as vi. The alarm format file provides information to the configurable

Modifying the Alarm Format File 61

B0193AU – Rev H 5. Alarm Text and Format Configuration for CAD

CAD Display Manager concerning placement of alarm text in the CAD defined by the alarm
template display file.
When the Current Alarm Display is first accessed, the Display Manager locates and reads the
alarms format file. To access changes made to the alarms format file after an initial display of
CAD, the Display Manager must be restarted. You can use the Restart_DM entry in the pull-
down menu associated with SftMnt top menu bar in the Software or Process Engineer’s envi-
ronment to restart the Display Manager.
Each line in the alarm format file contains a series of numbers separated by commas. The
comment lines are denoted with a “#” in the first column of the line. The lines are as follows:
♦ The first non-comment line of the alarm format file is special and contains two
numbers which are interpreted as follows:
♦ The first number is the template selection number (1, 2, 3, 4 corresponding to
CAD1, CAD2, CAD3, and CAD4). The Display Manager automatically
appends the number to the string “CAD” to obtain the file containing the
desired alarm template.
♦ The second number is the number of alarms per page (either 10 or 20). This
number should match the number of alarms defined by the alarm template
file.
♦ Each subsequent line specifies where on the alarm template to place a certain
alarm text field. You can specify as many or as few alarm text fields as desired. If
the alarm text field is not mentioned, it is not displayed. Each line contains four
numbers that are interpreted as follows:
♦ The first number is the alarm text field ID (1 through 21) indicating the type
of text to occur in the alarm messages received by the alarm subsystem. The
line is ignored if an invalid number is used. See “Alarm Text Field Types and
ID Numbers” on page 64 for a list of alarm text fields and associated ID num-
bers and field lengths.
♦ The second number is the alarm template display field ID (1 through 3). As
mentioned in “CAD Template Display Files” on page 60 each two line alarm
entry in the CAD representing one alarm is actually made up of the following
three fields:
Field 1: the first line of text (80 columns wide)
Field 2: the second line of text (80 columns wide)
Field 3: a seven column field dedicated to the alarm type text
which overlays columns 74 through 80 of the first line.

♦ The third number is the column number in the alarm template display field at
which the text specified by the alarm text field ID is to be placed. The allowable
values are 1 through 80 for Field 1 and Field 2; 1 through 7 for Field 3.
♦ The fourth number is the field length required to display the text. The allowable
values are from 1 to the number of columns to the right of the starting column
number, for example, 80 minus the start_column.

62
5. Alarm Text and Format Configuration for CAD B0193AU – Rev H

No more than twenty-one non-comment lines, one for each possible alarm text field should
be present in the file. Comment lines, which start with the “#” character are ignored. The use
of invalid numbers causes the line to be ignored.
See “Examples of Alarm Format Files” on page 64 for an example of an alarm format file.

How Display Manager Processes the CAD

In order to use the Alarm Format file effectively, you must be aware of the following rules that
Display Manager uses to process the CAD:
1. The Display Manager processes each alarm separately from any other alarm. For
each alarm, it processes the alarm text fields in the order they are specified in the
Alarm Format file.
2. If, when placing the text for a certain alarm text field, the Display Manager finds
that the starting column number already contains text from a previously processed
alarm text field, it searches to the right for the first unused column and starts plac-
ing the current text at that column. It subtracts the number of columns it has to
search from the maximum length of the field.
3. The Compound, Block, and Alarm Name fields can be concatenated cleanly or
be handled like any other field, whichever is desired. For concatenation of the
compound, block, and alarm names, the Alarm Format file should contain the
three fields on consecutive lines, in that order, and all three should specify the
same starting column number. Specifying the same starting column causes Display
Manager to concatenate (it searches for the first unused column) each field to the
previous field. The following rules apply:
♦ The Compound field is terminated by a colon or a period, and the Block field
is terminated by a period.
♦ The Block field starts with a colon character, and the Alarm Name field starts
with a period.
♦ If the Block field immediately follows the Compound field, the colon is
included in the field. It is appended to the Compound field, and the maxi-
mum length for the Block field is adjusted to be its maximum length plus that
for the Compound field. Otherwise, the colon is not included and no length
adjustment is made.
♦ If the Alarm Name field immediately follows the Block field, the period is
included in the field. It is appended to the Block field, and the maximum
length for the Alarm Name field is adjusted to be its maximum length plus the
(possibly adjusted) maximum length for the Compound field. Otherwise, the
period is not included and no length adjustment is made.
4. It is also possible to specify that a certain field should start at a column that is
within a previous field’s space. This is useful if the previous field has a variable
length and you desire to concatenate the two fields.
5. Any column that is not assigned to a text field is displayed as a blank.

Modifying the Alarm Format File 63

B0193AU – Rev H 5. Alarm Text and Format Configuration for CAD

Alarm Text Field Types and ID Numbers

The following list includes the alarm text fields and associated ID numbers that can occur in
any of the alarm messages:

ID Maximum
Numbers Alarm Text Fields Field Lengths
1 Compound Name 12
2 Block Name 13*
3 Alarm Name 13*
4 OPER for MON, EXC, IND and DEP Alarms 10
5 Block Descriptor 32
6 Alarm Type 7
7 Date 5
8 Time 8
9 Parameter Value for Analog Alarms 9
10 Units for Analog Alarms 6
11 Limit for Analog Alarms 11
12 CASENOmm Text for MON Alarms 8
13 STEP/STM/SUB/SBX for EXC and IND/DEP Alarms 28
14 Timeout for CONF Alarms 13
15 General Alarm Text 32
16 Range Alarm Text 32
17 SPCALM Alarm Text 32
18 BADIO/STATE State Text 32
19 RANGE State Text 4
20 SPCALM State Text 6
21 PNTxxx for STATE Alarms 7

NOTE
If concatenated, the block name contains a maximum of 12 configurable charac-
ters plus the “:” for a maximum field length of 13. If concatenated, the alarm
name contains a maximum of 12 configurable characters plus the “.” for a maxi-
mum field length of 13.

Examples of Alarm Format Files

The following is the default format file provided with the configurable CAD software. This
file is for the ten-entry, two-line CAD display template (CAD10) available in Release 3.0. Use
this to determine the default positions for alarm information.

64
5. Alarm Text and Format Configuration for CAD B0193AU – Rev H

NOTE
1. The default format file contains two lines for each element in the file layout:
the commented line defines the default value(s) displayed in the next line.
2. Do not remove the default values when making changes to elements of the
format file. Save these values by entering a pound (#) in front of the default val-
ues to comment the line; then enter new values on the next line. For example, to
start the compound name in Column 40 enter the following:
#Compound
#1,1,1,13
1,1,40,13

# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Format file for configuring the CAD
# -----------------------------------

# This file defines the layout of the alarm message on the

# Current Alarm Display (CAD). It represents the format that has
# traditionally been used by Foxboro.
#
# The first line defines the template id and the number of
# alarms per page. The template id values are from 1 - 4.
#
#
# The general format for configuring a file within is:
# field type this can hold values from 1 - 21
# line number line on which this field is displayed (1 - 3)
# starting position the column on which this field starts
# maximum length the maximum length of the text displayed
# for this field.
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# template id, number of alarms
1,10
# Compound
1,1,1,13
# Block
2,1,1,13
# Alarm name
3,1,1,12
# OPER
4,1,27,10
# Block descriptor
5,1,41,32
# Alarm type
6,3,1,7
# Date
7,2,1,5
# Time
8,2,7,8
# Value
9,2,16,9
# Units
10,2,26,6
# Limit
11,2,34,11
# CASENOmm
12,2,28,10
# STEP/STM/SUB/SBX
13,2,16,28
# Timeout
14,2,25,13
# General alarm text
15,2,45,32

Modifying the Alarm Format File 65

B0193AU – Rev H 5. Alarm Text and Format Configuration for CAD

# Range alarm text

16,2,16,32
# DISABL/SPCALM alarm text
17,2,36,32
# BADIO/STATE state text
18,2,40,32
# RANGE state text
19,2,74,4
# SPCALM state text
20,2,30,6
# PNTxxx for STATE alarms
21,2,73,7
# # # # # # # # # # # # # End # # # # # # # # # # # # # # # # # #
An example of a one line per alarm entry format file is as follows:
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# template id, number of alarms
4,20
# Date
7,1,1,5
# Time
8,1,7,5
# Compound
1,1,13,12
# Block
2,1,13,13
# Alarm name
3,1,13,13
# Block descriptor
5,1,45,27
# Alarm Type
6,3,1,8
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #

A description of the previous one line per alarm format file excluding comments is as follows.
Note that each format line specifies that the information is to appear on Line 1 of the alarm
entry on the display (second number).

Line “4,20” This line specifies that the special template CAD4 be used as the tem-
plate and that 20 alarms are desired per page.

Line “7,1,1,5” This line specifies that the Date field starts at Column 1 and requires
five columns.

Line “8,1,7,5” The Time field starts at Column 7 and requires five columns. Hours
and minutes will be displayed; seconds truncated.

Line “1,1,13,12” The Compound Name field starts at Column 13 and a maximum of
14 columns can be used.

Line “2,1,13,13” The Block Name field appends to the Compound field specified on
the previous line and a maximum of 28 columns are allocated to the
concatenated Compound and Block fields.

Line “3,1,13,13” The Alarm Name field appends to the Compound and Block fields
specified on the previous two lines and a maximum of 32 columns are
allocated to the concatenated Compound and Block fields.

66
5. Alarm Text and Format Configuration for CAD B0193AU – Rev H

Line “5,1,45,27” The Block Descriptor field starts at Column 45 and a maximum of
27 columns can be used.

Line “6,3,1,8” The Alarm Type field starts in the first column of the special seven-col-
umn display field that overlays the 80-column text of Line 1.

Modifying the Alarm Format File 67

B0193AU – Rev H 5. Alarm Text and Format Configuration for CAD

68
6. Alarm Horn Configuration
This chapter describes alarm horn configuration: how to link alarm priorities to
horns; the use of horn tones; configuring unique horns for each workstation;
modifying horn configurations; and syntax rules for configuring horns.
A Process alarms and system alarms directed to a workstation can result in the sounding of a
horn or horns. You can specify which of the three types of horns should be sounded upon the
arrival of either a system alarm or a process alarm. The three types of optional horns available
for the workstations are:
♦ Two annunciator keyboard horns – one annunciator horn per keyboard (not avail-
able for PW)
♦ One console horn
♦ Six horns external to the I/A Series equipment
In the case of process alarms, you can select which of the five alarm priorities should cause the
horn to sound. In the alarm horn configuration file, system alarms have an Alarm Priority of
0, which is higher than the 1 to 5 priorities of process alarms.
You can define a distinct horn tone level for system alarms and each process alarm priority in
each WP horn configuration table. The tone levels for both process and system alarms are
from 0 to 3 with 0 indicating no alarm tone.
The tone of a horn signifying an alarm is changed only if the priority of the new alarm is
greater than the priority of the original alarm that caused the horn to sound.
For example, if the horn has been sounded for a Priority 5 alarm and a Priority 3 alarm is then
received, the horn resounds with the tone specified in the Priority 3 column. However, if the
Priority 3 alarm is received and then the Priority 5 alarm, the horn remains on with the
Priority 3 tone level.
For each of the external horns a separate digital output parameter for each of the five process
alarm priorities and the system management alarm status can be specified. You are responsible
for connecting the external horns to the contact outputs.
Horn processing provided on a WP10 remains unchanged. Annunciator panel horns are
sounded for Priority 1 and Priority 2 process alarms.
Two files in the /usr/fox/alarms directory support horn extensions:
♦ horn.cfg, which is a user-modifiable text file containing horn configuration specif-
ics. With no modification, the default configuration allows for the annunciator
horns to sound for Priority 1 and Priority 2 process alarms. The instructions for
file modification are located in the horn_cfg.man file.
♦ AAhorns, which does not need to be executed on the WP/AW50 stations. The
ASCII file is read directly without conversions. However, on all other workstations
AAhorns is an executable file run by you following a change to horn.cfg. This pro-
cess produces binary configuration files AA<wplbug>.BIN. These BIN files are
read into memory when the WP20/30 or PW is booted.

69
B0193AU – Rev H 6. Alarm Horn Configuration

The default information in the horn.cfg file is accessed by every workstation processor that
does not have a unique configuration entered in the horn.cfg file. The standard default horn
configuration in the /usr/fox/alarms/horn.cfg file includes Lines 1 through 10 as listed below:
#
# Alarm Alert Horn Configuration File
# ===================================
Process Alarm
Priorities
Sys 1 2 3 4
1 LID ------
2 AnnunKeyboard1 0 1 1 0 0 0
3 AnnunKeyboard2 0 1 1 0 0 0
4 Console 0 0 0 0 0 0
5 ExtSys None
6 ExtPri1 None
7 ExtPri2 None
8 ExtPri3 None
9 ExtPri4 None
10 ExtPri5 None
#
# Support of multihead workstation additional horns:
# 2nd console horn and annunciator keyboards 3 and 4
#
11 Console 2 0 0 0 0 0 0
12 AnnunKeyboard3 0 1 1 0 0 0
13 AnnunKeyboard4 0 1 1 0 0 0

NOTE
Lines 11 to 13 apply only to dual-headed Model 51 workstations.

A unique horn configuration can be entered in the horn.cfg file for each workstation proces-
sor hosted by an AP, for a PW, and for WP/AW50 stations. Within the horn.cfg file, copy the
default configuration table and specify the workstation letterbug (LID, not the logical name)
and configuration options desired. Repeat for each workstation requiring a unique horn con-
figuration. The horn.cfg file can have multiple configuration tables.

NOTE
The horn options in the default table can be altered to create default informa-
tion specific to your default requirements.

For horn configuration changes to take place,

♦ The AAhorn executable file must be run on the host AP and each workstation
affected must be rebooted.
♦ The AAhorn executable file must be run on the PW and the PW rebooted.
♦ The WP/AW50 stations need only to be rebooted.
To alter the default horn configuration and/or create unique horn configurations for each WP,
use the following procedure:
1. From the System Terminal (VT100-compatible), use a text file editor such as vi to
edit the /usr/fox/alarms/horn.cfg file as indicated:
a. A default horn configuration appears in the /usr/fox/alarms/horn.cfg file. If
desired, alter the default WP horn configuration table (Lines 2 to 13) to repre-

70
6. Alarm Horn Configuration B0193AU – Rev H

sent the horn defaults required by all WPs not requiring unique configura-
tions. Do not enter a specific letterbug; “1 LID ------” indicates the default horn
configuration.
b. For each unique WP horn configuration required, copy the default horn con-
figuration, Lines 1 to 10, as it appears in the /usr/fox/alarms/horn.cfg file. Do
not leave any blank lines (Lines 1 to 10). Comments can be added to the file
by starting the comment line with a pound (#) sign in the first character
position.
c. On each Line 1 (except for the default configuration), enter the appropriate
WP letterbug by overtyping the “------” text with the actual letterbug, for
example, 1 LID GC3E03 .
Modify each line in the table (Lines 2 to 4) according to the desired horn tones
(0 to 3) for the system alarm and each process alarm priority for the WP indi-
cated in Line 1.
Modify Lines 5 to 10 by defining the compound:block.parameter for the digi-
tal output block in the CP database that is used to activate each external horn.
d. Save the completed horn.cfg file and exit the file editor.
2. At the prompt, run the program AAhorns for all non-Model 50 workstations.
This program creates an individual horn configuration file for each non-Model 50
workstation. Each individual horn configuration file has the appropriate WP let-
terbug included in the file name: AAwplbug.BIN.
3. Reboot every workstation (non-Model 50 and Model 50 workstations) for which
changes were made in the /usr/fox/alarms/horn.cfg file. The appropriate individ-
ual horn configuration file is loaded into each rebooted workstation.

NOTE
Horn configuration instructions are located in the /usr/fox/alarms/horn.cfg.man
file.

The alarm horn configuration syntax rules are as follows:

1. For the external horn, when defining the parameter, be sure to use the proper com-
pound:block.parameter syntax (include the “:” and “.”; no spaces).
2. All fields within each WP horn configuration must be filled in.
3. A comment line must have a “#” in the first column.
4. There cannot be any blank lines.
5. Be sure the line numbers 1 to 10 and the horn type, for example,
AnnunKeyboard1, appear as shown on the same line. This is required for file
interpretation.

71
B0193AU – Rev H 6. Alarm Horn Configuration

72
7. Common Alarm Group
Configuration
This chapter covers configuring and installing Common Alarm Groups, common
horn silence request, alarm recovery, and alarm display redirection.
Configuring the Common Alarm Group (CAG) option in the /usr/fox/alarm/commgrp.cfg
file allows you to logically group workstations throughout the I/A Series system. When certain
actions are requested by a workstation in that group, all workstations in the logical group are
affected. These actions are:
♦ Horn silencing
♦ Alarm clearing
Running the following script /usr/fox/alarms/CAGinit creates an initial list of workstations
(excluding WP10s) on the system in the /usr/fox/alarm/commgrp.cfg file. Each workstation
can be configured to be in one large CAG, in one smaller subgroup, or in two smaller sub-
groups. If a workstation is a member of two groups, requesting one of the previously men-
tioned actions from the workstation affects all the workstations throughout both Common
Alarm Groups. Therefore, a workstation has control over many more workstations.
In addition to the Common Alarm Group option, the configuration file also contains the
workstation alarm recovery option and the Current Alarm Display redirection option.
The following information can be optionally configured for every workstation listed in the
configuration file:
♦ The name of the CAG with which the workstation is associated.
♦ The name of a second CAG with which the workstation is associated.
♦ The letterbug of a backup workstation from which to recover the current alarm list
and annunciator panel LED settings if a reboot is required. (Reboot clears alarm
information.) See “Common Horn Silence” on page 75.
♦ The letterbug(s) of WP(s) to which the following alarm displays can be redirected
when accessed from the Current Alarm Display: Block Detail Display, Top Priority
Alarm Display, and User Display.

Configuring and Installing the File for CAGs

The configuration file for CAGs (/usr/fox/alarm/commgrp.cfg), created by running the
script /usr/fox/alarms/CAGinit, contains a listing of all workstations throughout the system
and configuration information for any of the following features:
♦ CAG-related common horn silence
♦ CAG-related alarm clear (via CLR ALM soft key)
♦ WP alarm recovery
♦ CAD redirection

73
B0193AU – Rev H 7. Common Alarm Group Configuration

When additional workstations are added to the I/A Series system configuration, rerun the
script to append the new workstation letterbugs to the Common Alarm Group configuration
file (/usr/fox/alarm/commgrp.cfg) for configuration:
/usr/fox/alarms/CAGinit
Although a workstation can only be a member in up to two common alarm groups, the num-
ber of CAG names used for grouping workstations is not limited.
Configuration is optional. It is not necessary for a workstation to be a member of a common
alarm group to configure WP alarm recovery or CAD redirection.

NOTE
1. Although a WP can be a member of up to two CAGs, there can be any num-
ber of Common Alarm Group names per system in the file.
2. A Top Priority or user display that is redirected to another WP must reside in
the AP hosting the WP to which it is redirected.
3. In order to temporarily override the configured CAD redirection, the Current
Alarm Display templates (/usr/fox/tmplts/CAD10 and/or
/usr/fox/tmplts/CAD20 on the WP20 and PW; /usr/fox/tmplts/CAD1[2,3,4]
on the WP30 and Model 50 workstations) can be modified to include the DISP
LOCL button. These modified displays should be distributed to the AP hosts of
WPs using CAD. You can also execute an alm redir command with the pref
tool.

To create, configure, and install the file containing CAG information,

1. In the VT100 mode, run the AP script /usr/fox/alarms/CAGinit to create the
/usr/fox/alarm/commgrp.cfg file. This file then contains a list of configurable
fields as well as a list of all the workstation letterbugs on the I/A Series network to
which the alarm features apply: all non-WP10 workstations. Each workstation let-
terbug entry defaults to no assignment, for example, “--------------”.

NOTE
Only one /usr/fox/alarm/commgrp.cfg file is created per I/A Series system. This
file contains information for all of the workstations on the system and must be
distributed to all the APs hosting workstations as well as to the PWs and
50 Series workstations configured in the file.

2. Using a text editor access the /usr/fox/alarms/commgrp.cfg file and enter the con-
figuration information for each workstation. The following is an example of a pre-
viously configured CAG configuration file.

# Common Alarm Group (CAG) Configuration File

#
# (CAD Redirection)
# WP CAG Backup BLK TOP USER CAG
# LBUG NAME1 LBUG DTL PRIO DISP NAME2

74
7. Common Alarm Group Configuration B0193AU – Rev H

###### ############ ###### ###### ###### ###### ############

WP20D1 TOWER1_NORTH WP30D1 WP30D1 WP30D2 WP30R3 ------
WP30D1 TOWER1_NORTH WP20D1 ------ ------ ------ ------
.
.
WP30R1 TOWER1_NORTH ------ ------ ------ ------ CENTRL_CNTRL

NOTE
The CAG NAME1 and CAG NAME2 fields can be up to 12 characters.

3. After creating and configuring the information, you must distribute the file to all
APs hosting the member workstations throughout the network. Copy the
/usr/fox/alarms/commgrp.cfg file to each AP, PW, or 50 Series workstation.
Also, be sure to distribute any modified Alarm Displays, that is, Current Alarm
Display with DISP LOCL button, to all the APs hosting workstations.
4. After installing the configured file on the APs hosting the workstations, reboot
each workstation.
♦ The following is an optional procedure to override the default configuration in
the common group configuration. The previous installation of the configured
files involved setting CADTP, CADUS, and CADDD redirection variables via
= or pref, for example:
pref -WP4000 CADTP DM1111
pref -AW2000 CADTP DM2222
The variables can contain DM names instead of letterbug names when redirecting
to Model 51 workstations with multiple DMs.

NOTE
Changes to the file require that the updated file be redistributed to the appropri-
ate APs, PWs, and 50 Series workstations. The workstations must then be
rebooted.

Common Horn Silence

When a workstation has been assigned to a logical grouping of workstations (CAG) in the
configuration file /usr/fox/alarm/commgrp.cfg, a silence horn request from a workstation
silences all the horns associated with workstations within its Common Alarm Group(s).
When the CAG NAME1 and/or CAG NAME2 field for the WP is configured in the CAG file,
a silence horn request sends the horn silence message to the other members of the Common
Alarm Group. Otherwise, if the field is not configured and the WP is part of a multi-screen
cluster, horns are silenced throughout the multi-screen cluster.
All workstations are responsible for resetting their own external horn contact points since dif-
ferent external horn contacts can be defined for the various workstations in the CAG.

Common Horn Silence 75

B0193AU – Rev H 7. Common Alarm Group Configuration

Alarm Recovery from a Backup Workstation

When the letterbug of a backup workstation is assigned to a workstation in the configuration
file /usr/fox/alarm/commgrp.cfg, the current alarm and annunciator LED settings for the
workstation can be recovered when the workstation is rebooted.
For alarm recovery, the backup workstation must have the same annunciator table configura-
tion as the original workstation. During the configuration of the process control scheme, both
workstations should be configured to receive the same alarms. The annunciator LEDs are
then set to the same states for both workstations. Upon reboot, the workstation requests the
current alarm information and annunciator assignments from the backup workstation. If suc-
cessful, the current alarm table and the annunciator table are both sent; otherwise both tables
are cleared.
Alarm recovery can also be performed on request with a Display Manager command. Refer to
the Display Manager Calls (B0193DF) document for information on the almbkup command.

NOTE
For alarm recovery, the annunciator keyboard assignments need to be the same
for both the workstation and its backup workstation. When the CLR ALM soft
key option is set to 1 or 2, the selected alarm is cleared from the CAD as
described in “CLR ALM Soft Key” on page 47 regardless of the various annunci-
ator keyboard assignments of the alarm on multiple workstations.

Display Redirection
Configuration of Current Alarm Display redirection in the /usr/fox/alarm/commgrp.cfg file
allows alarm-associated displays to be redirected to other workstations via the alarm soft keys.
The following three types of displays associated with active alarms can be redirected when the
associated CAD soft key is selected:
♦ User display associated with the selected alarm (USER DISP)
♦ A block detail display for the block associated with the selected alarm (BLK DTL)
♦ A user graphic for the highest priority alarm in the current alarm queue
(TOP PRIO)
Display redirection is implemented as follows:
♦ Each type of display can be directed to different workstations.
♦ The display file being accessed must reside on the host AP of the workstation to
which it is being redirected.
♦ On non-Model 50 workstations, displays invoked from annunciator keys are not
redirected.
♦ On non-Model 50 workstations, Display Manager commands configured in the
alarm panel under the Display Name field are not redirected.

76
7. Common Alarm Group Configuration B0193AU – Rev H

♦ PREV DISP soft key on the Current Alarm Display invokes the previous display
on the current workstation.
♦ DISP LOCL, available in the optional set of CAD buttons, is used to temporarily
override the display redirection.
♦ Each time the CAD is accessed, the redirection is reinstated.

Display Redirection 77
B0193AU – Rev H 7. Common Alarm Group Configuration

78
Appendix A. File Conversion
Information
This appendix provides the utilities for converting files 50 Series, WP20, WP30,
and PWs from binary data to ASCII format and vice versa.

NOTE
1. Prior to using any of the conversion utilities, backup the original file to
another name.
2. If a Model 51 workstation (with Release 4.2 or later) is available, the Annun-
ciator Configuration can be used to configure Model 50 workstation files. These
files are then copied to the appropriate workstation directories.

50 Series File Conversion Information

Alarm Table Configuration Files
Description:
The alarm table configuration file from a WP20/30 must be converted from binary
data to ASCII format for use on 50 Series workstations. The conversion utility is
located on the 50 Series workstation.
Conversion Utility:
/usr/fox/wp/bin/tools/cvtalmtbl alarmtablefile(s)

NOTE
alarmtablefile(s) refers to the binary WP20/30 alarm table configuration file
which is named WPLNAMAAtab. WPLNAM is the WP logical name. This
naming convention must be maintained.

Conversion Output:
The output of the conversion is an ASCII file in table format. For example:

#COMPOUND BLOCK PANEL KEY

#
COMPOUND1 BLOCK1 1 1
COMPOUND1 BLOCK2 6 10
COMPOUND3 BLOCK3 1 2

Valid panel numbers are from 1 to 12. Valid key numbers are 1 to 16. Duplicate
entries are not supported. When duplications are present, the first one read is used and
the subsequent one is ignored.

79
B0193AU – Rev H Appendix A. File Conversion Information

Comments are allowed only at the beginning of the Alarm Table. Any comments after
the first entry incorrectly process the file.

Alarm Panel Configuration Files

Description:
The alarm panel configuration file from a WP20/30 must be converted to ASCII Dis-
play Manager file format for use on 50 Series workstations. Configuration informa-
tion is divided into three categories: “program,” “display,” and “command” for
backward compatibility. The following is a table identifying the categories of annunci-
ator definitions that can be invoked:

Prog Command Display Detail Display

Annunciator Pick x x x x
Top Priority x x x
User Display x

Display Manager processes the applicable categories in the following order: program,
command, display, detail display.
The conversion utility is located on the 50 Series workstation.
Conversion Utility:
/usr/fox/wp/bin/tools/cvtalmpan alarmpanelfile(s)

NOTE
1. alarmpanelfile(s) refers to the binary WP20/30 alarm panel configuration file
which is named WPLNAMAApan. WPLNAM is the WP logical name. This
naming convention must be maintained.
2. On a Model 50, the binary to ASCII conversion produces an ASCII file
meant for 50 Series stations. However, additional editing must be done to
remove the AST command words and explicit directories.

Conversion Output:
The output of the conversion is an ASCII Alarm Server Task command file. For
example:
clralmpnl
addalmpnl 1 1 D /usr/disp/display1
addalmpnl 1 2 P dmcmd run /usr/prog/program1 &
addalmpnl 1 3 P dmcmd run /usr/prog/program2 &
addalmpnl 1 3 D /usr/disp/display2
addalmpnl 1 4
addalmpnl 2 10 D $$STO
addalmpnl 6 16 P dmcmd run /usr/prog/program3 &
addalmpnl 6 16 C “” dmcmd msglin “button picked” “”

Features:
The command file contains the following built-in commands:

80
Appendix A. File Conversion Information B0193AU – Rev H

clralmpnl This command clears out any alarm panel definitions in memory.
addalmpnl panel key type path
The argument options for this command are as follows:
panel = 1 to 6 to identify the annunciator panel.
key = 1 to 16 to identify the annunciator key.
type = category for annunciator pick – P for program, C for
command, D for display. Null indicates Detail Display.
path = definition to be added to the specified category. If the
definition is null, all definitions for the key are deleted.

Alarm Server Task alarm panel processing provides for the following:
♦ the use of any full path name.
♦ the configuration of multiple actions for one key pick. Multiple
calls to addalmpnl with a path argument create a chain of
actions for each category.
♦ the clearing of an action definition for a key by using the add-
almpnl command without a path argument.
Alarm Server Task requires the use of double quotes (“”) around multi-
word commands and the use of double dollar signs ($$) for WP globals
within commands.

WP20/WP30/PW File Conversion Information

Alarm Table Configuration Files
Description:
The alarm table configuration file from a WP20/30 or PW can be created using a text
editor and converted from ASCII format to binary format as an alternative to using
the Alarm Table Configurator. The binary formatted file can also be converted back to
an ASCII format for making changes to the file. The conversion utility is located on
the respective workstation.
The conversion file cvtalmtbl available on an AP20 or PW converts a Binary Alarm
Table File to be used on a WP20, WP30, PW. The input file is copied into file.bia16
and is deleted upon successful conversion. If an error occurs, the new file is deleted
and the input file renamed to origfile.bia16.
The conversion file tab20cvt available on an AP20 or PW converts an ASCII file into
a Binary Alarm Table File to be used on a WP20, WP30, PW station. The input file is
copied into file.ascii and is deleted upon successful conversion. If an error occurs, the
new file is deleted and the input file renamed to origfile.ascii.
Conversion Utility:
/usr/fox/alarms/cvtalmtbl alarmtablefile(s)
/usr/fox/alarms/tab20cvt alarmtablefile(s)

WP20/WP30/PW File Conversion Information 81

B0193AU – Rev H Appendix A. File Conversion Information

NOTE
alarmtablefile(s) refers to the binary WP20/30 alarm table configuration file
which is named <WPLNAM>AAtab. WPLNAM is the WP logical name. This
naming convention must be maintained.

Example of ASCII Alarm Table File Format for Binary Conversion:

#COMPOUND BLOCK PANEL KEY
#
COMPOUND_1 BLOCK1 1 1
COMPOUND_1 BLOCK2 1 2
COMPOUND_1 BLOCK3 1 3
COMPOUND_1 BLOCK4 1 4
COMPOUND_1 BLOCK5 1 5

Valid panel numbers are from 1 to 6. Valid key numbers are 1 to 16. Duplicate entries are not
supported. When duplications are present, the first one read is used and the subsequent one is
ignored.
Comments are allowed only at the beginning of the Alarm Table. Any comments after the
first entry incorrectly process the file.

Alarm Panel Configuration Files

Description:
The alarm panel configuration file from a WP20/30 can be created using an ASCII
text editor and converted from ASCII format to binary format as an alternative to
using the Alarm Table Configurator. The binary formatted file can also be converted
to an ASCII format for making changes to the file. The conversion utility is located on
the workstation.
The conversion file cvtalmpnl available on AP20 or PW converts a Binary Alarm
Panel File to be used on a WP20, WP30, PW. The input file is copied into file.bia16
and is deleted upon successful conversion. If an error occurs, the new file is deleted
and the input file renamed to origfile.bia16.
The conversion file pan20cvt available on AP 20 or PW converts an ASCII file into a
Binary Alarm Panel File to be used on a WP20, WP30, PW station. The input file is
copied into file.ascii and is deleted upon successful conversion. If an error occurs, the
new file is deleted and the input file renamed to origfile.ascii.
Configuration information is divided into three categories – “program,” “display,” and
“command” for backward compatibility. The following is a table identifying the cate-
gories of annunciator definitions that can be invoked:

Prog Command Display Detail Display

Annunciator Pick x x x x
Top Priority x x x
User Display x

82
Appendix A. File Conversion Information B0193AU – Rev H

Display Manager processes the applicable categories in the following order: program,
command, display, detail display.
Conversion Utility:
/usr/fox/alarms/cvtalmpnl alarmpanelfile(s)
/usr/fox/alarms/pan20cvt alarmtable file(s)

NOTE
alarmpanelfile(s) refers to the binary WP20/30 alarm panel configuration file
which is named <WPLNAM>AApan. WPLNAM is the WP logical name. This
naming convention must be maintained.

Example of ASCII Alarm Panel File Format for Binary Conversion:

An example of an ASCII formatted Alarm Panel file is as follows:
1 1 D display1
1 2 P program12
1 3 P program13
1 4 D display14
2 4 D display24
2 4 P program24

The format is: panel number, key number, D for display or P for program. The path for a dis-
play is assumed to be /usr/disp and the path for a program is assumed to be /usr/prog (as in
the existing configurators).

Horn Configuration File

Description:
The horn configuration file on the 50 Series workstation is read directly by the Alarm
Alert program. Therefore, there is no need to convert the file to binary format.
Instructional comments formerly in the file /usr/fox/alarms/horn.cfg are now located
in the /usr/fox/alarms/horn_cfg.man file.

Horn Configuration File 83

B0193AU – Rev H Appendix A. File Conversion Information

84
Index
A
Access
process alarm configurators 9
Alarm
alarm panel configuration 1
alarm soft key 47
alarm table configuration (ATC) 1
common alarm groups (CAG) 2
configuration for 50 Series 28
configuration overview 1
configurator access to WP20, WP30, and PW 9
current alarm display 43
current alarm display configuration 1
current alarm display template 2
customizing alarm notification 1
display manager process 63
display operation 39
displays 39
exit the APC 27
history display key configuration 56
horn configuration 69
id numbers 64
notification 1
number of per page 45
number per page 50
panel configuration files 80, 82
panel configuration for 50 Series 29
panel configuration WP20,WP30,WP 19
process alarm notification 3
recovery from a backup workstation 76
remote history access model 50 40
sort options 47
subsystem alert 1
system alarm notification 3
table configuration WP20,WP30,PW 10
table size 11
tag colors 46
template display file 60
text field type 64
text/format configuration for CAD on WP30, 50 Series 59
Alarm Display
configuration (current) 43

85
B0193AU – Rev H Index

Alarm Table
deleting an entry 16
exiting the configurator 19
modifying an entry 17
saving changes 18
Alarm table
closing the menu 19
Annunciator
adding a table entry 12
configuration 5
configuration by numbered location 7
deleting a panel table entry 26
key direction to display manager 31
key display redirection 33, 37
keyboard information 5
keyboard number layout 5, 6
loading a panel 21
modular keyboard layout 7
APC
exiting 27

C
CAD
alarm text and format configuration 59
display manager process 63
options for WP20,WP30,PW 44
template display file 60
CAG
common alarm group 2
configuration 73
configuring 73
installing the file 73
Configuration
50 Series 28
alarm history display redirection override 56
alarm horn 69
alarm panel configuration (APC) 1
alarm panel for WP20,WP30,WP 19
alarm table configuration 1
annunciator, via numbered location 7
CAD 59
CAD options/WP20,WP30,PW 44
common alarm group 73
current alarm display 1, 43
exiting the ATC 19
file for CAG 73

86
Index B0193AU – Rev H

LED alarm table configuration 10

return-to-normal 48
system monitor software 1

D
Display
assign a command 23
changing an entry 23
current alarm 43
operation 39
redirection 76
Display Manager
CAD process 63
features 80
Display manager
annunciator key direction 31

F
Files
sending WP20/WP30/PW to 50 Series workstations 36

H
Horn
common horn silence 75
configuration file 83

I
ID Numbers
text field type 64
Installing
file for CAG 73

K
Keyboard
annunciator keyboard information 5
annunciator keyboard number layout 5
modular annunciator keyboard layout 7
modular keyboard information 6
number layout 6
numeric keyboard information 5

M
Menu

87
B0193AU – Rev H Index

action pull-down 12, 20

closing the action menu 28
Modular keyboard
information 6

P
Panel
changing an entry 23
delete a table entry 26
Process alarm notification 3

R
Remote Alarm
access from 50 Series workstations 40
Return-to-normal
configuration 48

S
Screen refresh
number of seconds between refresh 45
Sort options 47
System
system alarm notification 3

T
Table
delete a panel table entry 26

The Foxboro Company

33 Commercial Street
Foxboro, Massachusetts 02035-2099
United States of America
http://www.foxboro.com
Inside U.S. 1-508-543-8750 or 1-888-FOXBORO (1-888-369-2676)
Outside U.S. - Contact your local Foxboro Representative.

Printed in U.S.A. 1099

An Invensys company