0% found this document useful (0 votes)
77 views224 pages

Symphony Splus Scada Operations - 3.3 - Database - Reference - User - Manual

Uploaded by

David Vasquez
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
77 views224 pages

Symphony Splus Scada Operations - 3.3 - Database - Reference - User - Manual

Uploaded by

David Vasquez
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 224

INDU STRIAL AU TO MAT IO N

ABB Ability™ Symphony® Plus


S+ Operations 3.3 Database Reference
User manual

INDU STRIAL AU TO MAT IO N

ABB Ability™ Symphony® Plus


S+ Operations 3.3 Database Reference
User manual
Notice
This document contains information about one or more ABB products and may include a description of or a
reference to one or more standards that may be generally relevant to the ABB products. The presence of any
such description of a standard or reference to a standard is not a representation that all of the ABB products
referenced in this document support all of the features of the described or referenced standard. In order to
determine the specific features supported by a particular ABB product, the reader should consult the product
specifications for the particular ABB product.

ABB may have one or more patents or pending patent applications protecting the intellectual property in the
ABB products described in this document.

The information in this document is subject to change without notice and should not be construed as a
commitment by ABB. ABB assumes no responsibility for any errors that may appear in this document.

Products described or referenced in this document are designed to be connected and to communicate
information and data through network interfaces, which should be connected to a secure net-work. It is the sole
responsibility of the system/product owner to provide and continuously ensure a secure connection between
the product and the system network and/or any other networks that may be connected.

The system/product owners must establish and maintain appropriate measures, including, but not limited to,
the installation of firewalls, application of authentication measures, encryption of data, installation of antivirus
programs, and so on, to protect these products, the network, its system, and interfaces against security
breaches, unauthorized access, interference, intrusion, leakage, and/or theft of data or information.

ABB performs functionality testing on the products and updates that we release. However, system/product
owners are ultimately responsible for ensuring that any product updates or other major system updates (to
include but not limited to code changes, configuration file changes, third-party software updates or patches,
hardware change out, and so on) are compatible with the security measures implemented. The system/product
owners must verify that the system and associated products function as expected in the environment in which
they are deployed.

In no event shall ABB be liable for direct, indirect, special, incidental or consequential damages of any nature or
kind arising from the use of this document, nor shall ABB be liable for incidental or consequential damages
arising from use of any software or hardware described in this document.

This document and parts thereof must not be reproduced or copied without written permission from ABB, and
the contents thereof must not be imparted to a third party nor used for any unauthorized purpose.

The software or hardware described in this document is furnished under a license and may be used, copied, or
disclosed only in accordance with the terms of such license.

This product meets the requirements specified in EMC Directive 2014/30/EU and in Low Voltage Directive
2014/35/EU.

The crossed–out wheeled bin symbol on the product and accompanying documents means that used
electrical and electronic equipment (WEEE) should not be mixed with general household waste. If you
wish to discard electrical and electronic equipment (EEE), please contact your dealer or supplier for
further information.

Disposing of this product correctly will help save valuable resources and prevent any potential negative effects
on human health and the environment, which could otherwise arise from inappropriate waste handling.

Trademarks and copyright


Symphony and Symphony Plus are a registered or pending trademark of ABB S.p.A.

Ability is a trademark of ABB.

All rights to copyrights, registered trademarks, and trademarks reside with their respective owners.

Copyright © 2011-2020 ABB. All rights reserved.

Release: April 2020

Document Number: 2VAA000830-330

Revision: A
TABLE OF CONTENTS

1. ABOUT THIS BOOK ..........................................................................14


1.1 Scope ................................................................................................................... 14

1.2 Intended User...................................................................................................... 14

1.3 Document Structure ........................................................................................... 14

2. DATABASE STRUCTURE ................................................................15


2.1 Outline ................................................................................................................. 15

2.2 Analog tags ......................................................................................................... 15

2.3 Digital Tags ......................................................................................................... 15

2.4 Tag Database ...................................................................................................... 15

2.5 General Parameters............................................................................................ 16

2.5.1 Generic Tag - General Parameters.................................................................... 16

2.5.2 Generic Tag - Process Parameters ................................................................... 19

2.5.3 Generic Tag - Process Parameters (continued)................................................. 22

2.5.4 Generic Tag – Generic Scanner Input Parameters ............................................ 24

2.5.5 Generic Tag – Generic Scanner Output Parameters ......................................... 25

2.5.6 Generic Tag - Symphony Input Parameters ...................................................... 25

2.5.7 Generic Tag - Alarm Processing Parameters .................................................... 26

2.5.8 Generic Tag - Alarm Processing Parameters (continued) ................................. 28

2.5.9 Generic Tag – Alarm Comment Parameters ...................................................... 28

2.5.10 Generic Tag – Alarm Categories ....................................................................... 29

2.5.11 Generic Tag – Network Parameters .................................................................. 29

2.5.12 Generic Tag - Application Parameters ............................................................... 30

2.5.13 Generic Tag - Application Parameters (continued) ............................................ 31

2.5.14 Generic Tag – Tag Extra References ................................................................ 31

2.5.15 Generic Tag – Tag Control References ............................................................. 32

2.5.16 Generic Tag – Acquisition .................................................................................. 33


TABLE OF CONTENTS

2.5.17 Generic Tag – DI General .................................................................................. 34

2.5.18 Generic Tag – DI Process ................................................................................. 35

2.5.19 Generic Tag – DI Feedback ............................................................................... 37

2.5.20 Generic Tag - OPC Parameters......................................................................... 38

2.5.21 Server DA Refresh Rates .................................................................................. 39

2.5.22 Read Types ....................................................................................................... 39

2.5.23 Generic Tag - OPC Parameters (continued) ...................................................... 39

2.5.24 Generic Tag - Hardware Description Parameters .............................................. 40

2.6 Plant Areas .......................................................................................................... 41

2.7 Digital Tag Definition .......................................................................................... 41

2.7.1 Digital Tag - General Parameters ...................................................................... 41

2.7.2 Digital Tag - Process Parameters ...................................................................... 43

2.7.3 Digital Tag - Symphony Input Parameters ......................................................... 44

2.7.4 Digital Tag - Symphony Input Parameters (continued) ...................................... 44

2.7.5 Digital Tag – Command Parameters.................................................................. 45

2.7.6 Digital Tag - Alarm Processing Parameter ......................................................... 45

2.7.7 Digital Tag - Alarm Comment Parameters ......................................................... 46

2.7.8 Digital Tag - Totalization Parameters ................................................................. 46

2.7.9 Digital Tag - Device Status Parameters ............................................................. 47

2.7.10 Digital Tag – Documentation Parameters .......................................................... 48

2.8 Analog Tag Definition ........................................................................................ 49

2.8.1 Analog Tag - General Parameters ..................................................................... 49

2.8.2 Analog Tag - General Parameters (continued) .................................................. 51

2.8.3 Analog Tag – Generic Scanner Input Parameters ............................................. 51

2.8.4 Analog Tag - Alarm Processing Parameters ...................................................... 52

2.8.5 Analog Tag - Alarm Level Parameters ............................................................... 53

2.8.6 Analog and Digital Tag – Control References .................................................... 57

2.8.7 Analog Tag – Alarm Option Parameters ............................................................ 60


TABLE OF CONTENTS

2.8.8 Analog Tag – Alarm Comment Parameters ....................................................... 64

2.8.9 Analog Tag - Totalization Parameters ............................................................... 65

2.8.10 Analog Tag – Documentation Parameters ......................................................... 67

2.8.11 Analog Tag - Hardware Description Parameters ............................................... 68

2.9 Alarm Categories ................................................................................................ 68

2.10 Alarm Printers ..................................................................................................... 71

2.11 Alarm Comments ................................................................................................ 72

2.11.1 Outline ............................................................................................................... 72

2.11.2 Alarm Comment - Definition Parameters. .......................................................... 72

2.12 Atom Configuration ............................................................................................ 72

2.13 Engineering Units ............................................................................................... 78

2.13.1 Outline ............................................................................................................... 78

2.13.2 Engineering Units Definition .............................................................................. 79

2.13.3 Engineering Unit - Definition Parameters ........................................................... 79

2.14 Text Selector ....................................................................................................... 79

2.14.1 Outline ............................................................................................................... 79

2.14.2 Text Selector - Definition Parameters ................................................................ 79

2.15 Alarm Management Subsystem ........................................................................ 79

2.15.1 Alarm Lists ......................................................................................................... 79

2.15.2 Outline ............................................................................................................... 80

2.15.3 Alarm Group Database ...................................................................................... 80

2.15.4 Alarm Group Definition ...................................................................................... 80

2.15.5 Alarm Groups – General Parameters ................................................................ 80

2.15.6 Alarm Groups – Presentation Parameters ......................................................... 81

2.15.7 Alarm Groups – Security Parameters ................................................................ 82

2.15.8 Alarm Attributes ................................................................................................. 82

2.15.9 Alarm list ............................................................................................................ 82

2.15.10 Alarm list Group ............................................................................................... 83


TABLE OF CONTENTS

2.16 Audible Alarms ................................................................................................... 83

2.16.1 Outline ............................................................................................................... 83

2.16.2 Audible Alarms Definition ................................................................................... 83

2.16.3 Audible Alarm - Definition Parameters ............................................................... 83

2.17 Calculation .......................................................................................................... 84

2.17.1 Calculations Outline ........................................................................................... 84

2.17.2 Calculation Formula Syntax ............................................................................... 84

2.17.3 Character Set..................................................................................................... 84

2.17.4 Operands ........................................................................................................... 84

2.17.5 Numbers ............................................................................................................ 84

2.17.6 Tag Names ........................................................................................................ 85

2.17.7 Internal Variables or Constants.......................................................................... 85

2.17.8 Functions ........................................................................................................... 85

2.17.9 Macros ............................................................................................................... 85

2.17.10 Comments ....................................................................................................... 85

2.17.11 C like comments .............................................................................................. 85

2.17.12 FORTRAN like comments................................................................................ 85

2.17.13 C++ like comments .......................................................................................... 85

2.17.14 Multiple Line Statements ................................................................................. 85

2.17.15 Expressions ..................................................................................................... 86

2.17.16 Calculation example ........................................................................................ 86

2.17.17 Calculation Database ....................................................................................... 86

2.17.18 Calculation – General Parameters ................................................................... 87

2.17.19 Calculation – Log Parameters.......................................................................... 87

2.17.20 Calculation - Frequency Parameters ............................................................... 88

2.17.21 Calculation – Formula File Parameters ............................................................ 88

2.17.22 Calculation – Network Parameters .................................................................. 89

2.17.23 Calculation – Macro Function Parameter ......................................................... 89


TABLE OF CONTENTS

2.18 Calculation Operators and Functions ............................................................... 90

2.18.1 Calculation - Operator Priorities ......................................................................... 90

2.18.2 Parentheses....................................................................................................... 90

2.18.3 Calculation - Arithmetic Operators ..................................................................... 90

2.18.4 Calculation - Logical Operators.......................................................................... 91

2.18.5 Calculation - Relational Operators ..................................................................... 91

2.18.6 Control Structures .............................................................................................. 91

2.18.7 Intrinsic Functions .............................................................................................. 92

2.18.8 Calculation - Execution Functions...................................................................... 93

2.18.9 Calculation - Logical Functions .......................................................................... 93

2.18.10 Calculation - Mathematical Functions .............................................................. 94

2.18.11 Calculation - Tag Functions ............................................................................. 96

2.18.12 Calculation - Time Functions ........................................................................... 97

2.18.13 Calculation - Steam Functions ......................................................................... 98

2.18.14 Calculation - Gas Property Functions .............................................................. 99

2.18.15 Calculation - Sea Water Function .................................................................. 100

2.18.16 Calculation - Sea Water Function Indices ...................................................... 100

2.18.17 Calculation - Fuel Combustion Functions based on Flue Gas ....................... 100

2.18.18 Calculation - Combustion Functions based on Fuel Characteristics .............. 101

2.18.19 Wet Air Functions .......................................................................................... 102

2.18.20 Calculation - Wet Air Functions...................................................................... 103

2.18.21 Data File Functions ........................................................................................ 104

2.18.22 Read/Write File Formats ................................................................................ 104

2.18.23 Calculation - Historical Functions ................................................................... 104

2.18.24 Database Functions ....................................................................................... 107

2.19 Trend Groups .................................................................................................... 108

2.19.1 Examples of Trend Groups .............................................................................. 109

2.19.2 Trend Group Database .................................................................................... 109


TABLE OF CONTENTS

2.19.3 Generic Trend Group Definition ....................................................................... 109

2.19.4 Generic Trend Group – General Parameters ................................................... 109

2.19.5 Trend Group - Archiving Types ........................................................................ 112

2.19.6 Generic Trend Group – Presentation Parameters ........................................... 112

2.19.7 Generic Trend Group – Link Parameters ......................................................... 114

2.19.8 Generic Trend Group – Log Parameters ......................................................... 115

2.19.9 Generic Trend Group - Tag List Parameters ................................................... 115

2.19.10 Generic Trend Group - Network Parameters ................................................. 117

2.19.11 Realtime Trend Group Definition ................................................................... 117

2.19.12 History Group Definition ................................................................................. 117

2.19.13 History Trend Group - History Parameters (Archiving). ................................. 117

2.19.14 History Trend Group - History Parameters (Sampling) .................................. 118

2.19.15 History Trend Group - History Parameters (Deriving) .................................... 119

2.19.16 History Trend Group - Time Function Parameters ......................................... 119

2.19.17 History Trend Group – Post Trip Log Parameters.......................................... 120

2.20 Report Database ............................................................................................... 121

2.20.1 Report Definition .............................................................................................. 121

2.20.2 Report - General Parameters........................................................................... 121

2.20.3 Report - Activation Parameters ........................................................................ 122

2.20.4 Report - Archiving Parameters......................................................................... 122

2.20.5 Report - Printing Parameters ........................................................................... 123

2.20.6 Report - Excel Parameters............................................................................... 123

2.20.7 Report - SOE Parameters ................................................................................ 124

2.20.8 Excel Work-Sheet ............................................................................................ 124

2.20.9 Public and Themodynamic Functions .............................................................. 124

2.20.10 Libraries of Functions .................................................................................... 125

2.20.11 Reports - Public Functions ............................................................................. 125

2.20.12 Report - Steam Functions .............................................................................. 128


TABLE OF CONTENTS

2.20.13 Report - Gas Property Functions ................................................................... 129

2.20.14 Report - Sea Water Function ......................................................................... 129

2.20.15 Report - Fuel Combustion Functions based on Flue Gas .............................. 129

2.20.16 Report - Combustion Functions based on Fuel Characteristics ..................... 130

2.20.17 Report - Wet Air Functions............................................................................. 131

2.21 Menu and Tool-bars ......................................................................................... 132

2.21.1 Outline ............................................................................................................. 132

2.21.2 Menu and Tool-bar Database .......................................................................... 132

2.21.3 Menu and Tool-bar Definitions ......................................................................... 132

2.21.4 Menu and Tool-bar - Identification Parameters ................................................ 136

2.21.5 Menu and Tool-bar - Item Types...................................................................... 136

2.21.6 Menu and Tool-bar – Action Parameters ......................................................... 137

2.21.7 Menu and Tool-bar – Action Types .................................................................. 137

2.21.8 Menu and Tool-bar - Standard Command Lines .............................................. 138

2.21.9 Menu and Tool-bar - Presentation Parameters ................................................ 139

2.21.10 Menu and Tool-bar - Standard Normal Icons ................................................. 140

2.21.11 Menu and Tool-bar - Standard Alarm Icons ................................................... 140

2.21.12 Menu and Tool-bar - Standard Blink Icon ...................................................... 140

2.21.13 Menu and Tool-bar - Presentation Parameters (continued) ........................... 140

2.21.14 Menu and Tool-bar - Allowed Parameters ..................................................... 141

2.21.15 Menu and Tool-bar - Privilege Parameters .................................................... 141

2.22 Network Parameters ......................................................................................... 142

2.23 Network subsystem: Nodes............................................................................. 143

2.23.1 Node Database ................................................................................................ 143

2.23.2 Node Definition ................................................................................................ 143

2.23.3 Node - General Parameters ............................................................................. 143

2.23.4 Node - Alarm Process Parameters .................................................................. 144

2.23.5 Node - Network Parameters ............................................................................ 145


TABLE OF CONTENTS

2.23.6 Node – License ................................................................................................ 145

2.24 Security Subsystem: Security ......................................................................... 145

2.24.1 Security Database ........................................................................................... 146

2.24.2 Security - General Parameters ........................................................................ 147

2.24.3 Security - Access Control Parameters ............................................................. 148

2.24.4 Security - Tag Operation Parameters .............................................................. 148

2.24.5 Security - Privilege Parameters ....................................................................... 150

2.24.6 Security - Group and Level Parameters ........................................................... 151

2.24.7 Security - Remote Client Access Parameters .................................................. 151

2.24.8 Enhanced User Management .......................................................................... 152

2.24.9 Defining Windows Users .................................................................................. 152

2.24.10 Security - Default Settings ............................................................................. 153

2.25 Foreign Database Support Subsystem ........................................................... 154

2.25.1 Target Database Requirements ....................................................................... 154

2.25.2 Static Tables .................................................................................................... 155

2.25.3 Foreign Database Support - Tag Static Table (TAGS) .................................... 155

2.25.4 Foreign Database Support - Trend Groups Static Table (GROUPS) ............... 156

2.25.5 Dynamic Tables ............................................................................................... 157

2.25.6 Foreign Database Support - Tag Dynamic Table (RTDB) ............................... 157

2.25.7 Foreign Database Support - Alarm Dynamic Table (ALARMS) ....................... 158

2.25.8 Foreign Database Support - Group Dynamic Table (<group name>) .............. 158

2.25.9 Data Export Manager ....................................................................................... 159

2.25.10 Setup Guidelines ........................................................................................... 160

2.25.11 Tuning and Troubleshooting .......................................................................... 160

2.25.12 Command buffer overflow .............................................................................. 160

2.25.13 Duplicate values/primary key violation. .......................................................... 160

2.25.14 Accept Warning ............................................................................................. 161

2.25.15 Trace Query ................................................................................................... 161


TABLE OF CONTENTS

2.25.16 Alarm Table ................................................................................................... 161

2.25.17 Group Table ................................................................................................... 161

2.25.18 RTDB Table ................................................................................................... 161

2.25.19 Tag Table....................................................................................................... 161

2.26 Custom Data Base ............................................................................................ 161

2.26.1 Operator XY-Plot ............................................................................................. 161

2.26.2 Plot area specific configuration ........................................................................ 162

2.27 Database Snapshots ........................................................................................ 163

2.28 File Synchronization ........................................................................................ 163

2.29 Logical Colors................................................................................................... 163

2.30 Mail Configuration ............................................................................................ 164

2.31 Quality Attributes ............................................................................................. 165

2.32 Service Scheduler ............................................................................................ 166

2.33 Sequence of Events ......................................................................................... 167

2.34 USB Recording Devices ................................................................................... 167

2.35 User Favorites................................................................................................... 168

2.36 User Roles ......................................................................................................... 168

2.37 Users ................................................................................................................. 171

2.38 Work Place Layout ........................................................................................... 172

2.39 Themes .............................................................................................................. 176

3. OFF-LINE SYSTEM CONFIGURATION TABLES...........................177


3.1 Deck Files Configuration ................................................................................. 177

3.2 Builder BFIL – XML Format – File System General Definition ...................... 177

3.3 Builder BTIM- Time Definition ......................................................................... 179

3.4 Builder DBXRF - Database Field Assignment Definition .............................. 179

3.5 Builder BALC – Alarm List Column Definition ............................................... 182

3.6 Builder BALM - Alarm Message Definition ..................................................... 183

3.7 Message Subsystem - Dynamic Text Definition Symbol .............................. 183


TABLE OF CONTENTS

3.8 Builder BEMF - Error Message Definition....................................................... 183

3.9 Message Subsystem - Text Definition Symbols ............................................ 184

3.10 Color DB HNMCOL ........................................................................................... 184

3.11 Tag DB HNMNDC .............................................................................................. 184

3.12 Tag Types .......................................................................................................... 185

3.13 Tag Sources ...................................................................................................... 186

3.14 Default Color Map ............................................................................................. 188

3.15 Digital Tag Field Applicability.......................................................................... 190

3.16 ICI Action Codes ............................................................................................... 190

3.17 ICI Point Types.................................................................................................. 190

3.18 Time Units ......................................................................................................... 191

3.19 Instrument Types.............................................................................................. 191

3.20 Analog and Digital Tag Quality Bits ................................................................ 192

3.21 Analog (Only) Tag Quality Bits ........................................................................ 192

3.22 System Information: Tag Configuration Retrieving Parameters .................. 193

3.23 Tag Configuration Retrieving Parameters ...................................................... 200

3.24 Gas Index - Gas Molecular Weight .................................................................. 219

3.25 Item Types for Field Assignment .................................................................... 220

3.26 Word Offset Prefixes ........................................................................................ 220

3.27 Field Types ........................................................................................................ 220

3.28 Alarm Types ...................................................................................................... 221

3.29 Dynamic Symbols............................................................................................. 222

3.30 DataProcessor file - XML structure ................................................................. 222

3.30.1 DataProcessor file - XML structure .................................................................. 223


S+ Operations DB Reference DATABASE STRUCTURE

1. ABOUT THIS BOOK


1.1 Scope
The S+ Operations DB Reference user manual provides the list of all databases fields with the required format, description,
and range values.

1.2 Intended User


This manual can be used by personnel who performs the functions of a system manager or configuration manager on the
Symphony Plus application.

1.3 Document Structure


This document describes the structures of the databases for tags, trend groups and all databases are explained.

14 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

2. DATABASE STRUCTURE
The Table 2-1 provides description of the fields in the database.
Table 2-1: Database Structure

Item Description
Name Field name identification within the database.

Format Field format.

Allowed field formats are:


- character (char),
- integer (int) or
- real.

If a numeric (integer or real) field is left blank, it is treated as zero.


Width Field width.

It is the maximum number of characters or digits (including decimal point, if it is a real number)
allowed to assign a value to the field.
Opt/Mnd Optional or Mandatory field.

A field can be optionally (“O”) defined or it must be defined as mandatory (“M”). An optional
field, left undefined, may be loaded into the database with a default value or left blank (or zero)
depending on the definition of a default value in the cross reference database. In any case, the
item configuration is not rejected.
Description Field description.

Range Range of legal values.

Default Default value.

It applies to optional fields only and defines the value assigned to the field if the user does not
define a value.
Parameters Involved sizing parameter(s) (if any).

The sizing parameter may bound the range of values. It may be required to modify (e.g.
increase an upper limit) the size in order to allow assigning values specific to the application.

2.1 Outline
The tag database is unique for all tags in the system, although it may be loaded starting from different files that may be
merged at any time.
In order to simplify the description of the database structure, two major types of tag will be described separately.

2.2 Analog tags


The analog tags are used to display current value of an analog signal or a 32-bit status indicator, this can be either a 32-bit
floating point number or a 32-bit integer (I*4).

2.3 Digital Tags


The digital tags are used to display current value of a digital signal or a 16-bit status indicator.

2.4 Tag Database


The structure of a database file varies according to the user preferences. A database file includes all mandatory and optional
fields.
The fields are grouped into three main sections:
• Generic Tag Definition

• Digital Tag Definition

• Analog Tag Definition


2VAA000830-330 A 15
S+ Operations DB Reference DATABASE STRUCTURE

2.5 General Parameters


The fields listed in Table 2-2 defines the name and other additional parameters used for identifying a tag, and provides a
reference to the process.
The three key characteristics of a tag are, an index, the name, and the type.
Note: Tag name and tag type are mandatory fields.

2.5.1 Generic Tag - General Parameters


The following table lists the Generic Tag- General Parameters:
Table 2-2: Generic Tag- General Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
Tag index.

Integer This field identifies the tag by number. It must be unique for
{0, 1...512000}
INDEX 6 each tag within database. If omitted or zero, the first vacant
0 [mxindx]
Optional index will be allocated

TAGINDEX is an alias name for this field


Tag name.

This field identifies the tag by name. It may be a combination


of alphabetic characters (A-Z), numeric characters (0-9) and
special symbols ("+", "-", "_", "$"," "), with at least one
alphabetic character. This name must be unique for each tag
within database.

TAGNAME is an alias name for this field.

Note: For Historian, Character 50+22 Mandatory.


The historian tag name length is bigger due to additional path
information.

Note: Maximum Tag Name length in Control Engineering for


Harmony is 20, while it is 50 in S+ Operations.

Following characters in Tag Names are not allowed by S+


Character Operations:
50
Mandatory . dot
<string>
NAME < less than
<blank> [sznam]
> greater than
“ double quotes
, comma
^ caret
/ forward slash
\ backslash
: colon
? question mark
* asterisk
| - Bar
“ “ Space at the end of Name.:
@ at
# Number sign
% Percentage
& Ampersand
( ) Left and Right parenthesis
~ tilde
= Equal
` single quote
{ } Left and right Brackets
[ ] Left and Right Square Brackets

16 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

Note: Tag name must be unique within the database of the


system, node, and trend. If defined with same tag name as any
of the item name, then it will lead to error while importing,
creating, and modifying of such item entries in any of these
database.

For Example: Having Tagname as “SPOServerA” with the


DEVSTA tag type in Tag database, it is not allowed to have
“SPOServerA” defined in the node database, it also not
allowed in trend database as well.
Tag unique identification.

Character This field provides a unique identification in the Symphony


<string>
UID 36 Plus application history. It is assigned at import time. Export
<blank> None
Mandatory database to update the field in the XLSX file.

TAGUID are the alias name for this field.


Tag description.
Character
<string>
DESC 64 This field is a character string used to describe the tag on the
<blank> [szdesc]
Optional different outputs (alarm messages, reports, summaries, etc.).
TAGDESC is an alias name for this field.
Tag extended description
Character
<string>
EXTDESC 80
This field is a character string used to completely define the <blank> [szedsc]
Optional
tag or to enhance the tag description.

Integer Last Update Set by the


LASTUPDT
20 Last date and time of the configuration changes done. system

Character Tag type code.


TAGTYPE 16 UNDEF [sztype]
Mandatory For more details on Tag type, refer to Tag Types.
Character Tag source code.
TAGSRC 7 <blank> None
Optional For more details on Tag type, refer to Tag Sources.
Virtual Tag (Hidden)
Character
VIRTUALTAG
1 If set YES then tags are not listed in client applications.
For example: Not listed in Tag Summaries
Data Processor name

Application component name. The field defines the name of a


Character
program used to perform some specific handling (e.g. raw data <string>
DATA_PROC 64
conversion, marshalling the data) on the tag values. <blank> None
Optional
Mostly set by the importer/engineering tools based on
connectivity.
Data Processor index
Integer Set by the
DATA_INDX
6 system
Index of the Data Processer into the internal table.

Character Static Data Processor name <string>


DATA_PROCS
64 <blank> None

Plant tag name.

Character This field provides an additional name or description (i.e. KKS


<string>
CUSTTAGID 32 code) to the tag. Since it is only used for print/display
<blank> None
Optional purposes, this field may be duplicated.

PLANT_TAG is an alias name for this field.

Integer Alarm mimic priority (Lower number has higher priority) 0


ALDISPPRIO
6 None

2VAA000830-330 A 17
S+ Operations DB Reference DATABASE STRUCTURE

Primary display reference for View 1.

Name of a graphic display associated to the tag. It is only used


for Alarm Mimic. It contains name of workplace layout, mimic,
Character trend, diagnostic, and alarm. In case of workplace layout, use
<string>
PRIMDISP1 256 prefix “$WPL.”
<blank> None
Optional
PRIMDISP and PRALDI_NAM are alias name for this field.

Note: In case of ALARMMIC functionality enabled, the display


name defined must be limited to 18 characters only.
Primary display reference for View 2.

Name of a graphic display associated to the tag. It is only used


Character for Alarm Mimic. It contains name of workplace layout, mimic,
<string>
PRIMDISP2 256 trend, diagnostic, and alarm. In case of workplace layout, use
<blank> None
Optional prefix “$WPL.”.

Note: In case of ALARMMIC functionality enabled, the display


name defined must be limited to 18 characters only.
Primary display reference for View 3.

Name of a graphic display associated to the tag. It is only used


Character for Alarm Mimic. It contains name of workplace layout, mimic,
<string>
PRIMDISP3 256 trend, diagnostic, and alarm. In case of workplace layout, use
<blank> None
Optional prefix “$WPL.”.

Note: In case of ALARMMIC functionality enabled, the display


name defined must be limited to 18 characters only.
Primary display reference for View 4.

Name of a graphic display associated to the tag. It is only used


Character for Alarm Mimic. It contains name of workplace layout, mimic,
<string>
PRIMDISP4 256 trend, diagnostic, and alarm. In case of workplace layout, use
<blank> None
Optional prefix “$WPL.”.

Note: In case of ALARMMIC functionality enabled, the display


name defined must be limited to 18 characters only.
Primary trend group
Character
Name of the trend display associated to the tag. If mentioned, <string>
PRIMGROUP 50
it is listed in the context menu of the tag. <blank> None
Optional
Note: Context menu options is subject to the user privileges
Object Path n

Object path defines information that helps in building functional


and/or control structure of a tag. Once configured, the tags
appears in functional/control aspect fly-out of Operations
Character Explorer.
<string>
OBJECTPATn 254 For example, how functional and control structure looks in
<blank> None
Optional Aspect fly-out, refer to section Aspect fly-out in S+
Operations Operations User Manual (2VAA001150).

n denotes to 1 to 5

OBJECTPATH is an alias name for OBJECTPATH1.


Integer Plant Area
0
PLANTAREA 2
None
Optional PLANTUNIT is an alias name for this field.
Security level.

This field is checked whenever a user attempts to operate over


Integer {0, 1...16}
the tag. Only users whose security level is greater or equal to
SEC_LEVEL 2 0
what's hereby defined are enabled to access the tag for
Optional None
changes or control.

SECLEVEL is an alias name for this field.

18 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

Security group.
Integer {0, 1...32}
This field is checked whenever a user attempts to operate over
SEC_GROUP 2 0
the tag. Only users whose security group mask includes what's
Optional None
hereby defined are enabled to access the tag for changes or
control.

Note 1:
• The TAGUID code is generated internally for the first time and added to the Operations Engineering database (i.e.
each time a tag database build follows a database initialization).
• Once assigned, the TAGUID cannot be modified. Whereas tag name/tag index can be modified.

2.5.2 Generic Tag - Process Parameters


The fields listed in Table 2-3 and Table 2-4, provides the information for the tag configuration: initial condition (settings for
start-up time), alarm processing, playback saving, application program activation, output transferring, value exporting,
triggering (calculation, report, totalization), process control inhibit and so on.
Table 2-3: Generic Tag – Process Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
AL_REM Character Remote alarm processing flag. {Y, N} Y None
1
Optional If set, the alarm processing for this tag will be
performed remotely (PCU level or PLC level),
otherwise it will be performed locally (HSI level). This
field is meaningful for tags coming from smart
devices able to check for an alarm condition. For all
other tags, alarm processing is always performed
locally.
OFFSCINI Character Off Scan initially {Y, N} Y None
1
Optional If set, the tag is put off scan at S+ Operations start-
up time.

The operator must manually put on scan the tag.


OFFALINI Character Off alarm check initially {Y, N} Y None
1
Optional If set, the tag is put off alarm check at S+ Operations
start-up time.

The operator must manually put on alarm check the


tag.
LOCREMINH Character Local-Remote control inhibit enabled {Y, N} Y None
1
Optional
PLAYBACK Character Playback archive flag. {Y, N} Y None
1
Optional If set, the tag will be recorded on the playback
archive.

PLAYBACKCD and PLAY_BAKB0 are alias name for


this field
HIS_LTKEEP Character History long term archive {Y,N} N None
1
Optional Playback flag for long term archiving.

If set, reduced size data packets will be recorded on


the playback to save disk space.

The on-line configuration does not include the field.

Alias name - PLAYBACKLT


(FBN : original name of the manual “playbacklt”)

2VAA000830-330 A 19
S+ Operations DB Reference DATABASE STRUCTURE

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
Note: If set to Y the export, then every exception of
this tag is stored in the historian database
HIS_SERVER Character Historic Archive Server Name <string>
50 Name of the Historian server. <blank>
Optional None
TAGSPAREF Integer Tag spare float field 0
5 Spare field, where user can mention any value in float None
format.
TAGSPAREI Integer Tag spare integer field 0
5 Spare field, where user can mention any value in None
integer format.
HISINDEX Integer Historic Archive Index Set by the
5 Indicates the tag index in Historian system. It is used system
Optional to write the process data to the historian database. If
missing, no data will be written.
HISLIFETIM Integer Historic Archive Life Time <Number>
5 0
None
HISDEADB Integer Historic Archive Dead Band {0..100}
5 This value indicates dead band in percentage (%). If 0
Optional the current value is not different from the previous None
one based on the specified dead band it is not visible
in historian.
HISIDENTF Character Historic Archive Identifier <string>
50 Identifier of the tag in the historian system. With the <blank>
Optional HISINDEX it is necessary to map to a proper None
historian data backfill.
HISEXPCLAS Character Historic Archive Export Class <string>
50 <blank>
None
HISCOMCLAS Character Historic Archive Compression Class <string>
50 <blank>
None
TOT_LOG Integer Totalization log number. {0,1...100}
3 0 [n.tene]
Optional If greater than 0, it identifies the index into the analog
or digital totalization log archive at which tag values
are accumulated.

The on-line configuration includes the field within the


PV General Tab for analog tags and the DI Process
Tab for digital tags.
TRIP_NUM Integer Post trip group {0,1...100}
4 0 [mxhgrp]
Optional Triggered post trip group number.

If greater than 0, it identifies the post trip group to be


triggered when the tag goes into alarm or returns to
normal.
MAINTTRIG Integer Maintenance trigger level. {0, 1...100}
6 0 [n.hrtl]
Optional If greater than 0, it identifies the maintenance log to
be triggered when the tag goes into alarm or returns
to normal.

Triggering takes place on both state transitions.


MAILNAME Character Reference to Mail Configuration <string>
50 <blank>
None
AAP_NUM Integer Index to an application action program. If greater than { 0, 1...63}
2 0, this field defines a link, which will cause a user 0
Optional defined application program to be activated upon None
status changes for this tag.

20 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
The name of the application program must be
ALACnn, where nn is the number corresponding to
the value of the field.
TRIG_CALC Integer Triggered calculation block {0, 1...999}
3 0 [mxxcal]
Optional Triggered calculation block number. If greater than 0,
it identifies the calculation block to be triggered when
the tag goes into alarm or returns to normal.

Triggering takes place on both state transitions.


COMPONENT Character Component name <string>
20 <blank>
None
REP_NUM Integer Triggered report number. {0,1...50}
4 0 [nmrpts]
Optional If greater than 0, it identifies the report to be triggered
when the tag goes into alarm or returns to normal.

Triggering takes place on both state transitions.


DATA_PROC Character Application component name. <string>
64 <blank> [szdesc]
Optional The field defines the name of a program used to
perform some specific handling (e.g. raw data
conversion) on the tag values.
DATA_PROCF Character Data Processor Name <string>
64 <blank>
Optional None
DATA_PROCI Character Data Processor Item <string>
64 <blank>
Optional None
FACEPLATE Character Faceplate Name <string>
80 <blank> [szedsc]
Optional The field applies to control tags only and defines the
name of the program used to manage control
commands.
PRJNAME Character Engineering Project Name <string>
50 <blank> [szedsc]
Optional
FLYOUT Character Name of flyout popup <string>
80 <blank>
None
REF_TAG Character Reference Tag (for signal tags) <string>
50 <blank>
None
REF_TAGn Character Reference Tag n (for faceplate) <string>
254 <blank>
Where n denotes to 1 to 5 None
OPCOMMAND Character Tag for command and control {Y,N} N None
1
CMDFBCK Character Feedback after command {Y,N} N None
1
WRITE_ALWS Character Write always to RTDB {Y,N} N None
1
CONTROLTYP Integer Control type <Number>
6 0
None
CONFIRMCM Character Need to Confirm command enable flag. {Y,N} N None
1
Optional If set, will be requested the confirmation to execute a
control command on the tag.

EXP_VAL field specifies a relational database (i.e. Oracle, Access) and the field must be updated with the values of the tag.
This requires the installation of a specific ODBC Connection Support, Symphony Plus license (optional), and a relational
database package to manage the tag values.

2VAA000830-330 A 21
S+ Operations DB Reference DATABASE STRUCTURE

2.5.3 Generic Tag - Process Parameters (continued)


The following table lists the parameters that are not included in the Process Tab of the on-line configuration:
Table 2-4: Generic Tag – Process Parameters (continued)

Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
C_DUAL Character Controller flag: dual {Y,N} N None
1

C_GROUPACK Character Controller flag: group ack {Y,N} N None


1

C_ENABLE Character Controller flag: enable {Y,N} N None


1

C_SUPPRESS Character Controller flag: suppression {Y,N} N None


1

C_OPERATE Character Controller flag: operate {Y,N} N None


1

C_INHIBIT Character Controller flag: inhibit {Y,N} N None


1

OTXNAME Character Output transfer tag name. <string>


56 <blank>
Optional Name of an output tag to be linked to the
current tag for outputting to loop.

The output tag must exist within the tag


database.
OTXENB Character Output transfer enable flag. {Y,N} N None
1
Optional If set, output transfer to the tag defined in
the OTXNAME field is enabled.
OTXQUAL Character Output transfer with quality {Y,N} N None
1

SNAPENB Character Snapshot Collection enabled {Y,N} N None


1
If enabled, tag is included while taking
snapshot
OPCEXPCLNT Character Export to OPC Client {Y, N} N
1
Optional OPCEXPCLNT is used to define the tags
which will be exported through
Symphony plus OPC Server.

If set, tag values are exported via OPC.


OPCSRVVIS Integer Opc server visibility {0, 1, 2}
2 2
Optional OPCSRVVIS is used to define tags
visibility of SPO tags with respect to the
S+ OPC Server.

Defines if the tag will be exported by the


OPC server.

0 = None
1 = Read only
2 = Read Write
NETTMAX Integer Timer max for network update <Number>
5 0
None
OUT1_DRV Character Output driver 1 name <string>
50 <blank>

22 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

OUT_DRV is the alias name for this field

OUT1_TYPE Integer Output driver 1 propagation type <Number>


2 0 = Command only 0
1 = Variation only None
2 = command and variation
OUT1_PC_DR Character Output driver 1 pc name <string>
50 <blank>
OUT1_ADn Integer Output 1 address n. Where n denotes 1 <Number>
6 to 10. 0
None
OUT_AD1 is the alias name for
OUT1_AD1

Note:
OUT_AD2 is the alias name for
OUT1_AD2

OUT_AD3 is the alias name for


OUT1_AD3

OUT_AD4 is the alias name for


OUT1_AD4

OUT_AD5 is the alias name for


OUT1_AD5

OUT_AD6 is the alias name for


OUT1_AD6

OUT_AD7 is the alias name for


OUT1_AD7

OUT_AD8 is the alias name for


OUT1_AD8

OUT_AD9 is the alias name for


OUT1_AD9

OUT_AD10 is the alias name for


OUT1_AD10
OUT1_TXn Character Output 1 driver text n. Where n denotes <string>
64 1 to 10. <blank>

OUT_TX1 is the alias name for


OUT1_TX1

Note:
OUT_TX2 is the alias name for
OUT1_TX2

OUT_TX3 is the alias name for


OUT1_TX3

OUT_TX4 is the alias name for


OUT1_TX4

OUT_TX5 is the alias name for


OUT1_TX5

OUT_TX6 is the alias name for


OUT1_TX6

OUT_TX7 is the alias name for


OUT1_TX7

OUT_TX8 is the alias name for


OUT1_TX8

2VAA000830-330 A 23
S+ Operations DB Reference DATABASE STRUCTURE

OUT_TX9 is the alias name for


OUT1_TX9

OUT_TX10 is the alias name for


OUT1_TX10

OUT2_DRV Character Output driver 2 name <string>


50 <blank>
OUT2_TYPE Integer Output driver 2 propagation type <Number>
2 0 = Command only 0
1 = Variation only None
2 = command and variation
OUT2_PC_DR Character Output driver 2 pc name <string>
50 <blank>
OUT2_ADn Integer Output 2 address n. Where n denotes 1 <Number>
6 to 10 0
None
OUT2_TXn Character Output 2 driver text n. Where n denotes <string>
64 1 to 10 <blank>
OUT3_DRV Character Output driver 3 name <string>
50 <blank>
OUT3_TYPE Integer Output driver 3 propagation type <Number>
2 0 = Command only 0
1 = Variation only None
2 = command and variation
OUT3_PC_DR Character Output driver 3 pc name <string>
50 <blank>
OUT3_ADn Integer Output 3 address n. Where n denotes 1 <Number>
6 to 10 0
None
OUT3_TXn Character Output 3 driver text n. Where n denotes <string>
64 1 to 10 <blank>
OUT4_DRV Character Output driver 4 name <string>
50 <blank>
OUT4_TYPE Integer Output driver 4 propagation type <Number>
2 0 = Command only 0
1 = Variation only None
2 = command and variation
OUT4_PC_DR Character Output driver 4 pc name <string>
50 <blank>
OUT4_ADn Integer Output 4 address n. Where n denotes 1 <Number>
6 to 10 0
None
OUT4_TXn Character Output 4 driver text n. Where n denotes <string>
64 1 to 10 <blank>
OUT5_DRV Character Output driver 5 name <string>
50 <blank>
OUT5_TYPE Integer Output driver 5 propagation type <Number>
2 0 = Command only 0
1 = Variation only None
2 = command and variation
OUT5_PC_DR Character Output driver 5 pc name <string>
50 <blank>
OUT5_ADn IntegerOutput 5 address n. Where n denotes 1 <Number>
6 to 10 0
None
OUT5_TXn Character Output 5 driver text n. Where n denotes <string>
64 1 to 10 <blank>
Note: The OUT1_ADn, OUT1_TXn, OUT1_DRV fields replace the OUT_ADn, OUT_TXn, and OUT_DRV
fields respectively.

2.5.4 Generic Tag – Generic Scanner Input Parameters


The fields listed in Table 2-5 provides the logic address or references used to locate the source tags acquired from generic
(not pre-defined as Symphony) process interface devices. They are valid for tags acquired from external (foreign) acquisition
devices.
These fields only provide an addressing criterion for external tags. The base system does not support any type of driver for
foreign acquisition devices. Such drivers, whenever required, must be developed as specific application packages.
24 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

All fields are mandatory if an external acquisition devices are used, else they need not have to be defined.
The Generic Scanner parameters replace previous External and Modbus Acquisition parameters.
The following table lists the Generic Tag – Generic Scanner Input Parameters:
Table 2-5: Generic Tag – Generic Scanner Input Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
FIELD_ADn Integer Field input address n. Where n denotes 1 <Number>
6 to 10 0
Mandatory None
FIELD_TXn Character Field input driver text n. Where n denotes <string>
64 1 to 10 <blank> [mxopcn]
Optional
FIELD_DRV Character Field input driver name. <string>
50 <blank> [sznam]
Mandatory This name identifies the kind of driver
interfacing S+ to the process for input
data communication.

2.5.5 Generic Tag – Generic Scanner Output Parameters


The fields listed in Table 2-6 provides the logic address or references used to locate the destination tags to generic (not pre-
defined as Symphony) process interface devices. They are valid for tags output to external (foreign) acquisition devices.
These fields only provide an addressing criterion for external tags. The base system does not support any type of driver for
foreign output devices. Such drivers, whenever required, must be developed as specific application packages.
Note: All fields are mandatory if an external acquisition devices are used, else they need not have to be defined.
The following table lists the Generic Tag – Generic Scanner Output Parameters:
Table 2-6: Generic Tag – Generic Scanner Output Parameters
Format Width Range Default
Name Description
Opt/Mnd Parameter(s)
OUT1_ADn Integer Field output driver 1 address n. Where n
6 denotes 1 to 10
Mandatory 0
Refer to Note at the end of the table. None
.................
OUT5_ADn Integer Field output driver 5 address n. Where n
6 denotes 1 to 10
Mandatory 0
None
OUT1_TXn Character Field output driver 1 text n. Where n <string>
64 denotes 1 to 10 <blank> [szdesc]
Optional
Refer to Note at the end of the table.
.............. ……………. ……………. …………….
OUT5_TXn Character Field output driver 5 text n. <string>
64 <blank> [szdesc]
Optional
OUTn_DRV Integer Field output driver name n. Where n <string>
50 denotes 1 to 5 <blank> [sznam]
Mandatory
This name identifies the kind of driver
interfacing Symphony Plus to the process
for output communication.

Refer to Note at the end of the table.


Note: The OUT1_ADn, OUT1_TXn, OUT1_DRV fields replace the OUT_ADn, OUT_TXn, and OUT_DRV fields
respectively.

2.5.6 Generic Tag - Symphony Input Parameters


The fields listed in Table 2-7 provides the logic address and other additional parameters used to locate the source of tags
coming from Symphony modules. They are valid for those kinds of tags.
The mandatory fields all together uniquely identify the location of the tag in terms of acquisition sub-system (PCU).
2VAA000830-330 A 25
S+ Operations DB Reference DATABASE STRUCTURE

The following table lists the Generic Tag – Symphony Input Parameters:
Table 2-7: Generic Tag – Symphony Input Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
ICI_NUM Integer ICI Number. {1...8}
2 1
Optional Number of the physical ICI device when multiple [mxciu] or
ICIs are connected to Symphony Plus [mxxciu]
ICI_NDX Integer ICI index. {-1, 0...29999}
5 -1 [mxcpts]
Optional This is the reference index in the internal
ICI table. Set by the system

If omitted or less than zero, the first vacant ICI


index will be allocated.

Index zero is legal only for ICI module status tags.


If this field is zero (blank) and ICI point type is not
module status, an error will be generated.
Therefore, this field must be omitted or explicitly
defined as –1, except for those particular tags
requiring fixed indexes.
LOOP Integer Ring number. {1...256}
3 0
Mandatory None
PCU Integer PCU number. {1...256}
3 0
Mandatory None
MODULE Integer Module number. {0...31}
2 0
Mandatory None
BLOCK Integer Block number. {0...32000}
5 0
Mandatory None
ICISTA_CD Character ICI action code. {X, E, C, D} C
1 None
Optional This code specifies the ICI action at start-up time.

2.5.7 Generic Tag - Alarm Processing Parameters


The fields listed in Table 2-8 and Table 2-10 provides information for the alarm processing of the tag. All fields are optional.
An optimal alarm processing option is provided based on the requirement. The alarm group, for example, is a key field. It
allows classifying tags into subsets (the alarm groups) for further alarm displaying and handling.
The following table lists the Generic Tag - Alarm Processing Parameters:
Table 2-8: Generic Tag - Alarm Processing Parameters

Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ALMGROUP Integer Alarm group number. {0, 1...272}
3 0
Optional AL_GRP is the alias name for this field. [sladnm] or
[mxxagp]
This field allows you to group all tags belonging
to a given plant area or component. Alarm group
numbers are used to sort the alarms for the
presentation on screen. Alarm groups are
customer defined. By default, groups 1 to 16 are
defined as first level groups, directly addressed
by alarm displays and summaries. Groups 17 to
32 are defined as sub-groups of group 1, groups
33 to 48 are defined as sub-groups of group 2
and so on.
ALMGRPNAM Character Alarm Group Name. <string>
20 <blank>
26 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

Optional Alarm groups logically gather alarms in groups [sznam]


and provide a method to analyze the status of
the tags.
AL_PRI Integer Alarm priority number. {1 ... 32}
2 1
Optional ALRM_PRTY1 is the alias name for this field [mxalpr] or
[mxxapr]

This is the default priority number and is used


when a specific alarm priority is not defined for a
single alarm condition. Specific priority numbers
can be assigned to each alarm condition. See
the following fields and the fields of the analog
sub- sections of analog and digital tag definitions
for a description. This default priority field and the
specific priority fields determine the colors used
to display alarms of the tag. Alarm priorities can
be customer defined.
AUDINDEX Integer Audible alarm index. {0, 1...32}0
3 [mxaud]
Optional This field defines the index into audible alarm
database to determine which audible is to be
activated upon alarm and/or return to normal.
ALMPRINTER Integer Alarm printer index {1...99}1
2 None
Optional Reference index to the printer where messages
concerning the tag are printed. Refer the PR_xxx
(e.g. PR_ALARM) field for more details. It is a
pointer to a alarm printer database defining the
alarm printer index. Refer to the system option
configuration for details.
SMSINDEX Integer Export alarm to SMS
3 Index for Short Message Send (SMS) alarm 0
Optional messaging. None
ALMTON Integer Time ON for alarms (Seconds) 0
6 None
Optional
ALMTOF Integer Time OFF for alarms (Seconds) {0...999}
6 0 None
Optional
SHELVLIM Integer Time out for shelving for Alarms (minutes) 0
6 None

AAP_NUM Integer Alarm action program (alacxx) 0


2 None
Index to an application action program. If greater
than 0, this field defines a link, which will cause a
user defined application program to be activated
upon status changes for the tag. The name of the
application program must be ALACxx, where xx
is the number corresponding to the value of the
field.
ALCATEG Character Alarm Category <string>
50 Default
Optional Name of the Alarm Category, which defines the
alarm processing options.
AL_CAT Character Categorize alarms by priority {Y, N} N
1
Optional

The acknowledgment of alarms can be executed also by using a tag as a trigger. An acknowledge command is triggered on
the specified alarm priority or alarm group, when the specified tag moves to alarm state.
Create additional tag in S+ Operations for third party based remote alarm acknowledge. This enables the link between third
party systems to S+ Operations alarm management systems. Set the values in the S+ Engineering > Operations
Engineering under System Settings tab, and deploy the following configurations (refer Table 2-9) to the required S+
Operations Node.

2VAA000830-330 A 27
S+ Operations DB Reference DATABASE STRUCTURE

Table 2-9: System Settings for Alarm Acknowledge

System Settings Descriptions


APPS\RemoteAck\<TagName> Name of the tag that will trigger the acknowledge action.
APPS\RemoteAck\<TagName>\AlarmGroup Index number of Alarm Group as defined in Alarm
Group Database to acknowledge.
Default Value: -1 (Disabled)
APPS\RemoteAck\<TagName>\AlarmPriority Index number of Alarm priority as defined in Alarm
Priority Database to acknowledge.
Default Value: -1 (Disabled)
APPS\RemoteAck\<TagName>\SilenceAudible Index number of Audible as defined in Audible Database
for Silencing the alarm.
Default Value: -1 (Disabled)
APPS\RemoteAck\<TagName>\TriggerValue Set the Tag value threshold to activate acknowledge.
Default Value: 1
APPS\RemoteAck\<TagName>\Timer Set the activation time (in milliseconds)
Default Value: 500
APPS\RemoteAck\<TagName>\RemoveAll Set the Tag value to Remove all alarms
Default Value: -1 (Disabled)
APPS\RemoteAck\<TagName>\RemoveInactive Set the Tag value to Remove all inactive alarms
Default Value: -1 (Disabled)

2.5.8 Generic Tag - Alarm Processing Parameters (continued)


The following table lists the parameters that are not included in the Alarm Process Tab of the on-line configuration:
Table 2-10: Generic Tag - Alarm Processing Parameters (continued)
Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
ALPRI_RTN Integer Return to normal priority number. {0, 1 ... 32}
2 0
Optional This is the priority assigned to the tag when [mxalpr] or [mxxapr]
a return to normal condition takes place after
an alarm. If set to 0 then the default priority
is assigned.

Refer the description of the AL_PRI field for


the definition of alarm priorities.
ALPRI_HCF Integer Hardware channel failure priority number. {0, 1 ... 32}
2 0
Optional This is the priority assigned to the tag [mxalpr] or [mxxapr]
when a hardware channel failure takes
Place. If set to 0 then the default priority is
assigned.

Refer the description of the ALI_PRI field for


the definition of alarm priorities.

2.5.9 Generic Tag – Alarm Comment Parameters


The fields listed in Table 2-11 provides information to the associated to alarm conditions of the tag. Either an integer format
(index) or a character format (text) can be used.
The index is used to address an alarm comment defined within the alarm comment database. This approach requires the
separate configuration of an alarm comment database in order to define all referenced alarm comments.
If the index is defined, the text type field (if any) is ignored.
If the text type field is used, it is added to the alarm comment database at the first vacant index. This approach does not
require the separate configuration of an alarm comment database.
If the text is defined, the index type field must not be included in the tag database. Refer to the Alarm Comment Definition
Parameters section for more information about the contents of these fields. Refer to the analog sub-sections of analog and
digital tag definitions for specific alarm comments.
The on-line configuration allows selection of alarm comment either by index (typing the number) or text (selecting from a
list).
The following table lists the Generic Tag – Alarm Comment Parameters:

28 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

Table 2-11: Generic Tag – Alarm Comment Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
ALRMCMNT1 Integer Return to normal comment index. {1...100}
5 0 [mxalcm]
Optional
ALRMCTXT1 Character Return to normal comment <string>
80 <blank> [szalcm]
Optional
ALRMCMNT2 Integer High alarm (for analog tags) or alarm (for {1...100}
5 digital tags) comment index. 0 [mxalcm]
Optional
HALMCMNT and H_MESS are the alias
name for this field
ALRMCTXT2 Character High alarm (for analog tags) or alarm (for <string>
80 digital tags) comment text. <blank> [szalcm]
Optional HALMCMNT and H_MESS are the alias
name for this field
Note: For ALRMCMNT3 to ALRMTXT12, refer to Analog Tag – Alarm Comment Parameters.
ALRMCMNT13 Integer Hardware failure comment index. {1...100}
5 0 [mxalcm]
Optional
ALRMCTXT13 Character Hardware failure comment <string>
80 <blank> [szalcm]
Optional
ALRMCMNT14 Integer Alarm comment {1...100}
5 0 [mxalcm]
HALMCMNT and ALL_DESCR are the
alias name for this field
ALRMCTXT14 Character Alarm comment <string>
80 <blank> [szalcm]
Optional HALMCMNT and ALL_DESCR are the
alias name for this field
ALRMCMNT12 Integer Status change comment <string>
5 <blank> [szalcm]

2.5.10 Generic Tag – Alarm Categories


The following table describes Alarm Categories.
Table 2-12: Generic Tag - Alarm Categories

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
ALCATPRIn Character Alarm Category for Priority n <string>
50 Defines the alarm category item for Priority n Default
Optional Note: n denotes 1 to 32

2.5.11 Generic Tag – Network Parameters


The fields listed in Table 2-13 refer to the Symphony Plus network communication subsystem.
They are used when multiple Symphony Plus servers in a multi-master architecture exchange data (values, alarm
acknowledges, messages, configurations) among them.
All fields are optional and they must be defined when servers (nodes) are intended to cooperate in a multi-master
architecture.
The fields reference the node definition. Refer to the Node database section for more details.
The following table lists the Generic Tag – Network Parameters:
Table 2-13: Generic Tag – Network Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
NETDSTCLAS Character Network Distribution Class <string>
2VAA000830-330 A 29
S+ Operations DB Reference DATABASE STRUCTURE

50 <blank>
Optional

2.5.12 Generic Tag - Application Parameters


The fields listed in Table 2-14 and Table 2-15 provides information for additional tag qualification or to be used by application
specific programs and these fields are optional.
Application parameters are statically defined. Application programs updates these values dynamically. Initial values can be
set.
The following table lists the Generic Tag – Application Parameters:
Table 2-14: Generic Tag – Application Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
UT_TEXT Character Text (1) <string>
8 <blank>
Optional USER3 is the alias name for this
field
UT_TEXT1 Character Text (2) <string>
16 <blank>
Optional USER7 is the alias name for this
field
UT_TEXT2 Character Text (3) <string>
32 <blank>
Optional USER10 is the alias name for
this field
GIS_LAYER Character The name of a layer in a GIS <string>
50 <blank>
Optional
GIS_OBJ_ID Integer Unique Id of a GIS object with a (0 to 16)
16 layer Default 0
Optional
GISENABLE Character Tag Associated to GIS {Y, N} N
1
Optional
GISASPnNAM Character Name of GIS aspect n. Where n <string>
256 denotes 1 to 3. <blank>
Optional
GISASPnCMD Character Command for GIS aspect n. <string>
244 Where n denotes 1 to 3. <blank>
Optional
UT_INn Integer Integer value. Where n denotes {-32767...+32767}
6 1 to 4. 0
Optional None
UT_REn Real Real number. Where n denotes <9 digit real>
9 1 to 6. 0
Optional None
ASPECTnNAM Character Aspect program menu text n. <string>
20 Where n denotes 1 to 9. <blank> [sznam]
Optional
Aspects allow you to add specific
menu items for tag handling.
Menu items are added to the
operating parameters and to the
context menu. Refer to the
ASPECTnCMD field for more
details.

The aspect name defines the


text of the menu item.
ASPECTnCMD Character Aspect command line n. Where <string>
80 n denotes 1 to 9. <blank> [szedsc]
Optional
Aspects allow you to add specific
menu items for tag handling.

30 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

Refer to the ASPECTnNAM field


for more details.

The aspect command defines


the command line to be
executed.

Refer to Note at the end of the


table for more details.
ASPECT10NA Character Aspect program menu text 10. <string>
20 <blank> [sznam]
Optional
ASPECT10CM Character Aspect command line 10. <string>
80 <blank> [szedsc]
Optional

Note:
The aspect command line defines the command to be executed when the menu item is
selected. The syntax of the command line is:
<program name>
or
<program name> <parameters>
The program name identifies the program to be activated and the parameters to define
possible input data to the program.
A parameter can be a tag name. It can be symbolically referenced using the syntax
%TAG%. At execution time the symbolic reference will be replaced with the actual tag
name.

2.5.13 Generic Tag - Application Parameters (continued)


The following table lists the parameters that are not included in the Application Tab of the on-line configuration.
Table 2-15: Generic Tag – Application Parameters (continued)

Format Width Range Default


Name Description
Opt/Mnd Parameter(s)
ATOMnNAM Character Atom name n. Where n denotes <string>
20 1 to 20. <blank> [szdesc]
Optional
ATOMnDES Character Atom name n. Where n denotes <string>
20 1 to 20. <blank> [szdesc]
Optional
ATOMnTYP Integer Atom type n. Where n denotes 1
6 to 20. 0
Optional None
ATOMnVAL Integer Atom value n. Where n denotes {-
10 1 to 20. 32767...+32767}
Optional 0
None

2.5.14 Generic Tag – Tag Extra References


The following table lists the parameters that are included in Tag extra references.
Table 2-16: Generic Tag – Tag extra references

Format Width Range Default


Name Description
Opt/Mnd Parameter(s)
TAG_S_Rn Char String Reference 1 through String <string>
256 Reference 50 <blank>
Optional
S_REFN is the alias name for
TAG_S_Rn

2VAA000830-330 A 31
S+ Operations DB Reference DATABASE STRUCTURE

TAG_V_Rn Integer Value Reference 1 through Value 0


6 Reference 50 None
Optional
V_REFN is the alias name for the
fields of TAG_V_Rn
TAG_F_Rn Integer Float Reference 1 through Float 0
15 reference 50 None
Optional
F_REFN is the alias name for the
fields of TAG_F_Rn

TAG_B_Rn Char Bool reference 1 through Bool {Y,N} N None


1 reference 50
Optional
B_REFN is the alias name for the
fields of TAG_B_Rn
Note: n indicates 1 through 50. For example TAG_S_R1 or TAG_S_R6 is indicated by TAG_S_Rn.

2.5.15 Generic Tag – Tag Control References


The following table lists the parameters that are included in Tag Control references.
Table 2-17: Generic Tag – Tag Control references

Format Width Range Default


Name Description
Opt/Mnd Parameter(s)
REF_BADC Char Bad calculation reference tag <string>
50 <blank>
Optional
REF_CF Char Communication failure reference <string>
50 tag <blank>
Optional
REF_CHF Char Channel failure reference tag <string>
50 <blank>
Optional
REF_OLD Char Old reference tag <string>
50 <blank>
Optional
REF_CFGER Char Configuration error reference tag <string>
50 <blank>
Optional
REF_NOCON Char No connection reference tag <string>
50 <blank>
Optional
REF_DEVER Char Device failure reference tag <string>
50 <blank>
Optional
REF_WIV Char Wait init value reference tag <string>
50 <blank>
Optional
REF_SUBN Char SubNormal reference tag <string>
50 <blank>
Optional
REF_EXTF1 Char Extended flag1 reference tag <string>
50 <blank>
Optional
REF_EXTF2 Char Extended flag2 reference tag <string>
50 <blank>
Optional
REF_EXTF3 Char Extended flag3 reference tag <string>
50 <blank>
Optional
CTRLINHTAG Char Control inhibit tag <string>
50 Tag name of control inhibit tag. It <blank> [sznam]
Optional must refer to a digital tag.
32 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

Control inhibit tag is a digital tag


used to disable actions upon
analog (RMSC) and digital (RCM,
DD, MSDD) control tags

INIB_PID is the alias name for this


field
ALMINHTAG Char Alarm inhibit tag <string>
50 <blank> [sznam]
Optional Name of a tag that, while in alarm,
will disable the generation of
alarm messages for this tag. If the
field is blank, no alarm inhibit tag
is defined.

ALIN_PID is the alias name for


this field
ALMINHVAL Integer Alarm inhibit value <string>
1 <blank> None
Optional
CTRLINHVAL Integer Control inhibit value <string>
1 <blank> None
Optional Set the values from the drop-down
list. The values are as follows:
0,1,2,3,A,N,H,2H,3H,L,2L,3L, CF,
and blank

2.5.16 Generic Tag – Acquisition


The following table lists the parameters that are included in Acquisition.
Table 2-18: Generic Tag – Acquisition

Format Width Range Default


Name Description
Opt/Mnd Parameter(s)
FIELD_DRV Character Field driver name <string>
50 <blank> [sznam]
Mandatory This name identifies the kind of
driver interfacing S+ to the
process for input data
communication.
FIELD_PC_D Field driver pc name
FIELD_AD1 Integer Field Address 1 0
6 None
Mandatory OPCREFRESH is the alias name
for this field

OPCREADTYP is the alias name


for FIELD_AD2

………………………. ………………
FIELD_AD12 Integer Field Address 12 0
6 None
Mandatory
FIELD_TX1 Character #(Field driver text)# 1 <string>
80 Optional. <blank> [mxopcn]
OPCPROGID and TAGGEN is the
alias name for this field

Note:
OPCCMPTR is the alias name for
FIELD_TX2

OPCITEMID is the alias name for


FIELD_TX3

2VAA000830-330 A 33
S+ Operations DB Reference DATABASE STRUCTURE

OPCACCPATH is the alias name


for FIELD_TX4

OPCPROGAE is the alias name


for FIELD_TX5

OPCALASRC is the alias name


for FIELD_TX7
…………………….. ……………….
FIELD_TX10 Character #(Field driver text)# 10 <string>
80 Optional. <blank> [mxopcn]

2.5.17 Generic Tag – DI General


The following table lists the parameters that are included in DI General.
Table 2-19: Generic Tag – DI General

Format Width Range Default


Name Description
Opt/Mnd Parameter(s)
ZEROSTATE Character Descriptor for state 0. <string> [sztags]
256
Mandatory This field defines the text to be
displayed or printed to represent
the state 0.

STA_DSC0 is the alias name for


this field.

ONESTATE Character Descriptor for state 1. <string>


256 <blank> [sztags]
Optional This field defines the text to
represent the normal state.

STA_DSC1 is the alias name for


this field
TWOSTATE Character Descriptor for state 2. <string>
256 <blank> [sztags]
Optional STA_DSC2 is the alias name for
this field

THREESTATE Character Descriptor for state 3. <string>


256 <blank> [sztags]
Optional STA_DSC3 is the alias name for
this field

FOURSTATE Character Descriptor for state 4. <string>


256 <blank> [sztags]
Optional STA_DSC4 is the alias name for
this field

FIVESTATE Character Descriptor for state 5. <string>


256 <blank> [sztags]
Optional STA_DSC5 is the alias name for
this field

SIXSTATE Character Descriptor for state 6. <string>


256 <blank> [sztags]
Optional STA_DSC6 is the alias name for
this field

SEVENSTATE Character Descriptor for state 7. <string>


256 <blank> [sztags]
Optional STA_DSC7 is the alias name for
this field
EIGHTSTATE Character Descriptor for state 8. <string>
256 <blank> [sztags]
Optional STA_DSC8 is the alias name for
this field
34 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

NINESTATE Character Descriptor for state 9 <string>


256 <blank> [sztags]
Optional STA_DSC9 is the alias name for
this field

TENSTATE Character Descriptor for state 10. <string>


256 <blank> [sztags]
Optional STA_DSC10 is the alias name for
this field

ELEVNSTATE Character Descriptor for state 11. <string>


256 <blank> [sztags]
Optional STA_DSC11 is the alias name for
this field

TWELVSTATE Character Descriptor for state 12. <string>


256 <blank> [sztags]
Optional STA_DSC12 is the alias name for
this field

THTEESTATE Character Descriptor for state 13. <string>


256 <blank> [sztags]
Optional STA_DSC13 is the alias name for
this field

FRTEESTATE Character Descriptor for state 14. <string>


256 STA_DSC14 is the alias name for <blank> [sztags]
Optional this field

FVTEESTATE Character Descriptor for state 15. <string>


256 <blank> [sztags]
Optional STA_DSC15 is the alias name for
this field

ISALARM0 Character State 0 is alarm {Y, N} N None


1 Is set, state 0 is an alarm state.
Optional
Refer to Note 1 at the end of the
table for more details.
………………. ………………………
ISALARM15 Character State 1 is alarm {Y, N} N None
1 Is set, state 15 is an alarm state.
Optional
Refer to Note 1 at the end of the
table for more details.
Note 1:
The IsAlarm0, IsAlarm1, ... IsAlarmn fields replace the Refstat field. The description of Refstat has been
removed from the configuration manual. However, the field is still supported for compatibility with previous
Symphony Plus versions. Refer to configuration manual of release 1.4 (or previous) for details.
The IsAlarm<i> set of fields allow defining multiple alarm statuses for a multi-state tag. A tag can have:
• A single alarm status and all other normal.
• A single normal status and all other alarm.
• Any combination of alarm and normal statuses.

2.5.18 Generic Tag – DI Process


The following table lists the parameters that are included in DI Process.
Table 2-20: Generic Tag – DI Process

Format Width Range Default


Name Description
Opt/Mnd Parameter(s)
INITVAL Integer Defines the initial value of the tag 0
15 None

2VAA000830-330 A 35
S+ Operations DB Reference DATABASE STRUCTURE

Optional
ACK_PROG Character Activate alac on ack {Y, N} Y None
1
Optional
RTN_PROG Character Activate alac on rtn {Y, N} Y None
1
Optional Activate an application action
program on return to normal
condition. If set, the application
action program defined by
AAP_NUM field will be activated
whenever a return to normal
condition takes place. The on-line
configuration includes the field
within the Alarm Level Tab for
analog tags and the DI Process
Tab for digital tags.

RTN_ACT is the alias name for


this field.

EVENTTAG Character Event tag {Y, N} N None


1
Optional If set, all possible states of the tag
will be considered normal and the
only type of alarm output enabled
is Operator Journal recording
(while alarm display pages,
reports and post trip logs are not
affected).

ALLNORM is the alias name for


this field.

EVT_PROG Character Event Program {Y, N} N None


1
Optional Program activation flag on event.
If set, the application action
program defined by AAP_NUM
field will be activated whenever an
event (state change) takes place.
ALM_PROG Character Activate alac on alarm {Y, N} N None
1 Program activation flag on alarm.
Optional If set, the application action
program defined by AAP_NUM
field will be activated whenever an
alarm condition occurs.
REFSTAT Integer Alarm State 0
3 None
Optional N_A_ST is the alias name for this
field
MAX_ROC Integer Maximum rate of change 0
3 None
Optional Maximum allowed rate of
changes. This field defines the
maximum number of state
changes allowed for this tag
during 1 minute. If the number of
changes exceeds this limit, the tag
is automatically put out of scan.
The function is useful for filter
exception reports due to hardware
failures in the digital contacts.
Those no- meaningful exception
reports might significantly reduce
or saturate the playback storage
area.
DEV_NAME Character Device name <string>
20 <blank>
36 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

Optional
DEV_NUMBER Integer Device number 0
15 None
Optional
DEV_TYPE Character Device type <string>
15 <blank>
Optional
DEVSUBTYPE Integer Device subtype 0
2 None
Optional
SOELOG Integer Triggered soe number 0
3 None
Optional
SOETYPE Integer Triggered soe type 0
1 None
Optional
SOETIMEOUT Integer Triggered soe timeout 0
3 None
Optional
SOETUNITS Integer Triggered soe timeout units 0
1 None
Optional
SOEMAXEVT Integer Triggered soe max events 0
5 None
Optional
SOEOUTLOG Integer Triggered soe output log 0
3 None
Optional

2.5.19 Generic Tag – DI Feedback


The following table lists the parameters that are included in DI Feedback.
Table 2-21: Generic Tag – DI Feedback

Range Default
Name Format Width Opt/Mnd Description
Parameter(s)
FB1_0STATE Character Zero state descriptor for <string>
16 feedback 1. <blank> [sztags]
Optional
This field defines the
text to be displayed for
the state 0 of feedback
1.

FB1_DSC0 is the alias


name for this field
FB1_1STATE Character One state descriptor for <string>
16 feedback 1. <blank> [sztags]
Optional
This field defines the
text to be displayed for
the state 1 of feedback
1.

FB1_DSC1 is the alias


name for this field
FB2_0STATE Character Same as above for state <string>
16 0 of feedback 2. <blank> [sztags]
Optional
FB2_DSC0 is the alias
name for this field
FB2_1STATE Character Same as above for state <string>
16 1 of feedback 2. <blank> [sztags]
Optional FB2_DSC1 is the alias
name for this field

FB3_0STATE Character Same as above for state <string>


16 0 of feedback 3. <blank> [sztags]
2VAA000830-330 A 37
S+ Operations DB Reference DATABASE STRUCTURE

Optional FB3_DSC0 is the alias


name for this field
FB3_1STATE Character Same as above for state <string>
16 1 of feedback 3. <blank> [sztags]
Optional FB3_DSC1 is the alias
name for this field

FB4_0STATE Character Same as above for state <string>


16 0 of feedback 4. <blank> [sztags]
Optional FB4_DSC0 is the alias
name for this field
FB4_1STATE Character Same as above for state <string>
16 1 of feedback 4. <blank> [sztags]
Optional FB4_DSC1 is the alias
name for this field

2.5.20 Generic Tag - OPC Parameters


OLE for Process Control (OPC) is a mechanism based on the Microsoft OLE/COM technology for communicating to
numerous data sources in order to enable inter-operability between automation/control application, field systems/devices
and business/office applications in the process control industry.
The Symphony Plus OPC Client provides Data Access (in accordance to the 1.0a and 2.03 specifications) and Alarm and
Event (in accordance to the 1.02 specification) functionalities and allows simultaneous connections to local and remote OPC
servers. The Symphony Plus OPC Server provides Data Access and Alarm and Event functionalities as well but, as far as
the Data Access specification is concerned, only the 2.03 is supported.
The fields listed in Table 2-22 to Table 2-25 provides information on Symphony Plus OPC subsystem and can be used to
define the database from the OPC.
If Symphony Plus OPC Support is installed, then OPC tags are used. In such a case, the on-line configuration provides a
tab for OPC parameters.
The following table lists the Generic Tag – OPC Parameters:
Table 2-22: Generic Tag – OPC Parameters

Format Width Range Default


Name Description
Opt/Mnd Parameter(s)
Character Server name. <string>
OPCPROGID 80 This is the name of the OPC Data Access <blank>
Mandatory Server. [mxopcn]
Character Alarm event server name. <string>
OPCPROGAE 80 This is the name of the OPC Alarm Event <blank>
Mandatory Access Server. [mxopcn]
Computer name.
Character This is the name of the machine hosting the OPC <string>
OPCCMPTR 80 Data Access Server and OPC Alarm&Event Server. <blank>
Optional It may be left undefined to establish a local [mxopcn]
connection.
Item identification.
Character
This is the unique identification of data item to be <string>
OPCITEMID 80
accessed in the server specific address space. The <blank> [mxopci]
Mandatory
value to be specified depends on the OPC server.
Access path.
Character <string>
This may be additional information to qualify access
OPCACCPATH 80 <blank>
to data item. The value to be specified depends on
Optional [mxopcn]
the OPC server.
Requested refresh time.
Each OPC server updates data items based on its
own refresh time capabilities. Symphony Plus OPC
server updates data items with the rate specified by
Integer refresh time, as shown in Table 2-23.
OPCREFRESH 6 Note: However, value 0 is not supported or 0
Optional recommended. None
Rates smaller than the lowest allowed refresh rate
are rounded to the minimum allowed value and
rates greater than the highest allowed rate are
rounded to the maximum allowed value.
38 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

Any other requested refresh rate will be rounded to


the closest higher supported rate.

Note: Once configurations are modified, the S+


Operations needs to be restarted for applying these
changes.
Integer
Read type.
OPCREADTYP 6 120
Refer Table 2-24 for allowed read types.
Optional None
OPCEXPCLNT Character Flag to enable commands to OPC client. {Y,N} N None
1
Optional If set, for a control tag, commands are allowed to
the OPC server.
Alarm Source.
Character This is the unique identification of alarm and event
OPCALASRC <string>
80 that need to be accessed from the OPC AE server.
<blank> [mxopci]
Mandatory The value to be specified depends on the OPC
server.

2.5.21 Server DA Refresh Rates


The following table lists the Server DA Refresh Rates:
Table 2-23: Server DA Refresh Rates

Code Description
500 500 milliseconds.
1 1 second.
2 2 second.
3 3 seconds.
5 5 second.
10 10 seconds.
30 30 seconds.
60 60 seconds.

2.5.22 Read Types


The following table lists the Read Types:
Table 2-24: Read Types

Code Description
100 Synchronous read from DEVICE (the physical device).
The OPC client sends a data read request and waiting for
response.
110 Synchronous read from CACHE (OPC server memory buffer).
The OPC client sends a data read request to the OPC server
and waits for response.
120 Exception based read (ADVISE).
The OPC client does not perform any data read request.
The OPC server send a data to the OPC client when value or
quality of data changes. So, CPU and network resources are
minimized.

2.5.23 Generic Tag - OPC Parameters (continued)


The following table lists the parameters that are not included in the OPC Tab of the on-line configuration:
Table 2-25: Generic Tag – OPC Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
OPC_ALA Character Flag for export alarms to OPC server. {Y, N} N None
1
Optional If set, alarm messages will be
automatically sent to the OPC server.
OPCPROGHS Character Historian server name. <string>
80 <blank> [mxopcn]

2VAA000830-330 A 39
S+ Operations DB Reference DATABASE STRUCTURE

Mandatory This is the name of the OPC Historian


Access Server.

2.5.24 Generic Tag - Hardware Description Parameters


The fields listed in Table 2-26 provides information about the source of the tag. They are related to wire cabling within the
cabinets and these fields are optional.
Note: Symphony Plus does not manage these fields, but these fields are loaded in the tag database based on requirement.
The following table lists the Generic Tag – Hardware Description Parameters:
Table 2-26: Generic Tag – Hardware Description Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
S_COORD Character Slave module coordinates. <string>
10 <blank> None
Optional
S_MODULE Character Slave module number. <string>
2 <blank> None
Optional
S_CHANNEL Character Slave channel number. <string>
2 <blank> None
Optional
S_TYPE Character Slave module type. <string>
6 <blank> None
Optional
TO_BOARD Character Termination unit identifier. <string>
14 <blank> None
Optional
TO_TU_TY Character Termination unit type. <string>
6 <blank> None
Optional
TO_TU_CO Character Termination unit coordinates. <string>
10 <blank> None
Optional
O_TB_ID Character Board identifier on termination unit. <string>
3 <blank> None
Optional
TO_PIN1 Character First pin on termination board. <string>
2 <blank> None
Optional
TO_PIN2 Character Second pin on termination board. <string>
2 <blank> None
Optional
TO_PIN3 Character Third pin on termination board. <string>
2 <blank> None
Optional
DRAW_REF Character Drawing reference code description. <string>
14 <blank> None
Optional
DESC_CABLE Character Field cable identifier. <string>
20 <blank> None
Optional Name of field cable wiring termination unit
to field termination board.
FR_BOARD Character Field termination cabinet identifier. <string>
14 <blank> None
Optional Name of field cabinet to which termination
unit is wired.
FR_TB_ID Character Field termination board identifier. <string>
4 <blank> None
Optional
FR_ROW Character Field termination board coordinates. <string>
4 <blank> None
Optional
FR_PIN1 Character First pin on field termination board. <string>
3 <blank> None
Optional
40 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

FR_PIN2 Character Second pin on field termination board. <string>


3 <blank> None
Optional
FR_PIN3 Character Third pin on field termination board. <string>
3 <blank> None
Optional
WIN_PANEL Character External alarm window panel identifier. <string>
8 <blank> None
Optional
WIN_NUMBER Character External alarm window number. <string>
3 <blank> None
Optional
WIN_ROW1 Character External alarm window description row 1. <string>
14 <blank> None
Optional
WIN_ROW2 Character External alarm window description row 2. <string>
14 <blank> None
Optional
WIN_ROW3 Character External alarm window description row 3. <string>
14 <blank> None
Optional

2.6 Plant Areas


Plant Areas is used for segregation of the plant into units or areas. They are used as follows:
• When deciding the mastership of S+ Operations redundancy mechanism along with Node weight.
• When deciding the mastership of S+ Operations Extended Redundancy mechanism.
• Point of Control.
The following table lists the parameters that are included in Plant Areas.
Table 2-27: Plant Areas

Range Default
Name Format Width Opt/Mnd Description
Parameter(s)
AREACOLOR Character 50 Optional Area Color. string>
<blank> None
AREATEXTCOL Character 50 Optional Area text color. string>
<blank> None

2.7 Digital Tag Definition


This section describes all specific fields used, together with the fields defined in the generic tag definition section, to configure
digital tags.
Some of these fields are meaningful only for particular types of digital tags. The Digital Tag Field Applicability table lists the
fields that are applicable to each one of tag types listed below:
• STATUS (Digital Status).
• RCM (Remote Control Memory).
• DD (Device Driver).
• MSDD (Multi State Device Driver).
• SPDT (Single Point Double Through).
• A/M Station Status.
• Symphony Extended Module Status.
All other fields may be used for all types of tags.

2.7.1 Digital Tag - General Parameters


The fields listed in Table 2-28, provides information on the text strings to be associated as logic state descriptors to each
possible status of the tag.
The total number of status text descriptors to be defined in a tag definition depends on the tag type.
For Example: A MSDD tag has four statuses and, in general, it will need four text descriptors.
Since all digital tags have at least two statuses, the first two logic state descriptors are mandatory, all others are optional.
The following table lists the Digital Tag – General Parameters:
Table 2-28: Digital Tag – General Parameters
2VAA000830-330 A 41
S+ Operations DB Reference DATABASE STRUCTURE

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
ZEROSTATE Character Zero state descriptor. <string>
256
Mandatory This field defines the text to be displayed or
printed to represent the state 0. [sztags]

STA_DSC0 is the alias name for this field.

ONESTATE Character Same as above for state 1. <string>


256
Mandatory STA_DSC1 is the alias name for this field
[sztags]
TWOSTATE Character Same as above for state 2. <string>
256 <blank> [sztags]
Optional The field is mandatory for MSDDs.

STA_DSC2 is the alias name for this field


THREESTATE Character Same as above for state 3. <string>
256 <blank> [sztags]
Optional The field is mandatory for MSDDs.
FOURSTATE Character Same as above for state 4. <string>
256 <blank> [sztags]
Optional
FIVESTATE Character Same as above for state 5. <string>
256 <blank> [sztags]
Optional
SIXSTATE Character Same as above for state 6. <string>
256 <blank> [sztags]
Optional
SEVENSTATE Character Same as above for state 7. <string>
256 <blank> [sztags]
Optional
EIGHTSTATE Character Same as above for state 8. <string>
256 <blank> [sztags]
Optional
NINESTATE Character Same as above for state 9. <string>
256 <blank> [sztags]
Optional
TENSTATE Character Same as above for state 10. <string>
256 <blank> [sztags]
Optional
ELEVNSTATE Character Same as above for state 11. <string>
256 <blank> [sztags]
Optional
TWELVSTATE Character Same as above for state 12. <string>
256 <blank> [sztags]
Optional
THTEESTATE Character Same as above for state 13. <string>
256 <blank> [sztags]
Optional
FRTEESTATE Character Same as above for state 14. <string>
256 <blank> [sztags]
Optional
FVTEESTATE Character Same as above for state 15. <string>
256 <blank> [sztags]
Optional
LSD1INDEX Integer Index for logic state descriptor 1.
16
Optional 0
None
.................. ……………. ................................................. …………….
LSD16INDEX Integer Index for logic state descriptor 16.
16
Optional 0
None
ISALARM0 Character Alarm flag for state 0. {Y, N} N None
1
42 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

Optional Is set, state 0 is an alarm state.

Refer to Note 1 at the end of the table for


more details.
.................. ……………. ................................................. …………….
ISALARM31 Character Alarm flag for state 31. {Y, N} N None
1
Optional Is set, state 31 is an alarm state.

Refer to Note 1 at the end of the table for


more details.

Note 1:
The IsAlarm0, IsAlarm1, ... IsAlarmn fields replace the Refstat field. The description of Refstat has been removed from the
configuration manual. However, the field is still supported for compatibility with previous Symphony Plus versions. Refer to
configuration manual of release 1.4 (or previous) for details.
The IsAlarm<i> set of fields allow defining multiple alarm statuses for a multi-state tag. A tag can have:
• A single alarm status and all other normal.
• A single normal status and all other alarm.
• Any combination of alarm and normal statuses.

2.7.2 Digital Tag - Process Parameters


The fields listed in Table 2-29, provides information on digital tags of alarm processing and these fields are optional.
The following table lists the Digital Tag – Process Parameters:
Table 2-29: Digital Tag – Process Parameters

Format Width Range Default


Name Description
Opt/Mnd Parameter(s)
REFSTAT Integer Alarm State 1
3 None
Optional N_A_ST is the alias name for this field

EVENTTAG Character State information flag. {Y, N} N None


1
Optional If set, all possible states of the tag will be considered
normal and the only type of alarm output enabled is
Operator Journal recording (while alarm display pages,
reports and post trip logs are not affected).

ALLNORM is the alias name for this field.

INITVAL Integer Initial value. {0...15}


2 0
Optional This value is loaded into the realtime database at None
system star-up.
MAX_ROC Integer Maximum allowed rate of changes. {0...999}
3 0
Optional This field defines the maximum number of state None
changes allowed for this tag during 1 minute. If the
number of changes exceeds this limit, the tag is
automatically put out of scan. The function is useful for
filter exception reports due to hardware failures in the
digital contacts. Those no- meaningful exception
reports might significantly reduce or saturate the
playback storage area.
TRIP_NUM Integer Triggered post trip group number. {0,1...100}
4 0 [mxhgrp]
Optional If greater than 0, it identifies the post trip group to be
triggered when the tag goes into alarm or returns to
normal.
ALM_PROG Character Program activation flag on alarm. {Y,N} N None
1
Optional If set, the application action program defined by
AAP_NUM field will be activated whenever an alarm
condition occurs.
2VAA000830-330 A 43
S+ Operations DB Reference DATABASE STRUCTURE

EVT_PROG Character Program activation flag on event. {Y,N} N None


1
Optional If set, the application action program defined by
AAP_NUM field will be activated whenever an event
(state change) takes place.

2.7.3 Digital Tag - Symphony Input Parameters


The fields listed in Table 2-30 provides information on sequence of events addressing for digital tags to be part of sequence
of events recorder. They are optional, and the value will be zero for a generic digital tag.
They must be defined (i.e. value greater than zero) for digital tags coming from a sequence of event recorder.
They are valid for digital tags from Symphony SER modules.
SER modules cannot be addressed directly by Symphony Plus tags. Dedicated MFP modules process tags gathered by
SER. Such modules provide data buffering and transmission over the C-NET.
Since managing such tags depends on the configuration of Symphony Plus (they can be used to produce sequence of
events reports as well as they can be stored into the realtime database using SER time stamp), all other processing and
acquisition parameters must be configured according to system configuration.
The fields in Table 2-31 provides information on attributes for the sequence of event RCMs. A sequence of event RCM must
be associated to each SER device.
When a sequence activating event takes place, the RCM tag changes from zero to one, and is kept at one until the sequence
of events collects events.
The following table lists the Digital Tag – Symphony Input Parameters:
Table 2-30: Digital Tag – Symphony Input Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
SER_NUMBER Integer SER number. {1, 2, 3….,10}
2 This field is used for
Optional generating SOE report.
SER_INDEX Integer SER index. {0, 1...512}
4 0 [mxsept]
Optional

When the extended sequence of events (FC 241) is used, the blocks for standard and summary sequence of events are
allocated to the addresses 5000 and 5001 and cannot be defined elsewhere.

2.7.4 Digital Tag - Symphony Input Parameters (continued)


The following table lists the parameters that are not included in the Symphony Tab of the on-line configuration:
Table 2-31: Digital Tag – Symphony Input Parameters (continued)

Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
SOELOG Integer Number of sequence of events log.
3
Optional This field identifies the log of each SER device. 0
None
SOETYPE Integer Type of sequence of events. {0, 1}
1 0
Optional The value of this field can be: None

0 - Standard SOE,
1 - Summary SOE.
SOETIMEOUT Integer Sequence of events time-out.
3
Optional This field defines the interval of time the 0
sequence of events is kept opened ready to None
collect all changes following the first event (the
SOE event activating).
SOETUNITS Integer Time unit to qualify the SOE time-out. {0, 1}
1 0
Optional The value can be: None
44 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

0 - Seconds,
1 - Minutes.
SOEMAXEVT Integer Maximum number of allowed events.
5
Optional The current sequence of event log is closed if it 0
reaches the maximum number of events. A new None
SOE log is opened to collect exceeding events.
SOEOUTLOG Integer Output log for SOE merging.
3
Optional When multiple SER devices are in use, a single 0
log can be generated merging logs. None

If the field value is not equal to the SOELOG


value, it forces a link and merge to the SOELOG
of the desired SER device.

2.7.5 Digital Tag – Command Parameters


The fields listed in Table 2-32 provides information on the text strings associated with each possible status of feedbacks
from the process and these fields are optional.
They are valid only for those digital tags acquired from Symphony modules that support feedback (DD and MSDD).
The on-line configuration includes the fields in the DI Feedback Tab.
The following table lists the Digital Tag – Command Parameters:
Table 2-32: Digital Tag – Command Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
FB1_0STATE Character Zero state descriptor for feedback 1. <string>
16 <blank> [sztags]
Optional This field defines the text to be displayed
for the state 0 of feedback 1.
FB1_1STATE Character One state descriptor for feedback 1. <string>
16 <blank> [sztags]
Optional This field defines the text to be displayed
for the state 1 of feedback 1.
FB2_0STATE Character Same as above for state 0 of feedback 2. <string>
16 <blank> [sztags]
Optional
FB2_1STATE Character Same as above for state 1 of feedback 2. <string>
16 <blank> [sztags]
Optional
FB3_0STATE Character Same as above for state 0 of feedback 3. <string>
16 <blank> [sztags]
Optional
FB3_1STATE Character Same as above for state 1 of feedback 3. <string>
16 <blank> [sztags]
Optional
FB4_0STATE Character Same as above for state 0 of feedback 4. <string>
16 <blank> [sztags]
Optional
FB4_1STATE Character Same as above for state 1 of feedback 4. <string>
16 <blank> [sztags]
Optional

2.7.6 Digital Tag - Alarm Processing Parameter


The fields listed in Table 2-33 provides information on the specific priority to be associated to a digital (status only) tag.
Refer to the analog sub-sections of generic tag definition for additional fields concerning the default alarm priority and other
specific alarm priorities.
Refer the description of the AL_PRI field for details on the definition of alarm priorities.
The following table lists the Digital Tag – Alarm Processing Parameter:
Table 2-33: Digital Tag – Alarm Processing Parameter
2VAA000830-330 A 45
S+ Operations DB Reference DATABASE STRUCTURE

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
ALPRI_STCH Integer Status change priority number. {0, 1 ... 16}
3 0
Optional This is the priority assigned to the tag (defined as [mxalpr] or
status only tag and not alarm tag) when a status [mxxapr]
change takes place and the condition must be
displayed. If set to 0 then the default priority is
assigned.

2.7.7 Digital Tag - Alarm Comment Parameters


The fields listed in Table 2-34 provides information on descriptive texts to be associated to alarm conditions of the tag.
Either an integer format (index) or a character format (text) can be used.
The index is used to address an alarm comment defined within the alarm comment database. This approach requires the
separate configuration of an alarm comment database in order to define all referenced alarm comments. If the index is
defined, the text type field (if any) is ignored.
If the text type field is used, it is added to the alarm comment database at the first vacant index. This approach does not
require the separate configuration of an alarm comment database. If the text is defined, the index type field must not be
included in the tag database.
The following table lists the Digital Tag – Alarm Comment Parameters:
Table 2-34: Digital Tag – Alarm Comment Parameters

Format Width Range Default


Name Description
Opt/Mnd Parameter(s)
ALRMCMNT12 Integer Alarm comment index for alarm {1...100}
3 condition. <blank> [mxalcm]
Optional
ALRMCTXT12 Character Alarm comment text for alarm condition. <string>
80 <blank> [szalcm]
Optional
Refer to the Alarm Comment – Definition Parameters for more information about the contents of these fields. Refer to the
analog sub-sections of the generic tag definition for other alarm comment fields.
The on-line configuration allows selection of alarm comment either by index (typing the number) or text (selecting from a
list).

2.7.8 Digital Tag - Totalization Parameters


The fields listed in Table 2-35 provides information on totalizations associated to the digital tag. They are valid, if the
TOT_LOG field is defined as non- zero value (i.e. a totalization has been associated to the digital tag).
This kind of totalization collects maintenance information related to dual state devices like motors, pumps, breakers, etc.
The totalization collects the number activations (i.e. the changes from a steady to an operational condition), the operating
time (sum of times in the operational condition) and the total time elapsed from the last service of the device the tag is
associated to.
Those collected values are compared to maximum values defined by the fields during processing.
The following table lists the Digital Tag – Totalization Parameters:
Table 2-35: Digital Tag – Totalization Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
HRTRUNSTAT Integer Dig. tot. running status {0, 1}
1 0
Optional Running status for digital totalization. None

This field defines the status identifying


the operational condition of the dual-state
device.
HRTMAXCHGS Integer Dig. tot. max changes
5 0
Optional Maximum number of status changes. None

46 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

This field defines the upper limit to the


number of allowed transitions from the
steady to the operational status of the
device.
HRTMAXRUN Integer Dig. tot. max running time
3
Optional Maximum running time. 0
None
This field defines the upper limit of the
operational time (sum of times in
operation) of the device. It is the
totalization of all single operational time
intervals.
HRTMAXRUNU Integer Dig. tot. max running time unit
1
Optional Time unit for maximum running time. 0
None

HRTMAXSRV Integer Dig. tot. max time from service


3
Optional Maximum time from service. 0
None
This field defines the upper limit to the
service time (time elapsed from the date
of the last service) of the device. It is the
difference between the current date and
the service date.
HRTMAXSRVU Integer Dig. tot. max time from service unit 0
1 None
Optional Time unit for maximum time from service.

2.7.9 Digital Tag - Device Status Parameters


The fields listed in Table 2-36 provides information on the device status tag only. These tags are used for diagnostic. The
device status tags allow collecting and storing the components diagnostic of the of the hardware architecture: computers,
printers, hard disks.
Set ALMACKBC flag using Infinet to route the alarm acknowledgments for a tag. This allows to broadcast acknowledgments
among nodes when the Ethernet is not connected to the network.
The online configuration does not provide a Tab including the device status fields. They can be defined by the off-line
(database file) configuration only.
If using Operations Engineering, note that the tag must be created as TAGTYPE = DIGITAL and then updated to TAGTYPE
= DEVSTAT
The following table lists the Digital Tag – Device Status Parameters:
Table 2-36: Digital Tag – Device Status Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
DEV_NAME Character Device name. <string>
20 <blank> None
Optional Depending on the type of device (refer to
the DEV_TYPE field for details), this field
can define the name of a printer, a
computer or a disk.

Refer to Note 1 at the end of the table for


more details
DEV_NUMBER Integer Device number. <integer>
15 0
Optional Allowed values are: None

1 - Printer,
2 - Node,
3 - Disk.
DEV_TYPE Integer Device type. {Printer, Node, Disk}
2VAA000830-330 A 47
S+ Operations DB Reference DATABASE STRUCTURE

15 The field qualifies the kind of device the 0


Optional tag applies to. It may define a printer, a None
node or a disk diagnostic tag.

Refer to Note 2 at the end of the table for


more details.
DEVSUBTYPE Integer Device sub-type.
2
Optional This field is not required for module 0
diagnostic. None
MODTYPE Character Module type. {MFP, OIS, MCS, ...}
20 <blank> [sznam]
Optional This field defines the kind of hardware to
be either: MFP, OIS, MCS or TNT

This field is not required for module


diagnostic. The field value is used, when
the ALMACKBC flag is set, to route the
alarm acknowledge through the Infinet.
MODREV Character Module revision. <string>
2 <blank> None
Optional This field is not required for module
diagnostic.

Note 1:
The name of devices is the names as known by Windows operating system. That is, a printer name is the name as defined
during the printer definition (e.g. LPT1 or \\SERVERNODE\LASERPRT1), a node name is the computer name (e.g.
Symphony Plus SERVER1) as defined in the Network tab (access from Settings and Control Panel) and a disk name is the
identifier of disk (e.g. C or D).

Note 2:
The diagnostic function reports the availability of printers, the existence (or the operability) of nodes and the space allocation
of disks.
The
system settings DiskUsageHighLimit and DiskUsageVeryHighLimit indicates the high and very high limits of the disk space
allocation.

2.7.10 Digital Tag – Documentation Parameters


The field listed in Table 2-37 provides information on tag conditions and documentation.
Note: Symphony Plus does not manage these fields, but these fields are loaded in the tag database based on requirement.
Refer to the analog sub-section of generic tag definition for additional fields.
The following table lists the Digital Tag- Documentation Parameters:
Table 2-37: Digital Tag – Documentation Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
ALMDST Integer Reference to status change
5 documentation 0
Optional None

Hardware Description Parameters:


Fields of this sub-section apply to both analog and digital tags. Refer to the analog sub-section of generic tag definition for
details.
Application Parameters:
Fields of this sub-section apply to both analog and digital tags. Refer to the analog sub-section of generic tag definition for
details.
Analog Tag Definition:
This section describes all specific fields used, together the fields defined in the generic tag definition chapter, to configure
analog tags.
48 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

General Parameters:
The fields listed in Table 2-38 provides information on the engineering unit index or text, the floating point presentation
format, the presentation scale and other parameters typical of analog tags. All fields are optional.
Refer to the Engineering Unit Database sub-section for more information about different ways to configure engineering
units.
The on-line configuration allows selection of engineering unit either by index (typing the number) or text (selecting from a
list).

2.8 Analog Tag Definition


This section describes the fields to configure analog tags.

2.8.1 Analog Tag - General Parameters


The following table lists the Analog Tag- General Parameters:
Table 2-38: Analog Tag – General Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
EUDESC Character Engineering unit text. <string>
16 <blank> [sztags]
Optional EU_NAME is the alias name for the field.

This text defines the engineering unit


associated to the tag.
NUMDECPL Integer Number of decimal places. {0...9}
1 2
Optional The information is used when displaying None
the tag value.
I4_DATA Character Integer/Real format flag. {Y,N} N None
1
Optional If set, the value of the tag will be stored
into realtime database as a 32-bit signed
integer.
PLAYBACKCM Character Playback compression flag. {Y,N} N None
1
Optional If set, tag exception reports will be
compressed in the playback archive
according to compression rules.
INITVAL Real Initial value. {lowlim...higlim}
15 0
Optional This value is loaded into realtime None
database at system start-up.

Refer to Note 1 at the end of the table for


more details.
SCA_VAL_0 Real 0% scale value. {lowlim...higlim}
15 0
Optional Value (expressed in engineering units) None
representing the 0% scale to be used for
bar chart and trend representation of the
tag. If omitted or zero (blank), the 0%
scale will be assumed to be the low
instrument limit. Refer to Note 1 at the
end of the table for more details.
SP_VAL0 Real Set point low limit {lowlim...higlim}
15 0
Optional None
SP_VAL100 Real Set point high limit {lowlim...higlim}
15 0
Optional None
SCA_VL_100 Real 100% scale value. {lowlim...higlim}
15 0
Optional Value (expressed in engineering units) None
representing the 100% scale to be used
for bar chart and trend representation of
2VAA000830-330 A 49
S+ Operations DB Reference DATABASE STRUCTURE

the tag. If omitted or zero (blank),


the100% scale will be assumed to be the
high instrument limit. Refer to Note 1 at
the end of the table for more details.
PLAYBACKDB Real Playback dead-band. {lowlim...higlim}
10 0
Optional DEADB_PB is alias name for this field None

This value (expressed in engineering


units) defines the dead-band for dummy
packet checking. If defined, must be
wider than the significative change the
tag value can take. Refer to the
PLAYBACKTM field and Note 3 at the
end of the table for more details.

Refer to Note 1 at the end of the table for


details.
PLAYBACKTM Integer Playback timer.
5
Optional This field defines the timer (in seconds) 30
for dummy packet checking. None
PLBCOMPRDB Integer Refer to PLAYBACKDB field and Note 3 {0...100}
15 at the end of the table for details. 0
Optional None
FILTER_TAU Integer Playback compression dead-band.
4
Optional This value (expressed in percentage) 0
defines the dead-band for playback None
compression algorithm. If defined, must
be wider than the significant change the
tag value can take.
INCDECPRC Real Time constant for filter factor. {0...100}
10 0.0
Optional This field defines a time constant for None
filtering a tag value before updating the
realtime database. A value of zero will
disable filtering. The value stored in the
realtime database is computed using new
input (raw) value and old realtime
database value.

Refer to Note 2 at the end of the table for


details.

Note 1:
In the range boxes, values of “lowlim” and “higlim” are defined by the general formulas:
lowlim = VAL0
higlim = VAL0 + SPAN
Values of VAL0 and SPAN are defined in the alarm level definition sub-section.

Note 2:
Filtering defined by the FILTER_TAU field plays a weighting role when a new tag value must be stored in the realtime
database. The stored value is computed according to the following formula:
Vn = Vn-1 * (FILTER_TAU / (dt + FILTER_TAU)) + Vr * (dt / (dt + FILTER_TAU))
Where:
Vn is the value to be computed and stored in the realtime database.
Vr is the input raw value.
Vn-1 is the current value stored in the realtime database. Date is the time elapsed between two exceptions.
FILTER_TAU is the value of filter factor.
If the filter factor is zero (no filtering applied), the weight of the current value in the realtime database is zero and the input
raw value of the tag will be stored in the realtime database.
50 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

Note 3:
Playback dead-band and timer provides a mechanism to allow re-building the actual history of the tag in trend displays and
trip analysis. If they are defined, each time a new packet is going to be queued to playback, its value is compared to last
stored packet. If the difference between values is greater than the defined playback dead-band, and last stored packet is
older than the defined playback timer, an additional dummy packet is queued to playback with the same value and quality
as the old one and the same time as the new one. Then the new packet is stored. This allows a higher reliability in data
trending. This allows to re-build the “step” graphic trend of the tag in the historian mode operating with such tags that can
change suddenly after a long steady period (i.e. currents or pressures).
This mechanism is used based on requirement, as it may considerably decrease the playback archive capacity.

2.8.2 Analog Tag - General Parameters (continued)


The following table lists the Analog Tag- General Parameters:
Table 2-39: Analog Tag – General Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
SPEUINDEX Integer SP Engineering Unit index. {-1, 0...127}
3 This field defines the index into the -1
Optional engineering unit database for set point. A
value of –1 forces automatic assignment
of engineering unit index for set point and
requires the specification of the
engineering unit text.
EUINDEX Integer Engineering unit index. {-1, 0...127}
3 This field defines the index into the -1 [mxeutx]
Optional engineering unit database. A value of –1
forces automatic assignment of
engineering unit index and requires the
specification of the engineering unit text
(refer to CONSTDELTA field for more
details).
CONSTDELTA Real Hourly constancy delta value. {lowlim...higlim}
10 0
Optional This value (expressed in engineering None
units) defines the delta allowed as
tolerance for hourly constancy check.
This field is meaningful only if Symphony
Plus has been configured to support
hourly constancy function.

The on-line configuration does not include


the field in the PV General Tab.

DELTA_HVAL is the alias name for this


field

The EUINDEX field takes precedence over EUDESC field. If EUINDEX is defined, EUDESC is ignored. If EUINDEX is
omitted (blank) or –1, the text defined by EUDESC is added to engineering unit database at the first vacant index.
When the EUINDEX is defined, the engineering unit database must be defined and built. Refer to the Engineering Units sub-
section for more details.

2.8.3 Analog Tag – Generic Scanner Input Parameters


The following table lists the Analog Tag – Generic Scanner Input Parameters:
Table 2-40: Analog Tag – Generic Scanner Input Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
CONVCODE Character Conversion code to be performed on the <string>
20 input raw data. <blank> [sznam]
2VAA000830-330 A 51
S+ Operations DB Reference DATABASE STRUCTURE

Optional
CONVMIN Integer Minimum value (in engineering unit) of the
15 input raw data.
Optional 0
None
CONVMAX Integer Maximum value (in engineering unit) of
15 the input raw data.
Optional 0
None
CONVOFFS Integer Offset value to add on converting input
15 raw data.
Optional 0
None

2.8.4 Analog Tag - Alarm Processing Parameters


The fields listed in following table provides information on specific alarm priorities to be associated to an analog tag.
Refer the description of the AL_PRI field for details on the definition of alarm priorities.
The following table lists the Analog Tag – Alarm Processing Parameters:
Table 2-41: Analog Tag – Alarm Processing Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
ALPRI_3H Integer 3-High alarm priority number. {0, 1 ... 16}
2 0
Optional This is the priority assigned to the tag when [mxalpr] or [mxxapr]
a 3-high alarm condition takes place. If set
to 0 then the default priority is assigned.
ALPRI_2H Integer 2-High alarm priority number. {0, 1 ... 16}
2 0
Optional This is the priority assigned to the tag when [mxalpr] or [mxxapr]
a 2-high alarm condition takes place. If set
to 0 then the default priority is assigned.
ALPRI_H Integer High alarm priority number. {0, 1 ... 16}
2 0
Optional This is the priority assigned to the tag when [mxalpr] or [mxxapr]
a high alarm condition takes place. If set to
0 then the default priority is assigned.
ALPRI_L Integer Low alarm priority number. {0, 1 ... 16}
2 0
Optional This is the priority assigned to the tag when [mxalpr] or [mxxapr]
a low alarm condition takes place. If set to 0
then the default priority is assigned.
ALPRI_2L Integer 2-Low alarm priority number. {0, 1 ... 16}
2 0
Optional This is the priority assigned to the tag when [mxalpr] or [mxxapr]
a 2-low alarm condition takes place.
ALPRI_3L Integer 3-Low alarm priority number. {0, 1 ... 16}
2 0
Optional This is the priority assigned to the tag when [mxalpr] or [mxxapr]
a 3-low alarm condition takes place. If set to
0 then the default priority is assigned.
ALPRI_HROC Integer High rate of change priority number. {0, 1 ... 16}
2 0
Optional This is the priority assigned to the tag when [mxalpr] or [mxxapr]
a high rate of change alarm condition takes
place. If set to 0 then the default priority is
assigned.
ALPRI_LROC Integer Low rate of change priority number. {0, 1 ... 16}
2 0
Optional This is the priority assigned to the tag when [mxalpr] or [mxxapr]
a low rate of change alarm condition takes
place. If set to 0 then the default priority is
assigned.

ALPRI_HDEV Integer High deviation priority number. {0, 1 ... 16}


52 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

2 0
Optional This is the priority assigned to the tag when [mxalpr] or [mxxapr]
a high deviation alarm condition takes place.
If set to 0 then the default priority is
assigned.
ALPRI_LDEV Integer Low deviation priority number. {0, 1 ... 16}
2 0
Optional This is the priority assigned to the tag when [mxalpr] or [mxxapr]
a low deviation alarm condition takes place.

The on-line configuration includes the fields above in the Alarm Level Tab and in the Alarm Option Tab.

2.8.5 Analog Tag - Alarm Level Parameters


The fields listed in Table 2-42 provides information on all alarm levels and related information concerning analog tags. All
these fields are valid if remote alarm processing (AL_REM field) is not enabled and these fields are optional.
The range of an analog tag is characterized by values of zero and span. They define the boundary limits to the tag values.
Symphony Plus automatically loads values of zero and span for Symphony tags.
Each analog tag has six fixed alarm levels, three high alarm limits and three low alarm limits. They are defined by a single
absolute value for each threshold, or by two dynamic values for high and low threshold and four offset values to define higher
and lower level thresholds as function of the dynamic values.
Raw and current threshold values are compared to decide if an alarm condition need to be notified. Of course, the dynamic
threshold tags and the current analog tag represents the same physical entity to be comparable.
Note: Dynamic thresholds are calculated tags.
The following table lists the Analog Tag – Alarm Level Parameters:
Table 2-42: Analog Tag – Alarm Level Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
HINS_LIMIT Real High instrument limit.
15
Optional This value (expressed in engineering units) 0
defines the 100% scale of the tag. This None
parameter may be used instead of SPAN.
SPAN Real Instrument span.
15
Optional This value (expressed in engineering units) 0
defines the range of the tag. None

When SPAN is used, the high instrument


limit is automatically calculated as the result
of VAL0 + SPAN.
HD_ACTIVE Character High Deviation active {Y, N} N None
1
Optional
LD_ACTIVE Character Low Deviation active {Y, N} N None
1
Optional
HI_ACTIVE Character High instrument limit activation flag. {Y, N} N None
1
Optional
HI_PROG Character Program activation flag on high instrument {Y, N} N None
1 alarm.
Optional
If set, the application action program defined
by AAP_NUM field will be activated
whenever a high instrument alarm is
generated.

HINS_PROG is the alias name for this field

H3ALARM Real 3-High alarm limit. {lowlim...higlim}


15 0
Optional None
2VAA000830-330 A 53
S+ Operations DB Reference DATABASE STRUCTURE

This value (expressed in engineering units)


defines the third high alarm level.

HIGH_LIMIT, DELTA_HH, and DELTA_SH


are the alias name for this field

Refer to Note1 at the end of the table for


more details.
H3_ACTIVE Character 3-High alarm limit activation flag. {Y, N} N None
1
Optional
H2ALARM Real 2-High alarm limit. {lowlim...higlim}
15 0
Optional This value (expressed in engineering units) None
defines the second high alarm level.

HIGH_LIMIT and DELTA_HH are the alias


name for this field

Refer to Note 1 at the end of the table for


more details.
H2_ACTIVE Character 2-High alarm limit activation flag. {Y, N} N None
1
Optional
H23_PROG Character Program activation flag on 2 and 3-High {Y, N} N None
1 alarm.
Optional
If set, the application action program defined
by AAP_NUM field will be activated
whenever a 2-High alarm or 3- High alarm is
generated.
HALARM Real High alarm limit. {lowlim...higlim}
15 0
Optional This value (expressed in engineering units) None
defines the first high alarm level.

HIGH_LIMIT is the alias name for this field

Refer to Note 1 at the end of the table for


more details.
H_ACTIVE High alarm limit activation flag. {Y, N} N None
H_PROG Character Program activation flag on high alarm. {Y, N} N None
1
Optional If set, the application action program defined
by AAP_NUM field will be activated
whenever a high alarm is generated.
LALARM Real Low alarm limit. {lowlim...higlim}
15 0
Optional This value (expressed in engineering units) None
defines the first low alarm level.

LOW_LIMIT and DELTA_LL is the alias


name for this field.

Refer to Note 1 at the end of the table for


more details.
L_ACTIVE Character Low alarm limit activation flag. {Y, N} N None
1
Optional
L_PROG Character Program activation flag on low alarm. {Y, N} N None
1
Optional If set, the application action program defined
by AAP_NUM field will be activated
whenever a low alarm is generated.

L2ALARM Real 2-Low alarm limit. {lowlim...higlim}


15 0
Optional None

54 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

This value (expressed in engineering units)


defines the second low alarm level.

Refer to Note 1 at the end of the table for


more details.
L2_ACTIVE Character 2-Low alarm limit activation flag. {Y, N} N None
1
Optional
L3ALARM Real 3-Low alarm limit. {lowlim...higlim}
15 0
Optional This value (expressed in engineering units) None
defines the third low alarm level.

LOW_LIMIT, DELTA_LL, and DELTA_SL


are the alias name for this field.

Refer to Note 1 at the end of the table for


more details.
L3_ACTIVE Character 3-Low alarm limit activation flag. {Y, N} N None
1
Optional
L23_PROG Character Program activation flag on 2 and 3-Low {Y, N} N None
1 alarm.
Optional
If set, the application action program defined
by AAP_NUM field will be activated
whenever a 2-Low alarm or 3- Low alarm is
generated.
VAL0 Real Low instrument limit.
15
Optional This value (expressed in engineering units) 0
represents the 0% scale of the tag. None
LI_ACTIVE Character Low instrument limit activation flag. {Y, N} N None
1
Optional
LI_PROG Character Program activation flag on low instrument {Y, N} N None
1 alarm.
Optional
If set, the application action program defined
by AAP_NUM field will be activated
whenever a low instrument alarm is
generated.
HVARALMTAG Character High variable alarm tag. <string>
256 <blank> [sznam]
Optional Name of an analog tag whose value will be
used as high alarm limit. If this field is
defined, all values specified by fixed high
alarm limits will be ignored.
H2VARALMTG Character 2-High variable alarm tag. <string>
256 <blank> [sznam]
Optional Name of an analog tag whose value will be
used as 2-high alarm limit. If this field is
defined, all values specified by fixed or delta
high alarm limits will be ignored.
H3VARALMTG Character 3-High variable alarm tag. <string>
256 <blank> [sznam]
Optional Name of an analog tag whose value will be
used as 3-high alarm limit. If this field is
defined, all values specified by fixed or delta
high alarm limits will be ignored.
H2DELTA Real 2-High variable alarm delta. {lowlim...higlim}
15 This value (expressed in engineering units) 0
Optional will be added to the high variable alarm tag None
value (if defined) to determine the 2-High
variable alarm limit. It is ignored if the
H2VARALMTAG field is defined.

2VAA000830-330 A 55
S+ Operations DB Reference DATABASE STRUCTURE

Refer to Note 1 at the end of the table for


more details.
H3DELTA Real 3-High variable alarm delta. {lowlim...higlim}
15 0
Optional This value (expressed in engineering units) None
will be added to the high variable alarm tag
value (if defined) to determine the 3-High
variable alarm limit. It is ignored if the
H3VARALMTAG field is defined.

Refer to Note 1 at the end of the table for


more details.
LVARALMTAG Character Low variable alarm tag. <string>
256 <blank> [sznam]
Optional Name (or index) of an analog tag whose
value will be used as low high alarm limit. If
this field is defined, all values specified by
fixed low alarm limits will be ignored.
L2VARALMTG Character 2-Low variable alarm tag. <string>
256 <blank> [sznam]
Optional Name (or index) of an analog tag whose
value will be used as 2-low high alarm limit.
If this field is defined, all values specified by
fixed or delta low alarm limits will be ignored.
L3VARALMTG Character 3-Low variable alarm tag. <string>
256 <blank> [sznam]
Optional Name (or index) of an analog tag whose
value will be used as 3-low high alarm limit.
If this field is defined, all values specified by
fixed or delta low alarm limits will be ignored.
L2DELTA Real 2-Low variable alarm delta. {lowlim...higlim}
15 0
Optional This value (expressed in engineering units) None
will be subtracted from the low variable
alarm tag value (if defined) to determine the
2-Low variable alarm limit. It is ignored if the
L3VARALMTAG field is defined.

Refer to Note 1 at the end of the table for


more details.
L3DELTA Real 3-Low variable alarm delta. {lowlim...higlim}
15 0
Optional This value (expressed in engineering units) None
will be subtracted from the low variable
alarm tag value (if defined) to determine the
3-Low variable alarm limit. It is ignored if the
L3VARALMTAG field is defined.

Refer to Note 1 at the end of the table for


more details.

Note 1:
In the range boxes, values of “lowlim” and “higlim” are defined by the general formulas:
lowlim = VAL0
higlim = VAL0 + SPAN
Values of VAL0 and SPAN are defined in the alarm level definition sub-section.
The SPAN field, defined in the database, is the full range of the tag (e.g. the range of the instrument). The high instrument
field, in the on-line configuration, defines the high instrument limit and correspond to the HINS_LIMIT field. They match only
if the VAL0 field value is zero.
When defining fixed alarm levels be sure to have a correct sequence of values for all active limits. In other words, fixed alarm
limits must satisfy the following relation:
(VAL0+SPAN) >
H3ALARM > H2ALARM > HALARM >
LALARM > L2ALARM >L3ALARM >
VAL0
56 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

Limits left not active must be ignored in the previous relation.


When using dynamic alarm limits, be sure values of dynamic alarm limits do not exceed the instrument limits and values of
dynamic alarm limits satisfy the relationship above.
All limits may be enabled or disabled by a flag. So, an alarm limit may be disabled without to change absolute, delta values
or dynamic threshold tags.
Most of fields have an alarm action flag field. If enabled it allows activation of the alarm action program defined by field
AAP_NUM (Refer to the Generic Tag Definition section for more details).

2.8.6 Analog and Digital Tag – Control References


The fields listed in following table provides information on all alarm levels and related information concerning analog and
digital tags. These fields are valid if remote alarm processing (AL_REM field) is not enabled and these fields are optional.
The range of an analog tag is characterized by values of zero and span. They define the boundary limits to the tag values.
Symphony Plus automatically loads values of zero and span for Symphony tags.
Each analog tag has six fixed alarm levels, three high alarm limits and three low alarm limits. They are defined by a single
absolute value for each threshold, or by two dynamic values for high and low threshold and four offset values to define higher
and lower level thresholds as function of the dynamic values.
Raw and current threshold values are compared to decide if an alarm condition need to be notified. Of course, the dynamic
threshold tags and the current analog tag represents the same physical entity to be comparable.
Note: Dynamic thresholds are calculated tags.
The following table lists the Analog Tag and Digital Tag – Control References:

Table 2-43: Analog and Digital Tag – Control References

Format Width Range Default


Name Description
Opt/Mnd Parameter(s)
HVARALMTAG Character High variable alarm analog tag. <string>
50 <blank> None
Optional Name of an analog tag whose
value will be used as high alarm
limit. If this field is defined, all
values specified by fixed high
alarm limits will be ignored.

HVALIM_PID is the alias name


for this field

H2VARALMTAG Character 2 High variable alarm analog <string>


50 tag. <blank> None
Optional
Name of an analog tag whose
value will be used as 2-high
alarm limit. If this field is defined,
all values specified by fixed or
delta high alarm limits will be
ignored.

HVALIM_PID is the alias name


for this field

H3VARALMTAG Character 3 High variable alarm analog <string>


50 tag. <blank> None
Optional
Name of an analog tag whose
value will be used as 3-high
alarm limit. If this field is defined,
all values specified by fixed or
delta high alarm limits will be
ignored.

HVALIM_PID is the alias name


for this field

2VAA000830-330 A 57
S+ Operations DB Reference DATABASE STRUCTURE

LVARALMTAG Character Low variable alarm analog tag. <string>


50 <blank> None
Optional Name (or index) of an analog
tag whose value will be used as
low high alarm limit. If this field is
defined, all values specified by
fixed low alarm limits will be
ignored.

LVALIM_PID is the alias name


for this field

L2VARALMTG Character 2 Low variable alarm analog tag. <string>


50 <blank> None
Optional Name (or index) of an analog
tag whose value will be used as
2-low high alarm limit. If this field
is defined, all values specified by
fixed or delta low alarm limits will
be ignored.

LVALIM_PID is the alias name


for this field

L3VARALMTG Character 3 Low variable alarm analog tag. <string>


50 <blank> None
Optional Name (or index) of an analog
tag whose value will be used as
3-low high alarm limit. If this field
is defined, all values specified by
fixed or delta low alarm limits will
be ignored.

LVALIM_PID is the alias name


for this field

REF_HINSTR Character High instrument reference <string>


256 analog tag. <blank> None
Optional
REF_LINSTR Character Low instrument reference analog <string>
256 tag. <blank> None
Optional
REF_H1 Character H1 reference analog tag. <string>
256 <blank> None
Optional
REF_H2 Character H2 reference analog tag. <string>
256 <blank> None
Optional
REF_H3 Character H3 reference analog tag. <string>
256 <blank> None
Optional
REF_L1 Character L1 reference analog tag. <string>
256 <blank> None
Optional
REF_L2 Character L2 reference analog tag. <string>
256 <blank> None
Optional
REF_L3 Character L3 reference analog tag. <string>
256 <blank> None
Optional
REF_BADC Character Bad calculation reference tag is <string>
256 either an analog or a digital. <blank> None
Optional

58 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

REF_CF Character Communication failure reference <string>


256 tag is either an analog or a <blank> None
Optional digital.
REF_CHF Character Channel failure reference tag is <string>
256 either an analog or a digital. <blank> None
Optional
REF_OLD Character Old reference tag is either an <string>
256 analog or a digital. <blank> None
Optional
REF_CFGER Character Configuration error reference tag <string>
256 is either an analog or a digital. <blank> None
Optional
REF_NOCON Character No connection reference tag is <string>
256 either an analog or a digital. <blank> None
Optional
REF_DEVER Character Device failure reference tag is <string>
256 either an analog or a digital. <blank> None
Optional
REF_WIV Character Wait initial value reference tag is <string>
256 either an analog or a digital. <blank> None
Optional
REF_SUBN Character Subnormal reference tag is <string>
256 either an analog or a digital. <blank> None
Optional
REF_EXTF1 Character Extended Flag1 reference tag is <string>
256 either an analog or a digital. <blank> None
Optional
REF_EXTF2 Character Extended flag2 reference tag is <string>
256 either an analog or a digital. <blank> None
Optional
REF_EXTF3 Character Extended flag3 reference tag is <string>
256 either an analog or a digital. <blank> None
Optional
CTRLINHTAG Character Control inhibit tag. <string>
50 It is either an analog or a digital <blank> None
Optional tag and used to disable the
actions upon analog (RMSC)
and digital (RCM, DD, MSDD)
control tags.

INIB_PID is the alias name for


this field
CTRLINHVAL Integer Control inhibit value <string>
1 <blank> None
Optional Set the values from the drop-
down list. The values are as
follows:
0,1,2,3,A,N,H,2H,3H,L,2L,3L,CF
, and blank
H1INHTAG Character Alarm inhibit analog tag level <string>
50 H1. <blank> None
Optional
H1INHVAL Integer Alarm inhibit analog tag level H1 <string>
1 value. <blank> None
Optional
Set the values from the drop-
down list. The values are as
follows:
0,1,2,3,A,N,H,2H,3H,L,2L,3L,CF
, and blank
H2INHTAG Character Alarm inhibit analog tag level <string>
50 H2. <blank> None
Optional
H2INHVAL Integer Alarm inhibit analog tag level H2 <string>
1 value. <blank> None
Optional

2VAA000830-330 A 59
S+ Operations DB Reference DATABASE STRUCTURE

Set the values from the drop-


down list. The values are as
follows:
0,1,2,3,A,N,H,2H,3H,L,2L,3L,CF
, and blank
H3INHTAG Character Alarm inhibit analog tag level <string>
50 H3. <blank> None
Optional
H3INHVAL Integer Alarm inhibit analog tag level H3 <string>
1 value. <blank> None
Optional
Set the values from the drop-
down list. The values are as
follows:
0,1,2,3,A,N,H,2H,3H,L,2L,3L,CF
, and blank
L1INHTAG Character Alarm inhibit analog tag level L1. <string>
50 <blank> None
Optional
L1INHVAL Integer Alarm inhibit analog tag level L1 <string>
1 value. <blank> None
Optional
Set the values from the drop-
down list. The values are as
follows:
0,1,2,3,A,N,H,2H,3H,L,2L,3L,CF
, and blank
L2INHTAG Character Alarm inhibit analog tag level L2. <string>
50 <blank> None
Optional
L2INHVAL Integer Alarm inhibit analog tag level L2 <string>
1 value. <blank> None
Optional
Set the values from the drop-
down list. The values are as
follows:
0,1,2,3,A,N,H,2H,3H,L,2L,3L,CF
, and blank
L3INHTAG Character Alarm inhibit analog tag level L3. <string>
50 <blank> None
Optional
L3INHVAL Integer Alarm inhibit analog tag level L3 <string>
1 value. <blank> None
Optional
Set the values from the drop-
down list. The values are as
follows:
0,1,2,3,A,N,H,2H,3H,L,2L,3L,CF
, and blank

2.8.7 Analog Tag – Alarm Option Parameters


The fields define additional alarm and archive processing information for analog tags.
The rate of change allows definition of a limit to the amount of changes during a prefixed period (a minute). Both increment
and decrement changes may be checked. Defined values may be activated and the alarm condition may activate an alarm
action program.
The alarm dead-band defines an alarm insensibility threshold to delay the alarm transition from a higher to a lower level
alarm or from an alarm level to a normal condition.
The alarm transition from a lower to a higher level alarm takes place immediately when the raw value of tag exceeds the
alarm limit threshold.
The alarm transition from a higher to a lower level alarm or from an alarm level to a normal condition takes place when the
raw value of tag is below the alarm limit threshold minus the dead band.
Neither rate of change of processing nor alarm dead-band definitions is affected by instrument limits.
The last two fields in the table defines the instrument limit violation. They allow defining actions to be performed on tag
database value when an instrument limit is exceeded.

60 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

The following table lists the Analog Tag- Alarm Option Parameters:
Table 2-44: Analog Tag – Alarm Option Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
HR_ACTIVE Character Increasing rate of change limit activation {Y, N} N None
1 flag.
Optional
HROC_LIMIT Real Increasing rate of change limit. {lowlim...higlim}
15 0
Optional This value (expressed in engineering None
units) defines the maximum positive
change allowed for the tag value during a
period of one minute. If the value is
exceeded, an increasing rate of change
alarm is generated.

HR_PROG Character Program activation flag on increasing rate {Y, N} N None


1 of change alarm.
Optional
If set, the application action program
defined by AAP_NUM field will be
activated whenever an increasing rate of
change alarm is generated.
LR_ACTIVE Character Decreasing rate of change limit activation {Y, N} N None
1 flag.
Optional
LROC_LIMIT Real Decreasing rate of change limit. {lowlim...higlim}
15 0
Optional This value (expressed in engineering None
units) defines the maximum negative
change allowed for the tag value during a
period of one minute. If the value is
exceeded, a decreasing rate of change
alarm is generated. It is usually entered
as a negative number. If an accumulator
must increase at a minimum rate, this
value may be entered as a positive
number.
LR_PROG Character Program activation flag on decreasing {Y, N} N None
1 rate of change alarm.
Optional
If set, the application action program
defined by AAP_NUM field will be
activated whenever a decreasing rate of
change alarm is generated.
ALARMDB Real Alarm dead-band. {All limits}
15 0
Optional This value (expressed in engineering None
units) defines a dead-band below the
high alarm limits and above the low alarm
limits. A high (low) alarm will return to
normal only when the value is below
(above) the high (low) alarm limit minus
(plus) the alarm dead-band.

This is enabled only when Remote alarm


processing option is disabled.

DEADB_CD is the alias name for this


field

For more information, refer to Note 2.


ALARMDBH Real High Alarm dead-band
15 0
Optional This value (expressed in engineering None
units) defines a dead-band below the

2VAA000830-330 A 61
S+ Operations DB Reference DATABASE STRUCTURE

high alarm limits. A high alarm will return


to normal only when the value is below
the high alarm limit minus the alarm
dead-band. Adopt larger value in either of
Alarm dead-band E.U. or this value for
high alarm dead-band value.

This field is enabled only when Remote


alarm processing option is disabled.

For more information, refer to Note 2.


ALARMDBL Real Low Alarm dead-band
15 0
Optional This value (expressed in engineering None
units) defines a dead-band above the low
alarm limits. A low alarm will return to
normal only when the value is above the
low alarm limit plus the alarm dead-band.
Adopt larger value in either of Alarm
dead-band E.U. or this value for low
alarm limit dead-band value.

This is enabled only when Remote alarm


processing option is disabled.

For more information, refer to Note 2.


LIMITDB Real Limit dead-band.
15
Optional This value (expressed in engineering 0
units) defines a dead-band above the None
high instrument limit and below the low
instrument limit. A high (low) instrument
violation will be considered only when the
value is above (below) the high (low)
instrument limit plus (minus) the
instrument dead-band.

This is enabled only when Remote alarm


processing option is disabled.

For more information, refer to Note 2.


LIMITDBH Real High Limit dead-band
15 0
Optional This value (expressed in engineering None
units) defines a dead-band above the
high instrument limit. A high instrument
violation will be considered only when the
value is above the high instrument limit
plus the instrument dead-band. Adopt
larger value in either of Limit dead-band
E.U. or this value for high Instrument limit
dead-band value.

This is enabled only when Remote alarm


processing option is disabled.

For more information, refer to Note 2.


LIMITDBL Real Low Limit dead-band
15 0
Optional This value (expressed in engineering None
units) defines a dead-band below the low
instrument limit. A low instrument
violation will be considered only when the
value is below the low instrument limit
minus the instrument dead-band. Adopt
larger value in either of Limit dead-band
E.U. or this value for low Instrument limit
dead-band value.

62 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

This is enabled only when Remote alarm


processing option is disabled.

For more information, refer to Note 2.


VIOL_CD Integer Instrument violation action code. {0, 1, 2}
1 1
Optional This field determines the value to store None
into the realtime database when an
instrument limit violation occurs.

The table below lists allowed codes and


the action on the realtime database:

0 - The current value is unchanged.


1 - The new value is stored.
2 - The instrument limit is stored.

The new value is ignored when code 0 or


2 is selected.
VIOL_SCAN Character Off scan flag for instrument limit violation. {Y, N} N None
1
Optional OFF_SCAN is the alias name for this
field

If set, the tag will be put off scan upon the


second consecutive instrument limit
violation.

Note 1:
In the range boxes, values of “lowlim” and “higlim” are defined by the general formulas:
lowlim = VAL0
higlim = VAL0 + SPAN
Values of VAL0 and SPAN are defined in the alarm level definition sub-section.
When defining the alarm dead-band, be sure the value does not exceed the absolute difference between two consecutive
alarm levels.
Note 2:
Typical examples for Alarm dead-band and Limit dead-band are as follows:
• The defined Alarm dead-band value is used as a common setting for High/Low alarm limit.
• The defined High/Low Alarm dead-band value is used as individual setting for an alarm limit.

Example 1: Alarm dead-band with following configurations


HALARM = 90, LALARM = 10, ALARMDB = 2, ALARMDBH = 0, ALARMDBL = 0
Process value and Alarm state change as follows.
Process Value Alarm state
High
=90 High alarm reported
=91 High alarm persist
=90 High alarm persist
=89 High alarm persist
< 88 Return To Normal reported.
Low
=10 Low alarm reported
=9 Low alarm persist
=10 Low alarm persist

2VAA000830-330 A 63
S+ Operations DB Reference DATABASE STRUCTURE

=11 Low alarm persist


>12 Return To Normal reported.

Example 2: Alarm dead-band with following configurations


HALARM = 90, LALARM = 10, ALARMDB = 0, ALARMDBH = 3, ALARMDBL = 1
Process value and Alarm state change as follows.
Process Value Alarm state
High
=90 High alarm reported
=91 High alarm persist
=90 High alarm persist
=89 High alarm persist
=88 High alarm persist
< 87 Return To Normal reported.
Low
=10 Low alarm reported
=9 Low alarm persist
=10 Low alarm persist
>11 Return To Normal reported.

In case of both Alarm dead-band and Limit dead-band values are set, precedence is given to larger value.

2.8.8 Analog Tag – Alarm Comment Parameters


The fields allows linking or referencing descriptive texts to be associated to alarm conditions of the tag.
Either an integer format (index) or a character format (text) are used. The index is used to address an alarm comment
defined within the alarm comment database. This approach requires the separate configuration of an alarm comment
database in order to define all referenced alarm comments. If the index is defined, the text type field (if any) is ignored.
If the text type field is used, it is added to the alarm comment database at the first vacant index. This approach does not
require the separate configuration of an alarm comment database. If the text is defined, the index type field must not be
included in the tag database.
The following table lists the Analog Tag- Alarm Comment Parameters:
Table 2-45: Analog Tag – Alarm Comment Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
ALRMCMNT3 Integer Low alarm comment index. {1...100}
5 0 [mxalcm]
Optional LALMCMNT and L_MESS are the alias
name for this field

ALRMCTXT3 Character Low alarm comment text. <string>


80 <blank> [szalcm]
Optional LALMCMNT and L_MESS are the alias
name for this field

ALRMCMNT4 Integer 2-high alarm comment index. {1...100}


5 0 [mxalcm]
Optional HALMCMNT and H_MESS are the alias
name for this field

ALRMCTXT4 Character 2-high alarm comment text. <string>


80 <blank> [szalcm]

64 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

Optional HALMCMNT and H_MESS are the alias


name for this field

ALRMCMNT5 Integer 2-low alarm comment index. {1...100}


5 0 [mxalcm]
Optional LALMCMNT and L_MESS are the alias
name for this field

ALRMCTXT5 Character 2-low alarm comment text. <string>


80 <blank> [szalcm]
Optional LALMCMNT and L_MESS are the alias
name for this field

ALRMCMNT6 Integer 3-high alarm comment index. {1...100}


5 0 [mxalcm]
Optional HALMCMNT and H_MESS are the alias
name for this field

ALRMCTXT6 Character 3-high alarm comment text. <string>


80 <blank> [szalcm]
Optional HALMCMNT and H_MESS are the alias
name for this field

ALRMCMNT7 Integer 3-low alarm comment index. {1...100}


5 0 [mxalcm]
Optional LALMCMNT and L_MESS are the alias
name for this field

ALRMCTXT7 Character 3-low alarm comment text. <string>


80 <blank> [szalcm]
Optional LALMCMNT and L_MESS are the alias
name for this field

ALRMCMNT8 Integer High deviation alarm comment index. {1...100}


5 0 [mxalcm]
Optional
ALRMCTXT8 Character High deviation alarm comment text. <string>
80 <blank> [szalcm]
Optional
ALRMCMNT9 Integer Low deviation alarm comment index. {1...100}
5 0 [mxalcm]
Optional
ALRMCTXT9 Character Low deviation alarm comment text. <string>
80 <blank> [szalcm]
Optional
ALRMCMNT10 Integer Increasing rate of change comment {1...100}
5 index. 0 [mxalcm]
Optional
ALRMCTXT10 Character Increasing rate of change comment text. <string>
80 <blank> [szalcm]
Optional
ALRMCMNT11 Integer Decreasing rate of change comment {1...100}
5 index. 0 [mxalcm]
Optional
ALRMCTXT11 Character Decreasing rate of change comment text. <string>
80 <blank> [szalcm]
Optional

Refer to the Alarm Comment Definition Parameters section for more details about the contents of these fields. Refer to the
analog sub-sections of the generic tag definition for other alarm comment fields.
The on-line configuration allows selection of alarm comment either by index (typing the number) or text (selecting from a
list).

2.8.9 Analog Tag - Totalization Parameters


The fields define analog totalizations associated to the analog tag. They are valid, if the TOT_LOG field is defined as non-
zero value (i.e. a totalization has been associated to the tag).

2VAA000830-330 A 65
S+ Operations DB Reference DATABASE STRUCTURE

The following table lists the Analog Tag – Totalization Parameters:


Table 2-46: Analog Tag – Totalization Parameters
Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
ENELOST Integer Lost samples management code. {0, 1}
1 0
Optional When it is 1, the lost samples None
management is active.
ENEBAD Integer Bad samples management code. {0, 1}
1 0
Optional When it is 1, the bad samples None
management is active.
ENEEUINDEX Integer Engineering unit index. {-1, 0 ...127}
3 -1 [mxeutx]
Optional This is a reference to the coding of
engineering units.
ENELOSC1M Real Low scale value for 1 minute analog
15 totalization. 0
Optional None
ENELOSC10M Real Low scale value for 10 minute analog
15 totalization.
Optional 0
None
ENELOSC30M Real Low scale value for 30 minute analog
15 totalization.
Optional 0
None
ENELOSC1H Real Low scale value for 1 hour analog
15 totalization.
Optional 0
None
ENELOSC8H Real Low scale value for 8 hours analog
15 totalization.
Optional 0
None
ENELOSCDAY Real Low scale value for 1 day analog
15 totalization.
Optional 0
None
ENELOSCMON Real Low scale value for 1 month analog
15 totalization.
Optional 0
None
ENELOSCYEA Real Low scale value for 1 year analog
15 totalization.
Optional 0
None
ENEHISC1M Real High scale value for 1 minute analog
15 totalization.
Optional 0
None
ENEHISC10M Real High scale value for 10 minute analog
15 totalization.
Optional 0
None
ENEHISC30M Real High scale value for 30 minute analog
15 totalization.
Optional 0
None
ENEHISC1H Real High scale value for 1 hour analog
15 totalization.
Optional 0
None
ENEHISC8H Real High scale value for 8 hours analog
15 totalization.
Optional 0
None
66 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

ENEHISCDAY Real High scale value for 1 day analog


15 totalization.
Optional 0
None
ENEHISCMON Real High scale value for 1 month analog
15 totalization.
Optional 0
None
ENEHISCYEA Real High scale value for 1 year analog
15 totalization.
Optional 0
None
ENERESC1M Real Rescale factor for 1 minute analog
15 totalization.
Optional 0
None
ENERESC10M Real Rescale factor for 10 minute analog
15 totalization.
Optional 0
None
ENERESC30M Real Rescale factor for 30 minute analog
15 totalization.
Optional 0
None
ENERESC1H Real Rescale factor for 1 hour analog
15 totalization.
Optional 0
None
ENERESC8H Real Rescale factor for 8 hours analog
15 totalization.
Optional 0
None
ENERESCDAY Real Rescale factor for 1 day analog
15 totalization.
Optional 0
None
ENERESCMON Real Rescale factor for 1 month analog
15 totalization.
Optional 0
None
ENERESCYEA Real Rescale factor for 1 year analog
15 totalization.
Optional 0
None

2.8.10 Analog Tag – Documentation Parameters


The fields listed in following table allows linking tag conditions and documentation.
Note: Symphony Plus does not manage these fields, but these fields are loaded in the tag database based on requirement.
Refer to the analog sub-section of the generic tag definition for additional fields.
The following table lists the Analog Tag – Documentation Parameters:
Table 2-47: Analog Tag – Documentation Parameters

Range Default
Name Format Width Opt/Mnd Description
Parameter(s)
ALMDLA Integer Reference to low alarm 0
5 documentation None
Optional
ALMDHH Integer Reference to 2 high alarm 0
5 documentation None
Optional
ALMDLL Integer Reference 2 low alarm
5 documentation 0
Optional None
ALMDSH Integer Reference to 3 high alarm
5 documentation

2VAA000830-330 A 67
S+ Operations DB Reference DATABASE STRUCTURE

Optional 0
None
ALMDSL Integer Reference 3 low alarm
5 documentation
Optional 0
None
ALMDHD Integer Reference to high deviation alarm
5 documentation
Optional 0
None
ALMDLD Integer Reference to low deviation alarm
5 documentation
Optional 0
None
ALMDHR Integer Reference to increasing rate of
5 change documentation
Optional 0
None
ALMDLR Integer Reference to decreasing rate of
5 change documentation
Optional 0
None

2.8.11 Analog Tag - Hardware Description Parameters


Hardware Description Parameters:
The descriptive fields listed in following table define some additional information about the source of analog tags. Refer to
the analog section of the generic tag for other hardware description fields.
The on-line configuration does not provide a Tab page for hardware description parameters.
The following table lists the Analog Tag – Hardware Description Parameters:
Table 2-48: Analog Tag – Hardware Description Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
INSTR_TYPE Character Instrument type. <string>
8 <blank> None
Optional This field describes the electrical range of
the signal and the relevant E.U.
conversion type.
JBOX Character Thermocouple junction box <string>
6 <blank> None
Optional
RTD_COMP Character Identifier of the compensation thermo- <string>
14 resistance for thermocouple. <blank> None
Optional

2.9 Alarm Categories


The following table provides the list of parameters that are included in Alarm Process.
Table 2-49: Alarm Process

Format Width Range Default


Name Description
Opt/Mnd Parameter(s)
DS_ALARM Character Display alarms. {Y, N} Y None
1
Optional If set, alarms concerning this tag will be displayed on
alarm display pages (LADs).
PR_ALARM Character Print alarms. {Y, N} N None
1
Optional If set, alarms concerning this tag will be printed on
alarm printer(s).

Refer to the ALMPRINTER field for more details.


SV_ALARM Character Archive alarms {Y, N} Y None
1
68 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

Optional If set, alarms concerning this tag will be logged to the


Operator Journal or historian database.

AUD_ALARM Character Activate audible alarm. {Y, N} Y None


1
Optional If set, the audible tone defined by AUDINDEX will be
activated when an alarm will occur.
BOT_ALARM Character Bottom alarm displaying flag. Display alarm at bottom {Y, N} Y None
1 of screen
Optional
If set, unacknowledged alarms concerning this tag will
be displayed in the bottom of screen alarm window.
REM_ONACK Character Remove alarm flag on acknowledgment. {Y, N} N None
1
Optional If set, alarm messages are removed from the alarm
display page (LAD) when an alarm acknowledgment
involving the tag is performed.
INFO_ONACK Character Log information flag on acknowledgment. {Y, N} N None
1
Optional If set, an information message is logged to the
Operator Journal or Historian when alarm
acknowledgment involving the tag is performed.
NO_UNACK Character Do not set as unacknowledged. {Y, N} N None
1
Optional
ALARMMIMIC Character Display mimic when alarm. {Y, N} N None
1
Optional
DS_RTN Character Display flag for return to normal condition. {Y, N} Y None
1
Optional If set, a RTN message concerning this tag will be
displayed on alarm display pages (LADs). An alarm
acknowledge will then remove the message.
PR_RTN Character Print flag for return to normal condition. {Y, N} N None
1
Optional If set, RTNs concerning this tag will be printed.

Refer to the ALMPRINTER field for more details.


SV_RTN Character Save message flag on return to normal. Archive return {Y, N} Y None
1 to normal condition.
Optional
If set, return to normal condition; messages
concerning this tag will be logged to the Operator
Journal or Historian.
AUD_RTN Character Activate flag for audible tone on return to normal. {Y, N} N None
1
Optional If set, the audible tone defined by AUDINDEX will be
activated when the tag will return to a normal
condition. An audible acknowledge or an alarm
acknowledge will then clear the audible tone.
PR_STCHNG Character Print flag for state changes. Print events {Y, N} N None
1
Optional If set, the changes of state concerning this tag will be
printed on alarm printer(s). State changes are
intended as alarms/RTNs of digital tags defined as
events (field EVENTTAG set to Y).

Refer to the ALMPRINTER field for more details.


Note:
• In case of tag reports CF state, the System
setting "GenerateEventOnChannelFailure" under
APPS\Alarms enables the status change in event
reporting.
• In case of tag reporting good quality from BQ
state, the System setting
"GenerateDiEventOnBQ2Good" under
APPS\Alarms enables the status change in event
reporting.

2VAA000830-330 A 69
S+ Operations DB Reference DATABASE STRUCTURE

SV_STCHNG Character Save flag for state changes. Archive events {Y, N} Y None
1
Optional If set, the changes of state concerning this tag will be
recorded into the Operator Journal.

Refer to the note under Description of PR_STCHNG


DS_STCHNG Character Save flag for display events. {Y, N} N None
1
Optional If set, the changes of state concerning this tag will be
displayed on the alarm pages.

Refer to the note under Description of PR_STCHNG


PR_OPACT Character Print flag for operator action messages. Print operator {Y, N} N None
1 actions
Optional
If set, on-line database modifications and all other
operator actions concerning this tag will be printed on
alarm printer(s).

Refer to the ALMPRINTER field for more details.


SV_OPACT Character Save flag for operator action messages. Archive {Y, N} Y None
1 operator actions.
Optional
If set, on-line database modifications and all other
operator actions concerning this tag will be recorded
into the Operator Journal.
PR_INFO Character Print flag for information messages. Print Information {Y, N} N None
1
Optional If set, information concerning this tag will be printed.

Refer to the ALMPRINTER field for more details.


SV_INFO Character Save flag for information messages. Archive {Y, N} Y None
1 information’s
Optional
If set, information concerning this tag will be logged to
the Operator Journal.
EXP_ALA Character Relational database update (alarms) flag. Export {Y, N} N None
1 alarm (via ODBC)
Optional
If set, alarm messages will automatically be sent to
the external relational database.
APPL_ALA Character Trigger flag for application program. {Y, N} N None
1
Optional On alarm occurrence, an application program is
triggered for execution. The on-line configuration does
not include the field.
LATCHALARM Character Latch/Unlatch alarm in an alarm list. {Y, N} N None
1
Optional Based on latching/unlatching of the alarms in the
alarm list acknowledged alarms appears or disappear
from the alarm list.
ALMACKBC Character Broadcast flag for alarm acknowledge via infinet {Y, N} N None
1
Optional If set, alarm acknowledgments are broadcasted to
other nodes in the same multi-master architecture.
AL_CAT Character Categorize alarms by priority {Y, N} N None
1
Optional
OPC_ALA Character Export alarm to OPC Server {Y, N} N None
1

FAST_BLINK Character Alarm blink at fast frequency {Y, N} N None


1

AL_ANNUNC Character Alarm presented in Annunciator Window {Y, N} N None


1

AUTOACK Character Auto acknowledge alarms after a timeout {Y, N} N None


1
70 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

AUTOREMOVE Character Auto remove inactive alarms after a timeout {Y, N} N None
1

NOREMACK Character Do not remove RTN with ACK, use remove {Y, N} N None
1

AUDINDEX Integer Audible alarm index. {0, 1...32}0


3 [mxaud]
Optional This field defines the index into audible alarm
database to determine which audible is to be activated
upon alarm and/or return to normal.

2.10 Alarm Printers


The following table provides the list of parameters that are included in Alarm Printers.
Table 2-50: Alarm Printers

Range Default
Name Format Width Opt/Mnd Description
Parameter(s)
COLORPRT Character Color Printer. string>
1 <blank> None
Optional
C_WHITE Character Sequence to set with string>
20 white color. <blank> None
Optional
C_RED Character Sequence to set with red string>
20 color. <blank> None
Optional
C_GREEN Character Sequence to set with string>
20 green color. <blank> None
Optional
C_YELLOW Character Sequence to set with string>
20 yellow color. <blank> None
Optional
C_BLUE Character Sequence to set with string>
20 blue color. <blank> None
Optional
C_MAGENTA Character Sequence to set with string>
20 magenta color. <blank> None
Optional
C_CYAN Character Sequence to set with string>
20 cyan color. <blank> None
Optional
C_NAVY Character Sequence to set with string>
20 navy color. <blank> None
Optional
C_BLACK Character Sequence to set with string>
20 black color. <blank> None
Optional
REROUTING Character Rerouting printer. string>
10 <blank> None
Optional
SINGLELINE Character Single line printer. string>
1 <blank> None
Optional
LINESPAGE Character Lines per page. string>
10 <blank> None
Optional
POINTSIZE Character Point size. string>
10 <blank> None
Optional
HEADER Character Printout header string>
256 <blank> None
Optional

2VAA000830-330 A 71
S+ Operations DB Reference DATABASE STRUCTURE

2.11 Alarm Comments

2.11.1 Outline
Alarm comments are descriptive texts associated with all possible alarm conditions of analog and digital tags.
These texts are collected into a specified file on a Personal Computer using standard packages like DBase III/IV or EXCEL
or the SLDG package (provided by the Bailey Engineering Work Stations). Then, the file must be copied to the computer
running the Symphony Plus application (if it is a different one) for final download. Tags will refer to alarm comments by index.
Alternatively, texts can be included in the tag database file. The alarm comment database will be filled when the tag database
is processed.
A non-existing text will be added in the first available location of the alarm comment database and an index will be assigned
to it. After a new text has been added, all tags using the same text will point to the same location of alarm comment database.
In this case, the ALRMCTXTn field will be filled, and the ALRMCMNTn will be omitted in the tag database.
This section describes the structure of the Alarm Comment Database (the first option is chosen).

2.11.2 Alarm Comment - Definition Parameters.


The following table provides the list of Alarm Comment – Definition Parameters:
Table 2-51: Alarm Comment – Definition Parameters
Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
INDEX Integer Alarm comment index. {1...100}
5 0 [mxalcm]
Mandatory ALARMINDEX is the alias name for this
field
TEXT Character Alarm comment text. <string>
80 <blank> [szalcm]
Mandatory ALARMTEXT and ALARM_CMNT are
alias name for this field

2.12 Atom Configuration


The following table provides the list of parameters that are included in Atom Configuration.
Note: Atom configuration database supports multi-client instance driver for ModBus TCP and IEC-104 protocol. It also
supports OPC connectivity.
Table 2-52: Atom Configuration

Range Default
Name Format Width Opt/Mnd Description
Parameter(s)
REF_TAG Character Reference Tag for string>
50 faceplate. <blank> None
Optional
ATOM1NAM Character Name for Atom #1. string>
20 <blank> None
Optional
CUSTTAGID Character Plant tag name. string>
32 <blank> None
Optional This field provides an
additional name or
description (i.e. KKS code)
to the tag. Since it is only
used for print/display
purposes, this field may be
duplicated.
IS_USED Character Atom is used. {Y, N} N None
1
Optional
CTRL_ATOM Character Atom is controlled. {Y, N} N None
1
Optional
FIELD_DRV Character Field input driver name. <string>
50 <blank> [sznam]
Mandatory
72 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

This name identifies the


kind of driver interfacing
S+ to the process for input
data communication.
FIELD_ADN Integer Field input address. 0
6 None
Mandatory
FIELD_TXN Character Field input driver text <string>
80 Optional. <blank> [mxopcn]
AL_MSG Character Alarm message. string>
80 <blank> None
Optional
HI_ACTIVE Character High instrument limit {Y, N} N None
1 activation flag.
Optional
H3_ACTIVE Character 3-High alarm limit
1 activation flag. {Y, N} N None
Optional
H3ALARM,
HVARALMTAG, and
DELTA_SH are the alias
name for this field

H2_ACTIVE Character 2-High alarm limit {Y, N} N None


1 activation flag.
Optional
H2ALARM,
HVARALMTAG, and
DELTA_HH are the alias
name for this field

H_ACTIVE Character High alarm limit activation {Y, N} N None


1 flag.
Optional
HALARM, HVARALMTAG,
and HIGH_LIMIT are the
alias name for this field

L_ACTIVE Character Low alarm limit activation {Y, N} N None


1 flag.
Optional
LALARM, LVARALMTAG,
and LOW_LIMIT are the
alias name for this field

L2_ACTIVE Character 2-Low alarm limit {Y, N} N None


1 activation flag.
Optional
L2ALARM,
LVARALMTAG, and
DELTA_LL are the alias
name for this field

L3_ACTIVE Character 3-Low alarm limit {Y, N} N None


1 activation flag.
Optional
L3ALARM,
LVARALMTAG, and
DELTA_SL are the alias
name for this field

LI _ACTIVE Character Low instrument limit active {Y, N} N None


1
Optional LINS_LIMIT is the alias
name for this field
HINS_LIMIT Integer High instrument limit 0
15
2VAA000830-330 A 73
S+ Operations DB Reference DATABASE STRUCTURE

Optional This value (expressed in None


engineering units) defines
the 100% scale of the tag.
This parameter may be
used instead of SPAN.
H3ALARM Integer 3-high alarm limit {lowlim...higlim}
15 0
Optional This value (expressed in None
engineering units) defines
the third high alarm level.

HIGH_LIMIT, DELTA_HH,
and DELTA_SH are the
alias name for this field

H2ALARM Integer 2-high alarm limit {lowlim...higlim}


15 0
Optional This value (expressed in None
engineering units) defines
the second high alarm
level.

HIGH_LIMIT and
DELTA_HH are the alias
name for this field

HALARM Integer High alarm limit {lowlim...higlim}


15 0
Optional HIGH_LIMIT is the alias None
name for this field

This value (expressed in


engineering units) defines
the first high alarm level.
LALARM Integer Low alarm limit {lowlim...higlim}
15 0
Optional This value (expressed in None
engineering units) defines
the first low alarm level.

LOW_LIMIT and
DELTA_LL is the alias
name for this field.

L2ALARM Integer 2-low alarm limit {lowlim...higlim}


15 0
Optional This value (expressed in None
engineering units) defines
the second low alarm
level.
L3ALARM Integer 3-low alarm limit {lowlim...higlim}
15 0
Optional This value (expressed in None
engineering units) defines
the third low alarm level.

LOW_LIMIT, DELTA_LL,
and DELTA_SL are the
alias name for this field.

VAL0 Integer Low instrument limit {lowlim...higlim}


15 0
Optional This value (expressed in None
engineering units)
represents the 0% scale of
the tag.

74 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

LINS_LIMIT is the alias


name for this field.

HI_AL_HIST Integer High instrument hyst. 0


15 None
Optional
H3_AL_HIST Integer High 3 hyst. 0
15 None
Optional
H2_AL_HIST Integer High 3 hyst. 0
15 None
Optional
H1_AL_HIST Integer High 1 hyst 0
15 None
Optional
L1_AL_HIST Integer Low 1 hyst 0
15 None
Optional
L2_AL_HIST Integer Low 2 hyst 0
15 None
Optional
L3_AL_HIST Integer Low 3 hyst 0
15 None
Optional
LI_AL_HIST Integer Low instrument hyst 0
15 None
Optional
ISALARMN Character Alarm bit mask. {Y, N} N None
1
Optional
FDBK_ITEM Character Command feedback item. string>
255 <blank> None
Optional
CMD_TIMO Integer Command timeout. 0
5 None
Optional
CMD_TYPE Integer Command type. 0
5 None
Optional
CMDFBCK Character Feedback after command. {Y, N} N None
1
Optional
PLAYBACK Character Playback archive flag. {Y, N} Y None
1
Optional If set, the tag will be
recorded on the playback
archive.
HIS_STKEEP Character History short term archive. {Y, N} Y None
1
Optional
HIS_LTKEEP Character History long term archive {Y,N} N None
1
Optional Playback flag for long term
archiving.

If set, reduced size data


packets will be recorded
on the playback to save
disk space.

The on-line configuration


does not include the field.

Note: If set to Y the export,


then every exception of
2VAA000830-330 A 75
S+ Operations DB Reference DATABASE STRUCTURE

this tag is stored in the


historian database

Alias: PLAYBACKLT
(FBN : original name of the
manual “playbacklt”)
PLBCOMPRDB Integer Refer to PLAYBACKDB {0...100}
15 field and Note 3 at the end 0
Optional of the table for details. None
HISLIFETIM Integer Historic Archive Life Time. None
5
Optional
OPCREADTYP
Integer OPC read type.
6 Refer Table 2-15 for
120
Optional allowed read types.
None
AL_REM Character Remote alarm processing {Y, N} Y None
1 flag.
Optional
If set, the alarm processing
for this tag will be
performed remotely (PCU
level or PLC level),
otherwise it will be
performed locally
(computer level). This field
is meaningful for tags
coming from smart devices
able to check for an alarm
condition. For all other
tags, alarm processing is
always performed locally.
AL_PRI Character Alarm priority number. {0, 1...15}
2 1
Optional ALRM_PRTY1 is the alias [mxalpr] and
name for this field [mxxapr]

This is the default priority


number and is used when
a specific alarm priority is
not defined for a single
alarm condition. Specific
priority numbers can be
assigned to each alarm
condition. See the
following fields and the
fields of the analog sub-
sections of analog and
digital tag definitions for a
description. This default
priority field and the
specific priority fields
determine the colors used
to display alarms of the
tag. Alarm priorities can be
customer defined.
EVENTTAG Character State information flag. {Y, N} N None
1
Optional If set, all possible states of
the tag will be considered
normal and the only type
of alarm output enabled is
Operator Journal recording
(while alarm display
pages, reports and post
trip logs are not affected).

76 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

ALLNORM is the alias


name for this field.

EVENTON Character Event item on active {Y, N} N None


1 transition.
Optional
EVENTOFF Character Event item on active {Y, N} N None
1 transition.
Optional
SCA_VAL_0 Real 0% presentation limit. {lowlim...higlim}
15 0
Optional Value (expressed in None
engineering units)
representing the 0% scale
to be used for bar chart
and trend representation
of the tag. If omitted or
zero (blank), the 0% scale
will be assumed to be the
low instrument limit. Refer
to Note 1 at the end of the
table for more details.
SCA_VAL_100 Integer 100% presentation limit. {lowlim...higlim}
15 0
Optional None
SP_VAL0 Integer Set point low limit. {lowlim...higlim}
15 0
Optional None
SP_VAL100 Integer Set point high limit. {lowlim...higlim}
15 0
Optional None
NUMDECPL Integer Number of decimal places. {0...9}
1 2
Optional The information is used None
when displaying the tag
value.
EUDESC Character Engineering unit text. <string>
16 <blank> None
Optional EU_NAME is the alias
name for the field.

This text defines the


engineering unit to be
associated with the tags in
the group. It can be used
to assign a unique
engineering unit to the
group. It supersedes the
engineering units of the
tags belonging to the
group.
ZEROSTATE Character Descriptor for state 0. <string> [sztags]
256
Mandatory This field defines the text
to be displayed or printed
to represent the state 0.
ONESTATE Character Descriptor for state 1. <string>
256 <blank> [sztags]
Optional This field defines the text
to represent the normal
state.
TWOSTATE Character Descriptor for state 2. <string>
256 <blank> [sztags]
Optional
THREESTATE Character Descriptor for state 3. <string>
256 <blank> [sztags]
Optional
FOURSTATE Character Descriptor for state 4. <string>
2VAA000830-330 A 77
S+ Operations DB Reference DATABASE STRUCTURE

256 <blank> [sztags]


Optional
FIVESTATE Character Descriptor for state 5. <string>
256 <blank> [sztags]
Optional
SIXSTATE Character Descriptor for state 6. <string>
256 <blank> [sztags]
Optional
SEVENSTATE Character Descriptor for state 7. <string>
256 <blank> [sztags]
Optional
EIGHTSTATE Character Descriptor for state 8. <string>
256 <blank> [sztags]
Optional
NINESTATE Character Descriptor for state 9 <string>
256 <blank> [sztags]
Optional
TENSTATE Character Descriptor for state 10. <string>
256 <blank> [sztags]
Optional
ELEVNSTATE Character Descriptor for state 11. <string>
256 <blank> [sztags]
Optional
TWELVSTATE Character Descriptor for state 12. <string>
256 <blank> [sztags]
Optional
THTEESTATE Character Descriptor for state 13. <string>
256 <blank> [sztags]
Optional
FRTEESTATE Character Descriptor for state 14. <string>
256 <blank> [sztags]
Optional
FVTEESTATE Character Descriptor for state 15. <string>
256 <blank> [sztags]
Optional
CONVCODE Character Conversion code to be <string>
20 performed on the input raw <blank> [sznam]
Optional data.
CONVMIN Integer Minimum value (in 0
15 engineering unit) of the None
Optional input raw data.
CONVMAX Integer Maximum value (in 0
15 engineering unit) of the None
Optional input raw data.
CONVOFFS Integer Offset value to add on 0
15 converting input raw data. None
Optional
CONVPARN Integer Conversion parameter. 0
15 None
Optional

Note: “N” can be 1 to 12 for the tag name FIELD_AD, “N” can be 1 to 10 for the tag name FIELD_TX, “N” can be 1 to 31 for
the tag name ISALARM and “N” can be 1 to 10 for the tag name CONVPAR.

2.13 Engineering Units

2.13.1 Outline
An engineering unit (E.U) may be associated with an analog tag. The engineering unit is a descriptive text used to physically
qualify values, and give meaning to the scale of analog tags.
These texts are usually collected into a specified file on a Personal Computer using standard packages like DBase III/IV or
EXCEL or the SLDG package (provided by the Bailey Engineering Work Stations).
Then, the file must be copied to the computer running the application Symphony Plus (if it is a different one) for final
download.
Analog tags will refer to engineering units by their index. In this case, analog tags can directly point to this database by
means of the field EUINDEX, while the field EUDESC can be omitted.

78 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

Alternatively, texts can be included into the tag database file. The engineering unit database will be filled when the tag
database is processed.
A non-existing text will be added in the first available location of the engineering unit database, and an index will be assigned
to it.
After a new text has been added, all tags using the same text will point to the same location of engineering unit database.
In this case, the EUDTEXT field will be filled and the EUDINDEX will be omitted in the tag database.
This section describes the structure of Engineering Units Database (if first option is chosen).

2.13.2 Engineering Units Definition


To configure engineering units, select the entry in the engineering unit table and double-click. A data entry dialog allows
entering the text.

2.13.3 Engineering Unit - Definition Parameters


The following table provides the list of Engineering Unit – Definition Parameters:
Table 2-53: Engineering Unit – Definition Parameters

Range Default
Name Format Width Opt/Mnd Description
Parameter(s)
INDEX Integer Engineering unit index. {1...127}
3 0 [mxeutx]
Mandatory EUDINDEX is the alias name
for this field
TEXT Character Engineering unit text. <string>
16 <blank> [sztags]
Mandatory EUDTEXT is the alias name for
this field

2.14 Text Selector

2.14.1 Outline
Text selectors are descriptive texts that are associated to the values of a particular type (“TEXT”) of analog tags.
These texts are usually collected into a specified file on a Personal Computer using standard packages like Dbase III/IV or
EXCEL or the SLDG package (provided by the Bailey Engineering Work Stations). Then, the file must be copied to the
computer running the application Symphony Plus (if it is a different one) for final download.

2.14.2 Text Selector - Definition Parameters


The following table provides the list of Text Selector – Definition Parameters:
Table 2-54: Text Selector – Definition Parameters

Format Width Range Default


Name Description
Opt/Mnd Parameter(s)
INDEX Integer Text selector index. {0...9999}
5 TEXTSINDEX is the alias name 0 [mxtxts]
Mandatory for this field
TEXT Character Text selector string. <string>
80 TEXTSTEXT is the alias name <blank> [sztxts]
Mandatory for this field

2.15 Alarm Management Subsystem

2.15.1 Alarm Lists


The alarm lists are chronological lists extracted from LADs (Latest Alarms Displays) by sorting only those events matching
a list of conditions (such as alarm category, alarm priority, alarm type).
Conditions can be configured on a per-display basis. That is, it is possible to get from LADs only those events that, at a
certain time, cover a particular importance.

2VAA000830-330 A 79
S+ Operations DB Reference DATABASE STRUCTURE

2.15.2 Outline
The main goal of alarm subsystem is to process up to three types of events (information events, return-to-normal events
and alarm events) and to notify operators by a wide range of peripheral devices, such as LADs (Latest Alarm Displays),
printers, Operations Journal (OJ) and audible alarms.
All these events may be queued by a scan subsystem (in the simplest scheme) as well as by calculation package,
configuration subsystem or user programs.
The following section shows how to configure alarm groups requested by alarm subsystem to process these events. Refer
the Color/Blink Override Basic Definition for more details on configuration of color/blink override.

2.15.3 Alarm Group Database


The alarm group database is generated on a Personal Computer using standard packages like DBase III/IV or EXCEL.
Then, the file must be copied to the computer running the application Symphony Plus (if it is a different one) for final import.
The alarm group database is imported by submitting the database file to the database builder. During this phase, the field
contents of the input file will be used to compile Symphony Plus internal database structures following the directives given
by a field assignment cross-reference file, previously processed by builder program DBXRF.
The database builder may also perform export operations, creating a target database file (DBase III/IV format) containing all
items as they are currently defined in the Symphony Plus internal database. If a target database does not exist, the builder
processor creates it using the whole Symphony Plus database structure.
Alternatively, a target database file may be specified as template. In this case, the builder processor updates the target
database file handling only the fields specified in it. The target database file may have just a single alarm group, or may be
a full or partial database file. It must contain all (and only) fields to be exported.

2.15.4 Alarm Group Definition


The following sections list parameters to define and structure alarm groups.

2.15.5 Alarm Groups – General Parameters


The following table provides the list of Alarm Groups – General Parameters:
Table 2-55: Alarm Groups – General Parameters

Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
INDEX Integer Alarm group index. {0, 1...272}
3 0 [mxclbk]
Optional This field identifies the alarm group by number. It must
be unique for each alarm group in the database. If
omitted or zero (blank), the first vacant index will be
allocated.

ALMINDEX is the alias name for this field


NAME Integer Alarm group name. <string>
50 <blank>
Mandatory This must be a unique name within the alarm group [sznam]
database.

ALMNAME is the alias name for this field


DESC Character Alarm group description. <string>
64 <blank>
Optional The description is used to identify the alarm group in the [szdesc]
alarm group tree.

ALMDESC is the alias name for this field


Integer Last Update Set by the
LASTUPDT
20 Last date and time of the configuration changes done. system
ALMLEVEL Integer Alarm group level. {0,1...99}
3 0
Mandatory It identifies the level of the sub-page hierarchy in the None
alarm sub-page being defined.
ALMLIST Character Alarm list. <string>
254 <blank> None
Mandatory

80 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

The alarm list includes the alarm attribute to check when


displaying an alarm sub-page and the list of alarm
groups (sub-groups) belonging to the group.

Legal alarm attributes are shown in Table 2-58.

Alarm attributes and group (sub-group) numbers are


separated by a comma. A semicolon ends the alarm list.

Alarm list supports multiple Alarm attributes. For more


information, refer to section 2.15.8.
Alarm summary type.
Integer
ALMSUMMTYP 3
This field specifies a processing option type for the
Optional 0 none
digital output.
Summary action tag name.
<string>
Character
This field specifies the name of a valid tag that is <blank>
ALMSUMMTAG 50
maintained and updated with the current summary [sznam]
Optional
status. Typically, this field is used to specify a digital
output tag that alarms external annunciators.
Alarm summary tag 2

Character This field specifies the name of a valid tag that is


<string>
ALMSUMMTA2 50 maintained and updated with the current summary
<blank> None
Optional status. Typically, this field is used to specify a digital
output tag that alarms external annunciators in latched
mode (until the alarm state switches to RTN).
FILENAME Character Specifications of an ASCII file containing the alarm list. <string>
254 <blank> None
Optional

2.15.6 Alarm Groups – Presentation Parameters


The fields listed in following table provides information on presentation parameters of an alarm group.
Table 2-56: Alarm Groups – Presentation Parameters

Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
Character Column definition name.
50 If user describes names separated by a
<string>
Optional semicolon, ZoomIn/Out feature will be
LISTALM <blank>
valid.
None
If this parameter is blank, alarm group
refers to the workplace parameter.
Integer
Alarm Mimic priority (Lower number has 0
ALDISPPRIO 6
higher priority) None
Optional
Primary display reference for monitor 1.
Primary display (view 1)

Name of a graphic display associated to


Character the tag. This page can be directly called <string>
PRIMDISP1 256 from tag presentation displays or from <blank>
Optional alarm pages and it is also used for Alarm None
Mimic.
Can contain name of workplace layout,
mimic, trend, diagnostic, alarm. In case of
workplace layout, use prefix “$WPL.”
Primary display reference for monitor 2.
Character Primary display (view 2) <string>
PRIMDISP2 256 <blank>
Optional Name of a graphic display associated to None
the tag. It is only used for Alarm Mimic.

2VAA000830-330 A 81
S+ Operations DB Reference DATABASE STRUCTURE

Primary display reference for monitor 3.


Primary display (view 3)
Character <string>
Name of a graphic display associated to
PRIMDISP3 256 <blank>
the tag. It is only used for Alarm Mimic.
Optional None
Can contain name of workplace layout,
mimic, trend, diagnostic, alarm. In case of
workplace layout, use prefix “$WPL.”
Primary display reference for monitor 4.
Primary display (view 4)
Character <string>
Name of a graphic display associated to
PRIMDISP4 256 <blank>
the tag. It is only used for Alarm Mimic.
Optional None
Can contain name of workplace layout,
mimic, trend, diagnostic, alarm. In case of
workplace layout, use prefix “$WPL.”
Integer
0
PLANTAREA 2 Plant Area
None
Optional

2.15.7 Alarm Groups – Security Parameters


The fields listed in following table provides information of security parameters in an alarm group.
Security parameters control the access to alarm pages for authorized users.
The following table lists the Alarm groups – Security Parameters:
Table 2-57: Alarm Groups – Security Parameters

Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
SEC_LEVEL Integer Security level. {0, 1...16}
2 0
Optional This field is checked whenever a user attempts to None
access the alarm group. Only users whose security
level is greater or equal to what's hereby defined are
enabled to access the alarm group.
SEC_GROUP Integer Security group. {0, 1...32}
2 0
Optional This field is checked whenever a user attempts to None
access the alarm group. Only users whose security
group mask includes what's hereby defined are
enabled to access the alarm group.

2.15.8 Alarm Attributes


The following table lists the Alarm Attributes:
Table 2-58: Alarm Attributes

Attribute Description
UNACKD Unacknowledged alarms.
ALMGRP Alarm group.
ALMPRI Alarm priority.

Note:
• There are two methods for specifying alarm lists. Either an external file or an internal alarm list can be used.
• ALMGRP and ALMARI can be used together. In such case, ALMGRP must be followed by ALMPRI.
For example: ALMGRP,4,5,6;ALMPRI,1,2,3;

2.15.9 Alarm list


The alarm list is a sequence of group definitions (a comma is the separator between alarm sub-groups) prefixed by the alarm
attribute. The alarm list includes the alarm group database file.
An example of alarm list is the following: ALMGRP, 17,18,19,20,21,22,23,24,25;

82 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

This method can be used when the tag list does not exceed the maximum of 254 characters (upper limit for Dbase III/IV
fields).

2.15.10 Alarm list Group


The list of sub-groups is contained in an ASCII file. A field in the alarm group database file allows definition of the file name.
The alarm list file must be located in the same folder hosting the alarm group database file: typically this folder is
\CONFIG\Almgr.
Since the alarm group name is referenced in the alarm list file, a unique alarm list file for all alarm groups or an alarm list file
for each alarm group can be used. The syntax of the alarm list is the same defined above.
This method must be used when the total number of characters for the alarm list definition is greater than 254.
Below the definition of two alarm lists is shown.
$BEGIN_GROUP ALM 1
ALMGRP, 17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32;
$END_GROUP
$BEGIN_GROUP ALM 2
ALMGRP, 33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48;
$END_GROUP
Each alarm list is enclosed between the group identification keywords $BEGIN_GROUP and $END_GROUP. The alarm
group name qualifies the tag list.
When un-building an alarm grouping, the output can be directed to the database (DBF or XLS) file and to the alarm list file
(TXT) or just to the database (DBF or XLS) file depending on the current group configuration of Symphony Plus.
If an alarm group configuration refers to an alarm list file, the un-build process will update the database file and the alarm
list file.
If an alarm group configuration defines sub-groups in the alarm list (without any reference to an alarm list file), the un-build
process will update the database file only.
If an alarm group configuration defines the sub-groups in the alarm list, a limit of 254 characters in the output field of the
database file may cause truncation of the alarm list

2.16 Audible Alarms

2.16.1 Outline
The audible alarm defines the tones Symphony Plus uses to notify alarms to the operator. An audible can be played by the
computer or played by horns that are Symphony driven.
These audible tones are collected into a dedicated file on a Personal Computer using standard packages like DBase III/IV
or EXCEL. Then, the file must be copied to the computer running the Symphony Plus application (if it is a different one) for
final download. Tags will refer to audible tones by index.

2.16.2 Audible Alarms Definition


The on-line configuration does not provide data entry for audible tones.

2.16.3 Audible Alarm - Definition Parameters


The following table provides the list of Audible Alarm – Definition Parameters:
Table 2-59: Audible Alarm – Definition Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
AUDINDEX Integer Audible alarm index. {0...32}
3 This field defines the index into audible alarm 0 [mxaud]
Mandatory database to determine which audible is to be activated
upon alarm and/or return to normal.
NAME Integer Alarm group name. <string>
50 <blank> [sznam]
Mandatory This must be a unique name within the alarm group
database.
2VAA000830-330 A 83
S+ Operations DB Reference DATABASE STRUCTURE

ALMNAME is the alias name for this field


AUDCODE Integer Audible code. Valid codes are: {0...6}
1 0 = No sound 0
Mandatory 1 = LOOP BEEP None
2 = LOOP WAVE
3 = SINGLE WAVE
4 = EXTERNAL
5 = EXTERNAL BEEP
6 = EXTERNAL WAVE
AUDFILE Character Audible wave file name. <string>
64 <blank> [szdesc]
Optional It is meaningful when AUDCODE is 2 or 3. The wave
file must be located within the \Config\Sound folder.
SEC_GROUP Integer Security group 0
2 None
Optional
AUDRCM Character RCM tag name. <string>
20 <blank> [sznam]
Optional It is meaningful when AUDCODE is 4.

The RCM tag must be defined within the tag database


and must refer to a physical horn.

2.17 Calculation

2.17.1 Calculations Outline


The Symphony Plus calculation package gives the user the functions of a scientific calculator using data from the process
and the customer database. It allows complex calculations to be defined, documented and run by people who know the most
about the process.
Calculated tags (tag type CALCANG or CALCDIG) are driven by the calculation package by defining calculation blocks.
A calculation block is a set of statements that are executed at a given period (minimum is 1 second). These statements look
like mathematical expressions that consist of operands, arithmetic operators, functions, relational and logic operators, and
control structures (such as WHILE-DO and IF-THEN-ELSE).
The package also provides functions to interact with the steam table. Input operands may be either system tags or local
variables.
The example in the following section shows the typical structure of a calculation block.

2.17.2 Calculation Formula Syntax


A calculation block includes operands, arithmetic operators, functions, relational and logic operators and control structures.
The syntax for calculations is like common mathematical expressions.
A calculation can use a maximum number of tags or constants (system option MaxTagsPerCalculationBlock: it needs a
system restart to be changed).
Blank lines and comments can be used to make the expressions more readable. Parentheses may be used anywhere to
affect the order of calculation.

2.17.3 Character Set


The character set of calculation package consists of all printable characters. Blanks have no significance (unless used within
a valid tag name). They may be used to make the equation more readable.
Both upper case and lower case can be used.
TAB characters cannot precede and cannot be embedded within the statements of a calculation. They can only be used
beyond the end of a statement to space a comment.

2.17.4 Operands
Operands are numbers, tag names, internal variables, constant names, functions or macros.

2.17.5 Numbers
In the calculations, numeric values are processed as floating point numbers. Expressions are calculated in double precision,
but the inputs and the results are single precision.
84 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

2.17.6 Tag Names


Tag names are used in the calculation blocks to represent values from the realtime Database. Tag name may be up to 20
characters long and must be delimited by double quote characters.
In the calculation, structure tag names represent a special kind of variables. All the tags belonging to the calculation block
are fetched from the realtime database at the same time, thus granting consistency to the data of the block.

2.17.7 Internal Variables or Constants


The calculation packages allow the definition of internal variables that can represent constants (physical values used in
many different statements) or intermediate results propagated from one statement to another.
The name of internal variables may be a maximum of 20 characters long and must contain an alphabetic character in the
first position. To be distinguished by tag names, the names of the internal variables must not be delimited by double quotes.
The name of internal variables is case sensitive.
The number of internal variables is limited by the system parameter ‘MaxTagsPerCalculationBlock’.

2.17.8 Functions
Functions are predefined names. Typically, they accept a number of input parameters and produce a result. See the list of
intrinsic functions for capabilities and syntax.

2.17.9 Macros
Macros are predefined and reserved names. Typically, they accept a number of input parameters and produce a number
result. Refer to the Calculation Macros manual for details on the syntax.

2.17.10 Comments
Comments may be placed anywhere to make the calculation block definition more readable. The calculation processor
recognizes the following delimiters as comment:

2.17.11 C like comments


All characters delimited by “/*” (slash-asterisk) and “*/” (asterisk-slash) are treated as a comment. The comment delimiters
must be defined in the same statement.

2.17.12 FORTRAN like comments


The characters following “!” (Exclamation mark) until the end of the line are treated as comments. The exclamation mark
may be placed after an executable statement.

2.17.13 C++ like comments


The characters following “//” (double slash) until the end of the line are treated as comments.

2.17.14 Multiple Line Statements


Typically, statements fit a single line of the formula file.
Multiple conditions or complex expressions or functions and macros with many parameters may require fitting the statement
on more than one line in the formula file.
A couple of “%” characters allow concatenating lines. The two line statement below shows an example of concatenation.
IF (A >= 100 AND B < 1000 AND C <= 60 AND %% D >= 3000 AND E > 27)
{
.......
}
The statement continuation not necessarily must begin at column 1. It can be indented to improve readability.
Insert a blank character before the continuation line symbol.
The statement continuations are non-computed in the total number of lines in the calculation, they are considered as part of
the continued line (e.g. a statement spanned on three lines by two continuation symbols is considered as a single line in the
count of calculation lines). Take care of that when looking for errors in a calculation.

2VAA000830-330 A 85
S+ Operations DB Reference DATABASE STRUCTURE

2.17.15 Expressions
An expression is a set of single items that, when evaluated, gives a result. Operators act on variables (tag names, internal
variables and constants) in an expression.
In the syntax to exemplify expressions, the following symbols are used:
• <calc> - identifies an internal generic variable used as calculation result,
• <ana_n> - identifies an generic analog value,
• <dig_n> - identifies a generic digital value.
Constants, internal variables and tag names can represent analog and digital values. For example, 5.6 can be a constant
analog value; VAR can be a variable analog value if VAR is an internal variable and “PV-TAG” can be an analog value
representing the current value of the tag PV-TAG in the database.
Items related to expressions are listed in the following description.

2.17.16 Calculation example


As an example, let consider a user wants to do a very rough leak detection system on a section of an oil pipeline. This can
be accomplished by checking that the input flow is roughly equivalent to the output flow, setting an alarm digital tag if the
difference is greater than a fixed value stored in a lab data entry tag.
Consider the following tags have been defined:
P100 - Accumulator input from flow station at beginning of pipeline. P200 - Accumulator input from flow station at end of
pipeline.
PDIF - Lab data entry tag containing the maximum allowed difference. D001 -Calculated digital tag used for alarming
purposes.
All tags involved in calculations must be defined by the tag database configuration. Refer the Tag Database section for more
details.
The code of the calculation is shown below.
/************************************************/
/* Compute the difference between input and output flow. */
/* Store the difference into a local variable. */ Dif_Flow = "P100" - "P200"
/* Check for a difference greater than the maximum allowed value. */
/* Set the output tag. */
if (Dif_Flow > "PDIF" )
{
"D001" = 1
}
else
{
"D001" = 0
}

/************************************************/
The item Dif_Flow above is a local variable. Its value is meaningful within the calculation and cannot be exported outside
unless it is assigned to a calculated analog tag.

2.17.17 Calculation Database


The calculation database is generated on a Personal Computer using standard packages like DBase III/IV or EXCEL. Then,
it must be copied to the computer running the Symphony Plus application (if it is a different one) for final import.
Calculation database is imported submitting the database file to the database builder. During this phase, the field contents
of the input file will be used to compile Symphony Plus internal database structures following the directives given by a field
assignment cross-reference file, previously processed by builder program DBXRF.
The database builder can also perform export operations, creating a target database file (DBase III/IV format) containing all
items as they are currently defined in the Symphony Plus internal database.

86 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

If a target database does not exist, the builder processor creates it using the whole Symphony Plus database structure.
Alternatively, a target database file may be specified as template. In this case, the builder processor updates the target
database file handling only the fields specified in it. The target database file can have just a single calculation or may be a
full or partial database file. It must contain all (and only) fields to be exported.

2.17.18 Calculation – General Parameters


The fields listed in following table defines the name and other additional parameters used to identify the calculation and to
give an explicit reference to the process.
The last four fields of the table are not included within the Tab of general parameters.
The following table provides the list of Calculation – General Parameters:
Table 2-60: Calculation – General Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
INDEX Integer Calculation block index. {0, 1...300}
6 0 [mxclbk]
Optional This field identifies the calculation by number. It must
be unique for each calculation in the database. If
omitted or zero (blank), the first vacant index will be
allocated.

CALCINDEX is the alias name for this field


NAME Integer Calculation block name. <string>
20 <blank> [sznam]
Mandatory This field is a unique identifier of the calculation.

CALCNAME is the alias name for this field


DESC Character Calculation block description. <string>
64 <blank> [szdesc]
Optional CALCDESC is the alias name for this field
CALCINACT Character Deactivate flag. {Y, N} N None
1
Optional If set, the calculation block will be initially set to inactive.
NOSLAVE Character Deactivate on secondary master flag. {Y, N} N None
1
Optional If set, the calculation block will be only executed on the
primary master in a multi-master Symphony Plus
architecture.

2.17.19 Calculation – Log Parameters


The fields listed in following table allows logs for operator actions and generic information.
The on-line configuration does not provide a data entry Tab for such fields.
The following table provides the list of Calculation – Log Parameters:
Table 2-61: Calculation – Log Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
PR_OPACT Character Print flag for operator action messages. {Y, N} N None
1
Optional
If set, database modifications and all other operator
actions concerning this calculation will be printed on alarm
printer(s).

PR_INFO Character Print flag for information messages {Y, N} N None


1
Optional If set, information concerning this calculation will be
printed.
SV_OPACT Character Save flag for operator action messages. {Y, N} N None
1
Optional
2VAA000830-330 A 87
S+ Operations DB Reference DATABASE STRUCTURE

If set, information concerning this calculation will be


logged to the Operator Journal file.
SV_INFO Character Save flag for information messages {Y, N} N None
1
Optional If set, information concerning this calculation will be
logged to the Operator Journal file.

2.17.20 Calculation - Frequency Parameters


The fields listed in following table defines the basic information to perform the calculation.
The following table provides the list of Calculation – Frequency Parameters:
Table 2-62: Calculation – Frequency Parameters

Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
CALCFRQ Integer Calculation period. {1...9999}
5 0
Mandatory This field defines the timing of the calculation. None

Refer to the CALCUNITS field for more details.


CALCUNITS Integer Calculation period unit. {0...3}
1 0
Optional This field qualifies the CALCFREQ field assigning a time None
unit.
OFFSET Integer Calculation offset. {1...9999}
5 0
Mandatory This field defines a delay added to the execution time of None
the calculation.

Refer to the OFFSUNITS field for more details.

Calculation offset must always be less than calculation


period.

Refer to Note 1 at the end of the table for more details.


OFFSUNITS Integer Calculation offset unit. {0...3}
1 0
Optional This field qualifies the OFFSET field assigning a time unit. None
SAMPLFRQ Integer Sampling period. {1...9999}
5 0
Mandatory Sampling period is used and must be defined when the None
calculation needs samples to produce the result.

For Example: average, minimum, maximum are


calculation based on samples. Sampling period must
always be less than calculation period.
SAMPLUNITS Integer Sampling period unit. {0...3}
1 0
Optional None

Note 1:
The calculation offset is applied to the base time of the calculation block, that is the greatest integer multiple of the calculation
period less or equal than calculation period itself (second zero if period is seconds, minute zero if period is minutes, midnight
if period is hours). For instance, to have a calculation block running every 30 minutes at minute 5, the offset must be 5
minutes.

2.17.21 Calculation – Formula File Parameters


The field listed in the following table defines a reference to the file implementing the formula to execute the calculation.
The term formula generically refers to the algorithm physically implementing the calculation.
A calculation can be a single and simple mathematical formula or a sequence of complex statements including IF-
THEN_ELSE and WHILE-DO control constructs.
The following table provides the list of Calculation – Formula File Parameter:
Table 2-63: Calculation – Formula File Parameter
88 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
CALCFILE Character Source file specification for the calculation block. <string>
254 <blank> None
Mandatory The full path allows locating the source file
anywhere. Usually source calculation files are
allocated within the
\S+\Config\Calc folder.

2.17.22 Calculation – Network Parameters


The fields listed in following table refer to Symphony Plus network communication subsystem.
They are used when multiple Symphony Plus servers in a multi-master architecture exchange data (values, alarm
acknowledges, messages, configurations) among them.
All fields are optional and they must be defined when servers (nodes) are intended to cooperate in a multi-master
architecture.
The fields reference the node definition. Refer to the Node database section for more details.
The following table provides the list of Calculation – Network Parameters:
Table 2-64: Calculation – Network Parameters
Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
SRCNODMSn Character Source node mask (n) Sequence {Y, N}
16 16*N
Optional SRCNODMSK is the alias name for None
SRCNODMS1 field

n = 1 to 4

DESTVALMSn Character Destination node mask (values) (n) Sequence {Y, N}


16 16*N
Optional DESTVALMSK is the alias name for None
DESTVALMS1 field

n= 1 to 4

CNFNODMS1 Character Configuration node mask (1) Sequence {Y, N}


16 16*N
Optional First bit refers to node 1 in the node None
definition, second bit refers to node 2,
and so on.

CNFNODMSK is the alias name for


CNFNODMS1

CNFNODMS2 Character Configuration node mask (2) Sequence {Y, N}


16 16*N
Optional The mask applies to nodes from 17 to None
32.

CNFNODMS3 Character Configuration node mask (3) Sequence {Y, N}


16 16*N
Optional The mask applies to nodes from 33 to None
48.
CNFNODMS4 Character Configuration node mask (4) Sequence {Y, N}
16 16*N
Optional The mask applies to nodes from 49 to 64 None

2.17.23 Calculation – Macro Function Parameter


The following table provides the list of field that are applicable for macro function definitions:
Table 2-65: Calculation – Macro Function Parameter

2VAA000830-330 A 89
S+ Operations DB Reference DATABASE STRUCTURE

Format Width Range Default


Name Description
Opt/Mnd Parameter(s)
NUMPAR Integer Number of parameters of the macro function.
3
Optional This field is used in the macro function definition 0
only. None

2.18 Calculation Operators and Functions

2.18.1 Calculation - Operator Priorities


Operators are executed in order of priority, from highest priority to lowest. Within the same priority, operators are executed
from left-to-right or right-to-left, according to the following table, as given below:
Table 2-66: Calculation – Operator Priorities

Operator Priority Order


OR 1 Left to Right
AND 2 Left to Right
NOT 3 Left to Right
<, ==, >, <=, !=, >= 4 Left to Right
+, - 5 Left to Right
*, / 6 Left to Right
*, / 7 Right to Left
- (prefix) 8 Left to Right

2.18.2 Parentheses
Parentheses can be used anywhere to affect the order of calculations. Regardless of operator priority, operations within
parentheses are evaluated before operations outside those parentheses. Operations within parentheses are evaluated
according to Table 2-66.

2.18.3 Calculation - Arithmetic Operators


Except the prefix minus, arithmetic operators apply to a couple of operands and give a result according to the rules of
arithmetic. The prefix minus applies to a single operand.
The following table lists the arithmetic operands.
Note: Operands are numeric entities.
Table 2-67: Calculation – Arithmetic Operators

Operator Description Syntax


+ The plus (+) is the addition operator. <calc> = <ana_1> + <ana_2>

It yields the sum of two operands.


- (infix) The minus (-) is the subtraction operator. <calc> = <ana_1> - <ana_2>

It yields the difference between two operands.


- (prefix) The minus (-) is the unary operator. <calc> = - <ana_1>

When used as a prefix to a single numeric operand, it


yields the negative value of the number.
* The star (*) is the multiplication operator. <calc> = <ana_1> * <ana_2>

It yields the product of two numbers.


/ The slash (/) is the division operator. <calc> = <ana_1> / <ana_2>

It yields the quotient of the first number divided by the


second number.
% The percent (%) is the module operator. <calc> = <ana_1> % <ana_2>

It yields the remainder of the division between first and


the second number.
^ The caret (^) is the exponential operator. <calc> = <ana_1> ^ <ana_2>

90 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

It raises the first operand to the power indicated by the


second operand. The second operand can be an integer
or a real value.

2.18.4 Calculation - Logical Operators


Except NOT, logical operators apply to a couple of operands and give a result according to the rules of Boolean logic. The
NOT operator applies to a single operand.
The following table provides the list of logic operands:
Table 2-68: Calculation – Logical Operators
Operator Description Syntax
AND The AND operator returns the value 1 when both arguments <calc> = <dig_1> AND <dig_2>
are true (not equal to zero).

If one argument is false (zero) it returns zero.


OR The OR operator returns the value 1 when one argument is <calc> = <dig_1> OR <dig_2>
true (not equal to zero).

If both arguments are false (zero) it returns zero.


NOT The NOT operator returns the value 1 if argument is false <calc> = NOT <dig_1>
(zero).

If argument is true (not equal zero) it returns zero.

2.18.5 Calculation - Relational Operators


Relational operators compare two values. They return 1 if the relation is true, 0 if the relation is false.
The following table provides the list of relational operators:
Table 2-69: Calculation – Relational Operators

Operator Description Syntax


< The < (less than) operator gives a true result, if the first operand ( <ana_1> < <ana_2> )
is less than the second.
== The == (equal to) operator gives a true result, if its operand are ( <ana_1> == <ana_2> )
equal.
> The > (greater than) operator gives a true result, if the first ( <ana_1> > <ana_2> )
operand is greater than the second.
<= The <= (less than or equal to) operand gives a true result, if the ( <ana_1> <= <ana_2> )
first operand is less than or equal to the second.
!= The != (not equal to) operator gives a true result, if operands are ( <ana_1> != <ana_2> )
not equal.
>= The >= (greater than or equal to) operator gives a true result, if ( <ana_1> >= <ana_2> )
the first operand is greater than or equal to the second.

2.18.6 Control Structures


Two control structures are available to calculation subsystem: IF-THEN-ELSE and WHILE-DO.
IF-THEN-ELSE:
The IF-THEN-ELSE structure is a compound operator. Its operands are one logical expression (the IF clause) and several
expressions (the THEN and the ELSE clauses).
The processor evaluates the first (IF clause) expression. If that expression is true (not equal to zero), the expressions
comprised in the THEN branch are evaluated and the expression comprised in the ELSE branch are skipped. Otherwise,
the expressions comprised in the THEN branch are skipped and the expressions comprised in the ELSE branch are
evaluated.
The ELSE branch is optional and can be omitted. In such a case, if the IF clause is false, no expressions of the IF-THEN-
ELSE structure are evaluated.
There are two formats allowed for the syntax of the IF-THEN-ELSE structure: a C like structure and a Fortran like structure.
The two structures are shown in the following examples.
o C like syntax
IF (expression_0)
{ expression_1_1 expression_2_1
2VAA000830-330 A 91
S+ Operations DB Reference DATABASE STRUCTURE

.... expression_N_1
} ELSE
{ expression_1_2 expression_2_2
....
expression_N_2
}
o Fortran like syntax

IF (expression_0) THEN expression_1_1 expression_2_1


.... expression_N_1
ELSE expression_1_2 expression_2_2
.... expression_N_2
ENDIF
• WHILE-DO:
The WHILE-DO structure is a compound operator. Its operands are one main expression (the WHILE clause) and several
expressions which are executed if the main expression is true (not equal to zero).
When all expressions have been executed, the main clause expression is evaluated again; if its value continues to be true
then all expressions are executed again.
There are two formats allowed for the syntax of the WHILE-DO structure: a C like structure and a Fortran like structure. The
two structures are shown in the following examples.
o C like syntax

WHILE (expression_0)
{
expression_1 expression_2
.... expression_N
}
o Fortran like syntax
WHILE (expression_0) DO expression_1 expression_2
.... expression_N
ENDWHILE
Using the WHILE-DO statement may cause never ending loops. In such a case the main clause expression never become
false and the functionality of the calculation package will result compromised.
Ensure to avoid such cases carefully checking the main clause.
The IF-THEN-ELSE and WHILE-DO structures can be nested, i.e.,the THEN and the ELSE clauses can include IF-THEN-
ELSE and WHILE-DO structures, the WHILE-DO body may include IF-THEN-ELSE and WHILE-DO structures.

The FORTRAN like syntax of the IF-THEN-ELSE cannot be nested. Use the C like syntax. The C like syntax of the IF-THEN-
ELSE and WHILE-DO structures cannot have the two brackets which include the ELSE or WHILE clause on the same line.

2.18.7 Intrinsic Functions


Functions are special operands that return a value based on a set of input parameters. Input parameters are enclosed
between parentheses. Functions follow the usual precedence rules of operands.
The following section gives a complete list and description of the intrinsic functions available in the calculation subsystem.
For each function, the syntax lists the input parameters together the engineering units (where applicable). The syntax of a
generic function having a total of n input parameters is shown below.

<calc> =
92 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

<function name> (Input variables


[1] <parameter 1>, [2] <parameter 2>,
......................
[n] <parameter n>,
End Variables)
Each parameter is numbered to allow easy checks in the calculation formulas. The “Input Variables” string opens the
declaration of input variables to the function. The “End Variables” string closes the declarations.
The ordering number and the declaration strings must not be typed in the macro call.
In the syntax to exemplify functions, the following symbols are used:
<calc> - identifies an internal generic variable used as calculation result,
<analog> - identifies a generic analog value,
<digital> - identifies a generic digital value,
<analog_n> - identifies a generic analog value,
<digital_n> - identifies a generic digital value,
“<tag>” - identifies a generic (analog or digital) tag name, “<pv_tag>” - identifies a generic analog tag name,
“<di_tag>” - identifies a generic digital tag name.
Other internal variables will be used, where possible, to improve readability of syntax. They are strictly related to the scope
of the function.
Constants, internal variables and tag names can represent analog (<analog_n>) and digital (<digital_n>) values. For
example, 5.6 is a constant analog value; VAR can be a variable analog value if VAR is an internal variable and “PV-TAG”
can be an analog value represented by the current value of the tag PV-TAG in the database.

2.18.8 Calculation - Execution Functions


These functions affect the algorithm execution of a calculation.
The following table provides the list of Calculation – Execution Functions:

Table 2-70: Calculation – Execution Functions

Function Description Syntax Eng. Unit


EXITCALC The function forces exit <calc> = EXITCALC (Input
from the calculation block. variables End Variables)

2.18.9 Calculation - Logical Functions


These functions perform logical calculations. They are an optimization of the basic logical operators ‘AND’ and ‘OR’.
The following table provides the list of Calculation – Logical Functions:
Table 2-71: Calculation – Logical Functions

Function Description Syntax Eng. Unit


F_AND The function returns the value 1 when arguments <digital> = F_AND
are true (not equal to zero). If one argument is false (Input variables
(zero) it returns zero. <digital_1>,
A variable number of arguments can be passed to <digital_2>,
the function and only good quality values are taken .......................
into account. <digital_n> End Variables)
A maximum of 99 input parameters can be defined.
F_OR The function returns the value 1 when one <digital> = F_OR
argument is true (not equal to zero). If both (Input variables
arguments are false (zero) it returns zero. <digital_1>,
A variable number of arguments can be passed to <digital_2>,
the function and only good quality values are taken .......................
into account. <digital_n> End Variables)
A maximum of 99 input parameters can be defined.

2VAA000830-330 A 93
S+ Operations DB Reference DATABASE STRUCTURE

2.18.10 Calculation - Mathematical Functions


These functions perform mathematical calculations. They are typical mathematical functions.
The following table provides the list of Calculation – Mathematical Functions:
Table 2-72: Calculation – Mathematical Functions

Function Description Syntax Eng. Unit


ABS The function returns the absolute value of a <calc> = ABS
number. (Input variables
<analog>
End Variables)
ACOS The function computes the inverse cosine (arc <calc> = ACOS
cosine) of an angle. (Input variables
<angle>
End Variables)

rad
ASIN The function computes the inverse sine (arc sine) <calc> = ASIN
of an angle. (Input variables
<angle>
End Variables)

rad
ATAN The function calculates the inverse tangent (arc <calc> = ATAN
tangent) of an angle. (Input variables
<angle>
End Variables)

rad
AVR The function returns the average value of n <calc> = AVR
values. (Input variables
<analog_1>,
A maximum of 99 input parameters can be <analog_2>,
defined. .......................
<analog_n> End
Variables)
COS The function computes the cosine of an angle. <calc> = COS
(Input variables
<angle>
End Variables)

rad
EXP The function returns the value 'e' raised to the <calc> = EXP
power specified by the argument. (Input variables
<analog>
The value of 'e' is 2.7182818, the base of natural End Variables)
logarithms.
INT The function returns the integer part of a real <integer part> = INT
number. (Input variables
<real number> End
Variables)
INTERP The function computes the interpolation of pair of <calc> = INTERP
values in a table. (Input variables
<interpolation
The interpolation value is the entry within the value>, X1, Y1, ... ,
table. Pairs must be ordered in increasing order of Xn, Yn End
Xi elements. Variables)

A maximum of 99 input parameters can be


defined.
LN The LN function computes the natural logarithm of <calc> = LN
a number. (Input variables
<positive real> End
Natural logarithms are calculated using 'e' = Variables)
2.71822818 as a base. The number must be
positive.
LOG10 The function computes the logarithm of a number. <calc> = LOG10
(Input variables
94 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

The base for the calculation is the value 10. The <positive real> End
number must be positive. Variables)
MAX The function returns the maximum among n <calc> = MAX
values. (Input variables
<analog_1>,
A maximum of 99 input parameters can be .......................
defined. <analog_n> End
Variables)
MIN The function returns the minimum among n <calc> = MIN
values. (Input variables
<analog_1>,
A maximum of 99 input parameters can be .......................
defined. <analog_n> End
Variables)
PIGREEK Function returns the value 3.14159. <calc> = PIGREEK
(Input variables End
Variables)
SIGN The function returns a representation of the <calc> = SIGN
numerical sign of its argument. (Input variables
<analog>
If its argument is negative, the function returns –1. End Variables)
If the argument is zero, it returns 0. If the
argument is positive, it returns 1.
SIN The function computes the sine of an angle. <calc> = SIN
(Input variables
<angle>
End Variables)

rad
SQR The function returns the square root of the <calc> = SQR
argument. (Input variables
<analog>
End Variables)
TAN The function returns the tangent of an angle. <calc> = TAN
(Input variables
<angle>
End Variables)

rad
VALMAX The function returns the maximum among n <calc> = VALMAX
values. (Input variables
<% validity>,
It is an optimization of the MAX function and takes <analog_1>,
care of the good quality samples only. Bad values .......................
are discharged, and then the maximum is <analog_n> End
evaluated. The quality of the result is set to good if Variables)
the percentage of remaining samples is greater
than the required validity percentage.

A maximum of 99 input parameters can be


defined.
VALMED The function returns the average among n values. <calc> = VALMED
(Input variables
It is an optimization of the AVR function and takes <% validity>,
care of the good quality samples only. Bad values <% deviation>,
are discharged. After the mean value has been <analog_1>,
computed, all involved samples are compared to .......................
the mean value. A sample is discharged if it differs <analog_n> End
more than the required deviation. Then a mean Variables)
value is computed again. The algorithm is
recursively applied until remaining samples are
within the required deviation. The quality of the
result is set to good if the percentage of remaining
samples is greater than the required validity
percentage.

A maximum of 99 input parameters can be


defined.

2VAA000830-330 A 95
S+ Operations DB Reference DATABASE STRUCTURE

VALMIN The function returns the minimum among n <calc> = VALMIN


values. (Input variables
<% validity>,
It is an optimization of the MIN function and takes <analog_1>,
care of the good quality samples only. Bad values .......................
are discharged, and then the minimum is <analog_n> End
evaluated. The quality of the result is set to good if Variables)
the percentage of remaining samples is greater
than the required validity percentage.

A maximum of 99 input parameters can be


defined.

2.18.11 Calculation - Tag Functions


The functions allow operating on tags and interacting with the configuration database and the realtime database.
The following table provides the list of Calculation – Tag Functions:
Table 2-73: Calculation – Tag Functions

Eng.
Function Description Syntax
Unit
FORCE_APPL1 The function forces the “<tag>” = FORCE_APPL1
application bit 1 of a tag, (Input variables “<tag>”,
irrespective of the quality of <digital>
input tag. End Variables)
FORCE_APPL2 The function forces the “<tag>” = FORCE_APPL2
application bit 2 of a tag, (Input variables “<tag>”,
irrespective of the quality of <digital>
input tag. End Variables)
FORCE_APPL3 The function forces the “<tag>” = FORCE_APPL3
application bit 3 of a tag, (Input variables “<tag>”,
irrespective of the quality of <digital>
input tag. End Variables)
FORCE_QUALITY The function forces the “<tag>” =
quality of a tag, irrespective FORCE_QUALITY (Input
of the quality of input tag. variables “<tag>”,
<digital>
Value 0 forces good quality, End Variables)
value 1 forces bad quality.
DESCR_OR OR function, with variable “<tag>” = DESCR_OR
elements. Special function (Input variables
which manipulates <elem_1>, ... ,<elem_n>,
descriptions (strings) <qual_1>, ... ,<qual_n> End
instead of values: giving an Variables)
OR function, the description
of the result is the chaining
of the description of the
single components which
are TRUE.
GETINFO The function returns <calc> = GETINFO
Symphony Plus system (Input variables
information. System <system parameter> End
information is identified by Variables)
a symbolic code as defined
in the System Parameter
Table.
GETTAG The function returns <calc> = GETTAG
database configuration (Input variables
parameters of tags. “<tag>”,
Configuration parameters <config. parameter> End
are identified by a symbolic Variables)
code as defined in the
Configuration Parameter
Table.
SAVEVALUE The function saves a value <calc> = SAVEVALUE
of a tag as initial value to (Input variables “<tag>”,
be restored later at restart <value>
time. End Variables)
96 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

The function returns a


value 0 (with quality bad)
on failure and a value 1
(with quality good) on
success. The function
writes the value in the
realtime database also.
Thus, tag assignment is not
required within calculation.
SETTAG The function writes <calc> = SETTAG
database configuration (Input variables
parameters of tags. “<tag>”,
<config. parameter>,
Configuration parameters <parameter value> End
are identified by a symbolic Variables)
code as defined in the
Configuration Parameter
Table.
TEST_ALARM The function checks if a tag <digital> = TEST_ALARM
is in an alarm condition. (Input variables “<tag>”
End Variables)
It returns 1 if the tag is
alarmed and 0 if not.
TEST_INSERTED The function checks if a tag <digital> =
has an inserted value. TEST_INSERTED (Input
variables “<tag>”
It returns 1 if the tag has End Variables)
inserted value and 0 if not.
TEST_QUALITY The function returns the <digital> = TEST_QUALITY
quality of a tag. (Input variables “<tag>”
End Variables)
It returns 0 if the tag quality
is good and 1 if the quality
is bad.
TEST_UNACKED The function checks if the <digital> =
tag is to acknowledge. TEST_UNACKED (Input
variables “<tag>”
It returns 1 if the tag is to End Variables)
acknowledge and 0 if not.
TEST_APPL1 The function returns the <digital> = TEST_APPL1
application bit 1 of the (Input variables “<tag>”
quality tag. End Variables)
TEST_APPL2 The function returns the <digital> = TEST_APPL2
application bit 2 of the (Input variables “<tag>”
quality tag. End Variables)
TEST_APPL3 The function returns the <digital> = TEST_APPL3
application bit 3 of the (Input variables “<tag>”
quality tag. End Variables)

2.18.12 Calculation - Time Functions


The functions deal with the time and its components. They allow retrieving information on time and date. Most of them do
not require parameters at all.
The following table provides the list of Calculation – Time Functions.
Table 2-74: Calculation – Time Functions

Function Description Syntax Eng. Unit


DAY The function returns the current day of <calc> = DAY
the month. (Input variables
End Variables)
The value is in the range 1 to 31.
DAYOFWEEK The function returns the current day of <calc> = DAYOFWEEK
the week. (Input variables End
Variables)
The value is in the range 0 to 6 and 0
refers to Sunday.

2VAA000830-330 A 97
S+ Operations DB Reference DATABASE STRUCTURE

DAYOFYEAR The function returns the current day of <calc> = DAYOFYEAR


the year. (Input variables End
Variables)
The value is in the range 1 to 366.
DELTATIME The function returns the difference in <calc> = DELTATIME sec
seconds between two times (time1 – (Input variables
time2). Integer numbers represent <day of time1>,
day, month, year, hour and minute. <month of time1>,
<year of time1>,
<hour of time1>,
<minute of time1>,
<second of time1>,
<day of time2>,
<month of time2>,
<year of time2>, min sec
<hour of time2>,
<minute of time2>
<second of time2> End
Variables)

min sec
HOUR The function returns the current hour <calc> = HOUR
of the day. (Input variables
End Variables)
The value is in the range 0 to 23.
JULSEC The function returns the number of <calc> = JULSEC
seconds since a reference date. (Input variables
End Variables)
The reference date is assumed to be
January, 1 1991.
MINUTE The function returns the current <calc> = MINUTE
minute of the hour. (Input variables
End Variables)
The value is in the range 0 to 59.
MONTH The function returns the current <calc> = MONTH
month. (Input variables
End Variables)
The value is in the range 1 to 12.
SECOND The function returns the current <calc> = SECOND
second within the minute. (Input variables
End Variables)
The value is in the range 0 to 59.
WEEKOFYEAR The function returns the current week <calc> = WEEKOFYEAR
of the year. (Input variables
End Variables)
The value is in the range 1 to 52.
YEAR The function returns the current year. <calc> = YEAR
(Input variables
End Variables)

2.18.13 Calculation - Steam Functions


The functions allow computing and retrieving data on steam and water properties. They involve temperature, pressure,
enthalpy, entropy and specific volume of steam.
The following table provides the list of Calculation – Steam Functions:
Table 2-75: Calculation – Steam Functions

Function Description Syntax Eng. Unit


CP_at_TP The function computes the <specific heat> = kJ/kg/°C
specific heat, relative to CP_at_TP
steam and water, as (Input variables
function of temperature and <temperature>,
pressure. <pressure> End Variables) °C
bar
DV_at_TP The function computes the <water viscosity> = kg/s m
water viscosity, relative to DV_at_TP
steam and water, as (Input variables
98 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

function of temperature and <temperature>,


pressure. <pressure> End Variables) °C
bar
H_at_PS The function computes the <enthalpy> = H_at_PS kJ/kg
enthalpy, relative to steam (Input variables
and water, as function of <pressure>,
pressure and entropy. <entropy>
End Variables) bar
kJ/kg °C
K_at_TP The function computes the <water conductibility> = W/m °C
water conductibility, relative K_at_TP
to steam and water, as (Input variables
function of temperature and <temperature>,
pressure. <pressure> End Variables) °C
bar
P_sat_at_T Given the temperature, the <saturation pressure> = bar
function returns the PSAT_at_T
pressure of saturation. (Input variables
<temperature> End
Variables) °C
S_at_PH The function computes the <entropy> = S_at_PH kJ/kg °C
entropy, relative to steam (Input variables
and water, as function of <pressure>,
pressure and enthalpy. <enthalpy> End Variables)
bar kJ/kg
S_at_TP The function computes the <entropy> = S_at_TP kJ/kg °C
entropy, relative to steam (Input variables
and water, as function of <temperature>,
temperature and pressure. <pressure> End Variables)
°C
bar
T_at_PH The function computes the <temperature> = T_at_PH °C
temperature, relative to (Input variables
steam and water, as <pressure>,
function of pressure and <enthalpy> End Variables)
enthalpy. bar kJ/kg
T_at_PS The function computes the <temperature> = T_at_PS °C
temperature, relative to (Input variables
steam and water, as <pressure>,
function of pressure and <entropy>
entropy. End Variables) bar
kJ/kg °C
T_sat_at_P Given the pressure, the <saturation temp.> = °C
function returns the TSAT_at_P
temperature of saturation. (Input variables
<pressure> End Variables)
bar
V_at_TP The function computes the <specific volume> = m3/kg
specific volume, relative to V_at_TP
steam and water, as (Input variables
function of temperature and <temperature>,
pressure. <pressure> End Variables) °C
bar

2.18.14 Calculation - Gas Property Functions


The functions concern gas properties and apply to various kinds of gasses. They involve temperature, pressure, enthalpy,
entropy, molecular weight, volume and specific heat of gas.
The following table provides the list of Calculation – Gas Property Functions:
Table 2-76: Calculation – Gas Property Functions

Function Description Syntax Eng. Unit


CP_GAS The function computes the specific heat of a <specific heat> = CP_GAS kJ/kg °C
gas as function of the temperature. (Input variables
<temperature>,
The gas is defined according to the gas <gas index> End Variables)
table. °C
nbr
2VAA000830-330 A 99
S+ Operations DB Reference DATABASE STRUCTURE

H_GAS The function computes the enthalpy of a gas <specific heat> = H_GAS kJ/kg
as function of the temperature. (Input variables
<temperature>,
The gas is defined according to the gas <gas index> End Variables)
table. °C
nbr
M_GAS The function computes the molecular weight <specific heat> = M_GAS kg/Mole
of a gas. (Input variables
<temperature>,
The gas is defined according to the gas <gas index> End Variables)
table. nbr
S_GAS The function computes the entropy of a gas <specific heat> = S_GAS kJ/kg °C
as function of temperature and pressure. (Input variables
<temperature>,
The gas is defined according to the gas <gas index> End Variables)
table. °C bar nbr
V_GAS The function computes the volume of a gas <specific heat> = V_GAS m3/Kg
as function of temperature and pressure. (Input variables
<temperature>,
The gas is defined according to the gas <gas index> End Variables)
table. °C bar nbr

2.18.15 Calculation - Sea Water Function


The functions concern sea water. They involve temperature, salt concentration, enthalpy, density, conductibility, viscosity
and specific heat of sea water.
A single generic function named SEAW implements the various sea water functions. An input parameter allows qualifying
the generic function SEAW to operate as a specific function.
The following table provides the list of Calculation – Sea Water Functions:
Table 2-77: Calculation – Sea Water Function

Function Description Syntax Eng. Unit


SEAW The function computes a property of the sea water <property> = SEAW Table 2-78
as function of the temperature and salt (Input variables
concentration. The property to be returned is <temperature>,
specified by an index as third parameter. <salt concentration>, °C
<function index> End %
Refer Table 2-78 for the list of allowed properties Variables) nbr
and the corresponding returned engineering unit.

2.18.16 Calculation - Sea Water Function Indices


The following table provides the list of Calculation – Sea Water Function Indices:
Table 2-78: Calculation – Sea Water Function Indices

Function Index Eng. Unit


Enthalpy 1 kJ/kg
Specific Heat 2 kJ/kg °C
Density 3 kg/m3
Thermal Conducibility 4 W/m °C
Dynamic Viscosity 5 kg/s m

2.18.17 Calculation - Fuel Combustion Functions based on Flue Gas


The following table lists fuel combustion and functions based on flue gas. They involve temperature, enthalpy, entropy and
composition of fuel and flue gas.
The functions HFUMI, HFUMACHS, CPFUACHS, FAMAX, FARATIO, CO2MAX and AIREXC, defined in previous manuals
among the gas property functions, have been removed from this manual because new functions defined here replace them
or they are not so general purpose to be included.
However, they are still supported for compatibility with old versions of Symphony Plus. Refer to the documentation of
previous versions for details. The names are reserved keywords and cannot be used within calculations to define internal
variables.
The following table provides the list of Calculation – Fuel Combustion Functions based on Flue Gas:
Table 2-79: Calculation – Fuel Combustion Functions based on Flue Gas
100 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

Function Description Syntax Eng. Unit


CP_FGAS_T The function computes the <specific heat> = kJ/kg °C
specific heat of flue gas as CP_FGAS_T (Input
function of the temperature variables
and the flue gas <temperature>,
composition. An index <index>, °C
specifies if flue gas <carbon bi-oxide>, nbr
composition is expressed in <oxygen>, %
weight (index = 0) or <carbon oxide>, %
volume (index = <sulphur bi-oxide>, %
1). <water>, %
<argon> %
End Variables) %
H_FGAS_T The function computes the <enthalpy> = H_FGAS_T kJ/kg
enthalpy of flue gas as (Input variables
function of the temperature <temperature>,
and the flue gas <index>,
composition. <carbon bi-oxide>, °C
<oxygen>, nbr
An index specifies if flue <carbon oxide>, %
gas composition is <sulphur bi-oxide>, %
expressed in weight (index <water>, %
= 0) or volume (index = <argon> %
1). End Variables) %
%
S_FGAS_TP The function computes the <entropy> = S_FGAS_TP kJ/kg °C
entropy of flue gas as (Input variables
function of the temperature, <temperature>,
the pressure and the flue <index>,
gas composition. <pressure>, °C
<carbon bi-oxide>, nbr
An index specifies if flue <oxygen>, %
gas composition is <carbon oxide>, %
expressed in weight (index <sulphur bi-oxide>, %
= 0) or volume (index = 1). <water>, %
<argon> %
End Variables) %
T_FGAS_H The function computes the <temperature> = °C
temperature of flue gas as T_FGAS_H (Input variables
function of the enthalpy and <enthalpy>,
the flue gas composition. <index>,
An index specifies if <carbon bi-oxide>, kJ/kg nbr
flue gas composition is <oxygen>, %
expressed in weight (index <carbon oxide>, %
= 0) or volume (index = <sulphur bi-oxide>, %
1). <water>, %
<argon> %
End Variables) %
T_FGAS_PS The function computes the <temperature> = °C
temperature of flue gas as T_FGAS_PS (Input
function of the pressure, variables
the entropy and the flue <pressure>,
gas composition. <entropy>, kJ/kg nbr
<index>, %
An index specifies if flue <carbon bi-oxide>, %
gas composition is <oxygen>, %
expressed in weight (index <carbon oxide>, %
= 0) or volume (index = 1). <sulphur bi-oxide>, %
<water>, %
<argon>
End Variables)

2.18.18 Calculation - Combustion Functions based on Fuel Characteristics


The following table provides the list of Calculation – Combustion Functions based on Fuel Characteristics:
Table 2-80: Calculation – Combustion Functions based on Fuel Characteristics

Function Description Syntax Eng. Unit

2VAA000830-330 A 101
S+ Operations DB Reference DATABASE STRUCTURE

AIR_MIN The function computes the <air in fuel>= AIR_MIN kg/kg


stoichiometric air in the fuel (Input variables
as function of the fuel <carbon>,
composition. <hydrogen>,
<sulphur>, %
The stoichiometric air is <oxygen> %
returned in kg dry air/kg End Variables) %
fuel. %
CP_FCOMB_T The function computes the <specific heat> = kJ/kg °C
specific heat of air and fuel CP_FCOMB_T (Input
as function of the variables
temperature and the fuel <temperature>,
composition. <carbon>, °C
<hydrogen>, %
<sulphur>, %
<oxygen>, %
<nitron>, %
<dry air/fuel> End %
Variables) kg/kg
H_FCOMB_T The function computes the <enthalpy> = H_FCOMB_T kJ/kg
enthalpy of air and fuel as (Input variables
function of the temperature <temperature>,
and the fuel composition. <carbon>,
<hydrogen>, °C
<sulphur>, %
<oxygen>, %
<nitron>, %
<dry air/fuel> End %
Variables) %
kg/kg
S_FCOMB_TP The function computes the <entropy> = S_FCOMB_TP kJ/kg °C
entropy of air and fuel as (Input variables
function of the temperature <temperature>,
and the fuel composition. <pressure>,
<carbon>, °C
<hydrogen>, %
<sulphur>, %
<oxygen>, %
<nitron>, %
<dry air/fuel> End %
Variables) kg/kg
T_FCOMB_H The function computes the <temperature> = °C
temperature of air and fuel T_FCOMB_H (Input
as function of the enthalpy variables
and the fuel composition. <enthalpy>,
<carbon>, kJ/kg
<hydrogen>, %
<sulphur>, %
<oxygen>, %
<nitron>, %
<dry air/fuel> End %
Variables) kg/kg
T_FCOMB_PS The function computes the <temperature> = °C
temperature of air and fuel T_FCOMB_PS (Input
as function of the pressure, variables
entropy and the fuel <pressure>,
composition. <entropy>, bar
<carbon>, kJ/kg °C
<hydrogen>, %
<sulphur>, %
<oxygen>, %
<nitron>, %
<dry air/fuel> End %
Variables) kg/kg

2.18.19 Wet Air Functions


The Wet Air functions lists temperature, pressure, absolute humidity, enthalpy, entropy and specific heat.

102 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

The functions HARIA, HHY, PVSAT and CPARIA, defined in previous manuals among the gas property functions, have
been removed from this manual since the functions defined here replace them.
However, they are still supported for compatibility with old versions of Symphony Plus. Refer to the documentation of
previous versions for details. The names are reserved keywords and cannot be used within calculations to define internal
variables.

2.18.20 Calculation - Wet Air Functions


The following table provides the list of Calculation – Wet Air Functions:
Table 2-81: Calculation – Wet Air Functions

Function Description Syntax Eng. Unit


CP_AIR_T The function computes the specific heat of <specific heat> = kJ/kg °C
wet air as function of the temperature and CP_AIR_T
absolute humidity. (Input variables
<temperature>,
The absolute humidity is expressed in kg <absolute humidity> End °C
vapor/kg dry air. Variables) kg/kg
H_AIR_T The function computes the enthalpy of wet <enthalpy> = H_AIR_T kJ/kg
air as function of the temperature and (Input variables
absolute humidity. <temperature>,
<absolute humidity> End
The absolute humidity is expressed in kg Variables) °C
vapor/kg dry air. kg/kg

This enthalpy is considered on the basis of


a unit mass of wet air and zero value for T
= 0 °C.

The usual enthalpy for air conditioning


applications (psychrometric chart) can be
obtained as follows:

Hhum=(1+X)*H_AIR_T(T,X) + 2501.7*X
expressed in kJ/kg dry air. In the above
formula X represent the absolute humidity
and T the temperature.
S_AIR_TP The function computes the entropy of wet <entropy> = S_AIR_TP kJ/kg °C
air as function of the temperature, pressure (Input variables
and absolute humidity. <temperature>,
<pressure>,
The absolute humidity is expressed in kg <absolute humidity> End °C bar kg/kg
vapor/kg dry air. Variables)
T_AIR_H The function computes the temperature of <temperature> = T_AIR_H °C
wet air as function of the enthalpy and (Input variables
absolute humidity. <enthalpy>,
<absolute humidity> End
The absolute humidity is expressed in kg Variables) kJ/kg kg/kg
vapor/kg dry air.
T_AIR_PS The function computes the temperature of <temperature> = °C
wet air as function of the pressure, entropy T_AIR_PS
and absolute humidity. (Input variables
<pressure>,
The absolute humidity is expressed in kg <entropy>, bar
vapor/kg dry air. <absolute humidity> End kJ/kg °C
Variables) kg/kg
WHY The function computes the percentage of <humidity> = WHY %
humidity per kg of dry air as function of dry (Input variables
bulb temperature, atmospheric pressure <dry bulb temp.>,
and measured relative humidity. <atmospheric press.>,
<relative humidity> End °C
The temperature is assumed to be in the Variables) bar
range –10 to 50 °C and pressure in the %
range 0.9 to 1.2 bar.

2VAA000830-330 A 103
S+ Operations DB Reference DATABASE STRUCTURE

2.18.21 Data File Functions


These two functions allow operations on Symphony Plus database data files. These functions also interface Symphony Plus
standard data files and specific application data files.
The following table provides the list of Data File functions:
Table 2-82: Data File Functions

Function Description Syntax Eng. Unit


READFILE The function read data from a specified <calc> = READFILE (Input
word of a record in a file. variables
<file name>,
Refer Table 2-83 for the list of allowed <record number>,
formats. <word number>,
<format>
End Variables)
WRITEFILE The function writes data to a specified <calc> = WRITEFILE (Input
word of a record in a file. variables
<file name>,
The value to be written is a parameter to <record number>,
the function. <word number>,
<format>,
Refer Table 2-83 for the list of allowed <value>
formats. End Variables)

2.18.22 Read/Write File Formats


The following table provides the list of Read/Write File formats:
Table 2-83: Read/Write File Formats:

Number Description
1 BYTE
2 USHORT
3 SHORT
4 UNIT
5 INT
6 FLOAT
7 DOUBLE

2.18.23 Calculation - Historical Functions


Historical functions involve a single database tag. Samples are collected at fixed time intervals and at calculation time they
are processed to provide the calculation result.
The following table provides the list of Calculation – Historical Functions:
Table 2-84: Calculation – Historical Functions

Function Description Syntax Unit


COUNTER Up/down counter. <calc> = COUNTER (Input
variables “<pv_tag>”,
The function adds the increment value to <threshold value>,
the previous counter value when the input <increment value>,
variable reaches the threshold value. The <reset flag>,
increment value will be > 0 for up counting <initial value>,
and < 0 for down counting. 3
End Variables)
When the reset flag is set to 1, the counter
is set to the initial value.
DELAY Delay. <calc> = DELAY
(Input variables
The function returns the previous value of “<tag>”,
the input. <reset flag>,
2
When the reset flag is set to 1, the function End Variables)
returns the current value of the input.
DERIV Derivative. <calc> = DERIV
(Input variables
“<pv_tag>”,
104 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

The function returns the derivative of last 4 4


sampled values according to the following End Variables)
simplified (based on 4 samples) formula:
Vn = ((-3*V3)-V2+V1+(3*Vi))/10*dt where:
V3 - 3rd previously sampled value, V2 -
2nd previously sampled value, V1 -
previous sampled value, Vi - current
sampled value. dt - sampling time.
EVENTTIME Time of last exception report of a tag. <calc> = EVENTTIME
(Input variables “<tag>”,
The time of last event with a given value is <value>
retrieved from the playback archive (at the End Variables)
moment within the last hour).
FILT Filter <calc> = FILT
(Input variables
The function returns a filtered value “<pv_tag>”,
according to the following formula: <time constant>,
Vn = Vn1*(tau/(dt+tau)+Vi(dt/(dt+tau) <reset flag>,
where: <initial value>
3
Vn1 - previous FILT calculated value, Vi - End Variables)
current sampled value, dt - sampling time.
tau - time constant.

When the reset flag is set to 1, the function


is set to the initial value.
GRAD Gradient. <calc> = GRAD
(Input variables
The function returns the gradient of two “<pv_tag>”,
sampled values according to the following 2
formula: End Variables)

Vn = (Vi - V1) / dt where:


V1 - previous sampled value, Vi - current
sampled value.
dt - sampling time.
H_AVR Historical average. <calc> = H_AVR GRAD
(Input variables
The function returns the average of last “<pv_tag>”,
sampled values. <min. % good>,
<discharge bad flag>,
If the percentage of samples with a good <number of samples> End
quality is greater than the minimum Variables)
percentage, the quality of average is set to
good. Elsewhere, the quality is set to bad.
Bad samples are discharged if the
discharge flag is set to 0. Elsewhere, they
are taken into account in computing the
average.
H_MAX Historical maximum. <calc> = H_MAX
(Input variables
The function returns the maximum of last “<pv_tag>”,
sampled values. <min. % good>,
<discharge bad flag>,
If the percentage of samples with a good <number of samples> End
quality is greater than the minimum Variables)
percentage, the quality of maximum is set
to good. Elsewhere, the quality is set to
bad.

Bad samples are discharged if the


discharge flag is set to 0. Elsewhere, they
are taken into account in computing the
maximum.
H_MIN Historical minimum. <calc> = H_MIN
(Input variables
The function returns the minimum of last “<pv_tag>”,
sampled values. <min. % good>,
<discharge bad flag>,

2VAA000830-330 A 105
S+ Operations DB Reference DATABASE STRUCTURE

If the percentage of samples with a good <number of samples> End


quality is greater than the minimum Variables)
percentage, the quality of minimum is set
to good. Elsewhere, the quality is set to
bad.

Bad samples are discharged if the


discharge flag is set to 0. Elsewhere, they
are taken into account in computing the
minimum.
H_SUM Historical sum. <calc> = H_SUM
(Input variables
The function returns the sum of last “<pv_tag>”,
sampled values. <min. % good>,
<discharge bad flag>,
If the percentage of samples with a good <number of samples> End
quality is greater than the minimum Variables)
percentage, the quality of sum is set to
good. Elsewhere, the quality is set to bad.
Bad samples are discharged if the
discharge flag is set to 0. Elsewhere, they
are taken into account in computing the
sum.
INTEG Integral. <calc> = INTEG
(Input variables
The function returns the integral of last “<pv_tag>”,
sampled values according to the following <reset flag>,
formula: <initial value>,
Vn = Vn1 + (Vi * dt) 3
where: End Variables)
Vn1 - previous INTEG calculated value.
Vi - current sampled value. dt - sampling
time.

When the reset flag is set to 1, the function


is set to the initial value.
HIST_VAL Historical value. <calc> = HIST_VAL (Input min sec
variables
The function returns the value of the tag “<hist group name>”,
within an historical group at a defined time. “<tag>”,
A negative offset refers to the preceding <day>,
sample with respect to the sample <month>,
identified by the time. <year>,
<hour>,
A positive offset refers to the next sample. <minute>,
A null offset refers to the sample identified <second>,
by the time. <offset>
End Variables)
HIST_WRT Write Historical value. <calc> = HIST_WRT min sec
(Input variables
The function writes the value of the tag <hist group name>,
within an historical group for the defined “<tag>”,
time. <day>,
<month>,
A negative offset refers to the preceding <year>,
sample with respect to the sample <hour>,
identified by the time. <minute>,
<second>,
A positive offset refers to the next sample. <offset>,
A null offset refers to the sample identified <value>
by the time. End Variables)
HIST_REGR Historical regression. <calc> = HIST_REGR min sec
(Input variables
<hist group name>,
“<tag>”,
“<filter tag>”,
<filter high value>,
<Filter low value>,
<day>,

106 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

<month>,
<year>,
<hour>,
<minute>,
<second>,
<offset value>,
<offset time unit>,
<number of samples>,
<analisys interval>,
<interval time unit>,
<min. % good>,
<discharge bad flag>,
<angle coeff>,
<const coeff>,
<error on angle coeff>,
<error on const coeff>,
<standard error> End
Variables)
SDEV Standard deviation. <calc> = SDEV
(Input variables
The function returns the standard deviation “<pv_tag>”,
value of last sampled values. <min. % good>,
If the percentage of samples with a good <discharge bad flag>,
quality is greater than the minimum <number of samples> End
percentage, the quality of standard Variables)
deviation is set to good. Elsewhere, the
quality is set to bad.

Bad samples are discharged, if the


discharge flag is set to 0. Elsewhere, they
are taken into account in computing the
standard deviation.
TIMER Timer. <calc> = TIMER sec
(Input variables
The function performs pulsed timing “<pv_tag>”,
(timing=0), timed out delay (timing=1) or <timing code>,
timing (timing=2) functions using the delay <delay>,
time defined in seconds. 2
End Variables)
NUM_ALARM Number of alarms in an alarm group. The <calc> = NUM_ALARM
function returns the number of (Input variables
alarms within an alarm group at the <alarm group number>,
Requested time. <unacked flag> End
Variables)
If “unacked flag” not equal 0, returns the
number of alarms to acknowledge.

2.18.24 Database Functions


The S+ Operations History server controls the data transfer from the database to the individual applications. Inquiries
includes the representation of current process values in process displays or trend displays.
The function "GetHistIntervallValues" returns statistically calculated values for preset intervals (delta period). The S+
Operations History database provides the following statistical functions:
Table 2-85: Database Functions

DB Function Description
Raw data Displays the data from the database
Average Returns the Average-Value over the delta period
Minimum Returns the Minimum-Value over the delta period
Maximum Returns the Maximum-Value over the delta period
Integral Returns the value integrated over the delta period
Difference Returns the value difference between period start and end
Standard Deviation Returns the sum of all squared deviations to the Average-Value

2VAA000830-330 A 107
S+ Operations DB Reference DATABASE STRUCTURE

Sum Returns the sum of the actually stored individual values in the interval (contains only the left
interval border)
Count Returns the number of actually stored individual values in the interval (contains only the left
interval border)
Value Values as displayed in the database

Following table explains typical example of Database function, DB Function interval, and DB Function Interval Unit for interval
of 5 seconds.
Table 2-86: Example of Database Functions

Values in the database Calculated values for a 5-minutes interval


Time in minutes Measured value Average-Values Minimum Maximum Integral
0 5 7.2 5 8 2160
1 7
2 8
3 8
4 8
5 9 5.4 2 9 1620
6 7
7 6
8 3
9 2
10

The returned time stamp corresponds to the start time of the scanned interval.
If, for example, the function "Average-Value" with a resolution of "5 minutes" is applied to the interval [0 to 5] minutes, the
result "7.2" with the time stamp "0 minutes" will be returned. The following calculation is used to find out the Average
Value:

When scanning a period for which no value exists in the database, the Last-Value will be used. If, for example, the function
"Average-Value" with a resolution of "2 minutes" is applied to the interval [3 to 4] minutes, a result of "8" with the time stamp
"3 minutes" will be returned.
For more information on Database Function, DB Function Interval, and DB Function Interval Unit, refer to section 3.3
Calculating Functions of S+ Operations History User manual (2VAA001151).

2.19 Trend Groups


Symphony Plus provides an integrated trend group processor for both analog and digital tags. The trend group package,
like all Symphony Plus subsystems, can be configured to meet specific application requirements without programming. It
maintains sets of input tags organized as trend groups and allows easy data displaying.
Trend groups can be classed into three main classes:’ realtime’, ‘historical’ and ‘post trip groups’.
Realtime groups allow quick data retrieving and presentation of tag values in trend or table format. realtime data are main
concern of realtime groups. Playback is the data source for realtime group presentations. realtime groups do not require any
recording on file.
Tag values of historical groups are periodically retrieved from playback, processed and stored in a set of circular files (Historic
Database) or trip files (Post Trip Database). Once stored, data can be retrieved to display trends or tables on operator
demand and are made available to Excel work-sheet (via DDE service) for printing.
108 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

2.19.1 Examples of Trend Groups


The following is a list of the three classes of trend groups that can be configured in a Symphony Plus application.
Realtime group
It allows grouping together analog and digital tags for quick displaying. Realtime groups may be viewed in historic mode
pausing realtime presentation and panning backward.
Historic group
A group of tags is gathered for periodical archiving or sampled and periodically processed for archiving. Different kinds of
processing criteria are selectable. Bad samples may be discharged or taken into account.
Post trip group
A group of tags is gathered for archiving when a digital tag, defined as trigger of the post trip changes to an alarm condition.
Data are archived beginning from the pre- trip time to the post trip time.

2.19.2 Trend Group Database


The trend group database is generated on a Personal Computer using standard packages like DBase III/IV or EXCEL. Then,
it must be copied to the computer running the Symphony Plus application (if it is a different one) for final import.
Trend group database is imported submitting the database file to the database builder. During this phase, the field contents
of the input file will be used to compile Symphony Plus internal database structures following the directives given by a field
assignment cross-reference file, previously processed by builder program DBXRF.
The database builder can also perform export operations, creating a target database file (DBase III/IV format) containing all
items as they are currently defined in the Symphony Plus internal database. If a target database does not exist, the builder
processor creates it using the whole S+ database structure. Alternatively, a target database file may be specified as template.
In this case, the builder processor updates the target database file handling only the fields specified in it. The target database
file may have just a single trend group or may be a full or partial database file. It must contain all (and only) fields to be
exported.

2.19.3 Generic Trend Group Definition


The following sub-sections list parameters to characterize all kind of trend groups.
There are both mandatory and optional parameters. A field (type of the trend group) allows the identification of group and
establishes which other fields must be filled in to complete the configuration. Additional fields are listed in the specific sections
following this one.

2.19.4 Generic Trend Group – General Parameters


The fields listed in Table 2-87 provides information of name and additional parameters used to identify and characterize the
trend group.
The following table provides the list of Generic Trend Group – General Parameters:
Table 2-87: Generic Trend Group – General Parameters

Format Width Range Default


Name Description
Opt/Mnd Parameter(s)
INDEX Integer Group index. {0, 1...100}
6 0 [mxhgrp]
Optional This field identifies the group by
number. It must be unique for each
trend group in the database. If
omitted or zero (blank), the first
vacant index will be allocated.

GROUPINDEX is the alias name


for this field
NAME Character Group name. <string>
20 <blank> [sznam]
Mandatory This field identifies the group by
name. It must be unique for each
trend group in the database.

Note: Tag name must be unique


within the database of the system,
node, and trend. If defined with
same tag name as any of the item
2VAA000830-330 A 109
S+ Operations DB Reference DATABASE STRUCTURE

name, then it will lead to error


while importing, creating, and
modifying of such item entries in
any of these database.

For Example: Having Tagname as


“SPOServerA” with the DEVSTA
tag type in Tag database, it is not
allowed to have “SPOServerA”
defined in the node database, it
also not allowed in trend
databased as well.

GROUPNAME is the alias name


for this field
GROUPUID Character Trend group unique identification. <string>
36 <blank> None
Optional This field provides a unique
identification within the Symphony
Plus life cycle.

Refer to Note1 at the end of the


table for more details
DESC Character Group description. <string>
64 <blank> [szdesc]
Optional GROUPDESC is the alias name
for this field
READONLY Character Read Only. Cannot be changed {Y,N} N None
1 online
Optional
SHOWLABEL Character Show label on Y-Axis (tics are {Y,N} N None
1 shown regardless of this flag)
Optional
OWNER Character Name of Owner <string>
50 <blank>
Optional
ALDISPPRIO Integer Alarm mimic priority (Lower 0
6 number has higher priority) None
Optional
PRIMDISPN Character Primary Display (View N) <string>
256 <blank> None
Optional Note: N indicates 1 through 4
views.
PLANTAREA Integer Plant Area 0
2 None
Optional
SEC_GROUP Integer Security group 0
2 None
Optional
SEC_LEVEL Integer Security level 0
2 None
Optional
EUINDEX Integer Engineering unit index. {-1, 0 ...127}
3 -1 [mxeutx]
Optional This field defines the index into the
engineering unit database. It can
be used to assign a unique
engineering unit to the group. It
supersedes the engineering units
of the tags belonging to the group.

The field is not included within the


fields of the on-line configuration
Tab.
EUDESC Character Engineering unit text. <string>
16 <blank> None
Optional EU_NAME is the alias name for
the field.

110 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

This text defines the engineering


unit to be associated with the tags
in the group. It can be used to
assign a unique engineering unit to
the group. It supersedes the
engineering units of the tags
belonging to the group.
GROUPCLASS Integer Class of trend group.
3
Optional Customer may class trend groups 0
using this field. None
ARCHTYPE Character Type of archiving. <string>
7 <blank> None
Mandatory This parameter qualifies the trend
group. Depending on the type, the
set of parameters required to fully
configuring the group changes.

Refer the Table 2-88 for the list of


all archiving types.
Application Parameters
ASPECT1NAM Character Name of aspect 1 <string>
20 <blank> None
Optional
ASPECT1CMD Character Command for aspect 1 <string>
80 <blank> None
Optional
ASPECT2NAM Character Name of aspect 2 <string>
20 <blank> None
Optional
ASPECT2CMD Character Command for aspect 2 <string>
80 <blank> None
Optional
ASPECT3NAM Character Name of aspect 3 <string>
20 <blank> None
Optional
ASPECT3CMD Character Command for aspect 3 <string>
80 <blank> None
Optional
ASPECT4NAM Character Name of aspect 4 <string>
20 <blank> None
Optional
ASPECT4CMD Character Command for aspect 4 <string>
80 <blank> None
Optional
ASPECT5NAM Character Name of aspect 5 <string>
20 <blank> None
Optional
ASPECT5CMD Character Command for aspect 5 <string>
80 <blank> None
Optional
ASPECT6NAM Character Name of aspect 6 <string>
20 <blank> None
Optional
ASPECT6CMD Character Command for aspect 6 <string>
80 <blank> None
Optional
ASPECT7NAM Character Name of aspect 7 <string>
20 <blank> None
Optional
ASPECT7CMD Character Command for aspect 7 <string>
80 <blank> None
Optional
ASPECT8NAM Character Name of aspect 8 <string>
20 <blank> None
Optional
ASPECT8CMD Character Command for aspect 8 <string>
80 <blank> None
Optional
2VAA000830-330 A 111
S+ Operations DB Reference DATABASE STRUCTURE

ASPECT9NAM Character Name of aspect 9 <string>


20 <blank> None
Optional
ASPECT9CMD Character Command for aspect 9 <string>
80 <blank> None
Optional
ASPECT10NA Character Name of aspect 10 <string>
20 <blank> None
Optional
ASPECT10CM Character Command for aspect 10 <string>
80 <blank> None
Optional
EXP_VAL Character Relational database update (tag {Y, N} N None
1 values ) flag.
Optional
If set, tag values will be
automatically sent to the relational
database.

Note 1:
The GROUPUID code is internally generated the first time a group is added to the Symphony Plus database (i.e. each time
a group database build follows a database initialization).
Add the GROUPUID field to the group database and left it initially blank when the group database file is filled in.
Following a group database build, a un-build operation must be executed in order for the GROUPUID field is filled.
If the GROUPUID is left blank, the group cannot be replaced later within the Symphony Plus database. An error message
will be issued for a duplicate group, since a new GROUPUID is generated. A S+ database initialization only allows replacing
(actually adding) the group.
Once assigned, the GROUPUID may be kept unchanged for the whole history of a group. The group name or the group
index may change, the GROUPUID is not affected. That allows you to keep track of a group during the history of the
application.
As a general rule, perform a database export immediately after a build operation in order to fill in a non-assigned GROUPUID
field within a group database file.

2.19.5 Trend Group - Archiving Types


The following table provides the list of all types of trend groups:
Note: The third column is the key to establish the additional parameters to fully configure the group. In the following pages,
specific sections exist to define each kind of group. Depending on the type of trend group refer to the section corresponding
to the kind.
Table 2-88: Trend Group – Archiving Types

Type Description Kind


REALTIM realtime group. realtime.
INST Group of instantaneous values. Historical.
AVERAGE Group of average values. Historical.
TOTAL Group of total values. Historical.
MIN Group of minimum values. Historical.
MAX Group of maximum values. Historical.
COUNT Counting group. Historical.
MONITOR Monitoring group. Historical.
RATIO Ratio group. Historical.
TRIP Post trip group. Post trip.

2.19.6 Generic Trend Group – Presentation Parameters


The fields listed in Table 2-89 provides information of presentation parameters of the trend group.
The following table provides the list of Generic Trend Group – Presentation Parameters:
Table 2-89: Generic Trend Group – Presentation Parameters

Range
Format Width
Name Description Default
Opt/Mnd
Parameter(s)

112 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

SWPROPSCAL Character Show scale properties on tag properties dialog {Y, N} Y


1 None
Optional
SWPROPDBFN Character Show database function properties on tag {Y, N} Y
1 properties dialog None
Optional
SWPROPCOL Character Show color property on tag properties dialog {Y, N} Y
1 None
Optional
SWPROPFILL Character Show filling property on tag properties dialog {Y, N} Y
1 None
Optional
INITMODE Integer Initial presentation (0 trend, 1 Digital Signal Trend, 0
1 2 bar) None
Optional
TIMESPAN Integer Default time range for group displaying.
5
Optional It applies to both realtime and historical trend 0
groups. It applies to both curve (continuous trace) None
and table (discrete values) group presentation
mode
.
The value must be greater than 10 seconds for
realtime trend groups and greater than the archive
frequency for historical trend groups.
SPANUNITS Integer Time units to qualify time span field. {0...5}
1 0
Optional None
LEGECFGSET Legend Configuration Set <string>
Name of the Legend configuration set <blank>
Definition name of Digital Signal Trend
LEGENDTYPE Legend type <string>
Following types are: <default>
• Default
• Top
• Bottom
• Left
• Right
• Grid Left
• Grid Right
NUMROLEGE Integer in Number of visible rows in legend 0
decimal None
Number of visible rows in normal and grid side
legend
NUMMROLEGE Integer in Number of minimum rows in grid side legend 0
decimal None
XMAXMAJOUR Integer in Maximum number of major tick count of X-Axis 0
decimal None
XMAXMINOR Integer in Maximum number of minor tick count of X-Axis 0
decimal between major tics None
YMAXMAJOUR Integer in Maximum number of major tick count of Y-Axis 0
decimal None
YMAXMINOR Integer in Maximum number of minor tick count of Y-Axis 0
decimal between major tics None
YPCTOVUP Integer in Percent of over upper range 0
decimal None
YPCTUNLO Integer in Percent of under lower range 0
decimal None
YAXISMODE Integer in Group trend Y-Axis percent mode 0
decimal None
SCVBTRANS Integer in Transparency (%, 0-100) of scooter value box 0
decimal None
SWATOFCFG Integer in Group trend Show amount of change between two 0
decimal scooters None
SWAVEOFCFG Group trend Show average rate of change/min
between 2 scooters
Character
XLSFILE Excel file name for reports <string>
64
2VAA000830-330 A 113
S+ Operations DB Reference DATABASE STRUCTURE

Optional <blank>
None
Character <string>
GRPVIEWER 64 Group viewer program <blank>
Optional None
LISTMODE Integer Group trend list mode mask <string>
8 <blank>
Optional None
TEXTCOL Group trend text color
GRIDCOL Group trend grid color
DRAWMODE Integer Group trend draw mode mask 0
8 None
Optional
BORDERCOL Group trend border color
FRAMECOL Group trend frame color
DISPFRQ Integer Default list display frequency. 0
5 None
Optional It is the time interval between two consecutive
values when a trend group is displayed as a table 0
(discrete values). None

It applies to both realtime and historical trend


groups.
The value must be greater than or equal to 1
second for realtime trends and equal to or a
multiple of the archive frequency for historical
trend groups.
DISPUNITS Integer Time units to qualify display frequency field. {0...5}
1 0
Optional None
CURVETYPE Integer Kind of representation for the trend curves. {0,1,2}
1 0
Optional Allowed values are: None

0 - default (interpolation),
1 - step,
2 - Interpolation.

2.19.7 Generic Trend Group – Link Parameters


The fields listed in Table 2-90 provides information on links to displays or additional trend groups for exploring purposes.
The following table provides the list of Generic Trend Group – Link Parameters:
Table 2-90: Generic Trend Group – Link Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
Primary display reference for Monitor
1.
Character
<string>
PRIMDISP 256 Name of a graphic display associated
<blank> None
Optional to the tag. This page can be directly
called from tag presentation displays
or from alarm pages.
Forward link among trend groups.
Character
<string>
FWDNAME 20 This field defines the name of another
<blank> [sznam]
Optional group chained as following to the
current one.
Backward link among trend groups.
Character
<string>
BWDNAME 20 This field defines the name of another
<blank> [sznam]
Optional group chained as previous to the
current one.

114 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

Escape page name.


Character
This field defines the name of an <string>
ESCNAME 20
escape display to leave the trend <blank> [sznam]
Optional
group subsystem. Typically, it is the
name of a plant or menu mimic.
Menu page name.
Character
<string>
ENTNAME 20
This field defines the name of a menu <blank> [sznam]
Optional
display.

2.19.8 Generic Trend Group – Log Parameters


The fields listed in Table 2-91 provides information of logs for operator actions and generic information.
The following table provides the list of Generic Trend Group – Log Parameters:
Table 2-91: Generic Trend Group – Log Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
PR_OPACT Character Print flag for operator action messages. {Y, N} N None
1
Optional If set, database modifications and all
other operator actions concerning this
group will be printed on the alarm
printer(s).
PR_INFO Character Print flag for information messages {Y, N} N None
1
Optional If set, information concerning this group
will be printed on the alarm printer(s).
SV_OPACT Character Save flag for operator actions. {Y, N} N None
1
Optional If set, database modifications and all
other operator actions concerning this
group will be logged to Operator Journal.
SV_INFO Character Save flag for information messages. {Y, N} N None
1
Optional If set, information concerning this group
will be logged to Operator Journal.

2.19.9 Generic Trend Group - Tag List Parameters


The fields listed in Table 2-92 provides information to identify tags that belongs to the trend group.
The following table provides the list of Generic Trend Group – Tag List Parameters:
Table 2-92: Generic Trend Group – Tag List Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
TAGFILE Character Specifications of an ASCII file containing the tag list. <string>
254 <blank>
Optional Refer to Note1 at the end of the table for more details.
TAGLIST Character List of tags belonging to the trend group. <string>
254 <blank> None
Optional Refer to Note1 at the end of the table for more details.
GRPTAGnn Character Tag Name <string>
50 <blank> None
Optional Where nn denotes 01 to 20.
GRPMINnn Integer Low scale 0
15 None
Optional Where nn denotes 01 to 20.
GRPMAXnn Integer High scale 0
15 None
Optional Where nn denotes 01 to 20.
GRPFNCnn Integer Database Function 0
15 None

2VAA000830-330 A 115
S+ Operations DB Reference DATABASE STRUCTURE

Optional Where nn denotes 01 to 20.


GRPINTnn Integer DB Function Interval 0
15 None
Optional Where nn denotes 01 to 20.
GRPUTSnn Integer DB Function Interval Units 0
1 None
Optional Where nn denotes 01 to 20.
GRPFILnn Character Filling {Y,N} N None
1
Optional Where nn denotes 01 to 20.
GRPCOLnn Character Color {Y,N} N None
1
Optional Where nn denotes 01 to 20.
NUMTAGS Integer Number of tags defined in the trend group. {0...60}
3 0 [grptag]
Optional If not specified, it is assumed to be the total number of
tags in the group as found in the tag list or tag file (see
next fields). If specified, it must be greater or equal to
the total number of defined tags. If greater, it keeps
space allocated to allow adding tags later on without
collected historical data are lost (i.e. the group
initialization is not required).

The field is not included within the fields of the on-line


Configuration tab.

Note 1:
There are two methods for specifying tags belonging to a trend group. Either an external tag file or an internal tag list can
be used.
Tag list
The list of tags is directly included in the trend group database file. A field defines all tags.
The tag list is a sequence of tag definitions (a semicolon is the separator between tag definitions). Each definition concerns
a tag and is a set of three items: the tag name, the low and the high limits for trend format presentations (a comma is the
separator between items).
An example of tag list is the following:
TAG-1, 0, 100; TAG-2, -10, 10; TAG-3, 0, 200;
This method can be used when the tag list does not exceed the maximum of 254 characters (upper limit for Dbase III/IV
fields).
The on-line configuration provides a dialog window to enter the tag list. Select the entry in the tag list and then type the tag
name and the display limits in the fields of the dialog.
Tag file
The list of tags is contained in an ASCII file. A field in the trend group database file allows definition of the file name. The
tag file must be located in the same folder hosting the trend group database file: typically this folder is S+\Config\Group.
Since the trend group name is referenced in a tag file, a unique tag file for all groups or a tag file for each group may be
used. The syntax of the tag list is the same defined above.
This method must be used when the total number of characters for the tag list definition is greater than 254.
Below the definition of two tag lists is shown.
$BEGIN_GROUP GROUP-01
PV-TAG-01, 0, 100; PV-TAG-02, 0, 110; PV-TAG-03, 0, 120; PV-TAG-04, 0, 130; PV-TAG-05, 0, 140; DI-TAG-01, 0, 1;
DI-TAG-02, 0, 2; DI-TAG-03, 0, 3;
$END_GROUP
$BEGIN_GROUP GROUP-02
PV-CAL-01, 0, 100;PV-CAL-02, 0, 100; PV-CAL-03, 0, 6000; DI-CAL-01, 0, 1;
$END_GROUP
Each tag list is enclosed between the group identification keywords $BEGIN_GROUP and $END_GROUP. The group name
qualifies the tag list.

116 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

When un-building trend groups the output may be directed to the database (DBF) file and to the tag list file (TXT) or just to
the database file depending on the current group configuration of Symphony Plus.
If a group configuration refers to a tag list file, the un-build process will update the database file and the tag list file.
If a group configuration defines tags in the tag list (without any reference to a tag list file), the un-build process will update
the database file only.
If a group configuration defines the tags in the tag list, a limit of 254 characters in the output field of the database file may
cause truncation of the tag list.

2.19.10 Generic Trend Group - Network Parameters


The fields listed in Table 2-93 provides information of Symphony Plus network communication subsystem.
They are used when multiple Symphony Plus in a multi master architecture exchange data (values and configurations). All
fields are optional.
The following table provides the list of Generic Trend Group – Network Parameters:
Table 2-93: Generic Trend Group – Network Parameters

Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
NETDSTCLAS Character Network Distribution Class <string>
50 <blank>
Optional

2.19.11 Realtime Trend Group Definition


Realtime trend groups are fully defined by the fields listed in the Generic Trend Group section. Refer to the Generic Trend
Group Definition section for more details.

2.19.12 History Group Definition


History groups requires additional parameters to be defined. The following subsections list parameters specifically related
to historical groups. Refer to the Generic Trend Group Definition section for details on the basic parameter definitions.

2.19.13 History Trend Group - History Parameters (Archiving).


The following table provides the list of archive and size in an historical trend group:

Table 2-94: History Trend Group – History Parameters (Archiving)

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
ARCHFRQ Integer Archiving frequency.
5
Mandatory The value defines the time interval between two 0
consecutive values stored in a historical group. Data None
are processed and archived with the frequency
defined in this field.

It applies to historical trend groups only.


ARCHUNITS Integer Time units to qualify archiving frequency field. {0...5}
1 0
Mandatory None
OFFSET Integer Archiving offset.
5
Mandatory This field defines a delay added to processing time of 0
the group. None

Refer to the OFFSUNITS field for more details.

Archiving offset must always be less than archiving


period.

2VAA000830-330 A 117
S+ Operations DB Reference DATABASE STRUCTURE

Refer to Note1 at the end of the table for more


details.
OFFSUNITS Integer Time units to qualify offset field. {0...5}
1 0
Mandatory None
TOTSAMPLES Integer Total number of elements kept archived. The value
9 defines the number of elements (that is, the size) of a
Mandatory trend group file. The total refers to each tag of the 0
trend group. None

Together the archiving frequency, this value defines


the total time span of a historical trend group. For
example, 1 hour archive frequency and 240 elements
define a total time span of 240 hours (10 days).

It applies to historical trend groups only.


ARCHINHTAG Character Archiving inhibit tag name. <string>
20 <blank>
Optional If defined, this tag allows inhibiting data archiving [sznam]
when it leaves its normal state. Data archiving
resumes when the inhibiting tag returns to the normal
state.

Note 1:
The archiving offset is applied to the base time of the trend group, that is the greatest integer multiple of the archiving period
less or equal than archiving period itself (second zero if period is seconds, minute zero if period is minutes, midnight if period
is hours). For instance, to have a group archiving every 30 minutes at minute 5, the offset must be 5 minutes.

2.19.14 History Trend Group - History Parameters (Sampling)


The parameters listed in Table 2-95 provides information when the archive type is TOTAL, AVERAGE, MIN or MAX. This
type of archiving only processes a set of samples to archive a computed value. Samples are collected within the archiving
period.
The following table provides the list of History Trend Group – History Parameters (Sampling):

Table 2-95: History Trend Group – History Parameters (Sampling):

Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
SAMPLFRQ Integer Sampling frequency.
5
Mandatory The value is the time interval between two consecutive 0
samples gathered to store a computed value in a trend None
group file.

This field applies when the historical trend group needs


to collect samples in order to store processed data (e.g
average value).

The value must be less than archiving frequency.


SAMPLUNITS Integer Time units to qualify sampling frequency field. {0...5}
1 0
Mandatory None
BADSAMPLES Integer Percent of allowed bad samples. {0...99}
2 0
Optional If greater than 0, a datum to be archived is marked bad None
when the percentage of bad samples among collected
samples is greater than the defined percent value.

The three parameters above concerning sampling must be defined only when the archive type is TOTAL, AVERAGE, MIN
or MAX. The first two are mandatory in such a case only.

118 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

2.19.15 History Trend Group - History Parameters (Deriving)


The two parameters listed in Table 2-96 retrieves data for archiving from another historical group. Data archiving on the
input group must grant data availability in order the derived group can retrieve data.
Deriving a group from another allows producing long term historical archives. For example, a daily archive may be derived
from an hourly archive; a yearly archive may be derived from a monthly archive.
The following table provides the list of History Trend Group - History Parameters (Deriving):
Table 2-96: History Trend Group – History Parameters (Deriving)

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
DERIVED Character Derived group flag. {Y,N} N None
1
Optional This flag states the current group is a derived one.
Another group defined by the field below is the source of
information.
INPGROUP Character Name of the input group. <string>
20 <blank> [sznam]
Optional If the derived group flag is set, this field specifies the
name of the source group.

2.19.16 History Trend Group - Time Function Parameters


The parameters listed in the Table 2-97 provides information if the archive type is COUNT, MONITOR or RATIO.
The following table provides the list of History Trend Group – Time Function Parameters:
Table 2-97: History Trend Group – Time Function Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
ONVALUE Character Monitor flag for value of tags. {Y, N} N None
1
Optional If the flag is set, the value of each tag is monitored
and compared to threshold limits.

For a MONITOR or RATIO group, the historical


group subsystem archives the absolute or relative
time (within the archive frequency) the tag assumes
a value within the threshold limits.

For a COUNT group, the number of times the value


of a tag enters within the threshold limits is archived.
MONQUALITY Character Monitor flag for quality of tags. {Y, N} N None
1
Optional If the flag is set, the quality of each tag is monitored
and compared to the quality mask.

For a MONITOR or RATIO group, the historical


group subsystem archives the absolute or relative
time (within the archive frequency) the tag assumes
a quality matching the quality mask.

For a COUNT group, the number of times the quality


of a tag matches the quality mask is archived.
MONREVERSE Character Reverse monitoring flag. {Y, N} N None
1
Optional Reverse the counting or monitoring rules defined by
the couple of fields above. Values or qualities
outside threshold limits are considered.
MONUNITS Character Time units for monitoring. {0...5}
1 0
Optional This field defines the interval used as time basis for None
monitoring evaluation.

2VAA000830-330 A 119
S+ Operations DB Reference DATABASE STRUCTURE

MONFACT Integer Monitor factor. {1, 10, 100,


2 1000}
Optional This field applies to RATIO groups only. 1
None
TARGETLOW Integer Low threshold limit for value monitoring.
10
Optional 0
None
TARGETHIGH Integer High threshold limit for value monitoring.
10
Optional 0
None
TARGETQUAL Integer Bit mask for quality monitoring. Sequence {0, 1}
32 <blank> None
Optional This bit mask must match the bit mask organization
of quality bits.

2.19.17 History Trend Group – Post Trip Log Parameters


The following sections list parameters related to post trip groups. Refer to the Realtime Trend Group Definition section for
the basic parameter definitions.
Post trip groups activation is set during the configuration of the tag database. A field in the tag database allows defining the
number of post trip group to be activated. Refer to tag database configuration for details.
The following table provides the list of History Trend Group – Post Trip Log Parameters:
Table 2-98: History Trend Group – Post Trip Log Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
PRETIME Integer Pre- trip time. {0...99999}
5 0
Optional It defines the amount of time to be taken into account None
before trip. Exception reports found in this time interval
are retrieved from playback and archived as post trip
data.
PREUNITS Integer Time units to qualify pre trip time field. {0...5}
1 0
Optional None
POSTTIME Integer Post trip time. {0...99999}
5 0
Optional It defines the amount of time to be taken into account None
after trip. Exception reports incoming during this time
interval are gathered and archived as post trip data.

Refer to Note1 at the end of the table for more details.


POSTUNITS Integer Time units to qualify post trip time field. {0...5}
1 0
Optional None
TRIPCOUNT Character Trip counter tag name. <string>
20 <blank> [sznam]
Optional The tag defined here keeps track of trips. Each time a
trip takes place, the counter increments.
TRIPCLOS Integer Close trip flag. {Y,N} N None
1
Optional If set, trip archiving ends when triggering tag returns to
normal condition (before post trip time elapses).
Otherwise, post trip archiving ends when post trip time
elapses.

Refer to Note1 at the end of the table for more details.

Note 1:
The post trip time defines the post trip duration also. In order to gather incoming exception reports, the post trip archiving is
kept active until the post trip time elapses.

120 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

For example, a post trip archiving will last 5 minutes if post trip time is set to 5 minutes. If the close trip flag is set, the post
trip archiving will last at least 5 minutes. It will last less than 5 minutes if the triggering tag will return to normal before 5
minutes elapses.

2.20 Report Database


The report definition database is generated on a Personal Computer using packages like DBase III/IV or EXCEL. Then, it
must be copied to the computer running the application Symphony Plus (if it is a different one) for final import.
The report is imported submitting the database file to the database builder. During this phase, the field contents of the input
file will be used to compile Symphony Plus internal database structures following the directives given by a field assignment
cross-reference file processed by DBXRF builder program.
The database builder performs export operations, creating a target database file (DBase III/IV format) containing all items
as they are currently defined in the Symphony Plus internal database. If Symphony Plus target database does not exist, the
builder processor creates it using the whole Symphony Plus database structure. Alternatively, a target database file may be
specified as template. In this case, the builder processor updates the target database file handling only the fields specified
in it. The target database file may have just a single report or may be a full or partial database file. It must contain all (and
only) fields to be exported.

2.20.1 Report Definition


The following sections defines the parameters required to configure reports within Symphony Plus (i.e. to notify Symphony
Plus report exists), to schedule them at specified time intervals, to link the report to the Excel work-sheet template and to
keep controlled the disk allocation (limiting the number or the age of reports stored on the hard disk).
The following section introduces the functions to interface Symphony Plus databases from Excel work-sheets.

2.20.2 Report - General Parameters


The fields listed in Table 2-99 provides information on name and additional parameters used to identify the report. A field
(report index) allows the report identification within other databases (e.g. in the tag database to define the report activated
on event). Additional fields are listed in the specific sections following this one.
The following table provides the list of Report – General Parameters:
Table 2-99: Report – General Parameters

Format Width Range Default


Name Description
Opt/Mnd Parameter(s)
REPINDEX Integer Report index. {0...50}
6 0 [nmrpts]
Optional This field identifies the report by number. It must be
unique for each report in the database. If omitted or
zero (blank), the first vacant index will be allocated.
REPNAME Character Report name. <string>
20 <blank> [sznam]
Mandatory This field identifies the report by name. It must be
unique for each report in the database.
REPDESC Character Report description. <string>
64 <blank> [szdesc]
Mandatory
REPINHTAG Character Report inhibit tag name. <string>
20 <blank> [sznam]
Optional Name of a tag that, while in alarm, will disable the
generation of the report. If the field is blank, no report
inhibit is defined.
SRCNODMSn Character Source node mask (n) Sequence {Y, N}
16 16*N
Optional SRCNODMSK is the alias name for SRCNODMS1 None
field

n = 1 to 4

DESTVALMSn Character Destination node mask (values) (n) Sequence {Y, N}


16 16*N
Optional DESTVALMSK is the alias name for DESTVALMS1 None
field

n= 1 to 4

2VAA000830-330 A 121
S+ Operations DB Reference DATABASE STRUCTURE

CNFNODMSn Character Configuration node mask (n) {Y,N}N None


16
Optional CNFNODMSK is the alias name for CNFNODMS1

n= 1 to 4

2.20.3 Report - Activation Parameters


The following table provides the list of fields that define scheduling or activation parameters used to generate the report:
Table 2-100: Report – Activation Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
SCHDFRQ Integer Schedule frequency. {1...99999}
5 0
Optional If greater than 0, the field allows automatically None
generating a report.

The minimum allowed value is 1 minute


(SCHDFRQ=1 and SCHDUNITS=1).

A value of 1 second (SCHDFRQ=1 and


SCHDUNITS=0) means no automatic scheduling and
may be used when defining a manually activated or a
scheduled on event report.
SCHDUNITS Integer Time unit to qualify scheduling frequency. {0...3}
1 0
Optional None
OFFSET Integer Report offset. {0...99999}
5 0
Optional This field defines a delay added to the scheduling None
time of report. See the OFFSUNITS field also. Report
offset must always be less than report period.

Refer to Note 1 at the end of the table for more


details.
OFFSUNITS Integer Time unit to qualify report offset. {0...3}
1 0
Optional None
ACTONEVENT Character Activate report flag on event. {Y,N} N None
1
Optional The tag whose REP_NUM field refers to this report
will activate reporting. If set, the field makes the
report eligible for activation when the activating tag
goes in an alarm condition.
Note 1:
The report offset is applied to the base time of the report, that is the greatest integer multiple of the scheduling period less
or equal than scheduling period itself (second zero if period is seconds, minute zero if period is minutes, midnight if period
is hours). For instance, to have a report scheduled every 30 minutes at minute 5, the offset must be 5 minutes.

2.20.4 Report - Archiving Parameters


The fields listed in Table 2-101 provides information of additional parameters used to archive report on the hard disk and to
control disk space allocation.
A parameter allows selecting to archive generated reports on the hard disk.
Two parameters, meaningful when archiving is selected, allow deleting from the hard disk reports older than a latency time
or exceeding a maximum limit. Both latency time and maximum limit can be defined for the same report. It is strongly
suggested to define latency time and maximum number of reports (at least one of them) when the disk archiving is selected.
The following table provides the list of Report – Archiving Parameters:
Table 2-101: Report – Archiving Parameters

122 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
ARCHIVE Character Disk archiving flag. {Y,N} Y None
1
Optional When a report is generated from its template, it is
stored on the hard disk. Each report has a its own
folder in the
\S+\Reports folder.
MAXLATENCY Integer Maximum latency time (days).
5
Optional Reports older than the latency days are deleted from 0
the hard disk. None
MAXREPORTS Integer Maximum number of reports.
4
Optional The oldest reports exceeding the allowed maximum 0
are deleted from the hard disk. None
SAVEHTM Character Html file archiving flag. {Y,N} Y None
1
Optional If set, the report is saved in an html format file.

2.20.5 Report - Printing Parameters


The fields listed in Table 2-102 provides information of printing the report:
The following table provides the list of Report – Printing Parameters:
Table 2-102: Report – Printing Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
PRINT Character Print flag. {Y,N} N None
1
Optional When a report is generated from its template, it is printed
on the documentation printer.
PRINTER Character Printer name. <string>
20 <blank> [sznam]
Optional Name of the documentation printer.

2.20.6 Report - Excel Parameters


The fields listed in Table 2-103 provides information of Excel worksheet parameters. They allow linking the report definition
and the report Excel template.
In the EXCEL file, the Automatic option needs to be selected; this option can be selected in the window activated by Tools
> Options > Calculation.

Figure 2-1: Report – Excel Parameters

The following table provides the list of Report – Excel Parameters:


Table 2-103: Report – Excel Parameters

Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
XLSDATCELL Character Date cell reference. <string>
10 <blank>
Optional The field is a reference to a cell within the Excel template None
file. The syntax is n!Am where n is the sheet number and

2VAA000830-330 A 123
S+ Operations DB Reference DATABASE STRUCTURE

Am is the cell reference (e.g. 1!M3 is a reference to cell M3


of sheet 1).

The cell in the Excel file must be of type General or


Numeric and it will contain the starting date used when the
report is manually requested. It can be referenced using
the GetSecFromDate routine (refer to the next section) to
provide a date in the internal Symphony Plus format.
XLSFILE Character Excel work-sheet file name. <string>
64 <blank>
Mandatory The field refers to the Excel template file where the [szdesc]
structure of the report is implemented.

The Excel work-sheet must be located within the


\S+\Config\Reports folder.
XLSSHEET Integer Excel sheet index. {1...99)
2 0
Mandatory Excel work-sheet (report template) may contain multiple None
sheets. From the reporting point of view each sheet must
be referenced as a report. In other words, a report must
exist for each sheet. Instead, a multiple page work-sheet is
considered as a single report.

2.20.7 Report - SOE Parameters


The fields listed in Table 2-104 provides information on additional parameters used to link the report to a Sequence of Event.
That is, these parameters allow defining sequence of event reports based on Excel work-sheets.
The following table provides the list of Report – SOE Parameters:
Table 2-104: Report – SOE Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
SOETYPE Integer Type of sequence of events. The value of this field can {0, 1}
1 be: 0
Optional None
0 - Standard SOE
1 - Summary SOE
SOEDEVICE Integer Sequence of event device. {0, 1, 2}
2 0 [mxsedv]
Optional Number of the SER device generating the sequence of
events.

2.20.8 Excel Work-Sheet


A report is generated periodically based on the scheduling parameters. A template work-sheet created by Excel is the cell
matrix used to generate the actual report.

2.20.9 Public and Themodynamic Functions


A set of public functions and thermodynamic functions are listed in the following sections. Refer to Microsoft manuals for
details on worksheet configuration. Here, only the public and thermodynamic functions and their syntax are introduced.
For each function, the syntax lists the input parameters. The syntax of a generic function having a total of n input parameters
is shown below.
[<return> =]
<function name> (Input variables
[1] <parameter 1>, [2]<parameter 2>,
End Variables)
......................
[n] <parameter n>,
Each parameter is numbered to allow easy checks in the cell formulas. The “Input Variables” string opens the declaration of
input variables to the function. The “End Variables” string closes the declarations.
The ordering number and the declaration strings must not be typed in the function call.
124 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

All these functions may be called both from the Excel work-sheet and the VBA Excel code (macro Excel). These functions
are for use with Microsoft Excel only.
In the syntax of functions, square brackets enclose the assignment valid for VBA Excel code only.

2.20.10 Libraries of Functions


The following sections define the functions available with the Symphony Plus software to provide an additional interface to
the Microsoft Excel work-sheet package. The libraries of functions can be included within each report or can be added to
Excel as Add-In. Refer to the Microsoft Excel manual for details on Add-In and the inclusion of library modules within Excel.
The public library is named Tnt.xla and is located within the \S+\Config\Reports. It includes all the public functions listed in
the following description.
The thermodynamic library is named Steamlib.xla and is located within the
\S+\Config\Calc. It includes steam functions, gas property functions, sea water functions, wet air functions and fuel
combustion functions as listed in the following description.

2.20.11 Reports - Public Functions


A set of public functions allows interacting with Symphony Plus in order to retrieve data for reporting. They include function
to interface the tag configuration database, the realtime database, the playback and the history groups. Time manipulation
functions are included also.
The following table provides the list of Report – Public Functions:
Table 2-105: Report – Public Functions

Function Description Syntax


BLKDEALLOC The function de-allocates data structures previously
allocated for data retrieving from historical archives
or playback. BLKDEALLOC (Input
variables End Variables)
The subroutine can be called from VBA Excel code
only.
FPBLKQUAL The function returns the quality mask of a tag of a [<long> =] FPBLKQUAL
historical group. (Input variables
On error, a null quality is returned. <group name>,
<tag name>,
<retrieving time> End
Variables)
FPBLKQUALTIME The function retrieves the quality of a tag from a data [<long> =]
packet (as returned by the Fpblksample function) of FPBLKQUALTIME
an historical group. (Input variables
<retrieving time> End
On error, a null quality is returned. Variables)
FPBLKSAMPLE The function returns a data packet of a tag within a [<long> =]
historical group. FPBLKSAMPLE
(Input variables
The returned value, the number of found records, <group name>,
can be used by the Fpblkqualtime, Fpblkvaldtime <tag name>,
and Fpfromblkvald functions. <start time>,
<end time>,
Depending on the sign of the number of records <number of records>
different searches are performed: End Variables)

> 0 - The function searches forward beginning from


start time,
= 0 - The function retrieves all records within the time
interval,
< 0 - The function searches backward beginning from
the end time.

If the absolute value is not null, only the first


<number of records> (or less) are returned.
FPBLKVALD The function retrieves the value of a tag within a [<double> =]
historical group. FPBLKVALD
(Input variables
On error, a null value is returned. <group name>,
<tag name>,

2VAA000830-330 A 125
S+ Operations DB Reference DATABASE STRUCTURE

<retrieving time> End


Variables)
FPBLKVALDTIME The function retrieves the value of a tag from a data [<double> =]
packet (as returned by the Fpblksample function) of FPBLKVALDTIME
an historical group. (Input variables
<retrieving time> End
On error, null value is returned. Variables)
FPFROMBLKVALD The function retrieves the value of a tag from a data [<double> =]
packet (as returned by Fpblksample function) of an FPFROMBLKVALD
historical group. (Input variables
<record index> End
The record index is a number from 1 to N where N is Variables)
the number of records returned by the Fpblksample
function.

On error, a null value is returned.


FPGET The function retrieves a tag value from the realtime [<string> =] FPGET
database. (Input variables
<tag name>,
On error, a null value is returned. <force recalculation>
End Variables)
Refer to Note 1 at the end of table for more details.
FPGETD The function retrieves a tag value from the realtime [<double> =] FPGETD
database. (Input variables
<tag name>,
On error, a null value is returned. <force recalculation>
End Variables)
Refer to Note 1 at the end of table for more details.
FPHGETD The function retrieves the value of a tag from the [<double> =] FPHGETD
playback archive. (Input variables
<tag name>,
On error, a null value is returned. <retrieving time> End
Variables)
FPHXGETVAL The function retrieves the value of a tag from a data [<double/string/date> =]
packet (as returned by Fphxnumval function) of the FPHXGETVAL
playback archive. (Input variables
<record index>,
The record index is a number from 1 to N where N is <returned type> End
the number of records returned by the Fphxnumval Variables)
function.

The record type is represented by a character:

d - Return a double precision value,


s - Return a string format value
t - Return the time (in string format) when the value
was collected.
FPHXNUMVAL The function retrieves records of a tag within the [<long> =]
playback archive. FPHXNUMVAL
(Input variables
The returned value, the number of found records, <tag name>,
may be used by the Fphxgetval function. <start time>,
<end time>,
Depending on the sign of the number of records <number of records>
different searches are performed: End Variables)

> 0 - The function searches forward beginning from


start time,
= 0 - The function retrieves all records within the time
interval,
< 0 - The function searches backward beginning from
the end time.

If the absolute value is not null, only the first


<number of records> (or less) are returned.
GETAPMSTIME The function translates a standard date and time in [<long> =]
the internal S+ format. GETAPMSTIME
(Input variables

126 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

The date and time is a string in the format <date and time> End
DD/MM/YY hh:mm:ss. Variables)

The returned value, in the internal Symphony Plus


date and time format, is the number of seconds since
January 1, 1991.
GETDATEFROMSEC The function translates Symphony Plus date and [<string> =]
time in the Excel date and time format. GETDATEFROMSEC
(Input variables
The input parameter, in the internal Symphony Plus <S+ date and time>,
date and time format, is the number of seconds since <force recalculation>
January 1, 1991. End Variables)

If the input parameter is not defined, the current


Symphony Plus date and time is converted.

The returned date and time is a string in the format


DD/MM/YY hh:mm:ss.

Refer to Note 1 at the end of table for more details.


GETSECFROMDATE The function translates the current date and time or [<long> =]
the date entered for manual forced reporting in the GETSECFROMDATE
Symphony Plus format. (Input variables
<Xls date cell>
The input date is defined by a reference to a cell in <force recalculation>
the work-sheet. End Variables)

If defined, the input parameter references a cell in


the work-sheet representing a date and time in the
Excel format.

If the input parameter is not defined, the current date


and time is converted.

The returned date and time is formatted according to


the format of the cell containing the function
reference.

Refer to Note1 at the end of table for more details.


TAGINFO The function retrieves tag information from the [<string> =] TAGINFO
configuration database based on info type (Input variables
parameter. <tag name>,
<tag info>,
On error, a null info is returned. <force recalculation>
End Variables)
Refer the table TagInfo Types within the Section 1 of
the S+ Application Program Interface manual for a
list of tag information codes.

Refer to Note 1 at the end of table for more details.


TAGREAD The function retrieves the tag value from the realtime [<double> =] TAGREAD
database. (Input variables
<tag name>,
On error, a null value is returned. <force recalculation>
End Variables)
Refer to Note 1 at the end of table for more details.
TAGREADBINARY The function retrieves the tag value from the realtime [<binary string> =]
database. TAGREADBINARY
(Input variables
On error, a null value is returned. <tag name>,
<force recalculation>
Refer to Note 1 at the end of table for more details. End Variables)
TAGREADVAL The function retrieves the tag value from the realtime [<double> =]
database. TAGREADBINARY
(Input variables
On error, a null value is returned. <tag name>,
<force recalculation>
Refer to Note 1 at the end of table for more details. End Variables)

2VAA000830-330 A 127
S+ Operations DB Reference DATABASE STRUCTURE

Note: The force recalculation parameter is an optional date field. If used, it must be set to NOW() and forces recalculation
of value each time the cell is referenced.

2.20.12 Report - Steam Functions


The following table provides the list of steam functions of calculations that are referenced within Excel work- sheets:
Table 2-106: Report Steam Functions

Function Description Syntax


CP_at_TP Specific heat as function of temperature and pressure. [<specific heat> =]
CP_at_TP
(Input variables
<temperature>,
<pressure> End
Variables)
DV_at_TP Water viscosity as function of temperature and pressure. [<viscosity> =] DV_at_TP
(Input variables
<temperature>,
<pressure> End
Variables)
H_at_PS Enthalpy, relative to steam and water, as function of pressure [<enthalpy> =] H_at_PS
and entropy. (Input variables
<pressure>,
<entropy>
End Variables)
H_at_TP Enthalpy, relative to steam and water, as function of [<enthalpy> =] H_at_TP
temperature and pressure. (Input variables
<temperature>,
<pressure> End
Variables)
K_at_TP Water conducibility, relative to steam and water, as function of [<conducibility> =]
temperature and pressure. K_at_TP
(Input variables
<temperature>,
<pressure> End
Variables)
PSAT_at_T Pressure of saturation as function of the temperature. [<sat. pressure> =]
PSAT_at_T
(Input variables
<temperature> End
Variables)
S_at_PH Entropy, relative to steam and water, as function of pressure [<entropy> =] S_at_PH
and enthalpy. (Input variables
<pressure>,
<enthalpy> End
Variables)
S_at_TP Entropy, relative to steam and water, as function of [<entropy> =] S_at_TP
temperature and pressure. (Input variables
<temperature>,
<pressure> End
Variables)
T_at_PH Temperature, relative to steam and water, as function of [<temperature> =]
pressure and enthalpy. T_at_PH
(Input variables
<pressure>,
<enthalpy> End
Variables)
T_at_PS Temperature, relative to steam and water, as function of [<temperature> =]
pressure and entropy. T_at_PS
(Input variables
<pressure>,
<entropy>
End Variables)
TSAT_at_P Temperature of saturation, given a pressure. [<saturation temp.> =]
TSAT_at_P
(<pressure>)
V_at_TP Specific volume, relative to steam and water, as function of [<specific volume> =]
temperature and pressure. V_at_TP

128 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

(Input variables
<temperature>,
<pressure> End
Variables)

2.20.13 Report - Gas Property Functions


The following table provides the list of gas property functions of calculations that can be used and referenced within Excel
work-sheets:
Table 2-107: Report – Gas Property Functions

Function Description Syntax


CP_GAS Specific heat of a gas as function of the temperature. [<specific heat> =] CP_GAS
(Input variables
<temperature>,
<gas index> End Variables)
H_GAS Enthalpy of a gas as function of the temperature. [<enthalpy> =] H_GAS
(Input variables
<temperature>,
<gas index> End Variables)
M_GAS Molecular weight of a gas. [<molecular weight> =] M_GAS
(Input variables
<gas index> End Variables)
S_GAS Entropy of a gas as function of temperature and pressure. [<entropy> =] S_GAS
(Input variables
<temperature>,
<pressure>,
<gas index> End Variables)

2.20.14 Report - Sea Water Function


The following table provides the list of Sea water function of calculations that can be used and referenced within Excel work-
sheets:
Table 2-108: Report – Sea Water Function

Function Description Syntax


SEAW Property of the sea water as function of the [<property> =] SEAW
temperature and salt concentration. The property to be (Input variables
returned is specified as third parameter. <temperature>,
<salt concentration>,
<function index> End Variables)

2.20.15 Report - Fuel Combustion Functions based on Flue Gas


The following tables: Table 2-109 and Table 2-110 provides information of fuel combustion functions of calculations that are
used and referenced within Excel worksheets:
Table 2-109: Report – Fuel Combustion Functions based on Flue Gas

Function Description Syntax


CP_FGAS_T Specific heat of flue gas as function of the temperature and [<specific heat> =] CP_FGAS_T
the flue gas composition. (Input variables
<temperature>,
<gas index>,
<% CO2>,
<% O2>,
<% CO>,
<% SO2>,
<% H2O>,
<% AR>
End Variables)
H_FGAS_T Enthalpy of flue gas as function of the temperature and the [<enthalpy> =] H_FGAS_T (Input
flue gas composition. variables
<temperature>,
<gas index>,
<% CO2>,
<% O2>,
<% CO>,
2VAA000830-330 A 129
S+ Operations DB Reference DATABASE STRUCTURE

<% SO2>,
<% H2O>,
<% AR>
End Variables)
S_FGAS_TP Entropy of flue gas as function of the temperature, the [<entropy> =] S_FGAS_TP (Input
pressure and the flue gas composition. variables
<temperature>,
<pressure>,
<gas index>,
<% CO2>,
<% O2>,
<% CO>,
<% SO2>,
<% H2O>,
<% AR>
End Variables)
T_FGAS_H Temperature of flue gas as function of the enthalpy and the [<temperature> =] T_FGAS_H
flue gas composition. (Input variables
<enthalpy>,
<gas index>,
<% CO2>,
<% O2>,
<% CO>,
<% SO2>,
<% H2O>,
<% AR>
End Variables)
T_FGAS_PS Temperature of flue gas as function of the pressure, the [<temperature> =] T_FGAS_PS (Input
entropy and the flue gas composition. variables
<pressure>,
<entropy>,
<gas index>,
<% CO2>,
<% O2>,
<% CO>,
<% SO2>,
<% H2O>,
<% AR>
End Variables)

2.20.16 Report - Combustion Functions based on Fuel Characteristics


The following table provides the list of Report – Combustion Functions based on Fuel Characteristics:
Table 2-110: Report – Combustion Functions based on Fuel Characteristics

Function Description Syntax


AIR_MIN Stechiometric air in the fuel as function of the fuel [<air in fuel> =] AIR_MIN
composition. (Input variables
<% C>,
<% H>,
<% S>,
<% O>
End Variables)
H_FCOMB_T Enthalpy of air and fuel as function of the temperature and [<enthalpy> =] H_FCOMB_T (Input
the fuel composition. variables
<temperature>,
<% C>,
<% H>,
<% S>,
<% O>,
<% N>,
<dry air/fuel> End Variables)
CP_FCOMB_T Specific heat of air and fuel as function of the temperature [<specific heat> =] CP_FCOMB_T
and the fuel composition. (Input variables
<temperature>,
<% C>,
<% H>,
<% S>,

130 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

<% O>,
<% N>,
<dry air/fuel> End Variables)
S_FCOMB_TP Entropy of air and fuel as function of the temperature, the [<entropy> =] S_FCOMB_T (Input
pressure and the fuel composition. variables
<temperature>,
<pressure>,
<% C>,
<% H>,
<% S>,
<% O>,
<% N>,
<dry air/fuel> End Variables)
T_FCOMB_H Temperature of air and fuel as function of the enthalpy and [<temperature> =] T_FCOMB_H
the fuel composition. (Input variables
<enthalpy>,
<% C>,
<% H>,
<% S>,
<% O>,
<% N>,
<dry air/fuel> End Variables)
T_FCOMB_PS Temperature of air and fuel as function of the pressure, [temperature=] T_FCOMB_PS (Input
entropy and the fuel composition. variables
<pressure>,
<entropy>,
<% C>,
<% H>,
<% S>,
<% O>,
<% N>,
<dry air/fuel> End Variables)

2.20.17 Report - Wet Air Functions


The following table provides the list of wet air functions of calculations that can be used and referenced within Excel work-
sheets:
Table 2-111: Report – Wet Air Functions

Function Description Syntax


CP_AIR_T Specific heat of wet air as function of the temperature and [<specific heat> =] CP_AIR_T
absolute humidity. (Input variables
<temperature>,
<absolute humidity> End
Variables)
H_AIR_T Enthalpy of wet air as function of the temperature and absolute [<enthalpy> =] H_AIR_T
humidity. (Input variables
<temperature>,
<absolute humidity> End
Variables)
S_AIR_TP Entropy of wet air as function of the temperature, pressure and [<entropy> =] S_AIR_TP
absolute (Input variables
<temperature>,
<pressure>,
<absolute humidity> End
Variables)
T_AIR_H Temperature of wet air as function of the enthalpy and absolute [<temperature> =] T_AIR_H
humidity. (Input variables
<enthalpy>,
<absolute humidity> End
Variables)
T_AIR_PS Temperature of wet air as function of the pressure, entropy and [<temperature> =] T_AIR_PS
absolute humidity. (Input variables
<pressure>,
<entropy>,
<absolute humidity> End
Variables)

2VAA000830-330 A 131
S+ Operations DB Reference DATABASE STRUCTURE

WHY Percentage of humidity per kg of dry air as function of dry bulb [<humidity> =] WHY
temperature, atmospheric pressure and measured relative (Input variables
humidity. <dry bulb temp.>,
<atmospheric press.>,
<relative humidity> End
Variables)

2.21 Menu and Tool-bars

2.21.1 Outline
The Menu and Tool-bars definition file provides the system, the information for configuring various menus and tool-bars
(buttons) implemented in the man machine interface.

2.21.2 Menu and Tool-bar Database


The menu and tool-bar database is generated on a Personal Computer using packages like DBase III/IV or EXCEL. Then,
it must be copied to the computer running the Symphony Plus application (if it is a different one) for final import.
Menu and tool-bar database is imported submitting the database file to the database builder. During this phase, the field
contents of the input file is used to compile Symphony Plus internal database structures following the directives given by a
field assignment cross-reference file, processed by DBXRF builder program.
The database builder performs export operations, creating a target database file (DBase III/IV format) containing all items
as they are currently defined in the Symphony Plus internal database.
If a target database does not exist, the builder processor creates it using the whole Symphony Plus database structure.
Alternatively, a target database file may be specified as template. In this case, the builder processor updates the target
database file handling only the fields specified in it.
The target database file may have just a single node or may be a full or partial database file. It must contain all (and only)
fields to be exported.

2.21.3 Menu and Tool-bar Definitions


The following table provides the list of parameters to customize menu, tool-bar, and other graphic elements. There are both
mandatory and optional parameters.

Table 2-112: Menu and Tool-bar Definitions

Configuration
Parameters Description
Tab

General Index Index defines the number assigned to the menu label

Name It defines the name of menu or toolbar to be stored in


database.

Menu label Menu label defines the name used to identify the menu
item.
• If the element is a button in a toolbar, then label is
used as a Tool-tip text.
• If the element is Menu item, then label is the text of
the item in the Menu.
• If the element is in a Display Tree, the Name is the
text of the leaf in the Display Tree.
(For more information refer section 2.16.4)

Description Description defines the nature of functionality of menu or


toolbar

Button type Button type identifies the element as a Menu, a Toolbar


(BUTTON), and a Display Tree, a Combobox, a Combo
item, a Dropdown button and a Check button element.
(For more information refer section 2.16.5)

132 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

Button action Button Action identifies the action to be performed upon


selection
(For more information refer section 2.16.6 and 2.16.7)

Combobox size It defines size of Combo box on toolbar

Image state normal • Image State Normal only applies to Toolbar or Display
Tree elements.
• With a Toolbar element, Image State Normal identifies
the name of the icon to be used by representing a
steady or normal condition within the button.
• With a Display Tree element, Image State Normal
identifies the name of the icon to be used by
representing the tree element.
• The icons must exist or must be included within
C:\Program Files\ABB Symphony
Plus\Operations\icons folder.
• This assumes that the root folder name set during
installation is the default name.
(For more information refer section 2.16.10)

Image state alarm Image State Alarm only applies to Toolbar or Display Tree
elements.
With a Toolbar element, Image State Alarm identifies the
name of the icon to be used to represent an Alarm
Condition on the button.
With a Display Tree element, Image State Alarm identifies
the name of the icon to be used to represent the expanded
tree element.
The icons must exist or must be included in C:\Program
Files\ABB Symphony Plus\Operations\icons folder
This assumes that the root folder name set during
installation is the default name.
(For more information refer section 2.16.11)

Image state blink Image State Blink only applies to Toolbar elements. Image
State Blink identifies the name of the icon to be used by
representing an Unacknowledged Alarm Condition within
the button.
The icons must exist or must be included within the
C:\Program Files\ABB Symphony Plus\Operations\icons
folder.
This assumes that the root folder name set during
installation is the default name.
(For more information refer section 2.16.12)

Menu level It identifies the level in the Menu structure. The value must
be in the range 0 to 9. The value 0 identifies a root level.
This field is applicable for Menu items only.

2VAA000830-330 A 133
S+ Operations DB Reference DATABASE STRUCTURE

Function key associated to menu Function Key associated to menu defines a functional key
button on the keyboard to be associated with the Menu and
the Toolbar element.
Function Key value can be defined for Menu option through
MENUFKEY option in Operations Engineering. The value
must be in the range 0 to 30. A value of 0 means that no
functional key button has been associated with the
element.
Function keys keyboard shortcut are:
• From value 1 to 10 à Function Keys “F1 to F10”.
• From value 11 to 20 à Either F11 to F20 OR “ALT +
F1” to “ALT + F10” OR “SHIFT+F1” to “SHIFT + F10”.
• From value 21 to 30 à “CTRL + F1” to “CTRL + F10”

Separator before menu item Separator before menu item allows you to insert a
separator between two buttons or Menu elements. The
value must be flagged Yes or No

Menu item valid on op.station Menu item valid on Op. Station identifies the Operator
Station associated with the Menu element. The element
only belongs to the Menu of that Operator Station. Other
Operator Stations cannot use that element.
The value must be in the range 0 to 32. A value of 0 means
that the element is assigned to all Operator Stations

Program to be activated Program to be activated identifies the name of the program


to activate when the menu or toolbar item is selected

Command line for the program Command line for the program identifies a parameter to be
passed to the program at activation time.
(For more information refer section 2.16.8)

Tag associated to the menu item

Target Window for the menu item

Security Security group Security Group identifies the security group associated with
the Menu elements. All the users with this security group
(For more can gain access to the elements.
information The value must be in the range 0 to 32. A value of 0 means
refer section that all users can gain access to the element, whichever
2.16.14) their security group.

Security level This field identifies the security level associated with the
Menu elements. All the users with a higher security level
can gain access to the element.
The value must be in the range 0 to 16. A value of 0 means
that all users can gain access to the element, whichever
their security level.

Presentation Plant Area Plant Area defines a logical subgroup that can be assigned
to a user in Security parameters.
(For more
information
refer section
2.16.9)

Privileges Alarm Management Alarm Management provides the privilege to execute alarm
management operations for the element

134 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

(For more Graphics configuration Graphics Configuration provides the privilege to configure
information Mimics for the element
refer section
2.16.15)
Logs configuration Logs Configuration provides the privilege to configure
reports for the element

History management History Management provides the privilege to perform


historical functions (e.g. initialize historical counters) for the
element

Diagnostic management Diagnostics Management provides the privilege to execute


diagnostics functions for the element

Security management Security Management provides the privilege to access and


modify security and users for the element

Time and date management Time and Date Management provides the privilege to set
time and date for the element.

View Trends View Trends provides the privilege to view

Global Trends configuration Global Trends Configuration provides the privilege to


access trend functions for the element

Infinet modules management Infinet Modules Management provides the privilege to


execute functions related to C-NET modules for the
element.

Groups configuration Groups Configuration provides the privilege to configure


Historical and Real-time groups for the element

Misc utility configuration Miscellaneous Utility Configuration provides the privilege to


configure some miscellaneous functions (e.g. Engineering
Units, Logic State Descriptors) for the element

Configuration Configuration provides the privilege to configure databases


for the element

View configuration View Configuration provides the privilege to view


configuration databases for the element

Remote write file Remote Write File provides the privilege to write a file in
remote access mode for the element

View display View Display provides the privilege to view Mimics for the
element

Long term history Long Term History provides the privilege to execute long
term historical functions for the element.

Client-server management Client - Server provides the privilege to access the client
and server management functions for the element

Calculation configuration Calculations Configuration provides the privilege to


configure calculations for the element

View history View History provides the privilege to view historical data
for the element

Windows nt management Windows Management provides the privilege to access


Windows functions (e.g. window sizing, Windows desktop
usage) for the element

2VAA000830-330 A 135
S+ Operations DB Reference DATABASE STRUCTURE

Odbc management ODBC Management provides the privilege to configure


ODBC commands for the element

Web navigation WEB Navigation provides the privilege to navigate through


the WEB for the element

Privilege to change password This provides the privilege to change the password of user

Application specific 1 privilege Application Specific 1 provides the privilege to access


specific application functions for the element

Application specific 2 privilege Application Specific 2 provides the privilege to access


specific application functions for the element

2.21.4 Menu and Tool-bar - Identification Parameters


The fields listed in Table 2-113 provides information on the name and additional parameters used to identify and qualify
menu and tool-bar items. They define the type of item to be a menu, a tool-bar (button) or a display tree element.
Additional fields allow characterizing the item depending on the type. Additional fields are listed in the specific sections
following this one.
Note: If the Menu Label is left blank, the particular menu item will not be imported into S+ Operations and an error is
displayed in the Operations Engineering log. Ensure to enter the value in Menu Label field.
The following table provides the list of Menu and Tool-bar – Identification Parameters:
Table 2-113: Menu and Tool-bar – Identification Parameters

Format Width Range Default


Name Description
Opt/Mnd Parameter(s)
INDEX Integer Item number. {1...100}
5 [n.menu]
Optional This is a unique number to identify each
menu and tool-bar item.

It must be unique for each item within


database. If omitted or zero (blank), the first
vacant index will be allocated.

MENUINDEX is the alias name for this field


MENULABEL Character Item description. <string>
64 <blank>
Mandatory If the item is an icon, this field is the tool-tip [szdesc]
text. If the item is a menu element, this field
is the text of the element. If the item is a leaf
of a display tree, this field is the text of the
leaf.
DESC Character Description <string>
64 <blank>
Optional
BUTTONTYPE Character Item type. Refer Table
9 2-114
Mandatory The field identifies the item to be an element
of a menu, a tool-bar (button) or a display
tree. None
Allowed item types are listed in Table 2-114.

2.21.5 Menu and Tool-bar - Item Types


The following table provides the list of Menu and Tool-bar – Item Types:
Table 2-114: Menu and Tool-bar – Item Type

Element Type Description


NONE Null element.
BUTTON Button of the Toolbar.
An action is associated to the button.
136 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

MENU Element of a Menu.


An action is associated to this element.
TREE Element of a Display Tree.
A display is associated to this element.
COMBOBOX Element of a.
A is associated to this element.
COMBOITEM Element of a.
A is associated to this element.
DROPBTN Element of a.
A is associated to this element.
CHECKBTN Element of a.
A is associated to this element.

2.21.6 Menu and Tool-bar – Action Parameters


The fields listed in Table 2-115 provides information on additional parameters used to qualify action related to menu and
tool-bar items. They define the action to be performed upon selection. Action can be “display a mimic”, “execute a program”,
“activate a Symphony Plus function”.
The following table provides the list of Menu and Tool-bar – Action Parameters:
Table 2-115: Menu and Tool-bar – Action Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
BUTTONACT Character Associated kind of action.
9
Mandatory The field identifies the action to be performed upon None
item selection.

Allowed values are listed in Table 2-116


MENUPGM Character Program name. <string>
9 <blank> None
Optional The field is the name of the program to activate when
the menu or tool-bar item is selected. It is valid only if
the action is program activation.
MENUCMDLIN Character Program parameter. <string>
128 <blank> None
Optional This field is a parameter (if any) to be passed to the
program at activation time.

Standard command lines are listed in Table 2-117

2.21.7 Menu and Tool-bar – Action Types


The following table provides the list of Menu and Tool-bar – Action Types:
Table 2-116: Menu and Tool-bar – Action Types

Action Type Description


NONE None to do.
This field defines a root or sub-root of a menu or display tree.
ALMDIS Alarm page displaying.
This field allows displaying an alarm page given the alarm group (to be defined in the
Command Line field).
PROGRAM Program activation.
This field allows activating a program (the name must be defined in the Program Name
field).
DISPLAY Mimic displaying.
This field allows displaying a mimic (the name must be defined in the Command Line
field).
SHELL Document displaying.
This field allows displaying a document (the name must be defined in the Command
Line field).
TRENDS Trend group displaying.

2VAA000830-330 A 137
S+ Operations DB Reference DATABASE STRUCTURE

This field allows displaying a trend group (the group name must be defined in the
Command Line field).
FACEPLATE Faceplate displaying.
This field allows displaying a faceplate (the faceplate name must be defined in the
Command Line field).
INTKEY Internal key.
This field allows activating a program (the name must be defined in the Program Name
field).
BROWSER Page displaying.
This field allows displaying a local HTML page or browsing to an Internet address (the
HTML page name or the Internet address must be defined in the Command Line field).
EXTAPPL Use this action type to define an external application program.
GIS Geographical Information System.
This field allows displaying GIS Views.

2.21.8 Menu and Tool-bar - Standard Command Lines


The following table provides the list of Menu and Tool-bar – Standard Command Lines:
Table 2-117: Menu and Tool-bar – Standard Command Lines

Description
Action Type Program Name Command Line
ALMDIS <alarm group> The alarm page of the alarm group defined in the
command line is displayed.
ALMDIS ICISTA - 100 The ICI status diagnostic function is activated.
BROWSER <HTML page> The local HTML page is displayed.
BROWSER <www address> The home page of the Internet address defined in
the command line is displayed.
DISPLAY <display name> The mimic whose name is defined in the command
line is displayed.
PROGRAM EIXKEY PAGE_PRINT The print screen function is activated.
PROGRAM EIXKEY PAGE_HOME The home page is displayed.
PROGRAM EIXKEY PAGE_PREV The previous page is displayed. The previous page
is any page displayed before the current one.
PROGRAM EIXKEY PAGE_BWRD The page backward is displayed. The page
backward is any page linked at configuration time
to the currently displayed page.
PROGRAM EIXKEY PAGE_FWRD The page forward is displayed. The page forward is
any page linked at configuration time to the
currently displayed page.
PROGRAM EIXKEY PAGE_ACKN The alarms on the current page are acknowledged.
PROGRAM EIXKEY PAGE_BYNAME The dialog window to enter a page name and call a
page by its name is displayed.
PROGRAM EIXKEY PAGE_SAVE The name of the currently displayed page is saved
for later recall.
PROGRAM EIXKEY PAGE_RECA The name of the page previously saved is
displayed.
PROGRAM EIXKEY PRTENB The alarm printer management function is
activated.
PROGRAM IBLSD EUD The engineering unit configuration function is
activated.
PROGRAM IBLSD LSD The logic state descriptor configuration function is
activated.
PROGRAM ITXTS ALMC The alarm comment configuration function is
activated.
PROGRAM ITXTS TXTS The text selector configuration function is activated.
PROGRAM LOGON -CHANGEROLE The User role change function is activated.
PROGRAM LOGON -CHANGEPWD The User Password change function is activated.
PROGRAM LOGON -CHANGESRV Function for connecting to different server is
activated.
PROGRAM LOGON -CHANGEWP The Workplace change function is activated.

138 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

2.21.9 Menu and Tool-bar - Presentation Parameters


The fields listed in Table 2-118 to Table 2-124 provides information on additional parameters used to graphically qualify
menu and tool-bar items. These fields define the icon names of buttons and optionally the functional key of the keyboard to
be used instead of the mouse (track-ball) to select.
The following table provides the list of Menu and Tool-bar – Presentation Parameters:
Table 2-118: Menu and Tool-bar – Presentation Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
IMGNORMAL Character Icon name or tree element. <string>
10 <blank> None
Mandatory If ButtonType is set to Button, the field is the icon
name used to display a normal state or a steady state.

Refer to Note1 at the end of the table for more details.

If ButtonType is set to Tree, the field is the tree


element.

Standard normal icons are listed in Table 2-119.


IMGALARM Character Icon name or tree element. <string>
10 <blank> None
Mandatory If ButtonType is set to Button, the field is the icon
name used to display an alarm state.

Refer to Note 1 at the end of the table for more


details..

If ButtonType is set to Tree, the field is the tree


element used to display the selection (open folder). It
is used when Imgnormal is set to Folder.

Standard alarm icons are listed in Table 2-120


IMGBLINK Character Icon name. <string>
10 <blank> None
Mandatory If ButtonType is set to Button, the field is the icon
name used to display an unacknowledged alarm state.
It applies to alarm tile icons only.

Refer to Note1 at the end of the table for more


details.

Standard blink icons are listed in Table 2-121.


MENUFKEY Integer Function key {0, 1, ..., 30}
3 0
Optional The field identifies a function key button of the None
keyboard to be associated to the menu or tool-bar
item.

A value of 0 means that no functional key button has


been associated to the item.
MENULEVEL Integer Menu level {0, ..., 9}
3 0
Optional It applies to menu items only and identifies the level in None
the menu structure.

The value 0 is the root level.


MENUSEP Character Item separator. {Y, N} N None
1
Optional The field specifies if a separator must be placed
between the previous and the current items. If set, the
item separator is a space for tool-bars and a line for
menus.

Note 1: The icons whose names are defined above must exist or must be included within the \S+\Icons folder.

2VAA000830-330 A 139
S+ Operations DB Reference DATABASE STRUCTURE

2.21.10 Menu and Tool-bar - Standard Normal Icons


The following table provides the list of Menu and Tool-bar – Standard Normal Icons:
Table 2-119: Menu and Tool-bar – Standard Normal Icons

Action Type Program Name Normal Icon Description


ALMDIS GRAn Gray number n inside a button.
By default n can range between 1 and
20.
ALMDIS ICISTA GREENLED Green led button (for ICI status).
BROWSER EXPLORER Internet explorer shaped icon.
BROWSER WFOLDER Network shaped icon.
DISPLAY PLANT Plant shaped button.
DISPLAY FOLDER Closed folder shaped icon.
DISPLAY FILE Page shaped icon.
NONE FOLDER Closed folder shaped icon.
NONE WFOLDER Network shaped icon.
PROGRAM ACKAUD AUDSILENCE Crossed horn shaped button.
PROGRAM EIXKEY HOME House shaped button.
PROGRAM EIXKEY LEFTKEY Left arrow shaped button.
PROGRAM EIXKEY PRINT Printer shaped button.
PROGRAM EIXKEY RIGHTKEY Right arrow shaped button.
PROGRAM EIXKEY UPKEY Up arrow shaped button.
PROGRAM LOGON LOGON Key shaped button.
PROGRAM TGROUP TRENDS Trend shaped button.

2.21.11 Menu and Tool-bar - Standard Alarm Icons


The following table provides the list of Menu and Tool-bar – Standard Alarm Icons:
Table 2-120: Menu and Tool-bar – Standard Alarm Icons

Action Type Program Name Normal Icon Description


ALMDIS REDn Red number n inside a button.
By default n can range between 1 and
20.
ALMDIS ICISTA REDLED Red led button (for ICI status).
DISPLAY OPFOLDER Opened folder shaped icon.
NONE OPFOLDER Opened folder shaped icon.

2.21.12 Menu and Tool-bar - Standard Blink Icon


The following table provides the list of Menu and Tool-bar – Standard Blink Icons:
Table 2-121: Menu and Tool-bar – Standard Blink Icon

Action Type Program Name Normal Icon Description


ALMDIS YELn Yellow number n inside a button.
By default n can range between 1 and
20.

2.21.13 Menu and Tool-bar - Presentation Parameters (continued)


The following table provides the list of parameters that are not included in the on-line configuration utility:
Table 2-122: Menu and Tool-bar – Presentation Parameters (continued)

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
TARGETWND Character Target Window for the menu item <string>
20 <blank>
Optional
MENUTAG Character Tag name. <string>
20 The field is the name of a tag associated to the menu <blank> [sznam]
Optional item.

140 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

2.21.14 Menu and Tool-bar - Allowed Parameters


The following table provides the list of fields that define security parameters to grant access to various menu and tool-bar
items:
Table 2-123: Menu and Tool-bar – Allowed Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
MENUOPSTA Integer Number of operator station. {0, 1...32}
3 0 [nmcrts]
Optional It allows assign the item to a single operator station.

The code 0 means the item is assigned to all


operator stations.
SECGROUP Character Security group {Y,N} N None
2
Optional
..................
SECGROUP32 Character Privilege to access tags and displays belonging to the {Y,N} N None
1 security group 32.
Optional
SECLEVEL Integer Security level. {0, 1, ..., 16}
2 0
Optional The value is compared to the security level assigned None
to the user before to grant access. A value of 0
means no security check.

2.21.15 Menu and Tool-bar - Privilege Parameters


The following table provides the list of fields that define security parameters to grant access to various menu and tool-bar
items:
Table 2-124: Menu and Tool-bar – Privilege Parameters

Range Default
Name Format Width Opt/Mnd Description
Parameter(s)
ALARMS Character 1 Privilege for executing general alarm {Y,N} N None
Optional management.
APPL1 Character1 Privilege for accessing specific {Y,N} N None
Optional application functions.
APPL2 Character1 Privilege for accessing specific {Y,N} N None
Optional application functions.
CALCUL Character1 Privilege for configuring calculations. {Y,N} N None
Optional
CLSERVER Character 1 Privilege for accessing the {Y,N} N None
Optional client/server management functions.
CONFIG Character1 Privilege for configuring some {Y,N} N None
Optional miscellaneous functions (e.g.
engineering units, logic state
descriptors).
DIAGNOSTIC Character1 Privilege for executing diagnostic {Y,N} N None
Optional functions.
GRAPHICS Character1 Privilege for performing mimic {Y,N} N None
Optional configuration.
GROUPS Character1 Privilege for configuring historical and {Y,N} N None
Optional real-time groups.
HISTORY Character1 Privilege for performing general {Y,N} N None
Optional historical functions (e.g. initialize
historical counters).
INFINET Character1 Privilege for executing functions {Y,N} N None
Optional related to the C-NET modules.
LOGS Character1 Privilege for modifying the {Y,N} N None
Optional configuration of the reports, for
triggering and deleting archived
reports.
LTERMHIST Character1 Privilege for executing long term {Y,N} N None
Optional historical functions.

2VAA000830-330 A 141
S+ Operations DB Reference DATABASE STRUCTURE

NAVIGATE Character1 Privilege for WEB navigation. {Y,N} N None


Optional
DBC Character1 Privilege for configuring the ODBC {Y,N} N None
Optional functions.
REMWRITEF Character1 Privilege for writing a file in remote {Y,N} N None
Optional access (e.g. using DDE functions).
SECURITY Character1 Privilege for accessing and modifying {Y,N} N None
Optional security and users.
TIMEDATE Character1 Privilege for setting the time and date. {Y,N} N None
Optional
TRENDS Character1 Privilege for accessing trend {Y,N} N None
Optional functions.
UTILITY Character1 Privilege for executing general utility {Y,N} N None
Optional functions.
VIEWCONFIG Character1 Privilege for displaying the {Y,N} N None
Optional configuration databases.
VIEWDISP Character1 Privilege for viewing displays. {Y,N} N None
Optional If set, display viewing is submitted to
security group check also.
VIEWHIST Character1 Privilege for viewing historical data. {Y,N} N None
Optional
WINDOWSNT Character1 Privilege for accessing Windows {Y,N} N None
Optional functions (e.g. window sizing,
Windows desktop usage).

2.22 Network Parameters


The fields listed in Table 2-13, refer to the Symphony Plus network communication subsystem.
They are used when multiple Symphony Plus servers in a multi-master architecture exchange data (values, alarm
acknowledges, messages, configurations).
All fields are optional and they must be defined when servers (nodes) are intended to cooperate in a multi-master
architecture.
The fields reference the node definition. Refer to the Node database section for more details.
The following table provides the list of Network Parameters:
Table 2-125: Network Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
NETDSTCLAS Character Network Distribution Class <string>
50 <blank>
Optional
SRCNODLST Character Source Node mask <string>
500 <blank>
Optional Source node list
DESTNODLST Character Destination Node mask (Op. actions) <string>
500 <blank>
Optional Destination node list (Op. actions)
DESTVALLST Character Destination Node (values) <string>
500 <blank>
Optional Destination node list (values)
CNFNODLST Character Configuration Node mask <string>
500 <blank>
Optional
Configuration node list
CMDNODLST Character Command Node mask <string>
500 <blank>
Optional

Command node list


FWDNODLST Character Forward Node mask <string>
500 <blank>
Optional

Forward node list


HISTVALLST Character History Align Node mask <string>
142 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

500 <blank>
Optional
History Align node list

2.23 Network subsystem: Nodes

2.23.1 Node Database


The node database is generated on a Personal Computer using standard packages like DBase III/IV or EXCEL. Then, it
must be copied to the computer running the Symphony Plus application (if it is a different one) for final import.
Node database is imported submitting the database file to the database builder. During this phase, the field contents of the
input file will be used to compile Symphony Plus internal database structures following the directives given by a field
assignment cross-reference file, processed by DBXRF builder program.
The database builder may also perform export operations, creating a target database file (DBase III/IV format) containing all
items as they are currently defined in the Symphony Plus internal database. If a target database does not exist, the builder
processor creates it using the whole Symphony Plus database structure. Alternatively, a target database file may be
specified as template. In this case, the builder processor updates the target database file handling only the fields specified
in it. The target database file may have just a single node or may be a full or partial database file. It must contain all (and
only) fields to be exported.

2.23.2 Node Definition


The following sections list parameters to characterize nodes within a network.
A node item is configured as a pseudo-tag: it is not included within tags, but has some of fields typical of tag configuration.

2.23.3 Node - General Parameters


The following table provides the list of fields that define the name and other additional parameters used to identify nodes in
the network:
Note: Additional fields are listed in the specific sections following this one.
Table 2-126: Node – General Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
INDEX Integer Node index. {0...32}
5 0 [mxnode]
Optional This field identifies the node by number. It must be
unique for each node in the database. If omitted or
zero (blank), the first vacant index will be allocated.

NODEINDEX is the alias name for this field


NAME Character Node name. <string>
20 <blank> [sznam]
Mandatory The node name must be the name assigned to the
computer and can be retrieved by the Network
function of the Control Panel.

Note: Tag name must be unique within the database


of the system, node, and trend. If defined with same
tag name as any of the item name, then it will lead to
error while importing, creating, and modifying of such
item entries in any of these database.

For Example: Having Tagname as “SPOServerA”


with the DEVSTA tag type in Tag database, it is not
allowed to have “SPOServerA” defined in the node
database, it also not allowed in trend databased as
well.

NODENAME is the alias name for this field


DEV_TYPE Character Device type <string>
15 <blank>
Optional
DESC Character Node description. <string>
64 <blank> [szdesc]
2VAA000830-330 A 143
S+ Operations DB Reference DATABASE STRUCTURE

Optional NODEDESC is the alias name for this field


ISCLIENT Character Node is client {Y,N} N None
1
Optional
ISFESRV Character Node is Frontend server {Y,N} N None
1
Optional
LICFESRV Character Licensed Frontend server {Y,N} N None
1
Optional
ALDISPPRIO Integer Alarm mimic priority (Lower number has higher 0
6 priority) None
Optional
PRIMDISPN Character Primary display reference. <string>
256 <blank> None
Optional Name of a graphic display associated to the tag.
This page can be directly called from tag
presentation displays or from alarm pages and it is
also used for Alarm Mimic.
Can contain name of workplace layout, mimic, trend,
diagnostic, alarm. In case of workplace layout, use
prefix “$WPL.”

Note: N indicates 1 through 4. Primary display (View


1) indicated as PRIMDISP1.
PRIMGROUP Character Primary trend group <string>
20 <blank> None
Optional
PLANTAREA Integer Plant Area 0
2 None
Optional
SEC_GROUP Integer Security group 0
2 None
Optional
SEC_LEVEL Integer Security level 0
2 None
Optional
WEIGHT Integer Node weight (the highest is the master)
2
Optional In a multi-master network configuration, the highest 0
value (weight) defines the “master” node. None

2.23.4 Node - Alarm Process Parameters


The following table provides the list of fields that define additional information for the alarm processing of the node pseudo-
tag:

Table 2-127: Node – Alarm Process Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
ALMGRPNAM Character Alarm Group Name <string>
50 <blank>
Optional
ALM_MSG Character Node Alarm Message <string>
50 <blank>
Optional
RTN_MSG Character Node RN message <string>
50 <blank>
Optional
ALCATEG Character Alarm Category <string>
50 Default
Optional

144 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

Name of the Alarm Category, which defines the alarm


processing options.
ALMPRINTER Integer Alarm printer index.
2
Optional Reference index to the printer where messages 0
concerning the tag are printed. None

Refer to the PR_ xxx (e.g. PR_ALARM) field for


more details. It is a pointer to a alarm printer
database defining the alarm printer index.

Refer to the system option configuration for details.


AL_PRI Integer Alarm priority. {0, 1...15}
2 1
Optional Refer to the same field of the tag database for a [mxalpr] and
complete description. [mxxapr]
AUDINDEX Integer Audible alarm index. {0, 1...32}
3 0 [mxaud]
Optional This field defines the index into audible alarm
database to determine which audible is to be
activated upon alarm and/or return to normal.
ALMGROUP Integer Alarm Group 0
3 None
Optional

2.23.5 Node - Network Parameters


The following table provides the list of fields that define additional information for the network parameters:
Table 2-128: Node – Network Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
PLBALGLST Character Alignment node list (plb) <string>
500 <blank>
Optional
PLBALGMSn Character Alignment node mask (plb) (n) {Y,N}N, None
16
Optional PLBALGMSK is the alias name for PLBALGMS1
n= 1 to 8
SNAPALGLST Character Alignment node list (Snapshots) <string>
500 <blank>
Optional
SNAPALGMSn Character Alignment node mask (snapshots) (n) {Y,N}N, None
16
Optional SNAPALGMSK is the alias name for SNAPALGMS1

n= 1 to 8

NETDSTCLAS Character Network Distribution Class {Y,N}N, None


50
Optional

2.23.6 Node – License


• Applications
• Client
• Connects
• Drivers
• Server

2.24 Security Subsystem: Security


Symphony Plus offers a security subsystem allowing definition of internal users. Each user is identified by a name and a
password.

2VAA000830-330 A 145
S+ Operations DB Reference DATABASE STRUCTURE

A set of access rights and permissions can be assigned to each user. In such a way access to Symphony Plus functions or
operations (e.g. tag configuration) can be denied.
In configuring Symphony Plus, various security level validity masks can be defined to limit access to functions or items (e.g.
tags). Those masks are used to control operator actions on the following items.
• Program Activation
• Display Retrieval
• Data Entry Field Selection
• Action Field Selection
• Tag Database Configuration,
• Group Definition and Display
• Process Control
The masks associated with the above items will be referred to as the "validity masks" throughout this section.
Symphony Plus provides the following validity masks:
• Tag Access Right Mask.
Enable or disable operations related to single tags. The following security rights are defined:
• Monitor
• Configure
• Process Control
• Tune
• Delete
• Enter Data
• Operation (e.g. scan on/off)
• Alarms Acknowledgment
• Security Region Mask
Enable or disable configuration operations on the following sub-systems:
• Utilities
• Alarm Management
• Graphics
• Historical Archives
• Diagnostic
• Security
• Time and Date
• Trend Groups
• PCU and Modules
Furthermore, operations on tags are submitted to a "Tag Security Group Mask" and a "Security Level" check.
Each tag can be assigned to one of 32 security groups. Each user is allowed to operate only on groups defined in the
Security Group mask, thus allowing different users to operate on different groups of tags.
Each tag can be assigned to one of 16 security levels. Only the users whose security level is greater or equal to the tag
security level are allowed to operate on that tag.
The security definition file contains the information to define the User Authorization File and to provide operator passwords.
Symphony Plus provides a security scheme that allows functions to be grouped so that access to a group of functions and/or
displays may be denied. Any operator of a Symphony Plus station must enter his password to gain rights and permissions.
This password has a list of allowed and denied functions/displays associated. Attempts to perform a denied operation will
results in an operator message.

2.24.1 Security Database


The security database is generated on a Personal Computer using standard packages like DBase III/IV or EXCEL. Then, it
must be copied to the computer running the Symphony Plus application (if it is a different one) for final import.
Security database is imported submitting the database file to the database builder. During this phase, the field contents of
the input file is used to compile Symphony Plus internal database structures following the directives given by a field
assignment cross-reference file, processed by DBXRF builder program.
The database builder may also perform export operations, creating a target database file (DBase III/IV format) containing all
items as they are currently defined in the Symphony Plus internal database. If a target database does not exist, the builder
processor creates it using the whole Symphony Plus database structure. Alternatively, a target database file may be
specified as template. In this case, the builder processor updates the target database file handling only the fields specified
in it. The target database file may have just a single user or may be a full or partial database file. It must contain all (and
only) fields to be exported.
146 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

2.24.2 Security - General Parameters


The following table provides the list of fields that define the name and other additional parameters used to identify the
Symphony Plus user:
Table 2-129: Security – General Parameters

Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
INDEX Integer User index. {0...20}
3 0 [n.pswd]
Optional This field identifies the Symphony Plus user by
number. It must be unique for each user in the
database. If omitted or zero (blank), the first vacant
index will be allocated.

USERINDEX is the alias name for this field


NAME Character User name. <string>
18 <blank>
Mandatory This field identifies the Symphony Plus user by name. [szunam]
It must be unique for each user in the database.

USERNAME is the alias name for this field


USERDESC Character Description user <string>
64 <blank>
Optional
PASSWORD Character User password. <string>
18 <blank>
Mandatory The export function does not fill in this field to prevent [szunam]
password decoding.

A new created security database file does not include


the field.

See also the caution Note at the end of the table.


PWDAGING Integer Password aging (days) 0
4 Nonr
Optional
CRYPTPWD1 Integer Encrypted user password.
18
Mandatory The export function fills in this field. A new created
security database file includes the field. See also the None
caution Note at the end of the table.
USERCODE Integer User code.
4
Optional Numeric code, such as a payroll code, associated to
the user. It is used only for display purposes. None
LANGUAGE Integer Man machine interface language. The value 0
2 defaults to the English language. Any other value set
Optional an alternate language. Of course, the dictionary for
such alternate language must be defined. None
ACTIVE USER Character Define if the inserted item refers to a real user or <string>
1 identify a Users’ group <blank>
Mandatory [szunam]
LASTLOGIN Integer Last login 0
2 None
Optional
WINGROUP Character Define if the inserted item refers to a real user or <string>
64 identify a Users’ group <blank>
Optional [szunam]

To prevent unauthorized password decoding, the security database export function does not manage the PASSWORD field,
it manages the CRYPTPWD1 field.
The PASSWORD field is not filled in (it is left blank) when the security database is exported to on existing file including the
field. The PASSWORD field is not included within a new created security database file.

2VAA000830-330 A 147
S+ Operations DB Reference DATABASE STRUCTURE

The CRYPTPWD1 field is included within a new created security database file. In the table above the two fields are
considered mandatory, actually one of them is really mandatory. A password can be defined by the PASSWORD field or by
the CRYPTPWD1 field.
In order to keep the password coding, it is suggested to add the CRYPTPWD1 field to the security the database file in a
column next to the PASSWORD field and leave it blank. On export the PASSWORD field is cleared and the CRYPTPWD1
field is filled in. Later, on import the CRYPTPWD1 field will supersede the PASSWORD field.
When a password must be changed, type the new password in the PASSWORD field and clear the corresponding
CRYPTPWD1 field. Then, build the security database.

2.24.3 Security - Access Control Parameters


The following provides the list of fields that define access control parameters used to restrict user accesses and to prevent
unauthorized accesses:

Table 2-130: Security – Access Control Parameters

Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
LOGOFFTMO Character Log-off on time-out. {Y,N} N None
1
Optional The log-off time-out is related to the screen saver setting. It is
required to set the screen sever time-out in order to control the
automatic user log-off.
Automatic log-off is forced when the screen saver time-out expires.
LOGINDISP Character Log-in display. <string>
9 <blank>
Optional Name of a mimic displayed when the user logs in. None
LOGOFFDISP Character Log-off display. <string>
9 <blank>
Optional Name of a mimic displayed when the user logs out or the time-out None
forces a log out.
LOGINPROG Character Log-in program. <string>
6 <blank>
Optional Name of the application program to run when the user logs in. None
LOGOFFPROG Character Log-off program. <string>
6 <blank>
Optional Name of the application program to run when the user logs out or None
the time-out forces a log out.
MAXLOGINFAIL Integer Maximum number of log-in trials. {0, 1...9999}
4 0
Optional The user is no longer allowed to log-in after the maximum number None
of trials is reached and wrong passwords have been typed at each
log-in trial. The user is locked.

The system manager must manually unlock the user in order to


allow user logging-in again.
MAXLOGFAIL Integer Max login failures 0
4 None
Optional
PWDAGING Integer Password aging (number of days). {0, 1...9999}
4 0
Optional After that time has elapsed, the user is no longer allowed to log-in. None
The user must change the password before its expiration or the
system manager must set a new password after expiration.

2.24.4 Security - Tag Operation Parameters


The following table provides the list of fields that define security parameters to operate on single tags:
Table 2-131: Security – Tag Operation Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
TAGMONITOR Character Privilege to monitor tags. {Y,N} N None
1

148 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

Optional
TAGCONFIG Character Privilege to configure tags. {Y,N} N None
1
Optional
TAGCONTROL Character Privilege to execute process control on tags. {Y,N} N None
1
Optional
TAGCONTRO2 Character Tag control 2 privilege {Y,N} N None
1
Optional
TAGTUNE Character Privilege to tune the process tags. {Y,N} N None
1
Optional
TAGDELETE Character Privilege to delete tags. {Y,N} N None
1
Optional
TAGENTDATA Character Privilege to perform data entry on tags. {Y,N} N None
1
Optional
TAGOFFSCAN Character Privilege to put tags off scan and on scan. {Y,N} N None
1
Optional
TAGOFFALM Character Privilege to put tags off alarm check and on alarm {Y,N} N None
1 check.
Optional
TAGLIMIT Character Privilege to change alarm limits of tags. {Y,N} N None
1
Optional
TAGLIMIT1 Character Tag change limit 1 privilege {Y,N} N None
1
Optional
TAGLIMIT2 Character Tag change limit 2 privilege {Y,N} N None
1
Optional
TAGLIMIT3 Character Tag change limit 3 privilege {Y,N} N None
1
Optional
TAGACK Character Privilege to acknowledge alarms. {Y,N} N None
1
Optional
TAGMONALL Character Privilege to perform full tag monitoring. {Y,N} N None
1
Optional Security level and security group check is bypassed.
TAGREMOTE Character Privilege for remote access on tags. {Y,N} N None
1
Optional
TAGENTHIST Character Privilege to enter historical data on tags. {Y,N} N None
1
Optional
TAGASPECT1 Character Tag control aspect1 {Y,N} N None
1
Optional
TAGASPECT2 Character Tag control aspect2 {Y,N} N None
1
Optional
TAGASPECT3 Character Tag control aspect3 {Y,N} N None
1
Optional
TAGASPECT4 Character Tag control aspect4 {Y,N} N None
1
Optional
TAGASPECT5 Character Tag control aspect5 {Y,N} N None
1
Optional

2VAA000830-330 A 149
S+ Operations DB Reference DATABASE STRUCTURE

2.24.5 Security - Privilege Parameters


The following table provides the list of fields that define security parameters to grant access to various Symphony Plus
functions:
Table 2-132: Security – Privilege Parameters

Range
Format Width
Name Description Default
Opt/Mnd
Parameter(s)
ALARMS Character Privilege for executing general alarm management. {Y,N} N None
1
Optional
APPL1 Character Privilege for accessing specific application functions. {Y,N} N None
1
Optional
APPL2 Character Privilege for accessing specific application functions. {Y,N} N None
1
Optional
CALCUL Character Privilege for configuring calculations. {Y,N} N None
1
Optional
CLSERVER Character Privilege for accessing the client/server functions. {Y,N} N None
1
Optional
CONFIG Character Privilege for configuring some miscellaneous {Y,N} N None
1 functions (such as engineering units and logic state
Optional descriptors).
DIAGNOSTIC Character Privilege for executing diagnostic functions. {Y,N} N None
1
Optional
GRAPHICS Character Privilege for performing mimic configuration. {Y,N} N None
1
Optional
GROUPS Character Privilege for configuring historical and realtime {Y,N} N None
1 groups.
Optional
HISTORY Character Privilege for performing general historic functions {Y,N} N None
1 (such as initializing the historical counters).
Optional
INFINET Character Privilege for executing functions related to the C- {Y,N} N None
1 NET modules.
Optional
LOGS Character Privilege for modifying the configuration of the {Y,N} N None
1 reports, for triggering and deleting archived reports.
Optional
LTERMHIST Character Privilege for executing long term historical functions. {Y,N} N None
1
Optional
NAVIGATE Character Privilege for navigating through WEB pages. {Y,N} N None
1
Optional
CONNECT Character Connect remote servers privilege {Y,N} N None
1
Optional
ODBC Character Privilege for configuring the ODBC functions. {Y,N} N None
1
Optional
REMWRITEF Character Privilege for writing a file in remote access (such as {Y,N} N None
1 using DDE functions).
Optional
SECURITY Character Privilege for accessing and modifying security and {Y,N} N None
1 users.
Optional
TIMEDATE Character Privilege for setting the time and date. {Y,N} N None
1
Optional
TRENDS Character Privilege for accessing trend functions. {Y,N} N None
1
150 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

Optional
UTILITY Character Privilege for executing general utility functions. {Y,N} N None
1
Optional
VIEWCONFIG Character Privilege for displaying the configuration databases. {Y,N} N None
1
Optional
VIEWDISP Character Privilege for viewing displays. {Y,N} N None
1 If set, display viewing is submitted to security group
Optional check also.
VIEWHIST Character Privilege for viewing historical data. {Y,N} N None
1
Optional
WINDOWSNT Character Privilege for accessing Windows functions (such as {Y,N} N None
1 window sizing, Windows desktop usage).
Optional

2.24.6 Security - Group and Level Parameters


The following table provides the list of fields that define the security group mask:
Note: Each field refers to a security group. Another field to control the access is the security level.
Table 2-133: Security – Group and Level Parameters

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
SECGROUP1 Character Privilege to access tags and displays belonging to the {Y,N} N None
1 security group 1.
Optional
..................... ............. ..................................... ........................
SECGROUP32 Character Privilege to access tags and displays belonging to the {Y,N} N None
1 security group 32.
Optional
SEC_LEVEL Integer Security level. {0, 1...16}
2 1
Optional This field is used for security checking whenever a None
user attempts to operate on Symphony Plus.

Only if the value is greater or equal the security level


of the requested function the user gains access.

2.24.7 Security - Remote Client Access Parameters


The following table provides the list of fields that define the remote access parameters:
Note: These fields define which clients are entitled to log in as privileged user. Each parameter is a bit mask and each bit
refers to a client. The clients must be defined in a client list on the server.
Table 2-134: Security – Remote Client Access Parameters

Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
CRTMASK1 Character Crt enable mask. Sequence {Y,
16 The bit mask allows enabling access or N}
Optional preventing access to clients. 16*Y None

The mask applies to clients from 1 to 16.


CRTMASK2 Character Crt enable mask. Sequence {Y,
16 N}
Optional Same as CRTMASK1 above. 16*Y None

The mask applies to clients from 17 to 32.


PLANTUMSK1 Character Plant unit enable mask 1. Sequence {Y,
16 N}
Optional The current user can only access to the 16*Y None
plant units enabled.
..................... ............. ..................................... ........................
2VAA000830-330 A 151
S+ Operations DB Reference DATABASE STRUCTURE

PLANTUMSK9 Character Plant unit enable mask 9. Sequence {Y,


16 N}
Optional Same as PLANTUMSK1. 16*Y None
PLANTUMS10 Character Plant unit enable mask 10. Sequence {Y,
16 N}
Optional The current user can only access to the 16*Y None
plant units enabled.
..................... ............. ..................................... ........................
PLANTUMS16 Character Plant unit enable mask 16. Sequence {Y,
16 N}
Optional Same as PLANTUMS10. 16*Y None

2.24.8 Enhanced User Management


Since these releases the Logon function was provided only for Symphony Plus defined users, based on a Symphony Plus
User Database on which each records defined an user, specifying the username, the password, the security levels, the
privileges and other features related to security.
This function is still available, and has been enhanced providing the possibility to define into the User Database some new
records that do not correspond to a user but correspond to a group template. Such records define a username
(corresponding to the name of the group), the security levels, the privileges and the other features related to the security.
For such records the password and the other fields related to the management of the password (such as password aging)
are not considered.
A new field in the DataBase named “ACTIVEUSER” provides the difference among user records and group template records.
The online configuration of the User Database also provides access to this field by means of a radio button that allows the
selection between user and group.
Note: User records and group template records can be mixed inside the User Database.
The Logon function provided by Symphony Plus has been enhanced in the following way.
When a user try to logon on Symphony Plus, providing Username and Password, the Symphony Plus User Database is
scanned for a matching of those parameters with the ones defined for active users. If a match is found, then the other
validations are performed and the Logon function is executed.
If the provided Username and Password do not match any Symphony Plus user, then those parameters are used to perform
an internal logon into the Operating System, which validates the parameters against its User Database. If the Windows logon
succeeds then the Windows User Database is checked in order to verify if the User belongs to any group named as defined
into the Wingroup field. If this happens, then the Symphony Plus logon function will continue providing to the new logged
user the security characteristics that are defined in the Symphony Plus group template record.
The previously described feature allows an independent management of users between Symphony Plus and the Operating
System. In Symphony Plus, the definition of group templates is mainly related to the specific features of Symphony Plus,
while the Operating System provides the management of the users, granting advanced policies for managing passwords
and related features. Furthermore the Operating System provides the possibility to defined “domain” users, centralizing the
management of its User Database. Of course the improved Symphony Plus logon function also takes into consideration this
feature, providing that the entered Username is in the standard form “domain\username”.
The default user logon, which is performed whenever the Symphony Plus HMI interface (PowerExplorer) is activated, also
takes into consideration the previously described feature. This gives the possibility to apply the Symphony Plus security that
is related, via the group templates, to the user logged in into the Operating System, eliminating or reducing the need to login
again into Symphony Plus.

2.24.9 Defining Windows Users


The link between Symphony Plus users and Windows users is provided by means of group template records defined into
the Symphony Plus User Database.
These records are exactly the same as the other user records, apart the field ACTIVEUSER set to “N”. The default setting
for this new field is “Y”, defining a standard Symphony Plus user.
The fields PASSWORD, PWDAGING and MAXLOGFAIL are ignored for group template records.
The USER.DBF files, which is provided as an example with the Symphony Plus Operation installation kit, defines the
following templates:
• Guests (with very restricted access)
• Users (with standard Operators capabilities)
• Administrators (with full capabilities)
The Windows User Database must be modified in order to define some group that corresponds to the ones defined in
Symphony Plus.

152 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

The following procedure may change a little according to the Operating System used, but the concepts are the same:
From “Administrative Tools” select “Computer Management” then select “Local Users and Groups”.
1. Select “Groups” and perform the “Action”: “New Group”.
2. Add one or more group corresponding to the ones defined into the Symphony Plus User Database.
Referring to the sample, you have to add:
• Symphony Plus Guests
• Symphony Plus Users
• Symphony Plus Administrators
3. Select each group (by double clicking on it) and “add” users to it. If you add the user which is currently logged on
you will have to logoff and logon again before the modification takes effect.
The above procedures is applied on a domain server, to centralize the user management.

Some Hints
In case Symphony Plus is started by an Interactive User (i.e. not started as a Window Service), then the logged user requires
Windows “Administrator” privileges, and a Local Policy right named “act as part of the Operating System”. This right is
granted automatically when the “Client/Server” function from the Symphony Plus Setup is performed.
Whenever a S+ Operations User Logon is performed the S+ Operations User Database is scanned first, then the Windows
Database is checked. In case of duplicated names the S+ Operations user will be taken in charge.
The Windows Group Database is checked by looking in the local groups (the groups defined in the machine where the user
logon) and then looking in the domain server.
In case of multiple definitions the one in the local machine will be considered.
The Windows user must belong only to one Symphony Plus group. In case of multiple assignments then the first in the
alphabetical order will be considered.

2.24.10 Security - Default Settings


Symphony Plus provides a default security configuration to grant its basic operation. This section lists those default settings
in Table 2-135.
The following table lists security level, security groups, tag operation rights and privileges of each user:
Note: The end user may want to change user names and/or passwords according to his organization and his needs. Follow
the general directions on configuration and the previous security database description to change user names or passwords.
Table 2-135: Security – Default Settings

Sec. Sec.
User Name Password Tag Operation Rights Privileges
Level Groups
OPERATOR LEVEL0 1 All TagMonitor, TagControl, TagAck ViewDisp
ENGINEER LEVEL1 1 All TagMonitor, Alarms,
TagConfig, TagDelete, Graphics, Logs,
TagEntData, TagOffScan, History,
TagOffAlm, TagLimit. Security,
TimeDate,
Trends, Infinet,
Groups, Utility,
ViewConfig,
ViewDisp,
LTermHist,
ClServer,
Calcul,
ViewHist, and
Windows.
SYSMGR PRIV 16 All All rights. All privileges.

Table 2-136: Layout Parameter

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd

2VAA000830-330 A 153
S+ Operations DB Reference DATABASE STRUCTURE

VTOOLBAR Character View toolbar {Y,N} N None


1
Optional
VSTATUSBAR Character VSTATUSBAR {Y,N} N None
1
Optional
VDISPTREE Character View display tree {Y,N} N None
1
Optional
VALARMTREE Character View alarm tree {Y,N} N None
1
Optional
VBOTTOMALM Character View bottom alarms {Y,N} N None
1
Optional
FULLSCREEN Character Full screen mode {Y,N} N None
1
Optional
VIEWFILE Character Can access file {Y,N} N None
1
Optional
OPENFILE Character Can open file {Y,N} N None
1
Optional
CLOSEWINDW Character Can open and close child windows {Y,N} N None
1
Optional
CANLOGOFF Character Can logoff {Y,N} N None
1
Optional

2.25 Foreign Database Support Subsystem


Symphony Plus supports wide range of commercial database managers, by exporting its internal data structures via ODBC
standard. In this environment, Symphony Plus acts as a data provider for the foreign database, in the following description
indicated as target database. Once the target database has been created and initialized, Symphony Plus connects and
updates it whenever a change occurs in its internal structures, either in case of configuration changes or historical archiving.
All the data exported to the target database is then fully accessible by any tool supported by the target database itself,
although for some data structure the recommended access is read-only.
Symphony Plus exports tag, trend group and alarm data structures, in form of:
• Static data.
• Dynamic data.
Static data contain configuration parameters, while dynamic data contain historical process values.
For each kind of data structure, one or more tables are maintained on the target database, according to what’s described in
the following sections. In general, there is a table for tag static data, a table for trend group static data, a table for tag dynamic
data, a table for alarm dynamic data and n tables for trend group dynamic data, where n is the maximum number of trend
groups in the system.

2.25.1 Target Database Requirements


The target database can be any commercial DBMS providing an ODBC driver for Windows as listed.
• MS Access,
• MS SQL Server 6.5 and
• Oracle 8
The target DBMS engine may run on the same machine as Symphony Plus as well as on a remote machine connected via
network.
Although Symphony Plus operates as a simple data provider, it expects the target database to have a known structure for
what concerns the number, name and format of the tables. Thus, such tables are created and maintained automatically by
Symphony Plus and their structure must never be changed. In addition, a maintenance application tool (‘Data Export
Manager’) is provided.
The only manual action required to put foreign database support at work, is a simple setup procedure to configure ODBC
data source. Once the ODBC driver is installed on Symphony Plus machine, just add a new data source using the ‘Data
Export Manager’. Depending on the DBMS, this setup procedure will interactively ask for all required information such as
server node name, security information and so on.
154 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

2.25.2 Static Tables


Static tables contain configuration parameters for tags and trend groups. The maximum number of tags and trend groups
limits the size of static tables in the system. Static tables reflect the current configuration of the system, and they must be
kept aligned by the system itself. Once Symphony Plus exports the data to the target database, it has no kind of control over
them. That is, if the contents of static tables are changed, the only way to recover the original situation is to realign the target
database by the ‘Data Export Manager’.
The structure of static tables may be changed to fit particular system requirements. These changes must be set up on
Symphony Plus by compiling a deck-file for database cross reference builder DBXRF (Refer S+ Engineering Operations
engineering user manual (8VZZ002960T2300) ) before the tables are created on target database. Once a table is created,
initialized and aligned, its structure must never change, unless realignment is made.
Static tables are created and initialized by Symphony Plus at system generation time, regardless they already exist or not.
Then, they are updated whenever the system processes a change in the configuration of tags and trend groups, either the
system is active or not.
If no error occurs, Symphony Plus and target database are guaranteed to be aligned. If any error occurs (for instance a
network failure or a target database shutdown), a warning message is displayed, and the target database is marked as non-
aligned. Again, the only way to recover the original situation is to realign the target database by the ‘Data Export Manager’.
When exporting static data to a foreign database be sure the exported strings (if any) do not contain any apostrophe (‘) since
it is a string delimiter. For example, if the tag description is exported, it must not contain any apostrophe. Check Symphony
Plus database files to prevent such a case.
The data type of the fields is function of the target DBMS. Table 2-137 and Table 2-138 show a sample structure for tag and
trend group static tables, in case target DBMS is Oracle8.
Refer to tag and group configuration for details on fields.

2.25.3 Foreign Database Support - Tag Static Table (TAGS)


The following table provides the list of Foreign Database Support – Tag Static Table (TAGS):
Table 2-137: Foreign Database Support – Tag Static Table (TAGS)

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
TAGINDEX Decimal Tag index. None
6
Optional
TAGNAME Character2 Tag name.
20
Optional
None
TAGDESC Character2 Tag description.
64
Optional
None
TAGTYPE Character2 Tag type.
8
Optional
None
EUDESC Character2 Engineering unit description.
16
Optional EU_NAME is the alias name for the field.
None
VAL0 Dbl. Prec. Value of 0% scale.

Optional None
SPAN Dbl. Prec. Instrument range.

Optional None
ZEROSTATE Character2 Descriptor for state 0.
256
Optional
None
ONESTATE Character2 Descriptor for state 1.
256
2VAA000830-330 A 155
S+ Operations DB Reference DATABASE STRUCTURE

Optional
None
TWOSTATE Character2 Descriptor for state 2.
256
Optional
None
THREESTATE Character2 Descriptor for state 3.
256
Optional
None
FOURSTATE Character2 Descriptor for state 4.
256
Optional None

2.25.4 Foreign Database Support - Trend Groups Static Table (GROUPS)


The following table provides the list of Foreign Database Support – Trend Groups Static Table (GROUPS):
Table 2-138: Foreign Database Support – Trend Groups Static Table (GROUPS):

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
GROUPINDEX Decimal Group index.
6
Optional
None
GROUPNAME Character2 Group name.
20
Optional
None
GROUPDESC Character2 Group description.
64
Optional
None
ARCHTYPE Character2 Type of archiving.
7
Optional This parameter qualifies the trend
group. Depending on the type, the None
set of parameters required to fully
configuring the group change
EUDESC Character2 Engineering unit description.
16
Optional EU_NAME is the alias name for the
field. None

ARCHFRQ Decimal Archive frequency.


6
Optional
None
ARCHUNITS Decimal Archive time units.
6
Optional
None
OFFSET Decimal Archive time offset.
6
Optional
None
OFFSUNITS Decimal Archive time offset units.
6
Optional
None
SAMPLFRQ Decimal Sample frequency.
6
Optional
None
SAMPLUNITS Decimal Sample time units.
6
Optional
156 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

None
TOTSAMPLES Decimal Total number of samples.
6
Optional
None
TAG1 Character2 Name of the 1st tag in the group.
20
Optional
None
.................. ............... ................................................. .........
TAG60 Character2 Name of the 60th tag in the group.
20
Optional
None

2.25.5 Dynamic Tables


Dynamic tables contain historical process values for tags, alarms and trend groups. Since new values are always inserted
into target database in form of new records, the size of dynamic tables can indefinitely grow up. That requires some kind of
maintenance activity on target database. On the other hand, since dynamic tables contain volatile information, there is no
need to keep any kind of alignment with Symphony Plus database. That is, target database’s administrator can manipulate
dynamic table contents as desired, for instance deleting or dumping to tape old records.
Like static tables, the structure of dynamic tables may be changed to fit specific application requirements. These changes
must be set up on Symphony Plus by compiling a deck-file for database cross reference builder DBXRF (Refer S+
Engineering Operations engineering user manual (8VZZ002960T2300)) before the tables are created on target database.
Once a table is created and initialized, its structure must never change, unless another initialization is made.
At start-up time, Symphony Plus creates and initializes tag and alarm dynamic tables, unless they already exist. Trend group
dynamic tables are created at group creation or when a change takes place.
The tag dynamic table is updated whenever Symphony Plus processes an exception report for tags marked for foreign
database export. Since a high exception report rate for tags may cause both overhead and target database oversize, it is
strongly recommended that only a few slow-changing tags (i.e. minute calculations or digital tags) are marked for export.
The alarm dynamic table is updated whenever the Symphony Plus processes an alarm message marked for foreign
database export (or concerning a tag marked for foreign database export). Since a high alarm rate may cause both overhead
and target database oversize, it is strongly recommended that only a few slow-changing tags (i.e. minute calculations or
digital tags) are marked for export.
A trend group dynamic table is updated whenever the S+ archives a trend group defined as historical (archive type INST,
AVERAGE, TOTAL, MIN, MAX, COUNT, MONITOR, RATIO, TRIP) marked for foreign database export. Since a high
archiving rate for trend groups may cause both overhead and target database oversize, it is strongly recommended that only
a few slow-archiving groups are marked for export.
The data type of the fields is function of the target DBMS. Table 2-139, Table 2-140 and Table 2-141 give a sample structure
for dynamic tables, assuming the target DBMS is Oracle8.

2.25.6 Foreign Database Support - Tag Dynamic Table (RTDB)


The following table provides the list of Foreign Database Support – Tag Dynamic Table (RTDB):

Table 2-139: Foreign Database Support – Tag Dynamic Table (RTDB

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
TAGTIME Date Tag time and date.

Optional None
TAGMILSEC Decimal Tag milliseconds.
3
Optional
None
TAGINDEX Decimal Tag index.
6
Optional
None
2VAA000830-330 A 157
S+ Operations DB Reference DATABASE STRUCTURE

TAGUID Character2 Tag unique identification.


36
Optional
None
TAGVALUE Dbl. Prec. Tag value.

Optional None
TAGSTATE Character2 Tag state.
16
Optional
[sztags]
TAGQUALITY Character2 Tag quality.
4
Optional
None

2.25.7 Foreign Database Support - Alarm Dynamic Table (ALARMS)


The following table provides the list of Foreign Database Support – Alarm Dynamic Table (ALARMS):
Table 2-140: Foreign Database Support – Alarm Dynamic Table (ALARMS)

Range Default
Name Format Width Opt/Mnd Description
Parameter(s)
ALARMTIME Date Alarm message time and
date.

Optional None
ALARMILSEC Decimal Alarm message
3,0 milliseconds.
Optional
None
TAGINDEX Decimal Tag index.
6
Optional
None
TAGUID Character2 Tag unique identification.
36
Optional
None
ALARMTYPE Character2 Alarm type.
6
Optional
None
ALARMTEXT Character2 Alarm text.
132
Optional
[s.aldb]

2.25.8 Foreign Database Support - Group Dynamic Table (<group name>)


The following table provides the list of Foreign Database Support – Group Dynamic Table (< group name>):
Table 2-141: Foreign Database Support – Group Dynamic Table (< group name>)

Format Width Range Default


Name Description
Opt/Mnd Parameter(s)
TAGTIME Date Tag time and date.

Optional None
TAGMILSEC Decimal Tag milliseconds.
3
Optional
None
TAGINDEX Decimal Tag index.
6

158 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

None
TAGVALUE Dbl.Prec. Tag value.

None
TAGSTATE Character2 Tag state.
16

[sztags]
TAGQUALITY Character2 Tag quality.
2

None
TRIPTIME Date Trip time and date.

Optional None
TRIPMILSEC Decimal Trip milliseconds.
3
Optional
None
GROUPINDEX Decimal Group index.
6
Optional
None

2.25.9 Data Export Manager


Symphony Plus provides a tool to maintain and monitor foreign database support function. This tool, named ‘Data Export
Manager’, allows the user to perform the following actions (enabled only if Symphony Plus has been configured to support
the ODBC interface):
• Connect Symphony Plus to a defined data source.
• Create a new data source to be connected.
• Inspect data source to get all existing tables.
• Create and realign tables on the data source.
• Query SQL commands to the data source.
To activate the maintenance tool, choose ‘Programs’ from the ‘Start Menu’, then ‘Symphony Plus’ and then ‘Data Export
Manager’. The main dialog window is displayed.
As the program is activated, the only function available is ‘Open Connection’, associated with the icon key:

This key displays the Windows standard ODBC setup wizard, listing all the data sources already configured on the machine.
The first time the program is activated, it creates a new data source specifically dedicated to Symphony Plus. To do it, press
the ‘New’ button, choose one of the ODBC drivers available and provide all required information. Such information depends
on the selected driver, and may range from simple file specification (i.e. desktop databases like MS Access) to network path
and security (i.e. distributed databases like Oracle or MS SQL Server).
Since it is not possible to give a standard procedure for all DBMS, please refer to manufacturer’s documentation. After the
data source has been properly setup, the program will ask the operator to make the selection permanent and to link all
Symphony Plus internal fields to the newly selected DBMS native data types. Next, after the automatically spawned build of
DBXRF is completed, all the tables actually configured on the target database are listed.
If the Symphony Plus data source has been already set up, just select it to get the table list described above. The table list
may also be recalled at any time by the ‘List’ function, associated with the icon key:

The connection just established can be closed when the program is terminated as well as by the dedicated function ‘Close
Connection’, associated with the icon key:

Usually, Symphony Plus creates and initializes static tables at generation time, and then maintains them updated to
guarantee the alignment of their contents with itself. In any case, they can also be created and realigned manually. For
instance, to support the database export function after Symphony Plus has been originally generated or to realign tables
after a communication failure, a manual realignment can be done. This function, indicated as ‘Create and Align’, is associated
with the icon key:
2VAA000830-330 A 159
S+ Operations DB Reference DATABASE STRUCTURE

Each table in list may be inspected to get its structure by the function “Properties”, associated with the icon key:

To get the table structure, select the desired table and press the icon key or just double click the desired table.
The table structure is displayed.
A table, once selected, may also be deleted (dropped) by the function “Delete”, associated with the icon key:

Finally, the target data source, may be queried by any standard SQL command using the function “Query” associated with
the icon key:

This function displays a window to enter the desired query.


The results of the entered query are reported on the main program window. This function must be used carefully, since it
allows also adding, deleting or modifying any table in the database. Then, if the query is not a simple “SELECT”, the user is
asked to confirm it, and all static tables are marked as non-aligned.
The current status (aligned or not) of the two static tables is displayed on the bottom right corner of the display window.

2.25.10 Setup Guidelines


The support to foreign database export may be added at any time to an existing (and licensed) Symphony Plus version 1.2
or higher (even if it has been generated without this feature), using the ‘Data Export Manager’. In any case, it is suggested
to setup this function just BEFORE the very first build all (last step of post-installation procedure), by following the procedure
itemized below:
• Create or modify the system option customizations. Use the Operations Engineering utility to turn the database
export flag ‘OdbcInterface’ to ‘YES’.
• Create or modify the data export customization file ‘DBXRF2DECK.INS’ in folder ‘Symphony Plus\Config’, adding
those fields that need to be exported in addition to standard exported fields, according to the instructions contained
in the S+ Engineering Operations engineering user manual (8VZZ002960T2300).
• Run the ‘Data Export Manager’ and define the Symphony Plus specific data source, according to what’s described
in previous section. Exit the ‘Data Export Manager’.
• Add the proper fields to tag database (‘EXP_VAL’ and ‘EXP_ALA’) and trend group database (‘EXP_VAL’), and
decide which tags and/or groups must be exported.
After these steps, continue the post-installation procedure by generating Symphony Plus database (Build All procedure).

2.25.11 Tuning and Troubleshooting


Symphony Plus logs all unsuccessful queries and function calls in standard error log file (‘Symphony Plus\logs\ErrorLog.Txt’)
or directly displays them through the ‘Data Export Manager’. In both cases, the interested ODBC driver generates these
messages, and then it is not possible to provide a general troubleshooting.
In any case, a couple of cases that can be analyzed with some detail:

2.25.12 Command buffer overflow


All create/insert/delete queries are made by SQL commands submitted to the ODBC driver. These commands are built into
a command buffer, initially allocated to 8 Kbytes.
In case of large tables (i.e. trend group static tables having 100 tags within list or more), this buffer could not be large enough,
and a ‘statement overflow’ error message is generated. In such case, the command buffer may be reallocated by tuning the
system setting under:
\APPS\ODBC\BufferSize
Use the Operations Engineering to configure system settings. After the change deploy to required nodes and, the system
must be restarted.

2.25.13 Duplicate values/primary key violation.


This condition usually indicates that the system tried to export to a given table some record that is absolutely equal (at least
for those field belonging to the primary key) to an existing one. This is not really an error, especially in case of a series of
close trips for the same trend group. In any case, there is no data leak (new records are not exported, but old -equal- records
exist).
160 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

The system settings under: \APPS\ODBC also contains other entries that can be configured to support the foreign database.
The following are the system settings:

2.25.14 Accept Warning


If 0, ODBC warnings will be considered as errors.
If 1, ODBC warnings will be considered ok. The default is 1.

2.25.15 Trace Query


If 1, all queries will be traced on a log file (‘SymphonyPlus\logs\TraceQuery.Txt’). This feature may be useful to debug target
DBMS problems, but must be normally set to 0 (the default).

2.25.16 Alarm Table


It is the name of the alarm dynamic table. The default is ‘ALARMS’.

2.25.17 Group Table


It is the name of the trend group static table. The default is ‘GROUPS’.

2.25.18 RTDB Table


It is the name of the tag dynamic table. The default is ‘RTDB’.

2.25.19 Tag Table


It is the name of the tag static table. The default is ‘TAGS’.
After these parameters are changed, the system must be restarted. If the change affects one of the table names, the table
must be created and realigned.

2.26 Custom Data Base


The following table provides the list of Custom Data base names.
Table 2-142: Custom Data Base

Range Default
Name Format Width Opt/Mnd Description
Parameter(s)
CUSTnTYP Integer Type. <string>
20 Where n denotes 1 to 20. <blank>
Optional
CUSTnVAL Character Value. <string>
256 Where n denotes 1 to 20. <blank> None
Optional

2.26.1 Operator XY-Plot


The following table provides the list of custom database names for Operator XY-plot.
Table 2-143: Custom Data Base for Operator XY-Plot

Field Number Name Format Default Description


1 Group name text Up to 255 char
2 View text RGB(70,80,90)
background
3 Title text color text RGB(255,255,255)
(Group/Plot)
4 Tag info text RGB(160,160,160)
background
5 X-Axis Title text RGB(255,0,0)
Background
6 Y-Axis Title text RGB(0,255,0)
Background
7 Tag name text text RGB(255,255,255)
color
8 Tag value text text RGB(255,255,255)
color
2VAA000830-330 A 161
S+ Operations DB Reference DATABASE STRUCTURE

9 Eng.Unit text text RGB(0,255,0)


color
10 Plot area text RGB(255,255,255)
border color
11 Plot area ruled text RGB(255,255,255)
line color
12 Plot area text RGB(128,128,128)
background
color
13 Able to change bool FALSE TRUE/FALSE
the width of plot
area.
14 Percent of int 50 0 – 100(%)
width of plot
area.
15 Minimum font int 4 4 – 24
size
16~20 Reserved

2.26.2 Plot area specific configuration


The following table provides the list of custom database names for plot area specific configuration.
Table 2-144: Plot area specific configuration

Atom
Name Format Default Description
Number
21 Plot name text Up to 255 char For plot1
22 Number of past text 10 0 - 500
plots
23 Sampling text 0 0:1sec
frequency of 1:5sec
past value 2:10sec
3:30sec
4:1min
5:5min
24 Plotting text 0 0:Line
method of past 1:Symbol
value 2:Line and
Symbol
25 Symbol of text 0 0 :・
current value 1:x
2:+
3:●
4:○
5 :▲
6 :△
7 :■
8 :□
9 :◆
10 :◇
26 Symbol of past text 0 See atom no.25
value
27 Symbol of last text 0 See atom no.25
value
28 Symbol color of text RGB(255,0,0)
current value
29 Symbol color of text RGB(0,255,0)
past value
30 Symbol color of text RGB(255,255,0)
last value
31 Trigger tag text Digital tag name
name
32 X-Axis tag text ;0.000000;100.000000 TagName :Analog
name <TagName>;LL;HL tag
LL: Lower limit
HL: Higher limit
162 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

33 Y-Axis tag text ;0.000000;100.000000 TagName :Analog


name <TagName>;LL;HL tag
LL: Lower limit
HL: Higher limit
34 Line color of text RGB(0,255,255) Bad quality line is
past value non-continuous
35 Split number of text 4 1–8
X-Axis
36 Split number of text 4 1–8
X-Axis
37 - 40 Reserved - - -

The following table provides the list of custom database names for other XY-plot area configuration.
Table 2-145: Other XY-Plot area configuration

Atom
Name Format Default Description
Number
41 - 60 Same as 21-40 For plot2
61 - 80 Same as 21-40 For plot3
81 - 100 Same as 21-40 For plot4

2.27 Database Snapshots


The following table provides the list of Database Snapshots.
Table 2-146: Database Snapshots

Range Default
Name Format Width Opt/Mnd Description
Parameter(s)
SNAPTYPE Integer Type of snapshot <string>
3 <blank> None
Optional
SNAPFILE Character File name of snapshot. <string>
50 <blank> None
Optional
SNAPTIME Integer Creation time. Read only
20
Optional

2.28 File Synchronization


The following table provides the list of Database Snapshots.
Table 2-147: File Synchronization

Range Default
Name Format Width Opt/Mnd Description
Parameter(s)
TAGFILE Character Path of the file(s) to be <string>
254 synchronized. <blank>
Optional
Specifications of an ASCII file
containing the tag list.

Refer to Note 1 at the end of


the table for more details.

Note 1: Basically, there are two methods for specifying tags belonging to a trend group. Either an external tag file or an
internal tag list can be used.

2.29 Logical Colors


The following table provides the list of Logical Colors.
Table 2-148: Logical Colors

Range Default
Name Format Width Opt/Mnd Description
Parameter(s)
LCCOLOR Integer Color. 0
2VAA000830-330 A 163
S+ Operations DB Reference DATABASE STRUCTURE

8 None
Optional
LCBLINK Integer Blink color. 0
8 None
Optional

2.30 Mail Configuration


The following table provides the list of parameters that are included in Mail Configuration.
Table 2-149: Mail Configuration

Range Default
Name Format Width Opt/Mnd Description
Parameter(s)
ENABLEHI Character Enable email at over {Y, N} N None
1 range (High Instrument
Optional Limit).
ENABLEH3 Character Enable email at high 3- {Y, N} N None
1 level alarm.
Optional
ENABLEH2 Character Enable email at high 2- {Y, N} N None
1 level alarm.
Optional
ENABLEH1 Character Enable email at high- {Y, N} N None
1 level alarm.
Optional
ENABLEL1 Character Enable email at low- {Y, N} N None
1 level alarm.
Optional
ENABLEL 2 Character Enable email at low 2- {Y, N} N None
1 level alarm.
Optional
ENABLEL3 Character Enable email at low 3- {Y, N} N None
1 level alarm.
Optional
ENABLELI Character Enable email at under {Y, N} N None
1 range (Low Instrument
Optional Limit).
ENABLEAL Character Enable email at alarm {Y, N} N None
1 (Digital Tag).
Optional
ENABLEACK Character Enable email at alarm {Y, N} N None
1 Acknowledge.
Optional
ENABLERTN Character Enable email at alarm {Y, N} N None
1 return to normal.
Optional
INHIBITTAG Character Tag to inhibit the mail string>
50 functions. <blank> None
Optional
MAILTITLE Character Mail title. string>
256 <blank> None
Optional
MAILBODY Character Mail Body. string>
256 <blank> None
Optional
SMTPSVR Character SMTP e-mail server string>
50 name. <blank> None
Optional
SVRPORT Character Port number of server. string>
1 <blank> None
Optional
164 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

ENABLESSL Character Enable SSL. {Y, N} N None


1
Optional
SMTPUSR Character User name to logon string>
50 SMTP server. <blank> None
Optional
PASSWORD Character User password. <string>
18 <blank> [szunam]
Mandatory The export function does
not fill in this field to
prevent password
decoding.

A new created security


database file does not
include the field.

See also the caution


Note at the end of the
table.
CRYPTPWD1 Encrypted password
MAILFROM Character Mail address for from. string>
50 <blank> None
Optional
ADDRHI Character Send email at over string>
256 range (High Instrument <blank> None
Optional Limit).
ADDRH3 Character Send email at high 3- < string>
256 level alarm. <blank> None
Optional
ADDRH2 Character Send email at high 2- string>
256 level alarm. <blank> None
Optional
ADDRH1 Character Send email at high - string>
256 level alarm. <blank> None
Optional
ADDRL1 Character Send email at low - level string>
256 alarm. <blank> None
Optional
ADDRL2 Character Send email at low 2- string>
256 level alarm. <blank> None
Optional
ADDRL3 Character Send email at low 3- string>
256 level alarm. <blank> None
Optional
ADDRLI Character Send email at under string>
256 range (High Instrument <blank> None
Optional Limit).
ADDRAL Character Send email at alarm string>
256 (Digital tag). <blank> None
Optional
ADDRACK Character Send email at alarm string>
256 acknowledge. <blank> None
Optional
ADDRRTN Character Send email at return to string>
256 normal. <blank> None
Optional

2.31 Quality Attributes


The following table provides the list of Quality Attributes.
Table 2-150: Quality Attributes

Range Default
Name Format Width Opt/Mnd Description
Parameter(s)
FGCOL_PRN Character Foreground color priority. string>
50 <blank> None
optional
2VAA000830-330 A 165
S+ Operations DB Reference DATABASE STRUCTURE

BGCOL_PRN Character Background color priority. string>


50 <blank> None
optional
UID Tag unique identification.

This field provides a unique


identification in the Symphony
Character Plus application history. It is
<string>
36 assigned at import time. Export
<blank> None
Mandatory database to update the field in
the DBF file.

TAGUID is an alias name for


this field.
QUALITYBIT Character Quality bit. string>
50 <blank> None
optional
QUALIVERT Character Quality status inverted. {Y, N} N None
1
optional

Note: “N” can be 1 to 32 for the tag name FGCOL_PR and “N” can be 1 to 32 for the tag name BGCOL_PR.

2.32 Service Scheduler


The following table provides the list of Service Scheduler.
Table 2-151: Service Scheduler

Range Default
Name Format Width Opt/Mnd Description
Parameter(s)
PREVPROC Character Dependent process. <string>
260 The start of the process is <blank> None
optional pending until depended
process is alive.
SYITOWAIT Character SYI to wait. <string>
64 The start of the process is <blank> None
optional pending until specified system
information flag becomes value
configured by “Value to Wait”
option.
SYITOWAITVAL Character Value to wait. <string>
1 The start of the process is <blank> 0
optional pending until specified system
information flag is set.
RUNASINTR Character Run as interactive user. {Y, N} N None
1 Start the process as interactive
optional user.
WAITSTART Character Wait to start. {Y, N} N None
1 To start the service in the
optional period that is configured in
StartWaitInSec system settings
value.
WAITEND Character Wait to end. {Y, N} N None
1 To wait to terminate the
optional service, configure Wait End
Timeout system settings.
Timeout period in seconds
WAITENDTM Character Wait end timeout. <string>
1 Timeout period in seconds <blank> 0
optional
WAITNTFY Character Wait notify. {Y, N} N None
1 Timeout in seconds
optional Wait schedule processing until
event specified in Wait notify
event is set.
NTFYNAME Character Wait notify event. string>
64 Displays the event name for <blank> None
optional this option
166 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

STARTDELAY Character Start delay. <string>


1 Delay to start process <blank> 0
optional measured in seconds.
FAILACT Character Failure actions. string>
50 Action to recover failure state. <blank> None
optional
WDTIMEOUT Character Watchdog timeout. <string>
1 Timeout for process hang <blank> 0
optional detection measured in Set 0 to disable the
seconds. watchdog timeout
Note: This options is only
available for the Apms Service
applications.
PROCNAME Character Process name. string>
260 It is the file name of the service <blank> None
optional or it can be the navigation path
for the file.
CMDLINE Character Command Line. string>
260 <blank> None
optional
WINSRVC Character Windows service. {Y, N} N None
1
optional
SRCNODLST Source node list {Y, N} N None
Set “Yes” for nodes that the No on all nodes.
Apms Scheduler manages
schedule of the service
application.

2.33 Sequence of Events


The following table provides the list of Sequence of Events (SOE).
Table 2-152: Sequence of events

Range Default
Name Format Width Opt/Mnd Description
Parameter(s)
SOELOG Integer Triggered soe number 0
3 None
Optional
PRETIME Integer Pre trip time 0
5 None
Optional
PREUNITS Integer Pre trip time units 0
1 None
Optional
POSTTIME Integer Post trip time 0
5 None
Optional
POSTUNITS Integer Post trip time units 0
1 None
Optional

2.34 USB Recording Devices


The following table provides the list of Service Scheduler.
Table 2-153: USB Recording Devices

Range Default
Name Format Width Opt/Mnd Description
Parameter(s)
DEVINSNAME Character USB key unique device <string>
50 instance ID. <blank> None
Mandatory
AUTHNDLST Character USB exporting authorized node <string>
500 list <blank> None

2VAA000830-330 A 167
S+ Operations DB Reference DATABASE STRUCTURE

2.35 User Favorites


The following table provides the list of User favorites.
Table 2-154: User Favorites

Range Default
Name Format Width Opt/Mnd Description
Parameter(s)
USERCOD Character User Name <string>
50 Indicates Owner name. If this <blank> None
Mandatory item is blank, it means this item
is system defined favorites.
This kind of favorites is not
editable
OWNERITEM Character Database item assigned as <string>
50 owner <blank> None
Optional
MENULINKn Character Menu link for operator favorite n <string>
50 Note: n indicates 1 through 10 <blank> None
Optional menu link.
PARENTITEM Character UID of the Parent Item <string>
36 <blank>

VIEW1 Character Work Place View #1 <string>


256 $$<PluginName>$<ViewName> <blank>

VIEW2 Character Work Place View #2 <string>


256 $$<PluginName>$<ViewName> <blank>
VIEW3 Character Work Place View #3 <string>
256 $$<PluginName>$<ViewName> <blank>
VIEW4 Character Work Place View #4 <string>
256 $$<PluginName>$<ViewName> <blank>
TABBED Character Tabbed Mode {Y,N} N None
1
Optional
VERT_ALIGN Character Vertical Alignment {Y,N} N None
1
Optional
LEVEL Integer Level in the tree view 0
3 None
Optional

2.36 User Roles


The following table provides the list of User roles.

Table 2-155: User Roles

Range Default
Name Format Width Opt/Mnd Description
Parameter(s)
USERROLLEV Integer Role Level 0
8 None
NEEDPASSW Character Need Password for changing {Y,N} N None
1 role
PASSWORD Character Password <string>
32 <blank>
CRYPTPWD1 Character Encrypted password <string>
80 <blank>
SEC_LEVEL Integer Security level 0
2 This field is checked whenever None
a user attempts to access the
alarm group. Only users whose
security level is greater or
equal to what's hereby defined

168 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

are enabled to access the


alarm group.

TAGMONITOR Character Tag monitor privilege {Y,N} N None


1
TAGMONALL Character Tag monitor ALL privilege {Y,N} N None
1
TAGCONFIG Character Tag configure privilege {Y,N} N None
1
TAGVIEWCNF Character Tag view configuration {Y,N} N None
1 privilege
TAGCONTROL Character Tag control privilege {Y,N} N None
1
TAGCONTRO2 Character Tag control 2 privilege {Y,N} N None
1
TAGTUNE Character Tag tune privilege {Y,N} N None
1
TAGDELETE Character Tag delete privilege {Y,N} N None
1
TAGENTDATA Character Tag enter data privilege {Y,N} N None
1
TAGOFFSCAN Character Tag off scan privilege {Y,N} N None
1
TAGOFFALM Character Tag off alarm privilege {Y,N} N None
1
TAGLIMIT Character Tag change limit privilege {Y,N} N None
1
TAGLIMIT1 Character Tag change limit 1 privilege {Y,N} N None
1
TAGLIMIT2 Character Tag change limit 2 privilege {Y,N} N None
1
TAGLIMIT3 Character Tag change limit 3 privilege {Y,N} N None
1
TAGACK Character Tag acknowledge privilege {Y,N} N None
1
TAGREDOP Character Red Tag Operations {Y,N} N None
1
TAGREMOTE Character Tag remote access privilege {Y,N} N None
1
TAGENTHIST Character Tag enter historical data {Y,N} N None
1 privilege
SHELVEALRM Character Tag shelve alarm privilege {Y,N} N None
1
SUPPRALRM Character Tag suppress alarm privilege {Y,N} N None
1
CHANGEPRIO Character Tag change alarm priority {Y,N} N None
1 privilege
OUTOFSERV Character Tag out of service privilege {Y,N} N None
1
LATCHALRM Character Tag latch alarm privilege {Y,N} N None
1
TAGASPECT1 Character Tag control aspect 1 {Y,N} N None
1
………………. ………………………
TAGASPEC10 Character Tag control aspect 10 {Y,N} N None
1
ALARMS Character Alarm management privilege {Y,N} N None
1
GRAPHICS Character Graphics configuration {Y,N} N None
1 privilege
LOGS Character Logs configuration privilege {Y,N} N None
1
HISTORY Character History management privilege {Y,N} N None
1
DIAGNOSTIC Character Diagnostic management {Y,N} N None
1 privilege
SECURITY Character Security management privilege {Y,N} N None
1
2VAA000830-330 A 169
S+ Operations DB Reference DATABASE STRUCTURE

TIMEDATE Character Time and date management {Y,N} N None


1 privilege
VIEWTRENDS Character View Trends privilege {Y,N} N None
1
TRENDS Character Global Trends configuration {Y,N} N None
1 privilege
INFINET Character Harmony modules {Y,N} N None
1 management privilege
GROUPS Character Groups configuration privilege {Y,N} N None
1
UTILITY Character Misc utility configuration {Y,N} N None
1 privilege
CONFIG Character Configuration privilege {Y,N} N None
1
VIEWCONFIG Character View configuration privilege {Y,N} N None
1
REMWRITEF Character Remote write privilege {Y,N} N None
1
VIEWDISP Character View display privilege {Y,N} N None
1
LTERMHIST Character Long term history privilege {Y,N} N None
1
CLSERVER Character Client-server management {Y,N} N None
1 privilege
CALCUL Character Calculation configuration {Y,N} N None
1 privilege
VIEWHIST Character View history privilege {Y,N} N None
1
WINDOWSNT Character Access Windows privilege {Y,N} N None
1
ODBC Character Odbc management privilege {Y,N} N None
1
NAVIGATE Character Web navigation privilege {Y,N} N None
1
CONNECT Character Connect remote servers {Y,N} N None
1 privilege
CHANGEPWD Character Privilege to change password {Y,N} N None
1
APPL1 Character Application specific 1 privilege {Y,N} N None
1
APPL2 Character Application specific 2 privilege {Y,N} N None
1
CMNOPERPA Character Operating Parameters {Y,N} N None
1
CMNPRDIS Character Primary Display {Y,N} N None
1
CMNDISREF Character Display References {Y,N} N None
1
CMNPRIMTR Character Primary trend group {Y,N} N None
1
CMDTRREF Character Trend References {Y,N} N None
1
CMNREPREF Character Report References {Y,N} N None
1
CMNMODSTA Character Module Status {Y,N} N None
1
CMNVWATOM Character View Atoms {Y,N} N None
1
CMNVWLSTAL Character Last Alarms {Y,N} N None
1
CMNVWLSTEV Character Last Events {Y,N} N None
1
CMNVWMELEX Character Melody Explorer {Y,N} N None
1
CMNVWEVTEX Character Event Explorer {Y,N} N None
1
CMNVWSHFBK Character Shift Book {Y,N} N None
1
170 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

CMNVWOPNOT Character Operator Notes {Y,N} N None


1
CMNVWALNOT Character Alarm Notes {Y,N} N None
1
CMNVWOPACT Character Operator Actions {Y,N} N None
1
CMNCOPYTAG Character Copy Tag Name {Y,N} N None
1
SECGRPMSK1 Character #(Security Groups)# 1-16 {Y,N} N None
16
SECGRPMSK2 Character #(Security Groups)# 17-32 {Y,N} N None
16
SECGRPMSK3 Character #(Security Groups)# 33-48 {Y,N} N None
16
SECGRPMSK4 Character #(Security Groups)# 49-64 {Y,N} N None
16
SECGRPMSK5 Character #(Security Groups)# 65-80 {Y,N} N None
16
SECGRPMSK6 Character #(Security Groups)# 81-96 {Y,N} N None
16
SECGRPMSK7 Character #(Security Groups)# 97-112 {Y,N} N None
16
SECGRPMSK8 Character #(Security Groups)# 113-128 {Y,N} N None
16
SECGRPMSK9 Character #(Security Groups)# 129-144 {Y,N} N None
16
SECGRPMS10 Character #(Security Groups)# 145-160 {Y,N} N None
16
SECGRPMS11 Character #(Security Groups)# 161-176 {Y,N} N None
16
SECGRPMS12 Character #(Security Groups)# 177-192 {Y,N} N None
16
SECGRPMS13 Character #(Security Groups)# 193-208 {Y,N} N None
16
SECGRPMS14 Character #(Security Groups)# 209-224 {Y,N} N None
16
SECGRPMS15 Character #(Security Groups)# 225-240 {Y,N} N None
16
SECGRPMS16 Character #(Security Groups)# 241-256 {Y,N} N None
16
FULLSCREEN Character Full screen mode {Y,N} N None
1
CANLOGOFF Character Can logoff {Y,N} N None
1
DEMNDMSK1 Character #(Demandable Security {Y,N} N None
16 Groups)# 1-16
……….. …………….
DEMNDMSK16 Character #(Demandable Security {Y,N} N None
16 Groups)# 241-256
GRANTMSK1 Character #(Grantable Security Groups)# {Y,N} N None
16 1-16
…………. ……………..
GRANTMSK16 Character #(Grantable Security Groups)# {Y,N} N None
16 241-256
CRTMASK1 Character Crt enable mask 1 {Y,N} N None
16
CRTMASK2 Character Crt enable mask 2 {Y,N} N None
16
CRTMASK3 Character Crt enable mask 3 {Y,N} N None
16
CRTMASK4 Character Crt enable mask 4 {Y,N} N None
16

2.37 Users
The following table provides the list of Users.
Table 2-156: Users
2VAA000830-330 A 171
S+ Operations DB Reference DATABASE STRUCTURE

Range Default
Name Format Width Opt/Mnd Description
Parameter(s)
ACTIVEUSER Character Active user {Y,N} N None
1
USERCODE Integer User code 0
4 None
WINGROUP Character Windows user group <string>
64 <blank>

LANGUAGE Character User Language <string>


20 <blank>

USERTHEME Character 50 Theme name to be used by <string>


user. <blank>

LASTLOGIN Integer Last login 0


8 None
WPL_VIEW1 Character Work Place Layout on Monitor <string>
18 1 <blank>
LOGINDISP is alias name for
this field
WPL_VIEW2 Character Work Place Layout on Monitor <string>
18 2 <blank>
WPL_VIEW3 Character Work Place Layout on Monitor <string>
18 3 <blank>
WPL_VIEW4 Character Work Place Layout on Monitor <string>
18 4 <blank>
LOGINPROG Character Login program <string>
18 <blank>
LOGOFFPROG Character Logoff program <string>
18 <blank>
LOGOFFTMO Character Logoff on timeout {Y,N} N None
1
PASSWORD Character Password <string>
32 <blank>
CRYPTPWD1 Character Encrypted password <string>
80 <blank>
PWDAGING Integer Password aging (days) 0
4 None
MAXLOGFAIL Integer Max login failures 0
4 None
USERROLE Character User role <string>
64 <blank>
URERROLE2 Character Second User role <string>
64 <blank>
USERROLE3 Character Third User role <string>
64 <blank>
ANYROLE Character Privilege to impersonate any {Y,N} N None
1 role
SEC_LEVEL Integer Security Level 0
2 None
This field is checked whenever
a user attempts to access the
alarm group. Only users whose
security level is greater or
equal to what's hereby defined
are enabled to access the
alarm group.
Note: For information on remaining fields, refer to 2.36

2.38 Work Place Layout


The following table provides the list of Work Place Layout.

172 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

Table 2-157: Work Place Layout

Format Width Range Default


Name Description
Opt/Mnd Parameter(s)
FPPINAREA Character Applications positioned only in the view {Y,N} N None
1 area.

Note: In case of FPPINAREA is set to YES,


it is recommended to enable the system
setting “WindowLocatorEnable” under
APPS\Layout and deploy this system setting
to required Operations node using
Operations Engineering.
TCANHIDE Character Top View can be hidden {Y,N} N None
1

BCANHIDE Character Bottom View can be hidden {Y,N} N None


1

CCANHIDE Character Center View can be hidden {Y,N} N None


1

PINPANE Character Pin Left and Right Panes {Y,N} N None


1

STATUSBAR Character Show Status Bar {Y,N} N None


1

TIMSTATBAR Character Show Time in Status Bar {Y,N} N None


1

MSBSTATBAR Character Show System Message in Status Bar {Y,N} N None


1

TOOLBAR Character Show Top Toolbar {Y,N} N None


1

BTOOLBAR Character Show Bottom Toolbar {Y,N} N None


1

MAINTOOLB Character Name of the main toolbar <string>


50 <blank>

ALARMOOLB Character Name of the alarm toolbar <string>


50 <blank>

TRENDTOOLB Character Name of the trend toolbar <string>


50 <blank>

DIAGTOOLB Character Name of the diagnostic toolbar <string>


50 <blank>

Character Column definition name.


50 If user describes names separated by a <string>
LISTALM Optional semicolon, ZoomIn/Out feature will be valid. <blank>
If this parameter is blank, alarm group refers None
to the workplace parameter.
ALMIMLIST Character Alarm list for filtering alarm mimic for this <string>
256 workplace layout <blank>

ALMGRPDESC Character Show Alarm Tree Description <string>


50 <blank>

TOPNAVIG Character Show Top Area View {Y,N} N None


1

TOPNAV Character Top Area View <string>


256 <blank>

2VAA000830-330 A 173
S+ Operations DB Reference DATABASE STRUCTURE

TOPNAVSZ Character Top Area View Vertical Size <string>


50 <blank>

VIEW1 Character Work Place View #1 <string>


256 <blank>

VIEW2 Character Work Place View #2 <string>


256 <blank>

VIEW3 Character Work Place View #3 <string>


256 <blank>

VIEW4 Character Work Place View #4 <string>


256 <blank>

VIEWNOPRIV Character Work Place View No Privilege <string>


256 <blank>

CAPVIEW Character Show Caption <string>


50 <blank>

TABBED Character Tabbed Mode {Y,N} N None


1

VERT_ALIGN Character Vertical Alignment {Y,N} N None


1

CLOCKWiSE Character Enable Clock Wise Navigation {Y,N} N None


1

ACTBORDER Character Show Window Active Border Colored {Y,N} N None


1

VWTITLEBAR Character Show Display Title bar {Y,N} N None


1

VWAMPRMBTN Character Show Alarm mimic permit button on title bar {Y,N} N None
1 on each childframe

HISTFAV Character Navigate on Favorite {Y,N} N None


1

ALMILAYOUT Character This workplace layout is only for Alarm {Y,N} N None
1 Mimic

BOTNAVIG Character Show Bottom Area View {Y,N} N None


1
BOTNAV Character Bottom Area View <string>
256 <blank>

BOTNAVSZ Character Bottom Area View Vertical Size <string>


50 <blank>

LEFTPANE Character Show Pane at Left {Y,N} N None


1

LEFTNAVSZ Character Left Pane Horizontal Size <string>


50 <blank>

LEFTNAVIG Character Show Navigation Pane at Left {Y,N} N None


1

LEFTNAV Character Left Navigation View <string>


256 <blank>

LEFTHIST Character Show History Pane at Left {Y,N} N None


1

174 2VAA000830-330 A
S+ Operations DB Reference DATABASE STRUCTURE

LEFTFAVOR Character Show Favorites Pane at Left {Y,N} N None


1

DISPLTREE Character Show Displays Tree at Left {Y,N} N None


1

ALARMTREE Character Show Alarms Tree at Left {Y,N} N None


1

ASPECTREE Character Show Aspects Tree at Left {Y,N} N None


1

RIGHTPANE Character Show Pane at Right {Y,N} N None


1

RIGHTNAVSZ Character Right Pane Horizontal Size <string>


50 <blank>

RIGHTNAVIG Character Show Navigation Pane at Right {Y,N} N None


1

RIGHTNAV Character Right Navigation View <string>


256 <blank>

RIGHTHIST Character Show History Pane at Right {Y,N} N None


1

RIGHTFAVOR Character Show Favorites Pane at Right {Y,N} N None


1

RDISPLTREE Character Show Displays Tree at Right {Y,N} N None


1

RALARMTRE Character Show Alarms Tree at Right {Y,N} N None


1

RASPECTREE Character Show Aspects Tree at Right {Y,N} N None


1

BTMFLYOUT Character Show Bottom Flyout <string>


50 <blank>

VIEWBUF1 Character Work Place Buffer View #1 <string>


256 <blank>

VIEWBUF2 Character Work Place Buffer View #2 <string>


256 <blank>

VIEWBUF3 Character Work Place Buffer View #3 <string>


256 <blank>

VIEWBUF4 Character Work Place Buffer View #4 <string>


256 <blank>

TOPALARM Character Show Last Alarms at Top {Y,N} N None


1

TOPALM Character Top Alarm Column Definition <string>


256 <blank>

TOPALMSZ Character Top Alarm View Vertical Size <string>


50 <blank>

BOTMALARM Character Show Last Alarms at Bottom {Y,N} N None


1

BOTALM Character Bottom Alarm Column Definition <string>


256 <blank>

2VAA000830-330 A 175
S+ Operations DB Reference DATABASE STRUCTURE

MAXFPLATES Character Max Number of Faceplates <string>


50 <blank>

2.39 Themes
The following table provides the list of themes:
Table 2-158: Themes

Range Default
Name Format Width Opt/Mnd Description
Parameter(s)
FONT Character Default font name to be used <string>
50 on WP and client application. <blank>

FONT_SIZE Character Default font size to be used on <string>


50 WP and client application. <blank>

FONT_COLOR Character Default font color to be used on <string>


50 WP and client application. <blank>

BGCLR Character Background Color <string>


50 <blank>

SLCTCLR Character Selection Color <string>


50 <blank>

SLCTCLR Character Selection Text Color <string>


50 <blank>

GRIDLINECLR Character Grid line color in list view <string>


50 <blank>

LISTGRID Character Enable grid line in list view {Y,N} N None


1

LISTSTRIPE Character Enable stripe in list view {Y,N} N None


1

STRIPECLR Character Stripe color of even rows in list <string>


50 view <blank>

176 2VAA000830-330 A
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

3. OFF-LINE SYSTEM CONFIGURATION TABLES


3.1 Deck Files Configuration
The user can customize S+ Operations (using an off-line) by editing the set of DECK files (DECKs) (<filename>.xml). By default,
these files are available in the path: C: \ Program Files x (86) \ ABB Symphony Plus \ Operations \ deck. These files are
processed and loaded in S+ data files by running the “Build Procedure. The changes to customizations encoded in a DECK file
must be carried out by copying the specific DECK file to folder C: \ ProgramData \ ABB Symphony Plus \ Operations \ SV3 \
config \ deck.

The filename renamed as “<…2deck.xml>”, (e.g. to change the customizations configured in “Balcdeck.xml”, copy the file as
“Balc2deck.xml” to folder specified before) and then edit the “…. 2deck.xml” file to define the changes to standard customization.
A “<…2deck.xml>” file should contain only changes compared to default configuration (defined by original “DECK” file).

When the Build action is performed, the “…deck” file automatically references to the “…2deck” file (if existing), and the “…2deck”
file is executed after the execution of “…deck” file overwriting standard settings with the customized file.

Advanced users can customize the deck files in order to change system behavior in terms of quality handling, color
management, thread handling, system timers, database defaults, error and log message handling with respect to project specific
requirements.

Table 3-1: Deck Files

Deck File Description


AlarmPrioSeverityInfo This deck file is used by the system Alarm Priority and Severity information.
Alias This deck file is used for configuring the server details for OPC DA\AE connectivity.
AlignConfig This deck file is used for aligning the files from a particular path across S+ Engineering server
and or S+ Operations ClientServer and or S+ Operations client and or S+ Operations Server
only.
Balcdeck This deck file is used for performing the custom configuration of Alarm List Column definition.
Balmdeck This deck file that determines the data to be displayed in the alarm list. This file is also
covering a number of presentation (Standard, Navigation, Full, etc.) that operators can utilize
to have, case by case, the best operational view for the specific alarm situation and Alarm
Messages. The Alarm Comments are able to be shown in the Alarm List Display.
Bemfdeck This deck file defines the S+ Operations error messages and also supports application
specific error message configuration.
Bfildeck This deck file is used by the system for internal dafs file configuration.
BFilterSymDeck In case project using filter configuration to filter macro symbols.
BInputParDeck This deck is used in case of project specific graphic symbols are defined with custom Global
Symbol Attributes.
Btimdeck This deck file used to determine timers in the system.
Correspondences This deck file is used by the system database builder tools like generic importer to define the
mapping between MS Access databases to DBF file.
DataProcessors This deck file is used by the system while mapping the dataprocessor during tag
configuration.
DBHeader This deck file is used by the system to define the header column of a imported DBF file.
Dbxrfdeck This deck file is used for determining the default columns on export of any database.
InfiFC This deck file is used for harmony connectivity for function code definitions.
OpcPriority This deck file is used by OPC connectivity for AE client configuration with Severity Vs Priority
mapping.
PvLevelDef This deck file is used by the system for the definition of alarm levels for process variables.
RegConf This deck file is used by the system for the definition of required system settings.
SysLogFilter This deck file is used by the system for the definition of Audit trial configuration.
XRef This deck file is used by the system database builder tools like generic importer to define the
mapping between MS Access databases to DBF file.

3.2 Builder BFIL – XML Format – File System General Definition


The following table provides the list of Builder BFIL – XML Format – File System General Definition:

Table 3-2: Builder BFIL – XML Format – File System General Definition
2VAA000830-330 A 177
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

Format Range
Parameter Description
Opt/Mnd Default
Action Code.

Allowed action codes are:

init - Initialize disk resident file directory, add - Add file {init, add,
Character
action to disk resident file directory, replace - Replace file to replace,
Mandatory
disk resident file directory, delete} None
Delete - Delete file from disk resident directory.

A maximum of [N.DIR] files may be added to the file


system.
File name.
Character <string>
name
Mandatory This field is defined the name of the file as a 6 <blank>
character string.
File description.
Character <string>
description
Optional Free format description of the data file, as a <blank>
32 character string.
File type.

Allowed file types are:


Character
type {D,C,P} None
Mandatory
D - Disk file,
C - Core file,
P - Parallel file.
File key.

The file key is an integer numeric name of three digits,


Character
key which refer to the file. {1...999} None
Mandatory
It must correspond with the number assigned
internally to the software for accessing the files.
Specifies the path of the file.
Character None
path If a valid file path is not specified, the file is assumed
Optional None
to be: key.DAT (located in the \Data folder) where key
is specified in the file key field on card
Number of records in the file.

The number of records is an integer numeric value.


Character {1...65535}
records It can be directly defined using a numeric value, or
Mandatory None
using an Ascii string, which refer to the corresponding
parameter defined in the system settings, under the
“sizes”.
Remote file writing enabled.
Character
remote_write {Y,N} N
Optional If set, a remote client can update the file via
DDE service.
Record size in words.
Character {0, 1...65535}
size The size of records is an integer numeric value.
Optional 0
If it is 0 the system supplies the size of the internal
structure which defines the record of file.
Snapshot file.
Character
save_snapshot {Y,N} N
Optional If set, the file will be created on multiple snapshot
folders for simulation purposes.
Save Initial condition file.
Character
save_initial {Y,N} N
Optional If set, the file will be saved as initial condition for
simulation purposes.
Character Skip Initialization.
skip_initialization {Y,N} N
Optional If set, the file will not be initialized when created.

178 2VAA000830-330 A
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

3.3 Builder BTIM- Time Definition


The following table provides the list of Builder BTIM – Timer Definition:
Table 3-3: Builder BTIM – Timer Definition

Format Range
Parameter Description
Opt/Mnd Default
Action code.

Allowed action codes are:


Character {init,add,replace}
action
Mandatory init - Initialize timer definition file, add - Add timer definition, None
replace - Replace timer definition,

A maximum of [N.SCTM] timers can be added.


Character None
name Timer name., according to the internal software definition
Mandatory None
Timer Period.
Integer
frequency
Optional
A value of 0 means self-scheduled process. 0
Units for timer period.
Character
freq_unit None} None
Optional Allowed values are: “sec”, “min”, “hour’, “day”, “month”,
“year’
Timer offset.

It specifies a time value added to the base time before


timer is executed. Base time depends on timer period units.
Character If timer period unit is seconds: base time begins at last
offset
Optional minute. If timer period unit is minutes: base time begins at
0
last hour. If timer period unit is hours: base time begins at
last midnight. If timer period unit is days: base time begins
at last Monday’s midnight. Delay must be less than timer
period.
Units for timer offset.
Character
offs_unit
Optional Allowed values are: “sec”, “min”, “hour’, “day”, “month”, and
None
“year Timer offset must be less than timer period.
Initial delay.
Character
delay
Optional
It specifies a delay to apply before to start the timer. 0
Units for initial delay.
Character
delay_unit
Optional Allowed values are: “sec”, “min”, “hour’, “day”, “month”,
None
“year’
Active flag.
Character {Y,N}
active
Mandatory N
Specifies if the timer is active or not.

3.4 Builder DBXRF - Database Field Assignment Definition


The following table provides the list of Builder DBXRF – Database Field Assignment Definition:
Table 3-4: Builder DBXRF – Database Field Assignment Definition

Format Range
Column Description
Opt/Mnd Default
Action code.

Allowed action codes are:


Character {init,add,replac
Action
Mandatory init - Initialize DBXRF definition file, add - e} None
Add DBXRF definition,
replace - Replace DBXRF definition

2VAA000830-330 A 179
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

A maximum of 1200 definitions can be


added.

DB_XREF

The name of the database field.

It corresponds to the name of the column


Character
Name in the DBF or XLS file. <string> None
Mandatory
Note that DBF limit the column names to
10 characters.
The description of the database field.
Character
descr <string> None
Optional
This field is limited to 28 characters.
Reference of database field.

It uniquely identifies the field to allow


handling during database processing.
Character Field reference is a string value and may
Code <string> None
Mandatory be specified according to the parameter
file LOADPRM which include the
symbols.

Default value.

The default value is assigned when field


Character <string>
default is not defined within the input database.
Optional None
If this field is not specified the default
value is 0 for numeric fields and empty
string for text fields
Field assignment call-back name (case
sensitive).
Character
callback <string> None
Optional
If no name is supplied, direct field
assignment is selected.
0 (field value inherited
from Control
Engineering and
mapped vice versa)
1 (mandatory field to
be displayed in S+
Defines the ownership of different Engineering’s Bulk
Integer database fields within different Engineering)
HmiToEngineering
Mandatory Symphony Plus applications. User 2 (field set to be
should not modify the values of this field. displayed in S+
Engineering’s Signal
Manager)
3 (optional field to be
displayed in S+
Engineering’s Bulk
Engineering)
Character
unbuild_callback Export call-back name (case sensitive). <string> None
Optional
DBF Export inhibit flag.

If set, the field is considered optional and


will not be created upon database
export. Otherwise it is mandatory and it
Character will be created.
dbfunbuild {Y, N} N
Optional
This selection only applies to export
operations specifying a new target
database. If a reference database is
specified, its structure will be used. That
is, all and only the fields thereby defined

180 2VAA000830-330 A
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

will be exported, ignoring the export


inhibit flag setting.

This flag is duplicated by the “DBF”


under the UNBUILD section

XLS Export inhibit flag.

If set, the field is considered optional and


will not be created upon database
export. Otherwise it is mandatory and it
will be created.

This selection only applies to export


Character operations specifying a new target {Y, N}
xlsunbuild
Optional database. If a reference database is N
specified, its structure will be used. That
is, all and only the fields thereby defined
will be exported, ignoring the export
inhibit flag setting.

This flag is duplicated by the “XLS”


under the UNBUILD section

ITEMTYPE

Item type to which field assignment is


applied. Item type is an string value
according to the parameter file SYSPRM
.
Character
Type <string> None
Mandatory A list of legal item types is shown in the
Appendix
A.
At least one of these types must be
specified for each DB_XREF definition.

ALIAS

Name of an aliases field. Defines an


alternative name for the column of the
DBF or XLS file
Character
Name Up to 8 alias name can be assigned for a <string> None
Optional
DB_XREF.

Alias name are limited, by DBF, to 10


characters

UNBUILD

Character <string>
Name The name of the field
Mandatory None
Output field type.

Allowed output field types are:

C - Character.
Character {C, N}
Type N - Numeric.
Mandatory None
This selection only applies to export
operations specifying a new target
database. If a reference database is
specified, its structure will be used.
Integer <number>
length Output field size.
Mandatory 0

2VAA000830-330 A 181
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

Flag specifying if the field will be


Character
Dbf exported to DBF files (see above) {Y,N} N
Optional
Flag specifying if the field will be
Character {Y,N}
Xls exported to XLS files (see above)
Optional N

3.5 Builder BALC – Alarm List Column Definition


The following table provides the list of Builder BALC – Alarm List Column Definition:
Table 3-5: Builder BALC – Alarm List Column Definition

Format Range
Parameter Description
Opt/Mnd Default
LIST_DEFINITION
Character <string>
name The name of definition
Mandatory None
Character <string>
description Description of definition
Optional None
LIST_PROCESSING
Character {Y,N}
full_color Fill background color for full line of alarm.
Optional N
Full_color_text Character Fill foreground text color for full line of alarm. {Y,N}
Optional N
View_header Character Show column header. {Y,N}
Optional N
Font_name Character Font name. {Y,N}
Optional N
Font_size Character Font size. {Y,N}
Optional N
Max_buffered_alarrms Character Max alarm record to be retrieved from server. {Y,N}
Optional N
statusquery Character Formatting of show alarms {Y,N}
Optional N
Descending_order Character Get the data form, then navigate to end of the {Y,N}
Optional alarm queue, data will be sorted. N
Back_first_page Character Navigates back to first page when new alarms {Y,N}
Optional are displayed. N
Reverse_order Character Latest alarm is displayed in the bottom of list. {Y,N}
Optional (Use with pages) N
statusbar Character Displays status bar. {Y,N}
Optional N
statusquery Character Formatting of show alarm information on <string>
Optional status bar. None
e.g. “Total %1 Acked %5”

Use %1 to %a. as follows.


%1: Number of alarms
%2: Active and unacked alarms count.
%3: Inactive and unacked alarms count.
%4: Inactive and acked alarms count.
%5: Active and acked alarms count
%6: Hidden alarms count.
%7: Shelved alarms count.
%8: Out of service alarms count.
%9: Auto hidden (suppress) alarms count.
%a: %2+%3
STATUSBAR
Hide_indicator_alarm Character Hides the statusquery on the status bar. {Y,N}
Optional N
Hide_indicator_totalarm Character Hides the total number alarms on the status {Y,N}
Optional bar. N
Hide_indicator_almpage Character Hides the number of alarms on the page of {Y,N}
Optional status bar N
Hide_indicator_page Character Hides page number on the status bar. {Y,N}
Optional N
Hide_indicator_filter Character Hides current filter information on the status {Y,N}
Optional bar. N
182 2VAA000830-330 A
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

COLUMN
Name Character Header name. <string>
Mandatory None
Size Character Column width. <number>
Mandatory 0
Icon Character Shows acked icon in the column. {Y,N}
Optional N
blink Character Blinking background color of unacked alarm {Y,N}
Optional item. N
Blink_text Character Blinking foreground text color of unacked {Y,N}
Optional alarm item. N
P1…Pn Character ID of parameter. <string>
Mandatory None
Right_align Character Right align text. {Y,N}
Optional N
Concat Character Concat each string. P1,P2,… {Y,N}
Optional N
Ascending Character Sort in ascending order. It uses sort order. {Y,N}
Optional Note: If user sorts in descending order, use N
‘sortorder’
sortorder Character Sort order. <number>
Optional 0

3.6 Builder BALM - Alarm Message Definition


The following table provides the list of Builder BALM – Alarm Message Definition:
Table 3-6: Builder BALM – Alarm Message Definition

Format Range
Parameter Description
Opt/Mnd Default
Action code.

Allowed action codes are:


Character {init,add,replace}
action
Mandatory None
Init - Initialize alarm messages definition file, Add - Add
an alarm message,
Replace- Replace an alarm message,
Alarm message code/number.
<string> or
Char or Int The field specifies the alarm message being defined.
Code {1...999}
Mandatory The alarm message number is an integer value and
[mxamsg]
may be specified either by number or by a symbol (the
parameter file BALMPRM includes the symbols).
The text string, which correspond to the alarm
Character
Value message. The parameters are replaced by the <string> None
Mandatory
parameters (P1 to P10).
Symbolic definition of the type of the first parameter.
Character Refer to table 3-15 for the list.
p1 <string> None
Optional Up to 30 parameters can be specified for an alarm
message
Integer Integer
l1 Length (in characters) of the first parameters.
Optional 0

3.7 Message Subsystem - Dynamic Text Definition Symbol


The following table provides the list of Message Subsystem – Dynamic Text Definition Symbol:
Table 3-7: Message Subsystem – Dynamic Text Definition Symbol

Symbol Field Type Description


%s String The field will be filled by a sequence of characters.

3.8 Builder BEMF - Error Message Definition


The following table provides the list of Builder BEMF - Error Message Definition:
Table 3-8: Builder BEMF - Error Message Definition
2VAA000830-330 A 183
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

Format Range
Column Description
Opt/Mnd Default
Action code.

Allowed action codes are:

Character Init - Initialize error message definition file, {init,add,replace}


action
Mandatory Add - Add error message definition, None
Replace - Replace error message
definition,
If a message does not exist, action code R
means add.
Error message identifier.

Character or integer The identifier is an integer value and may


code {1...999} None
Mandatory be specified either by number or by a
symbol (the parameter file BEMFPRM
defines the symbols).
This is the text of the message. The syntax
Character is according to the standard C language
value <string> None
Mandatory formatting; the meaning of the parameters
is defined below.

3.9 Message Subsystem - Text Definition Symbols


The following table provides the list of Message Subsystem – Text Definition Symbols:
Table 3-9: Message Subsystem – Text Definition Symbols

Symbol Field Type Description


%s String The field will be filled by a sequence of characters.
The field will be filled by a set of digits to represent an integer or a real
%d Digit
number.

3.10 Color DB HNMCOL


The following table provides the list of Color DB HNMCOL details:
Table 3-10: Color DB HNMCOL

Format Width Range Default


Name Description
Opt/Mnd Parameter(s)
Character
NAME Name None
50
Character
DESC Description None
256
Type “N”
COLOR Logical Color None
8

3.11 Tag DB HNMNDC


The following table provides the list of Tag DB HNMNDC details:

Table 3-11: Tag DB HNMNDC

Format
Range Default
Name Width Description
Parameter(s)
Opt/Mnd
Integer
INDEX Index None
6
Character
NAME Name None
50
Character
DESC Description None
256
SRCNODMSn Character Source node mask (n) Sequence {Y, N}
16 16*N
Optional None
184 2VAA000830-330 A
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

SRCNODMSK is the alias


name for SRCNODMS1
field

n = 1 to 4

Destination node mask (Op.


actions) (n)
Character
DESTNODMSK is the alias
DESTNODMSKn 16 {Y,N}N, None
name for DESTNODMS1
Optional
field

n = 1 to 4
DESTVALMSn Character Destination node mask Sequence {Y, N}
16 (values) (n) 16*N
Optional None
DESTVALMSK is the alias
name for DESTVALMS1
field

n= 1 to 4

CMDNODMSn Character Command node mask (n) {Y,N}N None


16
Optional CMDNODMSK is the alias
name for CMDNODMS1

n= 1 to 4

Forward node mask (1)


Character
FWDNODMSK 16 {Y,N}N None
FWDNODMS1 is the alias
Optional
name for this field
Character Forward node mask (n)
FWDNODMSn 16 {Y,N}N None
Optional n=2 to 4
CNFNODMSn Character Configuration node mask (n) {Y,N}N None
16
Optional CNFNODMSK is the alias
name for CNFNODMS1

n= 1 to 4

HISTVALMSn Character History Align node mask (n) {Y,N}N None


16
Optional HISTVALMSK is the alias
name for HISTVALMS1

n=1 to 8

3.12 Tag Types


The following table provides the list of Tag types:
Table 3-12: Tag types

Tag Type Description


It is used for/with the following:
• all Analogic Values
• from any TagSrc, except CNTRO and SOE
ANALOG
• integer values using the flag I4
• INFI be equivalent of AOL (Function Code 30) or AOLDB (Function
Code 48)
It is used in OPC TagSource. Translated to VT_R8.
ANALOG8
If the driver is Modbus then tag source is EXT.

2VAA000830-330 A 185
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

CFB Tag Cliff. It is used only with INFI TagSource.


DAANALG It is used only with INFI TagSource (OPC Translate it to Analogic)
Data Acquisition Analog (Function Code 177)
DADIG It is used only with INFI TagSource (OPC Translate it to Digital)
Data Acquisition Digital (FC 211))
DADIGTL It is used only with INFI TagSource (OPC Translate it to Digital)
Data Acquisition Digital (FC 211))
DANG It is used only with INFI TagSource (OPC Translate it to Analogic)
Data Acquisition Analog (Function Code 177)
DATETIME It is used Only with OPC TagSource translated to (VT_BSTR)
DBMAPPED Internal Value used to retrieve information from Symphony plus atoms
For Example: Trend, NertworkMask and so on
DD It is used only with INFI TagSource (OPC Translate it to Digital)
Device Driver (Function Code 123)
DELTATIME Date difference.
It is used only in OPC translated to (VT_UI4)
DEVSTAT It is used for Diagnostic Tags.
It is used only with TagSource DEVSTA.
DIGEIN It is used only with INFI TagSource (OPC Translate it to Digital)
Enhanced Digital Input (Function Code 224)
DIGEOUT It is used only with INFI TagSource (OPC Translate it to Digital)
Enhanced Digital output (Function Code 225)
DIGITAL Tag Digital (Function code 45).
DIGRPT It is used only with INFI TagSource (OPC Translate it to Digital)
Digital Output Tag
INTEGER Integer Value. It is used in OPC (VT_I4) and in EXT if the driver is Modbus.
Usually for an integer value ANALOG with flag I4 is used.
INTEGER8 Integer Value 8byte. It is used in OPC (VT_I8) and in EXT if the driver is
Modbus.
MSDD It is used only with INFI TagSource
MultiState Device Driver (Function Code 129)
NODESTA It is used for the status of the Node. No longer Used.
RCM It is used only with INFI TagSource (OPC Translate it to Digital)
Remote Control Memory (Function Code 62)
RMCB It is used only with INFI TagSource (OPC Translate it to Digital)
Remote Motor Control Block (Function Code 136)
RMSC It is used only with INFI TagSource (OPC Translate it to Analog)
Remote Manual Set Constant (Function Code 68)
STATION It is used only with INFI TagSource (OPC Translate it to Analog)
TCPADDR IP Address. No Longer Used.
TEXT It is used only with INFI TagSource
It is a integer, text selector (Function Code 151 )
TEXTSTR This is a string of text.
It is used only with INFI TagSource (Can Function Code 194)
It can be used in OPC, translation to (VT_BSTR)
Usually used also in custom app in User and LAB Tag.
UINTEGER Unsigned Integer. It is used with OPC TAgSource
UNDEF Internal Value used to retrieve information from Symphony plus atoms.
For Example: Trend, NertworkMask, and so on.
ANGRPT It is used only with INFI TagSource (OPC Translate it to Analog)
APMSSTA Digital Value. It is used for Status of Hardware devices.
A Bitmask tag is a type that is source for other tag that splits the bits.
BITMASK
It is used in DEVSTA and EXT (Modbus Driver) tagsrc.
Array of Bytes.
BYTEARR
No Longer used.
It is used only with INFI TagSource (OPC Translate it to Analog)
ANAEIN
Enhanced Analogic Input (Function Code 222)
It is only with INFI TagSource (OPC Translate it to Analog)
ANAEOUT
Enhanced Analogic Output (Function Code 223)

3.13 Tag Sources


The following table provides the list of Tag sources:
Table 3-13: Tag Sources
186 2VAA000830-330 A
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

Tag Source Description


It is used in standard Harmony Layout with C-Net DCS. Data and
Alarms are received from the connected devices. Extended
Redundancy, and command are supported.
Note: It is also possible to add HMI Logics but it is rarely used.
The following TagType are used:
• ANALOG: Analogic AOL (Function Code 30). Also Function
Code 48 (AOLDB Analogic with DeadBand)
• ANAEIN: Enhanced Analogic Input (Function Code 222)
• ANAEOUT: Enhanced Analogic Output (Function Code 223)
• ANGRPT: Output Analogic Tag
• CFB: TAg Cliff
• DAANALG: DAta Acquisition Analog (Function Code 177)
• DANG: Data Acquisition Analog (Function Code 177)
• DADIG: Data Acquisition Digital (FC 211)
INFI • DADIGTL: Data Acquisition Digital (FC 211)
• DD: Device Driver (Function Code 123)
• DIGEIN: Enhanced Digital Input (Function Code 224)
• DIGEOUT: Enhanced Digital output (Function Code 225)
• DIGITAL: Digital Tag DOL (Function code 45). And
alsoFunction Code 67 (DOLDB Digital with DeadBand)
• DIGRPT: Digital Output Tag
• MSDD: MultiState Device Driver (Function Code 129)
• RCM: Remote Control Memory (Function Code 62)
• RMCB: Remote Motor Control Block (Function Code 136)
• RMSC: Remote Manual Set Constant (Function Code 68)
• STATION: Station Tag (Function Code 80)
• TEXT: Text selector (Function Code 151)
• TEXTSTR: Text Tag (Function Code 194)
It is used for scanner acquisitions. Ensure to provide the DriverName.
Alarms Management is typically managed by HMI logic, Extended
redundancy, and command related to different drivers are supported.
Note: MArkDriver manages alarms directly.
TagType that is used are:
EXT • Analogic
• Digital
For Modbus also:
• Integer
• Integer8
• Analog8
It is used for tags that are calculated in the Symphony plus server
using S+ Calculation machine. Alarms Management is typically
CALC managed by HMI logic. MASTER/SLAVE mechanism is supported.
Extended redundancy, and command support are not supported. The
Function “Save Value” stores the values. All Tag Types can be used.
It is used for tags created by users for testing purpose. The last values
of the tags are saved and are restored at the startup, this ensures the
quality of the tag is not BAD. These tags are not managed by extended
LAB
redundancy, they are sent after any variation in case of standard
redundancy. Alarms are managed by HMI Logics. Command is not
supported. All Tag Types can be used.
It is used for tags created by users for testing purpose. The tags are
not related to any connectivity. Alarms Management is typically
USER
managed by HMI logic. Extended redundancy, and command are not
supported. All Tag Types can be used.
It is used for diagnostic tags. Alarms Management is typically managed
DEVSTA by HMI logic. Extended redundancy, and command are not supported.
All Tag Types can be used. BITMASK type is used always.
It is used for generic OPC tags. Alarms Management is managed using
OPC A/E or by HMI Logics. Extended redundancy, and command are
supported.
OPC
Note: OPC supports Symphony plus TagType but for most types the
tags are transformed to generic.

The following Tag types are used:

2VAA000830-330 A 187
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

ANALOG, DAANALG, DADIGTL, DANG, RMSC, STATION, ANGRPT,


ANAEIN, ANAEOUT are translated in VT_R4
ANALOG8 is translated to a VT_R8
DADIG, DD, DEVSTAT, DIGITAL, MSDD, RCM, RMCB, DIGRPT,
APMSSTA, NODESTA, DIGEIN, DIGEOUT are translated in a
VT_BOOL
TEXTSTR is translated in a VT_BSTR
INTEGER is translated in a VT_I4
INTEGER8 is translated in a VT_I8
UINTEGER, DELTATIME, N90STA, BITMASK are translated in a
VT_UI4
DATETIME is translated in a VT_DATE
It is used for generic OPC UA tags. Commands propagation is
OPC UA
supported. OPC UA transparent redundancy are supported.
Create OPC tag for specific Universal Connector. For more
UNIVERSAL
information, refer OPC.
Create OPC Tag for specific AC800F. For more information, refer
AC800F
OPC.
AC800M Create OPC tag for specific AC800M. For more information, refer OPC.
AC450 It is used for a specific OPC A450.
It is used, if a tag is generated from another tag. Alarms Management
TAGGEN is typically managed by HMI logic. Extended redundancy, and
command are not supported. All tag types can be used.
L23 Not supported in Symphony plus.
PROP13 It is used in Melody environment (evolution).
It is used for Sequence of Events for a Harmony tag. This is managed
by Scanner with SOEDriver. Alarms Management is typically managed
SOE by HMI logic. Command is not supported. Extended Redundancy is not
supported because the buffer of HPC800 is unique; a Running / Stand
By redundancy can be used. TagType must be Digital.
It is used for Sequence of Events of Symphony Plus Din rail controller’s
system reporting over IEC 60870-5-104 file transfer mechanism. IEC
SOE104 60870-5-104 Master driver used for file transfer, later Operations core
manages the alarm management, and eventually reports are generated
in S+ Operations History.
From 3.x version, it is used in PG-1000 integration. This provides
grouping of INFI tags to support multiple tags with faceplate. Multiple
INFI tags with extra string reference defines data processor files for this
CNTRO source.
Since, this tag source refers to multiple tags there is no Alarms
management, extended redundancy, and command are not supported.
TagType must be Digital.
MELODY It is used in Melody environment.
P14 It is used in Melody environment.
It is replaced by INFI tagSrc
C-NET
It is not supported in Symphony plus.
NOTE: This table indicates supported tag source in tag database only, and this may
vary with respect to connectivities supported in different releases. User must refer to
respective version release notes for information on supported connectivities.

3.14 Default Color Map


The following table provides the list of Default Color Map details:
Table 3-14: Default Color Map

Code Color
0 Black
1 Red
2 Green
3 Yellow
4 Blue
5 Magenta

188 2VAA000830-330 A
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

6 Cyan
7 White
8 Orange
9 Slate Blue
10 Hot Pink
11 Sea Green
12 Spring Green
13 Chocolate
14 Lavender
15 Sandy Brown
16 Tomato
17 Turquoise
18 Deep Pink
19 Dark Violet

For compatibility with older Symphony Plus versions, the first eight colors in the table match the old color table.
The color table above is defined in the BattColors file. The default color scheme defined in the BattColors file can be modified
changing the RGB pattern definition (e.g. RGB (80,80,80), RGB(FF,00,FF)) and typing the color name (e.g. gray, fuchsia)
as defined in the Internet Explorer color table. When an Internet Explorer color name is used, the RGB definition can be left
undefined typing RGB (-1,-1,-1). The color name is always mandatory.
Since an Internet Explorer color may not have a name defined, a color name must be associated to such color in order to
use it in the BattColors file.
Valid color definitions are the following:
RGB(-1,-1,-1) - fuchsia
RGB(FF,00,FF) - fuchsia // Same as previous RGB(FF,99,FF) - lightfuchsia // New color name RGB(-1,-1,-1) - gray
RGB(80,80,80) - gray // Same as previous RGB(CC,CC,CC) - dust // New color name RGB(-1,-1,-1) - lime
RGB(00,FF,00) - lime // Same as previous
RGB(00,CC,00) - dark lime // New color name
The syntax of the default BattColors file is shown below.
// BattColors.ins
//
// Definition of color table associated to
// Alarm Attribute and Color Builder (BATTDECK.INS).
//
RGB( -1, -1, -1) - black // 0
RGB( -1, -1, -1) - red // 1
RGB( -1, -1, -1) - green // 2
RGB( -1, -1, -1) - yellow // 3
RGB( -1, -1, -1) - blue // 4
RGB( -1, -1, -1) - magenta // 5
RGB( -1, -1, -1) - cyan // 6
RGB( -1, -1, -1) - white // 7
RGB( -1, -1, -1) - orange // 8
RGB( -1, -1, -1) - slateblue // 9
RGB( -1, -1, -1) - hotpink // 10
RGB( -1, -1, -1) - seagreen // 11
RGB( -1, -1, -1) - springgreen // 12
2VAA000830-330 A 189
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

RGB( -1, -1, -1) - chocolate // 13


RGB( -1, -1, -1) - lavender // 14
RGB( -1, -1, -1) - sandybrown // 15
RGB( -1, -1, -1) - tomato // 16
RGB( -1, -1, -1) - turquoise // 17
RGB( -1, -1, -1) - deeppink // 18
RGB( -1, -1, -1) - darkviolet // 19

3.15 Digital Tag Field Applicability


In the following table the asterisk states the field on the horizontal line is applicable and meaningful for the type of tag on
the vertical line.
Table 3-15: Digital Tag Field Applicability

Field DI RCM DD MSDD SPDT DCS MS


ZEROSTATE * * * * * * *
ONESTATE * * * * * * *
TWOSTATE * * *
THREESTATE * * *
FOURSTATE
to *
FVTEESTATE
FB1_0STATE * *
FB1_1STATE * *
FB2_0STATE * *
FB2_1STATE * *
FB3_0STATE *
FB3_1STATE *
FB4_0STATE *
FB4_1STATE *

3.16 ICI Action Codes


The following table provides the list of ICI Action Codes:
Table 3-16: ICI Action Codes

Index Action Code Description


1 X Skip. ICI ignore the tag.
2 E Establish Only.
3 C Establish and Connect.
4 D Define for Output.

3.17 ICI Point Types


The following table provides the list of ICI Point Types:
Table 3-17: ICI Point Types

Code Point Type


0 Not defined.
1 Process Variable.
2 Set-point Read.
3 Control Output Read.

190 2VAA000830-330 A
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

4 Ratio Index Read.


5 Analog Read.
6 Station Status.
7 Digital Read.
8 Set-point Write.
9 Control Output Write.
10 Ratio Index Write.
11 Station Mode.
12 Analog Report.
13 Digital Report.
14 Module Status.
15 RCM Read.
16 RCM Write.
17 Single Index Station.
18 Station Report.
19 RMSC Read.
20 RMSC Report.
21 R4 Analog Read.
22 R4 Analog Report.
23 Extended Module Status.
24 to 28 Not Defined.
29 DANG.
30 Not Defined.
31 Not Defined.
32 DD.
33 MSDD.
34 SPDT.
35 to 52 Not Defined.
53 RMCB.
54 DDIG.
55 to 59 Not Defined.
60 Text Selector.
Time Units
The following table provides the list of Time Units:
Table 3-18: Time Units

Code Time Unit Description


0 Sec. Seconds
1 Min. Minutes
2 Hours Hours
3 Days Days
4 Months Months
5 Years Years

3.19 Instrument Types


The following table provides the list of Instrument Types:
Table 3-19: Instrument Types

Instrument Type Description


2VAA000830-330 A 191
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

1-5 V High Level.


4-20 mA High Level.
TCK Type K thermocouple.
TCJ Type J thermocouple.
TCT Type T thermocouple.
RTD RTD 100 ohms.

3.20 Analog and Digital Tag Quality Bits


Tag quality bits are summarized in the two following tables.
The following table provides the list of quality bits valid for both analog and digital tags:
Table 3-20: Analog and Digital Tag Quality Bits

Code Description
0 Implemented
1 Unacknowledged
2 In alarm
3 Old data
4 Off scan
5 Reserved
6 Inserted value
7 Alarm check disabled
8 Alarm inhibited
9 Reserved
10 Bad calculated value
11 Application specific 3
12 Red tagged
13 Hardware channel failure
14 Application specific 1
15 Application specific 2

3.21 Analog (Only) Tag Quality Bits


The following table provides the list of quality bits valid for analog tags only:
Table 3-21: Analog (Only) Tag Quality Bits

Code Description
0 High instrument range
1 2-High alarm limit
2 High alarm limit
3 Low alarm limit
4 2-Low alarm limit
5 Low instrument range
6 Increasing ROC
7 Decreasing ROC
8 High deviation
9 Low deviation
10 Integer format
11 Tracking
12 3-High alarm limit
13 3-Low alarm limit
192 2VAA000830-330 A
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

14 Auto/Manual
15 Dummy Packet (Playback only)

3.22 System Information: Tag Configuration Retrieving Parameters


The following table provides the list of System Information – Tag Configuration Retrieving Parameters:
Table 3-22: System Information – Tag Configuration Retrieving Parameters

Parameter Description
ProductName Name of the Product
ShortProductName Short name of the Product
FullProductName Full name of the Product
ProductFamily Family Name of the Product
ProductVersion Version of the product
ProductCompany Company Name of the Product
ProductCorporate Corporate Name of the Product
Version Release version
SubVersion Release sub-version
Build Build Version
HotFix Hot Fix
MaximumTags Number of tags
MaximumConfiguredTags Numer of Tags Configured
MaximumCrts Maximum number of Clients
MaximumPV Maximum number of PV
MaximumDI Maximum number of DI
MaximumPlaybacks Apms Parameter
MaximumPrinters Maximum number of Printers
MaximumICI Maximum number of ICIs
MaximumICIIndex Number of ICI index
MaximumCalculations Maximum number of Calculation Blocks
MaximumTrendGroups Maximum Number of Historical Groups
MaximumTagInfoType Maximum Tag Info Type
MaximumFileKey Maximum File Key
MaximumTotalizationLogs Maximum Number of Totalizations
MaximumSoeEvents Maximum Events for SOE
MaximumMaintenanceLogs Maximum Number of maintenance
MaximumPTLArchives Maximum Number of Post Trip Logs
MaximumDisplays Maximum Number of Displays
MaximumOpConfDisplays Maximum Number of Op Conf Displays
MaximumAlarmPriorities Maximum Number of Alarm Priorities
MaximumAlarmGroups Maximum # of alarm groups
MaximumFiles Maximum number of Files
MaximumTagNameLenght Maximum Length of Tag Name in presentations
MaximumTagDescrlenght Maximum Length of Tag Description in presentations
MaximumTagsetLenght Maximum Length of Logic State Descr in presentations
RecordsInPtlFiles Apms Parameter
RecordsInPlaybackFiles Apms Parameter
EntriesInPlbQueue Apms Parameter
EntriesInPtlQueue Apms Parameter
2VAA000830-330 A 193
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

EntriesInPlbmemory Apms Parameter


EntriesInCompressedPlbFiles Apms Parameter
HistDataRetrievalLimit Apms Parameter
MaxTagPerGroup Maximum tags per Historical Group
MaximumAlacPrograms Number of Alarm Action Programs
MaximumPlaybackDays Maximum Number of Days for Keeping Playback archive
MaximumIndexNo Maximum Tag Index
MaximumSoeDevices Maximum SOE Device
NumberOfPlaybackFiles Number of files reserved for Playback
MaximumPtlDays Maximum Number of Days for Keeping PTL archive
MaximumPlantUnits Apms Parameter
LicensedClients Number of Clients licensed
LicensedAPI API is Licensed
LicensedSpecificAPI Specific API is Licensed
LicensedODBC ODBC is Licensed
LicensedWeb WEB is Licensed
LicensedPrc_Infi Process Control for INFI is Licensed
LicensedDisplayBuilder Display Builder is Licensed
LicensedDaOpcServer Licensed DA Opc Server
LicensedAeOpcServer Licensed AE OPC Server
LicensedHdaOpcServer Licensed HDA OPC Server
LicensedDawOpcServer Licensed DA- write OPC Server
LicensedOPCTags Number of tags licensed for OPC
LicensedDDE DDE is Licensed
LicensedTags Number of Tags licensed
LicensedHistTags Number of Tags Licensed
LicensedSimulation Simulation is Licensed
LicensedCalculation Calculation is Licensed
LicensedCalcSteam Steam Calculation is Licensed
LicensedCalcMacro Macro Calculation is Licensed
LicensedScanDrivers Scanner Drivers are Licensed
LicensedAPI_RT API RunTime is Licensed
LicensedPrc_Ac800f Process Control is Licensed
LicDrv_Infi Driver for INFI is Licensed
LicDrv_Dci Driver for DCI is Licensed
LicDrv_Odbc Driver for ODBC is Licensed
LicDrv_Modbus Driver for Modbus is Licensed
LicDrv_OpcClient Driver for is Licensed
LicDrv_Spabus Driver for Spabus is Licensed
LicDrv_Iec101 Driver for Iec101 is Licensed
LicDrv_Iec104 Driver for Iec104 is Licensed
LicDrv_Text Driver for Text is Licensed
LicDrv_Teleperm Driver for Teleperm is Licensed
LicDrv_GsmMarkV Driver for GsmMarkV is Licensed
LicDrv_Iec103 Driver for Iec103 is Licensed
LicDrv_XX2 Driver for XX2 is Licensed
LicDrv_XX3 Driver for XX3 is Licensed
LicDrv_XX4 Driver for XX4 is Licensed

194 2VAA000830-330 A
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

LicDrv_XX5 Driver for XX5 is Licensed


LicDrv_App Application Driver is Licensed
LicAppl_MaintTrigger Maint Trigger Application is Licensed
LicAppl_XmlToCmms Xml To CMMS Application is Licensed
LicAppl_PPP PPP Application is Licensed
LicAppl_DPP DPP Application is Licensed
LicAppl_TSE TSE Application is Licensed
LicAppl_BSE BSE Application is Licensed
LicAppl_TPA TPA Application is Licensed
LicAppl_STP STP Application is Licensed
LicAppl_TSEOP TSEOP Application is Licensed
LicAppl_BSEOP BSEOP Application is Licensed
LicAppl_MSFDPP MSFDPP Application is Licensed
LicAppl_CPA CPA Application is Licensed
LicAppl_Harmony_Cfg Harmony Cfg Application is Licensed
LicAppl_XX2 XX2 Application is Licensed
LicAppl_XX3 XX3 Application is Licensed
LicAppl_XX4 XX 4Application is Licensed
LicAppl_XX5 XX5 Application is Licensed
LicAppl_PeopleFinder People Finder is Licensed
LicensedPrc_Ac870p Licensed Process Control for Ac870P
LicensedPrc_ProP13 Licensed Process Control for ProP13
LicenseExpiration License expiration
ServerName Server Name
IsServer Apms Parameter
IsSystemActive The system is active
IsRundownInProgress System shutdown in progress
IsSimulationActive Simulation is Active
IsSimulationFrozen Simulation is Frozen
ClientName Name of Client
CurrentTimeIM Current Time
CurrentTimeString Current Time (string)
CurrentExTimeX Current Time
ConvertedTime Converted Time
CurrentOSTimeX Current Time from OS
StartupTimeIM Time of Last Startup
PercentDiskUsed_A Percentage of use of Disk A
PercentDiskUsed_B Percentage of use of Disk B
PercentDiskUsed_C Percentage of use of Disk C
PercentDiskUsed_D Percentage of use of Disk D
PercentDiskUsed_E Percentage of use of Disk E
PercentDiskUsed_F Percentage of use of Disk F
PercentDiskUsed_G Percentage of use of Disk G
PercentDiskUsed_H Percentage of use of Disk H
PercentDiskUsed_I Percentage of use of Disk I
PercentDiskUsed_J Percentage of use of Disk J
PercentDiskUsed_K Percentage of use of Disk A
PercentDiskUsed_L Percentage of use of Disk L

2VAA000830-330 A 195
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

PercentOJUsed Percentage of use of Operator Journal File


PercentPlaybackUsed Percentage of use of Playback Archive
PercentCpuLoad Percent of CPU Load
PercentMemoryUsed Apms Parameter
PhysicalMemory Size of Physical Memory
IsLowResources Low System Resources
LoggedUser Name of Logged User
LoginTime Time of Login
LogoffTimeout Timeout For Auto Logoff
LoggedUserRecord Record Index of Logged User
LoggedUserID ID of Logged User
LocalNode Local Node
IsSystemMaster The system is master
MasterNode Index of the Master Node
NodeWeight Node Weight
IsConfigAligned Configuration is Aligned
IsOjAligned Operator Journal file is Aligned
IsHistAligned Historical Files are aligned
IsPlbAligned Playback Archive is Aligned
IsPtlAligned Post Trip Log Archive is Aligned
IsNodeAligned Node is Aligned
IsAlignInProgress Node Alignment in Progress
NodeAligning Apms Parameter
NodeStatusMask Node Status Mask
NetWorkerLifeCycle Life Cycle for Networker
NodeConnected Number of nodes connected
ConnectionTime Connection time
ConnectionUpdate Connection Update
AlarmPrintMask Mask of Enabled Alarm Printers
IgnoreRio Ignore Remote IO Alarms
OisTimeSynch Time Synch INFI as OIS
DstOnInfi DST sent on INFI
FlagOldAlarms Apms Parameter
InfiTimeSynch Time Synch Infi
nackAlarm New Alarms are Uncked
PercentSaveOJ Apms Parameter
LadValueUpdate Update tag value on Alarm Display
QueueSOEtoDip Queue Sequence of Events to Data Processor
QueueSOEtoLog Queue Sequence of Events to Log processor
ExceptionScreen Apms Parameter
DisableAudibleOnAck Apms Parameter
PlaybackCompress Compress Playback
MsddFeedbacksInverted Invert Feedbacks on MSDD popup
BadQualityAlarms Bad Quality marked as Alarms
RemoteClients Apms Parameter
AlarmsWithMillisec Alarm Time includes Milliseconds
AlarmsAckBroadcast Broadcast Alarm Acknowledgements
AlarmsSilBroadcast Broadcast Alarm Silencing

196 2VAA000830-330 A
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

Language Human Machine Language


RedTagCommands Commands are enabled if Red Tag
EnableAlarmPrintouts Enable Printouts of all alarms
IncrementControls Rate for Control Increment
FastIncrementControls Rate for Control Fast Increment
DemoSystem Demo System
AlarmsPerLad Maximum Alarm Messages per Display
EUText Engineering Unit Text
LSDText Logic State Descriptor Tests
Qf1bad Mask of Quality Flag 1 for Bad
Qf2bad Mask of Quality Flag 2 for Bad
TimeUnitText Time Unit Text
TagTypeText Tag Type Text
HistArchText Historical Archive Text
HistArchHDB Historical Archive DB
TypeInfo Type Info
TagInfoType Tag Info Type
AlarmBitmap Alarm Bitmap
WeekTimeInfo Day Of the Week
DayLightSavingTimeInfo Day Light Saving Time is ON
SoeQueueEntries Entries in Sequence of Events Queue
CompositeTime Time in Composite Format
StandaloneSystem System Standalone
AlacQueueEntries Entries in Alarm Action Queue
FirstPlaybackFile Key for First Playback File
FirstPTLFile Key of first Post Trip Log File
NumberOfPTLFiles Number of files reserved for PTL
FirstHistorianFile Key of first Historical File
FirstHistorianRetrievedFile Key of first Historical Retrieved File
FirstHistorianGhostFile Key of first Historical GhostFile
NumberOfHistorianGhostFiles Number of Historical Retrieved Files
OpstationLayout Operator Station Layout
OpstationDisplay Operator Station Display
AlarmMimic Alarm Mimic
OdbcInterface ODBC Interface
OdbcTagHistory ODBC Tag History
RundownNotInProgress Rundown Not In Progress
DipQueueEntries Entries in Data Input Processor Queue
OdbcQueueEntries Entries in ODBC queue
IciStatus Status of the ICI
TextSelector Text Selector
Tagset Tagset
AlarmComment Alarm Comment
NationalLanguage National language
UserPar1 User Application Parameter 1
UserPar2 User Application Parameter 2
UserPar3 User Application Parameter 3
UserPar4 User Application Parameter 4

2VAA000830-330 A 197
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

UserPar5 User Application Parameter 5


UserPar6 User Application Parameter 6
UserPar7 User Application Parameter 7
UserPar8 User Application Parameter 8
LongTermPlayback Playback Saved for Long Term
PlbComprHorzBand Playback Compression Horizontal DeadBand
PlbComprSlopeBand Playback Compression Slope Band
TimeZone Time Zone
IgnoreAlarmGroup0 Ignore Alarms belonging to Group Zero
NodesInNetwork Number of Nodes in Network
PopupTimeout Timeout for Popups
BlackPopups Popups with Black Background
RequestReport Trigger for requesting Reports
DSysUseUID Use tag UID in Network messages
NetQueEntries Entries in Network queue
PopupToBeSelected Popus to be selected to enable commands
CalculReload Trigger for Reloading Calculations
SecurityGroup Security Group
SecurityLevel Security Level
SecurityPrivileges Security Privileges
ConnectionCnt Nodes Connection Count
EnableEventPrint Enable Printing of Event Messages
AlarmsWithStdDate Enable STD time format for alarms
ControlAcknowlegmentRequired Acknowledgement for Control is Required
IncrementControlsRate Rate for Control Increment
OpcQueEntries Entries in OPC queue
GenDiagStatus General Diagnostic Status
NetWorkerStatus NetWorker Status
OpcClientStatus OPC Client Status
OpcServerStatus OPC Server Status
DipReload Trigger for Reloading the Data Input Processor
OpcReload Trigger for Reloading OPC
HistReload Trigger for Reloading History
SmsReload Trigger for Reloading People Finder
AudibleCode Code of Alarm Audible
AudibleFile File for Alarm Audible
AtomSeparator Character for Atom Separation
SmsEnabled People Finder is Enabled
SmsActive People Finder Error logging is Active
SmsErrors People Finder Error logging is Enabled
SmsAckAll People Finder Acknowledge All Alarms
SmsAck People Finder Acknowledge Alarms
BuildTagInProgress Tag Builder is in Progress
ScannerReload Trigger for Reloading the Scanner
SimulationState Simulation State
SimulationRate Simulation Rate
OpstaPlantUnit Apms Parameter
PlantUnitMatch Apms Parameter

198 2VAA000830-330 A
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

UserReload Apms Parameter


OpcAERefresh OPC AE Refresh
FileInfoX File Info
FileVersion File Version
DisableAutoNetMasterSwitch Disable Auto-Switch from Master to Slave
LocalRemoteControlInhibitTagDX Tag for Local-Remote Control
V23Reload Trigger for Reloading V23 logic
V23Recalculate Recalculate Voting 2 of 3
NumMultipleOutputDrivers Number of Output Drivers
FreezeDIP Data Input Process is Frozen
PlbSwitch Playback Switch

2VAA000830-330 A 199
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

3.23 Tag Configuration Retrieving Parameters


The following table provides the list of Tag Configuration Retrieving Parameters:
Table 3-23: Tag Configuration Retrieving Parameters

Parameter Description
DB_TAGINDEX Index
DB_TAGNAME Name
DB_TAGDESC Description
DB_TAGIDX Internal Tag Index
DB_TAGTYPE Tag Type
DB_TAGTYPEDESCR Tag Type Description
DB_TAGSRC Tag Source
DB_VALUE Current Value
DB_RAWVALUE Current Raw Value
DB_NUMVALUE Numeric Value
DB_NUMUVALUE Numeric Unsigned Value
DB_PERCENT_VALUE Percent Value
DB_QUALITY Current Quality
DB_TIMESTAMP Time Stamp
DB_TIMESTAMP_TEXT Time Stamp Text
DB_ISO_TIMESTAMP Time Stamp
DB_VALUE_QUALITY Current Value and Quality
DB_VALUE_QUALITY_RA Current Value and Quality
DB_EXTQUALITY Current Quality
DB_TAGVAL Current Value and Quality
DB_TAGVALEX Current Value and Quality
DB_TSTAMP_VALUE_QUALITY Timestamp
DB_TVQ_STRING Timestamp (string)
DB_CUSTTAGID Plant Tag Name
DB_AL_PRI Current Alarm Priority
DB_AL_CAT Alarm Processing Categorized
DB_ALMGROUP Alarm Group
DB_EUDESC Engineering Unit
DB_SP_EUINDEX SP Engineering Unit index
DB_EUINDEX EU Index
DB_NUMDECPL Decimal Places
DB_I4_DATA Integer Format
DB_FGCOLOR Foreground Color
DB_BGCOLOR Background Color
DB_FGCOLORREF Foreground Color Ref.
DB_BGCOLORREF Background Color Ref.
DB_FGCOLORSTRING Foreground Color String
DB_BGCOLORSTRING Background Color String
DB_ALRMCMNT1 RTN Comment
DB_ALRMCMNT2 Hi Alarm Comment
DB_ALRMCMNT3 Lo Alarm Comment
DB_ALRMCMNT4 2-Hi Alarm Comment
DB_ALRMCMNT5 2-Lo Alarm Comment

200 2VAA000830-330 A
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

DB_ALRMCMNT6 3-Hi Alarm Comment


DB_ALRMCMNT7 3-Lo Alarm Comment
DB_ALRMCMNT8 Hi Deviation Comment
DB_ALRMCMNT9 Lo Deviation Comment
DB_ALRMCMNT10 Hi ROC Alarm Comment
DB_ALRMCMNT11 Lo ROC Alarm Comment
DB_ALRMCMNT12 Event Comment
DB_ALRMCMNT13 Channel Failure Comment
Primary Display reference for
DB_PRIMDISP1
monitor1
Primary Display reference for
DB_PRIMDISP2
monitor 2
Primary Display reference for
DB_PRIMDISP3
monitor 3
Primary Display reference for
DB_PRIMDISP4
monitor 4
DB_PRIMGROUP Primary Trend Group
DB_SEC_LEVEL Security Level
DB_SEC_GROUP Security Group
DB_AAP_NUM Alarm Action Program
DB_ACK_PROG Activate on Ack
DB_RTN_PROG Activate on RTN
DB_ALM_PROG Activate on Alarm
DB_EVT_PROG Activate on Event
DB_HI_PROG Activate on HI
DB_H23_PROG Activate on H3-H2
DB_H_PROG Activate on H
DB_L_PROG Activate on L
DB_L23_PROG Activate on L3-L2
DB_LI_PROG Activate on LI
DB_HR_PROG Activate on PROC
DB_LR_PROG Activate on NROC
DB_AL_REM Remote Alarm Processing
DB_TRIG_CALC Triggered Calculation
DB_ICI_NUM ICI Number
DB_ICI_NDX ICI Index
DB_LOOP Ring
DB_PCU Pcu
DB_MODULE Module
DB_BLOCK Block
DB_SER_NUMBER SER Number
DB_SER_INDEX SER Index
DB_ICISTA_CD ICI Action Code
DB_AUD_IDX Audible Alarm Index
DB_OIS_ALA OIS Alarm Proc.
DB_DS_ALARM Display Alarms
DB_PR_ALARM Print Alarms
DB_SV_ALARM Save Alarms
DB_AUD_ALARM Activate Audible
DB_AUD_RTN Audible on RTNs

2VAA000830-330 A 201
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

DB_BOT_ALARM Bottom of Screen


DB_DS_RTN Display RTNs
DB_PR_RTN Print RTNs
DB_SV_RTN Save RTNs
DB_DS_STCHNG Display Events
DB_PR_STCHNG Print Events
DB_SV_STCHNG Save Events
DB_PR_OPACT Print Actions
DB_SV_OPACT Save Actions
DB_PR_INFO Print Infos
DB_SV_INFO Save Infos
DB_REM_ONACK Remove on Ack
DB_INFO_ONACK Info on Ack
DB_NO_UNACK Do not set Unack
DB_ALARM_MIMIC Display Mimic when alarm
DB_ACK_BROAD Broadcast Ack to the field
DB_APPL_ALA Trigger Application Event
DB_EXP_ALA Export Alarms to Foreign DB
DB_OPC_ALARM Export Alarms to OPC Server
DB_SMSINDEX SMS index for Alarms
DB_ALMINHTAG Alarm Inhibit Tag
DB_CTRLINHTAG Control Inhibit Tag
DB_CONFIRM_COMMAND Need Confirm Command
DB_CTRLCMDTAG Control Command Tag
DB_HVARALMTAG Hi Variable Alarm Tag
DB_H2VARALMTG 2-Hi Variable Alarm Tag
DB_H3VARALMTG 3-Hi Variable Alarm Tag
DB_LVARALMTAG Lo Variable Alarm Tag
DB_L2VARALMTG 2-Lo Variable Alarm Tag
DB_L3VARALMTG 3-Lo Variable Alarm Tag
DB_CTRLINH Control Inhibit
DB_REMOTE_CTRLINH Remote Control Inhibit
DB_LOCAL_CTRLINH Local Control Inhibit
DB_S_COORD Slave Module Coordinates
DB_S_TYPE Slave Module Type
DB_S_TTID Termination Unit Type
DB_S_TOBO Termination Unit Identifier
DB_S_TTCO Termination Unit Coordinates
DB_S_SMOD S-Slave Module
DB_S_SCHA S-Slave Channel
DB_S_FRBO Field Cabinet Identifier
DB_S_MODULE Slave Module
DB_S_CHANNEL Slave Channel
DB_OFFSCINI Off Scan Initially
DB_OFFALINI Off Alarm Check Initially
DB_INITVAL Initial Value
DB_SCA_VAL_0 0% Presentation Scale
DB_SCA_VL_100 100% Presentation Scale

202 2VAA000830-330 A
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

DB_VIOL_CD Violation Code


DB_VIOL_SCAN Off Scan on Violation
DB_UT_TEXT Text (10 characters)
DB_UT_TEXT1 Text (16 characters)
DB_UT_TEXT2 Text (32 characters)
DB_UT_IN1 Integer 1
DB_UT_IN2 Integer 2
DB_UT_IN3 Integer 3
DB_UT_IN4 Integer 4
DB_UT_RE1 Real 1
DB_UT_RE2 Real 2
DB_UT_RE3 Real 3
DB_UT_RE4 Real 4
DB_UT_RE5 Real 5
DB_UT_RE6 Real 6
DB_VAL100 High Instrument Limit
DB_VAL0 Low Instrument Limit
DB_LALARM Low Alarm Limit
DB_L2ALARM 2-Low Alarm Limit
DB_L3ALARM 3-Low Alarm Limit
DB_HALARM High Alarm Limit
DB_H2ALARM 2-High Alarm Limit
DB_H3ALARM 3-High Alarm Limit
DB_LROC_LIMIT Increasing Rate Of Change
DB_HROC_LIMIT Decreasing Rate Of Change
DB_H3_DELTA 3-Hi Variable Alarm Delta
DB_H2_DELTA 2-Hi Variable Alarm Delta
DB_L2_DELTA 2-Lo Variable Alarm Delta
DB_L3_DELTA 3-Lo Variable Alarm Delta
DB_SPAN Span
DB_H_ACTIVE H-Limit Active
DB_H2_ACTIVE H2-Limit Active
DB_H3_ACTIVE H3-Limit Active
DB_L_ACTIVE L-Limit Active
DB_L2_ACTIVE L2-Limit Active
DB_L3_ACTIVE L3-Limit Active
DB_HR_ACTIVE HR Active
DB_LR_ACTIVE LR Active
DB_LI_ACTIVE LI Active
DB_HI_ACTIVE HI Active
DB_ALARMDB Alarm Deadband
DB_ALARMDBH High Alarm Deadband
DB_ALARMDBL Low Alarm Deadband
DB_LIMITDB Limit Deadband
DB_LIMITDBH High Limit Deadband
DB_LIMITDBL Low Limit Deadband
DB_ALARMDB_PERC Alarm Deadband (percent)
DB_EVENTTAG Event Tag

2VAA000830-330 A 203
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

DB_ISALARM0 State is Alarm


DB_ISALARM1 State is Alarm
DB_ISALARM2 State is Alarm
DB_ISALARM3 State is Alarm
DB_ISALARM4 State is Alarm
DB_ISALARM5 State is Alarm
DB_ISALARM6 State is Alarm
DB_ISALARM7 State is Alarm
DB_ISALARM8 State is Alarm
DB_ISALARM9 State is Alarm
DB_ISALARM10 State is Alarm
DB_ISALARM11 State is Alarm
DB_ISALARM12 State is Alarm
DB_ISALARM13 State is Alarm
DB_ISALARM14 State is Alarm
DB_ISALARM15 State is Alarm
DB_ISALARM16 State is Alarm
DB_ISALARM17 State is Alarm
DB_ISALARM18 State is Alarm
DB_ISALARM19 State is Alarm
DB_ISALARM20 State is Alarm
DB_ISALARM21 State is Alarm
DB_ISALARM22 State is Alarm
DB_ISALARM23 State is Alarm
DB_ISALARM24 State is Alarm
DB_ISALARM25 State is Alarm
DB_ISALARM26 State is Alarm
DB_ISALARM27 State is Alarm
DB_ISALARM28 State is Alarm
DB_ISALARM29 State is Alarm
DB_ISALARM30 State is Alarm
DB_ISALARM31 State is Alarm
DB_ALARM_MASK Alarm BitMask
DB_MAX_ROC Maximum Rate of Change
DB_ALMACK_NET_MASK Dest. node mask for alarm ack
DB_NET_NODE_SOURCE Source node mask
DB_TAGVAL_NET_MASK Dest. node mask for values
DB_CONFIG_NET_MASK Dest. node mask for config
DB_TOTALIZER_NUM Totalization Log
DB_TRIP_NUM Trip Log
DB_RPT_NUM Report Number
DB_TOTALIZER_1_MIN Totalizer 1 min.
DB_TOTALIZER_10_MIN Totalizer 10 min.
DB_TOTALIZER_30_MIN Totalizer 30 min.
DB_TOTALIZER_1_HOUR Totalizer 1 hour
DB_TOTALIZER_8_HOUR Totalizer 8 hour
DB_TOTALIZER_1_DAY Totalizer 1 day
DB_TOTALIZER_1_MONTH Totalizer 1 month

204 2VAA000830-330 A
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

DB_TOTALIZER_1_YEAR Totalizer 1 year


DB_TOTALIZED_1_MIN Totalized 1 min.
DB_TOTALIZED_10_MIN Totalized 10 min.
DB_TOTALIZED_30_MIN Totalized 30 min.
DB_TOTALIZED_1_HOUR Totalized 1 hour
DB_TOTALIZED_8_HOUR Totalized 8 hour
DB_TOTALIZED_1_DAY Totalized 1 day
DB_TOTALIZED_1_MONTH Totalized 1 month
DB_TOTALIZED_1_YEAR Totalized 1 year.
DB_HRT_TOTSTA Totalized number of start
DB_HRT_TOTSTO Totalized number of stop
DB_HRT_TOTTON Totalized running time
DB_HRT_TOTTLR Totalized time from last reset
DB_HRT_TOTTOF Totalized stop time
DB_HRT_TOTTIN Totalized BAD quality time
Totalized system shutdown
DB_HRT_TOTDWN
time
DB_PLB_COMPR Playback Compression
DB_PLB_LTKEEP Long Term Playback Archive
DB_PLB_RECORD Playback Archive
DB_REL_DB Export Values to Foreign DB
DB_EXPFIL Export Values to File
DB_ZEROSTATE State 0
DB_ONESTATE State 1
DB_TWOSTATE State 2
DB_THREESTATE State 3
DB_FOURSTATE State 4
DB_FIVESTATE State 5
DB_SIXSTATE State 6
DB_SEVENSTATE State 7
DB_EIGTHSTATE State 8
DB_NINESTATE State 9
DB_TENSTATE State 10
DB_ELEVNSTATE State 11
DB_TWELVSTATE State 12
DB_THTEESTATE State 13
DB_FRTEESTATE State 14
DB_FVTEESTATE State 15
DB_FB1_0STATE Feedback 1 State 0
DB_FB1_1STATE Feedback 1 State 1
DB_FB2_0STATE Feedback 2 State 0
DB_FB2_1STATE Feedback 2 State 1
DB_FB3_0STATE Feedback 3 State 0
DB_FB3_1STATE Feedback 3 State 1
DB_FB4_0STATE Feedback 4 State 0
DB_FB4_1STATE Feedback 4 State 1
DB_SET_POINT Set Point index
DB_CONTROL_POINT Control Point Index
DB_RATIO_INDEX Ratio Index
2VAA000830-330 A 205
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

DB_STATION_STATUS Station Status Index


DB_CONSTDELTA Hourly Constancy Delta
DB_CONTROLINCDEC Increment/decrement %
DB_FASTCONTROLINCDEC Fast Inc./dec. %
DB_PLAYBACKDB Playback Deadband
DB_PLAYBACKTM Playback Timer
DB_PVCACT Alarm Active Mask
DB_INH_CHAIN Alarm Inhibition Chain
DB_CONTROL_TYPE Control Type
DB_LAST_UPDATE Last Data Base Update
DB_IS_DEFINED Tag Defined
DB_LAD_LEVEL Alarm Group Level
DB_LAD_HAS_SUBGROUP Alarm Group With Subgroups
DB_LAD_SUMMARY Alarm Group Summary
DB_LOCALHOST Local Host
DB_NODEWEIGHT Node Weight
DB_QUALITYEX Current Decoded Quality
DB_COLOR_ATTRIBUTES Alarm Color Attributes
DB_ALARM_COMMENT Current Alarm Comment
DB_ANY_ALARM_COMMENT Any Alarm Comment
DB_PLANT_UNIT Plant Unit
DB_PLANT_UNIT_NAME Plant Unit Name
DB_ALMACKNL Alarm ack broad. node list
DB_OPCSRVVIS OPC Server visibility
DB_ALPRINUM Alarm printer number
DB_TAG_GUID Tag global UID
DB_TAG_GUID_SZ Tag global UID (formatted)
DB_SOE_NUM Triggered SOE number
DB_SOE_TYPE Triggered SOE type
DB_COMPRESSION_SPAN Plb compr. span (%)
DB_DEV_TYPE Device Type
DB_DEV_NUMBER Device Number
DB_DEV_NAME Device Name
DB_MODTYPE Module Type
DB_MODREV Module Rev.
DB_OTXIDX Output Transfer Tag Index
DB_OTXENB Output Transfer Enabled
DB_OPERPARAM Operating Parameter
DB_OPCPROGID OPC Program ID
DB_OPCCMPTR OPC Computer name
DB_OPCITEMID OPC Item ID
DB_OPCACCPATH OPC Access path
DB_OPCREFRESH OPC Refresh time
DB_OPCREADTYP OPC Read type
DB_OPCCLIENT Export to Client OPC
DB_OPCSERVER Export to Server OPC
DB_OPCALARMSOURCE OPC Alarm Source
DB_EXTDESC Extended Description

206 2VAA000830-330 A
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

DB_MAINT_TRIG Maintenance Trigger


DB_FIELD_AD1 Field Address 1
DB_FIELD_AD2 Field Address 2
DB_FIELD_AD3 Field Address 3
DB_FIELD_AD4 Field Address 4
DB_FIELD_AD5 Field Address 5
DB_FIELD_AD6 Field Address 6
DB_FIELD_AD7 Field Address 7
DB_FIELD_AD8 Field Address 8
DB_FIELD_AD9 Field Address 9
DB_FIELD_AD10 Field Address 10
DB_FIELD_DRV Field Driver Name
DB_FIELD_TX1 Field Drv Text 1
DB_FIELD_TX2 Field Drv Text 2
DB_FIELD_TX3 Field Drv Text 3
DB_FIELD_TX4 Field Drv Text 4
DB_FIELD_TX5 Field Drv Text 5
DB_FIELD_TX6 Field Drv Text 6
DB_FIELD_TX7 Field Drv Text 7
DB_FIELD_TX8 Field Drv Text 8
DB_FIELD_TX9 Field Drv Text 9
DB_FIELD_TX10 Field Drv Text 10
DB_DRV_INDEX Driver Index 1
DB_DRV_INDEX2 Driver Index 2
DB_DRV_INDEX3 Driver Index 3
DB_DRV_INDEX4 Driver Index 4
DB_DRV_INDEX5 Driver Index 5
DB_DRV_INDEXIN Driver Input Index
DB_DATA_PROCESSOR Data Processor Name
DB_OUT1_AD1 Output Address 1
DB_OUT1_AD2 Output Address 2
DB_OUT1_AD3 Output Address 3
DB_OUT1_AD4 Output Address 4
DB_OUT1_AD5 Output Address 5
DB_OUT1_AD6 Output Address 6
DB_OUT1_AD7 Output Address 7
DB_OUT1_AD8 Output Address 8
DB_OUT1_AD9 Output Address 9
DB_OUT1_AD10 Output Address 10
DB_OUT1_DRV Output Driver Name
DB_OUT1_TX1 Output Drv Text 1
DB_OUT1_TX2 Output Drv 1 Text 2
DB_OUT1_TX3 Output Drv 1 Text 3
DB_OUT1_TX4 Output Drv 1 Text 4
DB_OUT1_TX5 Output Drv 1 Text 5
DB_OUT1_TX6 Output Drv 1 Text 6
DB_OUT1_TX7 Output Drv 1 Text 7
DB_OUT1_TX8 Output Drv 1 Text 8

2VAA000830-330 A 207
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

DB_OUT1_TX9 Output Drv 1 Text 9


DB_OUT1_TX10 Output Drv 1 Text 10
DB_OUT2_AD1 Output 1 Address 1
DB_OUT2_AD2 Output 1 Address 2
DB_OUT2_AD3 Output 1 Address 3
DB_OUT2_AD4 Output 1 Address 4
DB_OUT2_AD5 Output 1 Address 5
DB_OUT2_AD6 Output 1 Address 6
DB_OUT2_AD7 Output 1 Address 7
DB_OUT2_AD8 Output 1 Address 8
DB_OUT2_AD9 Output 1 Address 9
DB_OUT2_AD10 Output 1 Address 10
DB_OUT2_DRV Output Driver Name
DB_OUT2_TX1 Output 2 Drv Text 1
DB_OUT2_TX2 Output 2 Drv Text 2
DB_OUT2_TX3 Output 2 Drv Text 3
DB_OUT2_TX4 Output 2 Drv Text 4
DB_OUT2_TX5 Output 2 Drv Text 5
DB_OUT2_TX6 Output 2 Drv Text 6
DB_OUT2_TX7 Output 2 Drv Text 7
DB_OUT2_TX8 Output 2 Drv Text 8
DB_OUT2_TX9 Output 2 Drv Text 9
DB_OUT2_TX10 Output 2 Drv Text 10
DB_TAGGEN Generator Tag
DB_COMPONENT Component Tag
DB_FACEPLATE Faceplate
DB_FEEDBACK1 Feedback 1
DB_FEEDBACK2 Feedback 2
DB_FEEDBACK3 Feedback 3
DB_FEEDBACK4 Feedback 4
DB_AUTOMAN Auto/Manual
DB_GOODSTATE Good State
DB_REQSTATE Requested State
DB_REDTAG Red Tag
DB_PERMISSIVE1 Permissive 1
DB_PERMISSIVE2 Permissive 2
DB_ASPECT1NAM Name of Aspect #1
DB_ASPECT1CMD Command for Aspect #1
DB_ASPECT2NAM Name of Aspect #2
DB_ASPECT2CMD Command for Aspect #2
DB_ASPECT3NAM Name of Aspect #3
DB_ASPECT3CMD Command for Aspect #3
DB_ASPECT4NAM Name of Aspect #4
DB_ASPECT4CMD Command for Aspect #4
DB_ASPECT5NAM Name of Aspect #5
DB_ASPECT5CMD Command for Aspect #5
DB_NUMATOMS Number of Atoms
DB_ATOM1NAM Name for Atom #1

208 2VAA000830-330 A
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

DB_ATOM1VAL Value for Atom #1


DB_ATOM2NAM Name for Atom #2
DB_ATOM2VAL Value for Atom #2
DB_ATOM3NAM Name for Atom #3
DB_ATOM3VAL Value for Atom #3
DB_ATOM4NAM Name for Atom #4
DB_ATOM4VAL Value for Atom #4
DB_ATOM5NAM Name for Atom #5
DB_ATOM5VAL Value for Atom #5
DB_ATOM6NAM Name for Atom #6
DB_ATOM6VAL Value for Atom #6
DB_ATOM7NAM Name for Atom #7
DB_ATOM7VAL Value for Atom #7
DB_ATOM8NAM Name for Atom #8
DB_ATOM8VAL Value for Atom #8
DB_ATOM9NAM Name for Atom #9
DB_ATOM9VAL Value for Atom #9
DB_ATOM10NAM Name for Atom #10
DB_ATOM10VAL Value for Atom #10
DB_ATOM11NAM Name for Atom #11
DB_ATOM11VAL Value for Atom #11
DB_ATOM12NAM Name for Atom #12
DB_ATOM12VAL Value for Atom #12
DB_ATOM13NAM Name for Atom #13
DB_ATOM13VAL Value for Atom #13
DB_ATOM14NAM Name for Atom #14
DB_ATOM14VAL Value for Atom #14
DB_ATOM15NAM Name for Atom #15
DB_ATOM15VAL Value for Atom #15
DB_ATOM16NAM Name for Atom #16
DB_ATOM16VAL Value for Atom #16
DB_ATOM17NAM Name for Atom #17
DB_ATOM17VAL Value for Atom #17
DB_ATOM18NAM Name for Atom #18
DB_ATOM18VAL Value for Atom #18
DB_ATOM19NAM Name for Atom #19
DB_ATOM19VAL Value for Atom #19
DB_ATOM20NAM Name for Atom #20
DB_ATOM20VAL Value for Atom #20
DB_ATOM21NAM Name for Atom #21
DB_ATOM21VAL Value for Atom #21
DB_ATOM22NAM Name for Atom #22
DB_ATOM22VAL Value for Atom #22
DB_ATOM23NAM Name for Atom #23
DB_ATOM23VAL Value for Atom #23
DB_ATOM24NAM Name for Atom #24
DB_ATOM24VAL Value for Atom #24
DB_ATOM25NAM Name for Atom #25

2VAA000830-330 A 209
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

DB_ATOM25VAL Value for Atom #25


DB_ATOM26NAM Name for Atom #26
DB_ATOM26VAL Value for Atom #26
DB_ATOM27NAM Name for Atom #27
DB_ATOM27VAL Value for Atom #27
DB_ATOM28NAM Name for Atom #28
DB_ATOM28VAL Value for Atom #28
DB_ATOM29NAM Name for Atom #29
DB_ATOM29VAL Value for Atom #29
DB_ATOM30NAM Name for Atom #30
DB_ATOM30VAL Value for Atom #30
DB_ATOM31NAM Name for Atom #31
DB_ATOM31VAL Value for Atom #31
DB_ATOM32NAM Name for Atom #32
DB_ATOM32VAL Value for Atom #32
DB_ATOM33NAM Name for Atom #33
DB_ATOM33VAL Value for Atom #33
DB_ATOM34NAM Name for Atom #34
DB_ATOM34VAL Value for Atom #34
DB_ATOM35NAM Name for Atom #35
DB_ATOM35VAL Value for Atom #35
DB_ATOM36NAM Name for Atom #36
DB_ATOM36VAL Value for Atom #36
DB_ATOM37NAM Name for Atom #37
DB_ATOM37VAL Value for Atom #37
DB_ATOM38NAM Name for Atom #38
DB_ATOM38VAL Value for Atom #38
DB_ATOM39NAM Name for Atom #39
DB_ATOM39VAL Value for Atom #39
DB_ATOM40NAM Name for Atom #40
DB_ATOM40VAL Value for Atom #40
DB_ATOM41NAM Name for Atom #41
DB_ATOM41VAL Value for Atom #41
DB_ATOM42NAM Name for Atom #42
DB_ATOM42VAL Value for Atom #42
DB_ATOM43NAM Name for Atom #43
DB_ATOM43VAL Value for Atom #43
DB_ATOM44NAM Name for Atom #44
DB_ATOM44VAL Value for Atom #44
DB_ATOM45NAM Name for Atom #45
DB_ATOM45VAL Value for Atom #45
DB_ATOM46NAM Name for Atom #46
DB_ATOM46VAL Value for Atom #46
DB_ATOM47NAM Name for Atom #47
DB_ATOM47VAL Value for Atom #47
DB_ATOM48NAM Name for Atom #48
DB_ATOM48VAL Value for Atom #48
DB_ATOM49NAM Name for Atom #49

210 2VAA000830-330 A
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

DB_ATOM49VAL Value for Atom #49


DB_ATOM50NAM Name for Atom #50
DB_ATOM50VAL Value for Atom #50
DB_ATOM51NAM Name for Atom #51
DB_ATOM51VAL Value for Atom #51
DB_ATOM52NAM Name for Atom #52
DB_ATOM52VAL Value for Atom #52
DB_ATOM53NAM Name for Atom #53
DB_ATOM53VAL Value for Atom #53
DB_ATOM54NAM Name for Atom #54
DB_ATOM54VAL Value for Atom #54
DB_ATOM55NAM Name for Atom #55
DB_ATOM55VAL Value for Atom #55
DB_ATOM56NAM Name for Atom #56
DB_ATOM56VAL Value for Atom #56
DB_ATOM57NAM Name for Atom #57
DB_ATOM57VAL Value for Atom #57
DB_ATOM58NAM Name for Atom #58
DB_ATOM58VAL Value for Atom #58
DB_ATOM59NAM Name for Atom #59
DB_ATOM59VAL Value for Atom #59
DB_ATOM60NAM Name for Atom #60
DB_ATOM60VAL Value for Atom #60
DB_ATOM61NAM Name for Atom #61
DB_ATOM61VAL Value for Atom #61
DB_ATOM62NAM Name for Atom #62
DB_ATOM62VAL Value for Atom #62
DB_ATOM63NAM Name for Atom #63
DB_ATOM63VAL Value for Atom #63
DB_ATOM64NAM Name for Atom #64
DB_ATOM64VAL Value for Atom #64
DB_ATOM65NAM Name for Atom #65
DB_ATOM65VAL Value for Atom #65
DB_ATOM66NAM Name for Atom #66
DB_ATOM66VAL Value for Atom #66
DB_ATOM67NAM Name for Atom #67
DB_ATOM67VAL Value for Atom #67
DB_ATOM68NAM Name for Atom #68
DB_ATOM68VAL Value for Atom #68
DB_ATOM69NAM Name for Atom #69
DB_ATOM69VAL Value for Atom #69
DB_ATOM70NAM Name for Atom #70
DB_ATOM70VAL Value for Atom #70
DB_ATOM71NAM Name for Atom #71
DB_ATOM71VAL Value for Atom #71
DB_ATOM72NAM Name for Atom #72
DB_ATOM72VAL Value for Atom #72
DB_ATOM73NAM Name for Atom #73

2VAA000830-330 A 211
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

DB_ATOM73VAL Value for Atom #73


DB_ATOM74NAM Name for Atom #74
DB_ATOM74VAL Value for Atom #74
DB_ATOM75NAM Name for Atom #75
DB_ATOM75VAL Value for Atom #75
DB_ATOM76NAM Name for Atom #76
DB_ATOM76VAL Value for Atom #76
DB_ATOM77NAM Name for Atom #77
DB_ATOM77VAL Value for Atom #77
DB_ATOM78NAM Name for Atom #78
DB_ATOM78VAL Value for Atom #78
DB_ATOM79NAM Name for Atom #79
DB_ATOM79VAL Value for Atom #79
DB_ATOM80NAM Name for Atom #80
DB_ATOM80VAL Value for Atom #80
DB_ATOM81NAM Name for Atom #81
DB_ATOM81VAL Value for Atom #81
DB_ATOM82NAM Name for Atom #82
DB_ATOM82VAL Value for Atom #82
DB_ATOM83NAM Name for Atom #83
DB_ATOM83VAL Value for Atom #83
DB_ATOM84NAM Name for Atom #84
DB_ATOM84VAL Value for Atom #84
DB_ATOM85NAM Name for Atom #85
DB_ATOM85VAL Value for Atom #85
DB_ATOM86NAM Name for Atom #86
DB_ATOM86VAL Value for Atom #86
DB_ATOM87NAM Name for Atom #87
DB_ATOM87VAL Value for Atom #87
DB_ATOM88NAM Name for Atom #88
DB_ATOM88VAL Value for Atom #88
DB_ATOM89NAM Name for Atom #89
DB_ATOM89VAL Value for Atom #89
DB_ATOM90NAM Name for Atom #90
DB_ATOM90VAL Value for Atom #90
DB_ATOM91NAM Name for Atom #91
DB_ATOM91VAL Value for Atom #91
DB_ATOM92NAM Name for Atom #92
DB_ATOM92VAL Value for Atom #92
DB_ATOM93NAM Name for Atom #93
DB_ATOM93VAL Value for Atom #93
DB_ATOM94NAM Name for Atom #94
DB_ATOM94VAL Value for Atom #94
DB_ATOM95NAM Name for Atom #95
DB_ATOM95VAL Value for Atom #95
DB_ATOM96NAM Name for Atom #96
DB_ATOM96VAL Value for Atom #96
DB_ATOM97NAM Name for Atom #97

212 2VAA000830-330 A
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

DB_ATOM97VAL Value for Atom #97


DB_ATOM98NAM Name for Atom #98
DB_ATOM98VAL Value for Atom #98
DB_ATOM99NAM Name for Atom #99
DB_ATOM99VAL Value for Atom #99
DB_ATOM100NAM Name for Atom #100
DB_ATOM100VAL Value for Atom #100
DB_ATOM1TYP Type of Atom #1
DB_ATOM2TYP Type of Atom #2
DB_ATOM3TYP Type of Atom #3
DB_ATOM4TYP Type of Atom #4
DB_ATOM5TYP Type of Atom #5
DB_ATOM6TYP Type of Atom #6
DB_ATOM7TYP Type of Atom #7
DB_ATOM8TYP Type of Atom #8
DB_ATOM9TYP Type of Atom #9
DB_ATOM10TYP Type of Atom #10
DB_ATOM11TYP Type of Atom #11
DB_ATOM12TYP Type of Atom #12
DB_ATOM13TYP Type of Atom #13
DB_ATOM14TYP Type of Atom #14
DB_ATOM15TYP Type of Atom #15
DB_ATOM16TYP Type of Atom #16
DB_ATOM17TYP Type of Atom #17
DB_ATOM18TYP Type of Atom #18
DB_ATOM19TYP Type of Atom #19
DB_ATOM20TYP Type of Atom #20
DB_ATOM21TYP Type of Atom #21
DB_ATOM22TYP Type of Atom #22
DB_ATOM23TYP Type of Atom #23
DB_ATOM24TYP Type of Atom #24
DB_ATOM25TYP Type of Atom #25
DB_ATOM26TYP Type of Atom #26
DB_ATOM27TYP Type of Atom #27
DB_ATOM28TYP Type of Atom #28
DB_ATOM29TYP Type of Atom #29
DB_ATOM30TYP Type of Atom #30
DB_ATOM31TYP Type of Atom #31
DB_ATOM32TYP Type of Atom #32
DB_ATOM33TYP Type of Atom #33
DB_ATOM34TYP Type of Atom #34
DB_ATOM35TYP Type of Atom #35
DB_ATOM36TYP Type of Atom #36
DB_ATOM37TYP Type of Atom #37
DB_ATOM38TYP Type of Atom #38
DB_ATOM39TYP Type of Atom #39
DB_ATOM40TYP Type of Atom #40
DB_ATOM41TYP Type of Atom #41

2VAA000830-330 A 213
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

DB_ATOM42TYP Type of Atom #42


DB_ATOM43TYP Type of Atom #43
DB_ATOM44TYP Type of Atom #44
DB_ATOM45TYP Type of Atom #45
DB_ATOM46TYP Type of Atom #46
DB_ATOM47TYP Type of Atom #47
DB_ATOM48TYP Type of Atom #48
DB_ATOM49TYP Type of Atom #49
DB_ATOM50TYP Type of Atom #50
DB_ATOM51TYP Type of Atom #51
DB_ATOM52TYP Type of Atom #52
DB_ATOM53TYP Type of Atom #53
DB_ATOM54TYP Type of Atom #54
DB_ATOM55TYP Type of Atom #55
DB_ATOM56TYP Type of Atom #56
DB_ATOM57TYP Type of Atom #57
DB_ATOM58TYP Type of Atom #58
DB_ATOM59TYP Type of Atom #59
DB_ATOM60TYP Type of Atom #60
DB_ATOM61TYP Type of Atom #61
DB_ATOM62TYP Type of Atom #62
DB_ATOM63TYP Type of Atom #63
DB_ATOM64TYP Type of Atom #64
DB_ATOM65TYP Type of Atom #65
DB_ATOM66TYP Type of Atom #66
DB_ATOM67TYP Type of Atom #67
DB_ATOM68TYP Type of Atom #68
DB_ATOM69TYP Type of Atom #69
DB_ATOM70TYP Type of Atom #70
DB_ATOM71TYP Type of Atom #71
DB_ATOM72TYP Type of Atom #72
DB_ATOM73TYP Type of Atom #73
DB_ATOM74TYP Type of Atom #74
DB_ATOM75TYP Type of Atom #75
DB_ATOM76TYP Type of Atom #76
DB_ATOM77TYP Type of Atom #77
DB_ATOM78TYP Type of Atom #78
DB_ATOM79TYP Type of Atom #79
DB_ATOM80TYP Type of Atom #80
DB_ATOM81TYP Type of Atom #81
DB_ATOM82TYP Type of Atom #82
DB_ATOM83TYP Type of Atom #83
DB_ATOM84TYP Type of Atom #84
DB_ATOM85TYP Type of Atom #85
DB_ATOM86TYP Type of Atom #86
DB_ATOM87TYP Type of Atom #87
DB_ATOM88TYP Type of Atom #88
DB_ATOM89TYP Type of Atom #89

214 2VAA000830-330 A
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

DB_ATOM90TYP Type of Atom #90


DB_ATOM91TYP Type of Atom #91
DB_ATOM92TYP Type of Atom #92
DB_ATOM93TYP Type of Atom #93
DB_ATOM94TYP Type of Atom #94
DB_ATOM95TYP Type of Atom #95
DB_ATOM96TYP Type of Atom #96
DB_ATOM97TYP Type of Atom #97
DB_ATOM98TYP Type of Atom #98
DB_ATOM99TYP Type of Atom #99
DB_ATOM100TYP Type of Atom #100
DB_ATOM1DESC Description for Atom #1
DB_ATOM2DESC Description for Atom #2
DB_ATOM3DESC Description for Atom #3
DB_ATOM4DESC Description for Atom #4
DB_ATOM5DESC Description for Atom #5
DB_ATOM6DESC Description for Atom #6
DB_ATOM7DESC Description for Atom #7
DB_ATOM8DESC Description for Atom #8
DB_ATOM9DESC Description for Atom #9
DB_ATOM10DESC Description for Atom #10
DB_ATOM11DESC Description for Atom #11
DB_ATOM12DESC Description for Atom #12
DB_ATOM13DESC Description for Atom #13
DB_ATOM14DESC Description for Atom #14
DB_ATOM15DESC Description for Atom #15
DB_ATOM16DESC Description for Atom #16
DB_ATOM17DESC Description for Atom #17
DB_ATOM18DESC Description for Atom #18
DB_ATOM19DESC Description for Atom #19
DB_ATOM20DESC Description for Atom #20
DB_ATOM21DESC Description for Atom #21
DB_ATOM22DESC Description for Atom #22
DB_ATOM23DESC Description for Atom #23
DB_ATOM24DESC Description for Atom #24
DB_ATOM25DESC Description for Atom #25
DB_ATOM26DESC Description for Atom #26
DB_ATOM27DESC Description for Atom #27
DB_ATOM28DESC Description for Atom #28
DB_ATOM29DESC Description for Atom #29
DB_ATOM30DESC Description for Atom #30
DB_ATOM31DESC Description for Atom #31
DB_ATOM32DESC Description for Atom #32
DB_ATOM33DESC Description for Atom #33
DB_ATOM34DESC Description for Atom #34
DB_ATOM35DESC Description for Atom #35
DB_ATOM36DESC Description for Atom #36
DB_ATOM37DESC Description for Atom #37

2VAA000830-330 A 215
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

DB_ATOM38DESC Description for Atom #38


DB_ATOM39DESC Description for Atom #39
DB_ATOM40DESC Description for Atom #40
DB_ATOM41DESC Description for Atom #41
DB_ATOM42DESC Description for Atom #42
DB_ATOM33DESC Description for Atom #43
DB_ATOM44DESC Description for Atom #44
DB_ATOM45DESC Description for Atom #45
DB_ATOM46DESC Description for Atom #46
DB_ATOM47DESC Description for Atom #47
DB_ATOM48DESC Description for Atom #48
DB_ATOM49DESC Description for Atom #49
DB_ATOM50DESC Description for Atom #50
DB_ATOM51DESC Description for Atom #51
DB_ATOM52DESC Description for Atom #52
DB_ATOM53DESC Description for Atom #53
DB_ATOM54DESC Description for Atom #54
DB_ATOM55DESC Description for Atom #55
DB_ATOM56DESC Description for Atom #56
DB_ATOM57DESC Description for Atom #57
DB_ATOM58DESC Description for Atom #58
DB_ATOM59DESC Description for Atom #59
DB_ATOM60DESC Description for Atom #60
DB_ATOM31DESC Description for Atom #61
DB_ATOM62DESC Description for Atom #62
DB_ATOM63DESC Description for Atom #63
DB_ATOM64DESC Description for Atom #64
DB_ATOM65DESC Description for Atom #65
DB_ATOM66DESC Description for Atom #66
DB_ATOM67DESC Description for Atom #67
DB_ATOM68DESC Description for Atom #68
DB_ATOM69DESC Description for Atom #69
DB_ATOM70DESC Description for Atom #70
DB_ATOM71DESC Description for Atom #71
DB_ATOM72DESC Description for Atom #72
DB_ATOM73DESC Description for Atom #73
DB_ATOM74DESC Description for Atom #74
DB_ATOM75DESC Description for Atom #75
DB_ATOM76DESC Description for Atom #76
DB_ATOM77DESC Description for Atom #77
DB_ATOM78DESC Description for Atom #78
DB_ATOM79DESC Description for Atom #79
DB_ATOM80DESC Description for Atom #80
DB_ATOM81DESC Description for Atom #81
DB_ATOM82DESC Description for Atom #82
DB_ATOM83DESC Description for Atom #83
B_ATOM84DESC Description for Atom #84
DB_ATOM85DESC Description for Atom #85

216 2VAA000830-330 A
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

DB_ATOM86DESC Description for Atom #86


DB_ATOM87DESC Description for Atom #87
DB_ATOM88DESC Description for Atom #88
DB_ATOM89DESC Description for Atom #89
DB_ATOM90DESC Description for Atom #90
DB_ATOM91DESC Description for Atom #91
DB_ATOM92DESC Description for Atom #92
DB_ATOM93DESC Description for Atom #93
DB_ATOM94DESC Description for Atom #94
DB_ATOM95DESC Description for Atom #95
DB_ATOM96DESC Description for Atom #96
DB_ATOM97DESC Description for Atom #97
DB_ATOM98DESC Description for Atom #98
DB_ATOM99DESC Description for Atom #99
DB_ATOM100DESC Description for Atom #100
DB_APP2 Quality Status: APP2
DB_APP1 Quality Status: APP1
DB_HCFV Quality Status: HCFV
DB_RTAG Quality Status: RTAG
DB_APP3 Quality Status: APP3
DB_BAD Quality Status: BAD
DB_B9 Quality Status: B9
DB_ALIA Quality Status: ALIA
DB_ALIN Quality Status: ALIN
DB_INSV Quality Status: INSV
DB_EVT Quality Status: EVT
DB_OFSC Quality Status: OFSC
DB_OLDD Quality Status: OLDD
DB_ALRM Quality Status: ALRM
DB_UNAK Quality Status: UNAK
DB_IMP Quality Status: IMP
DB_DUMM Quality Status: DUMM
DB_AM Quality Status: AM
DB_SLAV Quality Status: SLAV
DB_SHAV Quality Status: SHAV
DB_TRAK Quality Status: TRAK
DB_I4 Quality Status: I4
DB_LDEV Quality Status: LDEV
DB_HDEV Quality Status: HDEV
DB_DROC Quality Status: DROC
DB_IROC Quality Status: IROC
DB_LIRV Quality Status: LIRV
DB_LLAV Quality Status: LLAV
DB_LAV Quality Status: LAV
DB_HAV Quality Status: HAV
DB_HHAV Quality Status: HHAV
DB_HIRV Quality Status: HIRV
DB_CONVCODE Conversion Code

2VAA000830-330 A 217
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

DB_CONVCODESTR Conversion Code String


DB_CONVMIN Conversion Min
DB_CONVMAX Conversion Max
DB_CONVOFFS Conversion Offset
DB_ALRMCTXT1 RTN Alarm Comment
DB_ALRMCTXT2 High Alarm Comment
DB_ALRMCTXT3 Low Alarm Comment
DB_ALRMCTXT4 2-high Alarm Comment
DB_ALRMCTXT5 2-low Alarm Comment
DB_ALRMCTXT6 3-high Alarm Comment
DB_ALRMCTXT7 3-low Alarm Comment
DB_ALRMCTXT8 H dev Alarm Comment
DB_ALRMCTXT9 L dev Alarm Comment
DB_ALRMCTXT10 H roc Alarm Comment
DB_ALRMCTXT11 L roc Alarm Comment
DB_ALRMCTXT12 Status Chg Alarm Comment
DB_ALRMCTXT13 HCF Alarm Comment
DB_ALPRI_DEF Default Alarm Priority
DB_ALPRI_RTN Alarm Priority: RTN
DB_ALPRI_H Alarm Priority: H
DB_ALPRI_L Alarm Priority: L
DB_ALPRI_2H Alarm Priority: 2H
DB_ALPRI_2L Alarm Priority: 2L
DB_ALPRI_3H Alarm Priority: 3H
DB_ALPRI_3L Alarm Priority: 3L
DB_ALPRI_HDEV Alarm Priority: HDEV
DB_ALPRI_LDEV Alarm Priority: LDEV
DB_ALPRI_HROC Alarm Priority: HROC
DB_ALPRI_LROC Alarm Priority: LROC
DB_ALPRI_STCH Alarm Priority: STCH
DB_ALPRI_HCF Alarm Priority: BAD
DB_SNAP_ALIGN Node mask for snap align.
DB_CNF_ALIGN Node mask for cnf align
DB_OJ_ALIGN Node mask for OJ align
DB_PLB_ALIGN Node mask for plb align
DB_HIST_ALIGN Node mask for hist align
DB_GRP_TYPE_ARCH Archive Type
DB_GRP_TIMESPAN Time Span
DB_GRP_HIST_TYPE Archive Hist. Type
DB_GRP_ARCHFREQ Archive Frequency
DB_GRP_ARCHOFFSET Archive Offset
DB_GRP_SAMPFREQ Sample Frequency
DB_GRP_DISPFREQ Display Frequency
DB_GRP_ISDERIVED Derived Group
DB_GRP_INPGROUP Input Group
DB_GRP_NUMTAGS # of Tags
DB_GRP_TOTSAMP # of Archive Samples
DB_GRP_PRE_TRIP Pre-trip Time

218 2VAA000830-330 A
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

DB_GRP_POST_TRIP Post-trip Time


DB_GRP_ARCH_END_TIME Archive End Time
DB_GRP_ARCH_START_TIME Archive Start Time
DB_GRP_CLASS Group Class
DB_GRP_CLOSE_TRIP Close trip on return
DB_GRP_CURVE_TYPE Curve Type
DB_GRP_INITMODE Initial Presentation Mode
DB_GRP_FRAMECOL Trend Frame Color
DB_GRP_BORDERCOL Trend Border Color
DB_GRP_GRIDCOL Trend Grid Color
DB_GRP_TEXTCOL Trend Text Color
DB_GRP_DRAWMODE Trend Draw Mode
DB_GRP_LISTMODE Trend List Mode
DB_GRP_LISTMODE Trend List Mode
DB_GRP_XLSFILE Report file name
DB_GRP_VIEWER Group viewer program
DB_USR_PASSWEXPIRED User Password Expired
DB_USR_PASSWAGING User Password Aging
DB_USR_LANGUAGE User Language
DB_USR_LOGINDISPLAY User Login Display
DB_USR_LOGINPROG User Login Program
DB_USR_LOGOUTDISPLAY User Logout Display
DB_USR_LOGOUTPROG User Logout Program
DB_USR_CODE User Payroll Code
DB_USR_PASSWCHANGED User Password Changed
DB_USR_ACTIVE User Active
DB_USR_CRTMASK Mask of user allowed CRT
Reserved for Command by
DB_RESERVED_BY_USER
User
This node is Local source for
DB_IS_LOCAL_SOURCE
the tag
DB_ROWCOUNT Row Count for Alarm retrieval

3.24 Gas Index - Gas Molecular Weight


The following table provides the list of Gas Index – Gas Molecular Weight:
Table 3-24: Gas Index – Gas Molecular Weight

Index Gas Chemical Formula Molecular Weight


1 Hydrogen H2 2.016
2 Carbon monoxide CO 28.010
3 Methane CH4 16.043
4 Acetylene (Ethyne) C2H2 26.038
5 Ethylene C2H4 28.054
6 Ethane C2H6 30.070
7 Propane C3H8 44.097
8 N-Butane C4H10-N 58.124
9 Iso-Butane C4H10-I 58.124
10 N-Pentane C5H12-N 72.151
11 Neohexane C6H14 86.178
12 Hydrogen sulfide H2S 34.080
13 Carbon dioxide CO2 44.010
14 Oxygen O2 31.999
15 Water H2O 18.015
16 Sulphur dioxide SO2 64.063

2VAA000830-330 A 219
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

17 Nitrogen N2 28.016
18 Argon Ar 39.948
19 Air Air 28.959

3.25 Item Types for Field Assignment


The following table provides the list of Item Types for Field Assignment:

Table 3-25: Item Types for Field Assignment

Symbol Code Description


HNMPV 1 Analog tag.
HNMDI 2 Digital tag.
HNMCAL 4 Calculation.
HNMGRP 5 Trend group.
HNMNOD 7 Node (network server).
HNMLSD 9 Logic state descriptor.
HNMEU 10 Engineering unit.
HNMALC 11 Alarm comment.
HNMTXS 12 Text selector.
HNMLAD 13 Alarm summary group.
HNMOPC 15 Peg Board
HNMAUD 18 Audible alarm.
HNMUSR 19 Security (user and authorization).
HNMMEN 20 Menu and tool-bar.
HNMSOE 32 Sequence of Events
HNMPLA 33 Plant Area
HNMUIL 34 UI/Workplace Layout
HNMCOL 35 Logical Color
HNMFAV 37 User Favorites
HNMROL 38 User Roles
HNMQAT 39 Quality Attributes
HNMATM 40 Atom Configuration
HNMUSB 41 USB Recording Devices
HNMSNP 42 Snapshots
HNMPRT 43 Alarm Printers
HNMSCHD 44 Service Scheduler
HNMCUS 54 Custom Database
HNMMAI 56 Mail Configuration
HNMFSY 58 File Synchronization Database
HNMACT 59 Alarm Categories
HNMCFN 60 Calculation Functions

3.26 Word Offset Prefixes


The following table provides the list of Word Offset Prefixes:
Table 3-26: Word Offset Prefixes

Prefix Database
LA_ Audible tones database and alarm grouping database.
LC_ Calculation database.
LG_ Tag related databases (Engineering Units, Logic State Descriptors, Alarm
Comments, Text Selectors).
LH_ Trend group database.
LM_ Menu and tool-bar database.
LN_ Node database.
LO_ Security database.
LR_ Report database.
LT_ Tag database.
LX_ Export to foreign database.

3.27 Field Types


The following table provides the list of Field Types:

220 2VAA000830-330 A
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

Table 3-27: Field Types

Type Code
DT_CHAR 1
DT_VARCHAR 2
DT_LONGVARCHAR 3
DT_BIT 4
DT_TINYINT 5
DT_SMALLINT 6
DT_INTEGER 7
DT_BIGINT 8
DT_DECIMAL 9
DT_NUMERIC 10
DT_REAL 11
DT_DOUBLE 12
DT_FLOAT 13
DT_DATE 14
DT_TIME 15
DT_TIMESTAMP 16
DT_BINARY 17
DT_VARBINARY 18
DT_LONGVBINARY 19

3.28 Alarm Types


The following table provides the list of Alarm Types:
Table 3-28: Alarm Types

Code Symbol Description


1 ALEINF Information event.
2 ALERTN Return to normal.
3 ALEOPE Operator action.
4 ALEACK Alarm acknowledge event.
5 ALEOEV Event.
6 ALEOFF Alarm off scan
7 ALEOLD Bad alarm (never updated)
11 ALEDIA Digital alarm.
12 ALEHIR High instrument alarm.
13 ALELIR Low instrument alarm.
14 ALESHA 3-high alarm.
15 ALESLA 3-low alarm.
16 ALEHHA 2-high alarm.
17 ALELLA 2-low alarm.
18 ALEHAL High alarm.
19 ALELAL Low alarm.
20 ALERCP Rate of change increment
21 ALERCN Rate of change decrement
22 ALEHDV High deviation alarm.
23 ALELDV Low deviation alarm.
24 ALEHCF Bad alarm
25 ALEALA Generic alarm.
26 ALEEVT Event
40 ALEVOT Voting alarm (reserved).
41 ALEMUL Multiple alarm conditions (main
tag with atoms)
42 ALERTM Remove alarm message
43 ALEOPR Operator process change
44 ALSHLV Alarm Shelve
45 ALUSHL Alarm Un-shelve
46 ALSUPP Alarm Suppress
47 ALUSUP Alarm un-suppress
49 ALPOOS Alarm on service
50 ALROOS Alarm remove from service
51 ALRMTM Reset alarm timer (shelve)
128 ALELST

2VAA000830-330 A 221
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

3.29 Dynamic Symbols


The following table provides the list of Dynamic Symbols:
Table 3-29: Dynamic Symbols

Code Symbol Description


1 A_NAME Tag name
2 A_DESC Tag description
3 A_INDX Tag index
4 A_CUST Customer tag id (plant tag name)
5 A_GROU Alarm group
6 A_PRIO Alarm priority
7 A_EU EU descriptor
8 A_CMNT Alarm comment (buffer, 2W value + 2W quality)
9 A_ITMT Item type
10 A_ITMN Item number
11 A_VAL Value (buffer, 2W value + 2W quality)
12 A_VALQ Value and quality (buffer, 2W value + 2W quality)
13 A_STAT Status (buffer, 2W value + 2W quality)
14 A_STAQ Status and quality (buffer, 2W value + 2W quality)
15 A_TIME Time
16 A_DATE Date
17 A_DATI Date and Time
18 A_HTIM Historical time (buffer, 2W)
19 A_HDAT Historical date (buffer, 2W)
20 A_HDTI Historical date and time (buffer, 2W)
21 A_OPER Operator name (buffer, 1W)
22 A_CANC Cancode parameter (buffer, n/3 W)
23 A_ASCI Ascii parameter (buffer, n/2 W)
24 A_REAL Real parameter (buffer, 2W)
25 A_LONG Long integer parameter (buffer, 2W)
26 A_INTE Short integer parameter (buffer, 1W)
27 A_HEXL Long integer (hex) parameter (buffer, 2W)
28 A_HEXA Short integer (hex) parameter (buffer, 1W)
29 A_YENO Yes (1) / Not (0) (buffer, 1W)
30 A_TUTS Timer units (buffer, 1W)
31 A_NREF Item number referenced (buffer, 4W)
32 A_EDSC Extended description
33 A_NODE Local node name
34 A_QUAL Tag quality
35 A_PROD Product name
36 A_SKVL Skip value
37 A_BKVL Backward Skip value
38 A_DBXF Data Base Reference
39 A_UTX1 Text from OPC AE (1)
40 A_UTX2 Text from OPC AE (2)
41 A_UTX3 Text from OPC AE (3)
42 A_UTX4 Text from OPC AE (4)
43 A_UTX5 Text from OPC AE (5)
44 A_CHAR Plain ASCII text (non UNICODE Compliant)

3.30 DataProcessor file - XML structure


The following table provides the list of DataProcessor file – XML structure:
Table 3-30: DataProcessor file – XML structure

Element Item Description


MACRO Identifies the section of the xml file to specify the object type (including the list of the atoms
of the type)

Name of the type specified in the DataProcessor field in the data base of the tag (for
Name example “AC450.Block.XmlFileName.CFG”)
separator Character separator of the OPC items
Used to identify the name of the atom that will be used by Symphony Plus as “main”
Main atom
Tag type used in the Symphony Plus database.
222 2VAA000830-330 A
S+ Operations DB Reference OFF-LINE SYSTEM CONFIGURATION TABLES

Type
Accepted values: DIGITAL, ANALOG, INTEGER
ATOM Identifies the section to specify the name and the attributes of the atoms in the macro
Name Atom name
Descr Atom description
Canonical OPC item type (like distributed by OPC server)
Type
Accepted values: BOOL, INTEGER, DINT, REAL, STRING

3.30.1 DataProcessor file - XML structure


Following is an example of a DataProcessor.XML file to define a specific macro with atoms and Table 3-30 describes the
syntax.
<?xml version="1.0" ?>
<AC450>
<!-- Comment -->
<MACRO name="CFG" separator=":" mainatom="VALUE_TREAT" type="INTEGER">
<ATOM name="Alarm" descr="Status byte 1" type="BOOL" />
<ATOM name="ALARM_BLK" descr="Status byte 2" type="BOOL" />
<ATOM name="ALARM_PERIOD_BLK" descr="Status byte 2" type="BOOL" />
</MACRO>
</AC450>

2VAA000830-330 A 223

Visit us

Document Number: 2VAA000830-330 A


solutions.abb/symphonyplus
solutions.abb/controlsystems

You might also like