Vous êtes sur la page 1sur 76

B0700AP

REV A

I/A Series System


Alarm Management Commands and Keywords
October 1, 2004
Invensys, Foxboro, FoxPanels, FoxView, and I/A Series are trademarks of Invensys plc, its subsidiaries, and
affiliates.
All other brand names may be trademarks of their respective owners.

Copyright 2004 Invensys Systems, Inc.


All rights reserved

SOFTWARE LICENSE AND COPYRIGHT INFORMATION


Before using the Invensys Systems, Inc. supplied software supported by this documentation, you
should read and understand the following information concerning copyrighted software.
1. The license provisions in the 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, Invensys Systems, Inc. will no longer provide you
with support services and assumes no further responsibilities for your system or its
operation.
2. All software issued by Invensys Systems, Inc. and copies of the software that you are
specifically permitted to make, are protected in accordance with Federal copyright
laws. It is illegal to make copies of any software media provided to you by
Invensys Systems, Inc. for any purpose other than those purposes mentioned in the
software license.
Contents
Tables.................................................................................................................................... vii

Preface.................................................................................................................................... ix
Purpose .................................................................................................................................... ix
Revision Information ............................................................................................................... ix
Reference Documents .............................................................................................................. ix
Conventions ............................................................................................................................. ix

1. Introduction ...................................................................................................................... 1
Alarm Manager Commands and Keywords ............................................................................... 1
Alarm Manager Commands ................................................................................................. 1
Alarm Manager Keywords .................................................................................................... 1
Alarm Server Task Commands .................................................................................................. 1

2. Alarm Manager Commands............................................................................................... 3


Format ...................................................................................................................................... 3
Pref Command Syntax .............................................................................................................. 3
Command Summary ................................................................................................................. 4
Command Reference ................................................................................................................. 8
!= (Inequality) ....................................................................................................................... 9
= (Assignment) ..................................................................................................................... 9
== (Equality) ...................................................................................................................... 10
about .................................................................................................................................. 10
ackalm ................................................................................................................................ 11
ackcmp ............................................................................................................................... 11
ackpage ............................................................................................................................... 12
ackpage_cmp ...................................................................................................................... 12
almdisp ............................................................................................................................... 13
blk_dtl ................................................................................................................................ 14
chngenv .............................................................................................................................. 15
clear_alm ............................................................................................................................ 16
clear_page ........................................................................................................................... 16
deselect ............................................................................................................................... 17
detail_alm .......................................................................................................................... 17
disable ................................................................................................................................ 18
dismiss ................................................................................................................................ 18
enable ................................................................................................................................. 19
exit ..................................................................................................................................... 19
find .................................................................................................................................... 20

iii
B0700AP Rev A Contents

getenv ................................................................................................................................. 20
help .................................................................................................................................... 21
hide .................................................................................................................................... 21
hist_file .............................................................................................................................. 22
historian ............................................................................................................................. 22
historian_ts ......................................................................................................................... 23
match ................................................................................................................................. 24
match_ts ............................................................................................................................. 25
minimize ............................................................................................................................ 25
mute_all_horns .................................................................................................................. 26
mute_horns ........................................................................................................................ 26
ojinit .................................................................................................................................. 27
page .................................................................................................................................... 27
page_setup ......................................................................................................................... 28
pause .................................................................................................................................. 28
print ................................................................................................................................... 29
print_cancel ....................................................................................................................... 29
print_preview ..................................................................................................................... 30
print_setup ......................................................................................................................... 30
protect ................................................................................................................................ 31
quitam ................................................................................................................................ 31
refresh ................................................................................................................................ 32
run ..................................................................................................................................... 32
save_cancel ......................................................................................................................... 32
save_to_file ......................................................................................................................... 33
script .................................................................................................................................. 33
scroll_by_time .................................................................................................................... 34
select .................................................................................................................................. 34
send_to_dm ....................................................................................................................... 35
set_alarm_source ................................................................................................................ 36
setacl .................................................................................................................................. 37
setdisp ................................................................................................................................ 37
setenv ................................................................................................................................. 38
setenv_default ..................................................................................................................... 38
show ................................................................................................................................... 39
silence_horns ...................................................................................................................... 39
stop_match ......................................................................................................................... 40
top_prio ............................................................................................................................. 40
unmute_all_horns .............................................................................................................. 41
unmute_horns .................................................................................................................... 41
unpause .............................................................................................................................. 41
unprotect ............................................................................................................................ 42
user_disp ............................................................................................................................ 43
view_all .............................................................................................................................. 43

3. Alarm Manager Keywords ............................................................................................... 45


Keyword Descriptions ............................................................................................................. 45
Keyword Modifiers ................................................................................................................. 46

iv
Contents B0700AP Rev A

Time and Date Modifiers ........................................................................................................ 46


Examples of Keyword Specifiers .............................................................................................. 47
Alarm Manager Commands That Use Keywords .................................................................... 48

4. Alarm Server Task Commands ........................................................................................ 49


Overview ................................................................................................................................. 49
Pref Command Syntax ............................................................................................................ 49
Format .................................................................................................................................... 50
Command Reference ............................................................................................................... 50
addalmpnl .......................................................................................................................... 50
clralmpnl ............................................................................................................................ 51
loadalmpnl ......................................................................................................................... 51
prtalmpnl ........................................................................................................................... 51
Command Usage and Examples .............................................................................................. 52

5. Default User Interface Configuration .............................................................................. 55

Index .................................................................................................................................... 59

v
B0700AP Rev A Contents

vi
Tables
2-1. Alarm Manager Command Summary ........................................................................... 4
3-1. Alarm Manager Keywords ........................................................................................... 45
3-2. Keyword Modifiers ..................................................................................................... 46
3-3. Time and Date Modifiers ............................................................................................ 46
5-1. Alarm Manager Default Menu Bars ............................................................................ 56
5-2. Alarm Manager Default Buttons ................................................................................. 57
5-3. Alarm Manager Pop-Up Menus .................................................................................. 57

vii
B0700AP Rev A Tables

viii
Preface

Purpose
This document describes the Alarm Manager commands and keywords and Alarm Server Task
commands available with the I/A Series system.

Revision Information
For Release 8.0, this is the initial version of the document. Information was taken from Chapter 2
of I/A Series Workstation Alarm Management (B0193RV, Rev E) and substantially updated and
expanded.

Reference Documents
Workstation Alarm Management (B0700AT)
Alarm and Display Manager Configurator (ADMC) (B0700AM)
Display Engineering for FoxView Software and Display Manager Software
(B0193MQ)
FoxPanels Annunciator Keyboard and Alarm Panel Software (B0700BB).

Conventions
The following conventions are used in the command syntax in this document:
Arguments within square brackets [ ] are optional.
Arguments that appear in italics are replaced by values listed in the Input section.
A vertical line ( | ) indicates OR. For example, a | b means a or b.
Braces { } delimit a set of choices from with the user must choose one.
In all cases, the command syntax in the Syntax section is one continuous string (no
embedded carriage returns).
Multiple commands are separated with semicolons.

ix
B0700AP Rev A Preface

x
1. Introduction
This chapter provides an overview of the Alarm Management commands and keywords.

Alarm Manager Commands and Keywords


Alarm Manager (AM) commands and keywords are used to access information from alarm mes-
sages in other applications. They extend Alarm Manager functionality and facilitate a link from
the Alarm Manager to your own applications to meet your plant-specific needs.

Alarm Manager Commands


You can issue Alarm Manager built-in commands from a configurator, such as the Alarm and Dis-
play Manager Configurator (ADMC), or from a command line. You typically use Alarm Manager
(AM) commands to:
Use information from alarm messages in other applications
Configure button actions, menu items, and new alarm actions
Call up operator instructions for a selected alarm from a user-defined alarm response
manual application
Select a point in alarm and automatically trend the point.
Refer to Chapter 2 Alarm Manager Commands for AM command descriptions.

Alarm Manager Keywords


Use keywords and modifiers to configure the content of each alarm type message. At run time, the
Alarm Manager replaces keywords with text copied and derived from the corresponding fields in
the alarm messages generated by the control software.
Keywords are delimited by < and > and correspond to data in the alarm message. The set of valid
keywords varies by alarm type.
Refer to Chapter 3 Alarm Manager Keywords for AM keyword descriptions.

Alarm Server Task Commands


The Alarm Server Task (AST) is responsible for responding to annunciator key presses or soft
alarm panel button presses. It follows directions configured in the AApan file.
You can use Alarm Server Task commands on Windows based and Solaris based workstations to
redirect output when an annunciator keyboard or a soft panel button is pressed. Using AST com-
mands you can:
Add an assignment (definition) to AST memory
Clear alarm panel definitions from AST memory
Print (save) panel definitions to a file for future use
Load an alarm panel definition file to AST memory.
Refer to Chapter 4 Alarm Server Task Commands for AST command descriptions.

1
B0700AP Rev A 1. Introduction

2
2. Alarm Manager Commands
This chapter describes the Alarm Manager (AM) commands.

Format
Each command description provides the following information:
Category Contents
Syntax Syntax for the command, including any options and arguments.
Description Brief description of the command.
Input Any input to the command. This is usually a description of the options and
arguments.
Output Result of the command execution. This is usually a change to the display.
Usage List of menu items and buttons in the default interface. These items are precon-
figured to use the command. This section also indicates whether or not the com-
mand can be used with the pref command.
Examples Examples with an explanation of the output.

Pref Command Syntax


The Alarm Manager commands are used primarily in configuring menu items and buttons on the
alarm displays. Similar to the display managers built-in language, the $ expansion of variables is
supported. Many of these commands can be executed from the command prompt using the pref
command. The syntax for pref is:
pref -amname amcmd cmdlist
where:
amname Name of the target Alarm Manager
amcmd Keyword indicating that this is an Alarm Manager command
cmdlist Semicolon-separated list of AM commands. The list must be
enclosed in double quotes.

For more information, refer to Display Engineering for FoxView Software and Display Manager
Software (B0193MQ).
The following example shows how to use Alarm Manager commands to print alarms from a
display.
This first command selects the alarm display:
pref -AMNAME amcmd "setdisp NEWALM"
This second command issues the print request:
pref -AMNAME amcmd "print"

3
B0700AP Rev A 2. Alarm Manager Commands

Command Summary
Table 2-1 provides a quick reference summary of the AM commands. The commands are grouped
functionally and include a brief description and page number reference for a complete
description.

Table 2-1. Alarm Manager Command Summary

Category Command Description Details


AM almdisp Calls up the specified display (CAD, AHD, OPR, page 13
Displays for example) with possible matching and filtering.
detail_alm Calls up the Alarm Detail display for the selected page 17
alarm.
dismiss Dismisses the active alarm display. By default, the page 18
last AM window of the letterbug-named AM can-
not be dismissed.
exit Terminates the AM. By default, the letterbug- page 19
named AM cannot be exited.
hide Hides the specified display component (for exam- page 21
ple, button area) on the associated alarm display.
minimize Minimizes (iconizes) the active or specified alarm page 25
display.
pause Pauses the alarm updates to the associated CAD or page 28
MRA.
quitam Enables or disables the ability to exit from (quit) an page 31
Alarm Manager. Usually used in an AM script.
refresh Refreshes the alarm display with the latest set of page 32
alarms.
setdisp Sets the current display for future AM commands. page 37
Usually used in an AM script.
show Shows the specified display component (for exam- page 39
ple, button area) on the associated alarm display.
unpause Resumes the alarm updates to the associated CAD page 41
or MRA.
FoxView blk_dtl Calls up the Block Detail display on the associated page 14
Displays FoxView display manager for the selected alarm.
send_to_dm Sends the specified command to the associated page 35
FoxView.
top_prio Calls up the user graphic or detail display associ- page 40
ated with the highest priority alarm on a FoxView
display.
user_disp Calls up a user graphic on the associated FoxView page 43
for the selected alarm.

4
2. Alarm Manager Commands B0700AP Rev A

Table 2-1. Alarm Manager Command Summary (Continued)

Category Command Description Details


Alarm deselect Deselects all previously selected alarms. page 17
Selection find Displays the Find Alarms dialog box, which allows page 20
the operator to locate and select specific alarms on
the alarm display.
select Selects all the alarms on the associated display. For page 34
the CAD only the visible alarms are selected.
Acknowledge ackalm Acknowledges all process alarms in the selected page 11
Alarms Compound:Block(s).
ackcmp Acknowledges all process alarms in the selected page 11
Compound(s).
ackpage Acknowledges all process alarms for all page 12
Compound:Block(s) on the display page.
ackpage_cmp Acknowledges all process alarms for all Com- page 12
pound(s) on the display page.
Clear Alarms clear_alm Clears the select alarm(s) from the display and the page 16
AA database of the local workstation and any other
workstation within its CAGs.
clear_page Clears all the alarms on the current page from the page 16
display and the AA database of the local worksta-
tion and any other workstation within its CAGs.
Navigation page Allows paging through an alarm list (for example, page 27
first page, last page, next page, previous page, spe-
cific page number).
scroll_by_time Scrolls the active alarm display, forward or back- page 34
ward, by a time interval in minutes. Only available
when the primary sort criteria is time.
Match, Filter, match Applies matching, filtering, and sorting to the page 24
Sort alarm display. Criteria may be selected from the
Match dialog box or specified in a file.
match_ts Displays a touchscreen-enabled dialog box for page 25
selecting match and sort criteria. More restricted
than match.
stop_match Clears the current match criteria from the display. page 40
view_all Enters or exits the View All mode, which shows all page 43
alarms in the database regardless of matching or fil-
tering criteria. Available on summary displays only.

5
B0700AP Rev A 2. Alarm Manager Commands

Table 2-1. Alarm Manager Command Summary (Continued)

Category Command Description Details


Horns mute_all_horns Disables the sounding of the alarm horns at all page 26
workstations in the CAG.
mute_horns Disables the sounding of the alarm horns for the page 26
local workstation only.
silence_horns Silences the alarm horns on the local workstation page 39
or all workstations in the CAG.
unmute_all_ Enables the sounding of the alarm horns at all page 41
horns workstations in the CAG.
unmute_horns Enables the sounding of the alarm horns for the page 41
local workstation only.
Printing page_setup (Windows only) Calls up the AM Page Setup dia- page 28
log box to setup the page layout, headers, and foot-
ers in preparation for printing.
print Calls up a print dialog to print from the alarm dis- page 29
play. Options are available for using a standard
header and a default printer.
print_cancel From a CAD, cancels a print request that is in page 29
progress.
print_preview (Windows only) Displays a preview of what will be page 30
printed. This command is not available on the
CAD, MRA, or OPR displays.
print_setup (Windows only) Calls up the standard Windows page 30
Print Setup dialog box.
Saving to File save_cancel Cancels saving to a file from the CAD. page 32
save_to_file Saves the contents of the associated alarm display page 33
to a file in either text or CSV format.
Alarm hist_file Displays alarm messages on the AHD from a spec- page 22
History ified archived historian.
historian Selects an alternate historian. The historian may be page 22
selected from the Historian Selection dialog box.
historian_ts Displays a touchscreen-enabled dialog box for page 23
selecting a historian.

6
2. Alarm Manager Commands B0700AP Rev A

Table 2-1. Alarm Manager Command Summary (Continued)

Category Command Description Details


Security chngenv Changes the AM environment. page 15
disable Disables specific AM functions, namely acknowl- page 18
edging alarms, clearing alarms, and horn opera-
tions. All or some of the functions can be disabled.
enable Enables specific AM functions, namely acknowl- page 19
edging alarms, clearing alarms, and horn opera-
tions. All or some of the functions can be enabled.
ojinit Reads the updated OAJ logging directives. Usually page 27
used in an AM script.
protect Adds the specified access key lock protections. page 31
setacl Sets access key locks to be protected, unprotected, page 37
or unchanged.
unprotect Removes the specified access key lock protections. page 42
Environment getenv Sets a variable to the value of an environment vari- page 20
Variables able. Usually used in an AM script.
setenv Sets an environment variable to a specified value. page 38
Usually used in an AM script.
setenv_default Resets an environment variable to its default value. page 38
Usually used in an AM script.
Help about Displays the AM About dialog box. page 10
help Displays the topic listing for the AM Help file. page 21
Miscellaneous = Assignment operator. Usually used in an AM page 9
Commands script.
== Equality operator. Usually used in an AM script. page 10
!= Inequality operator. Usually used in an AM script. page 9
run Executes the specified program or script. page 32
script Executes the specified AM script containing other page 33
AM built-in commands.
set_alarm_ Sets the primary and/or backup alarm data source page 36
source for the active AM. The Set Alarm Source dialog
box may be used to enter the alarm data sources.

7
B0700AP Rev A 2. Alarm Manager Commands

Command Reference
The remainder of this chapter lists the AM commands and describes their syntax and use.

NOTE
The display names that can be used in place of disp are MRA, CAD, NEWALM,
UNACK, ACKED, AHD and OPR. Commands without a disp parameter are
performed on the initial alarm display or the active display set with the setdisp
command.

8
2. Alarm Manager Commands B0700AP Rev A

!= (Inequality)
Syntax: != value1 value2 command

Description: Inequality operator. Compares value1 to value2; if not equal, executes


command. Usually used in an AM script.

Input: Arguments and descriptions:


value1 First value used in the comparison.
value2 Second value used in the comparison.
command AM command to be executed if the values are not
equal.

Output: Dependent on the result of command.

Usage: Menu Bar, Pop-up Menu, Button: N/A


Use with the pref command?: Yes (depending on command)

Example: != $AM_LOCAL N amcmd unprotect value 100

= (Assignment)
Syntax: = wp-var value

Description: Assignment operator. Sets the variable wp-var to value. Usually used in
an AM script.

Input: Arguments and descriptions:


wp-var Name of the workstation variable.
value Value to be assigned to the workstation variable.

Output: No output. Use getenv to verify the set.

Usage: Menu Bar, Pop-up Menu, Button: N/A


Use with the pref command?: Yes

Example: = AMCMD

9
B0700AP Rev A 2. Alarm Manager Commands

== (Equality)
Syntax: == value1 value2 command

Description: Equality operator. Compares value1 to value2; if equal, executes


command. Usually used in an AM script.

Input: Arguments and descriptions:


value1 First value used in the comparison.
value2 Second value used in the comparison.
command AM command to be executed if the values are equal.

Output: Dependent on the result of command.

Usage: Menu Bar, Pop-up Menu, Button: N/A


Use with the pref command?: Yes (depending on command)

Example: == $AM_LOCAL N amcmd protect value 100

about
Syntax: about

Description: Displays the Alarm Manager About dialog box.

Input: None

Output: Displays Alarm Manager information in the About dialog box.

Usage: Menu Bar: Help > About Alarm Manager


Use with the pref command?: Yes

10
2. Alarm Manager Commands B0700AP Rev A

ackalm
Syntax: ackalm

Description: Acknowledges the selected process alarm(s) and all alarms in the same
block(s) as one of the selected alarms.

Input: Select alarm or alarms from the display.

Output: The alarm acknowledgement indicators, such as blinking or color, revert


to their acknowledged alarm states.

Usage: Pop-Up Menu: Ack Alarm


Button: Ack Alarm
Use with the pref command?: Not normally unless an alarm is selected on
the display first

ackcmp
Syntax: ackcmp

Description: Acknowledges the compounds of the selected alarms.

Input: Select alarm or alarms from the display.

Output: The alarm acknowledgement indicators, such as blinking or color, revert


to their acknowledged alarm states.

Usage: Button: Ack Cmp


Use with the pref command?: Not normally unless an alarm is selected on
the display first

11
B0700AP Rev A 2. Alarm Manager Commands

ackpage
Syntax: ackpage [disp]

Description: Acknowledges all process alarms on the current page of the display, disp.
The default display is the CAD.

Input: Argument and description:


disp Alarm display type (MRA, CAD, NEWALM, UNACK,
ACKED, or AHD)

Output: The alarm acknowledgement indicators, such as blinking or color, revert


to their acknowledgement alarm states.

Usage: Pop-up Menu: Ack Page


Button: Ack Page
Use with the pref command?: Yes

Example: ackpage CAD

ackpage_cmp
Syntax: ackpage_cmp [disp]

Description: Acknowledges the compounds on the current page of the display, disp.

Input: Argument and description:


disp Alarm display type (MRA, CAD, NEWALM, UNACK,
ACKED, or AHD)

Output: The alarm acknowledgement indicators, such as blinking or color, revert


to their acknowledgement alarm states.

Usage: Use with the pref command?: Yes

Example: ackpage_cmp CAD

12
2. Alarm Manager Commands B0700AP Rev A

almdisp
Syntax: almdisp disp [-match filename] [-stop_match] [-refresh]
[-historian histname]

Description: Presents the alarm display specified by disp with possible matching and
filtering. For the AHD, the historian name can be specified. (Note: This
does not start up the AM; at least one alarm display must already be
active.) In addition, the alarm display is subject to the following:
Display State Action
Inactive Initiates the display and brings it to the foreground
on the screen.
Obscured Brings the display to the foreground on the screen.
Minimized (Solaris) Opens the display and brings it to the
foreground on the screen.
(Windows) Highlights the display.

Input: Arguments and descriptions:


disp Display type (MRA, CAD, NEWALM,
UNACK, ACKED, AHD or OPR) to ini-
tiate. The default display is the CAD.
match filename Apply matching to the display at activation.
Match specification file located in
filename. If not fully specified, the
filename is /usr/fox/customer/alarms
/amspec/filename.ams by default.
stop_match Turns off the matching associated with the
display, if active. Otherwise, do nothing.
refresh Refresh the display, if active. Otherwise, do
nothing.
historian histname (AHD only) Specifies which historian to
read the historical alarms from.

Output: Initiates the named alarm displays with possible matching and new
historian (AHD only).

13
B0700AP Rev A 2. Alarm Manager Commands

Usage: Menu Bar:


Displays > Current Alarms
Displays > Most Recent Alarms
Displays > New Alarm Summary
Displays > Unacknowledged Alarm Summary
Displays > Acknowledged Alarm Summary
Displays > Alarm History
Displays > Operations
Pop-up Menu: Most Recent Alarms
Use with the pref command?: Yes

Examples: almdisp CAD -match /usr/fox/customer/alarms/amspec/prio1.ams


almdisp AHD -historian hist01

blk_dtl
Syntax: blk_dtl

Description: Calls up the Block Detail display for the selected alarm on the associated
FoxView. If more than one alarm is selected, the command is applied to
the first alarm only.

Input: Select an alarm from the display.

Output: The Block Detail display for the selected process alarm is presented in the
associated FoxView.

Usage: Pop-up Menu: Block Detail


Button: Block Detail
Use with the pref command?: Not normally unless an alarm is selected on
the display first

14
2. Alarm Manager Commands B0700AP Rev A

chngenv
Syntax: chngenv [env-name]

Description: Changes to the environment identified by env-name, subject to the


following:
If no environment name is specified, then an environment selec-
tion dialog box appears with the directory root specified as
/opt/fox/env. The dialog box lists the available environment files
from that directory. The operator can then select the environment
from the pop-up dialog box. This is the default behavior of the
Environments button on the Operations display.
If the environment file name is relative, then the default environ-
ment directory /opt/fox/env is used.
If the environment file name is actually a directory name, then an
environment selection dialog box appears with the specified direc-
tory as the directory root. The dialog box lists the available
environment files from that directory. The operator can then select
the environment from the dialog box.
If the specified or selected environment is password-protected, the
operator must supply the password in the dialog box. If the pass-
word is verified as correct the environment is entered; otherwise it
is not.

Input: Argument and description:


env-name Name of the environment file or name of a directory
containing environment files.

Output: Updates the active environment name on the alarm displays. Menu items
and button selections may change if permissions change with the new
environment.

Usage: Button: Environments


Use with the pref command?: Yes

Examples: chngenv /opt/fox/env/operator.env


chngenv

15
B0700AP Rev A 2. Alarm Manager Commands

clear_alm
Syntax: clear_alm

Description: Clears the selected alarms or events from the display and the AA database.
If the workstation is a member of a Common Alarm Group (CAG), the
selected alarms are also cleared from all other workstations that are mem-
bers of the CAG.

Input: Select alarm or alarms from the display.

Output: The selected alarms are cleared from all active alarm displays on the work-
station (or all workstations throughout the CAG, if appropriate).

Usage: Button: Clear Alarm


Use with the pref command?: Not normally unless an alarm is selected on
the display first

clear_page
Syntax: clear_page [disp]

Description: Clears all the alarms or events in the alarm window from the display and
the AA database. If the workstation is a member of a Common Alarm
Group (CAG), the selected alarms are also cleared from all other worksta-
tions that are members of the CAG.
If disp is not specified, the command defaults to the active display.

Input: Argument and description:


disp Alarm display type (MRA, CAD, NEWALM, UNACK,
ACKED, or AHD)

Output: The alarms on the current page are cleared from all active alarm displays
on the workstation (or all workstations throughout the CAG, if
appropriate).

Usage: Button: Clear Page


Use with the pref command?: Yes

Example: clear_page UNACK

16
2. Alarm Manager Commands B0700AP Rev A

deselect
Syntax: deselect

Description: Deselects the previously selected alarms.

Input: Previously selected alarm or alarms from the display.

Output: Previously selected alarms, which are visually highlighted, are no longer
highlighted.

Usage: Menu Bar: Edit > Deselect All


Use with the pref command?: Yes. Use the setdisp command first.

detail_alm
Syntax: detail_alm

Description: Invokes the Alarm Detail display for the selected alarm. If more than one
alarm is selected, the command is applied to the first selected alarm. This
command is used for process and event messages.

Input: Select alarm from the display.

Output: Alarm Detail display showing the alarm detail information for the selected
alarm.

Usage: Pop-up Menu: Alarm Detail


Double-click: default action
Button: Alarm Detail
Use with the pref command?: Not normally unless an alarm is selected on
the display first

17
B0700AP Rev A 2. Alarm Manager Commands

disable
Syntax: disable flist

Description: Prevents the Alarm Manager from performing the specified functions.
Usually used in an AM script.

Input: flist is a list of functions to be disabled. Valid parameter values are:


ack Alarm acknowledgement
clear Alarm clearing
horns Silence/mute/unmute horns
all All functions

Output: All actions associated with the disabled functions are dimmed
(unselectable).

Usage: Menu Bar, Pop-up Menu, Button: N/A


Use with the pref command?: Yes

Examples: disable ack clear


disable all

dismiss
Syntax: dismiss

Description: Dismisses the associated alarm display. All OM connections are closed and
the alarm display is removed from the screen. If the display is recalled, it
retains many of the characteristics, such as size, that it had before it was
dismissed.
By default, the last AM window cannot be dismissed.

Input: Currently active alarm display.

Output: Alarm display is removed from the screen.

Usage: Menu Bar: File > Dismiss


Windows Menu: Close
Use with the pref command?: No

18
2. Alarm Manager Commands B0700AP Rev A

enable
Syntax: enable flist

Description: Allows the Alarm Manager to perform the specified functions in the func-
tion list, flist. Usually used in an AM script.

Input: flist is a list of functions to be enabled. Valid parameter values are:


ack Alarm acknowledgement
clear Alarm clearing
horns Silence/mute/unmute horns
all All functions

Output: All actions associated with the enabled functions are selectable.

Usage: Menu Bar, Pop-up Menu, Button: N/A


Use with the pref command?: Yes

Examples: enable ack clear


enable all

exit
Syntax: exit [exit-num] [originator]

Description: Terminates the AM (provided the AM is quittable). If this is the last alarm
display active, the AM prompts the operator before exiting. All OM con-
nections are closed. This is available through the Operations display.

Input: Arguments and descriptions:


exit-num Exit code with which the AM exits.
originator Text string specifying the originator of the exit
request.

Output: All Alarm Manager windows are closed.

Usage: Menu Bar: File > Exit


Use with the pref command?: Yes

Example: exit -5

19
B0700AP Rev A 2. Alarm Manager Commands

find
Syntax: find

Description: Displays the Find Alarms dialog box, which allows the operator to locate
specific alarms on the associated alarm display.

Input: None

Output: The Find Alarms dialog box is displayed on the workstation screen.
When the find is applied, alarms matching the find criteria are selected.
Selected alarms are visually highlighted with a yellow surrounding box.

Usage: Menu Bar: Edit > Find Alarms


Use with the pref command?: Yes (Use the setdisp command first.)

getenv
Syntax: getenv env-var wp-var

Description: Sets the workstation variable wp-var to the value of the environment vari-
able env-var. Usually used in an AM script.

Input: Arguments and descriptions:


env-var Name of the environment variable to be read.
wp-var Name of the workstation variable to be set.

Output: None

Usage: Menu Bar, Pop-up Menu, Button: N/A


Use with the pref command?: Yes

Example: getenv CADTP CADTP

20
2. Alarm Manager Commands B0700AP Rev A

help
Syntax: help

Description: Displays the topic listing for the AM Help file.

Input: None

Output: First page of the AM Help file.

Usage: Menu Bar: Help > Help Topics


Use with the pref command?: Yes

hide
Syntax: hide {MenuBar | Title | ButtonArea | StatusArea}

Description: Hides the specified display component on the associated alarm display.

Input: Currently active alarm display. The following components can be hidden:
MenuBar Hide the menu bar located at the top of the display (that
is, File View Display).
Title Hide the title bar located near the top of the
display (that is, time/date, display title, New Alarms).
ButtonArea Hide the buttons located below the alarm messages (for
example, Ack Alarm, Top Prio, Block Detail).
StatusArea Hide the status bar at the bottom of the display (for
example, Match Active, Horn Muted).

Output: The specified component is hidden (removed) from the display.

Usage: Menu Bar: View > Hide Controls


Use with the pref command?: Yes (Use the setdisp command first.)

Examples: hide MenuBar


hide StatusArea

21
B0700AP Rev A 2. Alarm Manager Commands

hist_file
Syntax: hist_file filename

Description: Reads and presents the specified archived history file filename at the
Alarm History Display. Allows you to display alarms that were previously
archived and removed from the historian database.

Input: Argument and description:


filename Name of the historian archive file to use as an alarm
source.

Output: Alarm messages are displayed to the AHD display from the named histo-
rian archive file.

Usage: Use with the pref command?: Yes

Example: hist_file Q1_2002

historian
Syntax: historian [histname]

Description: Selects an alternate historian instance, subject to the following:


If no historian name is specified, a dialog box is displayed with a
list of available historian names. The operator can then select the
historian from the list.
If a historian name is specified, it becomes the selected historian.
The selected historian instance is used as the source of historized
alarms for the associated AHD display.
All historians use AIM*History.

Input: Argument and description:


histname Name of the historian to use as an alarm source.

Output: Alarm messages are displayed to the AHD display from the named
historian.

Usage: Button: Historian


Use with the pref command?: Yes

Examples: historian hist01


historian

22
2. Alarm Manager Commands B0700AP Rev A

historian_ts
Syntax: historian_ts [histname]

Description: Selects an alternate historian instance with a dialog box for touchscreen,
subject to the following:
If no historian name is specified, a dialog box is displayed with a
list of available historian names. The operator can then select the
historian from the list.
If a historian name is specified, it becomes the selected historian.
The selected historian instance is used as the source of historized
alarms for the associated AHD display.
All historians use AIM*History.

Input: Argument and description:


histname Name of the historian to use as an alarm source.

Output: Alarm messages are displayed to the AHD display from the named
historian.

Usage: Use with the pref command?: Yes

Examples: historian_ts hist01


historian_ts

23
B0700AP Rev A 2. Alarm Manager Commands

match
Syntax: match [filename]

Description: Names a file containing the matching and filtering specifications to be


applied to the associated alarm display, subject to the following:
If no file name is specified, then a Match/Filter dialog box is dis-
played allowing the operator to configure, apply, and clear alarm
matching and filtering for the associated alarm display.
If a file name is specified, the alarm match/filter specification
described in the file is applied to the associated alarm display.
If the file name is relative, then the default directory /usr/fox
/customer/alarms/amspec is used.

Input: Argument and description:


filename Name of the match/filter specification file.

Output: The Match/Filter dialog box is displayed.


When the match is applied, the alarm messages displayed change to reflect
the matching and filtering selected.

Usage: Menu Bar: View > Match Alarms


Use with the pref command?: Yes (Use the setdisp command first.)

Examples: match
match /usr/fox/customer/alarms/amspec/HIABS.ams

24
2. Alarm Manager Commands B0700AP Rev A

match_ts
Syntax: match_ts [filename]

Description: Names a file containing the matching and filtering specifications to be


applied to the associated alarm display with a dialog box for touchscreen,
subject to the following:
If no file name is specified, then a Touch Screen Match dialog box
is displayed allowing the operator to configure, apply, and clear
alarm matching and filtering for the associated alarm display.
If a file name is specified, the alarm match/filter specification
described in the file is applied to the associated alarm display.
If the file name is relative, then the default directory /usr/fox
/customer/alarms/amspec is used.

Input: Argument and description:


filename Name of the match/filter specification file.

Output: The Touch Screen Match dialog box is displayed.


When the match is applied, the alarm messages displayed change to reflect
the matching and filtering selected.

Usage: Use with the pref command?: Yes (Use the setdisp command first.)

Examples: match_ts
match_ts /usr/fox/customer/alarms/amspec/BOILER1.ams

minimize
Syntax: minimize [disp]

Description: Minimizes (iconizes) the associated alarm display. If no display is specified,


the current active display is minimized.

Input: Argument and description:


disp Display type (MRA, CAD, NEWALM, UNACK, ACKED,
AHD or OPR) to minimize.

Output: Minimizes the specified display type.

Usage: Menu Bar: File > Minimize


Windows Menu: Minimize
Use with the pref command?: Yes

Example: minimize ACKED

25
B0700AP Rev A 2. Alarm Manager Commands

mute_all_horns
Syntax: mute_all_horns

Description: Disables the sounding of the alarm horns at the workstation, all worksta-
tions in the CAG (if configured), and all external horns. Available from
the Operations display.
You can configure a time-out for mute commands. By default there will
be no time-out. When the external horn time-out expires, the horns will
resume sounding as new alarm messages are received.

Input: None

Output: Any horns sounding at the workstation or throughout the CAG, and
external horns are silenced and prevented from sounding again until an
unmute_all_horns command is received. Horns at an individual worksta-
tion also begin sounding again when an unmute_horns command is
received for the workstation.

Usage: Menu Bar: Horns > Mute CAG Horns


Use with the pref command?: Yes

mute_horns
Syntax: mute_horns

Description: Disables the sounding of the alarm horns at the workstation and external
horns. Available from the Operations display.
You can configure a time-out for mute commands. By default there will
be no time-out. When the external horn time-out expires, the horns will
resume sounding as new alarm messages are received.

Input: None

Output: Any horns sounding at the workstation and any external horns are
silenced and prevented from sounding again until an unmute_horns or
unmute_all_horns command is received.

Usage: Menu Bar: Horns > Mute Horns


Use with the pref command?: Yes

26
2. Alarm Manager Commands B0700AP Rev A

ojinit
Syntax: ojinit

Description: Re-reads OJLOG to get updated logging directives. OJLOG is a common


file used by the AM and FoxView containing directives on which operator
actions are to be logged. Usually used in an AM script.

Input: None

Output: None

Usage: Menu Bar, Pop-up Menu, Button: N/A


Use with the pref command?: Yes

page
Syntax: page page-spec

Description: Allows the operator to page through the alarm list. With no page-spec
specified, the command displays the Go To Page dialog box.

Input: page-spec can be:


num Go to the specified page.
+num Page forward num pages.
num Page backward num pages.
last Go to the last page.

Output: The set of alarm messages visible on the display changes to reflect the pag-
ing specified.

Usage: Menu Bar: View > Go To Page


Scroll Bars: Up/Down
Use with the pref command?: Yes

Examples: page 1
page last
page 32
page +5
page -3

27
B0700AP Rev A 2. Alarm Manager Commands

page_setup
Syntax: page_setup

Description: (Windows only) Invokes the AM Page Setup dialog box. This dialog box
allows for the setup of the page layout and headers and footers in prepara-
tion for printing.

Input: None

Output: The Page Setup dialog box is displayed on the workstation screen.

Usage: Menu Bar: File > Page Setup


Use with the pref command?: Yes. (Use the setdisp command first.)

pause
Syntax: pause

Description: Pauses the alarm updates to the associated CAD or MRA.


You can configure a time-out for pause commands. By default there will
be no time-out. When the pause time-out expires, the AM display will
resume updating with new alarm messages.

Input: None

Output: Updates to the associated display are stopped and PAUSED is illuminated,
in red, in the status area.

Usage: Pop-up Menu: Pause


Use with the pref command?: Yes. (Use the setdisp command first.)

28
2. Alarm Manager Commands B0700AP Rev A

print
Syntax: print [-standard_header] [-default_printer]

Description: (Windows) Invokes the standard Windows Print dialog box allowing the
operator to select the printer and choose various print options.
(Solaris) Prints the alarm entries or a saved file to the system printer. An
AM dialog box is displayed that allows the operator to choose:
Whether to print a file or to print the alarm entries on the associ-
ated display.
The name of the system printer.
An optional print script.

Input: Options and descriptions:


standard_header Include a standard, default header in the
alarm printout.
default_printer Forward the printout to the default printer,
bypassing the printer selection dialog box.

Output: The Print dialog box is displayed. Alarm entries or the contents of a file
printed on the printer.

Usage: Menu Bar: File > Print


Use with the pref command?: Yes. (Use the setdisp command first.)

Examples: print
print -standard_header -default_printer

print_cancel
Syntax: print_cancel

Description: Cancels printing from the Current Alarm Display.

Input: None

Output: None

Usage: Use with the pref command?: Yes

29
B0700AP Rev A 2. Alarm Manager Commands

print_preview
Syntax: print_preview

Description: (Windows only) Allows a screen preview of the printed report to be


viewed on the workstation screen. This command is not available on the
CAD, MRA, or OPR displays.

Input: Alarm messages from the currently active alarm display.

Output: Presents a screen preview of the printed report.

Usage: Menu Bar: File > Print Preview


Use with the pref command?: Yes

print_setup
Syntax: print_setup

Description: (Windows only) Invokes the standard Windows Print Setup dialog box
allowing the operator to select a printer and choose options such as the
number of copies and the paper orientation. This command does not
interact with the alarm printers.

Input: None

Output: Display the Windows Print Setup dialog box on the workstation screen.

Usage: Menu Bar: File > Print Setup


Use with the pref command?: Yes

30
2. Alarm Manager Commands B0700AP Rev A

protect
Syntax: protect {all | value spec | name list}

Description: Protects the specified access key locks. This command has the same syntax
and meaning as the FoxView protect command. Usually used in an AM
script.

Input: Arguments and descriptions:


all All access levels are affected.
value spec List of access levels affected, where spec is a comma-
separated list of individual access levels and/or ranges
(for example, 1,7,12-19,32). The list should contain
no white space characters; if it does, it must be
enclosed in double quotes.
name list List of action names to protect, where list is a
comma-separated list of names. Names starting with
a period (for example, .OUT) indicate that all action
names ending with the string are affected.

Output: None

Usage: Menu Bar, Pop-up Menu, Button: N/A


Use with the pref command?: Yes

Examples: protect all


protect 16,32-63,128

quitam
Syntax: quitam {on | off}

Description: Enables/disables the ability to exit from (quit) an Alarm Manager. Usually
used in an AM script.

Input: Arguments and descriptions:


on Enable quitting.
off Disable quitting.

Output: None

Usage: Menu Bar, Pop-up Menu, Button: N/A


Use with the pref command?: Yes

Examples: quitam on
quitam off

31
B0700AP Rev A 2. Alarm Manager Commands

refresh
Syntax: refresh

Description: Refreshes the alarm display with the latest set of alarms. This is useful to
get the latest snapshot of the alarm database on the summary displays or
the MRA display.

Input: Currently active alarm display.

Output: Display is refreshed with the latest alarms.

Usage: Menu Bar: View > Refresh


Pop-up Menu: Refresh
Use with the pref command?: Yes. (Use the setdisp command first.)

run
Syntax: run prog [arg-list]

Description: Executes the specified program with the specified arguments.

Input: Arguments and descriptions:


prog Full pathname to the program to be executed.
arg-list List of arguments to the program. If keywords are
used, the arguments are copied or derived from the
selected alarm.

Output: Dependent on the program being executed.

Usage: Menu Bar, Pop-up Menu, Button: N/A


Use with the pref command?: Yes

Example: run C:\Program Files\Windows NT\Accessories\wordpad.exe


\tmp\<Compound>-<Block>.<AlarmType>

save_cancel
Syntax: save_cancel

Description: Cancels saving the file from the Current Alarm Display.

Input: None

Output: None

Usage: Use with the pref command?: Yes

32
2. Alarm Manager Commands B0700AP Rev A

save_to_file
Syntax: save_to_file [filename] [-format CSV]

Description: Saves the contents of the associated alarm display to a file, subject to the
following:
If no file name is specified, then a file dialog box is displayed
allowing the operator to specify a file to which the alarms are to be
saved.
If a file name is specified, the alarm messages are saved to that file.
If the file name is relative, then the default directory /usr/fox
/customer/alarms/reports is used.

Input: Arguments and descriptions:


filename Name of the file to which the alarm messages are
saved.
format CSV Save the file in CSV (comma-separated variable)
format.

Output: None

Usage: Menu Bar: File > Save


Use with the pref command?: Yes (Use the setdisp command first.)

Examples: save_to_file
save_to_file myalarms.txt
save_to_file myalarms.csv -format CSV

script
Syntax: script filename

Description: Executes the named script file that contains other AM commands.

Input: Argument and description:


filename Name of the AM script (including the full path) to
execute.

Output: The output depends on the nature of the commands contained in the
script file. May be used with pref or attached to a menu item or button.

Usage: Menu Bar, Pop-up Menu, Button: N/A


Use with the pref command?: Yes

Example: script /tmp/myam_script

33
B0700AP Rev A 2. Alarm Manager Commands

scroll_by_time
Syntax: scroll_by_time {+n |-n}

Description: Scrolls the active alarm display by a time interval of n minutes. n can be
positive or negative. If no value is specified, a default of 15 minutes is
used. Note: This command only works on displays that use time as their
primary criteria.

Input: Argument and description:


+n Number of minutes to scroll the display forward (forward
in time).
n Number of minutes to scroll the display backward (back-
ward in time).

Output: The first alarm cell on the display is one of the following:
The first alarm in the local alarm database with a time at least n
minutes earlier or later than the time associated with the previous
first alarm cell
The first or last alarm in the local alarm database.

Usage: Menu Bar, Pop-up Menu, Button: N/A


Use with the pref command?: Yes. (Use the setdisp command first.)

Examples: scroll_by_time
scroll_by_time +3600
scroll_by_time -10

select
Syntax: select

Description: Selects all the alarms in the associated display.

Input: Currently active alarm display.

Output: Each alarm on the display is highlighted.

Usage: Menu Bar: Edit > Select All


Use with the pref command?: Yes. (Use the setdisp command first.)

34
2. Alarm Manager Commands B0700AP Rev A

send_to_dm
Syntax: send_to_dm [-dm dm_name] command-list

Description: Sends the specified command to FoxView indicated by dm_name, subject


to the following:
If dm_name is not specified, FoxView defaults to the name specified
in the CADUS variable.
dm_name can be a variable, such as $GCLBUG or $DMNAME.
If command-list contains a variable to be evaluated by
FoxView, not the AM, the variable name should be preceded with
two dollar signs (for example, $$DMNAME).

Input: Option/argument and descriptions:


dm dm_name The name of the FoxView where the command
is to be sent. dm_name is the FoxView name and
can be a variable, such as $DMNAME.
command-list Built-in command(s) to be executed by the tar-
get FoxView. This is a FoxView built-in com-
mand, not an AM built-in command.

Output: Dependent on the command being executed.

Usage: Menu Bar, Pop-up Menu, Button: N/A


Use with the pref command?: Yes

Example: send_to_dm trend -name <Compound>:<Block>.<ParamName>

35
B0700AP Rev A 2. Alarm Manager Commands

set_alarm_source
Syntax: set_alarm_source [-primary ws_name] [-backup ws_name]

Description: Sets the primary and/or backup alarm data source for the active AM. Both
options specifying the alarm sources are optional. The data sources are
specified by using the workstation logical names.
set_alarm_source sets the alarm data sources associated with the active
AM, subject to the following:
If both primary and backup sources are specified, both are set
without any user interaction.
If only the primary data source is specified only it is set; the
backup data source remains unchanged and possibly unset.
If only the backup data source is specified only it is set; the pri-
mary data source remains unchanged. If the primary data source is
not set, it is set to the local workstation logical name.
If neither primary or backup data source is specified, a dialog box
is displayed from which the operator can set the data sources.

Input: Options and descriptions:


primary ws_name Option to specify the primary alarm data
source for the active AM.
backup ws_name Option to specify the backup alarm data
source for the active AM.

Output: The set of alarms displays on the alarm displays may change when the data
source changes.

Usage: Menu Bar, Pop-up Menu, Button: N/A


Use with the pref command?: Yes

Examples: set_alarm_source
set_alarm_source -primary WP0001

36
2. Alarm Manager Commands B0700AP Rev A

setacl
Syntax: setacl number access

Description: Sets access key locks to be protected, unprotected, or unchanged. This


command has the same syntax and meaning as the FoxView setacl com-
mand. Usually used in an AM script.

Input: Arguments and descriptions:


number Starting number for the access key locks (between 0
and 255)
access List of protect, unprotect, and unchanged settings for
the access key locks starting with number and incre-
menting by one for each setting. Settings are indicated
by:
+ Enable access to the key lock
Disable access to the key lock
. Leave the access to the key lock unchanged

Output: None

Usage: Menu Bar, Pop-up Menu, Button: N/A


Use with the pref command?: Yes

Examples: setacl 1 ----------


Sets a minimal access level (security access = 0) for the environment
setacl 32 .+++...--

setdisp
Syntax: setdisp [disp]

Description: Sets the current display for future AM commands. Until another display is
selected or set, all AM commands are directed to disp. The default dis-
play is the CAD.

Input: Argument and description:


disp Display type (MRA, CAD, NEWALM, UNACK, ACKED,
AHD or OPR) to make current. Usually used in an AM
script.

Output: None

Usage: Menu Bar, Pop-up Menu, Button: N/A


Use with the pref command?: Yes

Example: setdisp MRA

37
B0700AP Rev A 2. Alarm Manager Commands

setenv
Syntax: setenv var value

Description: Sets an environment variable (var) to a value. Usually used within an AM


script.

Input: Arguments and descriptions:


var The name of the environment variable to be set.
value The value to which the variable is set.

Output: None

Usage: Menu Bar, Pop-up Menu, Button: N/A


Use with the pref command?: Yes

Example: setenv MYAM AM001

setenv_default
Syntax: setenv_default var

Description: Resets an environment variable to its default value. The default value is
the value configured for a read-only workstation variable having the same
name as the environment variable. Usually used within an AM script.

Input: Argument and description:


var The name of the environment variable to be set.

Output: None

Usage: Menu Bar, Pop-up Menu, Button: N/A


Use with the pref command?: Yes

Example: set_default ENV

38
2. Alarm Manager Commands B0700AP Rev A

show
Syntax: show {MenuBar | Title | ButtonArea | StatusArea}

Description: Shows the specified display component on the associated alarm display.

Input: Currently active alarm display. The following components can be shown:
MenuBar Show the menu bar located at the top of the display
(that is, File View Display).
Title Show the title area located near the top of the display
(that is, time/date, display title, New Alarms).
ButtonArea Show the buttons located below the alarm messages
(such as Ack Alarm, Top Prio, or Block Detail).
StatusArea Show the status area at the bottom of the display (such
as Match Active or Horn Muted).

Output: The specified component is redisplayed.

Usage: Pop-up Menu: Show Controls


Use with the pref command?: Yes. (Use the setdisp command first.)

Examples: show Title


show ButtonArea

silence_horns
Syntax: silence_horns

Description: Silences the horns at the workstation, all workstations in the CAG (if con-
figured), and all external horns. Available from the Operations display.

Input: None

Output: Horns are silenced.

Usage: Menu Bar: Horns > Silence Horns


Use with the pref command?: Yes

39
B0700AP Rev A 2. Alarm Manager Commands

stop_match
Syntax: stop_match

Description: Clears the current match specification from the display.

Input: Currently active alarm display.

Output: All alarm messages for the alarm display are presented.

Usage: Match dialog box: Stop


Use with the pref command?: Yes. (Use the setdisp command first.)

top_prio
Syntax: top_prio

Description: Calls up the user graphic or detail display on the associated FoxView. The
graphic displayed is the one associated with the highest priority alarm.
Optionally sets the LIA_CB global variable to the associated FoxView.
The criteria for determining the highest priority alarm is configurable as
one of the following:
The newest highest priority alarm (default)
The oldest highest priority alarm.
Note: In order to call up a user graphic, the mapping from alarm to
graphic must be configured in the alarm table and alarm panel configura-
tion files. For more information, refer to FoxPanels Annunciator Keyboard
and Alarm Panel Software (B0700BB).

Input: None

Output: The graphic is displayed on FoxView.

Usage: Pop-up Menu: Top Priority


Button: Top Priority
Use with the pref command?: Yes

40
2. Alarm Manager Commands B0700AP Rev A

unmute_all_horns
Syntax: unmute_all_horns

Description: Enables the sounding of the alarm horns at the workstation, all worksta-
tions in the CAG (if configured), and all external horns. Available from
the Operations display.

Input: None

Output: Horns begin sounding at the workstation, throughout the CAG, and
externally when alarms are received.

Usage: Menu Bar: Horns > Unmute CAG Horns


Use with the pref command?: Yes

unmute_horns
Syntax: unmute_horns

Description: Enables the sounding of the alarm horns at the workstation and external
horns. Available from the Operations display.

Input: None

Output: Horns begin sounding at the workstation and externally when alarms are
received.

Usage: Menu Bar: Horns > Unmute Horns


Use with the pref command?: Yes

unpause
Syntax: unpause

Description: Resumes the alarm updates to the associated CAD or MRA.

Input: None

Output: Updates to the associated display are resumed and PAUSED is grayed out in
the status area.

Usage: Pop-up Menu: Unpause


Use with the pref command?: Yes. (Use the setdisp command first.)

41
B0700AP Rev A 2. Alarm Manager Commands

unprotect
Syntax: unprotect {all | value spec | name list}

Description: Removes the specified access key lock protections. This command has the
same syntax and meaning as the FoxView protect command. Usually
used in an AM script.

Input: Arguments and descriptions:


all All access levels are affected.
value spec List of access levels affected, where spec is a comma-
separated list of individual access level and/or ranges
(for example, 1,7,12-19,32). The list should contain
no white space characters; if it does, it must be
enclosed in double quotes.
name list List of action names to protect, where list is a
comma-separated list of names. Names starting with a
dot (for example, .OUT) indicate that all action
names ending with the string are affected.

Output: None

Usage: Menu Bar, Pop-up Menu, Button: N/A


Use with the pref command?: Yes

Examples: unprotect value 100,107-117,141


unprotect all

42
2. Alarm Manager Commands B0700AP Rev A

user_disp
Syntax: user_disp

Description: Calls up a user graphic on the associated FoxView for the selected alarm. If
more than one alarm is selected, the command is applied to the first
selected alarm.
Note: In order to call up a user graphic, the mapping from alarm to
graphic must be configured in the alarm table and alarm panel configura-
tion files. For more information, refer to FoxPanels Annunciator Keyboard
and Alarm Panel Software (B0700BB).

Input: Select an alarm from the display.

Output: The graphic is displayed on FoxView.

Usage: Pop-up Menu: User Display


Button: User Display
Use with the pref command?: Not normally unless an alarm is selected on
the display first

view_all
Syntax: view_all {on | off}

Description: Enters or exits the view all alarms mode (all entries in the alarm database)
available on the summary displays.

Input: Arguments and descriptions:


on Enters view all mode.
off Exits view all mode.

Output: All alarms are displayed to the summary display; the title changes to
VIEW ALL MODE, and a red No Updates in the lower right-hand
corner of the display indicates no updating of values takes place while in
this mode.

Usage: Menu Bar:


View > Enable View All Mode
View > Disable View All Mode
Use with the pref command?: Yes. (Use the setdisp command first.)

Examples: view_all on
view_all off

43
B0700AP Rev A 2. Alarm Manager Commands

44
3. Alarm Manager Keywords
This chapter describes Alarm Manager keywords.
Keywords are delimited by < and > and correspond to data in the alarm message or data
derived from the alarm message. The set of valid keywords varies by alarm type. At run time, the
Alarm Manager replaces the keywords with text copied or derived from the corresponding fields
in the alarm message.

Keyword Descriptions
Table 3-1 alphabetically lists and describes the valid Alarm Manager keywords.

Table 3-1. Alarm Manager Keywords

Keyword Width Displayed As Description


AckState - Formatted indicator Acknowledged state
AlarmName 12 Text User-defined alarm text
AlarmNumber - Integer text Index of the alarm entry in the
displays alarm list
AlarmState - Formatted indicator Alarm state and Priority
AlarmType 6 Text Type of alarm, for example, HIABS
BadIO 32 Text BADIO, State, or Trip state text
Block 12 Text Block name
BlockDesc 32 Text Block description
BlockException 1 Integer text Standard block exception handler (0-5)
Case 2 Integer text Case number
Compound 12 Text Compound name
Date - Formatted string Date
DisSpc 32 Text Disable or SPC alarm text
Limit - Floating-point string Alarm limit
MMAlias 32 Text Alias for compound:block.alarmtype
Operational 4 Text Operational text for MON, EXC,
IND, DEP alarms
OptionText 32 Text User-defined optional text
ParamName 7 Text Name of the Parameter in alarm
Point 2 Integer text Boolean input Parameter number
Priority 1 Integer text Alarm Priority 1 - 5
Range 4 Text Optional text
RangeAlarm 32 Text User-defined text
SPCAlarm 6 Text SPC state text

45
B0700AP Rev A 3. Alarm Manager Keywords

Table 3-1. Alarm Manager Keywords (Continued)

Keyword Width Displayed As Description


Statement 4 Integer text Statement number
Step 3 Integer text Step number
Subroutine 3 Integer text Subroutine number
SystemTime 14 Text System-formatted time/date
Tenths 1 Integer text The tenths of a second part of the time
stamp
Time - Formatted string Time
Timeout 5 Integer text Timeout value
Units 6 Text Engineering units
Value - Floating-point string Alarm trip value

Keyword Modifiers
Keyword modifiers, listed in Table 3-2, are delimited by [ and ]. Modifiers vary by keyword.

Table 3-2. Keyword Modifiers

Keyword Field Description


Text A modifier of the form [x-y] specifies a range of characters
(from x to y) to display from the alarm message text. If no mod-
ifier is specified, the entire string is displayed.
Time and Date A modifier configures the time/date format. For example,
<time[%H:%M]> specifies the hour and minute separated by a
colon (:). Most common American and international formats
are selectable. Access to this field is provided for special-purpose
formats or local overrides of the default for the display.

Time and Date Modifiers


You can also use the time and date modifiers listed and described in Table 3-3.

Table 3-3. Time and Date Modifiers

Format
String Meaning
%a Abbreviated weekday name
%A Full weekday name
%b Abbreviated month name
%B Full month name
%c Date and time representation appropriate for locale
%d Day of month as decimal number (01 - 31)

46
3. Alarm Manager Keywords B0700AP Rev A

Table 3-3. Time and Date Modifiers (Continued)

Format
String Meaning
%H Hour in 24-hour format (00 - 23)
%I Hour in 12-hour format (01 - 12)
%j Day of year as decimal number (001 - 366)
%m Month as decimal number (01 - 12)
%M Minute as decimal number (00 - 59)
%p Current locale's A.M./P.M. indicator for 12-hour clock
%S Second as decimal number (00 - 59)
%U Week of year as decimal number (00-51), with Sunday as first day of
week
%w Weekday as decimal number (0 - 6; Sunday is 0)
%W Week of year as decimal number (00-51), with Monday as first day of
week
%x Date representation for current locale
%X Time representation for current locale
%y Year without century, as decimal number (00 - 99)
%Y Year with century, as decimal number
%z, %Z Time-zone name or abbreviation; no characters if time zone is unknown
%% Percent sign

Examples of Keyword Specifiers


Following are examples of keyword specifiers.

This Specifier Displays this Text


<Time[%H-%M-%S %p]> 05-22-56 A.M.
<BlockDesc[1-32]> Stand 4 Tension Control
<Value> <Units[1-6]> 1545 Deg. C
<BlockDesc[1-17]>-<AlarmName1-12> Laying Head Entry-Cobble
<Compound[1-12]>:<Block[1-6]> Feedwater:FIC101

47
B0700AP Rev A 3. Alarm Manager Keywords

Alarm Manager Commands That Use Keywords


Notice in the following examples how the Alarm Manager replaces keywords (Compound, Block,
ParamName, and AlarmType) with actual data when the command is invoked.

Trend Example
For example, to send a selected alarm point from an alarm display to the first trend line on the
first trend on a display manager, assign the following command to a button labeled Trend Point
on an alarm display:
send_to_dm ""trend -name <Compound>:<Block>.<ParamName>""
After having configured the Trend Point button, you can perform the trend by selecting an alarm
on the alarm display and clicking the Trend Point button.

WordPad Example
This user-supplied application is executed with the compound name, block name, and alarm type
of the selected alarm as arguments to the application. You could assign the following command to
a button labeled WordPad:
run C:\Program Files\Windows NT\Accessories\wordpad.exe
\tmp\<Compound>-<Block>.<AlarmType>
This command would open the <Compound>-<Block>.<AlarmType> file in WordPad. If the file
does not exist, an error message is displayed.

48
4. Alarm Server Task Commands
This chapter alphabetically lists and describes Alarm Server Task (AST) commands.

Overview
The Alarm Server Task (AST), which runs on Solaris based and Windows based workstations, is
responsible for responding to annunciator key presses or soft alarm panel button presses. It follows
directions configured in the AApan file.
The AST reads the AApan configuration file and directs the command, display, or program to the
appropriate display manager.
The AST has a command interface, allowing you to:
Add an assignment (definition) to AST memory
Clear alarm panel definitions from AST memory
Print (save) panel definitions to a file for future use
Load an alarm panel definition file to AST memory
You perform these actions at run time with a pref mechanism, for example:
pref -WPLBUG ascmd loadalmpnl /usr/fox/alarms/panel_cfg.new
Refer to FoxPanels Annunciator Keyboard and Alarm Panel Software (B0700BB) for usage
information.

Pref Command Syntax


The syntax for the pref command is:
pref -am_name ascmd cmdlist
where:
am_name Name of the target Alarm Manager
ascmd Keyword indicating that this is an Alarm Server Task command
cmdlist Semicolon-separated list of AM commands. The list must be
enclosed in double quotes.

For more information, refer to Display Engineering for FoxView Software and Display Manager
Software (B0193MQ).

49
B0700AP Rev A 4. Alarm Server Task Commands

Format
Each command description provides the following information:
Category Contents
Syntax Syntax for the command, including any options and arguments.
Description Brief description of the command.
Input Any input to the command. This is usually a description of the options
and arguments.
Examples Examples with an explanation of the output.

For additional information on the AST commands, refer to Command Usage and Examples on
page 52.

Command Reference
The remainder of this chapter lists the AST commands and syntax, followed by a section on usage
and examples.

addalmpnl
Syntax: addalmpnl panel key type path

Description: For alarm panel configuration at run time, adds a path for a chain of
annunciator key (or soft alarm panel button) actions.

Input: Arguments and descriptions:


panel 1 - 12, identifying the soft panel
key 1 - 16, identifying the panels key
type P = program
C = command
D = display
T= target display manager name
path The definition to be added to the specified category.
If definition is null, all definitions for the key are
deleted

Examples: addalmpnl 5 12 P /usr/prog/myprog.exe

50
4. Alarm Server Task Commands B0700AP Rev A

clralmpnl
Syntax: clralmpnl

Description: Clears alarm panel definitions from AST memory.

Input: None

loadalmpnl
Syntax: loadalmpnl [filename]

Description: Loads the specified alarm panel configuration into AST memory.

Input: Argument and description:


filename Path and name of the file to be saved.

If no filename is specified, the name defaults to the


value of $ALMPAN from the wp51_glbls file.

Example: loadalmpnl /usr/fox/alarms/TMPALMAApan

prtalmpnl
Syntax: prtalmpnl [filename]

Description: Prints (saves to file) alarm panel definitions from AST memory.

Input: Argument and description:


filename Path and name of the file to be saved.

If no filename is specified, the following default is


used:
(Solaris)
/usr/fox/alarms/WPLETTERBUGAApan.prt
(Windows)
\usr\fox\alarms\WPLETTERBUGAApan.prt

Example: prtalmpnl /usr/fox/alarms/WP001AApan.prt

51
B0700AP Rev A 4. Alarm Server Task Commands

Command Usage and Examples


This section provides examples of Alarm Server Task commands.

Example 1
pref -WRKSTN ascmd addalmpnl 1 3 D D:\path\file.ext
Temporarily stores a soft panel assignment until a reboot command or clralmpnl command is
issued. After entering this addalmpnl command, pressing the annunciator key at panel 1 key 3
presents file.ext at the designated display manager. You can save temporary key assignment(s)
to a file for future use. To save a temporary assignment (so it can be used after a reboot), issue the
prtalmpnl command to the AST.

Example 2
pref -WRKSTN ascmd prtalmpnl \usr\fox\alarms\SAVECFG.PRT
If a reboot occurs, the WRKSTNAApan file remains untouched, and the
\usr\fox\alarms\SAVECFG.PRT file, which contains both the WRKSTNAApan data and the tempo-
rary configuration data, is available. To load a previously saved alarm panel configuration file, per-
form this loadalmpnl command.

Example 3
pref -WRKSTN ascmd loadalmpnl \usr\fox\alarms\SAVECFG.PRT
Doing this is a fast way to temporarily configure soft panel assignments using the definitions that
were saved. At run time, to clear out all temporary alarm panel definitions, issue the clralmpnl
command:
pref -WRKSTN ascmd clralmpnl

Example 4
addalmpnl 3 14 T dm0005
To identify the keys target display manager (the DM to which the associated configured com-
mands, displays, or programs are sent when the key/button is pressed), the type field is set to T fol-
lowed by the target DM name.
If the key number (14) specified in the target type (T) command is in the range of 1 to 16, the tar-
get DM name applies to only that one key. If the key number is 0 (zero), the DM name is used for
all keys on the specified alarm panel that are not individually configured with a target name. In
the following example, all key actions configured on Panel 3 are directed to DM dm0004 except
key number 14, whose actions are directed to DM dm0005.
addalmpnl 3 0 T dm0004
addalmpnl 3 14 T dm0005
If a target DM name is not configured for a key, the target DM used by the AST is the default
letterbug.

52
4. Alarm Server Task Commands B0700AP Rev A

Example 5
pref -WRKSTN ascmd addalmpnl 1 3 D D:\path\file.ext
The above command temporarily stores an alarm panel assignment, until a reboot command or a
clralmpnl command is issued. After the addalmpnl command has been issued, pressing the
annunciator key at panel 1 key 3 presents file.ext at the designated display manager.
You can save temporary key assignment(s) to a file for future use. To save a temporary assignment
(so it can be used after a reboot), issue the prtalmpnl command to the AST.

Example 6
pref -WRKSTN ascmd prtalmpnl \usr\fox\alarms\SAVECFG.PRT
The above command stores the contents of the AST memory (AApan file plus temporary assign-
ments) to a file. Thus, after a reboot, the WRKSTNAApan file remains untouched and the
\usr\fox\alarms\SAVECFG.PRT file is available for loading.
You can reload assignments retained in the SAVECFG.PRT file by entering the following
loadalmpnl command.
pref -WRKSTN ascmd loadalmpnl \usr\fox\alarms\SAVECFG.PRT
Doing this is a fast way to temporarily configure soft panel assignments using the definitions that
were saved.
At any time, you can clear out all alarm panel definitions from the AST memory by issuing the
clralmpnl command, for example:
pref -WRKSTN ascmd clralmpnl

53
B0700AP Rev A 4. Alarm Server Task Commands

54
5. Default User Interface
Configuration
This chapter provides the menu bars, pop-up menus, and buttons in the default user interface
configuration.
Table 5-1 describes the menu bar layout; Table 5-2, the default buttons; and Table 5-3, the pop-
up menus in the default user interface.
You can customize all of these items using the Alarm and Display Manager Configurator
(ADMC). For more information, refer to Alarm and Display Manager Configurator (ADMC)
(B0700AM).

55
B0700AP Rev A 5. Default User Interface Configuration

Table 5-1. Alarm Manager Default Menu Bars

Menu Items CAD MRA NEWALM UNACK ACKED AHD OPR


File
Save
Print
Dismiss
Minimize
Exit
Edit
Select All
Deselect All
Find Alarms
View
Refresh
Match Alarms
Go To Page
Hide Controls
Enable View All Mode
Disable View All
Mode
Displays
Current Alarms
Most Recent Alarms
New Alarm Summary
Unacknowledged
Alarm Summary
Acknowledged Alarm
Summary
Alarm History
Operations
Horns
Silence Horns
Mute Horns
Mute CAG Horns
Unmute CAG Horns
Help
Help Topics
About Alarm Manager

56
5. Default User Interface Configuration B0700AP Rev A

Table 5-2. Alarm Manager Default Buttons

Buttons CAD MRA NEWALM UNACK ACKED AHD OPR


Ack Alarm
Ack Compound
Ack Page
Clear Alarm
Clear Page
Alarm Detail
Top Priority
Block Detail
User Display
Historian
Environments

Table 5-3. Alarm Manager Pop-Up Menus

Buttons CAD MRA NEWALM UNACK ACKED AHD OPR


Ack Alarm
Ack Compound

N O N E AVA I L A B L E
Ack Page
Alarm Detail
Top Priority
Block Detail
User Display
Refresh
Pause
Unpause
Silence Horns
Show Controls
Most Recent Alarms

57
B0700AP Rev A 5. Default User Interface Configuration

58
Index

!= command 9
== command 10

A
about command 10
ackalm command 11
ackcmp command 11
Acknowledge alarms
ackalm command 11
ackcmp command 11
ackpage command 12
ackpage_cmp command 12
ackpage command 12
ackpage_cmp command 12
AckState keyword 45
addalmpnl command 50
Alarm display
almdisp command 13
blk_dtl command 14
detail_alm command 17
user_disp command 43
Alarm Manager commands
!= 9
=9
== 10
about 10
ackalm 11
ackcmp 11
ackpage 12
ackpage_cmp 12
almdisp 13
blk_dtl 14
chngenv 15
clear_alm 16
clear_page 16
deselect 17
detail_alm 17
disable 18
dismiss 18
enable 19
exit 19
find 20
getenv 20

59
B0700AP Rev A Index

help 21
hide 21
hist_file 22
historian 22
historian_ts 23
inequality 9, 10
match 24
match_ts 25
minimize 25
mute_all_horns 26
mute_horns 26
ojinit 27
overview 1
page 27
page_setup 28
pause 28
print 29
print_cancel 29
print_preview 30
print_setup 30
protect 31
quitam 31
refresh 32
run 32
save_cancel 32
save_to_file 33
script 33
scroll_by_time 34
select 34
send_to_dm 35
set_alarm_source 36
setacl 37
setdisp 37
setenv 38
setenv_default 38
show 39
silence_horns 39
stop_match 40
summary 4
top_prio 40
unmute_all_horns 41
unmute_horns 41
unpause 41
unprotect 42
user_disp 43
view_all 43
Alarm Manager keywords
overview 1
Alarm Server Task commands

60
Index B0700AP Rev A

addalmpnl command 50
clralmpnl command 51
examples 52
loadalmpnl command 51
overview 1
prtalmpnl command 51
AlarmName keyword 45
AlarmNumber keyword 45
Alarms, acknowledge
ackalm command 11
ackcmp command 11
ackpage command 12
ackpage_cmp command 12
Alarms, clear
clear_alm command 16
clear_page command 16
Alarms, deselect
deselect command 17
AlarmState keyword 45
AlarmType keyword 45
almdisp command 13
AM keywords 45
Assignment (=) command 9

B
BadIO keyword 45
blk_dtl command 14
Block keyword 45
BlockDesc keyword 45
BlockException keyword 45
Buttons, default settings 55

C
Case keyword 45
chngenv command 15
Clear alarms
clear_alm command 16
clear_page command 16
clear_alm command 16
clear_page command 16
clralmpnl command 51
Command syntax
conventions ix
Comparison
equality (==) command 10
inequality (!=) command 9
Compound keyword 45
Conventions
command syntax ix

61
B0700AP Rev A Index

D
Date keyword 45
Default ADMC configuration 55
deselect command 17
detail_alm command 17
disable command 18
dismiss command 18
Display, alarm
almdisp command 13
blk_dtl command 14
detail_alm command 17
user_disp command 43
DisSpc keyword 45

E
enable command 19
Environments
chngenv command 15
getenv command 20
setenv command 38
setenv_default command 38
Equality (==) command 10
exit command 19

F
find command 20

G
getenv command 20

H
help command 21
hide command 21
hist_file command 22
historian command 22
historian_ts command 23
Horns
mute_all_horns command 26
mute_horns command 26
silence_horns command 39
unmute_all_horns command 41
unmute_horns command 41

I
Inequality (!=) command 9

62
Index B0700AP Rev A

K
Keywords 47
Keywords, Alarm Manager 45

L
Limit keyword 45
loadalmpnl command 51

M
match command 24
match_ts command 25
Menu bar layout, default settings 55
minimize command 25
MMAlias keyword 45
mute_all_horns command 26
mute_horns command 26

O
ojinit command 27
Operational keyword 45
OptionText keyword 45
Overview
Alarm Manager commands 1
Alarm Manager keywords 1
Alarm Server Task commands 1

P
page command 27
page_setup command 28
ParamName keyword 45
pause command 28
Point keyword 45
Pop-up menus, default settings 55
Pref command, syntax 3
print command 29
print_cancel command 29
print_preview command 30
print_setup command 30
Priority keyword 45
protect command 31
prtalmpnl command 51

Q
quitam command 31

63
B0700AP Rev A Index

R
Range keyword 45
RangeAlarm keyword 45
refresh command 32
run command 32

S
save_cancel command 32
save_to_file command 33
script command 33
scroll_by_time command 34
select command 34
send_to_dm command 35
set_alarm_source command 36
setacl command 37
setdisp command 37
setenv command 38
setenv_default command 38
show command 39
silence_horns command 39
SPCAlarm keyword 45
specifiers 47
Statement keyword 46
Step keyword 46
stop_match command 40
Subroutine keyword 46
SystemTime keyword 46

T
Tenths keyword 46
Text keyword modifier 46
Time and Date keyword modifier 46
Time and date modifiers 46
Time keyword 46
Timeout keyword 46
top_prio command 40

U
Units keyword 46
unmute_all_horns command 41
unmute_horns command 41
unpause command 41
unprotect command 42
user_disp command 43

V
Value keyword 46
view_all command 43

64
Index B0700AP Rev A

65
B0700AP Rev A Index

33 Commercial Street
Foxboro, Massachusetts 02035-2099
United States of America
www.foxboro.com
Inside U.S.: 1-866-746-6477
Outside U.S.: 1-508-549-2424 or contact your local Foxboro representative.
Facsimile: 1-508-549-4999
Printed in U.S.A. 1004