Sunteți pe pagina 1din 192

OperateIT Graphics

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.

Copyright ABB Automation Products AB 2001

3BSE 017 091R301


OperateIT Graphics Users Guide
Table of Contents

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

Chapter 3 - How to Work with the Graphics Builder


3.0.1 Graphics Builder ................................................................................. 14
3.0.2 Features ............................................................................................... 15
3.1 Create a New Graphic Aspect.............................................................................. 16
3.1.1 Differences between Graphic Aspect Categories ............................... 17
3.2 Starting Graphics Builder .................................................................................... 18
3.3 Switch Graphic Aspect in a Running Graphics Builder ...................................... 18
3.4 Setting Options in Graphics Builder .................................................................... 18
3.5 Working with Generic Elements.......................................................................... 20
3.5.1 Toolbox Window................................................................................. 21
3.5.2 Select Generic Elements from the Toolbox ........................................ 23
3.5.3 Adding Graphic Libraries to the Toolbox ........................................... 24
3.5.4 External ActiveX Controls.................................................................. 25

3BSE 017 091R301 i


OperateIT Graphics Users Guide
Table of Contents

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

ii 3BSE 017 091R301


OperateIT Graphics Users Guide
Table of Contents

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

3BSE 017 091R301 iii


OperateIT Graphics Users Guide
Table of Contents

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

Appendix A - Standard Building Blocks


A.1 Primitive Elements............................................................................................. 109
A.1.1 Arc .................................................................................................... 109
A.1.2 Bar..................................................................................................... 110
A.1.3 Bezier ................................................................................................ 113
A.1.4 Chord ................................................................................................ 114
A.1.5 Cone .................................................................................................. 115
A.1.6 Ellipse ............................................................................................... 116
A.1.7 Hscale................................................................................................ 117
A.1.8 Limit.................................................................................................. 118
A.1.9 Numeric ............................................................................................ 119
A.1.10 ObjectTrim ........................................................................................ 123
A.1.11 Pie ..................................................................................................... 125
A.1.12 Pipe ................................................................................................... 126
A.1.13 Polygon ............................................................................................. 127
A.1.14 Polyline ............................................................................................. 128
A.1.15 Rectangle .......................................................................................... 129
A.1.16 Text ................................................................................................... 130
A.1.17 Vscale................................................................................................ 131
A.1.18 Aspect Link....................................................................................... 133
A.2 Event Tunnel Control......................................................................................... 134
A.3 Primitive Element Properties ............................................................................. 135
A.3.1 Line Properties .................................................................................. 136
A.3.1.1 Line Styles.................................................................. 136

iv 3BSE 017 091R301


OperateIT Graphics Users Guide
Table of Contents

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

3BSE 017 091R301 v


OperateIT Graphics Users Guide
Table of Contents

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

Appendix D - Create New Aspect Categories with Templates


D.1 Create a New Aspect Category .......................................................................... 171

Appendix E - Adding Members


E.1 Add Member Window ....................................................................................... 173
E.2 Adding Methods/Events .................................................................................... 176
E.3 Adding Properties .............................................................................................. 176

vi 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 1.1 About This Book

Chapter 1 Introduction

1.1 About This Book


For a quick hands-on start on OperateIT Graphics, go to Chapter 6, Tutorial.
OperateIT Graphics is often referred to as Process Graphics.
This book is intended for those who configure and use graphic aspects (graphic
elements, graphic displays and faceplates). It also includes information about the
basic building blocks provided by ABB.
It is assumed that you are familiar with the concept of Aspect Objects, Aspects,
Structures etc. before you start using this book.
Information about the necessary preparations are described in OperateIT Plant
Engineering Methods Reference Manual.
This book is not the only source of instruction for OperateIT Graphics. ABB also
offers training courses for those who use Graphics.

Use of Warning, Caution, Information, and Tip


This publication includes Warning, Caution, and Information where appropriate
to point out safety related or other important information. It also includes Tip to
point out useful hints to the reader. The corresponding symbols should be
interpreted as follows:

Warning indicates the presence of a hazard which could result in personal injury.

Caution indicates the presence of a hazard which could result in equipment or


property damage.

Information alerts the reader to pertinent facts and conditions.

3BSE 017 091R301 1


OperateIT Graphics Users Guide
Chapter 1 Introduction

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.

1.1.1 How to Use This Book


The main parts of this book are:

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.

Building Graphic Elements, and Graphic Displays


Refer to Chapter 3, How to Work with the Graphics Builder, to learn what you need
to do in Graphics Builder, to build graphic elements and graphic displays.

Faceplates
Refer to Chapter 4, Faceplates to learn more about how to configure faceplates.

Basic Building Blocks Provided by ABB


Refer to Appendix A, Standard Building Blocks to learn more about the graphics
provided by ABB. The Primitives (primitive elements) and Subelements included in
this appendix are those supplied by ABB at delivery.

2 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 1.2 Product Overview

Assigning and Building Expressions


Refer to Section 3.6, Expression Builder, and Appendix B, Expressions to learn
more about expressions and how you use them.

Sizes and Scaling of Faceplates


Refer to Appendix C, Sizes of Faceplates to learn more about Faceplates.

1.2 Product Overview


Process Graphics consists of a graphic run-time viewer included in the OperateIT
Product. It also includes the software option Graphics Builder which is based on
Microsoft Visual Basic.
For a description of the OperateIT product, refer to the OperateIT Product Guide.

1.2.1 What You Can Do with OperateIT Graphics


You can do the following with Graphics:
Build graphic elements
Configure faceplates
Configure graphic displays
View graphics
Use faceplates for information and control

You can also find the following information in this book:


A tutorial
Detailed information about the basic building blocks provided by ABB
Examples of how to use expressions

3BSE 017 091R301 3


OperateIT Graphics Users Guide
Chapter 1 Introduction

1.3 Prerequisites and Requirements


OperateIT Graphics runs on the Microsoft Windows 2000 operating system.
All hardware and software requirements are listed in OperateIT Product Guide.
It is required that you are familiar with the graphical user interface of Microsoft
Windows 2000. You should also a have general knowledge of common terms such
as menus, buttons, drag/drop etc. It is also useful if you are familiar with Microsoft
Visual Basic since Graphics Builder works in conjunction with it.

1.4 Related Documentation


Table 1-1 lists all documentation related to Graphics.

Table 1-1. Related Documentation

Category Title Description


Installation OperateIT Installation Guide This book describes how you install the
OperateIT including the requirements on
the hardware.
System OperateIT Administrators Guide This book describes how you configure
Administration the OperateIT and how you then perform
maintenance.

4 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 1.5 Conventions

Table 1-1. Related Documentation (Continued)

Category Title Description


Software OperateIT Workplace and Plant Explorer This book describes everything about
Users Guide the user interface, for example how you
present information, navigate and
control objects.
OperateIT Alarm and Event Manager This book explains how to use the
Users Guide OperateIT Alarm and Event functions. It
covers alarm and event configuration
and presentation.
OperateIT Trends and Historian This book describes how to use the
Users Guide trend graphs and historian to view
historical data during runtime.
OperateIT Operators Guide This book is an extract from all other
guides, and describes a number of
selected operator scenarios.
OperateIT Plant Engineering Methods This book is intended as a guide for
Reference Manual plant engineering using OperateIT.
Other OperateIT Product Guide This book is a presentation of the
software and software options in
OperateIT Products. It also includes
hardware and software requirements
and specifications.

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.

3BSE 017 091R301 5


OperateIT Graphics Users Guide
Chapter 1 Introduction

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

6 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 1.6 Terminology

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.

3BSE 017 091R301 7


OperateIT Graphics Users Guide
Chapter 1 Introduction

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.

8 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 1.6 Terminology

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.

3BSE 017 091R301 9


OperateIT Graphics Users Guide
Chapter 1 Introduction

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.

10 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 2.1 Product Verification

Chapter 2 Installation

The OperateIT Graphics software, including OperateIT Graphics Builder, symbol


libraries, additional ActiveX libraries and other options, is installed according to the
instructions in the OperateIT Installation Guide.

2.1 Product Verification


To get information regarding the installed software, select
About Graphics Builder in the Help menu. This displays an information box with
information regarding version, licensing, and so on.

2.2 Third Party Products


If you want to build your own animated graphics or import and filter photos, which
are all useful additions to graphic elements/process displays, there are several third
party products that can be used. We recommend Paint Shop Pro from JASC. Please
look at http://www.jasc.com. There is a trial license for 30 days.

3BSE 017 091R301 11


OperateIT Graphics Users Guide
Chapter 2 Installation

12 3BSE 017 091R301


OperateIT Graphics Users Guide

Chapter 3 How to Work with the Graphics Builder

Graphics Builder is a tool which enables configuration of graphic aspects, e.g.


graphic displays, graphic elements and faceplate elements. It is a tool built on Visual
Basic.
This section gives you a description of the tools added to standard Visual Basic.
Graphics Builder provides several powerful features for configuring graphic
aspects, and writing expressions.
Even though the Visual Basic environment is a full fledged programming
environment, the configurator of graphic displays of graphic elements is not
required to be programmers or have a Visual Basic background.
Graphics Builder allows the full power of Visual Basic if needed. The Visual Basic
code panes are available and the environment is accessible.

3BSE 017 091R301 13


OperateIT Graphics Users Guide
Chapter 3 How to Work with the Graphics Builder

3.0.1 Graphics Builder


This is what Graphics Builder looks like.

Toolbox Workspace Properties window

Figure 3-1. Graphics Builder

14 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 3.0.2 Features

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.

3BSE 017 091R301 15


OperateIT Graphics Users Guide
Chapter 3 How to Work with the Graphics Builder

3.1 Create a New Graphic Aspect


Below follows a description of how to create a graphic aspect using Plant Explorer.
The example is a graphic element but could have been a Faceplate element,
Subelement or Graphic Display.
1. Select the Object type structure in the Plant Explorer.
2. Select an Object.
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 Process Graphics, Graphic Element, Graphic Element in the aspect
list.

Figure 3-2. New Aspect Window

5. Enter an aspect name and click Create. The created aspect is added to the
objects aspect list.

16 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 3.1.1 Differences between Graphic Aspect Categories

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.

3.1.1 Differences between Graphic Aspect Categories


This section contains some facts, and a comparison between the most common
graphic aspect categories.

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.

3BSE 017 091R301 17


OperateIT Graphics Users Guide
Chapter 3 How to Work with the Graphics Builder

3.2 Starting Graphics Builder


There are a few different ways to start Graphics Builder
Right-click on a graphic aspect, select Edit.
Click the Edit button which is displayed when aspects have not been edited
previously.
Right-click on a graphic background in an actual runtime view, and select Edit.

3.3 Switch Graphic Aspect in a Running Graphics Builder


Below follows a description of how to switch to another graphic aspect, when you
start from Graphics Builder.
1. Choose Open Aspect in the File menu. The Open Aspect window is presented.
2. Select the Aspect Object and the graphic aspect (that is, the graphic element)
which you want to edit.
3. Either click Open or double-click on the selected aspect.
Another way, which is even faster, is to use the drag-and-drop function.
1. Drag a graphic aspect, for example from Plant Explorer to the white area of
Graphics Builders workspace.

3.4 Setting Options in Graphics Builder


There are some optional preferences which you can set for Graphics Builder. You
can decide to use live data in Design mode, to have additional Visual Basic
functionality and to have access to a debug menu. There is also an option to show
the Element Browser and Expression Window at startup or not. Select Graphics
Builder Options in the Tools menu.

18 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 3.4 Setting Options in Graphics Builder

Figure 3-3. Graphics Builder Options

Live Data in Design mode


The Live Data option enables you to display dynamic data in graphic elements when
you are using graphic aspects in Design mode. This is useful if you do not want to
switch to Test mode when using graphic aspects. Mark the checkbox to select Live
data in Design mode. The setting Live data in design mode does not affect Test
mode.
Note that live data results in a higher CPU usage, which in turn leads to slower
operation of Graphics Builder.

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.

3BSE 017 091R301 19


OperateIT Graphics Users Guide
Chapter 3 How to Work with the Graphics Builder

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.

3.5 Working with Generic Elements


Generic elements is a common name for Primitives, Subelements, standard Visual
Basic components and third party ActiveX controls.
You build graphics by using the building blocks: primitive elements and
subelements, together they can for example make up a graphic element.

Primitive Elements Subelements Graphic Elements

100.0 100.0

100.0

? ?
??

0.0 0.0
AI 14
0.0

Figure 3-4. Generic elements used to build graphic elements

20 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 3.5.1 Toolbox Window

Following are different types of generic elements


Primitive element
A simple graphic element, for example a rectangle or a polyline. Normally a
part of a graphic display. A graphic object typically built up from several
subelements and/or primitive elements.
ABB provides some basic primitive elements (Examples: Arc, Bar, Chord),
while others may be built by you or purchased from other sources in the form
of graphic libraries. Primitive elements are graphic components (ActiveX
controls) that are installed into system libraries.
All elements that you use which have not been built in Graphics Builder are
treated like primitive elements.
Subelement
A graphic element composed of primitive elements and suitable for data type
presentation. Used to build graphic elements in Graphics Builder.
ABB provides a basic subelement: Bar.
Others may be built by you or purchased from other sources in the form of
graphic libraries. Examples: bar with limits, numeric value.
Standard Visual Basic components.
Third party ActiveX control, supplied by any source.
More information on building blocks can be found in Appendix A, Standard
Building Blocks.

3.5.1 Toolbox Window


Open the toolbox by clicking on the Toolbox button in the toolbar or choose
Toolbox in the View menu.
The main objectives of the toolbox window are:
Provide primitive elements and subelements. Section 3.5.2, Select Generic
Elements from the Toolbox.
Provide third party ActiveX Controls. Section 3.5.3, Adding Graphic Libraries
to the Toolbox.

3BSE 017 091R301 21


OperateIT Graphics Users Guide
Chapter 3 How to Work with the Graphics Builder

Subelements

Special

Visual Basic Graphic Primitives


controls
Graphic Primitives

Extended Primitives

Figure 3-5. Examples of Toolbox elements

The available toolbox buttons are:

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.

22 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 3.5.2 Select Generic Elements from the Toolbox

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.

3.5.2 Select Generic Elements from the Toolbox


The toolbox provides the chosen generic elements, used to build graphics.
1. Click the icon for the desired tool (ActiveX control) in the toolbox. The cursor
changes to a crosshair in the Graphic Builder workspace.
2. Place the cursor at any point in Graphics Builders workspace.
3. Click and hold the left mouse button.
4. Drag the cursor diagonally to the opposite corner of the bounding rectangle.

3BSE 017 091R301 23


OperateIT Graphics Users Guide
Chapter 3 How to Work with the Graphics Builder

5. Release the mouse button. The selected element now appears inside a bounding
rectangle in the workspace.

Toolbox-
Button

Figure 3-6. A Graphic Element in the Graphics Builder Window

3.5.3 Adding Graphic Libraries to the Toolbox


Subelements and Primitives are grouped together in different Graphic Libraries.
To add libraries to the toolbox:
1. Open the Graphic Libraries window in the Tools menu.
2. Select one or more of the listed Libraries.
3. Click OK. The selected libraries are presented under their respective button in
the toolbox.(The Apply button adds the selected Graphic libraries and keeps
the dialog box open. OK also adds the selected Graphic libraries but closes the
dialog box.)

24 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 3.5.4 External ActiveX Controls

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.

Figure 3-7. Graphic Libraries Window

Deleting graphic libraries from the toolbox


To delete tools: Open the Aspects menu, select Components, then uncheck the box
of the tool you wish to delete. Deleting tools from the toolbox is also described in
Visual Basics On-line Help file.

3.5.4 External ActiveX Controls


External ActiveX controls, not provided by ABB, you have to install by yourself.
See Section 3.5.3, Adding Graphic Libraries to the Toolbox, for more information.

3BSE 017 091R301 25


OperateIT Graphics Users Guide
Chapter 3 How to Work with the Graphics Builder

ActiveX components need to be installed in all your OperateIT workplaces, where


they are to be used. Otherwise, graphic displays containing ActiveX components,
which have not been installed, will not be appear on the monitor of that computer.
External ActiveX Controls are NOT described in this manual or any other related
document delivered by ABB.
Licenses for external/third party ActiveX controls, are not included in the OperateIT
product. For information about how to obtain these licenses, see the instructions
from each supplier.

How to Add External ActiveX Controls


To add external ActiveX Controls:
1. Place the ActiveX control on the hard drive and register it.
2. Choose Components in the Aspect menu. The Components window is
presented.
3. Select the Controls tab.
4. Click in the boxes to select one or more of the listed ActiveX Controls.
5. Click OK. The selected ActiveX Controls are presented in the toolbox.

3.6 Expression Builder


To properties of elements in the configured graphic aspect, one can assign
1. Constant values. They are assigned using the Properties window.
2. Expressions. Assigned using Expression Builder.

Though it is possible to assign constant values using Expression Builder, it should


be avoided, as it unnecessarily increases the CPU load.

26 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 3.6 Expression Builder

The Expression Builder can be opened from the View menu. To set properties for a
certain element, it needs to be selected first.

Expressions can not be used within subelements.

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.

3BSE 017 091R301 27


OperateIT Graphics Users Guide
Chapter 3 How to Work with the Graphics Builder

Properties Expression Expression entry fields

Top half

Bottom half

bject list Function buttons Object Property list Subproperty list

Figure 3-8. Expression Builder

3.6.1 The top half of the Expression Builder


The top half shows all the names of the properties of the selected element in the left
column. In the right column, the expressions assigned to those properties are
displayed.

28 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 3.6.1 The top half of the Expression Builder

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.

Figure 3-9. Edit variables tab

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.

3BSE 017 091R301 29


OperateIT Graphics Users Guide
Chapter 3 How to Work with the Graphics Builder

The expression variable function enables the reuse of frequently used


expressions. Expression variable store intermediate results from expressions and
make expressions shorter and more readable.
Expression variables can be used as a means for Visual Basic code, for example in
Faceplate elements, to read values produced by the expression. It is therefore
possible to set up a subscription for an object property to an expression variable and
enter Visual Basic code e.g. in the OnPostDataChange event, see Section B.6,
Subscription Control.
It is also possible to use expression variables to input values to expressions from
Visual Basic code. Perform the following steps.
1. Define an expression variable, without an expression connected to it, and refer
to it from expressions.
2. Set the value of the expression variable from Visual Basic.
3. Force execution of expression, by calling m_sc Execute Expressions.
Expression variables, in contrast to Object properties, do not posses quality
attributes. An expression variable will have the vtEmpty value, when some variable
referenced by the expression, has an empty value. One example is when data has not
been received for a referenced object property. See Section B.8.1, Handling Bad
Data for more information.

3.6.2 The bottom half of the Expression Builder


The bottom half of the Expression Builder contains 3 tabs, which all simplify the
construction of expressions:
1. ObjectProperty tab
It allows you to get dynamic data from an object and connect it to the selected
graphic element

30 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 3.6.2 The bottom half of the Expression Builder

Figure 3-10. Object Property tab

The objectProperty tab contains three lists:


The object list, which displays object references. See Section 3.7, Object list
for more information.
The object property list, which displays the properties of the selected object.
To add a property to the expression: Select it and press the Insert button, or
just double-click the property
The Subproperty list, which displays subproperties of the selected Object
property. The list allows you to define, which subproperty is relevant for the
expression.

3BSE 017 091R301 31


OperateIT Graphics Users Guide
Chapter 3 How to Work with the Graphics Builder

Figure 3-11. Subproperty list

The selected subproperty is Value by default. The other subproperties all


returns data quality information regarding the transfer of data. Note that Value
is not displayed in the expression entry field. More information can be found in
Section B.8, Quality attributes of Object Properties
2. Color tab
It enables you to choose colors from a logical color group. Select the drop
down list and choose a color group, then select a color from the list below..

Figure 3-12. Color Tab

32 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 3.6.3 Assign Expressions to Properties

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

Figure 3-13. Variables tab

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.

3.6.3 Assign Expressions to Properties


All element properties can be assigned an expression. To assign an expression to a
property:
1. Select an element.
2. Select Expression Builder in the View menu.
3. From the list of properties in the top left column, select the name of the
property you want to assign an expression
4. Assign an expression to the property via the ObjectProperty tab, the Color tab
or the Variables tab. Each tab contains items. Highlight the item of choice and
click Insert. The content of an expression can be created via the tabs and the

3BSE 017 091R301 33


OperateIT Graphics Users Guide
Chapter 3 How to Work with the Graphics 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.

3.6.4 Using Logical Colors


Some colors have special meaning for an operator, for example the color on active
alarms, or warning messages. Other colors needs to be the same on all places to give
the system a user-friendly look, for example background colors. You also want to be
able to change these colors with one operation for all occurrences.
Logical color is the concept used in OperateIT, to be able to fulfill these needs. A
logical color is defined once, and the user of the color reference the color by its
name. Information regarding configuring and adding your own logical colors can be
found in OperateIT Workplace and Plant Explorer.
Click the Color tab at the bottom part of the Expression Builder. This enables you to
choose from a variety of colors: Click on the drop down list and select a logical
color group, then select a logical color from the list below.
Before choosing/assigning color, you must have selected a property to assign the
color to, in the top half of the Expression Builder.

Figure 3-14. Color Tab

34 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 3.6.4 Using Logical Colors

3.6.4.1 Logical Colors in Process Graphics


Some of the logical colors have special meaning in graphic aspects delivered
together with controller integration products from ABB. If you make your own
graphic aspects, you should try to follow the same convention. This makes your
graphic aspects follow changes in the logical colors the same way as the standard
graphic aspects.
Table 3-1 below shows how they are used.

Table 3-1. Usage of logical colors in standard faceplates

Logical Color Group Color Usage


General static Static text in object displays
limit Limit indications in Bar-graphs
Object actuator Actuator for PIDCON and MANSTN
autoMode
deviation
manMode
measure
output
setpoint
text2Normal Normal status on text and values
symbol2Emphasize Emphasized normal status on
symbols
symbolNormal Normal status on symbols

3BSE 017 091R301 35


OperateIT Graphics Users Guide
Chapter 3 How to Work with the Graphics Builder

Table 3-1. Usage of logical colors in standard faceplates

Logical Color Group Color Usage


Event Colors blockedSymbol Blocked object symbol
blockedText Blocked object text
highAlarmSymbol Object high alarm symbol
highAlarmText Object high alarm text
selected Object selected text and symbol
unackHighAlarm Object unacknowledged high alarm
text and symbol
warningSymbol Object warning text and symbol

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.

3.7 Object list


The object list in Expression Builder is the same as in Element Browser.
Therefore, changes take immediate effect both in Expression Builder and Element
Browser. In Expression Builder, the list is visible when the Object property tab is
selected. Note that the object list contains object references that can be either
absolute or relative.
If you right-click on one of the object references, you created in the Object list, a
context menu with the following options appear.
Properties, see explanation below.
Delete, deletes the selected object reference.
Delete all, deletes all object references not used.
Autopopulate, adds all child objects (the other objects below the selected

36 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 3.7 Object list

object in the tree structure), to the object list.


Properties, opens an Object reference dialog. It contains the following options:

Figure 3-15. Object reference dialog

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.

3BSE 017 091R301 37


OperateIT Graphics Users Guide
Chapter 3 How to Work with the Graphics Builder

2. Detailed, contains information about relative and resolved absolute references.


a. For relative references, the exact definition of the relative path. Can be a
bit complex. The default representation of a relative reference uses full
path and structure qualification.
b. For a resolved absolute reference, the minimal sufficient name path
(category primary name) to uniquely identify the object is shown. If
unique names are used for objects, the path only contains a single name.
3. Object Proxy Name, at the bottom you can add a proxy name (default name:
m_Object) which enables you to change values for objects. This gives you a
representation of the object in the Visual Basic code pane.
The Object proxy concept is part of Aspect Object Automation.
See Section 4.5.1, How to write to the Properties of an Object for more
information.

3.7.1 Populate the Object List


A prerequisite before assigning expressions to properties is that the ObjectProperty
tab/the object list, contains objects. To add an object reference: Either click on the
Browse button, this opens a dialog box which allows you to choose an object, or
drag an object from Plant Explorer.

38 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 3.7.1 Populate the Object List

Figure 3-16. Add an Object.

3.7.1.1 Autopopulate the object list


Right-click on the object and select Autopopulate in the drop down list.
All child objects (the other objects below the selected object in the tree structure),
are added to the object list. Now we have objects to work with. For more
information about composite object types, see OperateIT Plant Engineering
Methods.
Populate in object types: If you create a graphic aspect on an object type, the object
list will automatically contain all the objects on that object type.

3BSE 017 091R301 39


OperateIT Graphics Users Guide
Chapter 3 How to Work with the Graphics Builder

3.8 Element Browser


The main objective of the Element Browser window is to:
Select and add graphic elements to a graphic aspect.

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.

40 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 3.8 Element Browser

You can also add elements by dragging them from Plant Explorer into the Graphic
display.

Object list Graphic Element list

Figure 3-17. Element browser

The Graphics Element Browser specific fields and buttons are:


The browse button
Brings up the object browser, used to populate the object list.
Object list
The list displays object references. The object list is common for Expression
Builder and Element Browser.
Graphic Element list
This list shows the graphic element aspects, associated with the selected Object.

3BSE 017 091R301 41


OperateIT Graphics Users Guide
Chapter 3 How to Work with the Graphics Builder

Add Element button


Click on this button when you want to add a selected graphic element to your
graphic.

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.

3.9 Background Color of Graphic Aspects


Graphics Builder offers extensive possibilities to control the background color of
graphic aspects in a simple and effective way according to your demands. You can
for example change the background color of a range of displays by adjusting the
color at just one place. It is also possible to let a graphic element adapt its
background color after the graphic aspect it resides in. Another alternative is to
handle individual aspects separately with their own special background colors. To
achieve this, there are three methods to choose from when configuring a graphic
aspect:
1. Container color
2. Logical color
3. Static color
The result of the different alternatives are described here in this section and how to
perform the configuration is explained in the next section.
Container color
When a graphic aspect is configured to use the color of its container, it will adapt its
background after the graphic aspect it resides in. If a graphic aspect is viewed stand
alone without a container, it will comply to the logical color GeneralBackColor
defined on the workplace.

42 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 3.9.1 How to Set the Background Color

As an example, consider a graphic display with a graphic element configured to use


the color of its container. When you change the background color of the display, the
graphic element will follow. If the graphic display itself is configured to use
container color, it will get the GeneralBackColor and in turn affect the graphic
element to use the same.
The value of the logical color GeneralBackColor can be changed in the Process
Graphics Color aspect in the workplace structure.
Logical color
A graphic aspect can be configured to have an arbitrary logical color as its
background. When the value of a logical color is changed it will take effect
immediately everywhere it is used. The graphic aspect does not consider the color
of its container in this case, it will totally comply to the logical color.
Static color
It is also possible to assign a static color as background. If you use a static color
instead of a logical it is important to be aware of the fact the possibility to update the
color at one central place is lost. But it is a convenient way when the color only
concerns one or a few graphic aspects.

3.9.1 How to Set the Background Color


It is important to note that the background color of an aspect in Graphics Builder
may not be the same as in run-time. The background color which you get in run-
time is controlled from an object called m_sc which is of the type
PgSubscriptionControl and belongs to the graphic aspect. It is selected from the
listbox in the top of Properties window. When m_sc is selected you should see a
property called GeneralBackColor. This is the property that controls the background
color of the aspect in run-time.
In the following it is explained how to set the background color in a graphic aspect
according to the three alternatives presented in the previous section.
Container color
1. Select the m_sc object in Properties window.
2. Set the GeneralBackColor property to -1 which will be represented as
&HFFFFFFFF&.

3BSE 017 091R301 43


OperateIT Graphics Users Guide
Chapter 3 How to Work with the Graphics Builder

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.

3.9.2 Changing the Color of Prebuilt Elements


It is possible to the change the color of graphic elements when you use them in
Graphics Builder. As long as the GeneralBackColor property of the m_sc control
has been configured using Properties window, it is regarded as a default setting
which can be overruled in Graphics Builder when the element is used. But, on the
other hand, if the GeneralBackColor has been assigned a logical color the only way
to change it is to change the value of the logical color on the workplace.
In order to overrule the background color of a graphic element that has been
configured with Properties window to use container color or a static color as default,
do like this:
1. Add the desired graphic element to your graphic aspect with Element Browser.
2. Select the graphic element.
3. In Properties window you find the BackgroundColor property which can be
modified according to the following alternatives:
Assign -1 in order to use container color.
Assign a static color.
Bring up Expression Builder and assign a logical color.

44 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 3.10 Controlling the Update Rate of Data Subscriptions

3.10 Controlling the Update Rate of Data Subscriptions


It is possible to control the rate by which dynamic updates take place in graphic
displays and elements. By default, the update rate is not controlled by process
graphics, but by the configuration of control connection aspects.
Setting the update rate for:
Graphic displays
By setting the value of the UpdateRate property, of the graphic displays
subscription control.
For instances of graphic elements
By setting the value of the UpdateRate property of the graphic element.
The unit for these properties is milliseconds.
The default value of both properties is 0. The interpretation of the zero value is that
the update rate is not determined by process graphics but by the underlying
integration of the controller. In most cases, the update rate is then determined by
means of control connection configuration.
Setting a value, other than 0, on a graphic display overrides any settings of the
update rate on graphic element instances, of that graphic display.
The effect of setting UpdateRate properties is determined by the (integration of the)
controller that is providing the data. In many cases, it is valid for analog properties
but not for properties that by their nature are changed in an event driven fashion.

3.11 Testing Graphic Aspects


The Test mode provides functionality to check behavior of graphic aspects.
Hence, when you decide to switch from Design mode to Test mode, your graphic
element will set up a subscription, and values, animation, etc. are continuously
updated.

To test a graphic element:


1. Switch to test mode by clicking the Test Mode button on the toolbar, or choose
Test Mode under the Run menu.
2. Set the object path property.

3BSE 017 091R301 45


OperateIT Graphics Users Guide
Chapter 3 How to Work with the Graphics Builder

3. Check the behavior of the graphic element.


4. Click the Design Mode button on the toolbar, or choose Design Mode under
the Run menu to return to design mode..

Test Mode Design Mode

Figure 3-18. Test Mode and Design Mode Buttons

5. Graphic aspects that contain relative references, require an invocation object to


function. In test mode, the invocation object can be selected by writing the
name of it to the object path property, using the property window for the tested
graphic aspect.

46 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 3.12 Saving, Deploying and Deleting Graphic Aspects

3.12 Saving, Deploying and Deleting Graphic Aspects


Saving
To save a graphic aspect, you either click the Save button in the toolbar, or choose
Save from the File menu.

Figure 3-19. Save Button

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.

3.13 Precautions When Importing/Exporting Aspects


The Import/Export Tool can be used to restore graphic aspects, and produce copies
of exported aspects. When restoring graphic aspects there are restrictions for both
Import and Export.

Graphic elements are implemented as ActiveX controls in Graphics Builder. Visual


Basic identifies an ActiveX control by a unique identity (Class id) and not by its
name.

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.

3BSE 017 091R301 47


OperateIT Graphics Users Guide
Chapter 3 How to Work with the Graphics Builder

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.

Figure 3-20. Import/Export dialog

In the Export/Import tool objects are represented with squares, aspects with circles.

48 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 3.14 Precautions When Copying Aspects

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.

Import needs to be performed before Upload.


Upload identifies existing objects based on names. Starting with Import prevents
Upload to create doubles (objects that already exist).

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).

3.14 Precautions When Copying Aspects


If you copy aspects, for example a graphic display, that contain graphic elements
within Plant Explorer, there are restrictions.

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.

3.15 Properties Window


The Properties window is one of the standard windows in Visual Basic. It shows all
the properties belonging to the currently active ActiveX control. The properties can
either be sorted in alphabetic order (with the Alphabetic tab) or in categories (with
the Categorized tab). The categories are presented as a tree structure. By default, all
categories are expanded. The available categories depend on the categories exposed
by the control.

3BSE 017 091R301 49


OperateIT Graphics Users Guide
Chapter 3 How to Work with the Graphics Builder

Open the Properties window by choosing Properties Window in the View menu.

Figure 3-21. Properties window

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.

A value entered in the Properties window is ignored at runtime/test mode if an


expression has been entered for the same property in Expressions Builder.

You can find more details about the Properties window in the Visual Basics On-line
Help file.

50 3BSE 017 091R301


OperateIT Graphics Users Guide

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.

3BSE 017 091R301 51


OperateIT Graphics Users Guide
Chapter 4 Faceplates

Reduced Faceplate Faceplate

Figure 4-1. Two of the three runtime views.

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.

52 3BSE 017 091R301


OperateIT Graphics Users Guide
Section

Extended Faceplate

Figure 4-2. The third runtime view

3BSE 017 091R301 53


OperateIT Graphics Users Guide
Chapter 4 Faceplates

4.1 Using Faceplates in Runtime


This section is an overview of how to open and use the faceplate, once it is
displayed in runtime.
In this example we open the faceplate via a graphic display. There are a number of
ways to open up a graphic display.To open a faceplate for a process object, just left-
click on the graphic element.

Click here to open up a faceplate

Figure 4-3. Graphic display

54 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 4.1 Using Faceplates in Runtime

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

7. Direct entry window

8. Buttons
10. Apply button

9. View selection buttons

Figure 4-4. Faceplate in runtime

3BSE 017 091R301 55


OperateIT Graphics Users Guide
Chapter 4 Faceplates

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.

Unlocked Locked by me Locked by other

Figure 4-5. Object lock states

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%)

56 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 4.1 Using Faceplates in Runtime

Use the up and down arrow keys on the keyboard.


This changes the value a little bit (1%)
Use the Page Up and Page Down keys on the keyboard.
This changes the value more (10%), than the two previous alternatives,
Apply the value:
Click the Apply button, or Press Enter on the keyboard.
Cancel and close the direct entry window (there are several ways):
Press the Esc key on the keyboard, or click in a neutral area on the side, within the
faceplate.
8. Buttons
Click here to control the behavior of the object. When you click on a button,
the effect on the object is direct. Apply is not needed. Apply is on the other
hand needed, when controlling to get direct effect
There are no buttons displayed in Figure 4-4.
Go to Figure 4-1, to see examples of buttons.
9. View selection buttons
Select the view of choice. The views from left to right are.
Reduced Faceplate
The size and contents typically have been optimized to cover most of the
normal process operator actions.
Faceplate
This runtime view is default and mandatory, it can not be removed.
Extended faceplate
The functions and information of the extended faceplate are intended for
the process engineer or the advanced operator.
Go to the beginning of this chapter for a display of, and more information about, the
different faceplate views.
10. Apply button
Regardless how the value has been set, it must be applied.
Click on the Apply button, or
Press Enter on the keyboard.
Both Enter and Apply close the direct entry window.

3BSE 017 091R301 57


OperateIT Graphics Users Guide
Chapter 4 Faceplates

4.2 Faceplate Configuration Overview


From an application engineers point of view, the faceplate is divided into several
areas that are configurable. Read about the contents of the faceplate areas here and
you will use the knowledge later on in Section 4.4, Configuring the Faceplate. In
short, the contents of all areas except the faceplate element area, are parts of the
faceplate aspect.

Alarm control

Object lock

Header area
Status and navigation
bar

Faceplate element
area

Buttons
Apply button

View selection buttons

Figure 4-6. Faceplate Terminology.

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.

58 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 4.2.1 Header

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

Object lock Object Name & Alarm


description Control

Figure 4-7. Example of a Header area

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.

3BSE 017 091R301 59


OperateIT Graphics Users Guide
Chapter 4 Faceplates

The table below is an overview of the different states of the object lock.

Table 4-1. Lock states displayed in the object lock.

Logical Color
Lock status Button Icon Name

Unlocked Raised FaceplateUnlocked

Locked by me Sunken FaceplateLocked


ByMe
Locked by other Flat FaceplateLocked
ByOther

If the object is locked by yourself, the button is sunken/pressed in and the


background is white. If it is locked by somebody else, the background is yellow but
the button is flat.
Its easy to see if the object is released by somebody else. The button is changed
from flat to raised and it turns bluegrey. Simply press the button to lock the object.
Possible ways to release a lock on an object, is to either click the lock button,
another way is to close the faceplate. The object lock will also be released when the
time-out period expires.

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.

60 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 4.2.1 Header

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.

Table 4-2. Alarm status by the alarm control.

Acknowledge Acknowledge not


Alarm state Logical colors
allowed allowed
0 - AlarmInActive
1- highAlarmSymbol
AlarmActiveAck

2- warningSymbol
AlarmInActiveUn
Ack

3- unackActiveHighAl
AlarmActiveUnAc arm
k

4- highAlarmSymbol
AlarmAutoDisabl
ed

5 - AlarmDisabled warningSymbol

Alarm not defined


= no alarm state
property found

3BSE 017 091R301 61


OperateIT Graphics Users Guide
Chapter 4 Faceplates

When the header is displayed in an Extended Faceplate with horizontally oriented


tab controls, the header rescales as shown in Figure 4-8

Figure 4-8. Header displayed in extended Faceplate.

4.2.2 Status and Navigation Bar


The Status and navigation bar includes status indicators for the object to the left
(IN). Status indicators shows the current result of an expression, which can include
one or several object properties. Aspect links to aspects of the object are displayed
to the right. It is possible to freely mix aspect links and indicators.

Figure 4-9. Example of Status and Navigation bar area.

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.

4.2.3 Faceplate Element Area


Aspects can be displayed in the faceplate element area, either alone or included in
tab groups. Primarily faceplate element aspects should be included in this area.
The faceplate element area can include several aspects and/or tab groups. The
orientation of those aspects and/or tab groups can be either horizontal or vertical,
but not both in the same faceplate aspect. Each tab in a tab group contains an aspect.

62 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 4.2.4 Buttons

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.

Tab group 1 Tab group 2

Figure 4-10. Example of a 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,

3BSE 017 091R301 63


OperateIT Graphics Users Guide
Chapter 4 Faceplates

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.

4.2.5 View Selection Buttons


These buttons enable you to choose one of the three runtime views. See Figure 4-10.
If a view does not exist, the button representing that view is dimmed. The current

Reduced Faceplate Extended


Faceplate Faceplate

Figure 4-11. View selection buttons

view is indicated by the fact that the corresponding button is sunken.

4.3 Create a New Faceplate Aspect


1. Select a structure in Plant Explorer, typically Object type structure.
2. Select an Aspect Object. Suitable objects are typically found in the Object type
structure, for example within the Control System group, shown below.

Figure 4-12. Select Aspect Object

64 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 4.4 Configuring the Faceplate

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.

Figure 4-13. New Aspect Window

5. Enter an aspect name and click Create. The created aspect is added to the
objects aspect list.

4.4 Configuring the Faceplate


This section explains how to configure the appearance and behavior of the 3
Faceplate runtime views. The configuration is done in the Config view. You are
required to have Application engineer privilege to configure the Faceplates.

3BSE 017 091R301 65


OperateIT Graphics Users Guide
Chapter 4 Faceplates

Right-click on the faceplate aspect and select Config view, to be able to configure.

Figure 4-14. Open Config view

The Config view contain the following tabs:


Layout Configuration of the Faceplate design.
Indicators Configuration of the Status and Navigation bar.
Buttons Configuration of the Button area.
Element Configuration of the Faceplate element area.

66 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 4.4.1 Layout Tab

4.4.1 Layout Tab


In the layout tab you design the layout and size of the Faceplate. There are
checkboxes for including reduced and/or extended faceplate views.

Figure 4-15. Layout tab

There is also a choice whether to have horizontal or vertical orientation of the


faceplate element area.It is recommended not to make changes in the layout tab
initially, as the default setting suits most users to begin with. If you still want to
make changes, see Appendix C, Sizes of Faceplates for more information.
The layout tab also contains a default view dropdown box. Select the view to be
displayed when the faceplate is opened. Naturally you can change the view, once the
faceplate is opened, via the View selection buttons.
Table 4-3 displays the configurable parameters in the Layout tab which affect the
overall layout of the Faceplate.

3BSE 017 091R301 67


OperateIT Graphics Users Guide
Chapter 4 Faceplates

Table 4-3. Layout parameters

Parameter Default value


Width 250
Height 400
Max no. of indicator rows 1
Max no. of indicators per row 6
Max no. of button rows 2
Max no. of buttons per row. 6

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.

68 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 4.4.2 Indicators Tab

4.4.2 Indicators Tab


The indicators tab allows you to configure which indicators and aspect links to
display in the status and navigation bar of the faceplate. You can decide which
position to display them in, depending on the selected view.

Figure 4-16. Indicators tab

3BSE 017 091R301 69


OperateIT Graphics Users Guide
Chapter 4 Faceplates

Table 4-4 displays the configurable parameters in the Indicators tab which affect the
Status and Navigation bar in the Faceplate.

Table 4-4. Indicators table

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

70 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 4.4.2 Indicators Tab

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

Figure 4-17. Configuration of Icons/Labels

3BSE 017 091R301 71


OperateIT Graphics Users Guide
Chapter 4 Faceplates

Table 4-5. Aspect links table

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.

4.4.2.1 Expression syntax in Faceplates


The syntax of expressions used for configuration of Indicators in faceplates differs
from the syntax used for graphic aspects in general (See Appendix B, Expressions).
The differences are listed below.
The syntax of an object property reference is:
$Object[:aspect]:property

72 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 4.4.3 Buttons Tab

The square brackets [ ] in the syntax above indicates that aspect can be omitted

The following is an example of an expression used in a general


graphic aspect:
AI.117:Control Connection:VALUE*14.2

It would look like this in Faceplate syntax:


$AI.117:Control Connection:VALUE*14.2
Expressions
Logical colors and expression variables assigned in the Expression Builder do not
function in Faceplates.

4.4.3 Buttons Tab


The Buttons tab allows you to configure which command buttons to display in the
buttons area of the faceplate. The behavior of the command buttons is also set.

Figure 4-18. Buttons tab

3BSE 017 091R301 73


OperateIT Graphics Users Guide
Chapter 4 Faceplates

Table 4-6 configuration of Button area.

Table 4-6. Buttons table

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.

74 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 4.4.4 Elements Tab

4.4.4 Elements Tab


The elements tab is used to configure the faceplate element area. Aspects can be put
in directly, or they can be organized in tab groups.

Figure 4-19. Elements tab

Table 4-7. Elements table

Parameter Description
Aspect All aspects of the object are
displayed. Choose one.
View Select a view for the chosen
aspect.

3BSE 017 091R301 75


OperateIT Graphics Users Guide
Chapter 4 Faceplates

Table 4-7. Elements table (Continued)

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.

4.5 Configuring Faceplate Elements


Configuring Faceplate elements is essentially done in the same manner as in the
sections: Create a new Graphic Aspect and Edit Graphic aspects in Chapter 3, How
to Work with the Graphics Builder.
The fact that we create faceplate elements from the faceplate element category adds
the following functions to faceplate elements (beyond regular graphic aspect
functions.)
When you left-click on a Faceplate element, nothing happens, as opposed to
left-clicking on an general graphic element. This is to avoid reinvoking the
faceplate.
Faceplate elements have support for communication with the faceplate session
framework. The framework controls the Apply button, time-outs for the direct
entry window.
In the newly created faceplate element commented out exists as templates for
some code you are required to add.

4.5.1 How to write to the Properties of an Object


Graphic elements read properties via expressions. In addition to read/retrieve
properties Faceplates also write to the object properties, hence you can enter
data/modify the underlying object.

76 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 4.5.2 Configuring the Direct Entry Window

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.

4.5.2 Configuring the Direct Entry Window


This section deals with how to activate and configure the look of a direct entry
window. There are three objects which have support for the direct entry window.
The primitives: bar and numeric, and the subelement bar.
The bar for example, has the following properties in order to support handling of the
direct entry window:
Displacement, direct entry window position from Bar
EnableInput
To enable direct entry window functionality, that is, to be able to modify the object
property values, you need to carry out the following steps:
Set EnableInput to True. This shows the transparent drag handle in the Bar to
inform the user that input is enabled. When the user left-clicks in the Bar, the
direct entry window is displayed and the drag handle transforms to a
highlighted state.

3BSE 017 091R301 77


OperateIT Graphics Users Guide
Chapter 4 Faceplates

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:

Private Sub Bar1_OnMouseDown(..., ByVal autoDew As Object)


On Error GoTo Error_AdvantBar1_OnMouseDown
m_SessionHdlr.StartSession
Set m_Dew = autoDew
m_SessionHdlr.TriggerTimeout
Exit sub
Error_AdvantBar1_OnMouseDown:
Call ReportError(AdvantBar1_OnMouseDown, Err.source,
Err.Description, , 0)
End Sub
A reference is now held by the application to avoid the direct entry window to
disappear unless the application explicitly wants to.
Add code to the Apply event from the Session Handler:

Private Sub m_SessionHdlr_DoApply


On Error GoTo Error_m_SessionHdlr_DoApply
m_Object("Control Connection:SetPoint") = m_DEW.GetValue
Exit Sub
Error_m_sessionHdlr_DoApply:
Call ReportError(m_sessionHdlr_DoApply, Err.source,
Err.Description, , 0)
End Sub

4.5.2.1 Incremental Change of Property Values in the Direct Entry Window


As described in Section 4.5.2.2, Stepsize in the Direct Entry Window, it is possible
to increase/decrease the value entered with the direct entry window in a few ways.
Pressing the spin buttons or by using the up/down arrow keys on the keyboard
increases/decreases the entered value with the normal step value, see below.
Pressing Page Up/Down keys increases/decreases the value 10 times the normal
step value.

78 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 4.5.2 Configuring the Direct Entry Window

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:

Private Sub AdvantBar1_OnMouseDown(.., ByVal autoDew As


Object)
On Error GoTo Error_AdvantBar1_OnMouseDown
m_SessionHdlr.StartSession
Set m_DEW = autoDew
m_SessionHdlr.TriggerTimeout
Following code disables max-min limits set by the
graphic component
Dim ndew As PGDIRECTENTRYWINDOWLib.PgNumericDEW
Set ndew = m_DEW.GetTypedDew
Dim NormalStep As Single
Let NormalStep = 0.1 'Set Normal step to desired value
Call ndew.EnableLimits(False, NormalStep)
Exit Sub
Error_AdvantBar1_OnMouseDown:
Call ReportError("AdvantBar1_OnMouseDown", Err.source,
Err.Description, "", 0)
End Sub
In the code above the normal step value is set to 0.1.

4.5.2.2 Stepsize in the Direct Entry Window


Depending on which method is used to change value in the direct entry window, the
percentage of the step varies. An explanation of the methods and their stepsize:
Click the spinbuttons (up and down arrows) in the direct entry window.

3BSE 017 091R301 79


OperateIT Graphics Users Guide
Chapter 4 Faceplates

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.

4.5.3 Visual Basic Error Handling


The writer of Visual Basic code, should ensure that errors that may occur during
execution of the code, are handled in a proper way.
A template for handling error code follows.

Private Sub MySub_DoApply


On Error GoTo Error_MySub_DoApply
MySub code here
Exit Sub
Error_MySub_DoApply:
Call ReportError(MySub_DoApply, Err.source,
Err.Description, , 0)
End Sub

4.5.4 The faceplate session handler


The faceplate session handler makes the communication between the faceplate
elements in the faceplate possible it also gives an opportunity to control the apply
button.
A faceplate contains faceplate elements. When creating a faceplate element the
element has an instance of the PgSessionHdlr, a reference to the session handler.

80 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 4.5.4 The faceplate session handler

The session handler, PgSessionHdlr, contains the following methods:

Table 4-8. SessionHdlr methods

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.

3BSE 017 091R301 81


OperateIT Graphics Users Guide
Chapter 4 Faceplates

Table 4-8. SessionHdlr methods (Continued)

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.

82 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 4.5.4 The faceplate session handler

The PgSessionHdlr events

Table 4-9. SessionHdlr events

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.

3BSE 017 091R301 83


OperateIT Graphics Users Guide
Chapter 4 Faceplates

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.

84 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 5.1 Frequently Asked Questions (FAQ)

Chapter 5 Maintenance

Graphics is a part of the OperateIT software package. Perform any required


maintenance according to the instructions in the Administrators Guide.

5.1 Frequently Asked Questions (FAQ)

5.1.1 Syntax error during deployment

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.

Figure 5-1. Add-In Manager

3BSE 017 091R301 85


OperateIT Graphics Users Guide
Chapter 5 Maintenance

5.1.2 Edit is Dimmed or Missing in the Context menu


Edit is dimmed or missing in the context menu. What could be causing the problem
and what should I do?
1. Visual Basic is not installed on the machine.
2. Process Graphics option is not installed on the machine.
3. Attempt to edit an inherited aspect (it is not possible.
4. Edit a graphics aspect requires application engineer privilege.

5.1.3 Edit Imported Graphics Aspect with 3rd party ActiveXs


There are error messages displayed, then the area where the missing ActiveXs
reside, turns into a picture box. What should I do?
1. Identify the missing ActiveXs, and install them on your machine.

86 3BSE 017 091R301


OperateIT Graphics Users Guide

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:

Section 6.1, Tutorial 1, Building a Graphic Display


Build a Graphic Display
Adding Graphic Elements to the Graphic Display
Using Logical Colors
Section 6.2, Tutorial 2, Building a Graphic Element
Creating a Graphic Element
Building a Graphic Element
Changing Properties for the Generic Element
Assigning Expressions to Properties
Testing the Graphic Element
Deploying a Graphic Element
Section 6.3, Tutorial 3, Creating and Configuring Faceplates
Creating a Faceplate Element
Configuring a Faceplate

3BSE 017 091R301 87


OperateIT Graphics Users Guide
Chapter 6 Tutorial

6.1 Tutorial 1, Building a Graphic Display


In this tutorial it is assumed that a tank farm with two tanks connected via a valve
already exists in the Functional structure.

Figure 6-1. Functional structure

The level in the tanks are measured by AO1.12 and AO1.13.

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.

88 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 6.1.1 Build a Graphic Display

Upper tank Valve Pipe Level indicator


Graphic primitive (Bar)

Direction arrow Lower tank


Fluid warning (Graphic primitive)

Figure 6-2. Graphic aspect

6.1.1 Build a Graphic Display


1. Right-click the Storage tanks, Tank Farm object, in Plant Explorer and select
New Aspect.
2. Select Graphic Display in the New Aspect list.
3. Name the Aspect Tank Farm Overview.
4. Right.click and select Edit in the context menu to launch Graphics Builder.
Make sure all the Graphic libraries are added.

3BSE 017 091R301 89


OperateIT Graphics Users Guide
Chapter 6 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.

Figure 6-3. Graphic Primitives tab

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.

Figure 6-4. Properties window

90 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 6.1.2 Adding Graphic Elements to the Graphic Display

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.

6.1.2 Adding Graphic Elements to the Graphic Display


Tank level indication, the bargraph is connected to the AO object.
10. This is done with the Element Browser. Open Element Browser in the Tools
menu. Click browse and select the A01.12 MB300AI under the Lower Tank,
Press OK.
11. The Element Browser now looks like in Figure 6-5. Select the graphic element
BargraphMV01, and click Add Element.

Figure 6-5. Lower tank level display

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.

3BSE 017 091R301 91


OperateIT Graphics Users Guide
Chapter 6 Tutorial

6.1.3 Using Logical Colors


We want a rectangle at the bottom to turn red, when fluid passes
through the valve, to indicate dangerous fluid. The fluid is measured by AO1.14
(the valve output).If the value is above 0 the rectangle will turn red and blink.
You could use logical colors to perform this function.

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.

20. Type > 0,


21. Select the Color tab. Click the drop down menu with the color groups, choose
Event Colors, then double-click UnackHighAlarm. It is a red blinking color.
A logical color reference is added to the FillColor property.
Assign color to the FrameColor and LineColor properties.

92 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 6.2 Tutorial 2, Building a Graphic Element

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.

Figure 6-6. FillColor property

Hopefully you have accomplished a similar result as in Figure 6-2. shown in the
beginning of this tutorial.

6.2 Tutorial 2, Building a Graphic Element


Graphic elements are building blocks that are used in displays and in other
elements. Graphic elements contain Visual Basic controls, ActiveX controls,
subelements and primitives. They are often reused in different Graphic displays. A
good example of a graphic element being added to a graphic display is Step 11 in
Section 6.1, Tutorial 1, Building a Graphic Display.
In this tutorial we will create a graphic element aspect and build a graphic element
(a bar) which could be added to the graphic display in the first tutorial. The end
result of this tutorial will look like this.

3BSE 017 091R301 93


OperateIT Graphics Users Guide
Chapter 6 Tutorial

Figure 6-7. Deployed bar

6.2.1 Creating a Graphic Element


1. To create a new graphic element, start from Plant Explorer. Select Object Type
Structure with the structure selector. Select a place in the structure to add the
Graphic Element to, right-click the mouse and select New Aspect.

94 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 6.2.1 Creating a Graphic Element

Figure 6-8. New Aspect

2. The New Aspect window is opened. Select Show all.


3. Select Process Graphics, Graphic element, Graphic element and name it.
4. Click Create.
5. Right-click on the created Graphic element. Select Edit, to open up the
Graphics Builder.

3BSE 017 091R301 95


OperateIT Graphics Users Guide
Chapter 6 Tutorial

Figure 6-9. Graphic Element

6.2.2 Building a Graphic Element


To build the new graphic element:
1. Click on the icon for the desired generic element. In our example, it is the
AdvantBar in the Graphic Primitives tab in the toolbox.
2. Place the cursor at any point in the Visual Basics workspace.
3. Press the left mouse button and drag the mouse to the size of choice, then
release the left mouse button.
4. The selected generic element now appears inside a bounding rectangle in the
workspace.

96 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 6.2.3 Changing Properties for the Generic Element

Figure 6-10. Graphics element (bar) in Visual Basic workspace

6.2.3 Changing Properties for the Generic Element


Properties are changed to adapt the look, in this case color and width of the graphic
element.
To change the properties BackColor and FrameWidth of the new generic element:
1. Select the Graphic primitive AdvantBar in the workspace.
2. Select the Properties Window in the View menu. The Properties window is
presented.
3. Click FrameWidth in the right column, and change the value to 2.
4. Click BackColor in the right column, and select a yellow color from the palette.

3BSE 017 091R301 97


OperateIT Graphics Users Guide
Chapter 6 Tutorial

6.2.4 Assigning Expressions to Properties


All properties can be assigned an expression. Expressions can be written directly in
the Expression Builder via the keyboard and via the tabs.To assign an expression to
a property:
1. Select the Bar in the workspace.
2. Select Expression Builder in the View menu. (If necessary: Resize/move the
Expression Builder.).

Figure 6-11. Expressions

To accomplish the expressions in Figure 6-11


1. Select property to assign an expression to, FillColor and Value for example.
Move the cursor to the right column the expression entry field
2. Select the Object Property tab and select the (Aspect) Object ..
The . represents the object which the graphic element resides on, and hence
receives its value from. Select Value - Control Connection, click Insert.

98 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 6.2.5 Testing the Graphic Element

Figure 6-12. Select Object

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.

6.2.5 Testing the Graphic Element


To test the new graphic element:
1. Select the generic element Bar in the workspace area.
2. Switch to test mode by clicking the Test Mode button on the toolbar, or choose
Test Mode in the Run menu.
3. Set the ObjectPath property by selecting an MB300AI (Aspect) Object (for
example AIC4_10).

3BSE 017 091R301 99


OperateIT Graphics Users Guide
Chapter 6 Tutorial

4. Check the behaviour of the graphic element.


5. Click on the Design Mode button on the toolbar, or choose Design Mode in the
Run menu to return to design mode.

6.2.6 Deploying a Graphic Element


To deploy the new graphic element:
1. Choose Deploy from the File menu

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.

6.3 Tutorial 3, Creating and Configuring Faceplates


We will create a property that will handle the value for the Faceplate Element.
The next step is to create a Faceplate Element, and later configure a faceplate.

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.

100 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 6.3 Tutorial 3, Creating and Configuring Faceplates

The result will look like this.

Indicator
Aspect link

Bar

Command button

T and F buttons

Figure 6-13. Faceplate

The different outcomes of clicking buttons in the Faceplate.

Table 6-1. Faceplate outcomes

Button Outcome

T A smiley icon, appears in the


top left corner.

F An F indicator appears in the


top left corner.

Command1 The bar goes to 30

3BSE 017 091R301 101


OperateIT Graphics Users Guide
Chapter 6 Tutorial

6.3.1 Creating a Faceplate Element


Before we start creating the faceplate element, we must create a test environment.
We will use a general property to be able to test the faceplate element.
Follow the steps to create a general property:
1. Mark the object where the Faceplate should reside. Right-click and select New
Aspect.
2. Mark list presentation and find General Properties, name it Props.
3. Click on Props in the Aspect list. Set the name to BarNum, select Valuetype
Real, enter the value 50. (The bar we will create should later use this value).
Click Set.
4. Set a new name to Bool, select Valuetype Boolean. (The Faceplate we will
create should later use this value). Click Set and Apply.

Figure 6-14. Select Valuetype.

102 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 6.3.1 Creating a Faceplate Element

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.

Figure 6-15. Faceplate Element1

3. Name the Faceplate Element. Faceplate Element1, press Create.


4. Click on edit, the Graphics Builder is launched.
5. The grey area represents the Faceplate Element.

Figure 6-16. Faceplate Element Area

6. Go to the Tools menu, select Graphic Libraries and mark Subelements, click
ok.

3BSE 017 091R301 103


OperateIT Graphics Users Guide
Chapter 6 Tutorial

7. Click on the Subelements tab, select Bar.


8. Create a Bar in the Faceplate Element area (the grey area).
Select the Bar and place it in the Faceplate Element area, left-click and drag to
wanted size.
9. Go the Properties area and set the property EnableInput to True.
10. Select Expression Builder in the View menu.
11. Go to the Value property, Select ObjectProperty tab, select BarNum in the
right column, then click Insert.

Figure 6-17. Insert BarNum

The Bar has been placed in the Faceplate Element area.

104 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 6.3.1 Creating a Faceplate Element

Now we will create a Button.


1. Go to the toolbox and select the General Tab, click on the CommandButton
tool.
2. Create the button, then double-click on it. (Visual Basic code is visible)
3. Implement the Command1_Click subroutine as follows.

Private Sub Command1_Click()


m_Object (Props:BarNum) = 30.0
End Sub
m_Object, in the code above, is an object proxy. It enables writing to an object. It
can be renamed, removed, and proxies for other objects can be defined.
See Chapter 4, Faceplates,Section 4.5.1, How to write to the Properties of an Object,
for more information.
4. Select Bar1 in the drop down menu above the code window to create a direct
entry window. Implement the OnMouseDown subroutine as follows.

Private Sub Bar1_OnMouseDown(ByVal button As Long, ByVal shift


As Long, ByVal xown As Single, ByVal yown
m_SessionHdlr.StartSession
Set m_DEW = autoDew
m_SessionHdlr.TriggerTimeout
End Sub
5. Select m_SessionHdlr in the drop down menu, you are in the code again.
6. Implement the m_SessionHdlr_DoApply subroutine as follows:

Private Sub m_sessionHdlr_DoApply()


TODO add right aspect and property name
m_Object (Props:BarNum) = m_Dew.GetValue
End Sub
7. Select Deploy in the File menu.
We have now created a Faceplate Element which contains a bar and a button
(command).

3BSE 017 091R301 105


OperateIT Graphics Users Guide
Chapter 6 Tutorial

6.3.2 Configuring a Faceplate


Create an indicator
1. Mark the object where the Faceplate should reside. Right-click and select New
Aspect.
2. Mark list presentation and find Faceplate, name it Faceplate1.
3. Select Faceplate1, the unconfigured Faceplate is visible.
4. Select Config view.
5. Set MaxNoOfButtonRows to 1, click Apply.
6. Select Element tab, click in the Aspect field. Select Faceplate Element1 in the
drop down list.
7. Click Apply.
8. Select Indicators tab, click in the Icons/Labels field.
9. Click on the Label/Icon field, enter F in the Label field, click Ok.
10. Click on Color field, select Priority 3, click Ok, click Add.
11. Select an icon and browse for it. Choose the FACE05.ICO from your
OperateIT\Icons library. Click Open and then Ok.
12. The labels dialog should now look like this.

Figure 6-18. The Indicator Labels Dialog

106 3BSE 017 091R301


OperateIT Graphics Users Guide
Section 6.3.2 Configuring a Faceplate

13. Click Ok.


14. Click on the Expression field, enter $'.:Props:Bool, click Ok.
15. Click on the Faceplate Pos field, enter 1, press Apply.
We have now created an indicator.

It is time to create an aspect link.


16. Click on the Aspect field, select Props in the drop down list.
17. Click on the Icon/Label field, Select Use aspect icon, Click Ok
18. Select Faceplate Pos field, enter 6.Press Apply.
An aspect link has been created.
19. Select Buttons tab
20. Click on the Label/Icon field, enter T in the Label field, click Ok.
21. Click on the Property field, select Bool in the drop down list.
22. Click on the Property Value select True in the drop down list.
23. Click on the Faceplate Pos, set it to 1
24. Click Add.
25. Configure the new button field the same as previously described but with the
following exceptions.
Set Icon/Label to F.
Set Property Value to False
Set faceplate Pos to 2.
26. Press Apply.
The Faceplate is now completely configured.

For information about using faceplates in runtime, from the operators perspective,
see Section 4.1, Using Faceplates in Runtime.

3BSE 017 091R301 107


OperateIT Graphics Users Guide
Chapter 6 Tutorial

108 3BSE 017 091R301


OperateIT Graphics Users Guide

Appendix A Standard Building Blocks

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 Primitive Elements


Primitive elements are the smallest building blocks in Graphics Builder. They are
normally a part of a graphic display. You can find the basic primitive elements in the
toolbox (see Section 3.5.1, Toolbox Window).

A.1.1 Arc
An Arc is a simple primitive element displaying a part of an ellipse.

Figure A-1. Arc

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.

3BSE 017 091R301 109


OperateIT Graphics Users Guide
Appendix A Standard Building Blocks

A.1.2 Bar
A Bar has the ability to show a vertically or a horizontally placed bargraph symbol.

Figure A-2. Bar

After creation the bounding rectangle can be manipulated to change size and
position of the Bar.

Table A-1. Frequently used Bar Properties

Name Type Default Description


MinValue FLOAT -100 Value of the bottom or left part of the bar.
MaxValue FLOAT 100 Value of the top or right part of the bar.
StartValue FLOAT 0 Starting point of the bar.
Value FLOAT 50 Value to control the bar.
ValueColorMax OLE_COLOR 00FF00 Color of the filled value part of the bar then Value
is in the interval StartValue-MaxValue.
ValueColorMin OLE_COLOR 0000FF Color of the filled value part of the bar then Value
is in the interval StartValue-MinValue.
Orientation ENUM VERTICAL The orientation of the bar. Can be VERTICAL or
HORIZONTAL.

110 3BSE 017 091R301


OperateIT Graphics Users Guide
Section A.1.2 Bar

Table A-1. Frequently used Bar Properties (Continued)

Name Type Default Description


Autodew Bool True If True and you click on the bar, a Direct Entry
Window object is created. It is returned to the
client.
Displacement Integer 0 Displacement of the Data Entry Window from the
bar. Horizontal bar gives displacement
downwards. Vertical bar gives displacement to the
right.
EnableInput Bool False Enable generation of the events: MouseUp,
MouseDown and MouseMove when clicked upon.
Visibility Bool True True is visible and False not visible.

Other properties of the primitive element Bar are:


Line Properties
Fill Properties
3D Frame Properties.

The bar primitive generates 3 different event primitives

Table A-2. Event primitives

Events Description
OnMouseDown The mouse is clicked.
OnMouseUp The mouse button is released.
OnMouseMove The mouse is moved

3BSE 017 091R301 111


OperateIT Graphics Users Guide
Appendix A Standard Building Blocks

Event signatures

Private Sub AdvantBar1_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)

Private Sub AdvantBar1_OnMouseUp(


ByVal button As Long,
ByVal shift As Long,
ByVal xown As Single,
ByVal yown As Single,
ByVal xcontainer As Single,
ByVal ycontainer As Single)

Private Sub AdvantBar1_OnMouseMove(


ByVal button As Long,
ByVal shift As Long,
ByVal xown As Single,
ByVal yown As Single,
ByVal xcontainer As Single,
ByVal ycontainer As Single)

112 3BSE 017 091R301


OperateIT Graphics Users Guide
Section A.1.3 Bezier

A.1.3 Bezier
A Bezier is like a polyline where the connecting lines are formed using the bezier
algorithm instead of straight lines.

Figure A-3. Bezier

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.

3BSE 017 091R301 113


OperateIT Graphics Users Guide
Appendix A Standard Building Blocks

A.1.4 Chord
A Chord draws a chord (a closed figure bounded by the intersection of an ellipse
and a line segment).

Figure A-4. Chord

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.

114 3BSE 017 091R301


OperateIT Graphics Users Guide
Section A.1.5 Cone

A.1.5 Cone
The Cone primitive draws a cone consisting of four vertices connected by straight
lines.

Figure A-5. Cone

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.

Table A-3. Frequently used Cone Properties

Name Type Default Description


Direction ENUM UP UP, DOWN, RIGHT or LEFT.
ConStrength INTEGER 50 Size of the cone top in percent of full width. If set
to 100, the cone top is the same size as the cone
bottom, and the cone is drawn as a pipe with flat
ends.
Visibility Bool True True is visible. False is not visible.

When using any of the shaded fill styles, the fill style will follow the direction of the cone.

3BSE 017 091R301 115


OperateIT Graphics Users Guide
Appendix A Standard Building Blocks

Other properties of the primitive element Cone are:


Line Properties
Fill Properties

A.1.6 Ellipse
An Ellipse can draw an ellipse with a frame and area fill.

Figure A-6. Ellipse

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

116 3BSE 017 091R301


OperateIT Graphics Users Guide
Section A.1.7 Hscale

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

Figure A-7. Hscale

After creation the bounding rectangle can be manipulated to change size and
position of the Hscale.

Table A-4. Frequently used Hscale Properties

Name Type Default Description


LabelFont FONT Default font Font used as labeling the scale.
from the
container
LabelFormat STRING #,# Format of the scale labels in Excel format.
MajorTics INTEGER 3 Number of major ticks.
MajorStrength INTEGER 10 The length of the major ticks.
MinorTics INTEGER 1 Number of minor ticks. The number is the amount
of minor tics between two major tics.
MinorStrength INTEGER 5 The length of the minor ticks.
LabelPosition ENUM DOWN The position of the label and ticks. Can be UP or
DOWN.
StartValue FLOAT 0 The Start Value (Lowest point on the scale).
EndValue FLOAT 100 The End Value (Highest point on the scale).
Visibility Bool True True is visible. False is not visible.

3BSE 017 091R301 117


OperateIT Graphics Users Guide
Appendix A Standard Building Blocks

Another property of the primitive element Hscale is Line Properties.

A.1.8 Limit
A Limit has the ability to show a vertically or horizontally placed limit symbol.

Table A-5. Limit

Examples LEFT RIGHT FULL

UP

DOWN

LEFT

RIGHT

118 3BSE 017 091R301


OperateIT Graphics Users Guide
Section A.1.9 Numeric

After creation the bounding rectangle can be manipulated to change size and
position of the Limit.

Table A-6. Frequently used Limit Properties

Name Type Default Description


Shape ENUM FULL Shape of the filled part of the Limit. Can be LEFT,
RIGHT or FULL.
Direction ENUM RIGHT The direction of the Limit. Can be UP, DOWN,
LEFT or RIGHT.
Visibility Bool True True is visible. False is not visible.

Other properties of the primitive element Limit are:


Line Properties
Fill Properties

A.1.9 Numeric
A Numeric has ability to show a number as a formatted text.

Figure A-8. Numeric

3BSE 017 091R301 119


OperateIT Graphics Users Guide
Appendix A Standard Building Blocks

The Comment/Tooltip is used in a special way in the primitive element Numeric.


If the formatted text STRING extends outside the borders of the available draw
area, the font will be changed to a strikethrough font and the tooltip presented will
be the full STRING. That is when the cursor is placed upon that area.
After creation the bounding rectangle can be manipulated to change size and
position of the Numeric.

Table A-7. Frequently used Numeric Properties

Name Type Default Description


Value FLOAT 0.0 The value to display.
Format STRING #,# Format of the value in Excel format.
For information on Excel format, use Microsoft
Excel 2000. In the Help menu select Microsoft
Excel Help. Type in the word format and select
Create a custom number format.
TextColor OLE_COLOR 000000 Color of the text.
Font FONT Default Font used in the text.
font from
the
container
Halign ENUM CENTER Horizontal alignment of the text inside the frame.
Can be LEFT, CENTER or RIGHT.
Valign ENUM MIDDLE Vertical alignment of the text inside the frame.
Can be TOP, MIDDLE or BOTTOM.
StrikeThrough BOOL TRUE Enable or disable the strike through facility, when
the field is exhausted.
Autodew Bool True If True and you click on the bar, a Direct Entry
Window object is created. It is returned to the
client.
DisplacementX Integer 3 Displacement of the Data Entry Window from the
numeric. See Figure A-9

120 3BSE 017 091R301


OperateIT Graphics Users Guide
Section A.1.9 Numeric

Table A-7. Frequently used Numeric Properties (Continued)

Name Type Default Description


DisplacementY Integer 5 Displacement of the Data Entry Window from the
numeric. See Figure A-9.
RightOf Bool False RightOf true or false, means that origo has two
different positions. See Figure A-9, for
information.
EnableInput Bool False Enable generation of the events: MouseUp,
MouseDown and MouseMove when clicked
upon.
NumberOfDecimals Integer -1 -1 means not valid. When format is valid it is not
overridden.
Error Bool False Error True means that ErrorCaption is displayed
instead of the normal value.
ErrorCaption String Is displayed when Error=True.
Visibility Bool True True is visible and False not visible.

RightOf = false RightOf = true

* DisplacementY
Numeric

*DisplacementY DisplacementX

Data entry window


DisplacementX
RightOf indicates the position of origo *
Figure A-9. Displacement of Data entry window

3BSE 017 091R301 121


OperateIT Graphics Users Guide
Appendix A Standard Building Blocks

Other properties of the primitive element Numeric are:


Fill Properties
3D Frame Properties.

The numeric primitive generates 3 different event primitives

Table A-8. Event primitives

Events Description
OnMouseDown The mouse is clicked.
OnMouseUp The mouse button is released.
OnMouseMove The mouse is moved

Event signatures

Private Sub AdvantNumeric1_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)

Private Sub AdvantNumeric1_OnMouseUp(


ByVal button As Long,
ByVal shift As Long,
ByVal xown As Single,
ByVal yown As Single,
ByVal xcontainer As Single,
ByVal ycontainer As Single)

Private Sub AdvantNumeric1_OnMouseMove(

122 3BSE 017 091R301


OperateIT Graphics Users Guide
Section A.1.10 ObjectTrim

ByVal button As Long,


ByVal shift As Long,
ByVal xown As Single,
ByVal yown As Single,
ByVal xcontainer As Single,
ByVal ycontainer As Single)

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.

Figure A-10. ObjectTrim

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

3BSE 017 091R301 123


OperateIT Graphics Users Guide
Appendix A Standard Building Blocks

Table A-9. Frequently used ObjectTrim Properties

Name Type Default Description


Update Rate INTEGER 1 Sample time in seconds.
GridVisible BOOL TRUE Visibility of the grid.
GridColor OLE_COLOR Color of the grid.
GridNumberV FLOAT 50 Number of vertical grid lines.
GridNumberH FLOAT 0.5 Number of horizontal grid lines.
CurveNVisible BOOL TRUE Visibility of the N:th curve.
CurveNColor OLE_COLOR Color of the N:th trend curve.
CurveNMinValue FLOAT -100 Minimum value of the trend area for the N:th
curve.
CurveNMaxValue FLOAT 100 Maximum value of the trend area for the N:th
curve.
CurveNValue FLOAT 0 Current value (input) for the N:th curve.
Visibility Bool True True is visible. False is not visible.

Other properties of the primitive element ObjectTrim are:


Fill Properties
3D Frame Properties.

124 3BSE 017 091R301


OperateIT Graphics Users Guide
Section A.1.11 Pie

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).

Figure A-11. Pie

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.

3BSE 017 091R301 125


OperateIT Graphics Users Guide
Appendix A Standard Building Blocks

A.1.12 Pipe
The Pipe draws a pipe with area fill.

Figure A-12. Pipe

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.

Table A-10. Frequently used Pipe Properties

Name Type Default Description


Orientation ENUM VERTICAL Orientation of the pipe. Can be VERTICAL or
HORIZONTAL.
TopLeftEnd ENUM FLAT Top or left end shape (depending of the direction)
of the pipe. Can be FLAT, LEFT or RIGHT.
BottomRightEnd ENUM FLAT Bottom or right end shape (depending of the
direction) of the pipe. Can be FLAT, LEFT or
RIGHT.
Visibility Bool True True is visible. False is not visible.

126 3BSE 017 091R301


OperateIT Graphics Users Guide
Section A.1.13 Polygon

When using any of the shaded fill styles, the fill style will follow the orientation of the pipe.

Other properties of the primitive element Pipe are:


Line Properties
Fill Properties

A.1.13 Polygon
A Polygon is a closed figure bounded by a line through a number of points.

Figure A-13. Polygon

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

3BSE 017 091R301 127


OperateIT Graphics Users Guide
Appendix A Standard Building Blocks

A.1.14 Polyline
A Polyline draws a line between a number of points.

Figure A-14. Polyline

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

128 3BSE 017 091R301


OperateIT Graphics Users Guide
Section A.1.15 Rectangle

A.1.15 Rectangle
A Rectangle can draw a rectangle with a frame and an area fill.

Figure A-15. Rectangle

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.

Table A-11. Frequently used Rectangle Properties

Name Type Default Description


Round INTEGER 0 Percent of rounding of the corners. 0 means a
rectangle with no rounding, 100 means fully
rounded.
Visibility Bool True True is visible. False is not visible.

Other properties of the primitive element Rectangle are:


Line Properties
Fill Properties
3D Frame Properties.

3BSE 017 091R301 129


OperateIT Graphics Users Guide
Appendix A Standard Building Blocks

A.1.16 Text
A Text has the ability to show a static text.

Figure A-16. 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.

Table A-12. Frequently used Text Properties

Name Type Default Description


Text STRING (empty) The text to display.
TextColor OLE_COLOR 000000 Color of the text.
Font FONT Default font Font used in the text.
from the
container
Visibility Bool True True is visible. False is not visible.
Halign ENUM CENTER Horizontal alignment of the text inside the frame.
Can be LEFT, CENTER or RIGHT.
Valign ENUM MIDDLE Vertical alignment of the text inside the frame.
Can be TOP, MIDDLE or BOTTOM.

130 3BSE 017 091R301


OperateIT Graphics Users Guide
Section A.1.17 Vscale

Table A-12. Frequently used Text Properties (Continued)

Name Type Default Description


StrikeThrough BOOL TRUE Enable or disable the strike through facility, when
the field is exhausted.
Visibility Bool True True is visible. False is not visible.

Other properties of the primitive element Text are:


Fill Properties
3D Frame Properties.

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

Figure A-17. Vscale

3BSE 017 091R301 131


OperateIT Graphics Users Guide
Appendix A Standard Building Blocks

After creation the bounding rectangle can be manipulated to change size and
position of the Vscale.

Table A-13. Frequently used Vscale Properties

Name Type Default Description


LabelFont FONT Default font Font used for labeling the scale.
from the
container
LabelFormat STRING #,# Format of the scale labels in Excel format.
MajorTics INTEGER 3 Number of major ticks.
MajorStrength INTEGER 10 The length of the major ticks.
MinorTics INTEGER 1 Number of minor ticks. The number is the amount
of minor tics between two major tics.
MinorStrength INTEGER 5 The length of the minor ticks.
LabelPosition ENUM LEFT The position of the label and ticks. Can be LEFT
or RIGHT.
StartValue FLOAT 0 The Start Value (Lowest point on the scale).
EndValue FLOAT 100 The End Value (Highest point on the scale).
Visibility Bool True True is visible. False is not visible.

Another property of the primitive element Vscale is Line Properties.

132 3BSE 017 091R301


OperateIT Graphics Users Guide
Section A.1.18 Aspect Link

A.1.18 Aspect Link


The Aspect link can be placed in a graphic display and used to open another aspect,
either in an overlapping window or by replacing the current aspect. Note that it will
always open an overlap from the preview area in the plant explorer, since the plant
explorer does not allow replace.
The Aspect link is based on a standard command button.

Figure A-18. Aspect Link

Table A-14. Aspect Link Properties

Name Type Default Description


Appearance Integer 1 0 = Flat, 1 = 3D (See Command Button)
Aspect String : The aspect this aspect link will open when
pressed, in human-readable form.
BackColor OLE_COLOR Default The Background color of the aspect link.
background (See Command Button)
Caption String Aspect Link The text displayed by the aspect link.
(See Command Button)
DisabledPicture Picture - The picture displayed by the aspect link when
enabled is false. (See Command Button)
DownPicture Picture - The picture displayed by the aspect link when it
is pressed. (See Command Button)

3BSE 017 091R301 133


OperateIT Graphics Users Guide
Appendix A Standard Building Blocks

Table A-14. Aspect Link Properties (Continued)

Name Type Default Description


Font Font MS Sans The Font used to display the Caption property.
Serif (See Command Button)
ForeColor OLE_COLOR Black Currently not used.
Presentation Integer Overlap Overlap, Base or Replace mode presentation of
Mode the selected aspect.

Picture Picture - The picture displayed by the aspect link.

The table contains custom made properties, plus a few of the most useful properties
for a standard command button.

A.2 Event Tunnel Control


There are situations when you click within a graphic element or display when you
may not see the context menu (right-click), or mat not be able to bring up the default
aspect (left-click), or see any object marking around a graphic element.
The reason is that it is not possible to click through some of the controls used in
the graphic element. Examples: Standard Visual Basic and 3rd party ActiveX
controls. Primitive elements described in appendix A, do not have this problem.
If You are obliged to use other elements than the ones in appendix A, the methods
described below are useful.
Recommended steps:
1. Use click transparent element because mouse events are automatically
passed to its container object. For example ABB Primitives.
This way you avoid any problems.
2. Visual Basic code is needed.
ActiveX controls normally requires that events are handled in Visual Basic
code. You have to add code to, for instance, the mouse events, see example
below.
3. Event Tunnel control is needed.

134 3BSE 017 091R301


OperateIT Graphics Users Guide
Section A.3 Primitive Element Properties

Event Tunnel control


To solve the problem the configurator can place Event Tunnel controls, to cover,
and in turn enable mouse-clicks to tunnel through to the standard input handling.
The point is to be able to tunnel the click through the labels.
The EventTunnel control marks the area for which all Mouse events will be
captured and forwarded to the container object: graphic element or display.
Visual Basic code
Note: For some controls that have suitable events, Visual Basic code can solve the
problem.
Sometimes controls that ought to be transparent for mouse-event, can be altered to
be transparent via Visual Basic code. Tunnel control is a last alternative solution.
Example: Code in Visual Basic when standard Label control is used.
....
Label1_MouseMove(...)
m_InputMgmt.MouseMove Me, Button, Shift
End Sub

Label1.Click(..)
If Button=VBLeftButton Then
m_inputMgmt.ShowDefaultAspect Me
Else If
m_imputMgmt.ShowContextMenu Me
End If
End Sub

A.3 Primitive Element Properties


All primitive elements can be assigned properties. The properties affect how the
graphic element will appear. You change the properties from the Properties window
(see Section 3.15, Properties Window).

3BSE 017 091R301 135


OperateIT Graphics Users Guide
Appendix A Standard Building Blocks

A.3.1 Line Properties


All lines drawn in the primitive elements are controlled by the Line Width, Line
Color and Line Style.

Table A-15. Line Properties

Name Type Default Description


LineWidth INTEGER 1 Width in pixels of the drawn line. Valid values are
any positive integer.
LineColor COLOR 000000 Color of the line.
LineStyle ENUM SOLID Style of the line. See Section A.3.1.1, Line Styles
below.

Fill properties applies to the primitive elements Arc, Bezier, Chord, Cone,
Ellipse, Hscale, Limit, ObjectTrim, Pie, Pipe, Polygon, Polyline, Rectangle and
Vscale.

A.3.1.1 Line Styles


The LineStyle property specifies the style of the line.

Table A-16. Line Styles

Value Enum Sample


0 SOLID

1 DASH

2 DOT

3 DASHDOT

4 DASHDOTDOT

136 3BSE 017 091R301


OperateIT Graphics Users Guide
Section A.3.2 Fill Properties

Remark: Solid lines can be any width. Any other style uses a line width of 1 no
matter of the value in LineWidth.

A.3.2 Fill Properties


Numerous numbers of the primitive elements are area filled. The filling is
controlled by FillColor, FillStyle and FillColor2. The FillStyle2 is effective when
one of the hatched or shading patterns is used. The FillStyle property specifies how
the area fill would appear.

Table A-17. Fill Properties

Name Type Default Description


FillColor COLOR BFBFBF Color of the area fill.
FillStyle ENUM SOLID See Section A.3.2.1, Fill Styles below.
FillColor2 COLOR 7F7F7F Second color of the rectangle if FillStyle is set to
any of the hatched or shading methods.
FillStyle2 ENUM OPAQUE Mode of the background if any of the hatched
patterns are used. Can be OPAQUE or
TRANSPARENT.

Fill properties applies to the primitive elements Chord, Limit, Pie and Polygon.

3BSE 017 091R301 137


OperateIT Graphics Users Guide
Appendix A Standard Building Blocks

A.3.2.1 Fill Styles


The FillStyle property specifies how the area fill would appear.

Table A-18. Fill Styles

Value Enum Sample


0 SOLID

1 TRANSPARENT

2 BDIAGONAL

3 CROSS

4 DIACROSS

5 FDIAGONAL

138 3BSE 017 091R301


OperateIT Graphics Users Guide
Section A.3.3 Fill Properties with Shade

Table A-18. Fill Styles (Continued)

Value Enum Sample


6 HORIZONTAL

7 VERTICAL

A.3.3 Fill Properties with Shade


Numerous numbers of the primitive elements are area filled. The filling is
controlled by FillColor, FillStyle and in case of shading also by FillColor2 and
Granularity. The FillStyle2 is effective when one of the hatched patterns is used.
The FillStyle property specifies how the area fill would appear.

Table A-19. Fill Properties

Name Type Default Description


FillColor COLOR BFBFBF Color of the area fill.
FillStyle ENUM SOLID See Section A.3.3.1, Fill Styles below.
FillColor2 COLOR 7F7F7F Second color of the rectangle if FillStyle is set to
any of the hatched or shading methods.
FillStyle2 ENUM OPAQUE Mode of the background if any of the hatched
patterns are used. Can be OPAQUE or
TRANSPARENT.
Granularity INTEGER 50 Granularity of the shading.

Fill properties with shade applies to the primitive elements, Cone, Ellipse,
Numeric, Pipe, Rectangle, Text and ObjectTrim.

3BSE 017 091R301 139


OperateIT Graphics Users Guide
Appendix A Standard Building Blocks

A.3.3.1 Fill Styles


The FillStyle property specifies how the area fill would appear.

Table A-20. Fill Styles

Value Enum Sample


0 SOLID

1 TRANSPARENT

2 BDIAGONAL

3 CROSS

4 DIACROSS

5 FDIAGONAL

140 3BSE 017 091R301


OperateIT Graphics Users Guide
Section A.3.3 Fill Properties with Shade

Table A-20. Fill Styles (Continued)

Value Enum Sample


6 HORIZONTAL

7 VERTICAL

8 VERTICAL
SHADE

9 HORIZONTAL
SHADE

10 VERTICAL
3DSHADE

11 HORIZONTAL
3DSHADE

3BSE 017 091R301 141


OperateIT Graphics Users Guide
Appendix A Standard Building Blocks

A.3.4 3D Frame Properties


All rectangle shaped primitive elements have the ability to show a 3D frame around
the element. The 3D frame is controlled by FrameWidth, FrameColor, FrameColor2
and 3D-Effect.

Table A-21. 3D Frame Properties

Name Type Default Description


FrameWidth INTEGER 1 Width of the 3D frame.
FrameColor COLOR DFDFDF Color of the left-top part of the 3D frame.
FrameColor2 COLOR 7F7F7F Color of the right-bottom part of the
3D frame.
3D-Effect ENUM RAISED 3D effect of the frame. See Section A.3.4.1, 3D
Effect below.

3D Frame properties applies to the primitive elements, Numeric, ObjectTrim,


Rectangle and Text.

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

Figure A-19. 3D-Effect Property (Raised/Sunken)

142 3BSE 017 091R301


OperateIT Graphics Users Guide
Section A.3.5 Smooth

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.

A.3.6 Angle Properties


The primitive elements Arc, Chord and Pie have round handles at the start and end
points.

Figure A-20. Primitive Elements with Angle Properties

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.

3BSE 017 091R301 143


OperateIT Graphics Users Guide
Appendix A Standard Building Blocks

Table A-22. Angle Properties

Name Type Default Description


StartAngle INTEGER 225 Starting angle (0-359) of the arc. 0 is positioned at
3 oclock.
StopAngle INTEGER 135 Stop angle (0-359) of the arc. If StartAngle and
StopAngle are equal a full ellipse is drawn.

Angle properties applies to the primitive elements Arc, Chord and Pie.

A.3.7 Point Properties


Some of the primitive elements are defined by a number of connected points.
Point properties applies to the primitive elements Bezier, Polygon and Polyline.

A.3.7.1 To Add a New Point


To add a new point:
1. Move the cursor to a line between two points. The cursor changes to a
crosshair (+).
2. Press Shift + left mouse button. The new point is added.

Figure A-21. Adding a New Point

144 3BSE 017 091R301


OperateIT Graphics Users Guide
Section A.3.7 Point Properties

A.3.7.2 To Delete a Point


To delete a point:
1. Move the cursor to the point. The cursor changes to AllsizeArrow.
2. Press Ctrl + left mouse button. The point is deleted.

Figure A-22. Deleting a Point

A.3.7.3 To Move a Point


To move a point:
1. Move the cursor to the point. The cursor changes to AllsizeArrow.
2. Press left mouse button and drag. The point is moved.

Figure A-23. Moving a Point

3BSE 017 091R301 145


OperateIT Graphics Users Guide
Appendix A Standard Building Blocks

A.4 ABB Subelements


These are basic subelements developed by ABB. They are building blocks in
Graphics Builder. You can find the subelements provided by ABB in the toolbox
(see Section 3.5.1, Toolbox Window).

A.4.1 Bar
A Bar has the ability to show a bar with two hatched limit areas or four limit
markers.

Figure A-24. Bar

After creation the bounding rectangle can be manipulated to change size and
position of the Bar.

Table A-23. Bar Properties

Property Name Default Remarks


Style FourLimits FourLimits or TwoLimits
Orientation Vertical Bar orientation, Vertical or Horizontal
Value 50 Value level

146 3BSE 017 091R301


OperateIT Graphics Users Guide
Section A.4.1 Bar

Table A-23. Bar Properties (Continued)

Property Name Default Remarks


StartValue 0 Start position of value in the bar
RangeMax 100 Top value of the bar
RangeMin 0 Bottom value of the bar
ValueColor Green Color of bar and question mark
ValueColorNeg Blue Color of bar when value is below Start
Value
BackColor Black Background color of the bar
Error False True: ErrorCaption is shown. The bar is
hidden. False: The bar is shown
ErrorCaption ? Indication for Error presentation
Font Arial 12 Bold Font used for ErrorCaption mark
HighLimit2 85 Alarm limit high marker placement
HighLimit2Fill Transparent Solid or Transparent
HighLimit2Color Grey Color of the limit and filling
HighLimit2Visible True Controls visibility, True or False
HighLimit1 75 Warning limit high marker placement
HighLimit1Fill Transparent Solid or Transparent
HighLimit1Color Grey Color of the limit and filling
HighLimit1Visible True Controls visibility, True or False
LowLimit1 25 Warning limit low marker placement
LowLimit1Fill Transparent Solid or Transparent
LowLimit1Color Grey Color of the limit and filling
LowLimit1Visible True Controls visibility, True or False
LowLimit2 15 Alarm limit low marker placement

3BSE 017 091R301 147


OperateIT Graphics Users Guide
Appendix A Standard Building Blocks

Table A-23. Bar Properties (Continued)

Property Name Default Remarks


LowLimit2Fill Transparent Solid or Transparent
LowLimit2Color Grey Color of the limit and filling
LowLimit2Visible True Controls visibility, True or False
FrameStyle Sunken Raised or Sunken
FrameWidth 1
FrameWidth2 Defines how far outside the bar the limit
object reaches.
EnableInput False Enable generation of the events:
MouseUp, MouseDown and
MouseMove when clicked upon.
Visibility True True is visible and False not visible.
Displacement 0 Displacement of the Data Entry window
from the bar.

The Bar subelement generates 3 different event subelements

Table A-24. Event primitives

Events Description
OnMouseDown The mouse is clicked.
OnMouseUp The mouse button is released.
OnMouseMove The mouse is moved

148 3BSE 017 091R301


OperateIT Graphics Users Guide
Section A.4.1 Bar

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)

A.4.1.1 Bar Styles


The subelement Bar can have two hatched limit areas or four limit markers.

HighLimit2

HighLimit1

?
Value

LowLimit1

LowLimit2

Figure A-25. Bar Styles

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.

3BSE 017 091R301 149


OperateIT Graphics Users Guide
Appendix A Standard Building Blocks

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.

Table A-25. Default Property Values for Bar Styles

Property Name FourLimits TwoLimits


Field1Visible True True
Orientation Vertical Vertical
Value 50 50
StartValue 0 0
RangeMax 100 100
RangeMin 0 0
ValueColor Green Green
ValueColorNeg Blue Blue
BackColor Black Black
Error False False
ErrorCaption ? ?
Font Arial 10 Bold Arial 10 Bold

150 3BSE 017 091R301


OperateIT Graphics Users Guide
Section A.4.1 Bar

Table A-25. Default Property Values for Bar Styles (Continued)

Property Name FourLimits TwoLimits


HighLimit2 85
HighLimit2Fill Transparent

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

FrameStyle Sunken Sunken


FrameWidth 1 1

3BSE 017 091R301 151


OperateIT Graphics Users Guide
Appendix A Standard Building Blocks

152 3BSE 017 091R301


OperateIT Graphics Users Guide
Section B.1 Introduction

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

3BSE 017 091R301 153


OperateIT Graphics Users Guide
Appendix B Expressions

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.

154 3BSE 017 091R301


OperateIT Graphics Users Guide
Section B.3 Object Properties

B.3 Object Properties

B.3.1 Syntax for Object Properties


The syntax for an object property reference has the following general formats:
<object reference>:<aspect reference>:<property reference>
Object ref
The Object ref part can either be a relative or an absolute reference to an object.
See Section B.7, Object References for more information and examples.
Aspect Ref
Aspect Ref is the name of the aspect.
PropertyRef
The property ref part is the name of a property in relation to an aspect.
Simple properties: Only contains a single name such as Value.
Structured propertiescontains a sequence of names, separated by periods.
Examples:
Limits.high
Limits.low

B.4 Object Path


Graphic aspects created from any aspect category except Subelement have an
ObjectPath, which is shown in the Property window in the Graphics Builder.
If the ObjectPath contains a relative reference, it starts with .
The ObjectPath property does not show the entire definition of the object reference
for lack of space in the property field.
If the ObjectPath contains an absolute reference, the name of the referenced object
is displayed.

3BSE 017 091R301 155


OperateIT Graphics Users Guide
Appendix B Expressions

B.4.1 Property Reference in Faceplates


The syntax for object property reference in faceplates is:
$Object:aspect:property.
The expression:
AI.117:Control Connection:VALUE*14.2
would look like this in Faceplate syntax:
$AI.117:Control Connection:VALUE*14.2

Logical colors and expression variables assigned in the Expression Builder do not
function in Faceplates.

B.5 Logical Colors


See Section 3.6.4, Using Logical Colors for basic information.

B.5.1 Enable/Disable Blinking Colors


The following example describes how to enable/disable blinking colors.
Blinking logical colors can be accessed from Expressions.The following is an
example of this.
(Bar.Color = ) iif(.:IsAlarm,
unackHighAlarm,
measure)
The effect of the previous expression is that the color of the bar blinks when the
object is IsAlarm, and shows steady state color measure, when the object is not.
Note that the expression is executed anytime the color (blink color) changes.
Therefore, blink colors should be used with care as they might cause high CPU load.
The configurator of a graphic element can reduce total CPU load caused by blinking
by adding the following expression to the EnableBlink property of the
Subscription Control.

(m_sc.EnableBlink=) .:IsAlarm)

156 3BSE 017 091R301


OperateIT Graphics Users Guide
Section B.5.1 Enable/Disable Blinking Colors

Open the Properties window in Visual Basic, select m_sc PgSubscriptionControl


in the drop down box at the top.
Open Expression Builder and edit the Expression entry field via Object property
tab, for the property EnableBlink.

Figure B-1. Enable blinking colors

3BSE 017 091R301 157


OperateIT Graphics Users Guide
Appendix B Expressions

B.6 Subscription Control

B.6.1 Event
The subscription control generates the events described in Table B-1.

Table B-1. Events on subscription control

Event Description

OnSubscriptionChange This event is triggered at the invocation of the


graphic/element. It is invoked late enough for
current object and other properties of the
element to have defined values. It is invoked
before any expressions are called
The method is also called after any assignment
to the ObjectPath property
OnPreDataChange Executes any time just before expressions are
executed
OnPostDataChange Executes any time after expressions are exe-
cuted

158 3BSE 017 091R301


OperateIT Graphics Users Guide
Section B.6.2 Property

B.6.2 Property
Table B-2. Properties of subscription control

Property Description

EnableBlink By setting EnableBlink to false it stops exe-


cuting expressions, as a result of blink color
changes. To reduce CPU load, EnableBlink
should be set to false, for an element that can
not blink.
GeneralBackColor For graphic display, the background color of
the graphic display.
For graphic element, the default value of the
BackgroundColor property, of the graphic
element.
UpdateRate The rate by which the graphic element sub-
scribes for cyclic data. The default value = 0,
which means that the update rate is determined
by the control connection aspect. The unit is
milliseconds.

3BSE 017 091R301 159


OperateIT Graphics Users Guide
Appendix B Expressions

B.6.3 Method
Table B-3. Methods of subscription control

Property Description

GetInvocationObjectId A method which returns the AfwObjectID


of the object, which is presented by the
graphic aspect.
GetInvocationObject A method which returns the AbbObject
which represents the aspect object, which is
presented by the graphic aspect.

ReportError This method can be called to report errors that


occur during the execution of Visual Basic
code.
ExecuteExpressions Can be called to force execution of all expres-
sions of the graphic aspect.

B.7 Object References


Object references are specified with an object path.
The syntax of an object reference can be the following.

ObjectPath Absolute object reference


./ObjectPath Relative object reference
Examples
Relative reference
.
./Level
./Tank/Level
Absolute reference
Reactor/Temp
AI.117

160 3BSE 017 091R301


OperateIT Graphics Users Guide
Section B.7.1 Relative and Absolute References

B.7.1 Relative and Absolute References


Relative references are used.
1. In the Object Type Structure, because a graphic aspect in an object type must
function for all instances of the object type.
2. In concrete structures, which simplify copying of a graphic aspect from one
position to another with a similar environment.

Absolute references are used


1. In concrete structures, for example Functional and Location Structure.
Concrete, strictly means all structures except Object Type Structure.
You can change details about the object reference. Example: It is possible to change
the reference to a different object.

B.7.2 Relative References.


Every graphic aspect is invoked for a certain object, the invocation object.
Relative references within the element are relative to the invocation object,
sometimes called current object.
The object path syntax may contain explicit specifications of name category
{NameCategory} and structure category [StructCategory].

B.7.3 Absolute References


You can create references to objects that are not yet created, they are entered and
saved as name paths. This is an unresolved reference. A name reference can later be
resolved when the object has been created.
Resolved absolute references (the object is found) are saved with unique identities.
In addition, a rescue information is saved to support automatic or manual
reconnect, in case the unique reference is broken. A broken reference means that
the unique reference does not match any objects in the system.
Broken references can be resolved again by re-deploying the graphic.

3BSE 017 091R301 161


OperateIT Graphics Users Guide
Appendix B Expressions

B.8 Quality attributes of Object Properties


Expressions can access quality information about object properties. To select quality
information, use the dropdown list in Expression Builder. It contains object property
quality attributes.

Figure B-2. Quality attributes

Table B-4. Quality attributes

Attributes Description
Value The value for the object
property is returned.
Initialized False until first data received
from OPC.

QualityOk False if data has not been


received, or is not good for
any reason.

162 3BSE 017 091R301


OperateIT Graphics Users Guide
Section B.8.1 Handling Bad Data

Table B-4. Quality attributes (Continued)

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.

B.8.1 Handling Bad Data


Handling bad data, method 1
The configurator of an object aware graphic element will often use expressions to
explicitly define the presentation of an element when the data driving it is not good.
It may look like the following:

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

3BSE 017 091R301 163


OperateIT Graphics Users Guide
Appendix B Expressions

Another possibility exists as vtEmpty is treated as a null value when assigned


to a non Variant variable/property. Specifically for a boolean, a vtEmpty is
assigned as false.
As a result, when using conditional expressions (expressions containing (nested)
iifs), the result will always evaluate to the last else branch when data is not good.

164 3BSE 017 091R301


OperateIT Graphics Users Guide
Section C.1 Default Faceplate Element

Appendix C Sizes of Faceplates

To be able to group the Faceplates together in later versions of OperateIT it is


strongly recommended that these guidelines are followed.
The appendix is written to assist the Faceplate Element builders in their work and to
explain what happens when a Faceplate does not behave as expected.
All sizes are measured in pixel units unless noted otherwise.

C.1 Default Faceplate Element


To fit into a normal Faceplate a Faceplate Element should have default size
according to the table below.

Table C-1. Faceplate Element size

Height Width
Pixels 220 250
Twips 3300 3750

The ratio between Height and Width will then be 0.88

C.2 Default Faceplate


A Faceplate should have default size according to the table below:.

Table C-2. Faceplate size

Height Width
Pixels 400 250

In later versions of OperateIT, when Faceplates can be grouped together, Faceplates


must have the same size to fit in the group display.

3BSE 017 091R301 165


OperateIT Graphics Users Guide
Appendix C Sizes of Faceplates

C.2.1 Sizes of each default component in a Faceplate


A normal Faceplate has a default configuration, which holds:
A default sized header
A status and navigation bar with 1 row and 6 positions
A Faceplate element area
A button area with 2 rows and 6 buttons per row
The sizes of these are summed in the table below. Note that the width is not summed
since all components reside in the same space width.

Table C-3.

Component Height Width


Header 46 250
Status and Navigation 46 249
Element 220 250
Buttons 87 249
Sum 399 250

C.3 Non-default Faceplate


Any view of the Faceplate can have almost any size. (The normal Faceplate view
should have a height of 400 pixels and a width of 250 pixels.) There is a minimum
size allowed in a Faceplate that is a single header with the width of three buttons.
That gives a minimum height of 46 pixels and a minimum width of 126 pixels.

C.3.1 Size of Each Part of the Components


Each part of a component (for example an aspect link in the Status and Navigation
bar) has a more or less fixed size. To best fit in the Faceplate Element, calculate the
size it should have according to the rules below.

166 3BSE 017 091R301


OperateIT Graphics Users Guide
Section C.3.1 Size of Each Part of the Components

Table C-4. Component size

Component Part No Height Width


Header 46 -
Status and First 46 44
Navigation
Following 41 41
Element Tab row 24 -
Element - -
Buttons First 46 44
Following 41 41

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.2 Status-, Navigation bar and Buttons


Indicators, Aspect links and buttons have all the same size that is 38x38 pixels. The
space between the "buttons" is 3 pixels wide and high and the bottom horizontal line
is 2 pixels high. So, the first "button" is 3+38+3 (=44) pixels wide and 3+38+3+2
(=46) pixels high and the following are 3+38 (=41) pixels wide and high.
The sum of 6 indicators (and/or Aspect links) on one row is 44+5*41 (=249) pixels
wide and 46 pixels high.
The sum of 6 buttons (on one row) times 2 rows is 44+5*41 (=249) pixels wide and
46+41 (=87) pixels high.

3BSE 017 091R301 167


OperateIT Graphics Users Guide
Appendix C Sizes of Faceplates

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:

Table C-5. Example faceplate content

Component Reduced Normal


Header 1 1
MaxNoOfIndicatorRows 0 2
MaxNoOfIndicatorsPerRow 0 5
MaxNoOfButtonRows 1 2
MaxNoOfButtonPerRow 4 5
Elements 1 1

168 3BSE 017 091R301


OperateIT Graphics Users Guide
Section C.3.2 Example

We also want the views to have these sizes:

Table C-6. Size of views

View Height Width


Reduced 150 To fit 4 buttons
Normal 400 250

Calculation gives these sizes per component in each view:

Table C-7. Sizes per component in each view

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

3BSE 017 091R301 169


OperateIT Graphics Users Guide
Appendix C Sizes of Faceplates

170 3BSE 017 091R301


OperateIT Graphics Users Guide
Section D.1 Create a New Aspect Category

Appendix D Create New Aspect Categories with


Templates

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.

D.1 Create a New Aspect Category


1. Select the Aspect System Structure in Plant Explorer.
2. Go to Process Graphics and right-click one of the two aspect types, Graphic
Display or Graphic Element. A drop down box appears, select Aspect Type
Definition.

Figure D-1. Aspect type definition

The Aspect Type Definition window is opened.


3. Click on the Categories tab, click the Add button and enter a category name,
we entered Loram Display. Close the dialog.

3BSE 017 091R301 171


OperateIT Graphics Users Guide
Appendix D Create New Aspect Categories with Templates

The Graphic Display aspect type now contains your aspect category, in this case
Loram Display.

Figure D-2. New aspect type

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.

172 3BSE 017 091R301


OperateIT Graphics Users Guide

Appendix E Adding Members

Adding member is applicable for subelements only.


The Add Member feature is accessed through the Tools menu. It allows you to add
members to graphics. Member is a collective name for property, method, and
event. The member is added to the entire graphic and not to any of its single
elements.
You can find more details about adding properties, methods and events in the Visual
Basics On-line Help file.

E.1 Add Member Window


Open the Add Member window by choosing Add Member in the Tools menu.

Figure 5-1. Add Member Window

3BSE 017 091R301 173


OperateIT Graphics Users Guide
Appendix E Adding Members

The main objectives of the Add Member window are:


Adding methods and events. Section E.2, Adding Methods/Events.
Adding properties. Section E.3, Adding Properties.

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).

Figure 5-2. Add Member Dialog box

Do not try to add two or more members with the same name. Doing so will cause a
deploy failure.

174 3BSE 017 091R301


OperateIT Graphics Users Guide
Section E.1 Add Member Window

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.

3BSE 017 091R301 175


OperateIT Graphics Users Guide
Appendix E Adding Members

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.

E.2 Adding Methods/Events


To add methods and events you follow the steps below.
1. Click the Add Member button in the Add Member window.
2. Enter an appropriate name.
3. Select type: Method or Event. You can only do one at a time.
4. Enter an argument if required.
5. Click OK. The member is now added to the member list. You can only see the
member(s) you are currently working with. Other members, that may have
been added earlier, you can find in the code.

E.3 Adding Properties


To add properties you follow the steps below.
1. Click the Add Member button in the Add Member window
2. Enter an appropriate name.
3. Select type: Property.
4. Enter/select data type, default value, runtime behavior, design time behavior in
the Attributes Information fields.
5. Click OK. The member is now added to the list in the Properties field. You can
only see the member(s) you are currently working with. Other members, that
may have been added earlier, you can find in the code.

176 3BSE 017 091R301


OperateIT Graphics Users Guide
Index

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

3BSE 017 091R301 177


OperateIT Graphics Users Guide
Index

status and navigation bar 62 Graphics builder options


view selection buttons 64 advanced user mode 19
write to properties of an object 76 debug 20
faceplate element browser 20
bar 56 expression builder 20
Faceplate element area 62 live data in design mode 19
Faceplate elements 17
Faceplate framework configuration I
buttons tab 73 Import 48
elements tab 75 Import all 48
Faceplate in runtime 55 Import aspects 47
Faceplate session handler 80 Import/export tool 47
Faceplate size 165 Init 81
Faceplate view 64
Faceplates 17 L
FAQ 85 Label/Icons dialog 71
Frequently asked questions (FAQ) 85 Logical color 42
Logical colors 34
G
Generic elements 20 M
select 23 m_SessionHdlr 105
Graphic aspect categories Maintenace
differences 17 frequently asked questions 85
Graphic aspects Maintenance 85
Background color 42 Member 173
deleting 47 Member types
deploying 47 event 175
Graphic display 17 method 175
Graphic element 17 property 175
building 96
Graphic elements
O
assigning an expression to a property 98
Object list 36
saving 47
autopopulate 39
testing 45
populate 38
Graphic libraries 24 to 25
Object lock 56
Graphics
Object proxy 77
product overview 3
Object proxy name 38
Graphics builder
Object reference dialog 37
Generic elements 20
out 67
setting options 18

178 3BSE 017 091R301


OperateIT Graphics Users Guide
Index

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

3BSE 017 091R301 179


OperateIT Graphics Users Guide
Index

U
Update rate 45

V
Visual Basic error handling 80

W
Write property 76

180 3BSE 017 091R301


3BSE 017 091R301
February 2001

S-ar putea să vă placă și