Q000083 SW GL 0001

You might also like

Download as pdf or txt
Download as pdf or txt
You are on page 1of 87

Copyright ABB AS. All rights reserved.

REUSE Guidelines
HMI Library Programming

Doc. kind

Guideline

Title

REUSE HMI Library Programming


Guidelines

ABB AS

Resp.

Project

dept.

REUSE

PAOG/AKE

Approved

Document identity

Lang.

Q000083-SW-GL-0001

en

Rev. ind. Sheet

No. of sh.

1
87

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

2 (87)

Content
1. Introduction.................................................................................................... 3
1.1
Purpose .................................................................................................. 3
1.2
VB graphics............................................................................................. 3
1.3
Abbreviations and definitions................................................................... 3
2.

Create new Object Type ................................................................................ 4

3. HMI in General................................................................................................ 5
3.1
Alarm and Event lists in General ............................................................. 6
4. Traditional Visual Basic programming......................................................... 7
4.1
Naming ................................................................................................... 7
4.2
Font in VB ............................................................................................... 8
4.3
Graphic Elements in VB .......................................................................... 9
4.4
Graphic Elements Details...................................................................... 10
4.5
Faceplates in VB ................................................................................... 15
4.6
Faceplate Details in VB ......................................................................... 16
4.7
Status rectangles in VB ......................................................................... 20
4.8
Not Available......................................................................................... 20
4.9
Indication Letters in VB ......................................................................... 21
4.10
Indication Letters when Hiding .............................................................. 22
4.11
Code in VB............................................................................................ 24
4.12
Comments............................................................................................. 24
4.13
Property settings ................................................................................... 25
4.14
Error handling ....................................................................................... 25
4.15
Presentation details............................................................................... 26
5. Process Graphics programming................................................................. 30
5.1
Naming ................................................................................................. 30
5.2
Colors in PG.......................................................................................... 31
5.3
Font in PG............................................................................................. 32
5.4
PG Graphic Elements ........................................................................... 33
5.5
Graphic Elements Details...................................................................... 34
5.6
Use of Views ......................................................................................... 46
5.7
Resize PG elements ............................................................................. 46
5.8
PG Faceplates ...................................................................................... 47
5.9
Indication Letters in PG ......................................................................... 68
5.10
General Alarm Indication....................................................................... 69
5.11
Indication Letters for Inactive Unacknowledged Alarms......................... 69
5.12
Indication Letters when Disabling Alarm................................................ 70
5.13
Presentation details............................................................................... 74
5.14
Revision History in PG .......................................................................... 76
6.

References ................................................................................................... 77

7.

Revisions...................................................................................................... 78

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

3 (87)

1. Introduction
This document describes the HMI Programming Guidelines that ABB has agreed to use for
development of the graphic elements and faceplates within the OGP REUSE Solutions.
The chapter Traditional Visual Basic programming shows the details for the Visual Basic
elements. The chapter Process Graphic Editor programming shows the details for the Process
Graphic Editor elements.
For more details about the FB Programming Guidelines, see ref. [Re4].
1.1 Purpose
The Guidelines that are given in this document shall be used as a reference when creating new
or editing existing graphic elements and faceplates within REUSE Object Types since these must
have unified functionality and design. Names of the Libraries, Object Types, Graphic Elements,
Faceplates, variables and so on shall be used in a consistent way. The HMI must also be
consistent in such way that the users feel secure about what will actually happen when they
select a specific action.
1.2 VB graphics
Since the OGP REUSE Solutions first were created for the Grane project, which had no
Guidelines, some VB-code exists in existing graphic elements and faceplates that do not
correspond to these Guidelines. OGP REUSE Solutions has despite this as intension to follow
these Guidelines for all new Object Types and for changes in existing types.
1.3 Abbreviations and definitions
The Table 1.1 contains the abbreviations and definitions that are used in this document:
Term
CMT
EDMS
FE
GE
HMI
OGP
OPC
PCS
PG
PGE
PSD
REUSE Solutions
team
SAS
SCD
VB

Description
Control Module Type
Electronic Document Management System, for handling and
storing different document revisions
Faceplate Element
Graphic Element
Human Machine Interface
Oil Gas Petrochemicals
OLE for Processing Control
Process Control System
Process Graphic (made in the PGE)
Process Graphics Editor
Process Shutdown
Standardization team within ABB AS, Process Industries
Division
Safety and Automation System
System Control Diagram
Visual Basic
Table 1.1 - Abbreviations and definitions

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

4 (87)

2. Create new Object Type


-

Always consider the name of the Object Type. It must be relevant for the use, for instance:
SBV = Switching Binary Valve
This name syntax is defined in the NORSOK-SCD I-005 standard. However, there are some
exceptions; this name syntax is not used in e.g. interface libraries or REUSEfg library.

When a new Object Type is created, the name must follow the syntax
<Abbreviation>_<Specification>Type, example
SBV_ValveType

Always consider placement of the new Object: should it be inserted in an existing library or
must a new library be created?

When should a new library be created?


1) Is the Object Type for a specific interface like Minerva, Autronica, or Sicam? then
the type should be in a specific library
2) Is it a general object? then it should be created in a general library, as for instance
REUSEcommon or REUSEfg

When a new library needs to be created, the name must follow the syntax
REUSE <Specification>Lib, example
REUSESicamLib

Everything that belongs together must be stored in the same library: Project Constants, Data
types and similar Object Types

Consider if the new Object Type should have Instantiate as Aspect Object flag set
1)
Should the CM have some HMI graphics? - Set flag
2)
Should the CM be in a consequence analyze with Bulk Data Manager? - Set flag

It is better to create a new library than to insert too many types in one library

Thumb rule: Maximum 10 types in the same library

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

5 (87)

3. HMI in General
-

New Graphic Elements and Faceplate Elements should be created through making a copy
of existing accepted and tested elements. Note: When copying an element from one library to
another the Key has to be reconnected.

To make sure that the Graphical layout becomes as consistent as possible you should in the
first place use MA and SBV as template when creating new elements. The elements must be
named according to the naming rules, see Chapter 2.

For all Windows Settings that should be used to get the correct HMI appearance, see
document ref. [Re3].

All Faceplate elements should, as far as possible, have a solid repeated status area on the
left side. This area should be equal for all elements in the same Faceplate with exception of
Trend and other special solutions. The right side of the Faceplate element should be used for
operator choices with push buttons, text boxes and indications of the choices.

The VB-elements must not be resized. To avoid this there are two recommended predefined
Screen Size settings, see ref. [Re6]. The PG-elements are built in Vector Graphics and are
more dynamic, but in general we recommend also avoid resizing of the PG-elements.

Everything in HMI must be aligned horizontally and vertically

All texts always with NLS to support different languages

Make sure the text is not too long for the actual space in the Graphics. Check that the space
is enough for all languages. Also make sure if a text is configurable, that the space is enough
for all possible configuration options.

Norwegian Correct Writing capital letters only in the first word and in names

Synchronize texts in Faceplates and Graphic Elements with the texts in Alarm/ Event lists

Use NLS texts consequent, do not mix similar words, example: Trip, Fault and Error

Avoid abbreviations if possible

All abbreviations in Faceplates, Graphic Elements, Alarm/Event lists must be done according
to Appendix B and Appendix C

Units should be according to the SI-units, see Appendix D

VB Graphics supports only Category Based alarm handling

PG Graphics supports both Category Based and Priority Based alarm handling

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

6 (87)

3.1 Alarm and Event lists in General

Figure 3.1 - Event list example


-

Alarm Texts max 30 characters

Event Texts max 40 characters

Capital letter only in first word and names

Use texts according to the selected Language

Try lengths between at least 10 and max 30 characters

Try to create the texts in pair:


o Block, Block off
o Valve open, Valve closed

Try to keep texts consistent:


o Manual mode
o Local mode

Tag name: Max 15 characters

Description: Max 40 characters (Max 29 can fit in the Faceplate)

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

7 (87)

4. Traditional Visual Basic programming


4.1 Naming
-

Graphic Elements must be named according to following:


ObjectTypePGnumber
Example: MAPG001
The number is decided according to following rules:
001 - 019: Numeric
020 - 049: Status
050 - 059: Bar graphs
100 - 119: Shutdown hierarchy lines
120 - 149: Shutdown hierarchy boxes
150 - 199: Shutdown causes and effects
200 - 249: Fire & Gas layout
250 - 299: Fire & Gas Input/Output boxes
900 - 999: Large Screen elements

Faceplate Elements must begin with prefix Comp and have English names that reflect the
content. The main element should be named Comp_Status. Other elements can for instance be
called Comp_Force, Comp_Trend or Comp_Hide. In the Faceplate should the elements be
presented with Norwegian names and sorted in a specific order:
1) Status
2) Trend
3) <Other elements>
4) Hide
5) Force
6) Alarms

The Faceplate must be named as the Control Module type since this name is visible for the
operator. The Faceplate for SBV must for instance be named SBV and not Faceplate_Comp or
similar.

VB-code variables should have var as prefix followed by an English variable name, example:
varInitCodeRead

Variables in Expression Builder (expression variables) in VB should have evar as prefix to


separate them from other variables in the code, example:
evarErrUnack

Visual Basic controls in all types of HMI elements should have the following prefix:
Advant Numeric
- num
Advant Rectangle
- rec
Label (dynamic)
- lbl
Label (static)
- clbl
Text Box
- txt
Combo Box
- cmb
Check Box
- btn
Command Button
- cmd
Line
- lin

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

8 (87)

All new Colors should have Col as prefix and should therefore not contain the word color. It
must also contain the name of the Color aspect, example:
ColReuseTrendWhite
ColReuseTrendBlack
ColReuseNormal

All Subroutines should start with Capital letter. Subroutines for specific tasks should have the
same name for all Object Types, example:
Execute
Abort
ResetAllButtons

4.2 Font in VB

Figure 4.1 - Font Microsoft Sans Serif


-

Font: Microsoft Sans Serif


Size in Graphic Elements: 10 pts
Size in Faceplates: 8 14 pts , see details in Chapter 4.6 for each Faceplate Variant
Color: Black, Green, Yellow or Red-Brown
Style: Regular, Bold
In Graphic Displays: Microsoft Sans Serif or Arial can be used

Motivation:
- Microsoft Sans Serif is a True Type font and is therefore suitable since it looks good in all
sizes
- All Graphic Elements and Faceplates must use Microsoft Sans Serif to make all
everything as consistent as possible
- Microsoft Sans Serif and Arial are very similar, so Arial can be selected as font for the
Graphic Displays if wanted

The font MS Sans Serif is not a True Type and should therefore not be used.
This font will not look good. Do not mix up with Microsoft Sans Serif.

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

9 (87)

4.3 Graphic Elements in VB

Figure 4.2 - Graphic Elements


-

Object Lock select frame: Always Bring to front


Placement of Status: H, F at the top or to the left
Colors and backgrounds of Indication Letters, as H, and L See Table 4.3
Align to Grid 120x120
Align everything horizontally and vertically
Units: Use SI-units as far as possible, see Appendix D
Tool tip must show name of object
Everything in the Graphic Element should bring up Faceplate in one click
The edges of the graphic must be sharp, even if circle or triangle

Colors and Fonts:


- Indication Letters : For instance , 10 pts, bold
- Set Point Value: 38.0, Blue, 10 pts, bold
- Input Value: 0.0- Yellow, 10 pts, bold (also for MV = Measured Values)
- Output Value: 52.0, Red-Brown, 10 pts, bold
- Label: For instance Ua, Black, 10 pts, bold
- Unit: For instance kV - Black, 10 pts, bold

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

10 (87)

4.4 Graphic Elements Details


This chapter shows some details for some specific Graphic Elements.
4.4.1 Dynamic Graphic Elements
The status of equipment shall be indicated with filled or not filled symbol. Filled symbol indicates
on, running, valve/damper open, etc. Not filled symbol indicates off, not running, valve/damper
closed, etc, see Table 4.1.
On - Running
Valve/damper open

Off - Not running


Valve/damper closed

General
ON/OFF
symbol
Electric
heater

Motor
Horizontal

Vertical

Horizontal

Vertical

Pump
The arrow
indicates
the flow
direction

Valve

Damper

Table 4.1 - Dynamic Graphic Elements

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

11 (87)

4.4.2 Indicators and Controllers


The following Table 4.2 shows the placement of the Indicators and Controllers in the Graphic Elements:
Indicator

Controller

1 2 3

H B F
999.9

H FC
999.9
Measured value
Setpoint
999.9
Measured value
Table 4.2 - Indicators and Controllers

1. Alarm indication
2. Blocking indication
3. Physical property
Flow, Level, Temperature, etc. ( C = Controller )
The letter shall be the same as the first letter in the tag no.
4.4.3 Pumps and valves
The following Figure 4.3 shows the placement of the indications for the Pumps and Valves.
1 2 3

B A F

1 2 3

B A F

1
2
3

B
A
F

1
2
3

B
A
F

Figure 4.3 - Pumps and valves


1. Blocking indication
2. Auto/Hand indication
3. Alarm indication.

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

12 (87)

4.4.4 Control Valves


The Graphic Elements for the Control Valves are presented in the Figure 4.4 below:
FC
999.9
999.9

B M
50

50
Blocked and in Manual mode
Figure 4.4 - Control valves

The opening of the valve in percent will be shown below the valve, or, for vertical valves, on the right
side of the valve. When the controller is in Manual mode, this shall be indicated on the valve with a white
M on blue background. Blocking shall be indicated on the valve and not on the controller.
4.4.5 Inputs in ESD/PSD Detail Pictures
The Figure 4.5 shows the Graphic Element for the Inputs in ESD.

Figure 4.5 Input ESD

4.4.6 Outputs in ESD/PSD Detail Pictures


The Figure 4.6 shows the Graphic Element for the Outputs in ESD.

HZV-20-0157

2.step separator gas out

Fault (valve not closed, pump not stopped, etc)


Equipment status (open/closed, running/not running)
Blocked
Figure 4.6 - Outputs ESD

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

13 (87)

4.4.7 ESD/PSD Shutdown Level


The Figure 4.7 shows the Graphic Elements for the ESD/PSD Shutdown Levels.
Overview Picture
PSD 5.32

Detail Picture

C F B

PSD 5.32
B
B
Blocked
Fault

Outputs to lower levels blocked

Coincidence

Shutdown level

Shutdown level

Inputs from higher levels blocked

Figure 4.7 Shutdown level


The field indicating shutdown level shall have black text on white background when
the shutdown level is tripped by a direct input. When the shutdown level is tripped by a higher
shutdown level, the field shall have black text on a light orange background.
4.4.8 Fire & Gas Overview Alarms
The Figure 4.8 shows the Graphic Elements for the Fire & Gas Overview Alarms.
FIRE

S F B

GAS

S F B

WATER

S F B

EFFECT

S F B

HVAC

S F B
Blocked
Fault
Suppressed
Alarm
Figure 4.8 Fire & Gas Overview

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

14 (87)

4.4.9 Fire & Gas Detectors


The Figure 4.9 shows the Graphic Element for the Fire & Gas Detectors.

B
Blocked
Detector symbol
Fault

Figure 4.9 Fire & Gas Detectors

The detector symbols shall be the same as those used on the Fire & Gas Detection Layout
drawings, and shall normally be green. When an alarm occurs, the detector symbol shall change
color according to the general rules for alarm colors.

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

15 (87)

4.5 Faceplates in VB

Figure 4.10 - Faceplate layout

Header must be the name of the type, example MA


Description: Max 40 characters (Max 29 can fit in the Faceplate!)
Size of Faceplate: Width=338, Height=346. No resizing or stretching.
Size of Faceplate Element: Width=4950, Height=3300.
No resizing code in the Faceplate tab
Scale mode: 3- Pixels
Tab order: Status, Trend, Hide, Values, Force,Alarm1,Alarm2
All tabs must have different names: Alarm1, Alarm2 and so on
Number of tabs: not so many that scrolling appears
Text for header of tabs: Max 10 characters
On each tab: try to always use 3 sectors with separator lines in between
Only the left sector of the Status tab is repeated on all other tabs
Everything must be aligned horizontally and vertically between the tabs
Input fields must be disabled/ hidden when input is not available
Horizontal separator lines between different functions and presentations
Reference type: SBC_H1

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

16 (87)

4.6 Faceplate Details in VB


When editing a Faceplate Element, try to use one of the following Faceplate Variants:
1) Button presentation, Type1

Size of buttons P and Av, Width=33, Height=17


Distance between buttons, 4 pixels
Header font: 10 pts, regular
Button font: 8 pts, regular

2) Button presentation, Type2

Size of buttons pne and Lukke, Width=50, Height=17


Distance between: 4 pixels
Header font: 10 pts, regular
Button font: 8 pts, regular

Buttons for Auto, Hand, pne, Stenge, Width=50, Height=17


Distance between: 4 pixels
Note: Buttons that belongs together must be placed Horizontally
Horizontal separator lines between the different function buttons
Header font: 10 pts, regular
Status font: 10 pts, bold See Table 4.3
Button font: 8 pts, regular

3) Button presentation, Type3

Size of Buttons: Utfr Avbryt Width=43, Height=17


Distance between buttons: 4 pixels
Button font: 8 pts, regular

4) Button presentation, Type4

Tilbakestill button: Width= 69, Height=17


Button font: 8 pts, regular

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

17 (87)

5) Button presentation, Type5

Other buttons: try to use Width=50, Height=17


Header font: 10 pts, regular
Button font: 8 pts, regular

6) Input , Type1

Input fields are always white


Input fields only visible when possible to edit
Label above, current value to the left, unit to the right
Header font: 10 pts, regular
Value and unit font: 10 pts, regular
Input font: 8 pts, regular

7) Input , Type2
-

Used for Set points and Output Values!


Set Point

Output

1) Field locked from editing:


2) Field when editable:
-

Label and Unit font: 10 pts, regular


Value font: 10 pts, bold (Set Point=Blue, Output=Red)
Value background: See above
Value width= Adjust to number of digits needed
The boxes below opens when in situation 2) and field is clicked:

Input fields are always white


Input fields only visible when possible to edit
Label above, current value in input box, scrollbar below
Input font: 8 pts, regular

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

18 (87)

8) Static Number presentation, Type1

Used for: Input Values


Always locked from editing
Label and Unit font: 10 pts, regular
Value font: Yellow text, 10 pts, bold
Value background: Black
Value width= Adjust to number of digits needed

9) Static Number presentation, Type2

Label font: 10 pts, regular


Value font: 10 pts, regular
Value background: Transparent background, black text

10) Status presentation, Type1

Rectangle: Green frame, black center, width=17, height=17


Text: Black text, 10 pts, regular
Texts not longer than approx. 25 characters

11) Status presentation, Type2

Rectangles: Green frame, black center, width=17, height=17


Header text: black text, 10 pts, bold
Text: black text, 10 pts, regular
Texts not longer than approx. 25 characters

12) Status presentation, Type3

Text: Green text, 10 pts, regular

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

19 (87)

13) Status presentation , Type4

Black text: 10 pts, regular


Green text: 10 pts, bold

14) Status presentation , Type5

Black text: 10 pts, regular


Green text: 14 pts, bold

15) Modus presentation, Type1

Header font: 10 pts, regular


Status font: 10 pts, bold
Letters to use: H , A, L See Table 4.3

16) Force presentation , Type1

Label font: 10 pts, regular


Button font: 8 pts, regular
Rectangle: Green frame, black center, width=17, height=17
Size of buttons: Width=33, Height=17
Distance between buttons, 4 pixels

17) Warning presentation, Type1


- Example: MBB m kjres fra bryter!
- Yellow text
18) Command presentation , Type2

Header font: 10 pts, regular


Button font: 8 pts, regular
Size of buttons: Width=50, Height=17
Rectangle: Green frame, black center, width=17, height=17

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

20 (87)

4.7 Status rectangles in VB

Figure 4.11 - Status rectangles in Faceplates


-

Size of rectangle: Width = 17, Height=17


Color of rectangle: Green, Black , white when NAS
Total number in one tab: 2x9 items
Texts: black text, 8 pts, regular
Max length of texts: must fit 2x9, approx. 25 characters
Abbreviations similar for all, see Appendix B
Large letter only in first word and names
Square to the left, text to the right
Never a square visible without a text
No holes between the squares
Always fill from the top
Reference type: SBC_H1: Comp_ElAlarms

4.8 Not Available


Figure 4.12 - Not Available
-

Not available standardize the presentation


Text: green text, 10 pts, regular
Only text if not available otherwise blank
Symbol: Green X that marks not available

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

21 (87)

4.9 Indication Letters in VB


The Table 4.3 contains all the Indication Letters that must be used:
Eng.

(or
(or

Nor.

)
)

(or
(or

)
)

English Abbreviation
T for Test modus
F for Force
S for Suppress
B for Blocking
H for Hiding

Norwegian Abbreviation
T for Test modus
P for Ptrykk
U for Undertrykk
B for Blokking
S for Skjuling

C for Coincidence
A for Alarm
W for Warning
F for Fault

C for Coincidence
A for Alarm
V for Varsel
S for Svikt

H for High alarm


L for Low alarm
H for High warning
L for Low warning

H for Hy alarm
L for Lav alarm
H for Hy varsel
L for Lav varsel

M for Manual modus 1)


A for Auto modus 2)
L for Local modus
E for External modus
I for Internal modus
X for Not available
T for Tracking

H for Hand modus


A for Auto modus
L for Lokal modus
E for Ekstern modus
I for Intern modus
X for Not availble
T for Tracking

Table 4.3 - Indication Letters


Comments in Table 4.3:
- 1) Manual modus as only if Auto modus not exists or PGreenH=true on that Type
- 2) Auto modus as
only if PGreenH=true

Colors
- Indications with gray background and green text, example
- Indications with blue background and white text, example

Oil, Gas & Petrochemicals

, symbolizes Normal
, symbolizes Not Normal

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

22 (87)

4.10 Indication Letters when Hiding

There are 3 different hidings: From Faceplate, Logic or Server Based. These
hidings give different presentations in Faceplate and Graphic Elements. Hiding
from Logic and Hiding from Server should be presented the same way.

1) Hiding from Faceplate


The Table 4.4 shows the Indication Letters for the hidden active Alarms and Faults when Hiding
from Faceplate is activated. It applies to both Faceplate Elements (FE) and Graphic Elements
(GE).

FE & GE
Eng.

FE & GE
Nor.

English
Abbreviations
F for Fault +
H for Hide
A for Alarm +
H for Hide
W for Warning +
H for Hide
H for High alarm +
H for Hide
L for Low alarm +
H for Hide
H for High warning +
H for Hide
L for Low warning +
H for Hide
C for Coincidence +
H for Hide

Norwegian
Abbreviations
S for Svikt +
S for Skjuling
A for Alarm +
S for Skjuling
V for Varsel +
S for Skjuling
H for Hy alarm +
S for Skjuling
L for Lav alarm +
S for Skjuling
H for Hy varsel +
S for Skjuling
L for Lav varsel +
S for Skjuling
C for Coincidence +
S for Skjuling

Table 4.4 Hiding from Faceplate


The system extension Group Display Status should not show any alarms that are Hidden from
Faceplate.

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

23 (87)

2) Hiding from Logic or Hiding from Server


The Table 4.5 shows the Indication Letters for the hidden active Alarms and Faults when Hiding
from Logic or Server Based Hiding is activated.

The presentation is different for Faceplate Elements (FE) and Graphic


Elements (GE).

FE
Eng.

FE
Nor.

GE
Eng.

GE
Nor.

English
Abbreviations
F for Fault
H for Hide (FE)
A for Alarm
H for Hide (FE)
W for Warning
H for Hide (FE)
H for High alarm
H for Hide (FE)
L for Low alarm
H for Hide (FE)
H for High warning
H for Hide (FE)
L for Low warning
H for Hide (FE)
C for Coincidence
H for Hide (FE)

Norwegian
Abbreviations
S for Svikt
S for Skjuling (FE)
A for Alarm
S for Skjuling (FE)
V for Varsel
S for Skjuling (FE)
H for Hy alarm
S for Skjuling (FE)
L for Lav alarm
S for Skjuling (FE)
H for Hy varsel
S for Skjuling (FE)
L for Lav varsel
S for Skjuling (FE)
C for Coincidence
S for Skjuling (FE)

Table 4.5 Hiding from Logic or Server


The system extension Group Display Status should not show any alarms that are Hidden from
Logic or Hidden from Server.

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

24 (87)

4.11 Code in VB
-

Avoid inserting logic in the Expression Builder. Logic should be implemented in the Control
Module.

Before Deploy you should make sure that no old, commented code still exists. All not needed
code must be removed

Code that belongs together should be kept together. Variables, Properties, Methods and
User_Control methods and so on.

All Graphic Elements and Faceplate elements with Apply button must handle Object
Locking.

Make sure that no Unresolved References are still in the element at Deploy.

New Faceplate elements should handle the Enter and Escape buttons.

Tab order should go from left to right and from the top and down as far as this is possible.

For SIL specific details for HMI, see ref. [Re2].

4.12 Comments
-

All comments must be written in English.

Comments should look like this:


Here is the text of the comment

All VB elements must have a header. It should contain date, revision, signature and comment.
Example:
'
' Date
| Rev. | Sign | Comment
'------------------------------------------------------' 28.06.2004 | 1.0 | THA | Upgrade to SV 3.1 Ormen Lange
' 24.11.2004 | 2.0 | THA | Reissued for construction.
10.01.2005 | 2.0 | ELU | FEM O1- 01 -0070, SIL Implementation

Complex functionality should have a short descriptive comment.

Subroutines should have a descriptive header.

Use space in the code to increase the readability.

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

25 (87)

4.13 Property settings


-

All VB controls should have Windowless =True and BackStyle = Transparent. If this is not
possible you should try to switch the VB control to a Windowless (lightweight) with similar
functionality. Otherwise use recommendations from manual ref. [Re1] for property settings.

4.14 Error handling


-

All possible Errors in the VB code must be caught in a way that makes sure that the
dialog/graphic does not fail. Make sure that there is always one Exit Sub in addition to End Sub
when On Error GoTo is used. Call the method ReportError if error occurs. Example:
Private Sub Execute()
On Error GoTo Error_cmdExecute_Click
If (ThisIsLockedByMe) Then
Do something here
End If
Exit Sub
Error_cmdExecute_Click:
Call ReportError("cmdExecute_Click", Err.source, Err.Description, "", 0)
End Sub

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

26 (87)

4.15 Presentation details


Here are a couple of chapters that describes how Alarm, Coincidences, Status and other should be
presented with different colors in HMI.
4.15.1 Alarms
Alarm
-

A / HH / LL
Red background with white text
Grey background with black text when Hiding selected

Warning
-

W / WH / WL
Yellow background with black text
Grey background with black text when Hiding selected

Signal fault
F
- Magenta background with white text
- Grey background with black text when Hiding selected
4.15.2 Coincidence
Coincidence C
- Safety action and Blocking Safety action will not be performed
- Yellow background with black text
4.15.3 Status
Force

F
-

Suppress

Optional value forced to I/O signals connected to the function blocks


S

Suppress the source to the alarm Alarm state will not give actions or be presented

B
Blocks the actions that are caused by alarm state or safety action Alarms will be presented

Block
Hide
-

H
Alarms will not be presented in the Alarmlist Grey indication in Faceplate and Graphic
Elements, message to Eventlist
All statuses are presented with blue background and white text

4.15.4 Safety action


Safety action LSL / LSH / FSL / FSH
- Safety action Safe position
- White color

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

27 (87)

4.15.5 Priority in Graphic Elements


The Table 4.6 shows how the different states should be presented when they are presented at
the same position in a Graphic Element.
Priority
1
2
3
4

Alarm
Alarm
Warning
Fault

Coincidence
A / HH / LL
W / WH / WL
F

Coincidence C

Status
Coincidence
Force
Suppress
Block
Hide

Test
C*
F
S
B
H

Test

T*

* Coincidence and Test can in some cases be presented in the Status indication.

Table 4.6 - Table priority

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

28 (87)

4.15.6 Presentation in Faceplates and Graphic Elements


The Table 4.7 and Table 4.8 show how the different statuses that appear should be presented in
Faceplates and in Graphic Elements.
G = Grey alarm indication, applies at Hiding
T = Alarm state that is suppressed

1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1

1
1
1
1
1
1
1
1

1
1
1
1

1
1

1
1

1
1
1
1
1
1

1
1

1
1

1
1

1
1
1
1
1
1
1

1
1
1

1
1
1

1
1
1
1

1
1
1
1
1
1

1
1

1
1
1
1

1
1
1
1

T
T
T
T
X
X
G
G
T
T
T
T
X
X
G
G

X
X
X
X
X
X
X
X

X
X
X
X

X
X

X
X

X
X
X
X
X
X

X
X

X
X
X
X
X
X
X

X
X
X

X
X

X
X

X
X

X
X

X
X
X
X

X
X

Hide

Bllock

X
X
X
X

X
X

X
X
X
X

X
X
G
G

X
X
X
X
X
X
X
X

Alarm

Hide

Block

Suppress

Force

Coincidence

Alarm

Hide, Operator

Block, Operator

Suppress, Operator

Force, Operator

Alarm

(Individual)

Suppress

Presentation Graphic
Elements,
(Collected)

Force

Presentation Faceplate,

Coincidence

1 = Activated
X = Active indication

X
X
G
G

X
X
X
X
X
X
X
X
X
X
X
X
X

X
X

X
X

Table 4.7 Status presentation: graphic elements

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

29 (87)

4.15.7 Presentation in Faceplates and Graphic Elements (2)


G = Grey alarm indication, applies at Hiding
T = Alarm state that is suppressed

1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1

1
1
1
1
1
1
1
1

1
1
1
1

1
1

1
1

1
1
1
1
1
1

1
1

1
1

1
1

1
1
1
1
1
1
1

1
1
1

1
1
1

1
1

T
T
T
T
X
X
G
G
T
T
T
T
X
X
G
G

X
X
X

X
X
X

X
X
X
X

X
X

X
X
X
X
X

X
X
X

X
X

X
X
X

1
1

X
X
X
G
G

X
X

1
1
1
1
1

1
1

1
1
1

1
1

Hide

X
X
X

X
X
X

X
X

X
X

X
X

X
X
X
G
G

X
X
X

X
X

X
X
X

X
1
1

X
X

X
1

X
X

X
X

Block

X
X

X
X
X

Alarm

Hide

Block

Suppress

Safety action

Coincidence

Alarm

Hide, Logic

Block, Logic

Suppress, Logic

Safety action

Alarm

(Individual)

Suppress

Presentation Graphic
Elements,
(Collected)

Safety action

Presentation Faceplate,

Coincidence

1 = Activated
X = Active indication

X
X

X
X
X
X
X

X
X
X

X
X

X
X
X
X

X
X
X

X
X

X
X

Table 4.8 Status presentation: graphic elements (2)

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

30 (87)

5. Process Graphics programming


5.1 Naming
-

Graphic Elements must be named according to following:


reObjectTypePGnumber
Example: reMAPG001, re stands for REUSE
The number is decided according to following rules:
001 - 019: Numeric
020 - 049: Status
050 - 059: Bar graphs
060 - 070: Cause & Effect
100 - 119: Shutdown hierarchy lines
120 - 149: Shutdown hierarchy boxes
150 - 199: Shutdown causes and effects
200 - 249: Fire & Gas layout
250 - 299: Fire & Gas Input/Output boxes
800 - 899: TR1212 elements
900 - 999: Large Screen elements

Faceplate Tabs must be named according to following:


x + Tab + Content + [no]
Example: xTabStatus, xTabAlarm1, xTabAlarm2, see Appendix E for Details

Indicators on the Object Types must be named according to following:


x + Ind + Type + no
Example: xIndAl1, xIndEr1, xIndEr2, see Appendix E for Details

In the Faceplate should the elements sorted in a specific order:


1) Status
2) Trend
3) <Other elements>
4) Force
5) Alarms

The Faceplate must be named as the CMT since this name is visible for the operator. Faceplate
for SBV must for instance be named SBV and not Faceplate_Comp or similar.

Variables in Expression Builder (expression variables) should not have any prefix since the new
PGE has an option to show or hide ev:: as automatic prefix

All controls in all types of HMI elements should have prefix, add if missing. See prefix list here.
The reason is to give each control a sensible name, for instance txtOutput
Numeric
- num
Line
- lin
Triangle
- tri
Rectangle
- rec
Command Button
- cmd
Elipse
- eli
Label (dynamic) - lbl
Bar graph
- bar
Button
- btn
Label (static)
- clbl
Indicator
- ind
Text Box
- txt
Input Field
- inp
Combo Box
- cmb
Scale
- scl
Check Box
- chb
Cone
- con

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

31 (87)

All new Colors should have ColReuse as prefix and should therefore not contain the word color.
The name should be written ColReuse due to historical reasons. It must also contain the name
of the Color aspect, example:
ColReuseGenInput
ColReuseGenOutput
ColReuseTrendWhite
ColReuseTrendBlack

All Aspects must have a good Aspect Description, see Appendix E for details.

5.2 Colors in PG
-

Shall be configurable in large extent via Color Palettes


More color options in different REUSE Palettes
Default: Dimmed-screen concept default set of Palettes
Also supported: Traditional VB-look as in Ormen Lange - separate set of Palettes
For Colors Overview see Q000083-SW-OV-0004, ref. [Re5]
Dimmed Color Philosophy according to Figure 5.1

Dimmed Colors:
Static information that
operator dont need to
pay attention to during
operation of the plant.

Normal Operation Colors:


Dynamic information that operator
needs to monitor in normal operation
of the plant

Critical Colors:
Critical information that
operator need to prioritize
before further operation of
the plant.

E.g.:
*Pipeline colors
*Background colors
* Static symbols

E.g.:
*Ordinary running status of a motor
*Ordinary open/close status of a valve
* Ordinary values: Inputs, Set points, Outputs

E.g.:
*Alarms
*Forced

Low Intensity

High Intensity

Figure 5.1 Dimmed Color Philosophy


5.2.1 Alarm Colors in PG
The REUSE PG supports two different Alarm Philosophies:
Priority Based:
The alarm color presented in Faceplates and Graphic Elements are
based on the Alarm Priority configuration on each FB. This is according to the EEMUA191 / YA-711 standards.
Category Based: The alarm color is based on the Alarm Category i.e. a Fault alarm
has a predefined color; a Warning alarm has another predefined color etc. These are
independent of the alarm priority configuration.
For more details about the Alarm Colors, see [Re5] and [Re7].

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

32 (87)

5.3 Font in PG

Figure 5.2 - Font Tahoma


-

Font: Tahoma
Size in Graphic Elements: 12 pts , see Appendix A for calculation of Font size
Size in Faceplates: 8 12 pts , see details in Chapter 5.8.4 for each Faceplate Variant
Color: Black, Green, Blue or Red-Brown
In Process Displays: Tahoma, Microsoft Sans Serif or Arial can be used

Motivation:
- Tahoma is standard font in Windows
- The letter I is easy to separate from for instance 1
- Tahoma is a True Type font and is therefore suitable since it looks good in all sizes
- All Graphic Elements and Faceplates must use Tahoma to make all everything as
consistent as possible
- Tahoma, Microsoft Sans Serif and Arial are very similar, so any of these three can be
selected as font for the Process Displays if wanted

The font MS Sans Serif is not a True Type and should therefore not be used.
This font will not look good. Do not mix up with Microsoft Sans Serif.

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

33 (87)

5.4 PG Graphic Elements

Figure 5.3 - Graphic Elements


-

Object Lock select frame: Use Standard Object Lock


Placement of Status: M, F at the top or to the left, see Figure 5.4
Colors and backgrounds of Indication Letters, as M, and L See Table 5.6
Align all Symbols that should be placed on top of Media lines to Grid=8
Align everything horizontally and vertically
Units: Use SI-units as far as possible, see Appendix D
Tool tip must show name of object
Make sure that property InhibitInput=None in order to bring up Faceplate in one click
The edges of the graphic must be sharp, even if circle or triangle - use Vector Graphics
To show complete numeric element size we use gray color similar to Display Background
The numeric elements that not brings up Faceplate on click should be Transparent
The Symbol colors are configurable can for instance use same as Media color
The elements can have Transparent Background
General philosophy: Filled=Open, Not filled=Closed
For Valves that only sometimes shows a Hat, it should only be shown in Auto mode

Colors and Fonts:


- Indication Letters : 12 pts, regular (E.g.
in Figure 5.3)
- Input Value: Green, 12 pts, regular (E.g. 65.0 in Figure 5.3)
- Measured Values: Green, 12 pts, regular
- Set Point Value: Blue,12 pts, regular (E.g. 0.0 in Figure 5.3)
- Output Value: Red-Brown, 12 pts, regular (E.g. 100.0 in Figure 5.3)
- Label: Black, 12 pts, regular (E.g. Ua)
- Unit: Black, 12 pts, regular (E.g. kV)

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

34 (87)

5.5 Graphic Elements Details


This chapter shows some details for some specific Graphic Elements.
5.5.1 Dynamic Graphic Elements
The status of equipment shall be indicated with filled or not filled symbol. Filled symbol
indicates on, running, valve/damper open, etc. Not filled symbol indicates off, not running,
valve/damper closed, etc, see Table 5.1.

On - Running
Valve/damper open

Off - Not running


Valve/damper closed

General ON/OFF
symbol

Electric heater

Motor
Horizontal

Vertical

Horizontal

Vertical

Pump
Fan
The arrow indicates
flow direction

Valve

Damper

Table 5.1 - Dynamic Graphic Elements

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

35 (87)

5.5.2 Indicators and Controllers


The Table 5.2 shows the placement of the Indicators and Controllers in the Graphic Elements:
Indicator

Controller

1 2 3

H B F
999.9

H FC
999.9
Measured value
Measured value
999.9
Set point
Table 5.2 - Indicators and Controllers

1. Alarm indication
2. Status indication
3. Physical property
Flow, Level, Temperature, etc. ( C = Controller )
The letter can be the same as the first letter in the tag no.
5.5.3 Placement of Indications
The Figure 5.4 shows the placement of the indications for Valves, Pumps and so on.
1 2 3

F A B

3
2
1

B
A
F

Figure 5.4 Placement of Indications


1. Alarm indication.
2. Auto/Manual indication
3. Status indication

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

36 (87)

5.5.4 Control Valves


The Graphic Elements for the Control Valves are presented in the Figure 5.5 below:
FC
999.9
999.9

M B
50

50
Blocked and in Manual mode
Figure 5.5 - Control valves

The opening of the valve in percent will be shown below the valve, or, for vertical valves, on the
right side of the valve. When the controller is in Manual mode, this shall be indicated on the valve
with a white M on blue background. Statuses shall be indicated on the valve and not on the
controller.
5.5.5 Inputs in ESD/PSD Detail Pictures
The Figure 5.6 shows the Graphic Element for the Inputs in ESD.

LZT23-0102 1.lv. comp. separator

A B
Status
Alarm
Figure 5.6 - Inputs ESD

5.5.6 Outputs in ESD/PSD Detail Pictures


The Figure 5.7 shows the Graphic Element for the Outputs in ESD.
F

HZV-20-0157

2.lv. separator gas output

Status
Equipment status (open/closed, running/not running)
Fault (valve not closed, pump not stopped, etc)
Figure 5.7 - Outputs ESD

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

37 (87)

5.5.7 ESD/PSD Shutdown Level


The Figure 5.8 shows the Graphic Elements for the ESD/PSD Shutdown Levels.
Overview Picture
PSD 5.32

Detail Picture

C F B

PSD 5.32
B
B
Status
Fault

Outputs to lower levels blocked

Coincidence

Shutdown level

Shutdown level

Inputs from higher levels blocked

Figure 5.8 Shutdown level


The field indicating shutdown level shall have black text on white background when
the shutdown level is tripped by a direct input. When the shutdown level is tripped by a
higher shutdown level, the field shall have black text on a light orange background.
5.5.8 Fire & Gas Overview Alarms
The Figure 5.9 shows the Graphic Elements for the Fire & Gas Overview Alarms.
FIRE

F S B

GAS

F S B

WATER

F S B

EFFECT

F S B

HVAC

F S B
Blocked
Suppressed
Fault
Alarm
Figure 5.9 - Fire & Gas Overview

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

38 (87)

5.5.9 Fire & Gas Detectors


The Figure 5.10 shows the Graphic Element for the Fire & Gas Detectors.

B
Status
Detector
Fault

e
s

Figure 5.10 - Fire & Gas Detectors

The detector symbols shall be the same as those used on the Fire & Gas Detection Layout
drawings. When an alarm occurs, the detector symbol shall change color according to the
general rules for alarm colors.

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

39 (87)

5.5.10 Max Text Lengths in Graphic Elements


The Table 5.3 below shows the Max number of Characters that the Graphic Elements must
support. Each Graphic Element that shows any of these texts must be defined to one of the
Types.
No
1
2
3
4
5
6
7

PG Type
Normal
Normal
Maximum
Maximum
Sequence
Sequence
Sequence

Contents

Max no of
Characters
Tagname
15
Description
25
Tagname
20
Description
40
Step Name
30
Condition Text
30
Action Text
30
Table 5.3 Max Text Lengths

PG Example
reMAPG153
reMAPG153
Future
Future
reKSPG023
reKSPG024
reKSPG024

Example: No 1 and No 2 Normal Tagname and Normal Description


reMAPG153 Width Tagname=160 pixels, Width Description=240 pixels, see Figure 5.11.

Figure 5.11 Text Lengths in reMAPG153

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

40 (87)

5.5.11 Graphic Element Sizes


The Size of the new Graphic Elements is shown in Table 5.4 below. The General Standard Size
is 32x32, but the Fire & Gas Symbols are 28x28 since there are often many detectors in a
Process Display.
Item
1

Type
Valve

Graphic Element

Size
Width=32, Height=22

4-way Valve

Width=32, Height=32

Breaker

Width=32, Height=15

Damper

Width=32, Height=32

Motor

32

Fan

32

Pump - Traditional

Width=49, Height=32

Pump

32

Small Indicators

Width=18, Height=20

10

Fire & Gas


F&G Detectors

Width=28, Height=28

11

F&G Flame

Width=28, Height=28
20

12

F&G Infrared

Width=28, Height=12
Table 5.4 - Size of new Graphic Elements

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

41 (87)

The Figure 5.12 shows the Size of the General Symbols and Fire & Gas Symbols when placed in
a Process Display.

Figure 5.12 - Size of new Graphic Elements

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

42 (87)

5.5.12 Graphic Elements Grid


The Figure 5.13 shows the suggested Grid settings when creating a Process Display. If the
projects use these Grid settings the creation of Process Displays will be much simpler since the
aligning of the elements will be centered automatically.

Figure 5.13 - Use of Grid


NOTE:
1)

Use the Flow Line width=1 to verify the centre the element

2)

Insert the Flow Line and do not move it with the Mouse to snap-to-grid. Just draw
the Line and it will snap according to Type B, see Figure 5.14 below. NOTE:
Sweden has a Tracker to make all lines snap according to Type B after SV5.1.

3)

Always set the Hotspot in the symbols to make them align perfectly to the Grid

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

43 (87)

Note also the following:


There are 2 different ways to draw the Lines
Type A) Create a new line and use the mouse to move the line to the Grid as shown in
Figure 5.14 below. This line will snap-to-grid to the right side of the Grid as shown. This
line can also be copied and the new line can be moved in the same way. NOTE: this will
be adjusted by Sweden for SV5.1 so that all lines snap according to Type B instead!
Type B) Draw a line but do not touch it! This line will be centered to the Grid as shown
in the Figure 5.14 below

Figure 5.14 - Two types of Lines


Decision: Since 800xA will adjust snap-to-grid to always snap as Type B (this will be introduced in
SV5.1), the REUSE Team has decided to center all the Valves, Pumps, and Motors on the Lines
according to Type B.

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

44 (87)

The Graphic Elements that is intended to be placed on top of a Media Line must be aligned so
they are centered to the Grid-lines when Grid=8, see Figure 5.15 below.

Figure 5.15 - Align to Grid

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

45 (87)

5.5.13 Graphic Elements Bring To Front


The option Bring to Front must be supported on all Graphic Elements that is intended to be
placed on top of a Media Line, see Figure 5.16.

Figure 5.16 - Bring to Front

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

46 (87)

5.6 Use of Views


In order to minimize the number of Internal Indicators and elements, we should try to use Views, see
Figure 5.17 below. Each View can contain one symbol with the related logic.

Figure 5.17 - Views


5.7 Resize PG elements
In order to make the PG elements dynamic, we should try to make the relevant elements resizable in the
following way:
1)
When increasing the Width, the number of Characters in Tagname and similar
should increase, the rest should keep the size.
2)
When increasing the Height, the Font size should increase

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

47 (87)

5.8 PG Faceplates

Figure 5.18 PG Faceplate layout example


5.8.1 General Faceplate Rules
General for Faceplates
- Reference type: CA (see Figure 5.18)
- Raised: Indicates that Input is possible
- Input fields must be flat (disabled/ hidden) when input is not available
- Input is always Select-And-Confirm, placed together to minimize Mouse Movement
- Input is always safe with Select-And-Confirm since the Operator has to make two clicks
- No Apply or Cancel button, Apply is placed together with the Selection
- Tooltip to inform about content in Indicators
- Use Standard OPC Error indication in Faceplate, only 1 thin red cross over FP
- Use Standard 800xA Object Lock
- Use same form of words: Suppress, Block, Hide (not Hiding), see Table 5.5
- For parts that are repeated in many Faceplate Elements an internal xInd can be created
- Operator Note : Letter image when note is present, else no image
Faceplate Font
- Font: Tahoma 11 pts, regular
- Description: Max 40 characters (Max 29 can fit in the Faceplate)
- Text for header of tabs: Max 10 characters

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

48 (87)

Faceplate Size and Arrangement


- Size of Faceplate: Height= 346, Width=338
- Size of Faceplate Element: Height=261, Width=330
- No resizing or stretching
- Tab order: Status, Trend, Hide, Values,..., Force,Alarm1,Alarm2
- All tabs must have different names: Alarm1, Alarm2 and so on
- Number of tabs: not so many that scrolling appears
- Everything must be aligned horizontally and vertically between the tabs
- On each tab: try to always use 3 sectors
- Placement rules: Left=Status, Middle=Main Input/Info , Right=Other input
- Only the Left sector of the Status tab is repeated on all other tabs
- The Bar graphs can only be operated on the Status Tab
- Use same size for All Faceplates, Motivation:
o Consistency
o Size of Trends
o Easier structuring of Faceplate content
o Easier to maintain
o Clearer Guidelines
o Harmonic Proportions (width and height)
o Easier to recognize REUSE
o No Resize problem
Faceplate Colors
- Faceplate Color: Gray RGB(212,208,200)
- Same colors as for GE applies to Faceplates, MV=green etc
- Primary use same color Palettes as for Graphic Elements
- Faceplate also has one separate color Palette
- New Color: Operations From Logic has Black Background and White text
Motivation for Gray Faceplates
- Standard color in Windows
- Background and buttons has same color, same as in other Windows programs
- Better contrasts than blue-green
- More professional than blue-green
- Gray can be used together with all other colors
- More uniform with the Graphic Displays
- No carved edges (the edges appear in the VB Faceplates)

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

49 (87)

5.8.2 General Faceplate Details


Static Values

Figure 5.19 Static Values


-

The Static Values that not can be changed are flat


Font: Tahoma, 11 pts, regular, black

Group Boxes

Figure 5.20 Group Boxes


-

Font : Tahoma 11 pts


Line color : Default Light gray, connected to Palette
Use rounded corners
Recommended distance : 10 pixels

Indicator Size and Distances

Figure 5.21 Indicator details


-

Font: Tahoma, 11 pts, regular


Frame Width=0, Height=17, Width=14
Distance between Indicators: 4 pixels

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

50 (87)

Tooltip on top of Indicators

Figure 5.22 Tooltips


-

Show Tooltip on top of Indicators


Always use form Block, not Blocking since not always active
When there are more than 1 in same field:
o
Example Block from FP and Block from Logic : Use Block

Bar graphs

Figure 5.23 Bar graphs


-

The indications for HH, H, L, LL must follow YA-711


Size when 1 Bar graph: W=18, H=180
Size when 2 Bar graphs: W=18, H=180 , Distance=3 or Distance=10
Size when 3 Bar graphs: W=18, H=160, Distance=3
Size special case: 3 small bar graphs: W=15, H=100, Distance=8 (see SBE_VSD)
Font size for Bar Scale: Tahoma, 8pts
Colors from Palette
Use Gradients in the Bar graphs

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

51 (87)

Symbols in Faceplate
-

Should be the same Symbol as in Graphic Elements


Same size as in the Graphic Elements
Use the Default Colors always from Palette (not the Media Color)
PEquipment decides the Symbol in the Faceplate

General rules for Boolean Options (On/Off):

Figure 5.24 Distance between Options


-

Distance when related Options: 3 pixels


Distance between Groups: 10 pixels
Font Size: Tahoma 11 pts, regular, black
Button size: Width=24, Height=24
Disabled Options are flat, see Figure 5.25

Figure 5.25 Disabled Options


Warning Texts in Faceplate
-

Warnings in Faceplate should be a Warning-triangle with red text describing the information
Font: Tahoma, 11pts , Bold, Red

Figure 5.26 Warning in FP

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

52 (87)

Not Available
Green X indication
No text for Not Available only green X
Keep Big X across some Symbols, same as before
ParError in Faceplate
- For FBs with ParError parameter it should be presented in the Faceplate with a red Warningtriangle when active and invisible when not active, see MA as reference.
- Width : 14
- Height: 17

Figure 5.27 ParError in FP

5.8.3 Operations from Logic


The Operations from Logic (Suppress, Block, Hide) are NOT shown in Graphic Elements since
they are not set by Operator and should not disturb the Process Display. They are shown in the
Faceplate. To separate the Operations from Logic and Operations from Faceplate the indications
for the Operations from Logic will be indicated with Black Background in Faceplate, example .
See Table 5.6.

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

53 (87)

5.8.4 Faceplate Input Alternatives


There are 9 Types of Input from the Faceplate:
1) Type1 Input of Real Values
2) Type2 Input of Real Values via Scrollbar
3) Type3 Direct set, Set a Real Value direct to Controller with 1 Click
4) Type4 Selection of Boolean Option (On/Off)
5) Type5 Selecting 1 from 2 Different Options
6) Type6 Main Operation
7) Type7 Single Selection
8) Type8 Selecting of Non-critical option without Apply
9) Type9 Selecting 1 from Multiple Selection
1) Type1 Input of Real Values

Figure 5.28 Input Type1


1)
2)
3)
4)

The Value is presented Raised since it is possible to edit


Click to show the input field (The Field does not sink in when clicked)
Type in the new value, press Enter-button to Apply
The new value is presented

The Disabled Input of Real Values that not can be changed are flat
Font: Tahoma, 11 pts, regular
Input box Height=20
Input box Width=48 or Width=60 (try to use one of those sizes)

Motivation for Input Type1


- Safe, since options are hidden and little risk for mistakes
- Apply with Enter gives only little Mouse movement
- Consistent; same type of input for Values, Booleans, 1 of 2, Main Op.
- Big digits that are easy to see
- Saves space
- Standard Input in the Process Graphics Editor
- Built-in Error Handling

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

54 (87)

2) Type2 Input of Real Values via Scrollbar

Figure 5.29 Input Type2


1) Click the Scrollbar
2) The input field appear
3) Type in new value, Enter to Apply. Also possible to drag the bar-arrows
4) The new value is presented
Motivation for Input Type2:
- Consistent with other, see input Type1
- Input close to the Context

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

55 (87)

3) Type3 Direct set. Set a value direct to Controller with 1 Click


1) The Direct set is default not Selected
2) Click the Direct set to Select Function and show the Arrow Buttons in the Bar
3) When an Arrow is clicked, the Small step value is written to Controller without Apply
The button Sinks in on click to indicate that Value is Written

Figure 5.30 Input Type3

Rules for Direct Set:


- Direct set is default not selected when FP is opened, but after it is selected it stays
selected until Operator de-selects it
- The Direct set affects all Bar graphs that has Input available (Example CA: both IntSP
and Output Bar graphs)
- When Direct set is selected it will at all times show the Up and Down that are available
(for All Bar graphs that has Input available)
- When nothing can be set in the Bar graphs the Direct set is disabled (Example CA: When
Auto + Ext is selected)
Motivation for this input:
- Consistent with other input
- Very important for the Operators to have this Option for fast and easy stepping

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

56 (87)

4) Type4 Selection of Boolean Option (On/Off):

1)
2)
3)
4)

Figure 5.31 Input Type4, select


The Option is not Activated
Click to show menu (Button does not sink in) (Select)
Click wanted Option, sets Option to Controller, no extra Apply needed (Confirm)
The Activated Option is shown

De-select of Boolean Option (On/Off):

Figure 5.32 Input Type4, de-select


1)
2)
3)
4)

The Option is Activated


Click to show menu
Click wanted Option, sets Option to Controller, no extra Apply needed
The Option is now De-activated

Complete text for Option is shown in menu: Block HH on, Block HH off

Motivation for Input Type4:


- Safe, since options are hidden and little risk for mistakes
- Apply closer to selection gives much less Mouse movements
- Consistent; same type of input for Values, Booleans, 1 of 2, Main Op.
- Big buttons that are easy to click
- Only the possible Options are enabled
- Saves space
- Easier to place since Horizontal
- Indication when On emphasizes the Status

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

57 (87)

General Selections of a Boolean Option (On/Off):


For selections that does not have a letter we have 2 different options:
1) Important
2) Not Important
1) Important

Important Not Selected

Important Selected
2) Not Important

Not Important Not Selected

Not Important Selected

General Activation of a Boolean Option (On/Off):


For activations we have 1 option:

Not Active

Active

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

58 (87)

5) Type5 Selecting 1 from 2 Different Options


When Selecting 1 from 2 Options it should be do according to the following description, otherwise same
details as for input Type4.

Figure 5.33 Input Type5, select


1)
2)
3)
4)

1 Option Auto is selected


Click to show menu (Button does not sink in when clicked)
Click wanted Option, sets Option to Controller, no extra Apply needed
The Option Manual is shown

Selecting back 1 from 2 Different Options:

Figure 5.34 Input Type4, select back


1)
2)
3)
4)

1 Option Manual is selected


Click to show menu
Click wanted Option, sets Option to Controller, no extra Apply needed
The Option Automatic is shown

- If the Mode is disabled, the button is flat but the text is still black
Motivation for Input Type5:
- Consistent, see motivation for Input Type4

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

59 (87)

6) Type6 Main Operation


The Main Operation is Open, Close, Start and Stop and so on
To emphasize them they are bigger and contain an Icon and a Text:
Main Operation Open Valve:

Figure 5.35 Input Type6, Open valve


1)
2)
3)
4)

The valve is Closed, can only be Opened


Click to show menu (The Button should not sink in when pressed)
Click Open valve, sets Option to Controller, no extra Apply needed
The valve is Open

Motivation for Input Type6:


- Consistent; same type of input for Values, Booleans, 1 of 2, Main Op.
- Big buttons that are easy to click
- Main operation should be easy to see
- Icons and Text on Button to emphasize the Operation

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

60 (87)

More details for Input Type6:


To avoid too big buttons: Max Size of Input Type6 buttons: Width= 103, Height= 32
Font size:
i. For short texts, for instance Start: Use Font: Tahoma 13 pts bold
ii. For longer texts, for instance Stepwise: Use Font: Tahoma 10 pts bold
Text: Open valve/Cancel, Open breaker/Cancel, Start motor/Cancel and so on.
Icons: Width = 36, Height = 25
All colors connected to palette, also disabled button
The disabled text should be default gray connected to separate color in palette
The icon should also be disabled and grayed out
- Figure 5.35 shows the English and Norwegian texts to use to fit Max Width=103
- Figure 5.36 shows the recommended size of Group box to use with Input Type6, try to use Min
Width=122 of the Group box

Figure 5.36 Input Type6, Max Width=103


Use Tahoma 10 pts bold for following texts:
Text:
Text:
Text:
Text:
Text

Eng: Shutdown
Eng: Reset
Eng: Deblock
Eng: Stepwise
Eng: Open fast

Nor: Nedsteng
Nor: Tilbakestill
Nor: Opphev
Nor: Stegvis
Nor: pne hurtig (Group box, see Figure 5.36)

Use Tahoma 13 pts bold for following texts:


Text:
Text:
Text:
Text:

Eng: Open
Eng: Close
Eng: Start
Eng: Stop

Oil, Gas & Petrochemicals

Nor: pne
Nor: Steng
Nor: Start
Nor: Stop

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

61 (87)

Figure 5.37 Input Type6, Group box


Main Operation Close Valve:

Figure 5.38 Input Type6, Close valve


1)
2)
3)
4)

The valve is Open, can only be Closed


Click to show menu
Click Close valve, sets Option to Controller, no extra Apply needed
The valve is Closed

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

62 (87)

7) Type7 Single Selection


When selecting a Single Selection it should be done in the following way, otherwise same details as for
Type4.

Figure 5.39 Input Type7


1)
2)
3)
4)

The Reset is Enabled and possible to select


Click to show menu
Click Reset alarm, sets Option to Controller, no extra Apply needed
If nothing more to Reset, the Reset is Disabled

8) Type8 Selecting of Non-critical option without Apply

Figure 5.40 Input Type8


-

Can only be used in Non-critical cases, Ex: to make curve-line visible/invisible in Trend
Does not require Apply
Font: Tahoma, 11 pts, regular
Enable / Disable according to Windows standard

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

63 (87)

9) Type9 Select 1 from Multiple Selections


To Select 1 from Multiple Options (3 or more) the Following shows the solution:
A Popup-menu that XA has promised to create in 800xA (probably in SV5.1):

Figure 5.41 Input Type9

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

64 (87)

5.8.5 Status indication

Figure 5.42 Example for Status Indication


-

Max 2x9 Status Indications in 1 Tab


Font: Tahoma, 11 pts, regular, black
Active Normal Green (Ex: FDH, FDL, Local, Test mode, PSD, Not Available)
Active Abnormal Red (Ex: Alarm, Warning, Fault)
Active Shutdown White (Ex: LSL.TripOrder)
Max length of texts: must fit 2x9, approx. 25 characters
Abbreviations similar for all, see Appendix B
Large letter only in first word and names
Circle to the left, text to the right
Never a Circle visible without a text
No holes between the Circles
Always fill from the top
Indicator size: Width=18, Height=18
Border: Color from Palette
Inside: 2 colors from Palette
Avoid using colors related with Alarms, Warnings and Faults
For YA-711: Nothing is related with the Priority
Reference type: see example in Figure 5.42

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

65 (87)

Inactive [ RGB(215,215,215), RGB(136,126,126) ] - Gray

Figure 5.43 Normal Status


-

Normal [ RGB(142,222,95), RGB(63,112,65) ] - Green

Figure 5.44 Abnormal Status


-

Abnormal [ RGB(251,170,168), RGB(162,33,30) ] - Red

Figure 5.45 Shutdown Status


-

Shutdown [ RGB(255,255,255), RGB(211,211,211) ] - White

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

66 (87)

5.8.6 Trend Tab

Figure 5.46 Trend Tab


-

Colors according to type of Value, MV=Green and so on


Configurable Curve lines visible or not (Example MV, SP)
Configurable Range
Configurable Time (in minutes)
All colors from Palettes
Set Trend DrawMode = Stepped
Configure Alarm limits visible or not (Example HH, H, L, LL)
Thickness of Lines: 2 pts

5.8.7 Force Tab


-

Digital Force:

Figure 5.47 Force for Digital

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

67 (87)

5.8.8 Texts to use


Here is Table 5.5 that shows the preferred Texts. See also Appendix B for abbreviations.
Item
1
2
3
4
5
6
7
8
9
10
11

Text
Block
Suppress
Hide
MV
Int SP
Ext SP
Out
Auto
Manual
Internal
External

Comment
Do not use Blocking
Do not use Suppressing
Do not use Hiding
Measured Value
Internal Set point
External Set point
Output
Do not use Automatic
Write complete word
Write complete word
Write complete word

Table 5.5 Texts to use in FP

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

68 (87)

5.9 Indication Letters in PG


The Table 5.6 contains all the Indication Letters that must be used:
Eng.

or
or

Nor.

or
or

English Abbreviation

Norwegian Abbreviation

Priority/

F for Force
S for Suppress from FP
B for Blocking from FP
H for Hiding from FP
T for Test modus

P for Ptrykk
U for Undertrykk fra FP
B for Blokking fra FP
S for Skjuling fra FP
T for Test modus

Category colors
Independent
Independent
Independent
Independent
Independent

S for Suppress from Logic


B for Blocking from Logic
H for Hiding from Logic

U for Undertrykk fra Logikk


B for Blokking fra Logikk
S for Skjuling fra Logikk

Independent
Independent
Independent

C for Coincidence
A for Alarm
W for Warning
F for Fault

C for Coincidence
A for Alarm
V for Varsel
S for Svikt

Priority/Category
Priority/Category
Priority/Category
Priority/Category

H for High alarm


L for Low alarm
H for High warning
L for Low warning

H for Hy alarm
L for Lav alarm
H for Hy varsel
L for Lav varsel

Priority/Category
Priority/Category
Priority/Category
Priority/Category

M for Manual modus 1)


A for Auto modus 2)
L for Local modus
E for External modus
I for Internal modus
X for Not available
T for Tracking

H for Hand modus


A for Auto modus
L for Lokal modus
E for Ekstern modus
I for Intern modus
X for Not availble
T for Tracking

Independent
Independent
Independent
Independent
Independent
Independent
Independent

Table 5.6 Indication Letters


Comments in Table 5.6:
- 1) Manual modus is
only if Auto modus not exists or PgreenH=true on that Type
- 2) Auto modus is
only if PgreenH=true (Manual is the normal mode)
Colors
- Indications with gray background and green text, example
- Indications with blue background and white text, example

Oil, Gas & Petrochemicals

, symbolizes Normal
, symbolizes Not Normal

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

69 (87)

5.10 General Alarm Indication


For each Alarm there are a few states that are general, see Table below.
FE & GE

Description
Unacknowledged alarm,
Blinking color
Acknowledged alarm,
Steady color
Inactive,
Unacknowledged alarm
Disabled alarm

Color
Color from Priority or Category (Ref. Ch. 5.2.1)
Color from Priority or Category (Ref. Ch. 5.2.1)
Color from Priority or Category (Ref. Ch. 5.2.1)
Color is Black Text with Gray background

Table 5.7 General Alarm Indication

5.11 Indication Letters for Inactive Unacknowledged Alarms


The Inactive Unacknowledged Alarms are shown flashing square according to the Table
below.
FE & GE

English Abbreviation
C for Coincidence
A for Alarm
W for Warning
F for Fault

Color
Color from Priority or Category (Ref. Ch. 5.2.1)
Color from Priority or Category (Ref. Ch. 5.2.1)
Color from Priority or Category (Ref. Ch. 5.2.1)
Color from Priority or Category (Ref. Ch. 5.2.1)

H/HH for High alarm

Color from Priority or Category (Ref. Ch. 5.2.1)

L/LL for Low alarm

Color from Priority or Category (Ref. Ch. 5.2.1)

H for High warning


L for Low warning

Color from Priority or Category (Ref. Ch. 5.2.1)


Color from Priority or Category (Ref. Ch. 5.2.1)

Table 5.8 Inactive Unacknowledged Alarms

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

70 (87)

5.12 Indication Letters when Disabling Alarm


Disabling alarm can be done one of the following ways:
1) Hide from Faceplate (Indication , see A below)
2) Suppress from Faceplate (Indication , see A below)
3) Hide from Logic (Parameters FUAxx=True) (Indication , see B below)
4) Suppress from Logic (Parameters FUxx=True) (Indication , see B below)
5) Disable from Parameters (Parameters PDAxx<>2) (See C below)

There are many different Disabling possibilities of Alarms. These disabling


methods give different presentations in Faceplates compared with Graphic
Elements!

The system extension Group Display Status should not show any alarms that are disabled.
The Table 5.9 shows all the possible Disable Alarm Cases that must be evaluated for each
Object Type. These Cases must be referred to in the Test Specifications.

Case
D1
D2
D3
D4
D5
D6
D7
D8
D9
D10

Title
FP Hide before Alarm
FP Hide after Alarm
FP Suppress before Alarm
FP Suppress after Alarm
Logic Hide before Alarm
Logic Hide after Alarm
Logic Suppress before Alarm
Logic Suppress after Unack & Ack Alarm
PDAxx<>2 before Alarm
PDAxx<>2 after Alarm
Table 5.9 Cases for disabling alarm

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

71 (87)

A) Disabling from Faceplate


The Table 5.10 shows the Indication Letters for the disabled Alarms when Hide or Suppress
from Faceplate is activated, it applies to both Faceplate Elements (FE) and Graphic Elements
(GE).
Operation before or after Alarm (Case D1, D2, D3, D4):
Hide

Suppress

FE & GE

FE & GE

+
+
+
+
+
+
+
+

+
+
+
+
+
+
+
+

Abbreviations
F for Fault
A for Alarm
W for Warning
H for High alarm
L for Low alarm
H for High warning
L for Low warning
C for Coincidence

Table 5.10 Disabling from Faceplate


.

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

72 (87)

B) Disabling from Logic


The Table 5.11 and Table 5.12 shows the Indication Letters for the disabled Alarms when Hiding
from Logic or Suppress from Logic is activated.
The presentation is different for Faceplate Elements and Graphic Elements. The reason why the
status black H and black S not is shown in the Graphic Elements is that these operations in this
case are set from Logic and not by Operator and therefore not should disturb the Operator.

The presentation is different for Faceplate Elements (FE) and Graphic


Elements (GE).

Operation before Alarm occurs (Case D5, D7):


Hiding

Suppress

FE

FE

+
+
+
+
+
+
+
+

+
+
+
+
+
+
+
+

GE

Abbreviations
F for Fault
A for Alarm
W for Warning
H for High alarm
L for Low alarm
H for High warning
L for Low warning
C for Coincidence

Table 5.11 Disabling from Logic before Alarm


Operation after Alarm occurs (Case D6, D8):
Hiding

Hiding

FE 1)

GE 1)

Suppress

Suppress

Suppress

Suppress

FE,
Unack

GE,
Unack

FE,
Ack

GE,
Ack

+
+
+
+
+
+
+
+

+
+
+
+
+
+
+
+

Abbreviations
F for Fault
A for Alarm
W for Warning
H for High alarm
L for Low alarm
H for High warning
L for Low warning
C for Coincidence

Table 5.12 Disabling from Logic after Alarm


The Hiding from Logic is only for Predictable Alarms i.e. the Alarm will not be affected and the
Hiding will not be enabled.
Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

73 (87)

C) Disabling from Parameter


The Table 5.13 shows the Indication Letters for the disabled Alarms when Disabling from
Parameter is activated.
The presentation is different for Faceplate Elements and Graphic Elements. The reason why the
status black D not is shown in the Graphic Elements is that these operations in this case are set
from Parameter and not by Operator and therefore not should disturb the Operator.

The presentation is different for Faceplate Elements (FE) and Graphic


Elements (GE).

Operation before or after Alarm (Case D9, D10):


PDAxx<>2
FE & GE

Abbreviations
F for Fault
A for Alarm
W for Warning
H for High alarm
L for Low alarm
H for High warning
L for Low warning
C for Coincidence

Table 5.13 Disabling from Parameter

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

74 (87)

5.13 Presentation details


Here are a couple of chapters that describes how Alarm, Coincidences, Status and other should be
presented with different colors in HMI.
5.13.1 Alarms
Alarm

A / HH / LL
- Cat. Based: Red background with white text
- Cat. Based: Grey background with black text when Disabling alarm
- Prio. Based: Color dependent on Priority
Warning
W / WH / WL
- Cat. Based: Yellow background with black text
- Cat. Based: Grey background with black text when Disabling alarm
- Prio. Based: Color dependent on Priority
Signal fault
F (Fault)
- Cat. Based: Magenta background with white text
- Cat. Based: Grey background with black text when Disabling alarm
- Prio. Based: Color dependent on Priority
5.13.2 Coincidence
Coincidence C
- Safety action and Blocking Safety action will not be performed
- Cat. Based: Yellow background with black text
- Prio. Based: Color dependent on Priority
5.13.3 Status
All statuses are presented with blue background and white text
Force
F
- Optional value forced to I/O signals connected to the function blocks
Suppress
S
Block
Hide
-

Suppress the source to the alarm Alarm state will not give actions or be presented
Alarms will not be presented in the Alarm list Grey indication in FP and Graphic Elements
B
Blocks the actions that are caused by alarm state or safety action Alarms will be presented
H
Alarms will not be presented in the Alarm list Grey indication in FP and Graphic Elements

5.13.4 Safety action


Safety action LSL / LSH / FSL / FSH
- Safety action Safe position
- White color

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

75 (87)

5.13.5 Priority in Graphic Elements


In general the following applies for the Priority for all alarms:
1)

Unacknowledged alarms has higher priority than Acknowledged

2)

In NORSOK the Alarms will be Prioritized according to Category

3)

In YA-711 the Alarms will be Prioritized according to Priority (1-1000)

4)

The Alarms can be Disabled in 5 ways, see Chapter 5.10

The Table 5.14 shows how the different states should be presented when they are presented at
the same position in a Graphic Element.
Priority
1
2
3
4

Alarm in YA-711

Alarm in NORSOK

Status

According to Priority
According to Priority
According to Priority
According to Priority

Coincidence
Alarm
Warning
Fault

Test
Force
Suppress
Block
Hide

C
A / HH / LL
W / WH / WL
F

T
F
S
B
H

Table 5.14 Priority in Graphic Elements

5.13.6 Priority in Faceplate


The Table 5.15 shows how the different states should be presented when they are presented at
the same position in a Faceplate Element.
Priority

Status Suppress

Status Block

Status Hide

1
2

Suppress from FP
Suppress from Logic

Block from FP
Block from Logic

Hide from FP
Hide from Logic

Table 5.15 Priority in Faceplate

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

76 (87)

5.14 Revision History in PG


All PG-elements and Faceplate-elements must be marked with an internal Revision History as shown
in Figure 5.48 below. For each change, the Revision History must be updated with:
<Rev. No> <Date> <Comment including FEM number> <Signature>

Figure 5.48 Revision History in PG


The Revision History must be included in all the following PG-elements:
1) reXXX Graphic Elements PG2 in Object Type Structure
2) xTabXXX Faceplate Elements PG2 in Object Type Structure
3) xIndXXX Internal PG elements in Object Type Structure
4) Indicators Internal Graphics Toolbox Items in Graphics Structure

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

77 (87)

6. References
Number
[Re1]

Document Identity
3BSE030335

Document Title
ABB Engineering Graphics

[Re2]

Q000083-SW-SIL-0002

REUSE Requirements for SIL1-2 HSI

[Re3]

Q000083-SW-WP-0004

[Re4]

Q000083-SW-GL-0006

REUSE Operator Workplace SV5.0 Recommended Settings


REUSE AC800 FB Programming Guidelines

[Re5]

Q000083-SW-OV-0004

REUSE Libraries Colors Overview

[Re6]

Q000083-SW-GL-0003

REUSE Process Display Guidelines

[Re7]

Q000083-SW-ALRM-0003

REUSE Alarm Implementation in Applications


Table 6.1 References

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

78 (87)

7. Revisions
Revision Chapter
-d1
Ad1
Ad2
Ad3
Ad4
Ad5
Ad6
Ad7
Ad8
Ad9
A
Bd1

All
All
5
5
5
5.6
5
5
5
5
5
No change
5

Bd2
Bd3
Bd4

All
All
All

Bd5
B
Cd1

All
All
Ch5.8 to
Ch5.12

Cd2
Cd3

Ch5.8 to
Ch5.12
Fig 5.30

All

Description

Date

Created from revision 7.2-0


Approved
Added details about Bar graphs
Added details about Input Type6
Added details about Bar graphs
Added details about Group boxes
Removed some old VB examples
Clarified one detail about the Grid lines
Added numbers for Cause & Effect elements
Added description for Hotspot and Views
Added details about Revision History in PG
Ready for Approval. QE: Subba Reddy
Updated Ch5.8 with motivation for Select-And-Confirm.
Added HMI to the Document Title
Some minor adjustments before Review
Updated after pre-review
Performed minor changes and corrected spelling mistakes
during review.
Updated after review
Ready for Approval, QE R.Karlsson
Updated for FEM N-02-0213

07.04.09/TSN
07.04.09/TSN
25.05.09/EL
04.06.09/EL
12.10.09/EL
19.10.09/EL
24.02.10/EL
01.03.10/EL
16.03.10/EL
04.05.10/EL
08.06.10/EL
09.07.10/SR
30.08.10/EL

Minor adjustments during review


Adjusted figure after review comment

2011-06-15/
OSR
2011-06-17/EL

Ready for Approval. QE R.Karlsson

2011-06-20 /RK

13.10.10 /EL
14.10.10 /EL
2010-10-19/JH
2010-10-20/EL
2010-10-21/RK
2011-06-02/EL

Table 7.1 - Revision

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

79 (87)

Appendix A. Font size Calculation


The calculation of the Font size is shown below.

Figure A.1 Features determining the definition of the minimum visual angle

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

80 (87)

Ormen Lange - Recommendation of Font Size


The calculation of the Font size according to the Formulas above was done at Ormen Lange, and
the result is shown below.

Figure A.2 Ormen Lange recommendations

REUSE - Recommendation of Font Size


Since REUSE also recommends using 21 screens with resolution 1600x1200 the
recommendation of Font Size is the same as for Ormen Lange: 12 pts. The Font that REUSE
prefers to use is Tahoma Regular since Tahoma is the standard font in REUSE.

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

81 (87)

Appendix B. English abbreviations


The Table below shows the English abbreviations that preferably should be used when creating
parameters, variables and other code

Oil, Gas & Petrochemicals

English word

Abbreviation

Acknowledge

Ack

Acknowledged

Ack

Active

Act

Activated

Act

Alarm

Al

Asynchronous

Async

Auto Disabled

AutoDis

Automatic

Auto

Backward

Bwd

Boolean

Bool

Busy

Busy

Cascade

Casc

Channel

Chan

Command

Cmd

Communication

Comm

Condition

Cond

Connect

Conn

Connected

Conn

Connection

Conn

Control

Ctrl

Cyclic

Cyc

Decrement

Decr

Delay

Delay

Description

Descr

Detection

Dct

Deviation

Dev

Device

Dev

Disable

Dis

Distribute

Distr

Duration

Dur

Elapsed

Elap

Enable

En

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

82 (87)

Oil, Gas & Petrochemicals

English word

Abbreviation

Error

Err

External

Ext

Feed back

FB

Feed forward

FF

Forward

Fwd

Foundation Fieldbus

FF

Filter

Filt

Force

Force

Function block

FB

Gain Scheduling

GS

Hysteresis

Hyst

In

In

Integer

Int

Inactive

Inact

Increment

Incr

Inhibit

Inh

Interaction

Iact

InteractionPar

InteractionPar

Interlock

Ilock

Limit

Lim

Local

Loc

Manual

Man

Master

Memory

Mem

Message

Msg

Mode

Mode

Negative

Neg

Number Of

NoOf

Object

Obj

Occurrence

Occ

Out

Out

Panel

Pan

Parameter

Par

Periodic

Per

Positive

Pos

Preset value

PV

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

83 (87)

English word

Abbreviation

Print

Prt

Process value

PV

Pulse

Pulse

Ready

Rdy

Reference

Ref

Real

Real

Relative

Rel

Request

Req

Reserve

Rsv

Reset

Rst

Select

Sel

Set point

Sp

Signal

Sig

Simple

Smp

Simulate

Sim

Slave

Source

Src

Start

Start

Status

Stat

Stop

Stop

String

Str

Supervision

Sup

Synchronous

Sync

Time

Unacknowledged

Unack

Update

Upd

Value

Val
Table B.1- English abbreviations

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

84 (87)

Appendix C. Norwegian abbreviations


The Table below shows the Norwegian abbreviations that preferably should be used when
creating texts for HMI and for Alarm and Event lists:
Norwegian word

Abbreviation

akkumulert
gjennomsnitt
elektro
identitet
bryter
overvkning
spenning
sikring
transformator
tilgjenglig
aktivitet
hy
hy hy
lav
lav lav
hysterese
grense
Mlt Verdi
intern
ekstern
Set Punkt
posisjon
kalkulert
vedlikehold
utgang
inngang
kortslutning
reduksjon
sekunder
temperatur
densitet
Nd Avstengnings System
Prosess Avstengnings System
trykk (Pressure)
temperatur (Temperature)
densitet (Density)
strm (Flow)
Feedback
Endebryter open
Endebryter lukket
Pulset start
Pulset stopp

akk.
gj.sn.
el.
id.
br.
overvkn.
sp.
sikr.
transf.
tilgj.
akt.
H
HH
L
LL
hyst.
gr.
M.V.
int.
ekst.
S.P.
pos.
kalk.
vedl.
utg.
inng.
kortsl.
red.
sek.
temp.
dens.
NAS
PAS
P
T
D
F
XG
XGH
XGL
YH
YL

Table C.1 - Norwegian abbreviation


Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

85 (87)

Appendix D. SI Units
The Table below shows most of the standard SI Units, derived units and other units that
preferably should be used:
Name

Symbol

Base/Derived quantity /Other

meter
kilogram
second
ampere
kelvin
mole
candela
square meter
cubic meter
meter per second
kilogram per cubic meter
hertz
Volt
Celsius

m
kg
s
A
K
mol
cd
m2
m3
m/s
kg/m3
Hz
V
deg C

length
mass
time
electric current
thermodynamic temperature
amount of substance
luminous intensity
area
volume
speed
mass density
frequency
voltage
temperature in Celsius
Table D.1 - SI units

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

86 (87)

Appendix E. Indicator & Tab naming rules


When the projects are creating the Process Displays they have to insert the Graphic Elements into
the Displays. To make it easier to see the Graphic Elements the naming of the Indicators and
Faceplate Tabs must be clearly separated from the names of the Graphic Elements, see figure
below.

Figure E.1 - Indicators & Faceplate Tabs naming

The naming rules for Indicators and Faceplate Tabs are described below.

Oil, Gas & Petrochemicals

OGP REUSE Solutions

REUSE HMI Library Programming Guidelines

Q000083-SW-GL-0001

Issued by department

Date

Language

Rev. ind.

Page

PAOG/AKE

2011-06-20

en

87 (87)

Naming rules for Indicators


Syntax: x + Ind + Type + no
Example: xIndAl1, xIndEr1, xIndEr2
Type is described in Table below:
No
Type
1
Al
2
Er
3
St
4
Md
5
Br
6
Pu
7
Co
8
Va
9
Fw
10
Na
11
He

Description
Alarm
Error
Status
Modus
Breaker
Pump
Coincidence
Valve
Four way valve
Not available
Heater

Table E.1- Indicator Types


Naming rules for Tabs
Syntax: x + Tab + Content + [no]
Example: xTabStatus, xTabTrend, xTabForce1, xTabForce2
NOTE: Try to use only short names for the content, max 6 letters
Aspect Description
To make sure that the Aspects for a Type is easy to recognize in for instance an export-file, the
Aspect Description must be very clear, see figure below.

Figure E.2 Aspect Description


The Aspect Description must contain Type + Clear Description
Example: SBC_F Faceplate Tab Status
Oil, Gas & Petrochemicals

OGP REUSE Solutions

You might also like