Button Configuration Form Instructions SW12-570
Button Configuration Form Instructions SW12-570
Button Configuration
Form Instructions
SW12-570
˚˚˚
L
Implementation
Engineering Operations - 1
Button Configuration
Form Instructions
SW12-570
Release 520
7/96
Copyright, Trademarks, and Notices
Before reading this publication, you should be familiar with the following:
This publication supports TotalPlant Solution (TPS) System network release 500 - 520.
TPS is the evolution of TDC 3000X.
Change bars are used to indicate paragraphs, tables, or illustrations containing changes
that have been made effective in this manual by release 520. Pages revised only to
correct minor typographical errors contain no change bars.
1 INTRODUCTION
1.1 Purpose
1.2 Scope
1.3 Prerequisites
1.3.1 Prior Knowledge
1.3.2 Sources of Button Configuration Data
1.4 Documents Required
2 GENERAL INSTRUCTIONS
3 EXAMPLES
INTRODUCTION
Section 1
1.1 PURPOSE
1.2 SCOPE
This publication covers instructions necessary to fill in the Button Configuration Forms to
be used with the data-entry portion of the configuration. Examples show some of the
ways to use the Configurable Buttons. Other actions that can be configured into buttons
are described in the Actors Manual, in the Implementation/Engineering Operations - 2
binder.
1.3 PREREQUISITES
There are two categories of prerequisites for filling out button-configuration forms:
Before using these instructions to fill out button-configuration forms, you should first read
the Configuration Data Collection Guide, in the Implementation/Startup &
Reconfiguration
- 2 binder. This guide is a road map through the various TotalPlant Solution (TPS)
System configuration activities that use paper forms. It tells you where the Button
Configuration paper forms fit into the overall configuration process.
Table 1-1 shows typical sources of data needed to complete the button-configuration
forms.
The Station Numbers The console con- A logical console can have
within the Console figuration installed, up to 10 stations. The
for which these buttons or to be installed Stations are numbered
are being configured 1-10
Process Unit IDs (for which Network Forms Network Forms list
button alarm indicators publication all Unit IDs
might be desired)
applicable to the Console
(Area) for which this set
of buttons is being
configured
Refer to the Actors Manual (SW09-555), for a complete list and description of the action
procedures (Actors).
GENERAL INSTRUCTIONS
Section 2
Two forms have been designed to collect configuration data for the configurable buttons.
The Button Configuration form provides space to configure up to six buttons. The Button
Name File form is used to collect new names for the configurable buttons. Use as many
pages of the forms as needed to configure the buttons.
NOTE
For those using R500 software, please note the following. Only the ABC
keyboard image and the Engineer's keyboard image were displayed for
button configuration purposes. Because configurable button numbers are
the same on QWERTY and ABC keyboards, either can be configured using
the ABC image.
Normally a set of buttons is configured for an area. Button 1 on any type of keyboard
within the same area will invoke the same action as Button 1 on any other type of keyboard
in the same area (some exceptions are discussed later). Identifying the keyboard type helps
the person entering button data to select the most helpful screen image for the configuration
task.
Figure 2-2 shows the layout for Configurable Buttons 1 through 85 on the QWERTY and
ABC Operator keyboards. Buttons 7 through 46 contain alarm indicator lamps as
indicated by the small circles in the upper corners. Buttons 0-6 do not contain alarm
indicator lamps. Note that the Alpha Shift Button (not illustrated), in the lower-right of
these keyboards is not configurable by the user.
Pathname__________________________ 4/96
Keyboard Type: __ABC __QWERTY __Integrated __Engineer (PF Keys)
References:
Button Configuration Form Instructions, SW12-570 in the Implementation/Engineering Operations - 2 binder.
Button Configuration Data Entry, SW11-570 in the Implementation/Engineering Operations - 2 binder.
Rev
DD MMM YY 14:05:41 1
BUTTON CONFIGURATOR QWERTY KEYBOARD PAGE 1 OF 5
1 2 3 4 5 6
7 8 9 10 11 12 13 14 15 16
17 18 19 20 21 22 23 24 25 26
27 28 29 30 31 32 33 34 35 36
37 38 39 40 41 42 43 44 45 46
! " \ $ = & * < > ?
47 48 49 50 51 52 53 54 55 56
Q W E R T Y U I O P
57 58 59 60 61 62 63 64 65 66
A S D F G H J K K -
67 68 69 70 71 72 73 74 75 76
➝
SP Z X C V B N M
77 78 79 80 81 82 83 84 85
15019
a – QWERTY Keyboard
DD MMM YY 14:05:41 1
BUTTON CONFIGURATOR ABC KEYBOARD PAGE 2 OF 5
1 2 3 4 5 6
7 8 9 10 11 12 13 14 15 16
17 18 19 20 21 22 23 24 25 26
27 28 29 30 31 32 33 34 35 36
37 38 39 40 41 42 43 44 45 46
47 48 49 50 51 52 53 54 55 56
A B C D E F G H I J
57 58 59 60 61 62 63 64 65 66
K L M N O P Q R S T
67 68 69 70 71 72 73 74 75 76
➝
U V W X Y Z SP _
77 78 79 80 81 82 83 84 85
15020
b – ABC Keyboard
DD MMM YY 14:05:41 1
BUTTON CONFIGURATOR INTEGRATED KEYBOARD PAGE 3 OF 5
1 2
PAGE FORWARD
3 4 FOR BUTTONS
7 THRU 85
5 6
DD MMM YY 14:05:41 1
BUTTON CONFIGURATOR INTEGRATED KEYBOARD PAGE 4 OF 5
7 8 9 10 11 12 13 14 15 16
17 18 19 20 21 22 23 24 25 26
47 48 49 50 51 52 53 54 55 56
-
57 58 59 60 61 62 63 64 65 66
LEFT QUADRANT LEFT MIDDLE QUADRANT
27 28 29 30 31 32 33 34 35 36
37 38 39 40 41 42 43 44 45 46
67 68 69 70 71 72 73 74 75 76
77 78 79 80 81 82 83 84 85
15021
Figure 2-4 illustrates the 17 Programmable Function (PF1-PF17) keys that appear on
various Engineering/Supervisory keyboards such as Micro TDC Station, the Universal
Workstation, the Integrated Keyboard, and others.
These 17 buttons can be used alone (first field), with the Shift key held down (middle
field), or with the Control key held down (lower field) to provide a total of 51 configurable
choices. The buttons are numbered 86 through 136.
DD MMM YY 14:05:41 1
BUTTON CONFIGURATOR ENGINEER KEYBOARD PAGE 5 OF 5
NORMAL
PF1 PF2 PF3 PF4 PF5 PF6 PF7 PF8 PF9 PF10
86 87 88 89 90 91 92 93 94 95
SHIFT
PF1 PF2 PF3 PF4 PF5 PF6 PF7 PF8 PF9 PF10
103 104 105 106 107 108 109 110 111 112
CONTROL
PF1 PF2 PF3 PF4 PF5 PF6 PF7 PF8 PF9 PF10
120 121 122 123 124 125 126 127 128 129
15022
The Action field (refer to Figure 2-1) is used to specify the Actor or group of Actors
assigned to a specific button. The Actors Manual describes the actors and Section 3 of this
manual provides some typical examples for this entry.
Unless specifically noted, any Actor or group of Actors can be used with a configurable
button; however, observe the following restrictions and precautions:
• When triggered by a configurable button, Actors that open a Text Input Port (TIP)
can do so only on the top line of the screen (region 1); therefore, TIP coordinates are
not requested during configuration.
All of the Actors and associated parameters must fit inside the screen form’s Action entry
port. For each button the screen form allows 78 characters by 15 lines (1170 characters).
Before configuring any of the buttons numbered 57 through 85 (the alpha buttons) on
ABC or QWERTY Keyboards, you should consider the following. These buttons are
normally used to enter text such as group names, point names, etc., a letter at a time. The
alpha buttons, like the others, can also be used to invoke the configurable functions (e.g.,
call up schematics, open ports, etc.).
If these buttons are configured, before making an entry the operator must make sure the
keyboard is in the correct mode for the type of information to be entered. The operator
must press the alpha shift button if necessary to switch between text mode and function
mode. If you configure any of the alpha buttons, therefore, you should instruct Operating
personnel to start with the Operator's keyboard in text mode and use the following
procedure to select a configured-button function:
• Press the alpha shift button again so that the buttons are always left in text mode.
If none of the alpha buttons are configured, just leave the keyboard in text mode all the
time.
Note that in all cases, the configuration actions you choose are effective only when the
Operator's Personality is running in the station.
Forty of the Configurable Buttons each have a pair of Light Emitting Diode (LED)
indicators; one red and one yellow. The Button Configuration screen for these buttons
contains a corresponding Lamp Specific Data field. This field is used to specify a Process
Unit ID, a Primmod point name, or an Annunciator Group title for use with the button
indicators. When an alarm condition is detected from the specified source, the assigned
LEDs turn on.
The level of Unit Alarm that turns on the red indicator is specified during System Wide
Values Configuration. Lower-priority Unit Alarms turn on the yellow LED indicator.
Only the buttons with lamp indicators can have a Lamp Specific Data entry. These are the
buttons with small circles in the upper corners as illustrated in Figures 2-2 through 2-4.
For Release 520 and later systems, CL/Sequence programs can also control the button
indicators. The CL message can be sent to all Universal Stations in certain specified
groups such as a Console or an Area. Refer to the Send Statement in the AM/CL, MC/CL,
or any of the Process Manager series CL manuals. Advanced Control Programs from
upper level processors connected to the Computer Gateway can also control the button
LEDs. Figure 2-5 illustrates how CL Send messages are used.
AM/CL Programs,
PM/APM/HPM and MC Sequence Programs,
Advanced Control Programs
CL SEND MESSAGE
$BTN_PRM $BTN_LED
Two forms of the CL Send message affect the Button LED Indicators—
If the LED indicators are assigned to a Unit, Primmod (or $MPROD), or Annunciator
Group as described in subsection 2.1.4, that assignment is not changed by a
$BTN_LED CL message.
Note that either the assignment in the Lamp Specific Data field or the CL Send message
can change the indicators at any time. If more than one Send statement or Lamp
Specific Data assignee tries to control the LEDs simultaneously, the last one processed
determines the LED(s) state.
A valid $BTN_PRM CL message overwrites any current lamp specific data field
assign-ment even if the LED indicators were assigned to a Unit, Primmod, or
Annunciator Group.
NOTE
Whenever a station is reloaded or an Area change is performed, all
configurable buttons are cleared and re-initialized to the values specified in
the Button Configuration file. Values previously stored by CL programs
are overwritten on any US that is either reloaded or that changed its Area.
Primmod Actors
G_PRIM S_PRIM
Stores
Reads Primmod
Primmod Assignment
Assignment or Clears
Any Type
Assignment
Get Primmod Actor—the G_PRIM actor can read a primmod value assigned to the
Lamp Specific Data field of a button on the local keyboard.
Figure 2-6 illustrates how these actors work. For complete information refer to the Get
Primmod actor and Store Primmod actors in Section 3 of the Actors Manual, SW09-555.
NOTE
Whenever a station is reloaded or an Area change is performed, all
configurable buttons are cleared and re-initialized to the values specified in
the Button Configuration file. Values previously stored by CL programs
are overwritten on any US that is either reloaded or that changed its Area.
In Release 520 and later systems, an optional Button Name File can be used to customize
the software names of the configurable buttons with LED indicators. The Button Name
File is an Area file and the button names entered in this file change Standard Default
Symbolic button names to User Defined Symbolic button names of your choice.
Universal Stations load Standard Default Symbolic button names at startup or following an
Area change but if a Button Name File is present, the User Defined Symbolic button
names in this file will overwrite the default names.
If a Button Name File is not present, the Standard Default Symbolic names remain
assigned to the configurable buttons. Entries in the Button Name File determine which
button names are changed. If a name isn't specified in the Button Name File for one or
more buttons, the corresponding button name or names are not changed. Only names for
the 40 buttons with LED indicators can be changed. The Standard Default Symbolic
names for these buttons are AN_CNF7 - AN_CNF46. For the complete list of Standard
Default Symbolic names, refer to Appendix C in the Actors Manual. The Button Name
Form, SW88-571 is used to collect User Defined Symbolic names of your choice for the
configurable buttons.
To
Configurable
Node Startup Button Buttons with
or Name LEDs
Area Change File
new
Figure 2-7— Renaming Configurable Buttons with LEDs from a Button Name File
After a Button Name File is successfully loaded, CL programs, Actors, and other functions
can access the button configuration fields using the User Defined Symbolic names that are
assigned through the Button Name File. Button names that weren't changed can still be
accessed by their Standard Default Symbolic names. Any of the Standard Default
Symbolic button names that are overwritten with new user names from the Button Name
file can no longer be accessed by their Default Symbolic names.
Notes: Button Names = 1 - 8 characters, (no spaces). Leading space = comment line.
Default Symbolic Button names are listed in the Actors Manual, Appendix C.
References:
Button Configuration Form Instructions, SW12-570 in the Implementation/Engineering Operations - 2 binder.
Button Configuration Data Entry, SW11-570 in the Implementation/Engineering Operations - 2 binder.
New
Figure 2-8 illustrates the Button Name File form. The paragraphs below explain how to
fill in each section of the form. Make copies of the form if needed however note that there
is a limit of 1000 lines total for button names and comments.
2.2.2 Pathname
Figure 2-8 shows an example of a Button Name File form. Indicate the pathname at the
top of the form. This pathname must be the same as used for the Button Configuration file
on Form SW88-570. The Button Name File must reside in the same directory as the Area
Data Base file (typically &Dnn where nn = the Area number). If there is no Button
Configuration file, use any valid 8-character file name of your choice. The Button Name
file always has the suffix .KN; the Button Configuration object file always has a suffix of
.KO. Thus, the button file name entered in the Pathname Catalog identifies both file
names. There does not have to be a Button Configuration file but if not, you must specify
the Button Name File in the Pathname Catalog and the volume where it is located or it
cannot be read. Refer to the Area Form Instructions manual, SW12-580 for more
information on the Pathname Catalog.
2.2.3 Comments
Comments are discussed first because any line is interpreted as a comment if that line
contains one or more leading spaces. Figure 2-9 shows an example of a filled in Button
Name Form where three lines are used as comment lines.
Also, after the Default Symbolic Button Name and User Defined Symbolic Button Name
is entered, the balance of the line can be used for a comment.
In the left most column, list the Default Symbolic Button Name that you wish to re-define.
Only the 40 configurable buttons with LED indicators can be re-defined. These are
AN_CNF7 - AN_CNF46. They do not all have to be redefined. Any buttons that are not
redefined can be accessed by their Default Synbolic names.
In the second column from the left, enter a 1 - 8 character symbolic name of your choice.
The only restriction is that the name cannot contain a space. This name will become the
new symbolic name for the button listed in the first column on the same line. For
example, in Figure 2-9, button AN_CNF9 is redefined as Button_A. The remainder of the
line can be used for a comment.
Note that the Button Configuration Data Entry manual explains how to build the actual
Button Name File at a Universal Station using the entries on form SW88-571.
Notes: Button Names = 1 - 8 characters, (no spaces). Leading space = comment line
Default Symbolic Button names are listed in the Actors Manual, Appendix C.
References:
Button Configuration Form Instructions, SW12-570 in the Implementation/Engineering Operations - 2 binder.
Button Configuration Data Entry, SW11-570 in the Implementation/Engineering Operations - 2 binder.
New
EXAMPLES
Section 3
To configure a button to call up a display, choose the desired display from the Display
Actors listed in the Actors Manual. Enter the Actor, character-by-character, into the
Action-entry columns. Refer to Figure 3-1 for an example.
GROUP(230,1)
Using the example above, this entry calls up Group 230 with Slot One preselected when
the configured Button is pressed.
Note that required parameters are enclosed by parentheses and must be separated by
commas. Correct punctuation and syntax must be maintained.
07
Button Number _________ Button Number_________
Action: Action:
GROUP(230,1)
________________________________________ ________________________________________
________________________________________ ________________________________________
________________________________________ ________________________________________
________________________________________ ________________________________________
________________________________________ ________________________________________
________________________________________ ________________________________________
________________________________________ ________________________________________
Lamp Specific Data* _________________________ Lamp Specific Data* ________________________
15029
Rev
Figure 3-1 — Display Call-Up Example (Group Call-Up, Group 230, Selected Point 1)
The Configurable Buttons can be used to transfer displays or keystrokes to and from
different Universal Stations that are in the same Console and have the same Area Database.
Note that all stations with the same Area Database have the same button configuration.
3.2.1 Cross-Screen
The Cross-Screen Actor conditions the Universal Station to transfer the next requested
display or keystroke to the specified screen (alphanumeric or cursor-control key functions
are not sent). The Cross-Screen Actor has the following form:
CROSSCRN(Screen No)
Example 1: CROSSCRN(01)
If, for example, the next button pressed calls up the Real Time Journal (RTJ) display, that
display would appear on screen 1.
Example 2:
Suppose an upper display (therefore one without a keyboard) is monitoring a condition that
needs to be acknowledged. This can be done in two ways (assume display 6 for the
following examples).
• If a button was configured CROSSCRN(6), the operator can press that button followed by
the ACK key on the Operator's Keyboard.
The advantage of the first method is that any one of a number of keys could be pressed
after the Crosscrn(6) button. The advantage of the second method is that the single button
could be labeled ACK SCREEN 6.
3.2.2 From-Screen
The From-Screen Actor causes the display that currently appears on another screen to also
appear on the screen at calling station.
FRM_SCRN(Screen No)
Example: FRM_SCRN(01)
When the button is pressed, the display currently appearing on Screen 1, also appears on
the station where the button was pressed.
Console Example
As illustrated by Figure 3-2, the screens within a Console are identified by Logical Screen
Numbers from 1 to N, where N equals the number of screens in the Console. The Screen
Number appears in the upper-right corner of the Screen.
Figure 3-2 shows how one button was configured for each screen in the Console to receive
or send displays. Pressing any of the buttons labeled TO X invokes a Cross-Screen Actor.
An additional button must be pressed to select the display that is transferred to screen X (X
can be any screen number in the console). Pressing a button labeled FROM X, calls the
display on screen X to screen 3 (in this case).
Figure 3-3 shows how the Button Configuration form was filled in for buttons 67 through
72 in this example.
4 5 6
Screen Numbers
1 2 3
MMM YY HH:MM 3
SCREEN
X
Honeywell TDC 3000 BUTTON CONFIGURATION Form SW88-570
Net>&D01>Buttons
Pathname__________________________ 4/96
Keyboard Type:: X
__ABC __QWERTY __Integrated __Engineer (PF Keys)
67
Button Number_________ 68
Button Number_________
Action: Action:
CROSSCRN(04)
________________________________________ CROSSCRN(05)
________________________________________
69
Button Number_________ 70
Button Number_________
Action: Action:
CROSSCRN(06)
________________________________________ FRM_SCRN(04)
________________________________________
71
Button Number_________ 72
Button Number_________
Action: Action:
FRM_SCRN(05)
________________________________________ FRM_SCRN(06)
________________________________________
15030
Display sets allow the operator to simultaneously call up a predetermined set of displays by
pressing a single button. Each display set uses one configurable button. For example,
Button 8 could be configured to call up the following:
For each screen in the set, a Cross-Screen Actor is combined with a display Actor. For
example, CROSSCRN(2);GROUP(1,0) calls up Group Display 1 on screen 2. Figure
3-4 illustrates the Actors used to configure the 3-screen display set described above.
All screens named in a display set must be in the same area and in the same console.
Actors must be separated by semicolons.
X
Honeywell TDC 3000 BUTTON CONFIGURATION Form SW88-570
Net>D01>Buttons
Pathname__________________________ 4/96
Keyboard Type: X
__ABC __QWERTY __Integrated __Engineer (PF Keys)
08
Button Number_________ Button Number_________
Action: Action:
CROSSCRN( 2); GROUP(1 , 0) ;
________________________________________ ________________________________________
CROSSCRN (1 );SCHEM(" F URN" ) ;
________________________________________ ________________________________________
CROSSCRN (3 );OVERVIE W
________________________________________ ________________________________________
________________________________________ ________________________________________
________________________________________ ________________________________________
________________________________________ ________________________________________
________________________________________ ________________________________________
Lamp Specific Data* _________________________ Lamp Specific Data* ________________________
15031
In addition to the simple display call-up actions that can be assigned to a Configurable
Button, Actors can be combined to perform more complex actions such as Parameter
Manipulation. For example, to indirectly turn on a Control Language Program bound to a
Data Point, the Point's PPS (Point Process Special) Parameter could be set to TRUE, as
follows:
In this example, AT101 is a Data Point with a Control Language Program bound (or
attached) to the Data Point. When you press Button 10, a Screen Prompt tells you to
type the word TRUE, to process the Data Point immediately instead of waiting for the
normal processing time to elapse. The storing of a Boolean "TRUE" to the PPS (Point
Process Special) parameter of the Data Point (Point ID of AT101) causes the Point to
process immediately, and thus the attached Control Language Program executes. The
screen is then updated to reflect any changes in status.
The Actor configured to accomplish these tasks is the Read Data and Store Into System
Variable, symbolized as RS_SYS. This Actor presents a Text Input Port (TIP) on the
screen and allows the operator to type data into the TIP. The input is read and stored in the
System Database. The Actor requires the following parameters: Point Name, TIP length,
and Prompt Message (30-characters maximum). Refer to the Actors Manual for a detailed
explanation of the parameters.
The Update Actor following the RS_SYS Actor in the example is used to show the
changes to the Schematic Region that could occur as a result of the operator action. The
Update Actor requires only two variables: the Screen Region and the Demand Group (1=
Local Variables, 0= All Groups).
The layout of the Screen Regions used to configure this example is shown in Figure 3-5.
Note that for Actors triggered by a configurable button, the Text Input Port is presented on
Line 1.
Figure 3-6 gives the example as it appears on the Configuration Form with callouts that
describe the parameters. Pay attention to the syntax in the example. The example shows
that Button 10 is assigned to LED Unit number A1; therefore, when Process Unit A1
detects an alarm condition, a LED indicator on Button 10 is lit to indicate the alarm status.
Summary of syntax:
SCREEN COLUMNS
1 30 35 80
LINE 1
REGION 1 PROMT MESSAGE TIP LINE 0
(PROMPT and
INTERACTION) LINE 25
SCHEMATIC REGION
REGION 2
LINE 0
TIP LENGTH
PROMPT
MESSAGE
Form SW88-570
10
Button Number _________
Action:
RS_SYS (AT101.PPS,4,"TYPE IN TRUE TO
________________________________________
PROCESS AT101");UPDATE (0, 2 )
________________________________________
________________________________________
________________________________________
The Que Key actor has the form QUE_KEY(Button ID). It allows a configurable button
(or target) to emulate almost any key on the Universal Station or Universal Work Station
keyboards. Refer to the Actors Manual for more information and the exact syntax for
each button ID.
Example 1: The Universal Work Station's Supervisor Keyboard does not contain a
keylock, but a configurable button with the action sequence QUE_KEY(KEY_SUP) will
enable the Supervisor Function when pressed. You may want to configure such a button
in an area separate from those normally used by the operators.
Refer to the subsection 3.2 of this manual for an additional example of the Que Key actor.
Honeywell IAC Automation College welcomes your comments and suggestions to improve
future editions of this and other publications.
You can communicate your thoughts to us by fax, mail, or toll-free telephone call. We would
like to acknowledge your comments; please include your complete name and address.
BY TELEPHONE: In the U.S.A. use our toll-free number 1*800-822-7673 (available in the 48
contiguous states except Arizona; in Arizona dial 1-602-313-5558).
BY MAIL:Use this form; detach, fold, tape closed, and mail to us.
Writer: B. Damours
COMMENTS:_____________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
RECOMMENDATIONS:___________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
NAME_________________________________________ DATE ____________________
TITLE ____________________________________________________________________
COMPANY _______________________________________________________________
ADDRESS ________________________________________________________________
CITY __________________________ STATE __________ ZIP ____________________
TELEPHONE________________________ FAX _________________________________
Industrial Automation and Control
Honeywell Inc.
16404 North Black Canyon Highway
Phoenix, Arizona 85023-3033
L
Helping You Control Your World