Documente Academic
Documente Profesional
Documente Cultură
Version A1.1
Users Guide
OperateIT
Graphics
Version A1.1
Users Guide
3BSE 017 091R301
NOTICE
The information in this document is subject to change without notice and should not be construed as a commitment by
ABB Automation Products AB. ABB Automation Products AB assumes no responsibility for any errors that may appear
in this document.
In no event shall ABB Automation Products AB be liable for direct, indirect, special, incidental, or consequential damages
of any nature or kind arising from the use of this document, nor shall ABB Automation Products AB be liable for
incidental or consequential damages arising from use of any software or hardware described in this document.
This document and parts thereof must not be reproduced or copied without ABB Automation Products ABs written
permission, and the contents thereof must not be imparted to a third party nor be used for any unauthorized purpose.
The software described in this document is furnished under a license and may be used, copied, or disclosed only in
accordance with the terms of such license.
TRADEMARKS
IndustrialIT, OperateIT and ControlIT are registered trademarks of ABB Ltd., Switzerland.
Microsoft, MS-DOS, Visual Basic and Windows 2000 are registered trademarks of Microsoft Corporation.
TABLE OF CONTENTS
Chapter 1 - Introduction
1.1 About This Book.................................................................................................... 1
1.1.1 How to Use This Book.......................................................................... 2
1.2 Product Overview .................................................................................................. 3
1.2.1 What You Can Do with OperateIT Graphics......................................... 3
1.3 Prerequisites and Requirements............................................................................. 4
1.4 Related Documentation.......................................................................................... 4
1.5 Conventions ........................................................................................................... 5
1.6 Terminology........................................................................................................... 7
Chapter 2 - Installation
2.1 Product Verification ............................................................................................. 11
CONTENTS (continued)
3.6 Expression Builder............................................................................................... 26
3.6.1 The top half of the Expression Builder ............................................... 28
3.6.2 The bottom half of the Expression Builder......................................... 30
3.6.3 Assign Expressions to Properties........................................................ 33
3.6.4 Using Logical Colors .......................................................................... 34
3.6.4.1 Logical Colors in Process Graphics ............................. 35
3.7 Object list............................................................................................................. 36
3.7.1 Populate the Object List...................................................................... 38
3.7.1.1 Autopopulate the object list ......................................... 39
3.8 Element Browser.................................................................................................. 40
3.9 Background Color of Graphic Aspects ................................................................ 42
3.9.1 How to Set the Background Color ...................................................... 43
3.9.2 Changing the Color of Prebuilt Elements ........................................... 44
3.10 Controlling the Update Rate of Data Subscriptions............................................. 45
3.11 Testing Graphic Aspects ...................................................................................... 45
3.12 Saving, Deploying and Deleting Graphic Aspects .............................................. 47
3.13 Precautions When Importing/Exporting Aspects ................................................ 47
3.14 Precautions When Copying Aspects.................................................................... 49
3.15 Properties Window............................................................................................... 49
Chapter 4 - Faceplates
4.1 Using Faceplates in Runtime ............................................................................... 54
4.2 Faceplate Configuration Overview ...................................................................... 58
4.2.1 Header ................................................................................................. 59
4.2.2 Status and Navigation Bar .................................................................. 62
4.2.3 Faceplate Element Area ...................................................................... 62
4.2.4 Buttons ................................................................................................ 63
4.2.5 View Selection Buttons....................................................................... 64
4.3 Create a New Faceplate Aspect ........................................................................... 64
CONTENTS (continued)
4.4 Configuring the Faceplate ....................................................................................65
4.4.1 Layout Tab...........................................................................................67
4.4.2 Indicators Tab......................................................................................69
4.4.2.1 Expression syntax in Faceplates...................................72
4.4.3 Buttons Tab .........................................................................................73
4.4.4 Elements Tab .......................................................................................75
4.5 Configuring Faceplate Elements ..........................................................................76
4.5.1 How to write to the Properties of an Object........................................76
4.5.2 Configuring the Direct Entry Window................................................77
4.5.2.1 Incremental Change of Property Values in the Direct Entry
Window ........................................................................78
4.5.2.2 Stepsize in the Direct Entry Window ...........................79
4.5.3 Visual Basic Error Handling ...............................................................80
4.5.4 The faceplate session handler..............................................................80
Chapter 5 - Maintenance
5.1.2 Edit is Dimmed or Missing in the Context menu................................86
5.1.3 Edit Imported Graphics Aspect with 3rd party ActiveXs..................86
Chapter 6 - Tutorial
6.1 Tutorial 1, Building a Graphic Display ................................................................88
6.1.1 Build a Graphic Display......................................................................89
6.1.2 Adding Graphic Elements to the Graphic Display..............................91
6.1.3 Using Logical Colors ..........................................................................92
6.2 Tutorial 2, Building a Graphic Element ...............................................................93
6.2.1 Creating a Graphic Element ................................................................94
6.2.2 Building a Graphic Element................................................................96
6.2.3 Changing Properties for the Generic Element ....................................97
6.2.4 Assigning Expressions to Properties ...................................................98
6.2.5 Testing the Graphic Element ...............................................................99
6.2.6 Deploying a Graphic Element ...........................................................100
CONTENTS (continued)
6.3 Tutorial 3, Creating and Configuring Faceplates............................................... 100
6.3.1 Creating a Faceplate Element ........................................................... 102
6.3.2 Configuring a Faceplate.................................................................... 106
CONTENTS (continued)
A.3.2 Fill Properties ....................................................................................137
A.3.2.1 Fill Styles....................................................................138
A.3.3 Fill Properties with Shade .................................................................139
A.3.3.1 Fill Styles....................................................................140
A.3.4 3D Frame Properties .........................................................................142
A.3.4.1 3D Effect.....................................................................142
A.3.5 Smooth ..............................................................................................143
A.3.6 Angle Properties................................................................................143
A.3.7 Point Properties .................................................................................144
A.4 ABB Subelements ..............................................................................................146
A.4.1 Bar .....................................................................................................146
Appendix B - Expressions
B.1 Introduction ........................................................................................................153
B.2 Expressions ........................................................................................................154
B.3 Object Properties ................................................................................................155
B.4 Object Path .........................................................................................................155
B.4.1 Property Reference in Faceplates......................................................156
B.5 Logical Colors ....................................................................................................156
B.5.1 Enable/Disable Blinking Colors........................................................156
B.6 Subscription Control ..........................................................................................158
B.6.2 Property .............................................................................................159
B.6.3 Method ..............................................................................................160
B.7 Object References ..............................................................................................160
B.7.1 Relative and Absolute References ....................................................161
B.7.2 Relative References...........................................................................161
B.7.3 Absolute References..........................................................................161
B.8 Quality attributes of Object Properties...............................................................162
B.8.1 Handling Bad Data ............................................................................163
CONTENTS (continued)
Appendix C - Sizes of Faceplates
C.1 Default Faceplate Element................................................................................. 165
C.2 Default Faceplate ............................................................................................... 165
C.2.1 Sizes of each default component in a Faceplate ............................... 166
C.3 Non-default Faceplate........................................................................................ 166
C.3.1 Size of Each Part of the Components ............................................... 166
C.3.1.1 Header ........................................................................ 167
C.3.1.2 Status-, Navigation bar and Buttons........................... 167
C.3.1.3 Element ...................................................................... 168
C.3.2 Example ............................................................................................ 168
Chapter 1 Introduction
Warning indicates the presence of a hazard which could result in personal injury.
Tip indicates advice on, for example, how to design your project or how to use a
certain function.
Although Warning hazards are related to personal injury, and Caution hazards are
associated with equipment or property damage, it should be understood that
operation of damaged equipment could, under certain operational conditions, result
in degraded process performance leading to personal injury or death. Therefore,
comply fully with all Warning and Caution notices.
Where to Start
If you are a first-time user, refer to Section 1.2.1, What You Can Do with OperateIT
Graphics to learn about the basic functions and features for this software option.
Installation
Chapter 2, Installation describes some of the procedures and preparations you need
to know when you load/install Process Graphics software.
Faceplates
Refer to Chapter 4, Faceplates to learn more about how to configure faceplates.
More information about Visual Basic can be found in Microsofts manuals, On-line
Help and On-line Documentation.
1.5 Conventions
The following conventions are used throughout this book for the presentation of
material:
The words in proper names of screen elements (for example, the title in the title
bar of a window, the label for a field of a dialog box) are initially capitalized.
Capital letters are used for the name of a keyboard key if it is labeled on the
keyboard. For example, press the ENTER key.
Lowercase letters are used for the name of a keyboard key that is not labeled on
the keyboard. For example, the space bar, comma key, and so on.
A plus sign is used to indicate that you must simultaneously press several keys.
For example, CTRL+C indicates that you must hold down the CTRL key while
pressing the C key.
The phrase "press and release" is used to indicate that you sequentially press
several keys. For example, to close a window, press ALT, and then F4. This
indicates that you press ALT key, and then you press and release the F4
function key.
The names of push and toggle buttons are boldfaced. For example, click OK.
The names of menus and menu items are boldfaced. For example, the File
menu.
The following convention is used for menu operations: MenuName >
MenuItem > CascadedMenuItem. For example: choose File > New >
Type.
The Start menu name always refers to the Start menu on the
Windows NT Task Bar.
System prompts/messages are shown in the Courier font, and user
responses/input are in the boldfaced Courier font. For example, if you enter a
value out of range, the following message is displayed:
Entered value is not valid. The value must be 0-30.
In a tutorial, you may be told to enter the string TIC132 in a field. The string is
shown as follows in the procedure:TIC132
1.6 Terminology
The following is a list of terms associated with Graphics that you should be familiar
with
Term Description
ActiveX Microsoft standard for user interface
components.
Aspect An aspect is a description of some
properties of an Aspect Object. Some
examples of aspects are name, circuit
diagram, graphic display, and control logic.
Aspect Objects A computer representation of a real object
like a pump, a valve, an order or a virtual
object like a service or an object type. An
Aspect Object is described by its aspects
and organized in structures.
Expressions Expressions are calculations that specify
subscriptions and relationship between
process data and data to be displayed. The
expression language is based on standard
Visual Basic.
Faceplate Faceplates are used to monitor and control
process data. A faceplate has a
configuration view where you insert
faceplate elements, buttons, status
indicators and aspect links. The faceplate
can have up to three run-time views:
reduced, normal and extended, depending
on how much information the user wants.
Faceplate Element Faceplate elements are used both for
presentation and modification of object
properties. Faceplate elements are object
aware.
Term Description
Generic Element Generic elements are ActiveX controls and
the most basic building blocks in Process
Graphics. They cannot subscribe for live
data themselves and they are dependent of
a container (a graphic aspect) to exist.
Primitives and subelements are generic as
well as standard Visual Basic controls and
3rd party ActiveX controls.
Graphic Aspect Aspects defined by the Process Graphics
aspect system. This system defines two
aspect types:
1. Graphic display
2. Graphic element.
Graphic Display Graphic displays are aspects directly
selected and viewed by the process
operator.
Graphic Element Graphic Elements are building blocks that
are used in graphic displays and other
graphic elements.
IndustrialIT IndustrialIT is ABBs solution, that creates a
business enterprise where your plant
automation, asset optimization, and
collaborative business systems are
seamlessly linked in real time.
Invocation object The object for which the graphic aspect is
invoked. This is applicable to graphic
aspects, that contain relative object
references, such as graphic elements and
object displays. Thus, the invocation object
becomes the top part of resulting object
references from the graphic aspect.
Term Description
Navigation Display A graphic display, which is a tool to help
you navigate and is a configurable graphic
aspect. It enables navigation through
structures in a graphic way. When you click
on a graphic element, the other parts of the
workplace panel is filled with aspects for the
object which the graphic element resides
on.
Object aware Graphic aspects that represent certain
process objects. They have the ObjectPath
property, to define the object reference.
Examples are: A graphic element for a
valve object type, or a graphic display in the
functional structure of Plant Explorer.
OPC An application programming interface
defined by the OPC Foundation. The
application of the OPC standard interface
makes possible interoperability between
automation/control applications, field
systems/devices and business/office
applications.
OperateIT The name for the collection of products for
daily operation and supervision of an
automated process
OperateIT Plant Explorer A configuration of the Internet Explorer for
creating the Aspect Object that you use to
put together the plant. You can also use it to
browse and search the structures of the
plant.
Term Description
Primitives Primitives are ActiveX controls provided by
ABB. They belong to the group of generic
elements and can be used as symbols in
graphic elements or as background static
graphic in displays. Primitives are not
aspects and therefore they must be
installed on every workplace where they will
be used
Property (1) A data field on an aspect on Aspect Object
that can be accessed by process graphics.
Property (2) A data field on an ActiveX control.
Structure A tree organization of Aspect Objects.
An Aspect object can exist in multiple
structures, for example both in Functional
structure and in Location structure.
Subelement A subelement is a graphic aspect, which is
not object aware. The subelement is merely
basic building block (generic element) that
you create with Graphics Builder. You place
your subelement aspects in a library in the
graphics structure.
View An Aspect can have several ways to be
presented depending on the task
performed, like viewing or configuration.
Each presentation form is called a view.
Chapter 2 Installation
When you are working with graphic aspects, the main objectives of Graphics
Builder are:
To configure graphic aspects.
To test graphic aspects.
To save graphic aspects.
To deploy graphic aspects.
3.0.2 Features
Graphics Builder has a lot of Visual Basic features.
The following features are specific for Graphics Builder.
Expression Builder that allows you to assign expressions (that is, to specify
subscriptions and specify the relationship between the process data and the data
that is to be displayed).
Graphic Libraries dialog which allows you to add Primitives and Subelements
to your toolbox.
Element Browser in which you can select appropriate graphic elements.
Design and Test function that enables you to build graphic aspects in design
mode and then check their behaviour in test mode.
Deploy function which stores the graphic aspects and enables viewing of
process displays by process operators. Before a graphic element is deployed, it
can only be seen in Graphics Builder.
Help function that offers you access to On-line Help and On-line
Documentation for Graphics Builder.
Graphics wizard that guides you through the steps of building graphic aspects.
Add Member function that allows you to add properties, methods, and events
to a graphic element.
These features are accessed through the pull-down menu in the menu bar or through
tool buttons.
5. Enter an aspect name and click Create. The created aspect is added to the
objects aspect list.
6. Right-click it and choose Edit from the context menu. The Graphics Builder is
launched.
It is also possible to create graphic aspects using Graphics Builder.
Simply choose New Aspect in the File menu and the Graphics Wizard is launched.
A subelement is mostly small, it is not object aware like the other categories.
It is merely a basic building block. (Graphic aspects that represent certain
process objects are said to be object aware, if they have an object reference
as a property). The subelement aspects are placed in a library in the graphics
structure.
Faceplate elements are used in Faceplates to monitor and control data.
A Graphic element is typically built of generic elements that are configured to
display dynamic data. It represents objects of a certain object type. For
example a valve. It has a reference to an Aspect Object. This building block is
used in graphic displays and even other graphic elements. ABB provides
graphic elements for various controllers (see OperateIT Connectivity Library
manuals), while others may be built by you, or purchased from other sources in
the form of graphic libraries.
A Graphic display is made to be handled and viewed by the process operator. It
covers a large part of the screen and typically contains more information than a
graphic element. The static part of the display is often built with generic
elements.
You can create your own aspect categories with templates, for more information see
Appendix D, Create New Aspect Categories with Templates.
Advanced Usermode
The Advanced User Mode option gives you access to more menus and functions in
Visual Basic. If you have not selected Advanced User Mode, some menus or menu
items are dimmed, which means that they are unavailable.
Click in the checkbox to select Advanced User Mode.
Debug
Click the Debug checkbox to get access to an additional Debug menu.
Element Browser
Click the checkbox to show Element Browser at startup.
Expression Builder
Click the checkbox to show Expression Builder at startup.
100.0 100.0
100.0
? ?
??
0.0 0.0
AI 14
0.0
Subelements
Special
Extended Primitives
General
This is Visual Basics own built in controls (Graphic libraries). They are always
included in the toolbox. Click on the General button to display them.
Special
Click on the Special button to display the options. One of the buttons is an Aspect
link. You can create an aspect link, place it in a graphic display and specify which
other aspect should be displayed, when the button is pressed. The other button is a
Tunnel control. Both are described thoroughly in Section A.1, Primitive Elements.
Graphic Primitives
Click on the button Graphic Primitives in the toolbox to display the set of available
primitive elements. The primitive elements provided by ABB are described in
Section A.1, Primitive Elements.
Subelements
These are subelements from the Graphics structure. Click on the
button Subelements in the toolbox to display the set of available subelements.
The subelements provided by ABB are described in Section A.4, ABB
Subelements.
Extended Primitives
These are additional primitive elements provided by ABB. Extended Primitives in
the toolbox displays these additional primitive elements.
5. Release the mouse button. The selected element now appears inside a bounding
rectangle in the workspace.
Toolbox-
Button
Open the Graphic Libraries window in the Tools menu and make your selection.
If you are creating a new graphic, you can find the same feature on Page Three of
the Graphics wizard.
The Expression Builder can be opened from the View menu. To set properties for a
certain element, it needs to be selected first.
The Expression builder is used to subscribe for and calculate data, which will be
presented in graphic aspects. Subscribe for data, is to trigger the influx of data to the
graphic aspect. A relationship between object properties and properties of generic
elements is specified.
The Expression Builder supports the use of Object property references, logical
colors and expression variables through simple click and browse operations. This
functionality combined with Visual Basic expression features make a powerful tool.
You have to browse to select logical colors, Object property references and
expression variables. They can not be written directly in the expressions. The
expression language is based on standard Visual Basic.
Top half
Bottom half
The following tabs represent different ways to sort properties of the selected
element.
The Alphabetic tab: The properties are sorted in alphabetic order, same as in
the Visual Basic properties window.
The Categorized tab: The property categories are listed as a tree structure. By
default, all categories are expanded. The available categories depend on the
properties exposed by the element.
The Assigned Tab: The properties with assigned values are displayed first.
Defined expression variables are displayed in the Edit Variables tab
The Edit variables tab: All Expression variables defined in the graphic element
are listed here.
You can also create a new expression variable via this tab. Click on the Add button,
enter the name of the new expression variable and assign the variable an expression.
3. Variables Tab
It displays the expression variables, you previously created, in the Edit
Variables tab, in the top half of the Expression Builder. To add a reference to an
expression variable to an expression, simply click on the variable you want to
add. Select Variables tab, and highlight the expression variable you want to
add, then click Insert.
Now the variable should be visible in the expression entry field in the top half of the
Expression Builder.
keyboard. With tabs we mean the three tabs: Object Property, Color and
Variables.
For more information about the syntax for expressions, see Appendix B,
Expressions.
Expressions for an element are not included when you copy it. You must enter the
same expressions for the copy.
There are logical color groups named Object Colors 3D and Event Colors 3D. These
color sets contains two variations of each color, one lighter and one darker, which
makes it possible to make and support 3D images. These color groups are used for
the same purposes as the Object and Event Color groups respectively, but for 3D
looking Faceplates.
1. Reference type drop down list, where you can choose either Absolute or
Relative reference type.
The difference between absolute and relative references
Object references in graphic aspects can be either relative or absolute.
The difference is when the aspect is copied from one object to another. If the
reference is absolute, the new aspect will show data from the same object as
before, but if the reference is relative, the aspect will always show data of the
object it resides on, or underlying objects. In the object type structure, the
only choice is relative references while it is possible to use either relative or
absolute references in the functional or location structure. See Appendix B,
Expressions for more information.
To select a graphic element and adding it to a graphic, follow the steps below.
1. Open the Element Browser in the Tools menu.
2. Populate the object list, see Section 3.7.1, Populate the Object List.
3. Select the graphic element you want to add to the graphic aspect.
4. Press the Add Element button.
You can also add elements by dragging them from Plant Explorer into the Graphic
display.
When you instantiate a graphic element, it is automatically added to the list in the
Components window and remains there even if it is deleted in Plant Explorer. Do
not try to fix a graphic display by creating a new graphic element with the same
name as the one you have deleted. It wont work. Instead, delete the graphic element
instance from the graphic display, also remove it from the components window.
Then, you create a new graphic element aspect, and let it replace the old (deleted)
graphic element instance in the graphic display.
Logical color
1. Select the m_sc object in Properties window.
2. Open Expression Builder and assign a logical color to the GeneralBackColor
property.
Note that here you select the m_sc object in Properties window but you do the
assignment in Expression Builder.
Static color
1. Select the m_sc object in Properties window.
2. Click the GeneralBackColor property.
3. Set a color from the palette which is brought up from the arrow button or type
the hex code of the color directly.
Deploying
To deploy a graphic aspect you choose Deploy from the File menu. Deploy means
the graphic aspects are saved and made viewable in the Workplace. They are now
launched for real. If a graphic aspect is not deployed, you can only see it in Graphics
Builder.
Deleting
To delete a graphic element, right-click it in Plant Explorer and choose Delete from
the context menu.
Import
You probably want to restore the graphic elements and hence preserve existing
unique identities, i.e you want the graphic display to look the same as it did. This is
accomplished via the Import or, Import All command in the Import/Export tool.
When you Browse and select an Aspect in the Import/Export tool, and drag it into a
structure in Plant Explorer, a copy of the graphic element is created with a new
unique identity. All previous references to the aspect do not work.
Import All preserves existing unique identities. The graphic display will therefore
look the same as the original. Import All imports all object and their aspects.
Import also preserves existing unique identities. The Import command imports the
selected object and owned aspects, and also any other objects below in the tree
structure.
In the Export/Import tool objects are represented with squares, aspects with circles.
There is a way to avoid confusing objects and aspects in the tree structure in the
Import/Export tool. Open the View menu, select Options and uncheck the Show
object aspects checkbox.
Export
When you export graphic aspects, i.e. create an .afw-file with the Import/Export
tool, the object that owns the aspect must be selected and dragged into the
Import/Export Archive window. In this case all aspects referenced by the object
may maintain their unique identities.
It is vital to select the object that owns the aspect, and not only the specific graphic
aspects when exporting. Selecting the object prevents the assignment of new unique
identities and in turn makes the references to graphic elements ok (in order to keep
the graphic displays intact).
When an object which contains graphic displays and graphic elements is copied, all
entities gets new unique identities. The copied elements are therefore not found by
the graphic display, which still refers to the original graphic elements.
Open the Properties window by choosing Properties Window in the View menu.
Choosing colors and fonts for a graphic element is done through color and font
dialog boxes, which you open by clicking on the "down-arrow" buttons at the far
right of the Properties window.
When exporting a graphic element to another system, the logical color relies on the
target system having the corresponding color and font definitions.
You can find more details about the Properties window in the Visual Basics On-line
Help file.
Chapter 4 Faceplates
The operator can view and control the process through faceplates. The faceplate
aspect of an Aspect Object can have three runtime views:
Reduced Faceplate, where the size and contents typically have been optimized
to cover most of the normal process operator actions. It is probably the most
frequently used view for those who prefers overlapping Faceplates.
Faceplate, which typically covers all normal process operator actions.
This runtime view is default and mandatory.
Extended Faceplate, with functions and information intended for the process
engineer or the advanced operator.
In addition to the runtime views there is also a Configuration view, which is used to
configure the three runtime views. See Section 4.4, Configuring the Faceplate for
more information.
It is not compulsory to have all Faceplate views defined for a Faceplate. The active
Faceplate view is indicated at the bottom of the Faceplates, the corresponding
view selection button is pressed in. A non-existing view leads to the corresponding
view selection button to be dimmed.
Extended Faceplate
The faceplate now appears in runtime. A picture and explanation of using the
faceplate follows.
2. Alarm control
1. Object lock
3.Indicator
4. Aspect links
5a. Bar
5b.Drag handle
6. Numeric
presentation
8. Buttons
10. Apply button
1. Object lock
Click to lock, or release the object you are currently working with. In the figure
below, the icon on the object lock button, indicates the lock status.
2. Alarm control
Indicates the alarm state and makes it possible to acknowledge alarm. The
different indications of the alarm is shown in the Table 4-2.
3. Indicator
Displays the status of the object.
4. Aspect links
Click aspect links, and different aspects of the current object will be displayed.
5. Bar
The bar displays an object property value. You can modify that value by
dragging the drag handle up or down. If you drag the handle, or simply click
the bar, the direct entry window (no.6) is opened. Another way to open the
direct entry window is to click the numeric presentation window (no.5).
6. Numeric presentation window
Displays the value of some object property.
7. Direct entry window
Open it via a click in the bar, or in the numeric presentation window. There are
several ways to modify data after the direct entry window has been opened.
Left-click on the bar and drag it up or down. The drag handle, not the
mouse position indicates the bar value.
Manually type in the value in the direct entry window.
Click the spinbuttons (up and down arrows) in the direct entry window.
This changes the value a little bit (1%)
Alarm control
Object lock
Header area
Status and navigation
bar
Faceplate element
area
Buttons
Apply button
The different views of a Faceplate can change the size or look of the Status and
Navigation bar area, the Faceplate element area and the Button area.
4.2.1 Header
The header is included in each Faceplate. It consists of the following Faceplate
areas:
Object lock
Object name
Object description
Alarm control
The object lock button is shown as sunken from the moment the user has pressed the
object lock button until the object lock is released.
You can control the object, as long as nobody else has locked it. However, if you
lock the object yourself, you are the only person allowed to control the object during
the lock period.
There is a time-out period before the object lock is released which is repeated in
case of an operator action that leads to an object mode change (for example:
switched mode from manual to auto).
If the object is locked by another person, the object lock button is flat, and the
operations, you may try to perform, will not be applied to the object.
The table below is an overview of the different states of the object lock.
Logical Color
Lock status Button Icon Name
The object name area displays the primary name of the object. A tooltip will
always show the whole name, when the cursor is positioned above the name.
This can be used when the width of the name area is not wide enough to display
the full name.
The object description area displays the description of the object, and the
tooltips works the same way as in the name area.
The alarm control indicates the alarm state and makes it possible to acknowledge
the object alarm from the faceplate. The table below is an overview of the different
states of the alarm.
2- warningSymbol
AlarmInActiveUn
Ack
3- unackActiveHighAl
AlarmActiveUnAc arm
k
4- highAlarmSymbol
AlarmAutoDisabl
ed
5 - AlarmDisabled warningSymbol
The number of indicators and aspect links allowed in the status and navigation bar is
controlled by layout settings in the Config view of the Faceplate. A default
configured Faceplate view will have space for a total sum of 6 indicators and aspect
links. Icons or labels can be used for the indicators and aspect links.
The faceplate element area in Figure 4-10 contains 2 tab groups with a total of 3
faceplate elements. They are sorted under the tabs, Control, Block and Limits.
Only 2 faceplate elements are displayed. In order to see the third, you would have to
select the Limits tab, since Block is currently the active tab in the right part of the
faceplate element area.
4.2.4 Buttons
Buttons that control properties of the object can be inserted in the button area. The
number of buttons shown per row, is dependent of the width of the view. The default
number of buttons is six.
For info how to configure the Button area see Section 4.4, Configuring the
Faceplate.
Pressing a button in the button area is a one-step action (Apply is not required,
although present by default). You can also choose to configure so the Apply button
is removed from the button area. See Section 4.4.3, Buttons Tab, for more
information.
3. Add an aspect by right-clicking in the aspect area and choose New Aspect
from the context menu. The New Aspect window is presented.
4. Select Faceplate, Faceplate, Faceplate in the aspect list.
5. Enter an aspect name and click Create. The created aspect is added to the
objects aspect list.
Right-click on the faceplate aspect and select Config view, to be able to configure.
The parameters above all deal with the size of the faceplate, number of rows,
indicators and buttons. Therefore an explanation of what size, number of rows and
so on is, has been omitted. An explanation seemed superfluous.
Table 4-4 displays the configurable parameters in the Indicators tab which affect the
Status and Navigation bar in the Faceplate.
Parameter Description
Icons/Labels The Expression and Icons/Labels
fields are connected. If the
expression is 0, Icon no. 1 is
displayed to show the outcome.
If the expression is 1, icon no. 2
is displayed, e.t.c.
See Figure 4-17 for an example.
Expression A calculation which results in an
integer value. See Section
4.4.2.1, Expression syntax in
Faceplates for more information.
Reduced pos Indicates in which position the
indicator will be displayed in the
Status and Navigation bar. 0=Not
displayed
If the value is > 0 the position is
counted from left to right with
increasing numbers. The exact
position of the faceplate depends
on No. of indicators per row., and
No. of indicator rows
Faceplate pos Same as in Reduced pos
Extended pos Same as in Reduced pos
The indicators table contains an Icons/Labels field. If you want the indicator to have
a different appearance, you can create a list of icons in the Label dialog. If the
expression for the indicator evaluates to 0, the first icon is shown, if it evaluates to
1, the second icon is shown and so on.
Example 1. To configure the first icon to be shown, if the value is below 50, and the
second icon to be shown if the value is above 50, set the expression for the indicator
to:
iif($.:VALUE < 50,0,1)
Example 2. Click in the Icons/Labels field, and a dialog box opens. Add the number
of icons and /or labels you want to use for each indicator. Each entry in the Labels
dialog is numbered from 0, 1,2 to .... N-1
The result of the configured expression must be in the same interval as the number
of Icons/Labels. A trick is to add an empty Label/icon, this can be used as default
Label/Icon, i.e. it does not show anything for this expression result.
Index 0
Index 1
Parameter Description
Aspect All aspects of the object are
displayed. Choose one.
View Select a view for the chosen
aspect.
Icon/Label Enter a label or select an icon to
be displayed on the aspect link.
Label color If you choose a label, assign a
color.
Reduced pos See same parameter in Table 4-4
for more information.
Faceplate pos See same parameter in Table 4-4
for more information.
Extended pos See same parameter in Table 4-4
for more information.
Table 4-5 displays the configurable parameters in the Aspect links tab, which affect
the right side of the Status and Navigation bar in the Faceplate.
For aspect links you can check the Use aspect icon checkbox, to get the default
aspect icon. Browsing for an icon is not needed. For the indicators, this option is not
available.
The square brackets [ ] in the syntax above indicates that aspect can be omitted
Parameter Description
Icon/Label Enter a label or select an icon
to be displayed on the button.
Label color The color of the label.
Property Select an object property to set
the value when pushing the
button.
Property type Displays the datatype of the
selected property.
Property value The value to be set when
pressing the button.
Tooltip text Text describing the button
when the mouse is on top of it.
Reduced pos See same parameter in
Section 4-4, Indicators Tab for
more information.
Faceplate pos See same parameter in
Section 4-4, Indicators Tab for
more information.
Extended pos See same parameter in
Section 4-4, Indicators Tab for
more information.
To inactivate the Apply button: If you want to hide the Apply button, go to the
Config view (of the faceplate), click the Buttons tab, and uncheck the Apply
present check box on the right side of the window. The Apply button is always
located to the right in the button area.
Parameter Description
Aspect All aspects of the object are
displayed. Choose one.
View Select a view for the chosen
aspect.
Parameter Description
Tab group Tab group identity. The
configurator can divide tabs into
tab groups. Leave this field
empty if you do not want an
extra Tab group or only want one
tab group.
Caption The name of the tab.
You can define a proxy for an Aspect Object. The proxy is a way to represent the
object in such a way that you can write to it. Define a proxy via the following steps.
1. Go to the object list via Expression Builder or Element Browser.
2. Right-click on the object to open the Context Menu.
3. Select Properties from the Context Menu.
4. The object reference dialog opens.
5. Enter an object proxy name.
Enter an object proxy name. (m_Object is the default proxy name for the
invocation object. This holds true for faceplate elements created in the
faceplate element category.)
The following example statement:
Let m_Object (Control Connection:Hi_limit) = 3.14
writes the value 3.14 to the property Hi_limit defined by the Control
Connection aspect, on the object, represented by the object proxy
m_Object. For information on error handling, go to Section 4.5.3, Visual Basic
Error Handling.
Set Displacement to position the direct entry window. The window positions
itself to the right of the Bar when the Bar is in a vertical orientation, and below
in a horizontal orientation. The distance from the Bar border in pixels is set by
the Displacement property.
Implement the MouseDown event from the Bar like this:
Holding the shift key down while pressing up/down arrow keys also
increases/decreases the value by 10 times the normal step value, while holding
down the control (ctrl) key increases the value by a 10th of the normal step value.
In the default case, i.e. when the direct entry window is created by the Numeric or
Bar primitive elements or using the Bar sub element, the normal step size is set to
1% of the MinValue, MaxValue interval (RangeMax - RangeMin for the Bar sub
element).
In the default case, it is not possible to increase/decrease the value outside the
MinValue, MaxValue interval. If this is not desired, it is possible to change this
behavior. By implementing the XXX_OnMouseDown code, according to the
following that effect is achieved:
The step is Normal, which means that the value change for each
step is 1% of the Max-Min range.
Use the up and down arrow keys on the keyboard.
The step is Normal, which means that the value change for each
step is 1% of the Max-Min range.
Use the Page Up and Page Down keys on the keyboard.
The step is 10*Normal.
Methods Description
Init([in] IUnknown* Hdlr) Register the faceplate element in the current
faceplate.
This gives the faceplate a connection to the
faceplate elements within the faceplate.
The faceplate is able to handle the
communication between the elements.
If the faceplate element is used outside the
faceplate, it communicates with itself.
StartSession() Starts an interaction. It is not possible to start
several sessions.
For multiple sessions, do not call this method
more then once.
EnableApplyButton(bool flag) Enables or disables apply. When calling this
method, all faceplate elements registered on the
faceplate, receive an event
DoEnableApplyButton(Bool flag) see description
below.
In the faceplate the apply button shows the state
enable or disable.
RequestApply() Requests apply.
The registered faceplate elements receive the
event DoApply(), see description below.
RequestCancel() Requests cancel.
The faceplate registered elements get the event
DoCancel(), see description below.
Methods Description
SendMessage(BSTR name, A broadcast method which enables the possibility
Variant data to send data to the other registered faceplate
elements, whom receive a callback
ReciveMessage(BSTR name,Variant data),
see description below.
TriggerTimeout() Triggers the timeout.
A session does not live forever. If it has been
inactive for three minutes, the timeout strikes and
the session is cancelled. Trigger the timeout
whenever you want the session to remain.
The faceplate elements receive the following events when a faceplate element
connected to the same faceplate or the faceplate element it self calls any of the
method described above.
Events Description
DoApply() Do apply.This event is received
when the operator makes apply
by clicking the apply button in
the faceplate.
when another faceplate element
connected to the same
faceplate or the faceplate
element itself requests apply.
when the operator press enter in
the Direct Entry Window.
To receive the event the faceplate
element must call the method
EnableApplyButton(flag) when there
is a value to apply otherwise no
events is fired.
DoCancel () Do cancel.This event is received
when another faceplate element
connected to the same faceplate or
the faceplate element itself requests
cancel.when the operator press
ESC in the Direct Entry Window.To
receive the event the faceplate
element must have a session started.
A session starts with the method call
StartSession().
DoRecieveMessage(BSTR name, A message is received.This event is
Variant data); received when another faceplate
element connected to the same
faceplate wants to broadcast a
message.It is up to the faceplate
element to translate the message.
Tutorial
Follow the steps to learn about session handling.
1. A good start to learn more about how to use the session handler is to create a
faceplate element.
2. Add a graphic primitive supporting the Direct Entry Window for example the
Bar.
3. In the faceplate element code, there are comments telling you where to call
methods on the PgSessionHdlr. Add that code.
4. Create a faceplate aspect.
5. Configure the faceplate, and add the created faceplate element.
6. Use the faceplate, and see how the different components, the Direct Entry
Window, the faceplate element, and the faceplate interact.
Chapter 5 Maintenance
Syntax error
I get the message syntax error, when deploying a graphic element. What is wrong?
Its probably a compile error.
Press Ctrl + F5, a box appears, select Cancel.
The compilation error is displayed.
Chapter 6 Tutorial
Below follows a description of how to build, test, save, deploy and use new graphic
elements and faceplates.
The tutorial consists of the following sections:
In this tutorial you will build a Graphic Display. It contains 2 storage tanks and bars
to indicate the level in the tanks. The tanks are connected via a pipe and there is a
valve on the pipe. A rectangle at the bottom turns red when fluid passes
through the valve. This is measured by the AO1.14 which must have a value above
0 for the rectangle to turn red.
It is a good idea to look at Figure 3-8 Expression Builder. The figure clarifies names
and areas within Expression Builder which are a prerequisite for understanding this
tutorial.
5. Go to Tools menu, Graphic libraries and check all the alternatives in the list.
Create the tanks and modify the pipe.
6. Select Graphic Primitives tab and then the AdvantCone tool from the
toolbox. Press the left mouse button and drag the mouse to the size of choice,
then release the left mouse button.
7. Build the pipe in between the tanks with the AdvantPipe tool in the toolbox.
8. Change the AdvantPipe ends to make it look like a proper connection between
them. Select Properties window in the View menu.
9. Change BottomRightEnd, TopLeftEnd, or Orientation, to get the desired look.
Add two arrows to show direction of the flow between the tanks. Select the
Extended Primitives tab and use the AdvantArrow tool. Place the arrows on the
pipe.
12. The BargraphMV01 for the AO1.12 value is now inserted in the middle of the
workspace. Drag it to the Lower tank.
13. Repeat the steps (11-13), which we just did on the lower tank, but select
AO1.13 under the Upper tank instead. Press OK.
14. Add the Valve via the Element Browser. Select the graphic element Valve01 in
the right list, and press Add Element.
So far we have the valve, the tanks and their levels.
15. Click on the Graphic Primitives tab, select the AdvantRectangle tool. Place
it below the tanks.
Assign Expressions to properties
It is now time to assign expressions to properties. This is done with the combination
of inserting references and typing in the Expression entry field.
16. Mark the rectangle in the workspace area. Open Expression Builder in the
View menu. Select the FillColor property, in the top half of the Expression
Builder.
The expression we will build will eventually look like this:
iif(AO1.14:Control Connection:VALUE > 0, unackHighAlarm,
GeneralBackColor)
17. Type iif(
18. Select the Object property tab in the lower half of the Expression Builder.
Select the object AO1.14 and select Value in the subproperty list.
19. Double-click Value - Control Connection from the Object Property list to
insert the reference to AO1.14:Control Connection:Value.
Note that the above reference can not be typed in, it must be inserted from the
bottom part of the Expression Builder.
22. Select the FrameColor property. Click the drop down menu with the color
groups, choose Process graphics color, then double-click GeneralBackColor.
23. Repeat step 22, but do it on the LineColor and FrameColor property instead.
The Expression Builder now looks like this.
Hopefully you have accomplished a similar result as in Figure 6-2. shown in the
beginning of this tutorial.
To set the expression for FillColor as seen in Figure 6-11, see the example in
Section 6.1.3, Using Logical Colors.
Value is set with the same method, first select the relative object and property
VALUE and press Insert, then input the multiplication expression * 3.14 on the
keyboard.
The Deploy function makes it possible to view the graphic element in the
Workplace window, it also saves the graphic element automatically. If a graphic
element is not deployed, you can only see it in Graphics Builder (you can not add
instances in other graphics).
2. Save and deploy the graphic display.
3. Exit Graphics Builder.
The faceplate will contain a command button which sets the bar value to 30, when
clicked upon.It will also contain two buttons T and F. Select T and a smiley
icon will appear in the indicator field. Select F and an F will appear in the indicator
field. The faceplate also includes an aspect link, which when clicked upon open up
the configuration window of the General Property aspect we use for the test.
Indicator
Aspect link
Bar
Command button
T and F buttons
Button Outcome
Now that we have a value for the bar, we will create a Faceplate element.
Creating a Faceplate Element
1. Mark the object where the Faceplate should reside. Right-click and select New
Aspect.
2. Go to Process Graphics, select Graphic Element, then Faceplate Element.
6. Go to the Tools menu, select Graphic Libraries and mark Subelements, click
ok.
For information about using faceplates in runtime, from the operators perspective,
see Section 4.1, Using Faceplates in Runtime.
You build graphics by using building blocks: Generic elements is a common name
for Primitives, Subelements, standard Visual Basic components and third party
ActiveX controls. More information regarding generic elements can be found in
Section 3.5, Working with Generic Elements.
A.1.1 Arc
An Arc is a simple primitive element displaying a part of an ellipse.
After creation the bounding rectangle can be manipulated to change size and
position of the Arc.
The properties of the primitive element Arc are:
Line Properties
Angle Properties.
A.1.2 Bar
A Bar has the ability to show a vertically or a horizontally placed bargraph symbol.
After creation the bounding rectangle can be manipulated to change size and
position of the Bar.
Events Description
OnMouseDown The mouse is clicked.
OnMouseUp The mouse button is released.
OnMouseMove The mouse is moved
Event signatures
A.1.3 Bezier
A Bezier is like a polyline where the connecting lines are formed using the bezier
algorithm instead of straight lines.
Each point of a bezier curve is controlled by the point itself and two gravity
points, which control the shape of the curve. The endpoints have only one gravity
point.
After creation the bounding rectangle can be manipulated to change size and
position of the Bezier. See Section A.3.7, Point Properties for manipulating single
points. Gravity points are moved in the same way as other points.
The property of the primitive element Bezier is Line Properties.
A.1.4 Chord
A Chord draws a chord (a closed figure bounded by the intersection of an ellipse
and a line segment).
After creation the bounding rectangle can be manipulated to change size and
position of the Chord.
The properties of the primitive element Chord are:
Line Properties
Fill Properties
Angle Properties.
A.1.5 Cone
The Cone primitive draws a cone consisting of four vertices connected by straight
lines.
The cone can be any color, any line width, many different line styles, solid area fill,
hatched area fill or shaded area fill.
After creation the bounding rectangle can be manipulated to change size and
position of the Cone.
When using any of the shaded fill styles, the fill style will follow the direction of the cone.
A.1.6 Ellipse
An Ellipse can draw an ellipse with a frame and area fill.
After creation the bounding rectangle can be manipulated to change size and
position of the Ellipse.
The properties of the primitive element Ellipse are:
Line Properties
Fill Properties
A.1.7 Hscale
An Hscale has the ability to show a horizontally placed scale. The scale can contain
labels as well as minor and major tics.
0.0 100.0
After creation the bounding rectangle can be manipulated to change size and
position of the Hscale.
A.1.8 Limit
A Limit has the ability to show a vertically or horizontally placed limit symbol.
UP
DOWN
LEFT
RIGHT
After creation the bounding rectangle can be manipulated to change size and
position of the Limit.
A.1.9 Numeric
A Numeric has ability to show a number as a formatted text.
* DisplacementY
Numeric
*DisplacementY DisplacementX
Events Description
OnMouseDown The mouse is clicked.
OnMouseUp The mouse button is released.
OnMouseMove The mouse is moved
Event signatures
A.1.10 ObjectTrim
An ObjectTrim has the ability to show up to four trim curves. The trim curve shows
the most current 120 samples of the input, the CurveNValue property. The sample
time is determined by the SampleTime property.
The trim curve is drawn in the color set in the CurveNColor property.
The background of the trim area is determined by the Fill properties.
After creation the bounding rectangle can be manipulated to change size and
position of the ObjectTrim
A.1.11 Pie
The Pie draws a pie slice (a closed figure bounded by the intersection of an ellipse
and line segments towards the center of the ellipse).
After creation the bounding rectangle can be manipulated to change size and
position of the Pie.
The properties of the primitive element Pie are:
Line Properties
Fill Properties
Angle Properties.
A.1.12 Pipe
The Pipe draws a pipe with area fill.
The pipe can be any color, any line width, a number of different line styles, solid
area fill, hatched area fill and shaded area fill. The pipe can be cut 45 degrees in one
or both ends. Pipe elements can be combined as shown above.
After creation the bounding rectangle can be manipulated to change size and
position of the Pipe.
When using any of the shaded fill styles, the fill style will follow the orientation of the pipe.
A.1.13 Polygon
A Polygon is a closed figure bounded by a line through a number of points.
After creation the bounding rectangle can be manipulated to change size and
position of the Polygon. See Section A.3.7, Point Properties for manipulation of
single points.
The properties of the primitive element Polygon are:
Line Properties
Fill Properties
Smooth
A.1.14 Polyline
A Polyline draws a line between a number of points.
After creation the bounding rectangle can be manipulated to change size and
position of the Polyline. See Section A.3.7, Point Properties for manipulating single
points.
The properties of the primitive element Polyline are:
Line Properties
Smooth
A.1.15 Rectangle
A Rectangle can draw a rectangle with a frame and an area fill.
The frame can be any color, any line width, a number of different line styles, solid
area fill, hatched area fill and shaded area fill. The corners of the rectangle can be
sharp (90 degrees) or rounded.
After creation the bounding rectangle can be manipulated to change size and
position of the Rectangle.
A.1.16 Text
A Text has the ability to show a static text.
The Comment/Tooltip is used in a special way in the primitive element Text. If the
Text STRING extends the available draw area, the font will be changed to a
strikethrough font and the tooltip presented will be the full text. If the Text STRING
can be drawn in the draw area, the Comment is usually presented as a tooltip.
After creation the bounding rectangle can be manipulated to change size and
position of the Text.
A.1.17 Vscale
A Vscale has the ability to show a vertically placed scale. The scale can contain
labels as well as minor and major tics.
100.0
0.0
After creation the bounding rectangle can be manipulated to change size and
position of the Vscale.
The table contains custom made properties, plus a few of the most useful properties
for a standard command button.
Label1.Click(..)
If Button=VBLeftButton Then
m_inputMgmt.ShowDefaultAspect Me
Else If
m_imputMgmt.ShowContextMenu Me
End If
End Sub
Fill properties applies to the primitive elements Arc, Bezier, Chord, Cone,
Ellipse, Hscale, Limit, ObjectTrim, Pie, Pipe, Polygon, Polyline, Rectangle and
Vscale.
1 DASH
2 DOT
3 DASHDOT
4 DASHDOTDOT
Remark: Solid lines can be any width. Any other style uses a line width of 1 no
matter of the value in LineWidth.
Fill properties applies to the primitive elements Chord, Limit, Pie and Polygon.
1 TRANSPARENT
2 BDIAGONAL
3 CROSS
4 DIACROSS
5 FDIAGONAL
7 VERTICAL
Fill properties with shade applies to the primitive elements, Cone, Ellipse,
Numeric, Pipe, Rectangle, Text and ObjectTrim.
1 TRANSPARENT
2 BDIAGONAL
3 CROSS
4 DIACROSS
5 FDIAGONAL
7 VERTICAL
8 VERTICAL
SHADE
9 HORIZONTAL
SHADE
10 VERTICAL
3DSHADE
11 HORIZONTAL
3DSHADE
A.3.4.1 3D Effect
The 3D effect of the frame can be RAISED or SUNKEN. If set to RAISED
FrameColor is used for the left-top part. FrameColor2 is used for the bottom-right
part. If set to SUNKEN the colors will be swapped.
RAISED SUNKEN
A.3.5 Smooth
Smooth is defined in the range 0..100. When Smooth is set > 0, the function
includes as many (visible) points as specified, between the original points. Then the
bezier algorithm shapes each straight line into an arc instead.
Smooth applies to the primitive elements Polygon and Polyline.
The angles can be changed either by holding down the right mouse button while
dragging the handles (the cursor changes to AllsizeArrow when moved by a handle)
or by entering the desired values in the StartAngle and StopAngle properties.
Angle properties applies to the primitive elements Arc, Chord and Pie.
A.4.1 Bar
A Bar has the ability to show a bar with two hatched limit areas or four limit
markers.
After creation the bounding rectangle can be manipulated to change size and
position of the Bar.
Events Description
OnMouseDown The mouse is clicked.
OnMouseUp The mouse button is released.
OnMouseMove The mouse is moved
Event signatures
Private Sub Bar1_OnMouseDown(
ByVal button As Long,
ByVal shift As Long,
ByVal xown As Single,
ByVal yown As Single,
ByVal xcontainer As Single,
ByVal ycontainer As Single,
ByVal autoDew As Object)
HighLimit2
HighLimit1
?
Value
LowLimit1
LowLimit2
FourLimits
The height of the limits is 1/11 of the subelement height. The height of the bar area
(bar without frame) is 10/11 of the element height. The vertical edges of the bar area
is placed on the center of the limit headers. The FrameWidth cannot exceed 1/2 of
the width of a limit header.
TwoLimits
The bar is resized to fit the subelement. The limits are sized to fit the bar area. The
lower edge of the upper limit area is determined by HighLimit1. The upper edge of
the lower limit area is determined by LowLimit1.
The properties below are set to the given value in accordance with the chosen Style.
HighLimit2Color Grey
HighLimit2Visible True
HighLimit1 75 75
HighLimit1Fill Transparent Transparent
HighLimit1Color Grey Grey
HighLimit1Visible True True
LowLimit1 25 25
LowLimit1Fill Transparent Transparent
LowLimit1Color Grey Grey
LowLimit1Visible True True
LowLimit2 15
LowLimit2Fill Transparent
LowLimit2Color Grey
LowLimit2Visible True
Appendix B Expressions
B.1 Introduction
Expressions are used for performing two tasks:
Specify subscriptions
Specify a relationship between process data and data to be displayed.
The expression syntax is based on standard Visual Basic. However, some additions
are made to easily set up a subscription.
Expressions are defined within graphic elements using the Expression Builder.
Expressions refer to object properties to be presented, and performs calculations on
data before being presented.
Input data for an expression can be properties of process objects, logical colors or
expression variables.
The execution of an expression takes place automatically when any input data to the
expression changes. The execution takes place for following reasons:
Initially when the graphic element is presented. The initial execution
handles constant values applied to input properties of the graphic
element.
When data is delivered from the OPC server.
Blink
Logical colors change
B.2 Expressions
Expressions are entered via a combination of the following.
The expressions are entered with the keyboard
References in expressions are handled via tabs and navigation in the lower half
of the Expression Builder.
Expressions are assigned to properties of contained generic elements.
Expressions refer to three entities
Object properties, commonly called Dynamic data.
Logical colors, assigned in the Expression Builder (see Section 3.6, Expression
Builder)
Expression variables, assigned in the Expression Builder (see Section 3.6.2,
The bottom half of the Expression Builder
The extensions of Visual Basic expression syntax is that object property
references can be used in an expression at any point where Visual Basic allows a
variable to be used.
The following are legal expressions:
The first expression has explanatory text below it.
1.
AI.117:Control Connection:VALUE*14.2
This expression means that the VALUE property of object AI.117 multiplied with
14.2 drives the property to which this expression is applied.
2.
iif(.:Control Connection:UNIT.QualityBad, highAlarmText,
text2Normal)
3.
iif(.:Control Connection:ALARM_BLK, blockedSymbol,
iif(.:Control Connection:ABOVE_HI_LIM2, highAlarmSymbol,
measure ))
References to object properties must be added via the Object list.
Logical colors and expression variables assigned in the Expression Builder do not
function in Faceplates.
(m_sc.EnableBlink=) .:IsAlarm)
B.6.1 Event
The subscription control generates the events described in Table B-1.
Event Description
B.6.2 Property
Table B-2. Properties of subscription control
Property Description
B.6.3 Method
Table B-3. Methods of subscription control
Property Description
Attributes Description
Value The value for the object
property is returned.
Initialized False until first data received
from OPC.
Attributes Description
QualityBad True when it is determined
that data really is bad.
QualityBad is false while
waiting for first update.
QualityCode Returns the raw quality value
received from OPC
TimeStamp Timestamp.
FloatClass If property entails a floating
point value, the result = 0.
Element.Visible = .:Status.QualityOk
RedXXXX.Visible = .:Status.QualityBad
Red Xs should not be presented until it is really known that good data will not be
received.
Handling bad data, method 2
Another method to handle bad quality is based on following:
Values of object properties are delivered as Variants to expressions. When
QualityOk of an object property is not true, its value is set to vtEmpty
Expressions evaluate to vtEmpty when any variable used by the expression has
a vtEmpty value. As expression variables are defined as Variants vtEmpty are
assigned to those
Expressions can use IsEmpty to test expression variable values
Height Width
Pixels 220 250
Twips 3300 3750
Height Width
Pixels 400 250
Table C-3.
C.3.1.1 Header
The header has a fixed height of 46 pixels and a non-fixed width, that must be at
least 88 pixels wide.
C.3.1.3 Element
The Faceplate Element varies in size. The faceplate element uses the left over space
in the faceplate. If you want to preserve the aspect ratio and if you want to keep the
font size and so on it is recommended that you calculate the faceplate element
height and width using this document.
Tab rows
If you are using tabs in any form (happens if you have configured more than one
faceplate element in a faceplate view) each tab row takes 24pixels in height. More
than one tab group does not take any more space (except if you configure them
vertically, thus adding more pixels on tab heights).
C.3.2 Example
Assume that you want to design both a reduced Faceplate and a normal Faceplate.
The different views should contain these component parts:
Reduced Normal
Component
Height Width Height Width
Header 46 - 46 -
Status and 0 0 87 208
Navigation
Buttons 46 167 87 249
Sum 92 167 220 250
Element 58 167 180 250
The element size available is calculated as the space left between the sum of all
other components and the total space in the view
It is possible to create your own aspect categories with templates. This way you can
configure for example background color, you can add a bar or change the size.
The Graphic Display aspect type now contains your aspect category, in this case
Loram Display.
4. Right-click Loram Display, and select New Aspect in the dropdown menu.
5. Navigate to your new aspect category, Process Graphics, Graphic Display,
Loram Display. Click the Create button at the bottom of the dialog
The template from the aspect type, is now copied to your new category.
6. Click Loram Display, in the aspect window, on the right side of Plant
Explorer.
7. Select the Edit button, to open your new aspect category template.
8. Configure the template, change background color, or size. You can even create
cones or bars to be a part of the template.
9. Once the template is configured, simply Select Save in the File menu.
10. Close the Graphics Builder.
11. Go to the aspect window, on the right side of Plant Explorer. Right-click
Loram Display and select Properties in the dropdown menu.
12. In the dialog, Select Aspect Details and click Add. Select Template Aspect
and click OK in the dropdown menu that appears.
13. You are now back in Dialog, click Apply and OK.
Now you have created your own aspect category.
Properties field
A list of all members that have been added to the graphic element. You can only see
the member(s) you are currently working with.
Add Member button
Press Add Member to present the Add Member dialog box, where you enter a
name and select the type (Property, Method or Event).
Do not try to add two or more members with the same name. Doing so will cause a
deploy failure.
Member Types
Property is a named attribute of an object. Properties define object
characteristics, such as size and name, or state of an object, such as enabled or
disabled. Properties are visible in the Expressions and Properties windows.
Method is a built-in routine attached directly to an ActiveX control. It can be
called from a user of graphic elements.
Event is an action, recognized by an object, for which a user of graphic
elements can write code to respond to you. Events can be generated by a user
action (such as clicking the mouse or pressing a key), by program code, or by
the system, as with timers.
Delete Member button
Select a member and click Delete Member to remove it from the list.
Attribute Information fields
Attribute Information fields in the Add Members window: Data Type, Default
Value, Run Time, Design Time and Arguments.
Data Type
Select one of the available data types: Boolean, Color, Date, Double, Font,
Integer, Long, Picture, Single, String or Variant in this field. You can find more
details about the different data types in Visual Basics On-line Help file.
Default Value
Enter a default value in this field. The value type depends on the selected data
type.
Run Time
Select one of the available alternatives (Read, Read/Write, Write) which
decides how the property will act at run time.
Design Time
Select one of the available alternatives (Read, Read/Write, Write) which
decides how the property will act at design time.
Arguments
This information field is only available when you select Method as the member
type. Enter an argument in this field. The argument must follow the Visual
Basic syntax.
INDEX
A Differences 17
Absolute, relative reference Direct entry window 77 to 78
difference 37 DoApply 83
ActiveX 86 DoCancel 83
ActiveX controls DoRecieveMessage 83
add external activeX controls 26
adding 26 E
Add member Element browser
member types 175 add graphic elements 40
Add member window 173 select graphic elements 40
Adding EnableApplyButton 81
external ActiveX controls 26 Event tunnel control 134
Graphic libraries 24 Export aspects 49
methods and events 176 Expression Builder
Apect link 22 bottom half 30
Aspect categories 17 Expression builder 26
Autopopulate 39 top half 28
Autopupulate the object list 39 Expressions 153
assign expressions to properties 33
B Extended faceplate 51
Background color 42
Background color set 43 F
Building faceplate elements 76 Faceplate 51
aspect links 56
C building elements 76
Color button area 63
background 42 configuration overview 58
Configuration of Label/Icons 71 direct entry window 56
Container color 42 element area 62
Expression syntax 72, 156
D extended 51
Debug 20 header area 59
Deleting inactivate apply button 74
graphic aspects 47 indicator 56
Deploy 100 object lock 56
Deploying reduced 51
graphic aspects 47 session handling tutorial 84
P Syntax error 85
Populate
object list 38 T
Precautions when copying aspects 49 Test Mode 99
Precautions when importing/exporting aspects 47 Test mode 46
Preparations Testing
installation 11 graphic elements 45
Primitive element 21 the 25
Product verification 11 Toolbox
Properties window 49 adding graphic libraries 24
Property 156 adding tools 24
deleting tools 25
R Toolbox buttons
Read properties 76 aspect link 22
Reduced faceplate 51 extended primitives 23
RequestApply 81 general 22
RequestCancel 81 graphic primitives 22
subelements 23
S TriggerTimeout 82
Saving Tunnel control 22
graphic elements 47 Tutorial 87
SendMessage 82 add graphic elements 91
Set background color 43 assigning expressions to properties 98
Sizes and scaling of faceplates building a graphic display 88
buttons 167 building a graphic element 93, 96
default component sizes 166 changing properties for generic element 97
default faceplate 165 changing properties for the graphic element 97
default faceplate element 165, 171 configuring a faceplate 106
element sizing 168 create an aspect link 107
navigation bar 167 create an indicator 106
size of header 167 creating a faceplate element 102
status bar 167 creating a graphic element 94
Sizes of faceplates creating and configuring faceplates 100
tab rows 168 Deploying a graphic element 100
StartSession 81 deploying a graphic element 100
Static color 42 design mode 100
Status and navigation bar 62 logical colors 92
Subelement 17 testing the graphic element 99
Subelements 21, 23 Tutorial.create a button 105
Subscription control 45
U
Update rate 45
V
Visual Basic error handling 80
W
Write property 76