Beruflich Dokumente
Kultur Dokumente
REV A
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
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
iv
Contents B0700AP Rev A
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.
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.
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.
4
2. Alarm Manager Commands B0700AP Rev A
5
B0700AP Rev A 2. Alarm Manager Commands
6
2. Alarm Manager Commands B0700AP Rev A
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
= (Assignment)
Syntax: = wp-var value
Description: Assignment operator. Sets the variable wp-var to value. Usually used in
an AM script.
Example: = AMCMD
9
B0700AP Rev A 2. Alarm Manager Commands
== (Equality)
Syntax: == value1 value2 command
about
Syntax: about
Input: None
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.
ackcmp
Syntax: ackcmp
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.
ackpage_cmp
Syntax: ackpage_cmp [disp]
Description: Acknowledges the compounds on the current page of the display, disp.
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.
Output: Initiates the named alarm displays with possible matching and new
historian (AHD only).
13
B0700AP Rev A 2. Alarm Manager Commands
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.
Output: The Block Detail display for the selected process alarm is presented in the
associated FoxView.
14
2. Alarm Manager Commands B0700AP Rev A
chngenv
Syntax: chngenv [env-name]
Output: Updates the active environment name on the alarm displays. Menu items
and button selections may change if permissions change with the new
environment.
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.
Output: The selected alarms are cleared from all active alarm displays on the work-
station (or all workstations throughout the CAG, if appropriate).
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.
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).
16
2. Alarm Manager Commands B0700AP Rev A
deselect
Syntax: deselect
Output: Previously selected alarms, which are visually highlighted, are no longer
highlighted.
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.
Output: Alarm Detail display showing the alarm detail information for the selected
alarm.
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.
Output: All actions associated with the disabled functions are dimmed
(unselectable).
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.
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.
Output: All actions associated with the enabled functions are selectable.
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.
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.
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.
Output: None
20
2. Alarm Manager Commands B0700AP Rev A
help
Syntax: help
Input: None
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).
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.
Output: Alarm messages are displayed to the AHD display from the named histo-
rian archive file.
historian
Syntax: historian [histname]
Output: Alarm messages are displayed to the AHD display from the named
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.
Output: Alarm messages are displayed to the AHD display from the named
historian.
23
B0700AP Rev A 2. Alarm Manager Commands
match
Syntax: match [filename]
Examples: match
match /usr/fox/customer/alarms/amspec/HIABS.ams
24
2. Alarm Manager Commands B0700AP Rev A
match_ts
Syntax: match_ts [filename]
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]
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.
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.
26
2. Alarm Manager Commands B0700AP Rev A
ojinit
Syntax: ojinit
Input: None
Output: None
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.
Output: The set of alarm messages visible on the display changes to reflect the pag-
ing specified.
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.
pause
Syntax: pause
Input: None
Output: Updates to the associated display are stopped and PAUSED is illuminated,
in red, in the status area.
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.
Output: The Print dialog box is displayed. Alarm entries or the contents of a file
printed on the printer.
Examples: print
print -standard_header -default_printer
print_cancel
Syntax: print_cancel
Input: None
Output: None
29
B0700AP Rev A 2. Alarm Manager Commands
print_preview
Syntax: print_preview
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.
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.
Output: None
quitam
Syntax: quitam {on | off}
Description: Enables/disables the ability to exit from (quit) an Alarm Manager. Usually
used in an AM script.
Output: None
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.
run
Syntax: run prog [arg-list]
save_cancel
Syntax: save_cancel
Description: Cancels saving the file from the Current Alarm Display.
Input: None
Output: None
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.
Output: None
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.
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.
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.
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.
Examples: scroll_by_time
scroll_by_time +3600
scroll_by_time -10
select
Syntax: select
34
2. Alarm Manager Commands B0700AP Rev A
send_to_dm
Syntax: send_to_dm [-dm dm_name] command-list
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.
Output: The set of alarms displays on the alarm displays may change when the data
source changes.
Examples: set_alarm_source
set_alarm_source -primary WP0001
36
2. Alarm Manager Commands B0700AP Rev A
setacl
Syntax: setacl number access
Output: None
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.
Output: None
37
B0700AP Rev A 2. Alarm Manager Commands
setenv
Syntax: setenv var value
Output: None
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.
Output: None
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).
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
39
B0700AP Rev A 2. Alarm Manager Commands
stop_match
Syntax: stop_match
Output: All alarm messages for the alarm display are presented.
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
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.
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.
unpause
Syntax: unpause
Input: None
Output: Updates to the associated display are resumed and PAUSED is grayed out in
the status area.
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.
Output: None
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).
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.
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.
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.
45
B0700AP Rev A 3. Alarm Manager Keywords
Keyword Modifiers
Keyword modifiers, listed in Table 3-2, are delimited by [ and ]. Modifiers vary by keyword.
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
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
47
B0700AP Rev A 3. Alarm Manager Keywords
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.
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.
50
4. Alarm Server Task Commands B0700AP Rev A
clralmpnl
Syntax: clralmpnl
Input: None
loadalmpnl
Syntax: loadalmpnl [filename]
Description: Loads the specified alarm panel configuration into AST memory.
prtalmpnl
Syntax: prtalmpnl [filename]
Description: Prints (saves to file) alarm panel definitions from AST memory.
51
B0700AP Rev A 4. 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
56
5. Default User Interface Configuration B0700AP Rev A
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