Professional Documents
Culture Documents
Q000083 SW GL 0001
Q000083 SW GL 0001
Q000083 SW GL 0001
REUSE Guidelines
HMI Library Programming
Doc. kind
Guideline
Title
ABB AS
Resp.
Project
dept.
REUSE
PAOG/AKE
Approved
Document identity
Lang.
Q000083-SW-GL-0001
en
No. of sh.
1
87
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.
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
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
4 (87)
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 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
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.
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
All abbreviations in Faceplates, Graphic Elements, Alarm/Event lists must be done according
to Appendix B and Appendix C
PG Graphics supports both Category Based and Priority Based alarm handling
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
6 (87)
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
7 (87)
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
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
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
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.
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
9 (87)
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
10 (87)
General
ON/OFF
symbol
Electric
heater
Motor
Horizontal
Vertical
Horizontal
Vertical
Pump
The arrow
indicates
the flow
direction
Valve
Damper
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
11 (87)
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
12 (87)
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.
HZV-20-0157
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
13 (87)
Detail Picture
C F B
PSD 5.32
B
B
Blocked
Fault
Coincidence
Shutdown level
Shutdown level
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
14 (87)
B
Blocked
Detector symbol
Fault
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.
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
16 (87)
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
17 (87)
6) Input , Type1
7) Input , Type2
-
Output
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
18 (87)
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
19 (87)
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
20 (87)
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
21 (87)
(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 Hy alarm
L for Lav alarm
H for Hy varsel
L for Lav varsel
Colors
- Indications with gray background and green text, example
- Indications with blue background and white text, example
, symbolizes Normal
, symbolizes Not Normal
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
22 (87)
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.
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
23 (87)
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)
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.
4.12 Comments
-
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
25 (87)
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.
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
26 (87)
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
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
27 (87)
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.
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
28 (87)
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
29 (87)
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
30 (87)
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
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
-
Dimmed Colors:
Static information that
operator dont need to
pay attention to during
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
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
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.
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
33 (87)
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
34 (87)
On - Running
Valve/damper open
General ON/OFF
symbol
Electric heater
Motor
Horizontal
Vertical
Horizontal
Vertical
Pump
Fan
The arrow indicates
flow direction
Valve
Damper
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
35 (87)
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
36 (87)
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.
A B
Status
Alarm
Figure 5.6 - Inputs ESD
HZV-20-0157
Status
Equipment status (open/closed, running/not running)
Fault (valve not closed, pump not stopped, etc)
Figure 5.7 - Outputs ESD
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
37 (87)
Detail Picture
C F B
PSD 5.32
B
B
Status
Fault
Coincidence
Shutdown level
Shutdown level
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
38 (87)
B
Status
Detector
Fault
e
s
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.
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
39 (87)
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
40 (87)
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
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
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.
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
42 (87)
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
43 (87)
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.
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
45 (87)
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
46 (87)
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
47 (87)
5.8 PG Faceplates
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
48 (87)
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
49 (87)
Group Boxes
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
50 (87)
Bar graphs
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
51 (87)
Symbols in Faceplate
-
Warnings in Faceplate should be a Warning-triangle with red text describing the information
Font: Tahoma, 11pts , Bold, Red
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
53 (87)
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)
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
54 (87)
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
55 (87)
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
56 (87)
1)
2)
3)
4)
Complete text for Option is shown in menu: Block HH on, Block HH off
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
57 (87)
Important Selected
2) Not Important
Not Active
Active
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
58 (87)
- 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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
59 (87)
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
60 (87)
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)
Eng: Open
Eng: Close
Eng: Start
Eng: Stop
Nor: pne
Nor: Steng
Nor: Start
Nor: Stop
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
61 (87)
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
62 (87)
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
63 (87)
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
64 (87)
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
65 (87)
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
66 (87)
Digital Force:
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
67 (87)
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
68 (87)
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
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 Hy alarm
L for Lav alarm
H for Hy varsel
L for Lav varsel
Priority/Category
Priority/Category
Priority/Category
Priority/Category
Independent
Independent
Independent
Independent
Independent
Independent
Independent
, symbolizes Normal
, symbolizes Not Normal
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
69 (87)
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
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)
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
70 (87)
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
71 (87)
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
72 (87)
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
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
73 (87)
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
74 (87)
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
75 (87)
2)
3)
4)
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
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
76 (87)
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
[Re3]
Q000083-SW-WP-0004
[Re4]
Q000083-SW-GL-0006
[Re5]
Q000083-SW-OV-0004
[Re6]
Q000083-SW-GL-0003
[Re7]
Q000083-SW-ALRM-0003
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
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
2011-06-15/
OSR
2011-06-17/EL
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
79 (87)
Figure A.1 Features determining the definition of the minimum visual angle
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
80 (87)
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
81 (87)
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
82 (87)
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
83 (87)
English word
Abbreviation
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
84 (87)
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
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
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
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
86 (87)
The naming rules for Indicators and Faceplate Tabs are described below.
Q000083-SW-GL-0001
Issued by department
Date
Language
Rev. ind.
Page
PAOG/AKE
2011-06-20
en
87 (87)
Description
Alarm
Error
Status
Modus
Breaker
Pump
Coincidence
Valve
Four way valve
Not available
Heater