Beruflich Dokumente
Kultur Dokumente
EP-DSXX36
April 2010
Release 400
Document Release Issue Date
EP-DSXX36 400 0 April 2010
Notice
This document contains Honeywell proprietary information. Information
contained herein is to be used solely for the purpose submitted, and no part of this
document or its contents shall be reproduced, published, or disclosed to a third
party without the express permission of Honeywell International Sàrl.
While this information is presented in good faith and believed to be accurate,
Honeywell disclaims the implied warranties of merchantability and fitness for a
purpose and makes no express warranties except as may be stated in its written
agreement with and for its customer.
In no event is Honeywell liable to anyone for any direct, special, or consequential
damages. The information and specifications in this document are subject to
change without notice.
Copyright 2010 – Honeywell International Sàrl
Honeywell trademarks
Experion®, PlantScape®, SafeBrowse®, TotalPlant® and TDC 3000® are
trademarks of Honeywell International Inc.
Other trademarks
Microsoft and SQL Server are either registered trademarks or trademarks of
Microsoft Corporation in the United States and/or other countries.
Trademarks that appear in this document are used only to the benefit of the
trademark owner, with no intention of trademark infringement.
2 www.honeywell.com/ps
Support and other contacts
Pacific
3
India
Korea
4 www.honeywell.com/ps
Singapore
Taiwan
Japan
Elsewhere
Call your nearest Honeywell office.
5
Training classes
Honeywell holds technical training classes on Experion. These classes are taught
by experts in the field of process control systems. For more information about
these classes, contact your Honeywell representative, or see http://
www.automationcollege.com.
Related documentation
For a complete list of publications and documents for Experion, see the Experion
Overview.
6 www.honeywell.com/ps
Contents
7
CONTENTS
Using SafeBrowse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
URL formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Linking to displays from HTML pages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Inserting graphics created by other applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Pasting text from another application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Setting the display’s options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Working with files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Creating a new display or shape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Saving a new display or shape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Opening a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Distributing and validating files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Checking the validity of point IDs in remotely-built files . . . . . . . . . . . . . . . . . . . . . . . 71
Distributing files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Exporting numbered displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
8 www.honeywell.com/ps
CONTENTS
9
CONTENTS
10 www.honeywell.com/ps
CONTENTS
7 Tutorial 265
Setting up the drawing window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
Drawing the objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Drawing the title . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Drawing the pump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Drawing the tank . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Drawing the pipe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
Drawing and configuring the alphanumeric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
11
CONTENTS
12 www.honeywell.com/ps
About this guide
1
This guide describes how to use Display Builder to create custom displays for
your Experion system.
This guide:
• Introduces you to the basic concepts behind Display Builder
• Describes how to create displays and link them to points in the server database
• Describes how to write scripts—mini programs—that increase the
functionality of your displays
• Provides guidelines for creating user-friendly displays
Attention This version of Display Builder creates displays with a proprietary “DSP”
format. If you want to create Web-based displays, see the HMIWeb Display
Building Guide
13
1 – ABOUT THIS GUIDE
Pre-requisite skills
This guide assumes that you have some knowledge of Microsoft Windows, and
understand phrases such as “double-clicking” and “dragging”.
14 www.honeywell.com/ps
HOW TO USE THIS GUIDE
15
1 – ABOUT THIS GUIDE
16 www.honeywell.com/ps
Getting started with (DSP)
Display Builder 2
Custom displays work in the same way as the standard displays supplied with
Experion. However, custom displays allow you to present information in a more
sophisticated and “user-friendly” manner. As a consequence, custom displays
make it easier for operators to visualize complex processes, and reduce the
probability of operator errors.
Attention This version of Display Builder creates displays with a proprietary “DSP”
format. If you want to create Web-based displays, see the HMIWeb Display
Building Guide.
17
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
18 www.honeywell.com/ps
USING THE TOOLBARS
19
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
Standard toolbar
The Standard toolbar includes basic Windows-related buttons such as Open and
Save.
Button Description
Display/Shape. Creates a new display or shape. Click the arrow to the
right to display the list:
Display. Creates a new display.
Print. Prints the display (to the Windows printer on the computer
running Display Builder).
Cut. Removes the selected object(s) from the display (and copies them
to the clipboard).
Copy. Copies the selected object(s) to the clipboard.
Find. Finds an object by its name (as shown in the Name property of the
Properties Window).
Undo. Undoes the previous action.
20 www.honeywell.com/ps
USING THE TOOLBARS
Toolbox toolbar
The Toolbox toolbar contains two types of buttons:
• Editing buttons, which you use to edit existing objects.
• Object creation buttons, which you use to create display objects. For example,
if you want to draw a rectangle, you click Rectangle.
Editing buttons
Button Description
Pointer. Selects, moves and resizes display objects.
Button Description
Text. Creates text, such as the display’s title.
Freehand Line. Creates a freehand line which follows the path you trace
with the pointer.
Rectangle. Creates a rectangle or square.
21
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
Button Description
Polyline. Creates a multi-segment line (which are similar to polygons,
but with one open side).
To create a polyline, you click to mark each apex, except for the last.
You mark the last apex by double-clicking.
Polygon. Creates a polygon.
To create a polygon, you click to mark each apex, except for the last.
You mark the last apex by double-clicking, which then closes the
polygon.
Arc. Creates an arc (a quarter of an oval or circle).
Scroll bar. Creates a scroll bar that users can operate in an interactive
display. See “About scrollbars” on page 99.
Indicator. Creates a “gauge” that indicates relative values. (Similar in
principal to a car’s fuel gauge.)
Alarm Line. Used to display alarms, delay or event conditions.
22 www.honeywell.com/ps
USING THE TOOLBARS
View toolbar
The View toolbar includes a range of editing buttons.
Button Description
Rulers. Shows/hides the rulers. The rulers make it easier to arrange
display objects in a neat and consistent manner. See “Setting the
display’s options” on page 64.
Grid. Shows/hides the grid. The grid makes it easier to arrange display
objects in a neat and consistent manner. See “Setting the display’s
options” on page 64.
Snap-to-Grid. Turns the “snap-to-grid” function on/off. When snap-to-
grid is active, objects automatically align to the grid when you create,
move or resize them.
Properties Window. Opens/closes the Properties Window. You use the
Properties Window to edit the characteristics of the selected object(s).
See “Using the Properties Window (DSP displays)” on page 47.
Script Editor. Opens/closes the Script Editor. You use the Script Editor
to write scripts—a script is a mini-program that performs a specific task.
See “Using the Script Editor” on page 142.
Scripts enable you to increase the sophistication of your displays, and
can vary widely in functionality and complexity. Anyone with minimal
programming skills can write simple scripts. Scripts are described in
detail in “Scripting reference” on page 131.
Shape Gallery. Opens/closes the Shape Gallery. The Shape Gallery
makes it easy to preview and add pre-built shapes to your displays. See
“Using the Shape Gallery” on page 57.
23
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
Arrange toolbar
The Arrange toolbar contains buttons for aligning and grouping display objects.
Button Description
Bring To Front. Moves the selected object(s) to the “front” so that it is
not obscured by overlapping objects.
Send To Back. Moves the selected object(s) to the “back” where it is
obscured by overlapping objects.
See “Moving a display object to the front or back” on page 36.
Group. Groups the selected objects so that they become one object. If
necessary, you can “nest” grouped objects to create even more complex
display objects.
Ungroup. Splits a grouped object into its component objects.
See “Grouping display objects” on page 37.
Align Left. Moves the selected objects horizontally so that they are all
aligned to the left.
Align Center. Moves the selected objects horizontally so that their
centers are aligned.
Align Right. Moves the selected objects horizontally so that they are all
aligned to the right.
Align to Page Center. Moves the selected objects so that they are
centered on an imaginary line that runs vertically through the center of
the display.
See “Aligning display objects” on page 33.
Align Top. Moves the selected objects vertically so that they are all
aligned at the top edge.
Align Middle. Moves the selected objects vertically so their centers are
aligned.
Align Bottom. Moves the selected objects vertically so that they are all
aligned at the bottom edge.
Align to Page Middle. Moves the selected objects horizontally so that
they are centered on an imaginary line that runs horizontally through the
center of the display.
See “Aligning display objects” on page 33.
24 www.honeywell.com/ps
USING THE TOOLBARS
Button Description
Even Horizontal Spacing. Moves the selected objects (except the outer
two) horizontally so that they are spaced evenly. For example, if you
select three objects, the inner one will move left or right so that is
centered between the two outer ones.
Even Vertical Spacing. Moves the selected objects (except the top and
bottom ones) vertically so that they are spaced evenly. For example, if
you select three objects, the inner one will move up or down so that is
centered between the top and bottom ones.
See “Distributing display objects” on page 34.
Flip Horizontal. Flips the selected objects horizontally (as in a mirror
image).
Flip Vertical. Flips the selected objects vertically.
Rotate Left. Rotates the selected objects 90 degrees clockwise.
Rotate Right. Rotates the selected objects 90 degrees anti-clockwise.
See “Flipping display objects” on page 35.
Lock Objects Toggle. Locks/unlocks an object. Locking an object
protects it from being accidently moved or resized. See “Locking display
objects” on page 32.
25
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
Format Toolbar
The Format toolbar contains buttons for controlling the appearance of display
objects.
You can use Format buttons in two ways:
• If you click a button while one or more objects are selected, it only affects the
appearance of selected object(s).
• If you click a button while no object is selected, you change the display’s
default value (standard value), which is then used whenever you create new
objects in that display. See “Setting the defaults” on page 29.
Button Description
Font. Sets the font of text. Note that you should only use fonts that are
loaded on every Station computer.
Font Size. Sets the size of text.
Justify Left, Justify Center and Justify Right. Align lines of text
within a paragraph.
Line Color. Sets the line color of objects. When you click the button, a
palette opens from which you select the color. See “Selecting colors” on
page 44.
Fill Color. Sets the fill color of objects. When you click the button, a
palette opens from which you select the color. See “Selecting colors” on
page 44.
Line Style. Sets the line thickness.
26 www.honeywell.com/ps
USING THE TOOLBARS
Button Description
Effects. Sets the “3D” effects of objects.
27
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
28 www.honeywell.com/ps
BASIC DRAWING TECHNIQUES
For example, to set the default colors to red line and yellow fill:
1 Make sure no object is selected. (If an object is selected, click a blank part of
the display, or choose Edit > Deselect All.)
2 Click Line Color to open the color palette.
29
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
30 www.honeywell.com/ps
BASIC DRAWING TECHNIQUES
To select: Do this:
One object Click it.
Several objects Hold down SHIFT click each object.
Several objects, which are Drag the pointer diagonally across the objects. This
generally close together selects any object that falls entirely within the “selection
rectangle” which appears while dragging.
One object from a stack of Hold down CTRL and click repeatedly until the object
objects you want is selected. Each time you click, the next
object in the stack (starting from the top) is selected.
Do not click too quickly—if you do, your action will be
interpreted as a double-click.
All objects Choose Edit > Select All.
All objects linked to the Choose Edit > Select Dynamic.
database (dynamic objects)
All objects not linked to the Choose Edit > Select Static.
database (static objects)
No object Click a blank part of the display, or choose Edit >
Deselect All.
To deselect: Do this:
All objects Click a blank part of the display. (If an object, such as a
“background bitmap”, covers the entire display, choose
Edit > Deselect All.)
One or more objects from a Hold down SHIFT and click each object you want to
group of selected objects deselect.
31
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
To lock an object:
1 Select the object.
2 Click Lock Objects. Note how the selection handles turn grey to indicate that
the object is locked.
To unlock a locked object, select it and then click Lock Objects a second time.
32 www.honeywell.com/ps
BASIC DRAWING TECHNIQUES
33
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
34 www.honeywell.com/ps
BASIC DRAWING TECHNIQUES
35
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
36 www.honeywell.com/ps
BASIC DRAWING TECHNIQUES
37
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
Tip If you want to retain the object proportions, hold down SHIFT and drag a
corner handle.
38 www.honeywell.com/ps
BASIC DRAWING TECHNIQUES
39
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
40 www.honeywell.com/ps
BASIC DRAWING TECHNIQUES
For example, to change the font of one or more alphanumerics to 12 point, bold:
1 Select the alphanumeric(s).
2 If necessary, open the Properties Window by clicking Properties Window on
the View toolbar.
3 Click the Font tab.
4 Select 12 from the Size property.
5 Select Bold from the Font style property.
For more information about the Properties Window, see “Using the Properties
Window (DSP displays)” on page 47.
41
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
You cannot rotate a shapelink if the associated shape contains any dynamic
objects. (Shapelinks are described in “Using shapes” on page 51.)
To rotate an object:
1 Click Rotator on the Toolbox toolbar.
2 Click the object you want to rotate.
Four rotation handles appear, as well as a rotation marker—this indicates the
point about which the object rotates.
3 If you want to rotate the object about a specific point, drag the rotation marker
to that point—the point can even be outside the object.
4 Drag one of the rotation handles clockwise or anti-clockwise. As you drag the
handle, the object rotates about the rotation marker.
42 www.honeywell.com/ps
BASIC DRAWING TECHNIQUES
43
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
Selecting colors
Note that a display object linked to the database can only use sixteen colors, these
being: white, gray, black, red, green, cyan, blue, magenta and yellow and their
low-intensity equivalents. If you select a non-standard color, the nearest standard
color will be used.
To select a custom line or fill or line color for the selected objects:
1 Click Line Color or Fill Color, as appropriate to open the color palette.
2 Click Other to open the Color dialog box.
44 www.honeywell.com/ps
BASIC DRAWING TECHNIQUES
3 Click the point in the “color spectrum” box that has the color you want.
There are two other ways of selecting a color. Either, type the HSL or RGB
values in the appropriate boxes, or drag the Color marker (the “x” in the color
spectrum box) and the Saturation marker on the Saturation scroll bar.
4 Click Add to Custom Colors so that the color appears in the next available
Custom colors box.
5 Click the custom color you have just created and then click OK.
45
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
46 www.honeywell.com/ps
USING THE PROPERTIES WINDOW (DSP DISPLAYS)
47
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
The Properties Window is modeless, which means that the selected object(s)
change as soon as you change a property’s value. (Unlike a standard dialog box,
you do not have to click an OK button.)
Properties are grouped according to the tabs that run across the top of the window.
The following examples show how the window changes as you click the tabs.
48 www.honeywell.com/ps
USING THE PROPERTIES WINDOW (DSP DISPLAYS)
49
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
50 www.honeywell.com/ps
USING SHAPES
Using shapes
A shape is, in effect, a “custom object” that is used in displays to present complex
dynamic data. Having created a shape, you can use it as many times as necessary,
including multiple times in the same display.
You add a shape to a display by inserting a shapelink that provides a link to the
shape. The shapelink controls the size and position of the shape in the display.
(Note that if you subsequently change a shape, the displays that include
shapelinks to it are automatically updated, except for size and position.)
There are two types of shape:
• Shape sequence
• Dynamic shape
51
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
Shape sequence
A shape sequence consists of a set of shapes that can be used as either a status
indicator, or as a simple animation.
Amber
Red Green
When used in a display, the status of the associated point determines which of the
three shapes appears in the display. For, example, when the status is 0 (Stop) the
red octagon appears; and when the status changes to 1, the octagon disappears and
amber triangle appears.
Display file
Shapelink
Amber
Shape file
Amber
Red Green
52 www.honeywell.com/ps
USING SHAPES
Notes
• A shape sequence cannot contain any dynamic display objects, such as
alphanumerics and combo boxes.
• All objects that make up a shape must be grouped. In the above example, the
text “Green” and the circle are grouped to form one shape.
• If the shape sequence is to be used as a status indicator, you must create a
separate shape for each state.
• You must arrange the shapes (left-to-right/top-to-bottom) in the appropriate
order. In the case of a status indicator, the top-left shape corresponds to 0, the
next shape corresponds to 1, and so on. In the case of an animation, the top-
left shape represents the first frame, and so on.
53
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
If, for example, there are only four states but the shape file contains eight
shapes, type 4 to use the first four shapes.)
54 www.honeywell.com/ps
USING SHAPES
Dynamic shape
A dynamic shape can contain dynamic objects, such as alphanumerics, that are
designed to be linked to the database.
For example, you could create dynamic shape that represents a pump and contains
two alphanumerics which show the flow rate and pressure. Each time you insert
an instance of dynamic shape into a display, you assign the appropriate point
parameters to the two alphanumerics of that instance.
Notes
• All objects in the dynamic shape must be grouped into one group.
55
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
4 While the shapelink is selected, open the Properties Window and click the
Data tab. This lists each of the dynamic objects in the shape.
5 Specify the appropriate point and parameter details for each object.
56 www.honeywell.com/ps
USING SHAPES
57
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
58 www.honeywell.com/ps
USING SHAPES
59
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
Using SafeBrowse
A SafeBrowse® object is a Web browser specifically designed for use with
Station.
SafeBrowse includes appropriate security features that prevent users from calling
up unauthorized Web pages or other documents in Station. For details about
restricting access, see the “Web access tab, Connection properties” topic in the
“Customizing Stations” section of the Server and Client Configuration Guide.
URL formats
The general format for the URL (Uniform Resource Locator) of a SafeBrowse
object is:
Protocol://ResourceName
Part Description
Protocol The protocol, which can be either http, ftp, gopher,
or file.
The default protocol is file. If the protocol is not
specified, Station assumes that the URL refers to a file,
either on the Station computer or on the network.
ResourceName The resource address or identifier, such as a file or Web
address. If the extension is not specified, Station
assumes that it is a display file.
60 www.honeywell.com/ps
USING SAFEBROWSE
Attention You cannot call up a display if the HTML page is displayed within a
SafeBrowse object.
61
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
To insert a graphic:
1 Choose Edit > Insert Picture to open the Insert Picture dialog box.
2 Select the graphic file you want to insert. If necessary, browse for the file,
restrict the list to the appropriate file type and preview the graphic in the right-
hand box.
3 Move, resize and group the graphic, like any other display object.
You can also paste a graphic from the clipboard. To do this, create your graphic in
a suitable application, copy it to the clipboard and then paste it into your display.
62 www.honeywell.com/ps
PASTING TEXT FROM ANOTHER APPLICATION
63
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
Option Description
Grid settings Specifies the spacing, style and color or grid lines.
The spacing is based on the display’s logical coordinates,
which range from 0, 0 (top, left) to 7999, 4399 (bottom,
right). The default spacing is 100 units.
For more information about logical coordinates, see “About
display coordinates” on page 241.
Page background color Sets the display’s background color in Display Builder. Note
that this does not affect the display when viewed in Station.
Show rulers Shows/hides the rulers. Note that you can change this by
clicking Rulers on the View toolbar.
Show grid Shows/hides the grid. Note that you can change this setting
by clicking Grid on the View toolbar.
Align objects to grid When selected objects automatically align to grid lines when
you create, move or resize them. Note that you can change
this setting by clicking Snap-to-Grid on the View toolbar.
64 www.honeywell.com/ps
WORKING WITH FILES
65
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
Notes
• You cannot change the file’s type after creating it. For example, you cannot
change a shape sequence into a dynamic shape.
• For instructions specific to creating a dynamic shape, see “Creating a dynamic
shape” on page 55; for instructions specific to a shape sequence, see “Creating
a shape sequence” on page 53.
66 www.honeywell.com/ps
WORKING WITH FILES
Item Description
File name The display’s name or number. See “Named versus
numbered displays” on page 67.
Save as type The display’s format. (By default, Display Builder uses the
current format.)
You only need to select an earlier format if you are creating a
display for an earlier version Experion, or for an earlier
product. See “Saving displays in earlier formats” on
page 68.
Named displays
An advantage of a named display is that Station users can call up it up by typing
the display’s filename (without the extension) in the Command Zone. It is also
easier for users to remember an intuitive name like “overview” than a number
such as “309”.
Notes
• If you want to assign the display to a function key so that users can press the
key to call up the display, the filename must not be longer than 20 characters.
• If the filename only contains numbers, such as 1234.dsp, users must also
include the extension when calling up the display from the Command Line.
Numbered displays
A display must be numbered if:
• You want to configure the PAGE UP and PAGE DOWN keys so that they call
up the next/previous pages. Both the page for which you configure the keys
and the pages you call up must be numbered pages.
• You want the display listed in the Display Summary.
• An Algorithm (“algo”) references the display.
• The point cross-reference report references the display.
67
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
Page numbering for custom displays starts at 301. (Numbers 1 to 300 are reserved
for the system displays supplied with Experion.) The maximum page number
depends on system sizing, and available disk space.
Attention When saving a display in an earlier format, only features supported by that
format will be saved.
68 www.honeywell.com/ps
WORKING WITH FILES
Opening a file
To open an existing Display Builder file, choose File > Open and use the Open
dialog box to select the file you want to open.
Attention If you open a file saved in an earlier file format, Display Builder
automatically opens it in the current format. Having made the required
changes, you must therefore select the original format when saving it if you
want to retain the earlier file format.
69
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
70 www.honeywell.com/ps
DISTRIBUTING AND VALIDATING FILES
71
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
Distributing files
There are two storage techniques for displays and shape files:
• Centralized, where all files are stored centrally on the server, and accessed by
Stations as required.
• Distributed, where each Station has its own copies on a local folder. (This
storage technique reduces communication traffic and call-up delays because
Stations do not have to download display files before displaying them.)
72 www.honeywell.com/ps
DISTRIBUTING AND VALIDATING FILES
73
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
74 www.honeywell.com/ps
Defining display object
properties 3
This chapter describes display object properties, which you access through the
Properties Window (described in “Using the Properties Window (DSP displays)”
on page 47).
If the Properties Window is not open, click Properties Window in the View
toolbar.
75
3 – DEFINING DISPLAY OBJECT PROPERTIES
Animation tab
The animation tab controls the correspondence between the object’s color and the
value or status of the associated point.
Property Description
Type of animation The type of animation used for the object:
• Color breakpoints. The color changes as the
value changes. You can specify up to nine colors and
the percentage range for which each color applies.
(For example, you could make an object turn red
when the value is between 90 and 100 percent of its
range.)
• Level fill. When the value is low, the color
applies to only the bottom part of the object; as the
value rises, the color rises to fill more of the object.
• Shape sequence. Only applicable to a shapelink.
Specifies the number of shapes in the shape sequence
you want to use. See “Inserting a shape sequence into
a display” on page 53.
Note that the Details properties change in accordance
with the selected type of animation.
76 www.honeywell.com/ps
ANIMATION TAB
Property Description
Details These properties change in accordance with the option
selected in Type of animation.
Type of breakpoint specifies how the color changes:
• Continuous. (Only applicable to analog values.)
The color changes as the value changes. You can
specify up to nine colors and the percentage range for
which each color applies. (For example, you could
make an object turn red when the value is between 90
and 100 percent of its range.)
• Discrete. The color changes as the state changes.
You define a separate color for each state. Select
Inverse if you want to animate the fill color rather
than the line color—this produces a “reverse video”
effect, which makes text stand out providing you
have selected an appropriate color scheme.
Indicate alarm state with color Station overrides the current color with the system-
defined colors during alarm or off scan states. (The
system-defined colors are specified in “System-defined
colors” on page 77.)
Not applicable if you select the Shape sequence option.
System-defined colors
77
3 – DEFINING DISPLAY OBJECT PROPERTIES
Appearance tab
The Appearance tab controls the object’s overall appearance, such as its fill color
and line thickness.
Property Description
Colors These properties control the object’s line and fill colors.
Lines These properties control the line characteristics, such as
dashed lines and arrows at line ends.
78 www.honeywell.com/ps
CUSTOM XY TAB
Custom XY tab
Not applicable to Experion.
79
3 – DEFINING DISPLAY OBJECT PROPERTIES
Data tab
The Data tab specifies the object’s link to the database. The Type of database
link property specifies the type of link:
• Point/Parameter. The object is linked to a point parameter. See “Defining a
link to a point” on page 81.
• Database file. The object is linked to a file in the server database, whose
contents are controlled by another application. See “Defining a link to a
database file” on page 83.
• None. The object has no link to the database. See “Using local display objects”
on page 85.
80 www.honeywell.com/ps
DATA TAB
Property Description
Point The ID of the point to which the object is linked.
If you are working remotely—not on a server—type the
point’s ID. (When the display is finalized, you should
check that the IDs are valid—see “Checking the validity
of point IDs in remotely-built files” on page 71.)
If you are creating the display on a server, you can
normally select the ID from the list. (However, in a
multi-server system, the server you are working on may
not know of the existence of every point in the system.)
Parameter The point parameter to which the object is linked.
If you select a history parameter, such as H24H, History
offset controls which history value is used. (0, the
default, represents the latest history value, 1 represents
the second-to-last value, and so on.)
81
3 – DEFINING DISPLAY OBJECT PROPERTIES
Property Description
Data entry allowed Allows users to edit the object’s value. (See “About the
Value Property” on page 163.)
If you select Data entry allowed, Security Level
appears, from which you select the appropriate level.
(Only users with the specified level, or higher, can enter
data.)
82 www.honeywell.com/ps
DATA TAB
Property Description
File The number of the file to which the object is linked.
Select the indexing option from the list opposite:
• No indexing.
• Indexed by file offset. Adds Station’s current
file offset to the file number. The offset can be set by
scrollbars, by the host and by the PAGE UP and
PAGE DOWN keys.
83
3 – DEFINING DISPLAY OBJECT PROPERTIES
Property Description
Record The number of the record within the file. Select the
indexing option from the list opposite:
• No indexing.
• Indexed by record offset. Adds Station’s
current record offset to the record number. The offset
can be set by scrollbars, by the server and by the
PAGE UP and PAGE DOWN keys.
• Indexed by field offset. Adds Station’s
current field offset to the word number. The offset
can be set by scrollbars, by the server and by the
PAGE UP and PAGE DOWN keys.
• Indexed by Station no. Each Station uses
separate records in the user file. The effect is to view
the User file as a series of logical files, one for each
Station. Set the record and word numbers as normal;
for example, if you want the link to refer to the
second record for each Station, set Record to 2.
Word The word number within the file. Select the indexing
option from the list opposite:
• No indexing.
• Indexed by field offset. Adds Station’s
current field offset to the word number. The offset
can be set by scrollbars, by the server and by the
PAGE UP and PAGE DOWN keys.
Format The data format.
If you select String, you must specify the length of the
string.
If you select Bits, you must specify the starting bit and
the number of bits within the word.
Read from oldest record of Applicable if it is a circular file and you want to read the
circular file oldest record first.
Data entry allowed Applicable only to a text object. Allows users to edit
Security level currently displayed text.
If you select Data entry allowed, you must also select a
Security level. (Only users with the selected level, or
higher, can enter data.)
84 www.honeywell.com/ps
DATA TAB
85
3 – DEFINING DISPLAY OBJECT PROPERTIES
Details tab
The Details tab contains properties that are specific to each type of object.
86 www.honeywell.com/ps
DETAILS TAB
Property Description
File Name The URL (Uniform Resource Locator) of the document
that you want to display. If necessary, find the document
by clicking Browse.
87
3 – DEFINING DISPLAY OBJECT PROPERTIES
Property Description
Type The type of message the object displays, such as alarm
or event.
Alarm priorities displayed Only messages with the specified priorities are
displayed.
88 www.honeywell.com/ps
DETAILS TAB
Alphanumeric object
Property Description
Display as These properties specify how the point parameter
Details information is displayed. See “Alphanumeric display
options” on page 89.
Number of characters The maximum number of characters that can be
displayed displayed.
Word wrap Selecting Word wrap allows the value (normally text)
to appear over several lines, where it is longer than the
object’s width.
Local edit Indicates that when a user edits the object’s value, the
edited value is stored locally, rather than being sent to
the server. Also, pressing ENTER inserts carriage
returns, instead of sending the contents to the server.
In practice, this option is only used for the “message
object” on the message pad system display.
89
3 – DEFINING DISPLAY OBJECT PROPERTIES
90 www.honeywell.com/ps
DETAILS TAB
Chart object
Property Description
Plot You can simultaneously display the values of up to eight
points, depending on the type of chart you have selected
in the Chart type property on the Options tab.
Point ID The IDs of the points whose values you want to display.
Parameter The point parameter(s) whose values you want to
display.
Color The color used to display the values of the associated
point on the chart.
91
3 – DEFINING DISPLAY OBJECT PROPERTIES
Checkbox object
Property Description
Label The descriptive text that appears to the right of the
checkbox.
Use inverse logic Reverses the standard checkbox logic, so that it
corresponds to the wording of Label. (In standard logic,
checked equals “1”.)
For example, labelling a checkbox “Open” would
require the opposite logic to labelling it “Close”.
92 www.honeywell.com/ps
DETAILS TAB
Combobox object
Property Description
Display as Specifies how the object is animated. See “Selecting the
Details display options for a combobox object” on page 93.
93
3 – DEFINING DISPLAY OBJECT PROPERTIES
94 www.honeywell.com/ps
DETAILS TAB
Indicator object
Property Description
Display as Specifies how the object is animated. See “Selecting the
display options for an indicator object” on page 95.
Orientation Specifies whether the indicator moves vertically or
horizontally.
Level fill color The color of the bar or pointer.
95
3 – DEFINING DISPLAY OBJECT PROPERTIES
Pushbutton object
Property Description
Label The pushbutton’s label.
Action The action performed when a user clicks the pushbutton.
Details See “Defining a pushbutton’s action” on page 96.
96 www.honeywell.com/ps
DETAILS TAB
97
3 – DEFINING DISPLAY OBJECT PROPERTIES
SafeBrowse object
Property Description
URL The URL (Uniform Resource Locator) of the document
that is displayed in the browser object. See “Using
SafeBrowse” on page 60.
98 www.honeywell.com/ps
DETAILS TAB
Scrollbar object
For an introduction to scrollbars, see “About scrollbars” on page 99.
Property Description
Minimum, Maximum, Range These parameters specify the range and other
visible and File number characteristics of the scrollbar. See “Defining the
scrollbar range” on page 102.
Minimum at bottom/right Specifies which end of the scrollbar represents the
minimum value. If not selected, the minimum value is at
the top or left end, depending on the scrollbar’s
orientation.
About scrollbars
Scrollbars can control:
• A value in the server database. For example, you could use a scrollbar to
control the value of a set point.
• A value in a script.
• An offset to a record or field for the display. Used in this way, the scrollbar
controls any other display objects that use the offset.
99
3 – DEFINING DISPLAY OBJECT PROPERTIES
Maximum value
Minimum value
100 www.honeywell.com/ps
DETAILS TAB
3445 4249.84
3446 234.07
3447 83449.23
3448 7559.45
Value Description
Record Offset Controls the current record offset for the display. See
“Using a scrollbar to control the offset” on page 100.
When a user moves the scroll box, the current record
offset changes. This affects any other objects in the
display for which Indexed by record offset is
selected on the Data tab—see “Defining a link to a
database file” on page 83.
Field Offset Controls the current field offset for the display. See
“Using a scrollbar to control the offset” on page 100.
When a user moves the scroll box, the current field
offset changes This affects any other objects in the
display for which Indexed by field offset is
selected on the Data tab—see “Defining a link to a
database file” on page 83.
Database File or Controls a value in the database. See “Using a scrollbar
Point/Parameter to set a value” on page 100.
101
3 – DEFINING DISPLAY OBJECT PROPERTIES
Item Description
Minimum The minimum value that the scrollbar can scroll to.
If you select Point/Parameter or Database file
from Type of database link on the Data tab, this
property is ignored and the minimum database value is
used.
Maximum The maximum value that the scrollbar can scroll to.
If you select Record Offset or Field Offset from
Type of database link on the Data tab, and want to
access all records or fields, set the value to 0. If you
select Point/Parameter or Database file, this
property is ignored and the maximum database value is
used.
Range visible Controls the relative width of the scroll box, with respect
to the total length of the scrollbar. For example, if you
set Maximum to 100, Minimum to 0, and Range
visible to 20, the scroll box will be one fifth the length of
the scrollbar.
File number Only applicable if you select Record Offset or Field
Offset from Type of database link on the Data tab.
Specifies the file whose record or field the scrollbar is
offsetting.
102 www.honeywell.com/ps
DETAILS TAB
Text object
Property Description
Label The text that appears in the display.
103
3 – DEFINING DISPLAY OBJECT PROPERTIES
Font tab
The font tab controls the appearance of the object’s text, such as the font and
point size.
Property Description
Font Text is displayed in the selected font. Note that you
should select fonts with care, and only use fonts that are
suitable for computer displays.
Size The text size, expressed in points.
Style The text style, such as italics.
Justify The horizontal alignment of text within the object.
Effects Strikeout draws a line through the text and Underline
draws a line under it.
104 www.honeywell.com/ps
GENERAL TAB
General tab
The General tab controls the object’s position and size.
Property Description
Name The object’s name. You use this name when referring to
the object in scripts.
Position The object’s position and size, expressed in logical units.
(For a description of logical units, see “About display
coordinates” on page 241).
Rotation Angle indicates the clockwise angle through which the
object has been rotated.
The Center properties indicate the logical coordinates of
the point about which the object has been rotated.
Visible Indicates that the object is visible in Station.
Note that you can use an invisible object as a
placeholder for information, so that it can be accessed by
scripts.
Tab stop Allows users to “select” the object by pressing TAN.
If you enable Tab stop for several objects in a display,
the tabbing order progresses from left-to-right and top-
to-bottom.
105
3 – DEFINING DISPLAY OBJECT PROPERTIES
Options tab
The Options tab is only applicable to a chart object, and controls its major
characteristics, such as its type (line, pie and so on) and the rate at which it plots
new values.
Property Description
Chart type The type of chart—see “Selecting the type of chart” on
page 107.
Axis Specifies the colors used for the legend text and its
background.
History type The interval between samples.
Samples The number of samples you want to display, between 1
and 1000. The default is 61. Note that the larger the
number of samples, the heavier the load on the server
and the longer the time required to update the chart.
Units Specifies whether samples are displayed as percentage
values or as engineering units.
106 www.honeywell.com/ps
OPTIONS TAB
107
3 – DEFINING DISPLAY OBJECT PROPERTIES
Repeats tab
The Repeats tab reduces the amount of work required when creating repetitive
displays. For example, if you wanted to create a list of point values, you would
create only one alphanumeric object and use the Repeat tab to create all the other
objects. You can also specify the relative position of each repeated object, as well
as the relative address of each point.
Note that repeated objects are created as a group.
Property Description
Number The number of objects you want.
Orientation Determines whether repeated objects appear either
below or to the right of the original object.
Spacing The inter-object spacing, expressed in logical units. (For
a description of logical units, see “About display
coordinates” on page 241.)
108 www.honeywell.com/ps
REPEATS TAB
Property Description
Increment The increment option:
• Point ID. Increments the point ID, starting from the
ID specified in the original display object.
• Parameter. Increments the point parameter for the
point ID specified in the original display object.
• History offset. Increments the history offset.
Only applicable to history parameters.
• Value. Only applicable for alphanumerics. Used to
create a sequence of numbers. See “Repeating a
numeric value” on page 109.
• File, Record and Field. Only applicable if the
original display object is linked to a user file.
Increments the specified option. For example, the
Record option, increments the record number.
• Parameter 1 to Parameter 4. Only applicable for
pushbuttons. Specifies which task request parameter
is incremented.
109
3 – DEFINING DISPLAY OBJECT PROPERTIES
Property Value
Type of database link Database file
File 2
Record 1 and Indexed by Station no.
Word 253
Format Integer 4
110 www.honeywell.com/ps
XY PLOT TAB
XY Plot tab
The XY Plot tab only appears when you select X-Y Plot from Chart Type on the
Options tab.
Property Description
Range The minimum and maximum percentage values of the X
and Y axes.
Marker The type of marker used in the graph:
• Circles mark successive plot values.
• Line draws vertical and horizontal lines that
intersect at the current plot value.
• Graph draws a line.
Use historical data Only applicable if you select the Graph option from
Marker. Specifies whether to use historical data, or
only to plot new samples while the chart is displayed.
111
3 – DEFINING DISPLAY OBJECT PROPERTIES
About acronyms
An acronym describes the meaning of a parameter’s state (or integer value). For
example, the acronyms “Stopped” and “Running” are much more meaningful in
displays than the raw parameter values “0” and “1”.
The default acronym file contains acronyms suitable for most purposes.
Acronyms in this file are divided into two ranges:
• System. These are supplied with Experion, and include commonly required
acronyms. System acronyms are stored in records 1 to 2048.
• User. These records are initially blank, so that you can define your own
acronyms as required. User acronyms are stored in records 2881 to 3880.
You define user acronyms in Station by selecting Configure > Acronyms > User.
The following figure shows how acronyms are stored in the default acronym file.
Related acronyms are stored as contiguous records in the order corresponding to
the parameter values. For example, “Closed” (record 3342) represents 0, and
“Open” (record 3343) represents 1.
To select a set of acronyms, you specify the starting record, as well as the number
of records you require. For example, if you wanted to use Stopped, Slow, Medium
and Fast, you would set the starting record to 3444 and the number of records to
4.
3441 ...
3442 Closed
3443 Open
3444 Stopped
3445 Slow
3446 Medium
3447 Fast
3448 ...
If the default acronym file is not sufficient for your needs, create your own
acronym files—see “Using custom acronyms” on page 114.
112 www.honeywell.com/ps
ABOUT ACRONYMS
Property Description
Start at acronym The record that contains the first acronym.
System acronyms are stored in records 1 to 2048, and
user-defined acronyms are stored in records 2881 to
3880.
Number of acronyms The number of acronyms you want to use.
Preview If you are on the server, and you press TAB, the selected
acronyms appear in this box.
113
3 – DEFINING DISPLAY OBJECT PROPERTIES
Task: Go to:
Create a custom acronym file with the correct size and format. page 114
Create a Custom Acronyms display. (Functionally, this display is identical page 114
to the standard acronym displays used to manage the system/user acronyms
in the default acronym file.)
Add the Custom Acronym display to Station’s Acronyms menu page 115
Define the acronyms, in Station, using the display page 115
Assign custom acronyms to display objects page 115
114 www.honeywell.com/ps
ABOUT ACRONYMS
115
3 – DEFINING DISPLAY OBJECT PROPERTIES
Property Description
File The file that contains the custom acronyms.
Start at record The record that contains the first acronym.
Number of acronyms The number of acronyms you want to use.
Start at word The word that contains the first acronym.
Length of acronyms The length of the acronyms.
Location Specifies how the acronyms are stored within the file:
• Consecutive records
• Single record, where the acronyms are stored in
consecutive words with the same record.
Preview If you are on the server, and you press TAB, the selected
acronyms appear in this box.
116 www.honeywell.com/ps
Defining display and shape
properties (DSP) 4
If the Properties Window is not open, choose File > Properties. If the Properties
Window is open, but one or more objects is selected, choose Edit > Deselect All.
117
4 – DEFINING DISPLAY AND SHAPE PROPERTIES (DSP)
Property Description
Title The display’s title that appears in the Station Title Bar
(and in the Display Summary display if it is a numbered
display).
Description Any notes or comments about the display.
118 www.honeywell.com/ps
DETAILS TAB FOR A (DSP) DISPLAY
Property Description
Type Specifies the display’s type. Select Standard, the
default, unless you are creating a special-purpose
display.
Select Point Detail if you are creating a point detail
display for a new type of point. See “Creating a point
detail display” on page 284.
The other display types are generally only used by
Honeywell personnel.
Zooming allowed If this check box is cleared, operators cannot zoom in/
out on the display.
Single use application set Only applicable if the display is to be used by a multi-
window Station.
An application set consists of two or more related
displays that must never be simultaneously displayed.
The name of each application set must be unique.
SafeView window category Only applicable if the display is to be used in
conjunction with SafeView.
The window category, which determines how SafeView
handles the display. The standard categories are:
• HW_System_Alarm_Summary. The Alarm
Summary.
• HW_System_Detail. A point detail display.
• HW_System_Faceplate. A faceplate.
• HW_System_Group. A group display.
• HW_System_Trend. A trend.
• HW_System_Display. A system display other than
the above categories.
Alternatively, type the name of the user-defined
category.
Allow callup for Specifies the asset assignment required to call up the
display. See “Restricting page callup” on page 121.
Refresh rate By default, Station updates all displays at a standard
rate, typically once every five seconds. This option
allows you to specify a slower rate for the display. (If the
display is particularly complex, slowing the refresh rate
will reduce the load on the system.)
119
4 – DEFINING DISPLAY AND SHAPE PROPERTIES (DSP)
Property Description
Previous display idle timeout Station displays the previous display if there has been no
user activity for the specified period.
Numbered display Used to create a numbered display. The reasons for
creating a numbered display are described in “Named
versus numbered displays” on page 67.
If you select Numbered display, you type the page
number in the opposite box which is revealed.
120 www.honeywell.com/ps
DETAILS TAB FOR A (DSP) DISPLAY
121
4 – DEFINING DISPLAY AND SHAPE PROPERTIES (DSP)
Property Description
Key A key and the associated action it performs when
Action pressed.
To assign an action to a key, select the key from the list
and then the action. Repeat for each key as required.
Enable application control keys Not applicable to Experion.
122 www.honeywell.com/ps
CALLUP TASK TAB FOR A (DSP) DISPLAY
Notes
• Do not call up a periodic task in the Callup Task properties of a display. If
you want to perform the task at regular intervals while the display is visible,
use the Periodic Task tab.
• Do not call up the Server Display Program (LRN 21) task in the Callup Task
properties of a display. It does not make sense to call up another page on
display callup.
• For more information about displaying the LRN assigned to an application
program, see the Application Development Guide.
Property Description
Request task on page callup Select this to specify a callup task.
Details The task details, including its LRN (task identifier),
parameters and the security level required to perform the
task.
Attention DEPRECATED. The use of the following
option is provided only for legacy systems
which may have made use of this functionality.
The recommended method is to use
multithreading instead of Station offsets.
If you select Add station number offset to LRN, a
separate task is performed on each Station. (The number
of the task performed on a particular Station is equal to
the sum of the specified LRN and the Station’s number.)
123
4 – DEFINING DISPLAY AND SHAPE PROPERTIES (DSP)
Property Description
Request task periodically Select this to specify a periodic task.
Details The task details, including its LRN (task identifier),
parameters and the security level required to perform the
task.
Attention DEPRECATED. The use of the following
option is provided only for legacy systems
which may have made use of this functionality.
The recommended method is to use
multithreading instead of Station offsets.
If you select Add station number offset to LRN, a
separate task is performed on each Station. (The number
of the task performed on a particular Station is equal to
the sum of the specified LRN and the Station’s number.)
Request every The request interval, specified in display update
intervals. (By default, Station updates all displays at the
same rate, typically every five seconds. However, you
can specify a longer interval in Refresh rate on the
General tab.)
124 www.honeywell.com/ps
HELP TAB FOR A (DSP) DISPLAY
125
4 – DEFINING DISPLAY AND SHAPE PROPERTIES (DSP)
Figure 48 Help tab for a display—specifying a HTML Help topic by its number
Property Description
Help file name The HTML Help filename, including its chm extension.
If the file is not in one of Station’s display folders, you
must include the full path.
Help file type Automatically set to HTML Help when you specify the
filename’s chm extension.
126 www.honeywell.com/ps
HELP TAB FOR A (DSP) DISPLAY
Property Description
Help Topic The help topic associated with the display.
To specify the topic’s internal filename, set
Locate topic by to Topic file and specify the
filename of the topic in Topic file.
To specify the topic’s number, set Locate topic by to
Topic number and specify the number in
Topic number.
127
4 – DEFINING DISPLAY AND SHAPE PROPERTIES (DSP)
Figure 49 Help tab for a display—specifying a help document other than an HTML Help file
Property Description
Help file name The filename of the document, including its extension.
If the file is not in one of Station’s display folders, you
must include the full path.
Help file type Automatically set to Document if its extension is not
chm.
128 www.honeywell.com/ps
GENERAL TAB FOR A SHAPE FILE
Property Description
Title The title of the shape file.
Description Any notes or comments about the shape.
Numbered shape Not applicable to Experion.
Use first shape for bad value Only applicable to a shape sequence. If selected, Station
displays the first shape if the associated point no longer
exists.
129
4 – DEFINING DISPLAY AND SHAPE PROPERTIES (DSP)
130 www.honeywell.com/ps
Scripting reference
5
This chapter describes how to enhance the functionality of your displays with
display scripts. (A script is a mini-program that performs a specific task.)
131
5 – SCRIPTING REFERENCE
Scripting basics
This section introduces you to the various features and rules that are applicable to
writing DSP display scripts for use with Display Builder (and not HTM display
scripts as used with HMIWeb Display Builder).
You write DSP display scripts in VBScript, a popular scripting language, which
does not require extensive programming skills and is relatively easy to use.
Select Help > VBScript Reference to display the VBScript Language Reference,
which is installed with Display Builder.
Attention The use of the plain term “script” in the Display Building Guide refers to
VBScript only, unless suitably qualified.
VBScript language is case insensitive, so objects such as “application” are
interpreted the same as “Application”, “APPLICATION” or “ApLiCaTiOn”.
VBScript in interpreted line-by-line. Each command instruction must be written
on a separate line. The line-break signifies the end of a command instruction
(unlike other scripting languages such as JavaScript which uses a semicolon to
indicate the end of a command instruction).
Tip If you prefer to use another scripting language such as JavaScript, you
need to use the HMIWeb Display Builder (which supports JScript) rather
than using Display Builder (which only supports the use of VBScript).
In VBScript, comments are preceded by an apostrophe. You should always
comment your code to briefly describe its intent. This will greatly assist you in
code maintenance and debugging.
VBScript is event driven, however, timers can be used in DSP display scripts for
running scripts at regular intervals.
In DSP display scripts, event handlers are assigned to objects by appending the
event to the object name with an underscore character.
For example, to assign the onClick event to a display object named “Pump2”, you
would name the VBScript subroutine “Pump2_onClick”:
Sub Pump2_onClick()
'perform some action here
End Sub
In DSP display scripts, you do not need to specify the object name in a script if
the script is attached to that object. For example, the following script changes the
“FillColor” property of the “Rect1” object:
Sub Rect1_onAlarm()
FillColor = vbRed
End Sub
132 www.honeywell.com/ps
SCRIPTING BASICS
To access the properties of another object on the page, you specify the object’s
name. For example, the following script accesses the “FillColor” property of the
“Rect1” object from another object on the page, such as a pushbutton:
Sub bntAck_onClick()
Rect1.FillColor = vbBlue
End Sub
DSP display scripts access the Station’s menu, toolbar, Message Zone, and
Command Zone through the root “Application” object.
Attention Do not use the VBScript “MsgBox” function in Station. To send a message
to the operator, you should only ever use the Station Message Zone.
Application.MessageZoneText = “Your message goes here”
Further details and examples are provided in the following topics to guide and
assist you in the development of your DSP display scripting.
133
5 – SCRIPTING REFERENCE
Validating events
Event handlers are called before the events are processed. This means that you
can use scripts to verify whether an event should proceed, canceling it if
necessary. The following example compares the user-entered value with the limit
and cancels the change if the value is greater than the limit.
Sub Alphanum1_OnChange(vNewValue)
tempvalue = CInt(vNewValue)
If tempvalue > Limit Then
MsgBox "Value must be below " & CStr(Limit) & "."
CancelChange()
End If
End Sub
134 www.honeywell.com/ps
SCRIPTING BASICS
135
5 – SCRIPTING REFERENCE
136 www.honeywell.com/ps
SCRIPTING BASICS
137
5 – SCRIPTING REFERENCE
138 www.honeywell.com/ps
SCRIPTING BASICS
139
5 – SCRIPTING REFERENCE
140 www.honeywell.com/ps
SCRIPTING BASICS
Using timers
Timers provide a convenient mechanism for running scripts at regular intervals.
For performance reasons, timers with intervals of less than 100ms are not
recommended.
For example, to “move” a display object across the display, you would:
1 Create a timer for the display object using the object’s CreateTimer method.
(A timer interval of about 250ms would be suitable.)
2 Write an OnTimer event for the object which moves the object a small
distance (to the left or right) when it fires.
141
5 – SCRIPTING REFERENCE
142 www.honeywell.com/ps
WRITING SCRIPTS FOR DISPLAYS AND SHAPE FILES
Notes
• Objects that already have scripts are shown in bold in the Object list.
Similarly, events that contain scripts for the selected object are shown in bold
in the Event list.
• The Script Editor supports the Cut (CTRL+X), Copy (CTRL+C) and Paste
(CTRL+V) functions.
• Changes to scripts are added to the display file when you select another object
or event; however, they are only saved to disk when you save the display file.
• The syntax of your script is checked when you select another object or event.
Any syntax errors are displayed via a message box.
• You can change the font by right-clicking in the Script Editor and selecting
Font from the floating menu.
143
5 – SCRIPTING REFERENCE
Notes
• For details about creating an SSO, see the Application Development Guide.
• Station is represented by the HMIWeb Object Model, in particular the
Application and AppWindow objects. (Note that the objects with the same
name in this document represent the old version of Station.) For details, see
the HMIWeb Display Building Guide.
• The sample Visual Basic project for an SSO.vbp provides the framework for
implementing an SSO. (The project and associated components are zipped
into SSO_Sample.zip. This file is located in Station\Samples.)
144 www.honeywell.com/ps
ABOUT THE POSSIBILITIES OF AUTOMATION
Attention This topic has not been updated to reflect HMIWeb-related changes to
Station’s functionality. For the updated information, see the scripting
section in the HMIWeb Display Building Guide.
Apart from making scripting possible, the Station Automation object model also
allows other applications to control Station. Other applications interact with a
Station object in the same way as does a script; that is, by using the object’s
properties, methods and events.
Conversely, because many other applications, such as Microsoft Excel, also have
Automation object models, you can control them via Station scripts. For example,
you could use the sophisticated charting features of Excel to display system
information in a manner that is not possible using only Station.
Getting two programs to interact requires considerable programming skills that
are beyond the scope of this guide. However, the two examples, “Controlling
Station from another application” on page 247 and “Controlling another
application from Station” on page 248 give an idea of what is possible.
145
5 – SCRIPTING REFERENCE
AppWindow
Page
146 www.honeywell.com/ps
OVERVIEW OF THE STATION AUTOMATION OBJECT MODEL
Objects collection
Display Object #1
Page
Display Object #n
The Page model includes the Display objects, each of which represents an
individual display object, such as a rectangle, alphanumeric or pushbutton.
The Page model also includes the Objects collection, which contains the top-level
display objects on the page. (Note that each group and shapelink has its own
Objects collection, consisting of the display objects that make up the group or
shapelink.)
About objects
Think of an object as a convenient way of interacting with a particular part of
Station, or one of its displays. When writing scripts, you need to become familiar
with three object-related terms:
• Properties, which are the object’s attributes or characteristics. A display
object, for example, has properties such as FillColor, Height and Width.
Consequently, you change the color of a display object by changing the value
of its FillColor property.
• Methods, equivalent to the terms “function” or “command”, which are
applicable to the object. For example, the Page object has a Redraw method,
which redraws the current display.
• Events, such as alarms and user actions, which are applicable to the object. A
display object, for example, has events such as OnClick (which occurs when a
user clicks the object) and OnLoad (occurs when the object is first loaded).
147
5 – SCRIPTING REFERENCE
Objects
The objects are listed in alphabetical order.
148 www.honeywell.com/ps
OBJECTS
Application object
Description
The Application object is Station’s root object. It represents Station’s window,
Menu, Toolbar, Message Zone and Command Zone. All other objects in the
object hierarchy can be reached from the Application object.
Attention This topic has not been updated to reflect HMIWeb-related changes to
Station’s functionality. For the updated description, see the “Application
object” topic in the “HMIWeb Object Model reference” section of the
HMIWeb Display Building Guide.
Syntax
For scripts:
Application
Remarks
• The Application object cannot be referenced from within the general script
section.
Properties
Property Description
AlarmZonePointID Returns the ID of the current alarm point. (The
associated alarm appears in the Alarm Line.)
AlarmZonePointServerAli Returns the alias of the server on which the current
asName alarm point resides.
AlarmZonePointServerNet Returns the base-name of the server on which the
workName current alarm point resides.
Application Returns the Application object.
AppWindow Returns the AppWindow object.
AreSafeBrowseRightMouse Returns True if right-clicking a SafeBrowse object is
ClicksAllowed allowed (that is, displays the shortcut menu). If not, it
returns False.
CommandZoneText Sets, but does not execute, the command that appears in
the Command Zone. To execute the command, the user
must press ENTER.
149
5 – SCRIPTING REFERENCE
Property Description
CurrentFieldOffset Sets or returns the sequence number of the current field
in the current record/database. For example, a value of 3
represents the third field in the record.
Used in conjunction with the CurrentRecordOffset and
CurrentFileOffset properties to uniquely identify a
particular field.
CurrentFileOffset Sets or returns the sequence number of the current file
(in the set of files). For example, a value of 3 represents
the third file in the set.
Used in conjunction with the CurrentRecordOffset and
CurrentFieldOffset properties to uniquely identify a
particular field.
CurrentPage Sets or returns the name of the current display. If set,
Station displays that display.
CurrentPointID Returns the ID of the currently selected point.
CurrentPointServerAlias Returns the alias of the server on which the currently
Name selected point resides.
CurrentPointServerNetwo Returns the base-name of the server on which the
rkName currently selected point resides.
CurrentRecordOffset Sets or returns the sequence number of the current
record in the current file. For example, a value of 3
represents the third record.
Used in conjunction with the CurrentFieldOffset and
CurrentFileOffset to uniquely identify a particular field.
DetailPointID Only applicable if the current display is a Point Detail
display. Returns the ID of the point whose details are
currently displayed.
DetailPointServerAliasN Only applicable if the current display is a Point Detail
ame display. Returns the alias of the server on which the
point, whose details are currently displayed, resides.
DetailPointServerNetwor Only applicable if the current display is a Point Detail
kName display. Returns the base network name of the server on
which the point, whose details are currently displayed,
resides.
Dictionary Returns the Dictionary collection.
150 www.honeywell.com/ps
OBJECTS
Property Description
EchoSafeBrowseMessage If set to False, prevents a SafeBrowse object from
writing messages to the Message Zone. (Typical
messages include “Web site found” and “downloading”.)
If set to True (the default) Safe Browse messages
appear in the Message Zone.
The property is reset to True when another display is
called up or when a new document is loaded into the
SafeBrowse object.
MessageZoneText Sets or returns the text that appears in the Station’s
Message Zone.
OperatorID Returns the:
• Operator ID if the Station is configured for operator-
based security
• Station number if the Station is configured for
Station-based security
Page Returns the Page object.
PageBackgroundColor Sets or returns the background color of the current
display. The colors are:
0 = Black
1 = Grey
2 = White
3 = Red
4 = Green
5 = Blue
6 = Cyan
7 = Magenta
8 = Yellow
9 = Default
Anything greater than 9 results in a black background
color.
Attention In a multi-window Station, changing the color
will change the background color of all current
and subsequent displays.
Parent Returns the Station object.
151
5 – SCRIPTING REFERENCE
Property Description
SecurityLevel Returns the user’s security level. The values are:
0 = View Only
1 = Ack Only
2 = Operator
3 = Supervisor
4 = Engineer
5 = Manager
ServerName Returns the name of the Server to which the Station is
connected.
StationNumber Returns the Station’s server connection number.
Methods
BeginCriticalSection method
Blue method
CancelOperatorCommand method
CreateTimer method
CrossScreenInvocationPending method
EndCriticalSection method
ExecuteOperatorCommand method
GetResponse method
Green method
InvokeMenu method
KillTimer method
MakeColor method
Quit method
Red method
RequestServerLRN method
Shell method
UserObjectNotify method
Events
OnAlarm event
OnAppStartup event
152 www.honeywell.com/ps
OBJECTS
OnConnect event
OnDisconnect event
OnMenu event
OnMenu2 event
OnOperatorChange event
OnOperatorCommand event
OnPageLoad event
OnPeriodicUpdate event
OnQuit event
OnTimer event
OnUserObjectNotify event
153
5 – SCRIPTING REFERENCE
AppWindow object
Description
The AppWindow object represents the Station window, and contains the
properties that reflect the current state of the main window.
Attention This topic has not been updated to reflect HMIWeb-related changes to
Station’s functionality. For the updated description, see the “AppWindow
object” topic in the “HMIWeb Object Model reference” section of the
HMIWeb Display Building Guide.
Syntax
Application.AppWindow
Properties
Property Description
Application Returns the Application object.
DisplayHWND Returns the “handle” allocated by Windows to the
window that includes the display and its surrounding
border. (See “Mouse coordinates” on page 241.)
Height Sets and returns the height of the Station window.
The range depends on Windows’ screen setting. For
example, if the setting is 1280x1024, the height can be
up to 1024.
HWND Returns the “handle” allocated by Windows to the
Station window.
Left Sets and returns the position of the left edge of the
Station window with reference to the left edge of the
screen.
The range depends on the Windows screen setting.
Parent Returns the Application object.
Title Returns the title that appears in the title bar of the Station
window.
Top Sets and returns the position of the top of the Station
window with reference to the top of the screen.
The range depends on the Windows screen setting.
Width Sets and returns the width of the Station window.
The range depends on the Windows screen setting. For
example, if the screen has a 1280x1024 resolution, the
width can be up to 1280.
154 www.honeywell.com/ps
OBJECTS
Property Description
WindowState Sets and returns the state of the Station window. The
values are:
0 = Window is hidden (not visible). Note that this value
should be used with caution because a hidden Station
will not receive any user events, although it will
continue to receive server and timer events.
1 = Window is visible and can be sized by the user
2 = Window is minimized
3 = Window is maximized
Methods
DPToLPX and DPToLPY methods
LPToDPX and LPToDPY methods
Events
None.
155
5 – SCRIPTING REFERENCE
Dictionary object
Description
The dictionary is a collection of named variables. Each item (named variable) in
the dictionary has a case-sensitive name and a value. The value can be of any
form, such as text or numeric.
Dictionary items can be used by any script, regardless of the object to which it is
attached.
By default, dictionary items remain for the life of Station. It is therefore important
to use the Remove method to remove items if they are no longer required.
Syntax
Application.Dictionary
Properties
Property Description
Application Returns the Application object.
Count Returns the number of items in the collection.
Parent Returns the Application object.
Property Description
Name Returns the item’s case-sensitive name.
Value Sets and returns the item’s value.
Methods
Add method
Item method
Remove method
Events
None.
156 www.honeywell.com/ps
OBJECTS
Example
This example shows how to create a variable called “Volts” and assign it a value:
Application.Dictionary.Add “Volts”, 12.2
Once created, any script can access the value as follows:
BattVolts = Application.Dictionary.Item("Volts").Value
157
5 – SCRIPTING REFERENCE
Display objects
Description
Display objects represent the graphic elements on the current display, such as
rectangles and pushbuttons.
Syntax
ObjectName
Where ObjectName is the display object’s name, such as “pushbutton3”. (As
shown in Name on the General tab of the Properties Window.)
Properties
Property Description
Application Returns the Application object.
Busy Only applicable to a SafeBrowse or ActiveX Document
object. Indicates whether the browser is currently
navigating or downloading.
Document Only applicable to a SafeBrowse or ActiveX Document
object. Returns the active document object. For example,
the HTML document being displayed in a SafeBrowse
window.
The Document property gives a script access to the
document’s Automation object. The properties and
methods available to the document depend on the
document’s type. See “Using the Document property” on
page 249.
DocumentType Only applicable to a SafeBrowse or ActiveX object.
Returns a string specifying the content type (MIME) of
the object’s contents. For example, if an HTML document
is being displayed, the content type is “text/html”.
158 www.honeywell.com/ps
OBJECTS
Property Description
FillColor Sets and returns the object’s fill color. The color can be
either the RGB value (24-bit) or one of the following
predefined VBScript colors:
• vbBlack
• vbWhite
• vbRed
• vbYellow
• vbGreen
• vbBlue
• vbCyan
• vbMagenta
FillColorBlink Sets and returns the blinking state of the object’s FillColor.
The values are True and False.
FillColorTransparent Sets and returns the transparency of the object’s FillColor.
The values are True and False.
Height Sets and returns the object’s height.
The range is between 1 and 4499.
Label Sets and returns the object’s label. Only applicable to
checkbox, pushbutton and text objects. (In the case of a
text object, the Label and Value properties are identical.)
Left Sets and returns the position of the object’s left edge with
reference to the left edge of the Station client window.
The range is between 0 and 7999.
LevelFillColor Only applicable to an indicator object. Sets and returns the
level fill color.
LineColor Sets and returns the object’s line color. The color can be
either the RGB value (24-bit) or one of the following
predefined colors:
• vbBlack
• vbWhite
• vbRed
• vbYellow
• vbGreen
• vbBlue
• vbCyan
• vbMagenta
LineColorBlink Sets and returns the blinking state of the object’s
LineColor. The values are True and False.
159
5 – SCRIPTING REFERENCE
Property Description
LineColorTransparent Sets and returns the transparency of the object’s Linecolor.
The values are True and False.
LineStyle Sets and returns the object’s line style. The values are:
0 = Flat
1 = Ridge
2 = Groove
3 = Raised
4 = Lowered
LineWidth Sets and returns the object’s line width. The values are:
0 = None (invisible)
1 = Hairline
2 = Thin
3 = Thick
4 = Thicker
5 = Thickest
ListCount Only applicable to a local Combobox object. (A local
Combobox is one which does not have a link to the
database.) Returns the number of items in the drop-down
list.
LocationName Only applicable to a SafeBrowse object. Returns a string
containing the title of the resource (URL) that the
SafeBrowse is displaying.
Name Returns the object’s name. (Corresponds to the Name,
property on the General tab of the Properties Window.)
Objects Only applicable if the object is a Group or Shapelink.
Returns the object’s collection.
Parent Returns the parent of the object. This is either:
• The Page object
• The Group or Shapelink to which the object belongs
Right Sets and returns the position of the object’s right edge with
reference to the left edge of the Station client window.
The range is between 0 and 7999.
RotationAngle The angle through which the object has been rotated,
expressed in degrees. The object is rotated about the point
defined by RotationPointX and RotationPointY.
Not all types of display objects can be rotated—see
“Rotating display objects” on page 42.
160 www.honeywell.com/ps
OBJECTS
Property Description
RotationPointX The horizontal and vertical coordinates of the point about
RotationPointY
which the object has been rotated.
The horizontal coordinate is between 0 and 7999 and the
vertical coordinate is between 0 and 4999.
SelectedListIndex Only applicable to a local Combobox object. (A local
Combobox is one which does not have a link to the
database.) Sets and returns the index that identifies an item
in the drop-down list.
The value for the first item is 0, the value for the second
item is 1, and so on. A value of -1 indicates that no item is
selected.
Top Sets and returns the position of the object’s top edge with
reference to the top of the Station client window.
The range is between 0 and 4499.
161
5 – SCRIPTING REFERENCE
Property Description
Type Returns the object’s type, which is one of the following:
0 = null
1 = Text
2 = Rectangle
3 = RoundRectangle
4 = Oval
5 = FreehandLine
6 = Line
7 = Arc
8 = Wedge
9 = Polyline
10 = Polygon
11 = Alphanumeric
12 = PushButton
13 = Indicator
14 = Checkbox
15 = Chart
16 = Combobox
17 = Multimedia
18 = Scrollbar
19 = Alarm
20 = Bitmap
21 = Metafile
22 = Overview
23 = Group
24 = Shapelink
25 = TGA image
26 = JPG image
28 = Video
29 = SafeBrowse
30 = ActiveXDoc
Value The object’s value, the meaning of which depends on its
type—see “About the Value Property” on page 163.
Note that Value is not applicable to all types of object.
162 www.honeywell.com/ps
OBJECTS
Property Description
Visible Sets and returns the object’s visibility. The values are
True and False.
Note that an invisible object does not receive user events,
such as OnClick, but still receives server and timer events.
Width Sets and returns the object’s width.
The range is between 1 and 7999.
Methods
AddListItem method
CancelChange method
CancelClick method
CancelDoubleClick method
163
5 – SCRIPTING REFERENCE
CancelNavigate method
Clear method
CreateTimer method
GoHome method
GoBack method
GoSearch method
GoForward method
KillTimer method
Refresh method
RemoveListItem method
SelectText method
SetFocus method
Stop method
Update method
Events
OnBeginNavigate event
OnChange event
OnClick event
OnDoubleClick event
OnDownloadBegin event
OnDownloadComplete event
OnFocus event
OnLoad event
OnMouseEnter event
OnMouseLeave event
OnMouseMove event
OnNavigateComplete event
OnPageComplete event
OnRightClick event
OnTimer event
OnUpdate event
OnUnload event
164 www.honeywell.com/ps
OBJECTS
Objects collection
Description
The Objects collection for:
• The Page object contains the top-level display objects in the current display.
• A Group or Shapelink contains the display objects within the group or
shapelink.
The Objects collection is used when referencing a display object from another
object’s script.
Syntax
When referencing the collection in the current display:
Page.Objects
Properties
Property Description
Application Returns the Application object.
Count Returns the number of display objects in the collection.
Parent Returns the parent object.
Methods
Item method
Events
None.
Example
This example shows how to refer to “Rectangle1”.
Page.Objects.Item("Rectangle1")
This example shows how to refer to the second item in the collection.
Page.Objects.Item(2)
This example shows how to use display objects to perform an iterative task. In
this case, change the fill color of all objects in a display.
For i = 1 to Page.Objects.Count
Page.Objects.Item(i).FillColor = vbRed
Next
165
5 – SCRIPTING REFERENCE
Page object
Description
The Page object represents the current display. The Page object also contains an
Objects collection, whose items are the display objects on the display (the
rectangles, alphanumerics, and so on).
Syntax
Page
Properties
Property Description
Application Returns the Application object.
FilePath Returns the full path of the display file.
HelpFile Sets or returns the filename of the help associated with
the display. Used in conjunction with HelpType,
HelpTopicFile and HelpTopicNumber.
The file must be located in a folder defined in Station’s
list of search paths—for example, in the same folder as
the associated display.
HelpTopicFile Only applicable when the HelpType is set to 1. Sets or
returns the internal filename of the help topic.
HelpTopicNumber Only applicable when the HelpType is set to 2. Sets or
returns the topic number of the help topic.
HelpType Sets or returns the type of help associated with the
display. The values are:
0 = Document other than HTML Help (such as a text file
or Microsoft Word document)
1 = Help topic within HTML Help identified by its the
internal filename (specified in HelpTopicFile)
2 = Help topic within HTML Help identified by its topic
number (specified in HelpTopicNumber)
Objects Returns the Objects collection for the display.
Parent Returns the Application object.
Title Returns the display’s title.
166 www.honeywell.com/ps
OBJECTS
Methods
CreateTimer method
KillTimer method
OpenHelp method
Redraw method
UserObjectNotify method
Events
OnLoad event
OnMouseMove event
OnPeriodicUpdate event
OnTimer event
OnUnload event
OnUserObjectNotify event
167
5 – SCRIPTING REFERENCE
Methods
The methods are listed in alphabetical order.
168 www.honeywell.com/ps
METHODS
Add method
Applicable to
Dictionary object
Description
Adds a new item (named variable) to the Dictionary collection.
Syntax
Add(name,value)
Part Description
name The case-sensitive name of the item.
value The value of the item.
Remarks
• The Dictionary can contain a maximum of 256 items. If you need to add more
items, you must first use the Remove method to remove unused items.
• There is no protection against adding more than one item with the same name.
If this happens, retrieving the item’s value will return the value of the first
item with that name.
Example
This example adds an item “Voltage” to the Dictionary and sets its value to
“12.3”.
Dictionary.Add "Voltage", 12.3
169
5 – SCRIPTING REFERENCE
AddListItem method
Applicable to
Display objects
Description
Adds an item to a local Combobox. (A local Combobox is one which does not
have a link to the database.) When a user selects a Combobox, the list of items
appears, allowing the user to select the appropriate item.
Syntax
[object.]AddListItem(item[, index])
or
[object.]AddListItem item[, index]
Part Description
object The Combobox to which the entry is being added.
item The item being added.
index The item’s position in the Combobox’s list.
If omitted, the item is added to the end of the list.
If an existing index is specified, existing items are
moved down to make room for the new item.
Remarks
• The index of the first item in the list is 0.
• By default, the first item in the list is selected when the combobox is initially
displayed.
Example
This example adds three items to the Combobox “SetSpeed”.
SetSpeed.AddListItem “Slow”, 0
SetSpeed.AddListItem “Medium”, 1
SetSpeed.AddListItem “Fast”, 2
170 www.honeywell.com/ps
METHODS
BeginCriticalSection method
Applicable to
Application object
Description
The BeginCriticalSection method disables the script timeout (which is set to
5 seconds).
The BeginCriticalSection and EndCriticalSection methods are usually used to
enclose a block of code that must not be interrupted once started. For example,
you may want to use the method(s) in a script that changes a number of values in
the database and then requests a task which uses the new values.
Syntax
Application.BeginCriticalSection()
Remarks
• You should use the BeginCriticalSection method with caution because it
disables the script timeout for all scripts.
• The EndCriticalSection method immediately re-enables the script timeout.
However, if there is no EndCriticalSection method, the script timeout is
automatically re-enabled when script finishes.
Example
This example shows how the BeginCriticalSection method can be used in the
OnClick event for a pushbutton.
Sub PushButton3_OnClick()
.
.
Application.BeginCriticalSection()
'critical task
.
Application.EndCriticalSection()
End Sub
171
5 – SCRIPTING REFERENCE
Blue method
Applicable to
Application object
Description
The Blue method is a utility function that can be used in any script. It returns the
blue component of a color value, expressed as a number between 0 (no blue) and
255 (100% blue). Normally used in conjunction with the Red and Green methods.
Syntax
Application.Blue(RGBvalue)
Part Description
RGBvalue The color value from which the blue component is
returned.
Example
This example obtains the blue component of the fill color of “Rect3”.
BlueValue = Application.Blue(Rect3.FillColor)
172 www.honeywell.com/ps
METHODS
CancelChange method
Applicable to
Display objects
Description
Cancels a change made by a user to the following types of display object:
• Alphanumeric
• Checkbox
• Scrollbar
• Combobox
Syntax
CancelChange
Remarks
• The CancelChange method can only be used within an OnChange event.
Together, they enable the change to be validated before passing it on to the
server.
Example
This example compares the user-entered value with the current limit and cancels
the change if the value is greater than the limit. The OnChange event fires when
the change is made, and passes the user-entered value to the script.
Sub OnChange(vNewValue)
'calculate current limit.
.
.
.
If vNewValue > Limit Then
MsgBox "Value must be below " & CStr(limit) & "."
CancelChange
End If
End Sub
173
5 – SCRIPTING REFERENCE
CancelClick method
Applicable to
Display objects
Description
Cancels the click when a user clicks a display object.
Syntax
CancelClick
Remarks
• The CancelClick method can only be used within OnClick and OnRightClick
events. Together, they enable the click operation to be validated before
passing it on to the server.
Example
This example, attached to “Pushbutton2”, checks the user’s security level and
cancels the click if the level is below Engineer.
Sub PushButton2_OnClick()
If Application.SecurityLevel < 4 Then
MsgBox "Only an Engineer or Manager can do this"
CancelClick
End If
End Sub
174 www.honeywell.com/ps
METHODS
CancelDoubleClick method
Applicable to
Display objects
Description
Cancels the double-click when a user double-clicks a display object.
Syntax
CancelDoubleClick
Remarks
• The CancelDoubleClick method can only be used within an OnDoubleClick
event. Together, they enable the double-click operation to be validated before
passing it on to the server.
Example
Sub Circle3_OnDoubleClick()
If ... Then
MsgBox "..."
CancelDoubleClick
End If
End Sub
175
5 – SCRIPTING REFERENCE
CancelNavigate method
Applicable to
Display objects
Description
Cancels a user’s navigation operation. Only applicable to a SafeBrowse object.
Syntax
CancelNavigate
Remarks
• The CancelNavigate method can only be used within an OnBeginNavigate
event. Together, they can be used to prevent the user from accessing
unauthorized Web sites.
• The OnBeginNavigate event only receives “http://” style addresses.
Consequently, you must ensure that any permitted Web site does not include
links to other types, such as FTP and files, that are inappropriate or unsafe.
Example
This example prevents the user from accessing external Web sites.
Sub OnBeginNavigate(URL)
If NewURL = ... Then
MsgBox "You cannot access external Web sites."
CancelNavigate
End If
End Sub
176 www.honeywell.com/ps
METHODS
CancelOperatorCommand method
Applicable to
Application object
Description
Cancels the command entered by a user in the Station’s Command Zone.
Syntax
CancelOperatorCommand
Remarks
• The CancelOperatorCommand method can only be used within an
OnOperatorCommand event. Together, they enable the command to be
validated before passing it on to the server.
Example
Sub OnOperatorCommand(bstrCommand)
If bstrCommand = "bye" Then
MsgBox "Log out not permitted"
CancelOperatorCommand
End If
End Sub
177
5 – SCRIPTING REFERENCE
Clear method
Applicable to
Display objects
Description
Clears (removes) the text of an Alphanumeric display object.
Syntax
[object.]Clear
Part Description
object The Alphanumeric object whose text is cleared.
Example
This example clears the alphanumeric “Alphanum1” when the user clicks
“Pushbutton1”.
Sub Pushbutton1_OnClick()
Alphanum1.Clear
End Sub
178 www.honeywell.com/ps
METHODS
CreateTimer method
Applicable to
Application object
Display objects
Page object
Description
Creates a timer for an object, which fires OnTimer events events at regular
intervals.
A timer keeps firing OnTimer events until it is killed by either the KillTimer
method, or when the associated object is killed. For example, displaying a new
display kills all timers associated with the old display and its display objects.
Syntax
Call [object.]CreateTimer(timerID, interval)
or
[object.]CreateTimer timerID, interval
or
variable = [object.]CreateTimer(timerID, interval)
The last syntax returns True if the timer is created and False if it isn’t.
Part Description
object The object for which you are creating the timer.
timerID A unique number that identifies the timer.
interval The interval, in milliseconds, at which the timer fires
timer events.
Remarks
• A maximum of 100 timers can exist at any one time.
• The timer’s interval can be changed by calling the CreateTimer method a
second time, specifying the original TimerID, but a different Interval.
• Timers with intervals of less than 100ms are not recommended for
performance reasons.
179
5 – SCRIPTING REFERENCE
Example
This example creates a 250ms timer for “Circle3” when it is loaded into the
display.
Sub Circle3_OnLoad()
Call CreateTimer(1, 250)
End Sub
You would then write an appropriate OnTimer event handler for the object.
180 www.honeywell.com/ps
METHODS
CrossScreenInvocationPending method
Applicable to
Application object
Description
Read only so cannot be set from script. Checks whether the operator has
requested that the next display navigation be passed to the associated Station (as
determined by the Flex Station Configuration Display properties).
Syntax
CrossScreenInvocationPending
Return value
True or False.
181
5 – SCRIPTING REFERENCE
Description
These two methods convert the X- and Y-coordinates, respectively, from
resolution-dependent display coordinates (expressed in pixels) to Display
Builder’s logical coordinates. See “About display coordinates” on page 241.
Syntax
Appwindow.DPToLPX(displaycoordx)
Appwindow.DPToLPY(displaycoordy)
Part Description
displaycoordx The display coordinate that is converted.
displaycoordy
Remarks
• The LPToDPX and LPToDPY methods convert from logical coordinates to
display coordinates.
Example
This example sets the logical coordinates of “Rect1”.
Rect1.Left = AppWindow.DPToLPX(500)
Rect1.Top = AppWindow.DPToLPY(300)
182 www.honeywell.com/ps
METHODS
EndCriticalSection method
Applicable to
Application object
Description
Re-enables the script timeout after having been disabled by the
BeginCriticalSection method. See “BeginCriticalSection method” on page 171
for further details.
Syntax
EndCriticalSection
183
5 – SCRIPTING REFERENCE
ExecuteOperatorCommand method
Applicable to
Application object
Description
Executes a user command as if it had been entered into the Command Zone by a
user. (A user command is anything a user would normally type into the Command
Zone.)
Syntax
ExecuteOperatorCommand(command)
Part Description
command The command that is executed.
Remarks
• If you use ExecuteOperatorCommand within an OnOperatorCommand event,
the command specified in ExecuteOperatorCommand will be executed and
the user’s command will be cancelled.
• For the list of operator commands, see the “Command reference” topic in the
“Reference topics” section of the Operator’s Guide.
Example
This example calls up display, whose page number is 80.
ExecuteOperatorCommand("Pag 80")
184 www.honeywell.com/ps
METHODS
GetResponse method
Applicable to
Application object
Description
Displays the specified prompt in Station’s Message Zone and returns the response
entered by the user in Station’s Command Zone.
Syntax
GetResponse(prompt)
Part Description
prompt The message that appears in the Message Zone.
Remarks
• Station cannot perform any other task while waiting for a response from a
user. You should therefore only use GetResponse within a suitable OnTimer
subroutine, as shown in the following example.
Example
This shows how to use an OnTimer subroutine to check for a response, and if
there is none (indicated by a null string) exit the routine.
Sub CheckResponse_OnTimer(l)
Dim str
str = GetResponse (“Are you sure (Y/N)?”)
If str = ““ then
.
.
Else
.
.
End If
End Sub
185
5 – SCRIPTING REFERENCE
GoBack method
Applicable to
Display objects (SafeBrowse object only)
Description
Goes back one page in the SafeBrowse’s history list.
Syntax
[SafeBrowse.]GoBack
Part Description
SafeBrowse The SafeBrowse object in which the previous page is
displayed.
Example
Sub Pushbutton1_OnClick()
Browser1.GoBack
End Sub
186 www.honeywell.com/ps
METHODS
GoForward method
Applicable to
Display objects (SafeBrowse object only)
Description
Displays the next page in the SafeBrowse object’s history list.
Syntax
[SafeBrowse.]GoForward
Part Description
SafeBrowse The SafeBrowse object in which the next page is
displayed.
Example
Sub Pushbutton1_OnClick()
Browser1.GoForward
End Sub
187
5 – SCRIPTING REFERENCE
GoHome method
Applicable to
Display objects (SafeBrowse object only)
Description
Displays the SafeBrowse object’s home page.
Syntax
[SafeBrowse.]GoHome
Part Description
SafeBrowse The SafeBrowse object in which the home page is
displayed.
Remarks
• The home page for all SafeBrowse objects is specified in the Station setup.
Example
Sub Pushbutton1_OnClick()
Browser1.GoHome
End Sub
188 www.honeywell.com/ps
METHODS
GoSearch method
Applicable to
Display objects (SafeBrowse object only)
Description
Displays the SafeBrowse object’s search page.
Syntax
[SafeBrowse.]GoSearch
Part Description
SafeBrowse The SafeBrowse object in which the search page is
displayed.
Remarks
• The search page for all SafeBrowse objects is specified in the Station setup.
Example
Sub Pushbutton1_OnClick()
Browser1.GoSearch
End Sub
189
5 – SCRIPTING REFERENCE
Green method
Applicable to
Application object
Description
The Green method is a utility function that can be used in any script. It returns the
green component of a color value expressed as a number between 0 (no green)
and 255 (100% green). Normally used in conjunction with the Blue and Red
methods.
Syntax
Application.Green(RGBvalue)
Part Description
RGBvalue The color value from which the green component is
returned.
Example
This example obtains the green component of the fill color of “Rect3”.
GreenValue = Application.Green(Rect3.FillColor)
190 www.honeywell.com/ps
METHODS
InvokeMenu method
Applicable to
Application object
Description
Superseded by the InvokeMenu2 method, however, the InvokeMenu method is
still supported for legacy scripts on DSP displays.
Invokes the selected menu item as if it had been selected by a user.
Syntax
InvokeMenu(menuitem)
191
5 – SCRIPTING REFERENCE
Part Description
menuitem The menu item:
1000 = Create a new Station connection
1001 = Open a new Station connection
1002 = Save the current Station connection
1003 = Save the current Station connection as
1004 = Setup the current Station connection
1005 = Print the current display
1006 = Quit Station
1007 = Show the full display
Attention Applicable to single-window Station only—
resizes the Station's main window—not
applicable for multi-window Station.
1008 = Zoom out
1009 = Zoom in
1030 = Show Station’s About dialog box
1034 = Login
1036 = Scroll right
1037 = Scroll left
1038 = Scroll up
1039 = Scroll down
1054 = Show the print page setup
1055 = Call up the startup display
1056 = Search for a Web page
1057 = Stop loading a Web page
1058 = Refresh a Web page
1061 = Open the Print dialog box
2111 = Call up next display
Example
This example shows how to print the current display.
InvokeMenu(1005)
192 www.honeywell.com/ps
METHODS
Item method
Applicable to
Dictionary object
Objects collection
Description
Returns the specified item from the Dictionary or Objects collection.
Syntax
Item(index|name)
Part Description
index Returns the item with the specified index (sequence
number within the list of items).
name Returns the item with the specified case-sensitive name.
Remarks
• The method returns the collection if neither index nor name are specified.
• Index numbering starts at 1.
Example
This example returns the value of a Dictionary item using its index.
SavedValue = Application.Dictionary.Item(1).Value
This example returns the value of a Dictionary item using its name.
SavedValue = Application.Dictionary.Item("Volts").Value
This example changes the fill-color of all display objects on the display.
For i = 1 to Page.Objects.Count
Page.Objects.Item(i).FillColor = vbRed
Next
193
5 – SCRIPTING REFERENCE
KillTimer method
Applicable to
Application object
Display objects
Page object
Description
Kills the specified timer. (Timers are created by the CreateTimer method.)
Syntax
[object.]KillTimer(timer)
Part Description
object Optional.The object whose timer is being killed.
timer The ID of the timer that is killed.
Example
This example kills a timer, with an ID of “2”, belonging to “Rectangle1” when the
user clicks “Pushbutton1”.
Sub Pushbutton1_OnClick
Rectangle1.KillTimer(2)
End Sub
194 www.honeywell.com/ps
METHODS
Description
These two methods convert the X- and Y-coordinates, respectively, from Display
Builder’s logical coordinates to the resolution-dependent display coordinates
(expressed in pixels). See “About display coordinates” on page 241.
Syntax
Appwindow.LPToDPX(logicalcoordx)
Appwindow.LPToDPY(logicalcoordy)
Part Description
logicalcoordx The logical coordinate that is converted.
logicalcoordy
Remarks
• The DPToLPX and DPToLPY methods convert from display coordinates to
logical coordinates.
Example
This example obtains the display coordinates of “Rect1”.
Xcoord = AppWindow.LPToDPX(Rect1.Left)
Ycoord = AppWindow.LPToDPY(Rect1.Top)
195
5 – SCRIPTING REFERENCE
MakeColor method
Applicable to
Application object
Description
The MakeColor method is a utility function that can be used in any script. It
returns a color value, expressed in RGB format. The value is packed into the
lower 24 bits of a long integer.
Syntax
Application.MakeColor(red, green, blue)
Part Description
red The red component, with a value between 0 (no red) and
255 (maximum red).
green The green component, with a value between 0 (no green)
and 255 (maximum green).
blue The blue component, with a value between 0 (no blue)
and 255 (maximum blue).
Example
This example changes the fill color of “Rect3” to white.
Rect3.FillColor = Application.MakeColor(255,255,255)
196 www.honeywell.com/ps
METHODS
OpenHelp method
Applicable to
Page object
Description
Opens the help associated with the display. The help details are specified in Page
object properties.
Syntax
OpenHelp()
Example
This example sets the help to “help.txt”, and opens the help.
Sub Pushbutton1_OnClick()
Page.HelpType = 0
Page.HelpFile = "help.txt"
Page.OpenHelp
End Sub
197
5 – SCRIPTING REFERENCE
Quit method
Applicable to
Application object
Description
Terminates Station. Equivalent to the user selecting File > Exit.
Syntax
Application.Quit
Remarks
• The method does not prompt for user confirmation.
Example
This example performs shut-down tasks and terminates the Station when the user
clicks the “Quit” button, providing the user confirms the message.
Sub QuitButton_OnClick()
If MsgBox("Are you sure you want to Exit Station?",_
vbYesNo) = vbYes Then
'Perform shut-down tasks.
.
.
Application.Quit
Else
CancelClick()
End If
End Sub
198 www.honeywell.com/ps
METHODS
Red method
Applicable to
Application object
Description
The Red method is a utility function that can be used in any script. It returns the
red component of a color value, expressed as a number between 0 (no red) and
255 (100% red). Normally used in conjunction with the Blue and Green methods.
Syntax
Application.Red(RGBvalue)
Part Description
RGBvalue The color value from which the red component is
returned.
Example
This example obtains the red component of the fill color of “Rect3”.
RedValue = Application.Red(Rect3.FillColor)
199
5 – SCRIPTING REFERENCE
Redraw method
Applicable to
Page object
Description
Immediately redraws the current display.
Syntax
Redraw
Example
This example redraws the page.
Sub ...
.
.
Page.Redraw
End Sub
200 www.honeywell.com/ps
METHODS
Refresh method
Applicable to
Display objects (SafeBrowse object only)
Description
Reloads the current Web page in the SafeBrowse object.
Syntax
[SafeBrowse.]Refresh
Part Description
SafeBrowse The SafeBrowse object which is reloaded.
Example
Sub Pushbutton1_OnClick()
Browser2.Refresh
End Sub
201
5 – SCRIPTING REFERENCE
Remove method
Applicable to
Dictionary object
Description
Removes an item from the Dictionary collection.
Syntax
Remove(index|name)
Part Description
index Required if name is not specified. The sequence number
of the item that is removed.
name Required if index is not specified. The case-sensitive
name of the item that is removed.
Remarks
• Index numbering starts at 1.
Example
This example removes “Voltage” (the name of the item) from the Dictionary.
Application.Dictionary.Remove("Voltage")
This example removes the third item from the Dictionary.
Application.Dictionary.Remove(3)
202 www.honeywell.com/ps
METHODS
RemoveListItem method
Applicable to
Display objects (Local Combobox only)
Description
Removes an item from a local Combobox. (A local Combobox is one which does
not have a link to the database.)
Syntax
[object.]RemoveListItem(index)
Part Description
object The Combobox from which the entry is removed.
index The sequence number of the removed item. Note that the
first item has an index of 0.
Example
This example removes the second item from the combobox.
Combobox1.RemoveListItem(1)
203
5 – SCRIPTING REFERENCE
RequestServerLRN method
Applicable to
Application object
Description
Requests the specified LRN (Logical Resource Number) on the server.
Syntax
RequestServerLRN(LRN[, param1, param2])
Part Description
LRN The requested LRN.
param1 param2 The parameter(s) passed to the LRN.
Example
This example uses the Server Display Program (LRN 21) to call up page 11.
Application.RequestServerLRN 21, 1, 11
204 www.honeywell.com/ps
METHODS
SelectText method
Applicable to
Display objects (Alphanumeric only)
Description
Selects the text of an Alphanumeric display.
Syntax
[object.]SelectText
Part Description
object The Alphanumeric object whose text is selected.
Example
Sub Pushbutton1_OnClick()
Alphanum1.SelectText
End Sub
205
5 – SCRIPTING REFERENCE
SetFocus method
Applicable to
Display objects
Description
Selects the dynamic display object. (A dynamic display object is one that can
have focus.) Some display objects, such as checkboxes and alphanumerics, are
intrinsically dynamic; however, objects that are normally static, such as
rectangles and lines, are also dynamic if they are linked to the database.
Syntax
[object.]SetFocus
Part Description
object The object that is selected.
Example
Pushbutton1.SetFocus
206 www.honeywell.com/ps
METHODS
Shell method
Applicable to
Application object
Description
Executes a command as an operating system command.
Syntax
Call Application.Shell(command, state)
or
Application.Shell command, state
Part Description
command The operating system command.
state Sets the state of the window in which the command runs.
The values are:
0 = Window is hidden (not visible).
1 = Standard Window
2 = Window is minimized
3 = Window is maximized
Example
This example starts Windows Notepad and displays a text file.
Application.Shell "notepad c:\documents\readme.txt",1
207
5 – SCRIPTING REFERENCE
Stop method
Applicable to
Display objects (SafeBrowse object only)
Description
Stops the current navigation operation in the SafeBrowse object.
Syntax
[SafeBrowse.]Stop
Part Description
SafeBrowse The SafeBrowse object in which navigation is stopped.
Example
Sub Pushbutton1_OnClick()
Browser1.Stop
End Sub
208 www.honeywell.com/ps
METHODS
Update method
Applicable to
Display objects
Description
Fires an OnUpdate event for a display object, even though it was not updated by
the server. (Normally, OnUpdate events only fire when the object is updated by
the server.)
Syntax
[object.]Update()
Part Description
object The display object that is updated.
Example
Sub Pushbutton1_OnClick()
Combobox1.Update
End Sub
209
5 – SCRIPTING REFERENCE
UserObjectNotify method
Applicable to
Application object
Page object
Description
Fires an OnUserNotify event for the Application or Page object. This method is
used by automation objects that may require significant processing time, thereby
avoiding script timeouts.
Syntax
[object.]UserObjectNotify(lID, vParam)
Part Description
object The display object for which the event fires.
lID The ID that identifies the object using the method.
vParam The variant used to return data to the script.
210 www.honeywell.com/ps
EVENTS
Events
The events are listed in alphabetical order.
211
5 – SCRIPTING REFERENCE
OnAlarm event
Applicable to
Application object
Description
Fires when a new alarm appears in the Station’s Alarm Zone.
Syntax
OnAlarm()
Example
This example sets the background color to red when an alarm occurs.
Sub Application_OnAlarm()
PageBackgroundColor = 3
End Sub
212 www.honeywell.com/ps
EVENTS
OnAppStartup event
Applicable to
Application object
Description
Fires as soon as Station is started and all its objects have been created.
Syntax
OnAppStartup()
Remarks
• The event does not fire when the Station script is reloaded, for example, when
a user chooses Station > Connect.
Example
This example sets the background color to white when Station starts.
Sub Application_OnAppStartup()
PageBackgroundColor = 2
End Sub
213
5 – SCRIPTING REFERENCE
OnBeginNavigate event
Applicable to
Display objects (SafeBrowse object only)
Description
Fires when a user enters a new URL in a SafeBrowse object.
Syntax
OnBeginNavigate(URL)
Part Description
URL The Web address (Universal Resource Locator)
Remarks
• The URL is not passed immediately to the SafeBrowse object when the
OnBeginNavigate event fires. This allows the event to be used in conjunction
with the CancelNavigate method to check the URL before sending it to the
SafeBrowse object.
• The OnBeginNavigate event only receives “http://” style addresses.
Consequently, you must ensure that any permitted Web site does not include
links to other types, such as FTP and files, that are inappropriate or unsafe.
• An OnNavigateComplete event fires when the SafeBrowse object completes
navigation to the URL.
Example
This example cancels the navigation if the new URL is outside the
ourwebsite.com domain.
Sub Browser1_OnBeginNavigate(URL)
const domain = "ourwebsite.com"
newDomain = right(URL,Len(domain))
If newDomain <> domain Then
CancelNavigate
End If
End Sub
214 www.honeywell.com/ps
EVENTS
OnChange event
Applicable to
Display objects
Description
Fires when a user changes the value of a display object. It does not fire when the
server or a script changes the value.
Only applies to the following types of display objects:
• Alphanumeric
• Checkbox
• Scrollbar
• Combobox
Syntax
OnChange(value)
Part Description
value The new value supplied by the user.
Remarks
• The object retains its old value when the OnChange event fires. This allows
the event to be used in conjunction with the CancelChange method to validate
the change before sending it to the server.
• An OnUpdate event fires when the server actually changes the object’s value.
• Do not use the OnChange event to create message boxes, input boxes or
dialog boxes for a scrollbar. Doing so will result in unpredictable object
behavior.
Example
This example displays a warning message when a user tries to change the state of
a point.
Sub Combobox1_OnChange(vNewValue)
If MsgBox("Do you want to change the point", vbYesNo)_
= vbNo Then
CancelChange()
End If
End Sub
215
5 – SCRIPTING REFERENCE
OnClick event
Applicable to
Display objects
Description
Fires when a user clicks a display object.
Syntax
OnClick()
Remarks
• The OnClick event fires before the click action is processed. This allows the
event to be used in conjunction with the CancelClick method to validate the
action before sending it to the server.
Example
This example, attached to “Pushbutton2”, checks the user’s security level and
cancels the click if the level is below Engineer.
Sub PushButton2_OnClick()
If Application.SecurityLevel < 4 Then
MsgBox "Only an Engineer or Manager can do this"
CancelClick
End If
End Sub
216 www.honeywell.com/ps
EVENTS
OnConnect event
Applicable to
Application object
Description
Fires when Station connects to a server.
Syntax
OnConnect()
Example
This example adds the named variable myKey to the Application Dictionary, with
value 10.
Sub Application_OnConnect()
Application.Dictionary.Add "myKey", 10
End Sub
217
5 – SCRIPTING REFERENCE
OnDisconnect event
Applicable to
Application object
Description
Fires when Station disconnects from a server.
Syntax
OnDisconnect()
Example
This example removes the named variable myKey from the Application
Dictionary.
Sub Application_OnDisconnect()
Application.Dictionary.Remove("myKey")
End Sub
218 www.honeywell.com/ps
EVENTS
OnDoubleClick event
Applicable to
Display objects
Description
Fires when a user double-clicks a display object.
Syntax
OnDoubleClick()
Remarks
• The OnDoubleClick event fires before the double-click action is processed.
This allows the event to be used in conjunction with the CancelDoubleClick
method to validate the action before sending it to the server.
Example
Sub Pushbutton1_OnDoubleClick()
.
.
.
End Sub
219
5 – SCRIPTING REFERENCE
OnDownloadBegin event
Applicable to
Display objects (SafeBrowse objects only)
Description
Fires before a SafeBrowse object begins a download operation.
Syntax
OnDownloadBegin()
Example
This example sets the color of “Oval1” to red when downloading begins.
Sub SafeBrowse1_OnDownloadBegin()
Oval1.FillColor = vbRed
End Sub
220 www.honeywell.com/ps
EVENTS
OnDownloadComplete event
Applicable to
Display objects (SafeBrowse only)
Description
Fires after a SafeBrowse object is downloaded.
If the object is a HTML page that contains frames, the event fires as each frame is
downloaded, as well as when the page is downloaded. By contrast, the
OnPageComplete event is only fires after the page, and all its frames, have
downloaded.
Syntax
OnDownloadComplete()
Example
This example sets the color of “Oval1” to green after downloading has finished.
Sub SafeBrowse1_OnDownloadComplete()
Oval1.FillColor = vbGreen
End Sub
221
5 – SCRIPTING REFERENCE
OnFocus event
Applicable to
Display objects
Description
Fires when a dynamic display object gets focus. (A dynamic display object is one
that can have focus.) Some display objects, such as checkboxes and
alphanumerics, are intrinsically dynamic; however, objects that are normally
static, such as rectangles and lines, are also dynamic if they are linked to the
database.
Syntax
OnFocus()
Example
This example sets a text object’s text when the checkbox receives focus.
Sub Checkbox1_OnFocus()
Text1.Value = "Checkbox1 Focus"
End Sub
222 www.honeywell.com/ps
EVENTS
OnLoad event
Applicable to
Display objects
Page object
Description
In the case of a display, the event fires when the display is first displayed.
In the case of a display object, the event fires when the display object is loaded
into the display.
Syntax
OnLoad()
Remarks
• An OnLoad script for an object may fail if it references another object that has
not yet been loaded.
Example
This example creates a 2-second timer for “Circle3” when it is loaded. (You
would then use the object’s OnTimer event to run another script.)
Sub Circle3_OnLoad()
CreateTimer(1, 2000)
End Sub
223
5 – SCRIPTING REFERENCE
OnMenu event
Applicable to
Application object
Description
Superseded by the “OnMenu2 event” on page 225, however, is still supported for
scripts on DSP displays that use “InvokeMenu method” on page 191.
Used to assign custom additional script to the event.
Syntax
OnMenu(item)
Part Description
item The ID of the selected menu item.
Example
Assume the InvokeMenu method has been used with menu item 2113 (alarm
acknowledge). This fires an OnMenu event, which returns 2113.
The following script displays a message if the menu item is 2113.
Sub Application_OnMenu(lMenuTag)
If cint(lMenuTag) = 2113 Then
Application.MessageZoneText = "Notice: Alarm acknowledge"
End If
End Sub
224 www.honeywell.com/ps
EVENTS
OnMenu2 event
Applicable to
Application object
Description
Fires when a user selects a menu item and returns the menu item name. OnMenu2
is more flexible than the OnMenu event, taking a single string which indicates the
menu item name.
Syntax
OnMenu2(command)
Part Description
command The string identifying the name of the command. This is
the name of the command specified in the Station menu
and toolbar customization dialog box.
Example
This example displays a warning when a user selects the Acknowledge/Silence
menu item. In this example the name of the Acknowledge/Silence command is
“Acknowledge Alarm”. The script is:
Sub Application_OnMenu2(strMenuItem)
If (strMenuItem) = "Acknowledge Alarm" Then
MsgBox "WARNING: Alarm acknowledged"
End If
End Sub
225
5 – SCRIPTING REFERENCE
OnMouseEnter event
Applicable to
Display objects
Description
Fires when the mouse enters the bounding rectangle of a display object.
Applies to all types of display object, except Lines, FreeHandLines and Polylines.
Syntax
OnMouseEnter()
Remarks
• The processing load increases significantly as the number of mouse events
being monitored increases.
• OnMouseEnter events should not be used for critical scripts because they are
given a low priority and are often discarded by the operating system.
Example
This example uses the OnMouseEnter and OnMouseLeave events to display an
explanatory message in the Station’s Message Zone whenever the mouse pointer
is on top of the display object, “MainValve”. The OnMouseEnter event displays
the description.
Sub MainValve_OnMouseEnter()
Application.MessageZoneText = "Main Valve"
End Sub
And the corresponding OnMouseLeave event clears the description when the
pointer leaves the object.
Sub MainValve_OnMouseLeave()
‘reset the message zone text
Application.MessageZoneText = ""
End Sub
226 www.honeywell.com/ps
EVENTS
OnMouseLeave event
Applicable to
Display objects
Description
Fires when the mouse leaves the bounding rectangle of a display object.
Applies to all types of display object, except Lines, FreeHand lines and
PolyLines.
Syntax
OnMouseLeave()
Remarks
• The processing load increases significantly as the number of mouse events
being monitored increases.
• OnMouseLeave events should not be used for critical scripts because they are
given a low priority and are often discarded by the operating system.
Example
This example uses the OnMouseEnter and OnMouseLeave events to display an
explanatory message in the Station’s Message Zone whenever the mouse pointer
is on top of display object, “MainValve”. The OnMouseEnter event displays the
description.
Sub MainValve_OnMouseEnter()
Application.MessageZoneText = "Main Valve"
End Sub
And the corresponding OnMouseLeave event clears the description when the
pointer leaves the object.
Sub MainValve_OnMouseLeave()
‘reset the message zone text
Application.MessageZoneText = ""
End Sub
227
5 – SCRIPTING REFERENCE
OnMouseMove event
Applicable to
Display objects
Page object
Description
In the case of the current display, the event fires when a user moves the mouse
over the display.
In the case of a display object, the event fires when a user moves the mouse over
the display object (excluding a SafeBrowse object).
Syntax
OnMouseMove(x, y)
Part Description
x Returns the horizontal coordinate of the mouse.
y Returns the vertical coordinate of the mouse.
Remarks
• The processing load increases significantly as the number of mouse events
being monitored increases.
• OnMouseMove events should not be used for critical scripts because they are
given a low priority and are often discarded by the operating system.
• The mouse coordinates range from -266, -122 to 8257, 4568 if a user moves
the pointer over the border around the display. See “Mouse coordinates” on
page 241.
Example
This shows the current mouse coordinates in two text objects named “TextX” and
“TextY”.
Sub Page_OnMouseMove(lx,ly)
TextX.Value = lx
TextY.Value = ly
End Sub
228 www.honeywell.com/ps
EVENTS
OnNavigateComplete event
Applicable to
Display objects (SafeBrowse object only)
Description
Fires when a SafeBrowse object completes navigation to a URL.
Syntax
OnNavigateComplete()
Example
This example changes an object’s fill-color to green when navigation is complete.
Sub SafeBrowse1_OnNavigateComplete()
Oval1.FillColor = vbGreen
End Sub
229
5 – SCRIPTING REFERENCE
OnOperatorChange event
Applicable to
Application object
Description
Fires when a user logs on, or when the user changes security levels.
Syntax
OnOperatorChange()
Example
This example shows how to display the appropriate “home page” when a user
logs on. Each display would display information appropriate to a particular
security level.
Sub OnOperatorChange()
If SecurityLevel = 2 Then
CurrentPage = "MainMenuOperator"
End If
If SecurityLevel = 3 Then
CurrentPage = "http://www.../overview.htm"
End If
If SecurityLevel = 4 Then
CurrentPage = 303
End If
If SecurityLevel = 5 Then
CurrentPage = 304
End If
End Sub
230 www.honeywell.com/ps
EVENTS
OnOperatorCommand event
Applicable to
Application object
Description
Fires when a user issues a command from Station’s Command Zone.
Syntax
OnOperatorCommand(command)
Part Description
command The command entered by the user.
Remarks
• The OnOperatorCommand event fires before the command is processed. This
allows the event to be used in conjunction with the CancelOperatorCommand
method to validate the command before sending it to the server.
Example
This example checks the user’s security level and cancels the command if the
level is below Engineer (level 4 security).
Sub Application_OnOperatorCommand(bstrCommand)
If SecurityLevel < 4 Then
MsgBox "Only an Engineer or Manager can do this"
CancelOperatorCommand
End If
End Sub
231
5 – SCRIPTING REFERENCE
OnPageComplete event
Applicable to
Display objects (SafeBrowse only)
Description
Fires after a SafeBrowse object that includes a HTML page is downloaded.
Syntax
OnPageComplete()
Remarks
• OnPageComplete is equivalent to the OnDownloadComplete event if the
HTML page does not contain any frames.
Example
This example sets the color of “Oval1” to green after downloading has finished.
Sub SafeBrowse1_OnPageComplete()
Oval1.FillColor = vbGreen
End Sub
232 www.honeywell.com/ps
EVENTS
OnPageLoad event
Applicable to
Application object
Description
Fires when a new display is loaded, or when the current display is refreshed.
Syntax
OnPageLoad()
Remarks
• The equivalent events for the Page object is the OnLoad event.
Example
This example shows the current page name in the Message Zone.
Sub Application_OnPageLoad()
MessageZoneText = Page.CurrentPage
End Sub
233
5 – SCRIPTING REFERENCE
OnPeriodicUpdate event
Applicable to
Application object
Display objects
Page object
Description
Fires when Station receives a periodic update from the server. Periodic updates
occur whenever the server updates the system time in Station’s Status Line, and
OnPeriodicUpdate events fire for all display objects in the current display.
Syntax
OnPeriodicUpdate()
Example
This example animates a shapelink, stepping to the next shape on each periodic
update.
Sub Shapelink1_OnPeriodicUpdate()
Nextvalue = Nextvalue + 1
If Nextvalue > 4 Then
Nextvalue = 1
End If
End Sub
234 www.honeywell.com/ps
EVENTS
OnQuit event
Applicable to
Application object
Description
Fires when a user selects Station > Exit.
Syntax
OnQuit()
Example
This example changes an alphanumeric value when a user exits Station.
Sub Application_OnQuit()
MsgBox "Have a nice day!"
End Sub
235
5 – SCRIPTING REFERENCE
OnRightClick event
Applicable to
Display objects
Description
Fires when a user right-clicks a display object.
Syntax
OnRightClick()
Remarks
• By default, right-clicking in Station gives focus to the next object in the tab
sequence. You can prevent the change in focus by including a CancelClick
method at the end of the script, as shown in the following example.
• The OnRightClick event fires before the right-click action is processed. This
allows the event to be used in conjunction with the CancelClick method to
validate the action before sending it to the server.
Example
This example, attached to “Pushbutton1”, displays a list of options when it is
right-clicked. CancelClick at the end of the script prevents focus changing to the
next object in the tab sequence.
Sub Pushbutton1_OnRightClick()
'display list of options
.
.
CancelClick
End Sub
236 www.honeywell.com/ps
EVENTS
OnTimer event
Applicable to
Application object
Display objects
Page object
Description
Fires at regular intervals, as determined by the associated timer. (Timers are
created using the CreateTimer method.)
Syntax
OnTimer(timer)
Part Description
timer Returns the ID of the timer.
Example
This example shows how an OnTimer event handler can perform several tasks for
an object that has several timers. In this case, “Tank2” has two timers.
Sub Tank2_OnTimer(lTimerID)
If lTimerID = 1 Then
.
.
.
ElseIf lTimerID = 2 Then
.
.
.
End If
End Sub
237
5 – SCRIPTING REFERENCE
OnUnload event
Applicable to
Display objects
Page object
Description
OnUnload events fire for the current display and each of its display objects when
Station unloads the display (in preparation for displaying another display or
exiting Station).
Syntax
[object.]OnUnload()
Part Description
object The object being unloaded.
Remarks
• Scripts executed as the result of an OnUnload event must not contain any
message boxes, input boxes or dialog boxes.
Example
Sub Page_OnUnload()
.
.
.
End Sub
238 www.honeywell.com/ps
EVENTS
OnUpdate event
Applicable to
Display objects
Description
Fires when a display object is updated by the server, or because its Update
method was called.
Syntax
OnUpdate()
Example
Sub Alphanum1_OnUpdate()
Text1.Value = 2 * Alphanum1.Value
End Sub
239
5 – SCRIPTING REFERENCE
OnUserObjectNotify event
Applicable to
Application object
Page object
Description
Fires when an automation object calls the UserObjectNotify method. (The
method is used by automation objects that may require significant processing
time, thereby avoiding script timeouts.) See “UserObjectNotify method” on
page 210.
Syntax
OnUserObjectNotify(lID, vParam)
Part Description
lID ID that identifies the object that fired the event.
vParam The variant used to return data to the script.
240 www.honeywell.com/ps
ABOUT DISPLAY COORDINATES
Mouse coordinates
When a user views a display in Station, it is surrounded by a small border region,
as shown in gray in the following figure. This region is used, for example, by
scrollbars where the display is larger than the screen.
Inside the display, the mouse coordinates range from 0, 0 to 4499, 7999.
However, if a user moves the pointer over the border region, the coordinates
range from -122, -266, to 4568, 8257.
-122, -266
0, 0
4499, 7999
4568, 8257
241
5 – SCRIPTING REFERENCE
Examples
The following examples demonstrate how scripts can be used.
The \dspbld\examples folder contains a number of example displays, such as
xsmscript.dsp (a numbered display, whose number is 801) which contains an
ActiveX script.
242 www.honeywell.com/ps
EXAMPLES
When inserting the shapelink for the fan, you don’t have to specify how many
shapes you want to use—this is controlled by your scripts.
The following shape sequence is used to represent the two states of the fan. The
first (left-hand) shape represents the “off” state, whereas the other four shapes are
used for the “on” animation.
These shapes are bitmap images that were created in a drawing program and then
pasted into the shape file. Creating the shapes this way made it easier to produce a
more realistic effect.
243
5 – SCRIPTING REFERENCE
The OnTimer script steps through the four “on” shapes. (Values 2 to 5.)
Sub StartBtn_OnTimer(lTimerID)
If Fan.Value = 5 Then
Fan.Value = 2
Else
Fan.Value = Fan.Value +1
End If
End Sub
244 www.honeywell.com/ps
EXAMPLES
Color animation
You want to change the color of the heat exchanger plates as the temperature
varies. The plates are grey rectangles, which are grouped to form one object,
“Plates”.
The OnPeriodicUpdate event for Plates iterates over the rectangles, changing the
surface color in line with the temperature, which is stored in an alphanumeric
object called “alphanum1”.
Sub OnPeriodicUpdate()
Dim Temp
Dim RedComp
Dim BlueComp
Dim GreenComp
Temp = alphanum1.value
‘work out the values of the color components
RedComp = 126.0 + ((300.0 - Temp) / (300.00 - 20.0) * 255.0)/2
BlueComp = 126.0 - ((300.0 - Temp) / (300.00 - 20.0) * 255.0)/
2
GreenComp = 126.0 - ((300.0 - Temp) / (300.00 - 20.0) *
255.0)/2
For Each rect in Objects
rect.FillColor = Application.MakeColor(RedComp,
BlueComp, GreenComp)
Next rect
End Sub
245
5 – SCRIPTING REFERENCE
246 www.honeywell.com/ps
EXAMPLES
Whenever the support tool needs Station to display a particular display (such as
“301”), it uses the following command to instruct Station to display that display.
stationApp.CurrentPage = 301
247
5 – SCRIPTING REFERENCE
248 www.honeywell.com/ps
EXAMPLES
' Now reference the doc and set value of the current cell
safebrowse1.Document.Application.ActiveCell.Value = 12
249
5 – SCRIPTING REFERENCE
250 www.honeywell.com/ps
Guidelines for creating user-
friendly displays 6
The aim of this chapter is to help you create well designed and user-friendly
displays.
When designing displays it is important to keep the following principles in mind:
• Involve users and try to see the system from their perspective. It is a good idea
to involve users throughout the design and testing process. This helps you
focus on the design of the displays, and the tasks users need to perform.
• Use design elements consistently throughout all displays. Users will then
know how to interpret a display even if they have never seen it before or use it
infrequently.
• When providing users with options, use check boxes and combo boxes (lists
of valid choices), rather than forcing them to enter an obscure code or number.
• Avoid creating displays that are cluttered or have a haphazard layout. Well
designed displays are easier to understand and easier to use.
251
6 – GUIDELINES FOR CREATING USER-FRIENDLY DISPLAYS
General standards
The following general standards apply to all system displays and can be used to
help you create consistent custom displays. You may use them as the basis for
creating your own style guide.
Using color
You need to design displays that are legible on any user selectable background
color. (The system displays use an embedded background graphic that overrides
the user selected background.)
Limit the use of color to either special conditions such as alarms and indicators,
or to show relatedness (on trend displays for example) by color keying. Do not
use color in an arbitrary manner. Too many colors or activity on a display leads to
confusion.
Color is very effective in indicating different states. However, do not rely on color
alone to indicate a state. Use color as a separate indicator showing redundant
information. For example, you could use a text box beside an LED style dynamic.
Using animation
The principles that apply to color also apply to animation. Too much activity on a
display can lead to confusion. Use animation sparingly for the most effective
results.
252 www.honeywell.com/ps
GENERAL STANDARDS
Designing layouts
In general, favor an asymmetric layout. Make use of blank regions to provide
balance and promote legibility.
Use similar layouts for similar displays or groups of information. For example,
make all report detail similar.
Align display components in a visually intelligible manner, based on an
underlying grid.
Use existing displays as templates for any new displays.
Layering
Layer displays so that the display title bar (and its elements) is displayed first,
followed by other display components from the top left to the bottom right in
order.
253
6 – GUIDELINES FOR CREATING USER-FRIENDLY DISPLAYS
Title bar
The title bar describes the contents or purpose of the display.
As a minimum, a title bar should show the (static) title and, if appropriate, an icon
for visual reinforcement. If the display contains a dynamic item or view (for
example, point detail displays show one specific point at a time), show the current
item or view as an additional dynamic title. Other dynamic objects such as combo
boxes or data entry boxes that define the display view can also be shown.
Locate navigation push buttons that call up related displays, but which do not
indicate the display contents, on the right of the display title bar. In this way the
right hand side of the title bar can be used like a display-specific toolbar,
removing clutter and distraction from the display and reinforcing the function of
buttons in this position.
254 www.honeywell.com/ps
GENERAL STANDARDS
255
6 – GUIDELINES FOR CREATING USER-FRIENDLY DISPLAYS
Graphic pushbuttons
You can use graphics on pushbuttons:
• To save space when the item is redundant anyway (for example, display title
pushbuttons). The experienced user can use these buttons when the graphics
become familiar.
• To reinforce the text description and make it quick and easy to recognize (for
example, menu displays).
• To be used in conjunction with icons that are associated with the titles of the
displays being called up (for example, menu displays) so that the icon is
reinforced.
256 www.honeywell.com/ps
GENERAL STANDARDS
Comboboxes
Comboboxes are used for selecting one item from a list, which appears when the
combobox is selected. The currently active choice will appear in the combo box.
Use a white background and black text.
257
6 – GUIDELINES FOR CREATING USER-FRIENDLY DISPLAYS
Checkboxes
Checkboxes are used for toggling the state of an item. The checkbox is checked
when the item is enabled and is white when disabled.
Only use a checkbox when a user can manually change the state (at some security
level). Otherwise, use “LED indicators”.
Use a white background and black text.
258 www.honeywell.com/ps
GENERAL STANDARDS
Group headings
You can use group headings to organize the information on your display so that it
is easier to comprehend.
As a general rule, use no more than eight group headings (or other items mixed
with group headings) on a display. If the display becomes cluttered, either
reorganize the information into different frame headings or use more than one
display.
259
6 – GUIDELINES FOR CREATING USER-FRIENDLY DISPLAYS
Tables
Tables can include alphanumeric data boxes, combo boxes, push buttons and
check boxes. Large tables can use a scroll bar.
A table consists of a “table heading” and body of the table. The scroll bar is
optional.
The “table heading” identifies each column of the data. Each table row is
uniquely identified by one (or more) index fields that form part of the tabular
data. These index fields can be thought of as the “independent variable(s)” in the
table.
Add a scroll bar to a table if there are more rows than can be shown on the
display.
Attention Application Programmers, ensure data that you want to be able to scroll is
laid out so that you can use record or field indexing to each line in the
table. The advantages of using a table with scroll bar are substantial, as:
• No extra displays are required
• The display is not redrawn as you scroll—only the records change
• The scroll box indicates what view of the total data you are seeing
• You can scroll by individual records or by pages of records
260 www.honeywell.com/ps
GENERAL STANDARDS
Icons
Icons are used to reinforce display titles and also for navigation. An icon should
be a simple graphic symbol rather than a “real” picture.
When associated with display titles, icons help the user identify the display as
belonging to a certain subsystem or relevant to a particular subject. You can
reinforce this by using icons on menu pages and their push buttons. When these
buttons are pressed a display containing that icon is called up. For the experienced
user then, iconic push buttons on the toolbar and display title bar provide a quick
means of navigation.
When creating icons, keep the following points in mind:
• Simple icons are easier to remember and are less likely to appear
unprofessional.
• Limit the number of icons to fairly broad categories of the application.
• Re-use the icons in as many related areas as possible. The more frequently an
icon appears, the more likely it will be remembered. For example, you could
use a magnifying glass icon for all point detail displays.
• Reinforce icons with text (where space permits) to assist in the learning
process.
Consider using icons in the following locations:
• Preceding the display title
• Navigation push buttons on the right hand side of the display title bar
• Menu displays associated with text
261
6 – GUIDELINES FOR CREATING USER-FRIENDLY DISPLAYS
262 www.honeywell.com/ps
FURTHER READING
Further reading
The following references contain more material on human-computer interface
design:
Laurel. B., Ed. (1990) The Art of Human-Computer Interface Design. Wellesley,
MA: Addison-Wesley.
Articles and essays by leaders in HCI. Easy to read with lots of interesting history
and information.
Norman, D. (1988). The Design of Everyday Things. New York: Basic Books.
Great information about designing for usability from a wide range of fields.
Shneiderman, B. (1992). Designing the User Interface: Strategies for Effective
Human-Computer Interaction. Reading, MA: Addison-Wesley.
A synthesis of computer science and psychology. Deals with the human factors
aspects of several types of system.
Tognazzini, B. (1992). Tog on Interface. Reading, MA: Addison-Wesley.
A good expose on the Apple Macintosh user interface.
263
6 – GUIDELINES FOR CREATING USER-FRIENDLY DISPLAYS
264 www.honeywell.com/ps
Tutorial
7
This tutorial shows you how to create the simple display shown below.
In this tutorial you learn how to:
• Draw and group display objects
• Link display objects to the database
• Animate display objects
• Link to another display using a push button
• Save the display so that it can be called up in Station
265
7 – TUTORIAL
Activating snap-to-grid
The snap-to-grid function makes it much easier to align display objects.
To activate snap-to-grid:
1 Click the Snap-to-Grid tool— —on the Arrange toolbar. Note that you can
turn off the function by clicking the tool a second time.
You can display the names of tools by moving the pointer slowly over the tools.
266 www.honeywell.com/ps
DRAWING THE OBJECTS
267
7 – TUTORIAL
268 www.honeywell.com/ps
DRAWING THE OBJECTS
You can now change the pump’s fill and line colors:
1 Click the Fill Color tool on the Format toolbar and select red from its color
palette.
2 Click the Line Color tool and select “X” (which represents transparent) from
its color palette.
Changing the color (or any other property) of a selected object only changes that
object’s color—it does not change the default color.
269
7 – TUTORIAL
270 www.honeywell.com/ps
DRAWING THE OBJECTS
271
7 – TUTORIAL
272 www.honeywell.com/ps
DRAWING THE OBJECTS
273
7 – TUTORIAL
5 Click the Data tab and select Point/Parameter from the Type of database
link property.
6 Type tanklevel (this is a point’s ID) in the Point property.
If you are creating the display on the server, Point will contain a list of all
database points. So, rather than typing the point ID, you simply select it from
the list.
274 www.honeywell.com/ps
DRAWING THE OBJECTS
275
7 – TUTORIAL
The Properties Window always shows the properties of the selected object(s).
Consequently, it now shows the push button’s properties.
5 Click the Details tab on the Properties Window.
6 Type Overview in the Label property.
7 Select Callup Page from the Action property and type Summary in the Page
property. (Note that you do not have to add the filename’s extension.)
276 www.honeywell.com/ps
DRAWING THE OBJECTS
277
7 – TUTORIAL
278 www.honeywell.com/ps
SAVING THE DISPLAY
279
7 – TUTORIAL
280 www.honeywell.com/ps
Reference information
8
For information about: Go to:
Keyboard shortcuts page 282
The shortcut menu, which appears when you right-click page 283
Point detail displays page 284
Using Display Builder’s command-line commands page 287
DisplayInfo, a command-line information extraction tool page 288
281
8 – REFERENCE INFORMATION
Keyboard shortcuts
Command Shortcut
Arrange > Align > Bottom> CTRL+Y
Arrange > Align > Center CTRL+W
Arrange > Align > Left CTRL+Q
Arrange > Align > Middle CTRL+T
Arrange > Align > Right CTRL+E
Arrange > Align > Top CTRL+R
Arrange > Bring to Front CTRL+L
Arrange > Group CTRL+G
Arrange > Send to Back CTRL+K
Arrange > Ungroup CTRL+F
Edit > Copy CTRL+C
Edit > Cut CTRL+X
Edit > Delete DELETE
Edit > Duplicate CTRL+D
Edit > Paste CTRL+V
Edit > Select All CTRL+A
Edit > Undo CTRL+Z
File > New > Display CTRL+N
File > Open CTRL+O
File > Print CTRL+P
File > Save CTRL+S
282 www.honeywell.com/ps
USING THE SHORTCUT MENU
283
8 – REFERENCE INFORMATION
Property Description
Type of database link Select Point/Parameter.
Point Leave blank.
284 www.honeywell.com/ps
CREATING A POINT DETAIL DISPLAY
Property Description
Parameter The syntax is: Alias.Parameter
Where:
• Alias is the name you defined in Quick Builder for
the “contained” (child) point
• Parameter is parameter name.
For example, if you wanted to display the PV of a
contained point whose alias is “HoursRun”, you would
type: HoursRun.PV
Data entry allowed Allows users to edit the object’s value. (See “About the
Value Property” on page 163.)
If you allow data entry, select the minimum Security
Level required to change the value.
Property Description
Type of database link Select Point/Parameter.
Point Leave blank.
Parameter The parameter name.
Data entry allowed Allows users to edit the object’s value. (See “About the
Value Property” on page 163.)
If you allow data entry, select the minimum Security
Level required to change the value.
Property Description
Type of database link Select Point/Parameter.
Point The name of the control module.
Parameter The syntax is: ContainedObject.Parameter
Where:
• ContainedObject is the contained CM within the
point, or a basic block (for example, a PID)
• Parameter is the name of the parameter within the
contained block
285
8 – REFERENCE INFORMATION
Property Description
Data entry allowed Allows users to edit the object’s value. (See “About the
Value Property” on page 163.)
If you allow data entry, select the minimum Security
Level required to change the value.
286 www.honeywell.com/ps
USING DISPLAY BUILDER’S COMMAND-LINE PARAMETERS
Syntax
To open a display:
dspbld displayname.dsp
To export a display:
dspbld -e|-es displayname.dsp [-out outfilename]
Part Description
-e Exports the display, and displays a warning message if
any display object references a non-existent point ID.
-es Exports the display, but suppresses any warning
messages.
displayname.dsp The display that is exported.
-out outfilename Display Builder writes any warning messages to this
file.
Notes
If you use -e or -es:
• Both Display Builder and the display must be on the server.
• Display Builder is not invoked interactively, which means that you cannot
modify the display.
287
8 – REFERENCE INFORMATION
Using DisplayInfo
DisplayInfo is a command-line utility that allows you to examine various display
details.
Syntax
displayinfo [options] displayfile
Part Description
options The options, which can be any order:
-d Provides details about the display objects.
-l Provides a shapelink summary.
-p Provides details about points referenced in the
display.
-s Lists scripts.
-v Generates a verbose (detailed) output.
displayfile The name of the display.
Example
The following example shows the results if you use DisplayInfo without any
options:
DisplayInfo r### ...
Filename : MainBoiler.dsp
Type : Standard display
Title : Boiler Statuses
Last saved : Tue Aug 14 21:35:24 1998
File version : r###.# (0x22)
Total objects : 53
Total scripted objects : 16
Total dependent shapelinks : 3
288 www.honeywell.com/ps
Glossary
acronym
An acronym is a text string that is used to represent a state or value of a point in a
display. From an operator’s point of view, it much easier to understand the
significance of an acronym such as “Stopped”, compared with an abstract value
such as “0”.
ActiveX component
An ActiveX component is a type of program designed to be called up from other
applications, rather than being executed independently. An example of an
ActiveX component is a custom dialog box, which works in conjunction with
scripts, to facilitate operator input into Station.
alarm
An indication—visual and/or audible—that alerts an operator at a Station of an
abnormal or critical condition. Alarms can be assigned either to individual points
or for system-wide conditions, such as a controller communications failure.
algorithm
See point algorithm.
analog point
A point type that is used to represent continuous values that are either real or
integer. Continuous values in a process could be: pressure, flow, fill levels, or
temperature.
application program
A user-written program integrated into Experion using the Application
Programming Interface (API).
asset
(Previously called area.) A representation of entities such as plant equipment,
facilities, buildings. Operators or Stations can be assigned access to particular
assets only.
bad value
A parameter value, (for example, PV), that is indeterminate, and is the result of
conditions such as unavailable input.
289
GLOSSARY
Client software
An umbrella term covering Experion, Quick Builder, Station, and Display Builder
software.
collection
A collection is a set of named values or display objects that are used in scripts.
default
The value that an application automatically selects if the user does not explicitly
select another value.
display
Station uses displays to present Experion information to operators in a manner
that they can understand. The style and complexity of displays varies according to
the type of information being presented.
Displays are created in Display Builder.
display object
A display object is a graphic element, such as an alphanumeric, a push button or a
rectangle, in a display.
Display objects that represent point information (such as an alphanumeric) or
issue commands (such as a push button) are called “dynamic” display objects.
event
Can have either of two meanings:
• Within the context of the system, an event is a significant change in the status
of an element, such as a point or piece of hardware. Some events have a low,
high, or urgent priority, in which case they are further classified as alarms.
Events can be viewed on an operator Station display and included in reports.
• Within the context of scripts, an event is a change in system status or an
operator-initiated action that causes a script to run.
export
The process of registering a numbered display with the server so that it can be
called up in Station.
group
A group of up to eight related points whose main parameter values appear in the
same group display.
290 www.honeywell.com/ps
GLOSSARY
history
Point values stored to enable tracking and observation of long-term trends.
Analog, status, and accumulator point PVs can be defined to have history
collected for them.Three types of history collection are available:
• Standard
• Extended, and
• Fast
local display object
A dynamic display object that displays information or issues a command, but
which is not linked to the server. Such display objects are used in conjunction
with scripts.
method
A programmatic means of controlling or interrogating the Station Automation
object model. A method is equivalent to the terms “function” or “command” used
in some programming languages.
Mode
A point parameter which determines whether or not the operator can control the
point value. For example, in a status point, the mode determines whether the
operator can control the output value
operator ID
A unique identification assigned to each operator. If operator-based security is
enabled, the operator must use this ID and a password to sign on to a Station.
operator password
A character string (not echoed on screen) used with the operator ID to sign on to
an operator Station.
operator security level
Experion has six security levels defined for performing operations. An operator is
assigned a security level and may perform functions at or below that security
level.
operator-based security
An operator-based security comprises an operator ID and password, which must
be entered at an operator Station in order to access Experion functions.
291
GLOSSARY
Output
A point parameter used to issue control values. The output (OP) is often related to
the mode (MD) parameter and can be changed by an operator only if the mode is
manual.
point
A data structure in the server database, usually containing information about a
field entity. A point can contain one or more parameters.
point algorithm
A prescribed set of well-defined rules used to enhance a point’s functionality. The
point algorithm accomplishes this by operating on the point data either before or
after normal point processing.
There are two types of point algorithms, PV (processed every time the point
parameter is scanned) and Action (processed only when a point parameter value
changes).
Point Detail display
A display that shows the current point information. Each point has a Point Detail
display.
process variable
An actual value in a process: a temperature, flow, pressure, and so on. Process
variables may be sourced from another parameter and may also be calculated
from two or more measured or calculated variables using algorithms.
property
In Display Builder a property is attribute or characteristic of an object within the
Station Automation object model. For example, a display object has properties
that define its height, width and color.
PV algorithm
One of two types of algorithm you can assign to a point in order to perform
additional processing to change point parameter values. A PV algorithm changes
the value of the point process value (PV) input only. Contrast with Action
algorithm.
report
Information collected by the server database that is formatted for viewing. There
are several pre-formatted reports, or the user can customize a report. Reports may
be generated on demand or at scheduled intervals. Reports can be printed or
displayed on an operator Station.
292 www.honeywell.com/ps
GLOSSARY
SafeBrowse object
A SafeBrowse object is a Web browser specifically designed for use with Station.
SafeBrowse includes appropriate security features that prevent users from
displaying unauthorized Web pages or other documents in Station.
script
A script is a mini-program that performs a specific task. Scripts use the Station
Automation object model to control and interrogate Station and its displays.
security level
Access to Experion functions is limited by the security level of the operator.
Experion has six security levels.
server
The computer on which the Experion database software runs.
Server software
An umbrella term used to refer to the database software and server utilities
installed on the Experion server computer.
server Station
A computer running both the Experion database (server) software and the Station
software. This computer can also be used as an operator Station.
setpoint
The desired value of a process variable. Setpoint is an analog point parameter, and
the value is entered by the operator. The setpoint can be changed any number of
times during a single process. The setpoint is represented in engineering units.
shape
A shape is a special type of display object that can be used in numerous displays.
Shapes can be used as “clip-art” or as shape sequences.
shapelink
A shapelink is, in effect, a “window” which always displays one shape of a shape
sequence. For example, a shapelink representing a point’s status displays the
shape that corresponds to the current status.
shape sequence
A shape sequence is a set of related shapes that are used in conjunction with
shapelinks. A shape sequences can be used to:
• Represent the status of a point. (Each shape represents a particular status.)
• Create an animation. (Each shape is one “frame” in the animation.)
293
GLOSSARY
softkey
A softkey is a function key which, when pressed, performs the action specified by
the current display.
Station
The main operator interface to Experion. Stations may run on either a remote
computer through a serial or LAN link, or on the server computer.
When Station is running on the Experion server computer, it is often referred to as
a server Station. When it is running on a machine other than the server, it is often
referred to as an operator Station.
Station Automation object model
The Station Automation object model provides the programming interface
through which scripts control Station and its displays.
status point
A point type used to represent discrete or digital field values.
Output values can be used to control up to two consecutive discrete locations in a
controller. Output values can be automatic or operator-defined.
Mode values apply to output values and determine whether or not the output
value is operator-defined or automatic.
task
A task is any of the standard server programs or an application program that can
be invoked from a display.
timer
A timer is a programming mechanism for running scripts at regular intervals in
Station.
URL
Uniform Resource Locator. For example, a Web address.
utility
Experion programs run from a command line to perform configuration and
maintenance functions; for example, the lisscn utility.
294 www.honeywell.com/ps
Index
Symbols tool 22
Animation tab, Properties window 76
17 Appearance tab, Properties window 78
Application object
A described 146
reference 149
accelerator keys 282 AppWindow object
acronyms described 146
adding custom acronym display to menu 115 reference 154
creating a custom acronym display 114 Arc tool 22
creating a custom acronym file 114 Arrange toolbar
custom 114, 115 Display Builder 24
default 112 arranging
defining custom 115 display objects
described 112 (DSP) Display Builder 24
selecting 113, 115
assigning
system 112
actions to keys (DSP displays) 122
user 112
document
actions to a display (DSP) 128
assigning to keys (configuring DSP help
displays) 122 to a display (DSP) 126
ActiveX Documents Automation object model 146
described 22
Automation, scope 145
properties 87
tool 22
Add method 169 B
AddListItem method 170
BeginCriticalSection method 171
Alarm Line
properties 88 Blue method 172
tool 22 Bold tool 26
Align tools bring display object to front 36
Bottom (of page) 24 Bring To Front tool 24
Center (a display object) 24
Left (a display object) 24
Middle (of page) 24
C
Page Center 24 callup task for a display (DSP) 123
Right (a display object) 24 callup task tab
Top (of page) 24 display properties
aligning display objects 33 DSP 123
alphanumeric CancelChange method 173
properties 89 CancelClick method 174
295
INDEX
296 www.honeywell.com/ps
INDEX
297
INDEX
298 www.honeywell.com/ps
INDEX
299
INDEX
300 www.honeywell.com/ps
INDEX
301
INDEX
302 www.honeywell.com/ps
INDEX
303
INDEX
U
Underline tool 26
Undo tool 20
undoing the previous action 46
Ungroup tool 24
Update method 209
URL formats 60
user file, linking a display object to 83
UserObjectNotify method 210
V
validating events 134
validating point IDs in remotely-built display 71
Video tool 22
View toolbar
Display Builder 23
W
Web browser
SafeBrowse 60
tool 22
Wedge tool 22
Windows
Properties Window
DSP 47
windows
Shape Gallery 57
working with files 69
writing scripts 131
X
XFI, display format 68
XSM, display format 68
XY Plot tab, Properties window 111
Z
Zoomer tool 21
304 www.honeywell.com/ps
Honeywell Process Solutions
1860 W. Rose Garden Lane
Phoenix AZ 85027
USA EP-DSXX36
April 2010
www.honeywell.com © 2010 Honeywell International Sàrl