You are on page 1of 569

Power Generation Portal

Version 4.1

Configuration Manual

Power Generation Portal


Version 4.1

Configuration Manual

Release:
Document number:

Oct 2007
9AKK101130D1382

TRADEMARKS
Registrations and trademarks used in this document include:
Acrobat

Registered trademark of Adobe Systems, Incorporated.

Adobe

Registered trademark of Adobe Systems, Incorporated.

Advant

Registered trademark of ABB Inc.

AdvaBuild

Registered trademark of ABB Inc.

Industrial IT

Trademark of ABB Inc.

Microsoft

Registered trademark of Microsoft Corporation.

Windows

Registered trademark of Microsoft Corporation

About This Book 13


Scope 13
Intended User 13
Document Structure 13
Related Documentation 15
On-line Documentation 15
Configuration Guide 17
Main Features 17
Configuration Overview 29
Outline of Configuration 30
System Configuration 36
System Configuration Interface 37
System Configuration Parameters 42
System Sizes 42
System Options 42
Configuration Procedure 42
Introduction 42
Calling the Builders 43
Building Procedure 46
Builder Window 47
Builder List 47
Builder Action Buttons 54
Builder Options 60
Export Window 64
Export Action Buttons 65
Database Configuration 69
Introduction 69
Tag Database Subsystem 71
Outline 71
Tag Database 71
Generic Tag Definition 73
General Parameters 73
Process Parameters 77
Generic Scanner Input Parameters 83
Generic Scanner Output Parameters 85

Note 1: 87
Command Parameters 89
Alarm Processing Parameters 89
Alarm Level Parameters 96
Alarm Option Parameters 96
Alarm Comment Parameters 96
Network Parameters 98
OPC Parameters 100
Totalization Parameters 104
Device Status Parameters 104
Documentation Parameters 104
Hardware Description Parameters 105
Application Parameters 109
Digital Tag Definition 113
General Parameters 114
Process Parameters 117
Generic Scanner Input Parameters 118
Generic Scanner Output Parameters 119
Symphony Input Parameters 119
Command Parameters 121
Alarm Processing Parameters 123
Alarm Level Parameters 123
Alarm Option Parameters 123
Alarm Comment Parameters 123
Network Parameters 124
OPC Parameters 124
Totalization Parameters 125
Device Status Parameters 126
Documentation Parameters 129
Hardware Description Parameters 129
Application Parameters 129
Analog Tag Definition 129
General Parameters 129
Process Parameters 134
Generic Scanner Input Parameters 135

Generic Scanner Output Parameters 135


Symphony Input Parameters 135
Command Parameters 136
Alarm Processing Parameters 136
Alarm Level Parameters 138
Alarm Option Parameters 146
Alarm Comment Parameters 150
Network Parameters 153
OPC Parameters 153
Totalization Parameters 153
Device Status Parameters 157
Documentation Parameters 157
Hardware Description Parameters 159
Application Parameters 160
Alarm Comments 160
Outline 160
Alarm Comment Definition 161
Engineering Units 161
Outline 161
Engineering Units Definition 162
Logic State Descriptors 163
Outline 163
Logic State Descriptors Definition 163
Text Selector 164
Outline 164
Text Selector Definition 164
Alarm Management Subsystem 166
Alarm Lists 166
Outline 166
Alarm Group Database 166
Alarm Group Definition 167
General Parameters 167
Grouping Parameters 168
Security Parameters 171
Additional Parameters 171

Audible Alarms 172


Outline 172
Audible Alarms Definition 173
Calculation Subsystem 174
Calculations 174
Outline 174
Calculation example 174
Calculation Database 176
Calculation Definition 176
General Parameters 176
Log Parameters 177
Frequency Parameters 178
Formula File Parameters 180
Network Parameters 181
Macro Function Parameters 182
Calculation Formula Syntax 182
Character Set 183
Operands 183
Comments 184
Multiple Line Statements 185
Expressions 185
Control Structures 190
Intrinsic Functions 193
Execution Functions 194
Logical Functions 195
Mathematical Functions 196
Tag Functions 202
Time Functions 206
Steam Functions 209
Gas Property Functions 212
Sea Water Functions 214
Fuel Combustion Functions 215
Wet Air Functions 222
Data File Functions 225
Historical Functions 227

Trend Group Subsystem 235


Trend Groups 235
Outline 235
Examples of Trend Groups 235
Trend Group Database 236
Generic Trend Group Definition 236
General Parameters 237
Display Parameters 240
Link Parameters 241
Log Parameters 243
Tag List Parameters 244
Network Parameters 247
Realtime Trend Group Definition 248
Historic Group Definition 248
History Parameters 249
Time Function Parameters 253
Post Trip Trend Group 254
Trip Parameters 255
Report Subsystem 257
Report 257
Outline 257
Report Database 258
Report Definition 258
General Parameters 258
Activation Parameters 260
Archiving Parameters 261
Printing Parameters 263
Excel Parameters 264
SOE Parameters 265
Excel Work-Sheet 265
Public and Themodynamic Functions 265
Libraries of Functions 266
Public functions 266
Steam Functions 273
Gas Property Functions 276

Sea Water Functions 277


Fuel Combustion Functions 278
Wet Air Functions 284
Pegboard Subsystem 286
Outline 286
Pegboard Database 286
Pegboard Definition 287
General Parameters 287
Link Parameters 288
Popup Parameters 289
Operator Station Subsystem 291
Menu and Tool-bars 291
Outline 291
Menu and Tool-bar Database 291
Menu and Tool-bar Definition 291
Identification Parameters 292
Action Parameters 293
Presentation Parameters 298
Allowed Parameters 302
Privilege Parameters 303
Network Subsystem 307
Nodes 307
Outline 307
Node Database 307
Node Definition 308
General Parameters 308
Alarm Process Parameters 313
Security Subsystem 317
Security 317
Outline 317
Security Database 319
Security Definition 319
General Parameters 320
Access Control Parameters 323
Access Security Parameters 325

Client Parameters 331


Enhanced User Management 332
Security Defaults 336
Foreign Database Support Subsystem 337
Foreign Database 337
Outline 337
Target Database Requirements 337
Static Tables 338
Dynamic tables 342
Data Export Manager 347
Setup Guidelines 349
Tuning and Troubleshooting 350
System Configuration 353
Server Configuration Subsystem 353
Direct Access File System 353
Process Scheduling 356
Daylight Saving Time 358
Operator Station Subsystem 359
Language 359
Database Subsystem 361
Field Assignment Cross-Reference 361
Alarm Management Subsystem 366
Introduction 366
Color/Blink Override 367
Message Subsystem 371
Alarm message 371
Error messages 375
Off-line Utilities 379
Introduction 379
Start PGP 379
Overview 379
Activating PGP 379
PGP Description 380
PGP Explorer 380
Overview 380

Calling PGP Explorer 380


SODG Display Translator 380
Overview 380
Importing the displays 381
Calling Display Translator 382
Translating Displays and Symbols 382
Extracted processed symbols 387
Extracted processed symbols 387
DT Symbols Files 388
DT Symbols Files 388
Display Compiler (EIXCMP) 388
Overview 388
Calling Display Compiler 389
Compiling Displays 389
Display Builder 392
Overview 392
Calling Display Builder 392
Display Builder Description 392
Data Export Manager 392
Overview 392
Calling Data Export Manager 393
Data Export Manager Description 393
Historical Backup 393
Overview 393
Archives 394
Alarm Archive 394
Trend Group Archive 395
Playback Archive 395
Post Trip Archive 396
Totalization Archive 396
Calling Historical Backup Archiving 396
Archiving Interface 397
Saving Procedure 398
Restoring Procedure 400
Deleting Procedure 401

One Shot Backup 402


Overview 402
Calling One Shot Backup 403
One Shot Backup Description 404
Save/Restore Configuration 404
Overview 404
Calling Save Settings 405
Save Config/Display/Data 405
Restore 409
Long Term Archive (LTA) 411
Overview 411
Long Term Archive Explorer Activation 412
Archives 412
Registry 412
Registry 412
Functionality 416
LTA Interface 417
Configured Servers 420
LTA Status 420
LTA Status 420
LTA drive status 422
LTA drive status 422
Change Parameters 423
LTADriveCmd program 424
People Finder 426
Overview 426
Database 426
Registry 426
Registry 426
Calling Finder Configuration 427
Calling Finder Configuration 427
New Phone 430
New Sms Index 430
New Sms Index 430
Sms Index 433

Functionality 435
Master/Slave 436
Real-time Utilities 437
Distributed Architecture 439
Introduction 439
Assumptions 441
Server Functions 442
On-line Features 442
Initialization Features 443
Client Functions 444
ALIGNSPECS Program 444
Tables 469
Tag Types 469
Tag Sources 471
Default Color Map 471
Digital Tag Field Applicability 474
ICI Action Codes 474
ICI Point Types 475
Time Units 477
Instrument Types 477
Tag Quality Bits 477
System Information 479
Tag Configuration Retrieving Parameters 489
Gas Index Table and Gas Molecular Weight 518
Item Types for Field Assignment 518
Word Offset Prefixes 520
Field Types 520
Alarm Types 522
Dynamic Symbol Table 523
Data Processor file 525
AC800F Support 527
Overview 527
Functionalities 527
Plc File parsing results xml file/s (Temporary File) 529
FreelanceTemplate.xml (Temporary File) 529

DBHeader.xml (Persistent File) 530


Correspondences.xml (Persistent File) 530
Starting-up the PLC File Builder 531
Open a PLC File 532
Build a PLC File 539
Messages window 543
Log file 543
Add a New PLC Object Type (Example) 544
AC800F Requirements 544
PGP Requirements 545

About This Book


Scope
The Power Generation Portal Configuration Manual provides an efficient
means to define all information needed to configure or update the Power
Generation Portal (PGP) basic software and application software.

Intended User
This manual can be used by anyone who performs the functions of a system
manager or configuration manager on a PGP application.

Document Structure
The Power Generation Portal Configuration Manual contains seven major
sections:

The first section introduces configuration from a general point of view.

The approach to configuration is depicted here. The general


configuration procedure is also described. This section is intended to
give the reader the basic information and knowledge to perform a
configuration change.

The second section details the database files configuration items.

The structures of the databases for tags, trend groups and calculations
are explained giving description of each field. Customers will use this
section commonly since it is strictly related to application entities.

The third section details the system files configuration items.

The structure of XML files used to configure system files is explained


giving description of each field. Normal users are not required to use
this section. Just in case an application must be deeply customized,
experienced users may must use this section.

9AKK101130D1382

13

The fourth section outlines some off-line procedures not embedded


within the on-line basic menus of PGP. These procedures are PGP
Startup, PGP Explorer Startup, Database Builder, Display Translator,
Data Export Manager, Long Term Archiving and System Setup Utility.

The last three sections introduce the distributed architecture and the
OPC server and client.

A final Appendix section collects tables referenced throughout the


document. Other Appendix sections introduce the PLC File Builder designed
to interface the Freelance and the Tag Export designed to interface the
Composer.
Use of Warning, Caution, Information, and Tip Icons
This publication includes Warning, Caution, and Information, where
appropriate, to point out safety related or other important information. It also
includes Tip to point out useful hints to the reader. The corresponding
symbols should be interpreted as follows:
Electrical warning indicates the presence of a hazard which could result in
electrical shock.
Warning indicates the presence of a hazard which could result in personal
injury.
Caution indicates important information or warning related to the concept
discussed in the text. It might indicate the presence of a hazard which
could result in corruption of software or damage to equipment/property.
Information alerts the reader to pertinent facts and conditions.
Tip indicates advice on, for example, how to design your project or how to
use a certain function.
Although Warning hazards are related to personal injury, and Caution
hazards are associated with equipment or property damage, it should be
understood that operation of damaged equipment could, under certain
operational conditions, result in degraded process performance leading to

14

9AKK101130D1382

personal injury or death. Therefore, comply fully with all Warning and
Caution notices.

Related Documentation
On-line Documentation
All documentation is supplied in Adobe Acrobat reader (.pdf) format.
The Power Generation Portal User Manual is also available as online Help.
Category
Software
Installation

Title
Power Generation Portal
Installation Manual

Description
How to install Power Generation Portal.

Power Generation Portal Release Known problems, fixed problems and other
Notes
release information.
Power Generation Portal
Configuration Manual

Shows you how to configure and use Power


Generation Portal.

Power Generation Portal Display Provides instructions for building custom


Builder Manual
graphic displays using the Display Builder.
Configuration

Power Generation Portal


Scanner Manual

Shows you how to configure Power Generation


Portal drivers

Power Generation Portal Registry List all registry settings used by Power
Settings
Generation Portal Software
Power Generation Portal 800xA
Connectivity Package

9AKK101130D1382

Shows you how to interface AC800M


controllers.

15

Category

Operation

Title

Description

Power Generation Portal User


Manual

Provides instructions for using Power


Generation Portal features.

Power Generation Portal


Application Programmer
Interface

Information on how to create application


programs that execute Power Generation
Portal functions.

Power Generation Portal Product


An overview of functions offered by PGP
Guide
Power Generation Portal
Troubleshooting Manual

16

Assist in troubleshooting problems

9AKK101130D1382

Section 1 Configuration Guide


Main Features
PGP is a versatile software package that allows various configurations,
which can have a number of functions and a specific capability according to
the clients requests.
Minimum, default and maximum values of sized features of the package are
described here below in Table 1 Current system features are left blank and
may be written in accordance with the sizing of the individual application. If
no specific sizing is required, the package will be configured with the sizing
indicated in the fourth column of the table. Most of unlimited maximum
values are only limited by disk capacity.

9AKK101130D1382

17

Further features are listed and detailed below.


Table 1. Features: Sizes.
Category

Parameter or Feature

Min.

Default

Max.

Current

Database
Tags Number of Analog Tags

100

5,000

256,000

Number of Digital Tags

100

5,000

256,000

Number of Database Tags

200

10,000

512,000

Eng. Units Number of Descriptors

128

512

Logic States Number of Descriptors

512

2,048

Alarm Comments Number of Comments

100

1,024

Tags Number of Handled Alarms

N/A

N/A

Unlimited N/A

No. of Analog Alarm Levels

N/A

No. of Rate of Change Levels

N/A

No. of Deviation Levels

N/A

Unacked Alarm Msg. Capacity

10

272

1,024

Nodes Alarm Broadcasted Nodes

64

Priorities Number of Alarm Priorities

16

20

32

512

100

2,000

100

10,000

N/A

256

256

Alarm Handling

Groups Number of Alarm Groups

Number of Alarm Colors


Tones Number of Audible Tones
Calculations
Tags No. of Tags per Calc. Block
Blocks No. of Calculation Blocks
Statements Statement Length

18

256

9AKK101130D1382

Table 1. Features: Sizes.


Category

Parameter or Feature

Min.

Default

Max.

Current

Human Interface
Displays Number of Displays

N/A

N/A

Unlimited

100

500

32

32

N/A

500

1,000

0.2

99.0

SP and CO Fast Increment (%)

4.0

99.0

Popup Time-out (m)

60

Users Number of Individual Users

20

100

User Name Number of Characters

18

18

Password Number of Characters

18

18

256/SER

Pegboards Number of Pegboard


Windows Number of Operator Windows
No. of Menu Items and Icons
Process Control SP and CO Increment (%)

Security

Process Events
SOE Number of SOE Tags

5,000/SE
M
Number of SOE Devices

10

N/A

N/A

Unlimited

N/A

N/A

Unlimited

Playback Number of Playback Hours

24

24

No. of Playback Snapshots

10

100

Summaries
Tags realtime Tag Summaries
Tag Operating Parameters
Hist. Archiving

9AKK101130D1382

19

Table 1. Features: Sizes.


Category

Parameter or Feature

Trend Groups Number of Trend Groups

Min.

Default

Max.

Current

100

1,000

No. of Tags per Trend Group

60

512

No. of Colors for Trend Curves

15

15

15

N/A

10,000

100,000

Maintenance Number of Digital Totalizations

100

1,000

Totalizations Number of Analog Totalizations

100

1,000

10,000

Max Number of Files

100

9,999

Number of Long Term Logs

N/A

N/A

Unlimited N/A

Number of Unique Reports

50

1,000

N/A

99

N/A

N/A

Unlimited N/A

Clients Number of Clients Served

32

64

Nodes Number of Nodes

32

64

(Value includes historical, post


trip and realtime groups)

Chronol. Alarms No. of archived messages

Post Trips Max Latency Days

15

Long Term Arch.

Reports

Printing
Printers Number of Printers
Ext. Interfacing
Interfaces Number of Unique Interfaces
Hardware

Communication
Infinet Number of INICIs

20

9AKK101130D1382

Table 2. Features: Details.


Category

Parameter or Feature

Details

Database
General Configuration
Tags Standard Format
Compatibility to ...

On-line and Off-line.


Dbase III/IV (DBF) or Excel (XLS).
Win Tools,
Composer (conversion to or from
MDB file).

Eng. Units Standard Format


Compatibility to ...
Logic States Standard Format
Compatibility to ...
Alarm Comments Standard Format

Dbase III/IV (DBF), Excel (XLS) or


CF File.
Win Tools (CF File).
Dbase III/IV (DBF), Excel (XLS) or
CF File.
Win Tools (CF File).
Dbase III/IV (DBF) or Excel (XLS).

Alarm Handling
General Alarm Acknowledgment

Global (user restricted),


per Individual Tag,
per Alarm Page (all tags displayed).

Alarm Inhibit

Automatic per Individual Tag,


Manual per Individual Tag.

Alarm Action Program

Activation configurable per individual


tag and per alarm condition.
The Alarm Action Program must be
separately implemented.

Tags Variable Alarm Levels


Alarm Dead-band

9AKK101130D1382

Configurable per individual tag.


Configurable per individual tag.

21

Table 2. Features: Details.


Category

Parameter or Feature

Details

RTN as New Message

Configurable per individual tag.

Remove Alarm Message on Ack

Configurable per individual tag.

Groups Group Tree

Configurable.
Default: 16 main groups and 16 subgroups for each main group.

Nodes Acknowledgment Broadcast

Configurable (default NO).

Tones Types of Audible Tones

Beep,
Wave file (one shot or continuous),
Horn (via RCM).

Audible on Alarm

Configurable per individual tag.

Audible on RTN

Configurable per individual tag.

Alarm Audible Silence

Global.

Disable Audible on Acknowledge

Configurable (default YES).

Pages Alarm Display

Alarm Page per group and


Unacknowledged Alarm Window.

Alarm Filtering

per Priority,
per Alarm Group.

Alarm Summary

Summary always on view and


One click to display.

Message Format Font Height and Weight of Message

22

Configurable.

Alarm Comments on Alarm Display

Configurable (default NO).

Value Updated within Alarm Display

Configurable (default YES).

Milliseconds within Date/Time

Configurable (default YES).

Time of Alarm Resolution

1 Millisecond.

9AKK101130D1382

Table 2. Features: Details.


Category

Parameter or Feature
Date and Time

Details
Configurable.
Standard: dd-mmm-yy or
Alternate: according to Regional
Option settings.

International Date

Configurable according to Regional


Option settings.

Calculations
General Configuration
Triggering
Statements Statement Length
Operators Arithmetical Operations

On-line and Off-line.


On event and On schedule.
Configurable.
+, - (prefix), - (infix), *, /,
% (module), ^ (exponential).

Logical Operators

AND, OR, NOT.

Relational Operators

<, ==, >, <=, !=, >=.

Structures Control Structures

IF-THEN-ELSE,
WHILE-DO.

Functions Mathematical Functions

9AKK101130D1382

ABS, SIN, COS, EXP, LN, LOG10,


MIN, MAX, SQR, etc.

Tag Functions

GETINFO, GETTAG, SAVEVALUE,


TEST_ALARM, TEST_QUALITY,
FORCE_QUALITY, etc.

File Functions

READFILE, WRITEFILE.

Time Functions

DAY, HOUR, DAYOFWEEK,


DELTATIME, etc.

Steam Functions

Specific Heat, Hentalpy, Entropy,


Specific Volume, Water Viscosity,
Water Conducibility, etc.

23

Table 2. Features: Details.


Category

Parameter or Feature

Details

Gas Property Functions

Specific Heat, Enthalpy, Entropy,


Molecular Weight of Gas.

Sea Water Functions

Specific Heat, Enthalpy, Density,


Thermal Conducibility, Dynamic
Viscosity of Sea Water.

Wet Air Functions

Specific Heat, Enthalpy, Entropy,


Temperature, Humidity of Wet Air.

Fuel Combustion Functions

Specific Heat, Enthalpy, Entropy,


Temperature of Fuel.

Historical Functions

COUNTER, DELAY, DERIV, FILT,


GRAD, HIST_VAL, INTEG, etc.

Macros Library of Macros

Thermal Power Plant and MSF


Desalination Plant macros.

Human Interface
General Language

Multi-language supported.
Default English or Italian.
Other languages supported if
translation files are provided.
Support for UNICODE characters
and Right-To-Left aligned languages
available.

Displays Graphic Editor

Embedded Editor,
SODG (via translation),
Loox Maker.

Import Existing Mimics

SODG

Update Frequency of Dynamics

Selectable 1 Sec. or 5 Sec.

Pegboards Structure (Pop-ups Allocation)


Standard Input Format

24

Configurable within 32 cells.


Dbase III/IV (DBF) or Excel (XLS).

9AKK101130D1382

Table 2. Features: Details.


Category

Parameter or Feature

Windows Multi-screen
Draggable Windows
Process Control SP and CO Increment

Details
Configurable (default NO).
Configurable (default NO).
Configurable (default 0.2%).

SP and CO Fast Increment

Configurable (default 4%).

Double Click to Select Popup

Configurable (default NO).

Security
General Access
Technology
Log In Log In

Individual users.
Proprietary.
Username and Password.

Username

No case sensitivity.

Password

No case sensitivity.

Default Log-in User

Configurable.

Log-in Display

Configurable.

Log Out Log Out

Manual on demand or
Automatic on time-out.

Log-out Time-out

Configurable.

Log-out Display

Configurable.

Process Events
General Sequence of Events
Sequence of Events Resolution
Tags Number of SOE Events
Duplication of SOE to Digital Inputs
Logs Multiple SOE Logs

9AKK101130D1382

Standard and distributed.


1 Millisecond.
Configurable.
Configurable (default YES).
Kept individual or merged.

25

Table 2. Features: Details.


Category

Parameter or Feature

Details

Summaries
Tags realtime Tag Summary

Multiple filtering criteria.

Hist. Archiving
General Types of Data

Playback,
Historical Trend Groups,
Post Trip Groups,
Chronological Alarm Messages

Automatic Archiving on Time Basis

Playback, Historical Groups and


Chronological Alarm Messages.

Automatic Archiving on Event Basis

Post Trip Groups.

Playback Tags Archived on Playback

Configurable per Individual Tag,


All Tags by Default.

Playback Data Compression


Trend Groups Types of Historical Trend Groups

Slope Band.
Istantaneous Value, Minimum,
Maximum, Total, Count, Monitor and
Ratio.

Trend Group Displaying Formats

Trend or Table.

Trend Group Time Displaying

realtime or Historical.

Curve Highlight on Trend

Bolding of Selected Tag.

Tag Engineering Unit Scale on Trend

Default: 0 - 100 % or
E.U. Scale of Selected Tag.

Trend Curve Analysis

Pause realtime trending,


Zoom and Pan Functions,
Drag Cursor.

Trend Group Configuration

26

On-line or Off-line.

9AKK101130D1382

Table 2. Features: Details.


Category

Parameter or Feature
Trend Group Display Configurability

Details
On-line.
Tag Scale, Curve Color and Display
Coordinates.

Statistic Data of Trend Curves

On Demand.
Average, Minimum and Maximum,
Time of Minimum and Maximum.

Chronol. Alarms Alarm Summary


Post Trips Latency on Disk

Multiple Filtering Criteria.


Configurable in term of days and
number of files.

Long Term Arch.


General Type of Data

Playback, Chronological Alarm


Messages, Historical Groups, Post
Trip Groups.

Archival Storage

On-line, Remote

Automatic Archiving on Time Basis

Configurable.

Manual Archiving

Supported.

Media Archive to ...

CD-ROM, Optical Disk, DAT Tape,


Disk File.

Reports
General Template Configuration

Scheduling: On-line and Off-line,


Work-sheet: Off-line.

Logged Data

realtime and Historical.

Triggering

On event or On schedule.

Latency on Disk

Configurable in term of days and


number of files.

Logs Data Logging

9AKK101130D1382

Custom Excel Work-sheet.

27

Table 2. Features: Details.


Category

Parameter or Feature

SOE Sequence of Events Logging

Details
Standard Text File,
Custom Excel Work-sheet.

Printing
Alarms Type of Printing

Automatic Single Line,


Automatic Full Page,
Manual on Demand.

Alarms per Page

Configurable.

Enable/Disable Alarm Printing

Manual.

Alarm Printer Operation

Enable/Disabled at start-up time


(default DISABLED).

Alarm Page Header

Configurable.

Reports Timing

Automatically Scheduled,
Manual on Demand.

Ext. Interfaces
OLE OLE/DDE Interface
ODBC ODBC Interface

DDE Functions.
Oracle, Access, dBase IV, Excel, MS
SQL Server.

OPC OPC Interface

OPC Server and OPC Client.

WEB WEB Extensions

Internet and Corporate Intranet.

Hosts Architecture

Client/Server.

Hardware

Host PC

Custom
(Dell and Compaq suggested).

Clients Client Switch-over to Server


Server List for Clients

28

Automatic or Manual.
Configurable.

9AKK101130D1382

Table 2. Features: Details.


Category

Parameter or Feature

Nodes Redundancy
Field Field Hardware

Details
Multi-Master Nodes.
Freelance 2000, Symphony, Infi 90,
Network 90, Foreign Devices.

Communication
Standard Supported
Scanner Suite Capability to Host Drivers for

C-Net, Infinet, Plant Loop.


Foreign Protocols.
Suite provided for support.

Embedded Drivers for

Modbus Protocol,
Generic Serial Protocol,
Text Files,
Relational Database (OBDC),
TCP/IP IEC 8070-5-104 Protocol,
System Six through DAS API.

Configuration Overview
These instructions provide information to configure PGP. The configuration
steps assume that the system is being generated for the first time, and
therefore may include some steps that could be skipped on subsequent
generations.
Some configurations can be performed just to reflect the hardware
configuration of the system, others may be performed to implement
archiving, or to customize alarm management. The former takes place
during the system set up or when new hardware equipment is going to be
installed, the latter may take place several times during the life-cycle of the
PGP application.

9AKK101130D1382

29

Outline of Configuration
This section outlines the general steps for configuring PGP. The following
sections provide the necessary information to actually perform the
configuration steps outlined here.
PGP database is mainly loaded by a set of (at least one) DBF or XLS files.
The content of these files is processed and loaded in the PGP data files by
running a build procedure. These files are located, unless differently
specified, in the CONFIG folder and sub-folders.
PGP is mainly off-line customized editing a set of XML files. They are
commonly named (for historical reason) DECK files or DECKs. These files
are located, unless differently specified, in the DECK folder.
The content of DECK files is processed and loaded in the PGP data files by
running a build procedure.
Database configuration and system customizations are separated activities.
They can be performed in different time and, with some restrictions, in
whatever order. Each operation can be performed separately from the
others. Only changing the system sizes or rebuilding the file system requires
a complete build procedure. A single DECK can be processed to change a
specific configuration. Restrictions in the sequence of processing take place
when DECKs have some relationship.
Changes to the configuration of a DECK file must be carried out by copying
the DECK file to the CONFIG\DECK folder as 2DECK (e.g. to change
BATTDECK configuration, copy the file as BATT2DECK in the
CONFIG\DECK folder). A 2DECK file must contain only changes to the
default (defined by DECK file) configuration.
A DECK file automatically references the 2DECK file, if existing, during the
build phase.
Displays are configured by a dedicated procedure, it is described in a
separated manual. Here just the directions to convert and compile displays
are given.
In the following description, bold and underlined characters are used to
highlight mandatory configuration actions and bold characters are used to
highlight optional configuration actions to be performed for each installation.

30

9AKK101130D1382

Optional configurations depend on the specific application. Normal


characters are used to list activities that are usually responsibility of ABB
Energy Automation people and may optionally involve the customer. PGP is
delivered with a default configuration. It allows the system to run properly.
Setup the configuration of the system.
Evaluate the system sizes and options. Choose the proper configuration
parameters by the SysSetup utility.
Configure the application file system.
Create and/or update the application direct access file system definition file
BFIL2DECK.
Configure error messages.
Create and/or update the application error message definition file
BEMF2DECK.
Please note that this file should be modified to translate messages into
foreign languages. Refer to BLANGDECK file for the text translation.
Changing the structure of existing messages may result in data presentation
problems.
Determine the rescheduling timer for application tasks.
Create and/or update the application program timer definition file
BTIM2DECK.
Configure daylight saving time.
Create and/or update Daylight Saving Time definition file BDST2DECK.
Configure application menu and tool-bar.
Generate menu and tool-bar database(s) on a Personal Computer using the
Dbase III/IV or Excel utility.

9AKK101130D1382

31

Export the menu and tool-bar database file(s) to the computer running PGP
and build the menu and tool-bar database file(s) on board the PGP
computer.
PGP provides a default menu and tool-bar configuration.
Configure the language.
Create and/or update the language dictionary definition file BLANG2DECK.
Set the database cross-reference.
The database configuration may require updating the database crossreference file DBXRFDECK. The definition of all database fields requiring
non-standard processing, such as site-specific field assignments or reject
rules, must be included in the cross-reference definition.
Create and/or update the database cross-reference definition file
DBXRF2DECK.
Configure engineering unit database.
Generate engineering unit database(s) on a Personal Computer using the
Dbase III/IV or Excel utility or the SLDG utilities provided by the Bailey
Engineering Work Station.
Export the engineering unit database file(s) to the computer running PGP
and build the engineering unit database file(s) on board the PGP computer.
This operation must be carried out if engineering units are referenced by an
index within the tag database. The configuration is not required if the
engineering unit texts are defined within the tag database.
Configure logic state descriptor database.
Generate logic state descriptor database(s) on a Personal Computer using
the Dbase III/IV or Excel utility.

32

9AKK101130D1382

Export the logic state descriptor database file(s) to the computer running
PGP and build the logic state descriptor database file(s) on board the PGP
computer.
Typically, logic state descriptors are defined within the tag database.
Configure tag database.
Generate tag database(s) on a Personal Computer using the Dbase III/IV or
Excel utility. There are some utilities that allow you to import the DataBase
generated by different Engineering Tools. The SLDG utility provided by the
Bailey Engineering Work Station allows you to import DataBases generated
for the Harmony system. The PlcFileBuilder utility allows you to import
DataBases generated for the AC800F, while the Ac800mBuilder tool allows
you to import DataBases generated for the AC800M systems.
Export the tag database file(s) to the computer running PGP and build the
tag database file(s) on board the PGP computer
For more information on how to configure the AC800M database refer to the
manual: 9AKK101130D1482 - 800xA Connectivity Manual.
For more information on how to configure the AC870P database refer to the
manual: 9AKK105130D3258 - PGP for AC870P.
Configure calculation database.
Create a source file for each calculation block, defining the algorithm and all
input and output tags.
Determine name, number, description and rate of all calculation blocks.
Generate calculation database(s) on a Personal Computer using the Dbase
III/IV or Excel utility. Export the calculation database file(s) to the computer
running PGP and build the calculation database file(s) on board the PGP
computer.
The definition file associates calculation blocks with related algorithm source
files.

9AKK101130D1382

33

The configuration of calculated tag falls in the tag database configuration:


calculation tags are a kind of the tags in the database.
Configure Trend Group database.
Generate Trend Group database(s) on a Personal Computer using the
Dbase III/IV or Excel utility. Export the Trend Group database file(s) to the
computer running PGP and build the Trend Group database file(s) on board
the PGP computer.
Configure alarm comment database.
Generate alarm comment database(s) on a Personal Computer using the
Dbase III/IV or Excel utility. Export the alarm comment database file(s) to the
computer running PGP and build the alarm comment database file(s) on
board the PGP computer.
This operation must be carried out if alarm comments are referenced by an
index within the tag database. The configuration is not required if the alarm
comment texts are defined within the tag database.
Configure text selector database.
Generate text selector database(s) on a Personal Computer using the
Dbase III/IV or Excel utility. Export the text selector database file(s) to the
computer running PGP and build the text selector database file(s) on board
the PGP computer.
Configure pegboard database.
Determine the number and the structure of pegboards.
Generate pegboard database(s) on a Personal Computer using the Dbase
III/IV or Excel utility. Export the pegboard database file(s) to the computer
running PGP and build the pegboard database file(s) on board the PGP
computer.

34

9AKK101130D1382

Configure audible alarm database.


Determine which kind of audibles and how many audibles need for alarming
purposes.
Generate audible database(s) on a Personal Computer using the Dbase
III/IV or Excel utility. Export the audible database file(s) to the computer
running PGP and build the audible database file(s) on board the PGP
computer.
If audible are implemented by wave files, provide such files also.
Configure report database.
Determine the number and the structure of reports. The reporting utility of
PGP is based on Excel.
Create the Excel files (one for each report). An Excel file may contain
multiple sheets and/or multiple pages.
Generate report database(s) on a Personal Computer using the Dbase III/IV
or Excel utility. Export the report database file(s) to the computer running
PGP and build the report database file(s) on board the PGP computer.
Configure the security database.
Determine which operators are allowed to perform which functions and
assign password and validity masks to each unique set of functions.
Generate security database(s) on a Personal Computer using the Dbase
III/IV or Excel utility. Export the security database file(s) to the computer
running PGP and build the security database file(s) on board the PGP
computer.
Configure the node database.
In a multi-master PGP configuration, determine the nodes exchanging data
(alarm acknowledges, tag values, operator actions, configurations, etc.).

9AKK101130D1382

35

Generate node database(s) on a Personal Computer using the Dbase III/IV


or Excel utility. Export the node database file(s) to the computer running
PGP and build the node database file(s) on board the PGP computer.
Configure application alarm messages.
Create and/or update alarm message definition file BALM2DECK.
Please note that this file should be modified to translate messages into
foreign languages. Refer to BLANGDECK file for the text translation.
Changing the structure of existing messages may result in data presentation
problems.
Configure alarm groups.
Define the tree structure of alarm groups.
Generate alarm group database(s) on a Personal Computer using the
Dbase III/IV or Excel utility. Export the alarm group database file(s) to the
computer running PGP and build the alarm group database file(s) on board
the PGP computer.
Configure tag color attributes.
Determine which colors must be assigned to tag statuses and/or blink
override on displays. The configuration can be different for both analog and
digital tags.
Create and/or update and build color override definition file BATT2DECK.
Define the colors for alarm messages in the BATTCOLORS file located in
the CONFIG folder.
Configure the displays.
Mimic displays can be configured using the built in PGP Display Builder.
Mimic displays can also be converted processing SODG displays generated
by the Bailey Engineering Work Station for Harmony systems. The compiled
DT files are required for conversion.

36

9AKK101130D1382

System Configuration
This section defines configuration parameters and discusses things to
consider in determining appropriate values. Configuration parameters are
defined into the Windows Registry.
For a complete list of PGP registry read the manual 9AKK101130D8771PGP Registry Settings.
Creating or modifying these parameters is the first step in configuring PGP.
Values of these symbols will be used to size global commons, data files, to
select options and roughly customize the PGP application.
PGP installation sets a default value for each configuration parameter in
order to allow correct operation without any change.
The parameters are located under the:
Hkey_Local_Machine\Software\ABB\Power Generation Portal
registry key of the Windows Registry.
PGP supplies a utility, named SysSetup, which allows viewing and
modifying the configuration parameters. The following section describes the
SysSetup utility.

System Configuration Interface


Running SysSetup
Select the Programs menu from the Start button. Then, select the ABB
Industrial IT then Power Generation Portal item and finally the System
Setup process.
The process displays the configuration builders.
The main dialog window of the process displays five button on the left side
and the process welcome page on the right side.
The SysSetup process only interfaces the PGP registry set.

9AKK101130D1382

37

When selecting the Registry button, the process dialog window changes.
The tree of registry folders is displayed on the left side of the dialog window.
On the right side of the dialog window the registry items are listed by
selecting the registry folder.
The dialog window of the process is shown below.

Figure 1. System Setup Interface


A copy of the registry values is kept within a disk file. The administrator may
align registry values from the file or align files from the registry values.

38

9AKK101130D1382

On top of the list of registries, the alignment of the registry values is


displayed.
Changing Registry Values
The customer is only allowed to change the value of registry keys. Select
the registry folder and then the registry key to be changed. The selection of
the system size folder and the maximum number of alarm comment key is
shown, as example, in Figure 2.
Double-click the selected registry key, or select the property item in the view
menu. The dialog window to change the value is displayed as shown in
Figure 3.
Two kinds of registry values are defined within the PGP registry folders:

String.

Integer or real values.

Both types have a name, a description, a value and can also have
comments.

9AKK101130D1382

39

A integer or real format registry value may have reference values such as
the minimum and maximum allowed values and the default value. These
values together with the notes help in changing the current value.

Figure 2. Registry Folder and Registry Value Selection

40

9AKK101130D1382

Figure 3. Change Registry Value


Press the Cancel button to exit without any change or press the OK button
to set the change and exit the window.

9AKK101130D1382

41

System Configuration Parameters


System Sizes
For details on size parameters please refere to the 9AKK101130D8771PGP Registry Settings manual.
Changing the system size parameters requires you to execute a build all
phase to re-size data files based on the new size(s).
Changing size parameters could affect performance and operation of the
PGP application.

System Options
This section defines a set of symbols, called System Options, that allow
customization of some running features of PGP.
The System Option registry set is read each time PGP starts up. After some
options have been changed, the shutdown and start-up of PGP must be
performed in order for changes to be applied.
Changing System Options could affect performance and operation of the
PGP application
For details on size parameters please refere to the 9AKK101130D8771PGP Registry Settings manual.

Configuration Procedure
Introduction
A set of configuration operations customizes PGP for the operational
conditions. They allow PGP to meet specific application requirements, and
to carry out monitoring and control on the specific process.
The number of configuration operations depends on the kind, the size and
complexity of the PGP application.
They range from a simple tag database configuration to a full tag, Trend
Group and calculation configuration.

42

9AKK101130D1382

It is out of the scope of this manual to list all combinations of configuration


operations: such a list could not be exhaustive.
Basically, the configuration procedure is the process of transferring
information from external files to the internal PGP databases. These
external files, called definition files, are variously structured: there are ASCII,
Dbase or Excel files.
The configuration operations are generically called building. Builders are the
processes involved in configuration.
In the following sections the general procedure to execute a configuration
operation is explained. It will be applied every time configurations must be
performed.

Calling the Builders


Builders are off-line configuration processes and cannot be reached via the
on-line PGP menus. They can be reached via the Start menu of the
computer where PGP has been installed.
In order to run the builder processes, do the following
Select Start > Programs item > ABB Industrial IT >Power
Generation Portal, and then select System Setup.
The process displays the configuration builders.

9AKK101130D1382

43

The main dialog window of the process deploys five buttons on the left side,
and the process welcome page on the right side.

Figure 4. PGP Setup Window


When the Build Database button is selected the process dialog window
changes. On the left side, the builder window shows the icons of all the
available builder processors.
Within the list, the user can choose either the Build All icon or the icon
representing the builder of a defined database. Once the selection has been
performed, both a set of action buttons and a set of build options are
displayed on the right side of the window.

44

9AKK101130D1382

When the Export button is selected the main process dialog window
changes once again, a window similar to the builder one is displayed on the
left side.
The icons of all the available builder processors are shown, but the Build All
icon is replaced by the Unbuild All icon.
Once the selection has been performed, both a set of action buttons and a
set of build options are displayed on the right side of the window.

9AKK101130D1382

45

The figure below shows the scheme of the builder window when the
Unbuild All icon is selected.

Figure 5. Unbuild Data Base - Offline Database Builder Window

The Export button will be operational only if the selected builder has a
corresponding process for downloading the PGP database.
In the following section is a description of the configuration procedure. It
does not refer to specific builders. It is a general description. The input file to
a builder is generically named definition file.

46

9AKK101130D1382

Building Procedure
Each configuration activity typically involves a single definition file or a few
definition files. For example, changes in the tag database involve the tag
database definition file if all tags are kept in a single file, or the set of tag
database definition files if multiple files are used.
In this section, the most frequent usage of builder environment is described.
First Step
The first step upon entering the builder environment is the identification of
the builder. The builder identification is mandatory both for editing and
building (importing or exporting) in order to point to the right set of definition
files.
Second Step
Editing the definition file(s) is the second step. Changing the existing
definition file(s) or creating new definition file(s) take place at this stage.
Depending on the type of definition file submitted for editing, Excel or
Notepad are invoked.

Of course, Excel will only be successfully invoked if it is installed on the


computer.

Rules for editing definition files can be found in Section 2, Database


Configuration and Section 3, System Configuration.
Third Step
Building the definition file(s) is the third step. After editing, the building phase
converts the information of a definition file to the PGP internal databases.
A building phase must always follow an editing phase, otherwise PGP
internal databases will not be updated. The Import button allows the
building operation.
(See the Third Step on page 47).
Errors during the building phase may require editing and re-building
definition.

9AKK101130D1382

47

Builder Window
The following sections describe the elements of the builder window.

Builder List
The builder list section lists all the available builders. Each builder is
designed to process an XML definition file. A definition file defines all the
information to transfer in the internal PGP database at build time.
The following information is a complete list of the database builders with a
brief description. Refer to Section 2, Database Configuration and Section 3,
System Configuration for a detailed description of each definition file.
Direct Access File System (DAFS) builder
The DAFS builder creates the PGP file system and common area. It is the
key builder since the whole internal PGP database is created on the basis of
the information it processes.
The builder processes file definitions. All definitions are in terms of:

Symbolic file name.

File name.

Number of records.

Size of record.

The file related to this builder is named BFILDECK.XML.


Application specific files may be generated by including their definitions in
the BFIL2DECK.XML file. This file is automatically appended to BFILDECK
file at build time.
The file BFIL2DECK.XML must be located in the CONFIG\DECK folder.
The file BFIL2DECK exists only if at least a specific application file has been
defined.

48

9AKK101130D1382

Error Message builder


The Error Message builder processes the list of the error messages PGP
may output in the event of a system error.
The file related to this builder is BEMFDECK.XML.
Additional error messages for application tasks may be included in the
BEMF2DECK.XML file. This file is automatically appended to BEMFDECK
file at build time.
The file BEMF2DECK.XML must be located in the \CONFIG\DECK folder.
Field Association Cross-Reference builder
The Field Association Cross-Reference builder defines the rules to process
fields of tag database, calculation database, Trend Group database, etc.
The definitions concern:

Tag type switch,

Basic reject rules,

Analog tag database fields,

Digital tag database fields,

Calculation database fields,

Trend Group database fields,

Logic state descriptor database fields,

Engineering unit database fields,

Alarm comment database fields,

Text selector database fields,

Pegboard database fields,

Audible database fields,

Report database fields,

Security database fields,

9AKK101130D1382

49

Node database fields,

Menu and Tool-bar database fields

Alarm Grouping database fields

and may include:

Site specific reject rules and fields customizations.

The file related to this builder is DBXRFDECK.XML.


Changes may be included in the DBXRF2DECK.XML file. This file is
automatically appended to DBXRFDECK file at build time.
The file DBXRF2DECK.XML must be located in the \CONFIG\DECK folder.
Process Scheduling builder
The Process Scheduling builder defines the table of processes periodically
scheduled and the process rescheduling time.
The Process Scheduling builder accesses to a file named BTIMDECK.XML.
Scheduling for application tasks may be generated including their definitions
in the BTIM2DECK.XML file. This file is automatically appended to
BTIMDECK file at build time.
The file BTIM2DECK.XML must be located in the \CONFIG\DECK folder.
The file BTIM2DECK exists only if at least an application task has been
defined for rescheduling.
Daylight Saving Time builder
The Daylight Saving Time builder defines the beginning and ending date
and time of the daylight saving time period for nearly years.
The file related to this builder is BDSTDECK.XML.
Additional years or changes to the default years may be included in the
BDST2DECK.XML file. This file is automatically appended to BDSTDECK
file at build time.
The file BDST2DECK.XML must be located in the \CONFIG\DECK folder

50

9AKK101130D1382

The default BDSTDECK.XML file distributed with the PGP setup is


configured for the European DayLight Saving Time rules.

Menu and Tool-bar builder


The Menu and Tool-bar builder defines the structure of menus and icons in
the global function area.
Database builder processes the fields of each item to be configured in the
PGP according to the definitions of the cross-reference, the Menu and Toolbar . Each item is identified by a name.
The file related to this builder is *.DBF or *.XLS (e.g. MENU.DBF).
The location of tag definition file is \CONFIG\MENU.
Alternate Language builder
The default PGP language is English. An alternate language may be defined
by setting the dictionary in the Alternate Language definition file.
The language dictionary is defined into the BLANGDECK.XML file.
Translation for the alternate language may be included in the
BLANG2DECK.XML file. This file is automatically appended to
BLANGDECK file at build time.
The file BLANG2DECK.XML must be located in the \CONFIG\DECK folder.
Logic State Descriptor Database builder
The Logic State Descriptor Database builder defines a table containing the
status to represent digital variables. The builder establishes a
correspondence between a numeric code and a status descriptor.
The definition file for logic state descriptors is not used if texts for logic state
descriptions of digital tags are defined in the tag database itself.
The file related to this builder function is *.CF (e.g. LSDSCP.CF). A DBF or
XLS file may also be used. The location of LSD definition file is
\CONFIG\LSD.

9AKK101130D1382

51

Engineering Unit Descriptor Database builder


The Engineering Unit (E.U.) Descriptor Database builder defines a table
containing the engineering units to qualify analog tag values.
The builder establishes a correspondence between a numeric code and an
engineering unit descriptor. The codes may be used in the tag database to
define the engineering unit of each analog tag.
The definition file for engineering units is not used if E.U. descriptions for
analog tags are defined in the tag database itself.
The file related to this builder is *.CF (e.g. EUDSCP.CF). A DBF or XLS file
may also be used.
The location of EU definition file is \CONFIG\EU.
Tag Database builder
The Tag Database builder processes the fields of each tag to be configured
in the PGP according to the definitions of the cross-reference. Each tag is
identified by a tag name.
The file related to this builder is *.DBF or XLS (e.g. TAGS.DBF).
The location of tag definition file is \CONFIG\TAG.
Calculation Database builder
The Calculation Database builder defines the execution criteria and the
algorithm for each calculation block to be executed.
The file related to this builder is *.DBF or XLS (e.g. CALC.DBF).
The location of calculations definition file is \CONFIG\CALC.
Each calculation definition refers to an ASCII file where the calculation
algorithm is defined. That ASCII file is typically a TXT file.

52

9AKK101130D1382

Trend Group Database builder


The Trend Group Database builder defines the archiving criteria, the
archiving timing and the tag list for each realtime, historic, post trip and time
function group to be configured.
The file related to this builder is *.DBF or *.XLS (e.g. GROUPS.DBF).
The location of Trend Group definition file is \CONFIG\GROUP.
Alarm Comment Database builder
The Alarm Comment Database builder defines a table containing the alarm
comments to be output when an alarm condition related to a tag arises.
The builder establishes a correspondence between a numeric code and an
alarm comment string. The codes may be used in the tag database to define
the alarm comments related to the alarm conditions of each tag.
The file related to this builder is *.DBF or *.XLS (e.g. ALRMCMNT.DBF).
The location of alarm comment definition file is \CONFIG\ALM.
Text Selector Database builder
The Text Selector Database builder defines a table containing the text
selectors.
The file related to this builder is *.DBF or *.XLS (e.g. TEXTSEL.DBF).
The location of text selector definition file is \CONFIG\TEXT.
Pegboard builder
Pegboards are control displays where all elements are pop-ups (e.g. RCMs,
Stations, RMSCs, etc.) used in command operations. Each pegboard may
have up to 32 pop-ups.
The Pegboard builder defines the structure of such displays. The position
and type of each pop-up and the associated tag is defined.
The file related to this builder is *.DBF or *.XLS (e.g. PEGBOARD).

9AKK101130D1382

53

The location of pegboard definition file is \CONFIG\PEGBOARD.


Audible Alarm builder
The Audible Alarm builder processes the definition of the audible PGP plays
when an alarm arises.
The file related to this builder is *.DBF or *.XLS (e.g. AUDIBLE.DBF). The
location of audible definition file is \CONFIG\SOUND.
If wave files are used, they have also to be located in the \CONFIG\SOUND
folder.
Report builder
Reports are based on Excel files. The Report builder defines a link among
each report, the Excel file and the scheduling criteria.
The file related to this builder is *.DBF or *.XLS (e.g. REPORT.DBF). The
location of report definition file is \CONFIG\REPORTS.
Excel files have also to be located within the \CONFIG\REPORTS folder.
Security builder
The Security builder defines user names, passwords and access rights of
PGP users.
The file related to this builder is *.DBF or *.XLS (e.g. USER.DBF).
The location of security definition file is \CONFIG\USERS.
Node builder
The Node builder defines the structure of the nodes in a multi-master PGP
architecture.
The file related to this builder is *.DBF or *.XLS (e.g. NODE.DBF).
The location of node definition file is \CONFIG\NODE.

54

9AKK101130D1382

Alarm Message builder


The Alarm Message builder processes the list of the alarm, communication,
inquiry messages foreseen in the PGP.
The file related to this builder is BALMDECK.XML.
Additional alarm messages for application tasks may be included in the
BALM2DECK.XML file. This file is automatically appended to BALMDECK
file at build time.
The file BALM2DECK.XML must be located in the \CONFIG\DECK folder.
Alarm Group builder
The Alarm Group builder defines the alarm grouping. PGP has a default
configuration consisting of 16 main alarm groups and 16 sub-groups
associated to each main group.
The file related to this builder is *.DBF or *.XLS (e.g. ALRMGRP.DBF).
The location of node definition file is \CONFIG\ALMGR.
Color/Blink Override Builder
The Color/Blink Override builder defines the background and foreground
colors and the 2-characters suffix used to present the quality of tags. Color
and blink override is associated with an alarm priority.
The file related to this builder is BATTDECK.XML.
Changes may be included in the BATT2DECK.XML file. This file is
automatically appended to BATTDECK file at build time.
The file BATT2DECK.XML must be located in the CONFIG/DECK folder.
Colors can be redefined in the BATTCOLORS file located in the
CONFIG\DECK folder.

Builder Action Buttons


The files related to the builders mentioned in the previous section may be
modified to accomplish the different user needs or to meet application
requirements.

9AKK101130D1382

55

Classified by file extension, there are four kinds of files:

Extension XML files: they are ASCII files and can be changed by using
the Wordpad editor,

Extension DBF files: they are Database files and can be modified by
using DBase IV or Excel,

Extension XLS files: they are Database files and can be modified by
using Excel,

Extension CF files: they are ASCII files in a Bailey format and can be
modified by using the Notepad editor.

All files may be opened on the same computer running PGP, the only
requirement is the availability of standard editors: Notepad, Excel, etc. Files
can also be exported to other computers for modifications and then imported
for processing (building).
Tag database, engineering unit, logic state descriptor, alarm comment and
text selector files may be produced and updated by using the Bailey SODG
utility or the ABB Symphony Composer utility and then copied to the PGP
computer.
The following description only presents the on-board editing.

56

9AKK101130D1382

The figure below shows the builder window after a builder has been
selected: in the example the tag database builder is shown.

Figure 6. Builders Builder Selection


In the following description the functions related to the action buttons are
described.
Import button
Through the Import button, different actions are allowed to be performed
according to the choice between the selection of the Build All icon and the
selection of a specific builder icon.

9AKK101130D1382

57

When a specific builder icon has been selected, the import function enables
the user to process a definition file after an editing phase.
When modifications have been done on a definition file, the operator must
submit the file to the proper builder in order to transfer modifications to the
internal PGP database, and to make modifications operational.
By clicking the Import button, definition files related to the selected
(highlighted on blue) builder are used for building.

Figure 7. Builders - Import Window


Figure 7 shows the window opened after the Import button has been
pressed. This is the standard dialog window used by Windows programs to
access an existing file. Therefore, all usual features are available to
navigate inside the folder.
The default folder is \CONFIG. Depending on the selected builder a
corresponding \CONFIG sub-folder is chosen and displayed in the Look-in
field.
By clicking the Import button, the building phase can begin.
If the definition file (DECK files only) includes the file initialization
specification, the user is requested to confirm file initialization. A dialog

58

9AKK101130D1382

window is opened. The OK button confirm the file initialization. The Cancel
button starts to process without performing any file initialization.
The figure below shows an example of file initialization window displayed
when the alarm group builder runs.

Figure 8. Builders File Initialization Window


Initialization of DBF or XLS files may be performed checking the Initialize
option (see Initialize Option).
The builder outputs an echo of definition file and building messages on a
dedicated window. Figure 9 shows an example of such a window used by
the Alarm Group builder to output messages.
The echo area echoes the definition file (ListOfAlarmGroups.DBF in the
example) the builder is processing. The echo may be scrolled up and down
if it does not fit the available window space.
Echoing is normally disabled (see Echo Option).
The message area displays the output messages of the builder. If the area
contains several messages a scroll bar allows you to scroll in order to view
them.
The Abort button of this window allows you to quit the builder without
completing the operation. It may be used to quit time consuming build

9AKK101130D1382

59

operations when the definition file must be changed. The build operation is
usually very fast and the Abort button is not used.

Figure 9. Builders Output Message Window


When the Build All icon has been selected, the import function enables the
user to process all the definition files invoking the proper builder.
The complete build runs at least once at system generation time to configure
the PGP internal database for the first time. Some definition files (e.g. the
tag database file) may be empty or defaulted during this phase.
The function can be also be invoked when system sizes or many definition
files change due to additional requirements for the PGP application. In case

60

9AKK101130D1382

of heavy changes it is useful to process all definition files rather than to run
single builders separately.
Basically, the windows used by the build all function are those used by the
build function. Refer to the build section for an explanation of the various
windows.

Figure 10. Builders Data File Initialization Window


Since the build all function re-builds all data files, the operation may take
place if PGP does not run and the user is required to confirm the
initialization.
A dialog window allows you to choose the initialization by pressing the OK
button. Figure 10 shows an example of data file initialization window
displayed when build all function runs.
Abort Button
The Abort button abandons processing without performing any file
initialization and any building. This button does not allow you to close the
builder window.

Builder Options
Before running builders, a set of options may be selected for specific
purposes.

9AKK101130D1382

61

These options are facilities offered to collect information on building


activities, or to change the usual behavior of builders. Depending on the
builder, options may be or may be not pre-selected.
The user may change (select or deselect) each option by clicking the check
box on the left of the option name.

62

9AKK101130D1382

The figure below shows an example of builder window where two options
are selected.

Figure 11. Builders Builder Options


Refer to the following sections for details on each option of the builder
window.
Echo Option
If selected, it allows you to echo building messages to the builder message
window. Otherwise builder does not echo messages.
By default, the echo option is never selected.

9AKK101130D1382

63

Ignore Error Option


If selected, this option prevents builder from signalling each error occurred
during operations and pausing. Error notification requires user
acknowledgment and consequently it stops builder operation.
The option can be useful when user runs a heavy builder operation (typically
a build all operation) so as to avoid continuous interactions. An example is
represented by the building of all data files during the night.
By default, the ignore error option is never selected.
Log File Option
If selected, it allows you to echo building messages to a log file rather than
to the builder message window.
Device, folder and log file name are defined in the log file area of the builder
window.
By default, the log file option is always selected.
The log file option may be used when executing a build all: echoed
messages are numerous and it is suggested to output them on file.
Propagate Option
When selected, this option allows you to transfer build settings from the
current node to all other nodes in a multi-master architecture. That option
allows you to update all nodes in a multi-master network without executing a
build on each node.
The nodes part of the multi-master architecture must be configured by the
Node builder so that PGP can know all the possible destinations.
Use the option carefully in order to prevent an excessive load in the network.
Pre-PostApp Option
When selected, this option allows you to execute application programs
before and/or after a build.

64

9AKK101130D1382

A dialog window allows you to type the path to the application(s).

Figure 12. Builders Pre-PostApp Option


Initialize Option
When selected, this option forces the builder to initialize the PGP internal
database before processing the definition file. The Initialization option does
not require the presence of the initialization card when a deck definition file
is submitted.
By default, the initialize option is not selected.
When the option is selected, the user is inquired before initialization
proceed.
Add Option
When selected, this option forces the builder to add in the PGP internal
database only the items which cant be found (new items). Existing items are
left unchanged and a warning message is output unless the ignore error
options is selected.
For example, if the tag database builder has been selected, the add option
forces builder to add all tags which are not found in the PGP internal
database.
By default, the add option is never selected. That means items are added or
replaced into the PGP database.

9AKK101130D1382

65

Replace Option
This option, when it is selected, forces the builder to replace in the PGP
internal database the items found in the submitted definition file. The notexisting items are added in the PGP internal database.
By default the replace option is already selected. It means that items are
added or replaced in the PGP database.
Delete Option
When selected, this option, reverses the builder operation in order to delete
from the PGP internal database the items found in the submitted definition
file.
For example, if the tag database builder has been selected, the delete
option forces the builder to delete from PGP tag database all the tags found
in the submitted tag definition DBF file.
By default, the delete option is not selected. It means that tags are added or
replaced in the PGP database.
Log File
When the log file option is selected, a log file specification may be entered in
the field of this area. Disk drive, folder path and file name identify the file
specification.
The default file name is BUILD.LOG and will be allocated in the \LOGS
folder.

Export Window
The following sections describe the structure of the elements the export
window.
See the previous section Builder List for further details on the builder
description.

66

9AKK101130D1382

Export Action Buttons


Export button
During the normal operation operators or maintenance people can modify
the configuration by adding, deleting or changing some database entities
(e.g. tags, Trend Groups, and calculations) using on-line builders.
The Export function allows you to download the current configuration on a
target definition file to include all the on-line changes. The function allows
you to keep a definition file consistent with the on-line configuration, and
ready to be built up later on.
The Export function only applies to the following databases:

Menu and Tool-bar database.

Logic State Descriptor database,

Engineering Unit database,

Tag database,

Calculation database,

Trend Group database,

Alarm comment database,

Text selector database,

Pegboard database.

Audible database,

Report database,

Security database,

Node database,

Alarm Grouping database.

They correspond to the definition files having extension DBF or XLS.


The Figure 13 shows the window opened after the Export button has been
pressed. This is a standard dialog window used by Windows programs to

9AKK101130D1382

67

interface an existing file. Therefore, all usual features are available to


navigate inside the folder.
The default folder is \CONFIG. Depending on the selected builder a
corresponding \CONFIG sub-folder is chosen and displayed in the Look-in
field.

Figure 13. Builders - Export Window


If an existing target file is selected, the un-build function downloads all the
items (unless a selection is required: see PGP) and only the fields
embedded within the target file are involved. If a new target file is typed, the
un-build function downloads all the fields of the PGP internal database.
In the example figure the exported items are tags.
The Cancel button allows you to close the export window and to quit the
export environment. The exit icon at the top right of the builder window does
the same operation.
Abort Button
The Abort button abandons processing without performing any export file.
This button does not allow you to close the export window.

68

9AKK101130D1382

Select Option
When selected, this option allows you to define selection criteria during the
export procedure.
Criteria allows you to set a modification time interval within which it is
possible to select the items going to be processed. The initial and the final
date and time can be defined.
Further, a SQL like specification allows you to filter items satisfying a
selection criteria. Database field names must be typed in uppercase. For
example, the select condition TAGTYPE = CALCANG allows you to refer
only analog calculated tags.

9AKK101130D1382

69

70

9AKK101130D1382

Section 2 Database Configuration


Introduction
In the following sections, one for each major subsystem, the fields of various
databases are described. Fields are identified by name.
All tables in the following sections are structured as shown in the table
below.
Table 3. 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 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.

9AKK101130D1382

69

Table 3. Database structure.


Item
Default

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

Each field has a format and a width defined. Most of them have a range of
legal values and a default value defined. Further, sizing parameters may be
defined.
In the on-line configuration most of boolean fields are set using the check
mark. A check mark means Y(es), nothing (empty cell) means N(o).
The tables in the following sections always refer to the database
configuration, and boolean fields have values Y(es) or N(o).

70

9AKK101130D1382

Tag Database Subsystem


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:
Analog tags
The current value of analog tags is maintained in the realtime database as
either a 32-bit floating point number or a 32-bit integer (I*4) depending on
the internal representation format.
Also, a 32-bit status indicator is maintained in the realtime database. It flags
alarm and quality conditions of each tag.
Digital tags
The current value of digital tags is maintained in the realtime database as up
to 16 bits of status. Also, a 16-bit status indicator is maintained in the
realtime database. It flags alarm and quality conditions of each tag.
Independently of the source, a tag will always be defined with certain basic
information. For example, it will have a name, a description and alarm
processing options defined. Other information is defined depending on the
kind of tag. Other information may be defined or omitted as desired.
Both tag types may be acquired from the field or generated by calculation
packages, user programs or remote nodes.
In the following sections a single database will always be referred. In
general, it must be intended as a collection of multiple database files.

Tag Database
The tag database consists of one or more files generated on a Personal
Computer using standard packages like DBase III/IV or EXCEL, the SLDG

9AKK101130D1382

71

package (component of the Bailey Engineering Work Stations) or the ABB


Symphony Composer. Then, it must be copied to the computer running the
PGP application (if it is a different one) for final download.
Tag database downloading is performed by submitting the database file(s)
to the database builder. During this phase, the field contents of the input
file(s) will be used to compile PGP 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 or Excel format) containing all items as they are
currently defined in the PGP internal database.
If a target database does not exist, the exporter creates it using the whole
PGP database structure (i.e. all fields are included).
Alternatively, a target database file may be specified as template. In this
case, the exporter updates the target database file handling only the fields
specified within it.
The target database file may have just a single tag, or may be a full or partial
database file. It must contain all (and only) fields to be exported.
Although many fields are part of the whole database, only a limited set of
them is mandatory. All others are optional and, if omitted, a proper default
value provided by builder will be assigned.
Those fields that do not apply to a given type of tag (e.g. the engineering
unit does not apply to digital tags) will be ignored without any error reporting.
The structure of a database file (i.e. the definition or the order of optional
fields) may change according to user preferences, except for field names. A
database file will include, at least, all mandatory fields. Other possible fields
(i.e. site-specific additional descriptive text), although not interfering with
database building procedures, are out of the scope of the manual, and are
not described or considered here.
Several fields are common to both analog and digital tags. The following
description is structured in a common information section (that applies to all
tags) and two specific information sections (that applies only to analog or
digital tags).

72

9AKK101130D1382

All fields are grouped into three main sections:

Generic Tag Definition

Digital Tag Definition

Analog Tag Definition.

Fields are classed into sub-sections for an easy use and reference. The
three main sections contain the same number of sub-sections to allow easy
cross-reference. If a section does not define any field for the specific main
section, it will be left empty.

Generic Tag Definition


This section describes all common fields used to configure both analog and
digital tags.

General Parameters
The fields in Table 4 and Table 5 define the name and other additional
parameters used to identify the tag, and to give an explicit reference to the
process.
They define three key characteristics of a tag: the index and the name to
uniquely identify the tag, and the type to characterize it. Tag name and tag
type are mandatory fields.

9AKK101130D1382

73

Table 4. Generic Tag - General Parameters.


Format
Width
Opt/Mnd

Name
INDEX

Range
Default
Parameter(s)

Description

Integer

Tag index.

{0, 1...128000}

This field identifies the tag by number. It


must be unique for each tag within
database. If omitted or zero (blank), the
first vacant index will be allocated

Optional

[mxindx]

TAGINDEX is an alias name for this field.


NAME

Character

Tag name.

<string>

20

This field identifies the tag by name. It


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

<blank>

Mandatory

[sznam]

TAGNAME is an alias name for this field.


UID

<string>

Character

Tag unique identification.

36

This field provides a unique identification <blank>


in the PGP application history. It is
None
assigned at import time. Export database
to update the field in the DBF file.

Mandatory

TAGUID is an alias name for this field.


See Note 1 at the end of the table.
DESC

Character

Tag description.

<string>

64

This field is a character string used to


describe the tag on the different outputs
(alarm messages, reports, summaries,
etc.).

<blank>

Optional

[szdesc]

TAGDESC is an alias name for this field.

74

9AKK101130D1382

Table 4. Generic Tag - General Parameters.


Format
Width
Opt/Mnd

Name
TAGTYPE

Description

Range
Default
Parameter(s)

Character

Tag type code.

UNDEF

This field specifies the type of the tag


according to Appendix A.

[sztype]

Mandatory

TAGTYPE is an alias name for this field.


TAGSRC

CUSTTAGID

PRIMDISP

SEC_LEVEL

Character

Tag source code.

7
Optional

This field specifies the source type of the None


tag according to Appendix A.

Character

Plant tag name.

<string>

32

<blank>

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.

Character

Primary display reference.

<string>

80

<blank>

Optional

Name of a graphic display associated to


the tag. This page can be directly called
from tag presentation displays or from
alarm pages.

Integer

Security level.

{0, 1...16}

0
This field is checked whenever an user
attempts to operate over the tag. Only
None
users whose security level is greater or
equal to what's hereby defined are
enabled to access the tag for changes or
control.

Optional

9AKK101130D1382

<blank>

None

None

75

Table 4. Generic Tag - General Parameters.


Format
Width
Opt/Mnd

Name
SEC_GROUP

Range
Default
Parameter(s)
{0, 1...32}

Integer

Security group.

0
This field is checked whenever an user
attempts to operate over the tag. Only
None
users whose security group mask
includes what's hereby defined are
enabled to access the tag for changes or
control.

Optional

EXTDESC

Description

Character

Extended tag description.

<string>

80

This field is a character string used to


completely define the tag or to enhance
the tag description.

<blank>

Optional

[szedsc]

Note 1:
The TAGUID code is internally generated the first time a tag is added to the
PGP database (i.e. each time a tag database build follows a database
initialization).
Add the TAGUID field to the tag database and leave it initially blank when
the tag database file is filled in.
Following a tag database build, an un-build operation must be executed in
order the TAGUID field is filled. If the TAGUID is left blank, later on the tag
cannot be replaced within the PGP database, an error message is issued for
duplicate tag since a new TAGUID is generated. A PGP database
initialization only allows replacing (actually adding) the tag.
Once assigned, the TAGUID may be kept unchanged for the whole history
of a tag. The tag name or the tag index may change, the TAGUID is not
affected. That allows you to keep track of a tag during the history of the
application (for example within the trend historical groups).

76

9AKK101130D1382

As a general rule, perform a database export immediately after a build


operation in order to fill in a non-assigned TAGUID field within a tag
database file.
The parameter listed in the following table is not included in the General Tab
of the on-line configuration.
Table 5. Generic Tag - General Parameters (continued)
Format
Width
Opt/Mnd

Name
PLANTUNIT

Range
Default
Parameter(s)

Description

Integer

Plant unit.

{0, 1...12}

This field identifies the plant unit


(applicable to multi-unit plants only) and
allows grouping the tags per unit group.

Optional

None

Process Parameters
The fields of Table 6 and Table 7 define the basic information for the tag
configuration: initial condition (setting at start-up time), alarm processing,
playback saving, application program activation, output transferring, value
exporting, triggering (calculation, report, totalization), process control inhibit.
All fields are optional.

9AKK101130D1382

77

Table 6. Generic Tag - Process Parameters.


Format
Width
Opt/Mnd

Name
AL_REM

OFFALINI

{Y, N}

Character

Remote alarm processing flag.

Y
If set, the alarm processing for this tag
will be performed remotely (PCU level or None
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.

Optional

OFFSCINI

Range
Default
Parameter(s)

Description

{Y, N}

Character

Initially off scan flag.

1
Optional

If set, the tag is put off scan at PGP start- N


up time.
None
The operator must manually put on scan
the tag.

Character

Initially off alarm check flag.

{Y, N}

If set, the tag is put off alarm check at


PGP start-up time.

Optional

None

The operator must manually put on alarm


check the tag.
EXP_VAL

PLAYBACK

Character

Export to ODBC flag.

{Y, N}

If set, tag values are exported via ODBC


interface.

Optional
Character

Playback archive flag.

{Y, N}

If set, the tag will be recorded on the


playback archive.

Optional

78

None

None

9AKK101130D1382

Table 6. Generic Tag - Process Parameters.


Format
Width
Opt/Mnd

Name
AAP_NUM

Description

Range
Default
Parameter(s)
{ 0, 1...63}

Integer

Index to an application action program.

0
If greater than 0, this field defines a link
which will cause an user defined
None
application program to be activated upon
status changes for this tag.

Optional

The name of the application program


must be ALACxx, where xx is the number
corresponding to the value of the field.
TRIG_CALC

{0, 1...999}

Integer

Triggered calculation block number.

0
If greater than 0, it identifies the
calculation block to be triggered when the [mxxcal]
tag goes into alarm or returns to normal.

Optional

Triggering takes place on both state


transitions.
REP_NUM

{0,1...50}

Integer

Triggered report number.

If greater than 0, it identifies the report to 0


be triggered when the tag goes into alarm [nmrpts]
or returns to normal.

Optional

Triggering takes place on both state


transitions.
DATA_PROC

Application component name.

64

The field defines the name of a program <blank>


used to perform some specific handling
[szdesc]
(e.g. raw data conversion) on the tag
values. See Appendix A for details about
the DataProcessor xml file.

Optional

FACEPLATE

<string>

Character

Pop-up handling program name.

80

The field applies to control tags only and <blank>


defines the name of the program used to [szedsc]
manage control commands.

Optional

9AKK101130D1382

<string>

Character

79

Table 6. Generic Tag - Process Parameters.


Format
Width
Opt/Mnd

Name
CONFIRMCM

CTRLINHTAG

Description

Range
Default
Parameter(s)

Character

Confirm command enable flag.

1
Optional

If set, will be requested the confimation to N


execute a control command on the tag.
None

Char

Control inhibit tag name.

<string>

20

Tag name of control inhibit tag. It must


refer to a digital tag.

<blank>

Optional

{Y,N}

[sznam]

Control inhibit tag is a digital tag used to


disable actions upon analog (RMSC) and
digital (RCM, DD, MSDD) control tags.
OTXNAME

Character

Output transfer tag name.

<string>

56

Name of a output tag to be linked to the


current tag for outputting to loop.

<blank>

Optional

The output tag must exist within the tag


database.
OTXENB

Character

Output transfer enable flag.

If set, output transfer to the tag defined in N


the OTXNAME field is enabled.
None

Optional

80

{Y,N}

9AKK101130D1382

Table 6. Generic Tag - Process Parameters.


Format
Width
Opt/Mnd

Name
MAINTTRIG

Range
Default
Parameter(s)

Description

{0, 1...100}

Integer

Maitenance log number.

0
If greater than 0, it identifies the
maintenance log to be triggered when the [n.hrtl]
tag goes into alarm or returns to normal.

Optional

Triggering takes place on both state


transitions.
OPCSRVVIS

Integer

OPC server visibility.

{0, 1, 2}

Defines if the tag will be exported by the


OPC server.

Optional

0 = NO
1 = Read only
2 = R/W

The EXP_VAL field that allows you to specify a relational database (i.e.
Oracle, Access) must be updated with the values of the tag. That requires
the installation of a specific (ODBC Connection Support) optional PGP
license and a relational database package to manage the tag values.
The parameters listed in the following table are not included in the Process
Tab of the on-line configuration.

9AKK101130D1382

81

Table 7. Generic Tag - Process Parameters (cntd.).


Format
Width
Opt/Mnd

Name
ACK_PROG

Range
Default
Parameter(s)

Description

Character

Program activation flag on acknowledge. {Y,N}

If set, the application action program


defined by the AAP_NUM field will be
activated when an alarm acknowledge is
performed.

Optional

N
None

The on-line configuration includes the


field within the Alarm Level Tab for
analog tags and the DI Process Tab for
digital tags.
CTRLCMDTAG

Char

Control command tag name.

<string>

20

Not longer used.

<blank>

Optional
EXPFIL

PLAYBACKLT

[sznam]
{Y, N}

Character

Export to file flag.

1
Optional

If set, tag values are exported to an ASCII N


file.
None
The on-line configuration does not
include the field.

Character

Playback flag for long term archiving.

{Y,N}

If set, reduced size data packets will be


recorded on the playback to save disk
space.

Optional

None

The on-line configuration does not


include the field.

82

9AKK101130D1382

Table 7. Generic Tag - Process Parameters (cntd.).


Format
Width
Opt/Mnd

Name
PLAYBACKSP

Description

Range
Default
Parameter(s)
{Y,N}

Character

Playback specific processing flag.

Y
If set, tag exception reports will be
submitted to specific processing on
None
playback archiving. A specific application
routine must be implemented.

Optional

The on-line configuration does not


include the field.
RTN_PROG

Character
1
Optional

Activate an application action program on {Y,N}


return to normal condition.
N
If set, the application action program
None
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.

TOT_LOG

{0,1...100}

Integer

Totalization log number.

If greater than 0, it identifies the index into 0


the analog or digital totalization log
n.tene
archive at which tag values are
accumulated.

Optional

The on-line configuration includes the


field within the PV General Tab for analog
tags and the DI Process Tab for digital
tags.

Generic Scanner Input Parameters


The fields in Table 8 define the logic address or references used to locate
the source tags acquired from generic (not pre-defined as Symphony)

9AKK101130D1382

83

process interface devices. They are meaningful only for tags acquired from
external (foreign) acquisition devices. In any other case, their contents will
be ignored.
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.
All fields are mandatory if an external acquisition device is used. Otherwise
they must not be defined.
The Generic Scanner parameters replace previous External and Modbus
Acquisition parameters. Their description has been removed from the
configuration manual.
However, those parameters are still supported for compatibility with previous
versions of PGP. Refer to configuration manual of release 1.3 (or previous)
for details.
Table 8. Generic Tag Generic Scanner Input Parameters.
Format
Width
Opt/Mnd

Name
FIELD_AD1

...................
FIELD_AD10

FIELD_TX1

................

84

Integer

Range
Default
Parameter(s)

Description
Field input address 1.

Mandatory

None

................

.................................

Integer

Field input address 10.

............

Mandatory

None

Character

Field input driver text 1.

<string>

80

<blank>

Optional

[mxopcn]

................

..................................

.............

9AKK101130D1382

Table 8. Generic Tag Generic Scanner Input Parameters.


Format
Width
Opt/Mnd

Name
FIELD_TX10

Character

FIELD_DRV

Description
Field input driver text 10.

Range
Default
Parameter(s)
<string>

80

<blank>

Optional

[mxopcn]

Character

Field input driver name.

<string>

20

This name identifies the kind of driver


interfacing PGP to the process for input
data communication.

<blank>

Mandatory

[sznam]

Generic Scanner Output Parameters


The fields in Table 9 define the logic address or references used to locate
the destination tags to generic (not pre-defined as Symphony) process
interface devices. They are meaningful only for tags output to external
(foreign) acquisition devices. In any other case, their contents will be
ignored.
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.
All fields are mandatory if an external output device is used. Otherwise they
must not be defined.

9AKK101130D1382

85

Table 9. Generic Tag Generic Scanner Output Parameters.


Format
Width
Opt/Mnd

Name
OUT1_AD1

Integer

Field output driver 1 address 1.

See the Note 1 at the end of the table.

0
None

Mandatory
.................

................

..................................

OUT1_AD10

Integer

Field output driver 1 address 10.

See the Note 1 at the end of the table.

Mandatory

........
0
None

.................

................

..................................

OUT5_AD10

Integer

Field output driver 5 address 10.

OUT1_TX1

Range
Default
Parameter(s)

Description

........

Mandatory

None

Character

Field output driver 1 text 1.

<string>

64

See the Note 2 at the end of the table.

<blank>

Optional

[szdesc]

..............

................

....................................

............

OUT1_TX10

Character

Field output driver 1 text 10.

<string>

64

See the Note 2 at the end of the table.

<blank>

Optional

[szdesc]

..............

................

....................................

............

OUT5_TX10

Character

Field output driver 5 text 10.

<string>

86

64

<blank>

Optional

[szdesc]

9AKK101130D1382

Table 9. Generic Tag Generic Scanner Output Parameters.


Format
Width
Opt/Mnd

Name
OUT1_DRV

Description

Range
Default
Parameter(s)
<string>

Character

Field output driver name 1.

20

<blank>
This name identifies the kind of driver
interfacing PGP to the process for output [sznam]
communication.

Mandatory

See the Note 3 at the end of the table.


..............

................

....................................

............

OUT5_DRV

Character

Field output driver name 5.

<string>

20

<blank>
This name identifies the kind of driver
interfacing PGP to the process for output [sznam]
communication.

Mandatory

Note 1:
The OUT1_ADn fields replace the OUT_ADn fields. The description of
OUT_ADn has been removed from the configuration manual. However, the
field is still supported for compatibility with previous PGP versions. Refer to
configuration manual of release 4.0 (or previous) for details.
Note 2:
The OUT1_TXn fields replace the OUT_TXn fields. The description of
OUT_TXn has been removed from the configuration manual. However, the
field is still supported for compatibility with previous PGP versions. Refer to
configuration manual of release 4.0 (or previous) for details.
Note 3:
The OUT1_DRV field replaces the OUT_DRV field. The description of
OUT_DRV has been removed from the configuration manual. However, the
field is still supported for compatibility with previous PGP versions. Refer to
configuration manual of release 4.0 (or previous) for details.

9AKK101130D1382

87

Symphony Input Parameters


The fields in Table 10 define the logic address and other additional
parameters used to locate the source of tags coming from Symphony
modules. They are meaningful only for those kind of tags. In any other case,
their contents will be ignored.
The mandatory fields all together uniquely identify the location of the tag in
terms of acquisition sub-system (PCU). They must not be defined if a
generic acquisition device is used (see the previous section).
Table 10. Generic Tag - Symphony Input Parameters.
Format
Width
Opt/Mnd

Name
ICI_NUM

ICI_NDX

Range
Default
Parameter(s)

Description

Integer

ICI Number.

{1...8}

Number of the physical ICI device when


multiple ICIs are connected to PGP.

Optional
Integer

ICI index.

{-1, 0...29999}

This is the reference index in the internal -1


ICI table.
[mxcpts]
If omitted or less than zero, the first
vacant ICI index will be allocated.

Optional

[mxciu] or [mxxciu]

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

88

Integer

Ring number.

{0..63}

Mandatory

None

9AKK101130D1382

Table 10. Generic Tag - Symphony Input Parameters.


Format
Width
Opt/Mnd

Name
PCU

Integer

MODULE

{1...256}
0

Mandatory

None
Module number.

{0...31}

Mandatory

None

Integer

ICISTA_CD

PCU number.

3
Integer

BLOCK

Range
Default
Parameter(s)

Description

Block number.

{0...99999}

Mandatory

None
{X, E, C, D}

Character

ICI action code.

This code specifies the ICI action at start- C


up time. See Appendix A for the meaning None
of supported actions.

Optional

Command Parameters
Fields of this sub-section apply to digital tags only. Refer to the analogue
sub-section of digital tag definition for details.

Alarm Processing Parameters


The fields in Table 11 and Table 12 define additional information for the
alarm processing of the tag.
All fields are optional. Moreover, some of them should be defined to grant an
optimal alarm processing. The alarm group, for example, is a key field. It
allows classing tags into subsets (the alarm groups) for further alarm
displaying and handling

9AKK101130D1382

89

Table 11. Generic Tag - Alarm Processing Parameters.


Format
Width
Opt/Mnd

Name
DS_ALARM

PR_ALARM

Range
Default
Parameter(s)

Description

Character

Display alarm flag.

1
Optional

If set, alarms concerning this tag will be


Y
displayed on alarm display pages (LADs). None

Character

Print alarm flag.

{Y, N}

If set, alarms concerning this tag will be


printed on alarm printer(s).

Optional

{Y, N}

None

See the field ALMPRINTER also.


SV_ALARM

AUD_ALARM

BOT_ALARM

REM_ONACK

Character

Save alarm flag.

{Y, N}

Optional

If set, alarms concerning this tag will be


logged to the Operator Journal.

Character

Audible tone activation flag.

{Y, N}

Optional

If set, the audible tone defined by


AUDINDEX will be activated when an
alarm will occur.

Character

Bottom alarm displaying flag.

{Y, N}

Optional

If set, unacknowledged alarms


concerning this tag will be displayed in
the bottom of screen alarm window.

Character

Remove alarm flag on acknowledgment.

{Y, N}

If set, alarm messages are removed from N


the alarm display page (LAD) when an
None
alarm acknowledgment involving the tag
is performed.

Optional

90

None

None

None

9AKK101130D1382

Table 11. Generic Tag - Alarm Processing Parameters.


Format
Width
Opt/Mnd

Name
INFO_ONACK

DS_RTN

PR_RTN

Range
Default
Parameter(s)

Description

Character

Log information flag on acknowledgment. {Y, N}

1
Optional

If set, an information message is logged


to the Operator Journal when alarm
acknowledgment involving the tag is
performed.

Character

Display flag for return to normal condition. {Y, N}

1
Optional

Y
If set, a RTN message concerning this
tag will be displayed on alarm display
None
pages (LADs). An alarm acknowledge will
then remove the message.

Character

Print flag for return to normal condition.

{Y, N}

If set, RTNs concerning this tag will be


printed.

Optional

N
None

None

See the field ALMPRINTER also.


SV_RTN

Character

Save message flag on return to normal.

{Y, N}

If set, return to normal condition


messages concerning this tag will be
logged to the Operator Journal.

Optional
AUD_RTN

Character
1
Optional

9AKK101130D1382

None

Activate flag for audible tone on return to {Y, N}


normal.
N
If set, the audible tone defined by
None
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.

91

Table 11. Generic Tag - Alarm Processing Parameters.


Format
Width
Opt/Mnd

Name
PR_STCHNG

Range
Default
Parameter(s)

Description

{Y, N}

Character

Print flag for state changes.

N
If set, the changes of state concerning
this tag will be printed on alarm printer(s). None
State changes are intended as
alarms/RTNs of digital tags defined as
events (field EVENTTAG set to Y).

Optional

See the field ALMPRINTER also.


SV_STCHNG

DS_STCHNG

PR_OPACT

{Y, N}

Character

Save flag for state changes.

1
Optional

Y
If set, the changes of state concerning
this tag will be recorded into the Operator None
Journal.

Character

Save flag for display events.

{Y, N}

If set, the changes of state concerning


this tag will be displayed on the alarm
pages

Optional
Character

Print flag for operator action messages.

{Y, N}

If set, on-line database modifications and N


all other operator actions concerning this None
tag will be printed on alarm printer(s).

Optional

None

See the field ALMPRINTER also.


SV_OPACT

PR_INFO

{Y, N}

Character

Save flag for operator action messages.

1
Optional

If set, on-line database modifications and Y


all other operator actions concerning this None
tag will be recorded into the Operator
Journal.

Character

Print flag for information messages.

{Y, N}

If set, information concerning this tag will


be printed.

Optional

None

See the field ALMPRINTER also.

92

9AKK101130D1382

Table 11. Generic Tag - Alarm Processing Parameters.


Format
Width
Opt/Mnd

Name
SV_INFO

EXP_ALA

APPL_ALA

Range
Default
Parameter(s)

Description

Character

Save flag for information messages.

1
Optional

If set, information concerning this tag will Y


be logged to the Operator Journal.
None

Character

Relational database update (alarms) flag. {Y, N}

Optional

If set, alarm messages will be


automatically sent to the external
relational database.

Character

Trigger flag for application program.

{Y, N}

On alarm occurrence, an application


program is triggered for execution.

Optional

{Y, N}

None

None

The on-line configuration does not


include the field.
ALMACKBC

ALMGROUP

Character

Broadcast flag for alarm acknowledge.

{Y, N}

Optional

If set, alarm acknowledgments are


broadcasted to other nodes in the same
multi-master architecture.

Integer

Alarm group number.

{0, 1...272}

0
This field allows you to group all tags
belonging to a given plant area or
[sladnm] or [mxxagp]
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.

Optional

9AKK101130D1382

None

93

Table 11. Generic Tag - Alarm Processing Parameters.


Format
Width
Opt/Mnd

Name
AL_PRI

Range
Default
Parameter(s)

Description

{1 ... 16}

Integer

Alarm priority number.

This is the default priority number and is 1


used when a specific alarm priority is not [mxalpr] or [mxxapr]
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 analogue subsections of analog and digital tag
definitions for a description.

Optional

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. The
BATTDECK system configuration file
defines the default alarm priorities.
ALMINHTAG

AUDINDEX

Alarms inhibit tag.

20
Optional

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

Integer

Audible alarm index.

{0, 1...32}

This field defines the index into audible


alarm database to determine which
audible is to be activated upon alarm
and/or return to normal.

Optional

94

<string>

Char

[mxaud]

9AKK101130D1382

Table 11. Generic Tag - Alarm Processing Parameters.


Format
Width
Opt/Mnd

Name
ALMPRINTER

Range
Default
Parameter(s)

Description

{1...99}

Integer

Alarm printer index.

1
Reference index to the printer where
messages concerning the tag are printed. None
See the fields PR_xxx (e.g. PR_ALARM)
also.

Optional

It is a pointer to a registry defining the


alarm printer. Refer to the system option
configuration for details.
SMSINDEX

Integer
3
Optional

Index for Short Message Send (SMS)


alarm messaging.

0
None

The EXP_ALA field allows specifying and requiring to update an external


relational database (i.e. Oracle, Access). That requires the installation of
a specific optional PGP licensed feature (the ODBC Interface) and a
relational database package to be interfaced.
The acknowledge of alarms can be executed also by using a tag as a
trigger. When the specified tag goes in alarm state, the acknowledge
command will be issue on the specified alarm priority or alarm group
defined into the registry ..APPS\RemoteAck\<TAGNAME>\AlarmPriority
(or ...AlarmGroup); when both parameters are zero, a global
acknowledge will be triggered.
The parameters listed in the following table are not included in the Alarm
Process Tab of the on-line configuration.

9AKK101130D1382

95

Table 12. Generic Tag - Alarm Processing Parameters (cntd.).


Format
Width
Opt/Mnd

Name
ALPRI_RTN

Range
Default
Parameter(s)

Description

Integer

Return to normal priority number.

{0, 1 ... 16}

This is the priority assigned to the tag


when a return to normal condition takes
place after an alarm. If set to 0 then the
default priority is assigned.

Optional

[mxalpr] or [mxxapr]

See the description of the AL_PRI field


for the definition of alarm priorities.
ALPRI_HCF

Integer

Hardware channel failure priority number. {0, 1 ... 16}

0
This is the priority assigned to the tag
when a hardware channel failure takes
[mxalpr] or [mxxapr]
place. If set to 0 then the default priority is
assigned.

Optional

See the description of the AL_PRI field


for the definition of alarm priorities.

Alarm Level Parameters


Fields of this sub-section apply to analog tags only. Refer to the analogue
sub-section of analog tags for details.

Alarm Option Parameters


Fields of this sub-section apply to analog tags only. Refer to the analogue
sub-section of analog tags for details.

Alarm Comment Parameters


The fields in Table 13 allow defining or referencing descriptive texts to be
associated to alarm conditions of the tag. Either a integer format (index) or a
character format (text) can be used.

96

9AKK101130D1382

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 chapter for more information about
the contents of these fields. Refer to the analogue 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).
Table 13. Generic Tag Alarm Comment Parameters.
Format
Width
Opt/Mnd

Name
ALRMCMNT1

ALRMCTXT1

ALRMCMNT2

Integer

{1...100}
0

Optional

[mxalcm]

Character

Return to normal comment text.

<string>

80

<blank>

Optional

[szalcm]

Integer
Optional
Character
80
Optional

9AKK101130D1382

Return to normal comment index.

5
ALRMCTXT2

Range
Default
Parameter(s)

Description

High alarm (for analog tags) or alarm (for {1...100}


digital tags) comment index.
0
[mxalcm]
High alarm (for analog tags) or alarm (for <string>
digital tags) comment text.
<blank>
[szalcm]

97

Table 13. Generic Tag Alarm Comment Parameters.


Format
Width
Opt/Mnd

Name
ALRMCMNT13

ALRMCTXT13

Integer

Range
Default
Parameter(s)

Description

Hardware channel failure comment index. {1...100}

Optional

[mxalcm]

Character

Hardware channel failure comment text.

<string>

80

<blank>

Optional

[szalcm]

Network Parameters
The fields in Table 14 refer to the PGP network communication subsystem.
They are used when multiple PGP 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 Nodes database for
details.

98

9AKK101130D1382

Table 14. Generic Tag Network Parameters.

Name
CNFNODMSK

Format
Width
Opt/Mnd

Sequence {Y, N}

Optional

First bit refers to node 1 in the node


definition, second bit refers to node 2,
and so on.

None

Character

Destination node mask for tag


configurations.

Sequence {Y, N}

Destination node mask for tag


configurations.

Sequence {Y, N}

Destination node mask for tag


configurations.

Sequence {Y, N}

Optional

16*N
The mask applies to nodes from 49 to 64 None

Character

Destination mask for operator actions.

Sequence {Y, N}

16

16*N
Operator actions are routed from the
current node to the nodes set in the
None
destination mask. First bit refers to node
1 in the node definition, second bit refers
to node 2, and so on.

16
Optional
CNFNODMS3

Character
16
Optional

CNFNODMS4

Character
16

DESTNODMSK

Optional

DESTNODMS2

16*N
The mask applies to nodes from 33 to 48. None

Character

Destination mask for operator actions.

16

The mask applies to nodes from 17 to 32. 16*N

Sequence {Y, N}
None

Character

Destination mask for operator actions.

16

The mask applies to nodes from 33 to 48. 16*N

Optional

9AKK101130D1382

16*N

16*N
The mask applies to nodes from 17 to 32. None

Optional
DESTNODMS3

Range
Default
Parameter(s)

Destination node mask for tag


configurations.

Character
16

CNFNODMS2

Description

Sequence {Y, N}
None

99

Table 14. Generic Tag Network Parameters.

Name
DESTNODMS4

Format
Width
Opt/Mnd

Description

Character

Destination mask for operator actions.

16

The mask applies to nodes from 49 to 64. 16*N

Optional
DESTVALMSK

None

16

16*N
Tag values are routed from the current
node to the nodes set in the destination
None
mask. First bit refers to node 1 in the
node definition, second bit refers to node
2, and so on.

Character

Destination node mask for tag values.

16

The mask applies to nodes from 17 to 32. 16*N

Character

Destination node mask for tag value.

16

The mask applies to nodes from 33 to 48. 16*N

SRCNODMS2

Character

Destination node mask for tag value.

16

The mask applies to nodes from 49 to 64. 16*N

Sequence {Y, N}
None

Character

Source node mask for tag values.

Sequence {Y, N}

16

16*N

Optional

First bit refers to node 1 in the node


definition, second bit refers to node 2,
and so on.

Character

Source node mask for tag values.

Sequence {Y, N}

16

The mask applies to nodes from 17 to 32. 16*N

Optional

100

Sequence {Y, N}
None

Optional
SRCNODMSK

Sequence {Y, N}
None

Optional
DESTVALMS4

Sequence {Y, N}

Destination node mask for tag values.

Optional
DESTVALMS3

Sequence {Y, N}

Character
Optional

DESTVALMS2

Range
Default
Parameter(s)

None

None

9AKK101130D1382

Table 14. Generic Tag Network Parameters.


Format
Width
Opt/Mnd

Name
SRCNODMS3

Description

Character

Source node mask for tag values.

16

The mask applies to nodes from 33 to 48. 16*N

Optional
SRCNODMS4

Range
Default
Parameter(s)
Sequence {Y, N}
None

Character

Source node mask for tag values.

16

The mask applies to nodes from 49 to 64 16*N

Optional

Sequence {Y, N}
None

OPC Parameters
OPC (OLE for Process Control) is a standard mechanism based on the
Microsoft OLE/COM technology for communicating to numerous data
sources in order to grant inter-operability between automation/control
application, field systems/devices and business/office applications in the
process control industry.
The PGP OPC Client provides Data Access (in accordance to the 1.0a and
2.03 specifications) and Alarm&Event (in accordance to the 1.02
specification) functionalities and allows simultaneous connections to local
and remote OPC servers.The PGP OPC Server provides Data Access and
Alarm&Event functionalities as well but, as far as the DA specification is
concerned, only the 2.03 is supported..
The fields in Table 15 and Table 12 refer to the PGP OPC subsystem and
can be used to define the database from the OPC point of view. They are
meaningful for OPC tag types only.
OPC tags can be successfully used only if the PGP OPC Support has been
installed and licensed. In such a case, the on-line configuration provides a
Tab for OPC parameters.

9AKK101130D1382

101

Table 15. Generic Tag - OPC Parameters.

Name
OPCPROGID

OPCPROGAE

OPCCMPTR

OPCITEMID

OPCACCPATH

Format
Width
Opt/Mnd

Range
Default
Parameter(s)

Character

Server name.

80
Mandatory

This is the name of the OPC Data Access <blank>


Server.
[mxopcn]

Character

Alarm event server name.

80
Mandatory

This is the name of the OPC Alarm Event <blank>


Access Server.
[mxopcn]

Character

Computer name.

80
Optional

This is the name of the machine hosting <blank>


the OPC Data Access Server and OPC
[mxopcn]
Alarm&Event Server. It may be left
undefined to establish a local connection.

Character

Item identification.

80
Mandatory

<blank>
This is the unique identification of data
item to be accessed in the server specific [mxopci]
address space. The value to be specified
depends on the OPC server.

Character

Access path.

80

This may be additional information to


<blank>
qualify access to data item. The value to [mxopcn]
be specified depends on the OPC server.

Optional

102

Description

<string>

<string>

<string>

<string>

<string>

9AKK101130D1382

Table 15. Generic Tag - OPC Parameters.


Format
Width
Opt/Mnd

Name
OPCREFRESH

Integer

Requested refresh time.

Each OPC server updates data items


based on its own refresh time
capabilities. PGP OPC server updates
data items with the rate specified by
refresh time Table 16.

Optional

Range
Default
Parameter(s)

Description

1
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.
Any other requested refresh rate will be
rounded to the closest higher supported
rate.
OPCREADTYP

Integer

Read type.

See Table 17 for allowed read types.

Optional
OPCEXPCLNT

120
None

Character

Flag to enable commands to OPC client.

{Y,N}

If set, for a control tag, commands are


allowed to the OPC server.

Optional

None

Table 16. Server DA Refresh Rates.


Code

Description

500

500 milliseconds.

1 second.

2 second.

3 seconds.

9AKK101130D1382

103

Table 16. Server DA Refresh Rates.


Code

Description

5 second.

10

10 seconds.

30

30 seconds.

60

60 seconds.

Table 17. Read Types.


Code
100

Description
Synchronous read from DEVICE (the physical device).
The OPC client send a data read request and waiting for response.

110

Synchronous read from CACHE (OPC server memory buffer).


The OPC client send 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.

The parameters listed in the following table are not included in the OPC Tab
of the on-line configuration.

104

9AKK101130D1382

Table 18. Generic Tag - OPC Parameters (cntd.).


Format
Width
Opt/Mnd

Name
OPC_ALA

OPCPROGHS

Range
Default
Parameter(s)

Description

Character

Flag for export alarms to OPC server.

{Y, N}

If set, alarm messages will be


automatically sent to the OPC server.

Optional
Character

Historian server name.

<string>

80

This is the name of the OPC Historian


Access Server.

<blank>

Mandatory

None

[mxopcn]

Totalization Parameters
Fields of this sub-section differ for analog and digital tags. Refer to the
analogue sub-section of analog and digital tags for details.

Device Status Parameters


Fields of this sub-section apply to digital tags only. Refer to the analogue
sub-section of digital tags for details.

Documentation Parameters
The fields in Table 19 allow linking tag conditions and documentation.
Currently, PGP does not manage these fields, but they may be loaded in the
tag database for a future use.

9AKK101130D1382

105

Table 19. Generic Tag - Documentation Parameters.


Format
Width
Opt/Mnd

Name
ALMDHF

Integer
5

Reference to documentation on hardware


channel failure condition.
0
None

Optional
ALMDRN

Integer
5

Reference to documentation on return to


normal condition.

Optional
ALMDHA

Integer
5
Optional

Range
Default
Parameter(s)

Description

0
None

Reference to documentation on alarm


(digital tags) or high alarm (analog tags)
condition.

0
None

Refer to the analogue sub-sections of digital and analog tag definition for
additional fields.

Hardware Description Parameters


The descriptive fields in Table 20 define some additional information about
the source of the tag. They are related to wire cabling within the cabinets. All
fields are optional.
Since they mainly refer to Symphony hardware, field names and
descriptions are addressed to the Symphony nomenclature. In any case,
they may be used in a broad sense where different hardware is used to
interface PGP.
Currently, PGP does not manage these fields, but they may be loaded in the
tag database for a future use.

106

9AKK101130D1382

Table 20. Generic Tag - Hardware Description Parameters.


Format
Width
Opt/Mnd

Name
S_COORD

S_MODULE

S_CHANNEL

S_TYPE

TO_BOARD

TO_TU_TY

TO_TU_CO

TO_TB_ID

9AKK101130D1382

Character

Range
Default
Parameter(s)

Description
Slave module coordinates.

<string>

10

<blank>

Optional

None

Character

Slave module number.

<string>

<blank>

Optional

None

Character

Slave channel number.

<string>

<blank>

Optional

None

Character

Slave module type.

<string>

<blank>

Optional

None

Character

Termination unit identifier.

<string>

14

<blank>

Optional

None

Character

Termination unit type.

<string>

<blank>

Optional

None

Character

Termination unit coordinates.

<string>

10

<blank>

Optional

None

Character

Board identifier on termination unit.

<string>

<blank>

Optional

None

107

Table 20. Generic Tag - Hardware Description Parameters.


Format
Width
Opt/Mnd

Name
TO_PIN1

TO_PIN2

TO_PIN3

DRAW_REF

DESC_CABLE

FR_BOARD

FR_TB_ID

FR_ROW

108

Character

Range
Default
Parameter(s)

Description
First pin on termination board.

<string>

<blank>

Optional

None

Character

Second pin on termination board.

<string>

<blank>

Optional

None

Character

Third pin on termination board.

<string>

<blank>

Optional

None

Character

Drawing reference code description. <string>

14

<blank>

Optional

None

Character

Field cable identifier.

<string>

20

<blank>

Optional

Name of field cable wiring


termination unit to field termination
board.

Character

Field termination cabinet identifier.

<string>

14

<blank>

Optional

Name of field cabinet to which


termination unit is wired.

Character

Field termination board identifier.

<string>

None

None

<blank>

Optional

None

Character

Field termination board coordinates.

<string>

<blank>

Optional

None

9AKK101130D1382

Table 20. Generic Tag - Hardware Description Parameters.


Format
Width
Opt/Mnd

Name
FR_PIN1

FR_PIN2

Character

First pin on field termination board.

<blank>

Optional

None

Character

Second pin on field termination


board.

Character

Third pin on field termination board.

Optional

None

Character

Character

External alarm window panel


identifier.

External alarm window number.

<string>
<blank>

Optional

None

Character

Character
14

External alarm window description


row 1.

Character
14
Optional

<string>
<blank>
None

External alarm window description


row 2.

Optional

9AKK101130D1382

<blank>
None

Optional

WIN_ROW3

<string>

14
WIN_ROW2

<string>
<blank>

Optional

WIN_ROW1

<blank>

8
WIN_NUMBER

<string>
None

Optional

WIN_PANEL

<string>

3
FR_PIN3

Range
Default
Parameter(s)

Description

<string>
<blank>
None

External alarm window description


row 3.

<string>
<blank>
None

109

Application Parameters
The fields in Table 21 and Table 22 are available for additional tag
qualification or to be used by application specific programs.
All fields are optional.
Application parameters may be statically used by defining a value for them.
Values will be unchanged. They may also be dynamically used to update
values by application programs. Initial values may be set.
Table 21. Generic Tag - Application Parameters.
Format
Width
Opt/Mnd

Name
USER3

USER7

USER10

UT_IN1

UT_IN2

UT_IN3

110

Character

Range
Default
Parameter(s)

Description
ASCII text.

<string>

<blank>

Optional

None

Character

ASCII text.

<string>

16

<blank>

Optional

None

Character

ASCII text.

<string>

32

<blank>

Optional

None

Integer

Integer value.

{-32767...+32767}

Optional

None

Integer

Integer value.

{-32767...+32767}

Optional

None

Integer

Integer value.

{-32767...+32767}

Optional

None

9AKK101130D1382

Table 21. Generic Tag - Application Parameters.


Format
Width
Opt/Mnd

Name
UT_IN4

UT_RE1

UT_RE2

UT_RE3

UT_RE4

UT_RE5

UT_RE6

9AKK101130D1382

Integer

Range
Default
Parameter(s)

Description
Integer value.

{-32767...+32767}

Optional

None

Real

Real number.

<9 digit real>

Optional

None

Real

Real number.

<9 digit real>

Optional

None

Real

Real number.

<9 digit real>

Optional

None

Real

Real number.

<9 digit real>

Optional

None

Real

Real number.

<9 digit real>

Optional

None

Real

Real number.

<9 digit real>

Optional

None

111

Table 21. Generic Tag - Application Parameters.


Format
Width
Opt/Mnd

Name
ASPECT1NAM

Description

Range
Default
Parameter(s)
<string>

Character

Aspect program menu text 1.

20

Aspects allows you to add specific menu <blank>


items for tag handling. Menu items are
[sznam]
added to the operating parameters and to
the context menu. See the field
ASPECT1CMD also.

Optional

The aspect name defines the text of the


menu item.
ASPECT1CMD

Character

Aspect command line 1.

<string>

80

Aspects allows you to add specific menu


items for tag handling. See the field
ASPECT1NAM also.

<blank>

Optional

[szedsc]

The aspect command defines the


command line to be executed.
See the Note 1 at the end of the table.
......................

...............

..............................................

............

......................

...............

..............................................

............

ASPECT5NAM

Character

Aspect program menu text 5.

<string>

20

Same as ASPECT1NAM above.

<blank>

Optional
ASPECT5CMD

[sznam]

Character

Aspect command line 5.

<string>

80

Same as ASPECT1CMD above.

<blank>

Optional

See the note 1 at the end of the table.

[szedsc]

Note 1:
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>

112

9AKK101130D1382

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.
The parameters listed in the following table are not included in the
Application Tab of the on-line configuration.
Table 22. Generic Tag - Application Parameters (cntd.).
Format
Width
Opt/Mnd

Name
ATOM1NAM

Character

Range
Default
Parameter(s)

Description
Atom name 1.

<string>

64

<blank>

Optional

[szdesc]

...................

...............

....................

............................

ATOM50NAM

Character

Atom name 50.

<string>

64

Same as ATOM1NAM above.

<blank>

Optional
ATOM1TYP

Integer

[szdesc]
Atom type 1.

Optional

None

...................

...............

....................

ATOM50TYP

Integer

Atom type 50.

Same as ATOM1TYP above.

Optional

9AKK101130D1382

............................
0
None

113

Table 22. Generic Tag - Application Parameters (cntd.).


Format
Width
Opt/Mnd

Name
ATOM1VAL

Integer

Range
Default
Parameter(s)

Description
Atom value 1.

{-32767...+32767}

10

Optional

None

...................

...............

....................

............................

ATOM50VAL

Integer

Atom value 50.

{-32767...+32767}

10

Same as ATOM1VAL above.

Optional

None

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.

114

9AKK101130D1382

General Parameters
The fields in Table 23 define 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.
Table 23. Digital Tag - General Parameters.

Name
ZEROSTATE

ONESTATE

Format
Width
Opt/Mnd

Description

Range
Default
Parameter(s)

Character

Zero state descriptor.

<string>

16
Mandatory

This field defines the text to be displayed


or printed to represent the state 0.
[sztags]

Character

Same as above for state 1.

<string>

16
Mandatory
TWOSTATE

[sztags]

Character

Same as above for state 2.

<string>

16

The field is mandatory for MSDDs.

<blank>

Optional
THREESTATE

[sztags]

Character

Same as above for state 3.

<string>

16

The field is mandatory for MSDDs.

<blank>

Optional
FOURSTATE

9AKK101130D1382

Character

[sztags]
Same as above for state 4.

<string>

16

<blank>

Optional

[sztags]

115

Table 23. Digital Tag - General Parameters.

Name
FIVESTATE

SIXSTATE

SEVENSTATE

EIGHTSTATE

NINESTATE

TENSTATE

ELEVNSTATE

TWELVSTATE

116

Format
Width
Opt/Mnd
Character

Description
Same as above for state 5.

Range
Default
Parameter(s)
<string>

16

<blank>

Optional

[sztags]

Character

Same as above for state 6.

<string>

16

<blank>

Optional

[sztags]

Character

Same as above for state 7.

<string>

16

<blank>

Optional

[sztags]

Character

Same as above for state 8.

<string>

16

<blank>

Optional

[sztags]

Character

Same as above for state 9.

<string>

16

<blank>

Optional

[sztags]

Character

Same as above for state 10.

<string>

16

<blank>

Optional

[sztags]

Character

Same as above for state 11.

<string>

16

<blank>

Optional

[sztags]

Character

Same as above for state 12.

<string>

16

<blank>

Optional

[sztags]

9AKK101130D1382

Table 23. Digital Tag - General Parameters.


Format
Width
Opt/Mnd

Name
THTEESTATE

Character

FRTEESTATE

Optional

[sztags]
Same as above for state 14.

<string>

16

<blank>

Optional

[sztags]
Same as above for state 15.

<string>

16

<blank>

Optional

[sztags]

Integer

Index for logic state descriptor 1.

16

Optional

None

..................

...............

.................................................

LSD16INDEX

Integer

Index for logic state descriptor 16.

ISALARM0

<string>
<blank>

Character

LSD1INDEX

Same as above for state 13.

16
Character

FVTEESTATE

Range
Default
Parameter(s)

Description

.........

16

Optional

None

Character

Alarm flag for state 0.

{Y, N}

Is set, state 0 is an alarm state.

Optional

See Note 1 at the end of the table.

None

..................

...............

.................................................

.........

ISALARM31

Character

Alarm flag for state 31.

{Y, N}

Is set, state 31 is an alarm state.

Optional

See Note 1 at the end of the table.

None

Note 1:

9AKK101130D1382

117

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

Process Parameters
The fields in Table 24 define some alarm processing information concerning
digital tags. All fields are optional.
Table 24. Digital Tag - Process Parameters.
Format
Width
Opt/Mnd

Name
EVENTTAG

State information flag.

If set, all possible states of the tag will be N


considered normal and the only type of
None
alarm output enabled is Operator Journal
recording (while alarm display pages,
reports and post trip logs are not
affected).

Integer

Initial value.

{0...15}

15

This value is loaded into the realtime


database at system star-up.

Optional

118

{Y, N}

Character
Optional

INITVAL

Range
Default
Parameter(s)

Description

None

9AKK101130D1382

Table 24. Digital Tag - Process Parameters.


Format
Width
Opt/Mnd

Name
MAX_ROC

ALM_PROG

EVT_PROG

{0...999}

Integer

Maximum allowed rate of changes.

0
This field defines the maximum number
of state changes allowed for this tag
None
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 nomeaningful exception reports might
significantly reduce or saturate the
playback storage area.

Optional

TRIP_NUM

Range
Default
Parameter(s)

Description

Integer

Triggered post trip group number.

{0,1...100}

Optional

If greater than 0, it identifies the post trip


group to be triggered when the tag goes
into alarm or returns to normal.

Character

Program activation flag on alarm.

{Y,N}

Optional

If set, the application action program


defined by AAP_NUM field will be
activated whenever an alarm condition
occurs.

Character

Program activation flag on event.

{Y,N}

If set, the application action program


defined by AAP_NUM field will be
activated whenever an event (state
change) takes place.

Optional

[mxhgrp]

None

None

Generic Scanner Input Parameters


Fields of this sub-section apply to both analog and digital tags. Refer to the
analogue sub-section of generic tag definition for details.

9AKK101130D1382

119

Generic Scanner Output Parameters


Fields of this sub-section apply to both analog and digital tags. Refer to the
analogue sub-section of generic tag definition for details.

Symphony Input Parameters


The fields of Table 25 define the 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 meaningful only for digital tags coming from Symphony SER
modules. In any other case, their contents will be ignored.
SER modules cannot be addressed directly by PGP 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 PGP (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 26 allow defining the 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.

120

9AKK101130D1382

Table 25. Digital Tag - Symphony Input Parameters.


Format
Width
Opt/Mnd

Name
SER_NUMBER

Integer

SER_INDEX

Range
Default
Parameter(s)

Description
SER number.

{0, 1, 2}

Optional

[mxsedv]

Integer

SER index.

{0, 1...512}

Optional

[mxsept]

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.
The parameters listed in the following table are not included in the
Symphony Tab of the on-line configuration.
Table 26. Digital Tag - Symphony Input Parameters (cntd.).
Format
Width
Opt/Mnd

Name
SOELOG

SOETYPE

Range
Default
Parameter(s)

Description

Integer

Number of sequence of events log.

Optional

This field identifies the log of each SER


device.

Integer

Type of sequence of events.

{0, 1}

The value of this field can be

Optional

0 - Standard SOE,

None

None

1 - Summary SOE.

9AKK101130D1382

121

Table 26. Digital Tag - Symphony Input Parameters (cntd.).


Format
Width
Opt/Mnd

Name
SOETIMEOUT

SOETUNITS

Range
Default
Parameter(s)

Description

Integer

Sequence of events time-out.

3
Optional

This field defines the interval of time the 0


sequence of events is kept opened ready None
to collect all changes following the first
event (the SOE event activating).

Integer

Time unit to qualify the SOE time-out.

{0, 1}

The value can be

Optional

0 - Seconds,

None

1 - Minutes.
SOEMAXEVT

SOEOUTLOG

Integer

Maximum number of allowed events.

5
Optional

0
The current sequence of event log is
closed if it reaches the maximum number None
of events. A new SOE log is opened to
collect exceeding events.

Integer

Output log for SOE merging.

When multiple SER devices are in use, a 0


single log can be generated merging
None
logs.

Optional

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.

Command Parameters
The fields in Table 27 define the descriptive text strings associated with
each possible status of feedbacks from the process. All fields are optional.
They are meaningful only for those digital tags acquired from Symphony
modules that support feedback (DD and MSDD). See also Appendix A.

122

9AKK101130D1382

The on-line configuration includes the fields in the DI Feedback Tab.


.

Table 27. Digital Tag Command Parameters.

Name
FB1_0STATE

FB1_1STATE

FB2_0STATE

FB2_1STATE

FB3_0STATE

FB3_1STATE

FB4_0STATE

FB4_1STATE

9AKK101130D1382

Format
Width
Opt/Mnd

Description

Range
Default
Parameter(s)

Character

Zero state descriptor for feedback 1.

<string>

16
Optional

This field defines the text to be displayed <blank>


for the state 0 of feedback 1.
[sztags]

Character

One state descriptor for feedback 1.

16
Optional

This field defines the text to be displayed <blank>


for the state 1 of feedback 1.
[sztags]

Character

Same as above for state 0 of feedback 2. <string>

<string>

16

<blank>

Optional

[sztags]

Character

Same as above for state 1 of feedback 2. <string>

16

<blank>

Optional

[sztags]

Character

Same as above for state 0 of feedback 3. <string>

16

<blank>

Optional

[sztags]

Character

Same as above for state 1 of feedback 3. <string>

16

<blank>

Optional

[sztags]

Character

Same as above for state 0 of feedback 4. <string>

16

<blank>

Optional

[sztags]

Character

Same as above for state 1 of feedback 4. <string>

16

<blank>

Optional

[sztags]

123

Alarm Processing Parameters


The field in the Table 28 allows defining a specific priority to be associated
to a digital (status only) tag.
Refer to the analogue sub-sections of generic tag definition for additional
fields concerning the default alarm priority and other specific alarm priorities.
See the description of the AL_PRI field for details on the definition of alarm
priorities.
Table 28. Digital Tag - Alarm Processing Parameters.
Format
Width
Opt/Mnd

Name
ALPRI_STCH

Description

Range
Default
Parameter(s)
{0, 1 ... 16}

Integer

Status change priority number.

0
This is the priority assigned to the tag
(defined as status only tag and not alarm [mxalpr] or [mxxapr]
tag) when a status change takes place
and the condition must be displayed. If
set to 0 then the default priority is
assigned.

Optional

Alarm Level Parameters


Fields of this sub-section apply to analog tags only.

Alarm Option Parameters


Fields of this sub-section apply to analog tags only.

Alarm Comment Parameters


The fields in the Table 29 allow linking or referencing descriptive texts to be
associated to alarm conditions of the tag.
Either a 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

124

9AKK101130D1382

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.
Table 29. Digital Tag - Alarm Comment Parameters.
Format
Width
Opt/Mnd

Name
ALRMCMNT12

Integer

ALRMCTXT12

Description

Range
Default
Parameter(s)

Alarm comment index for alarm condition. {1...100}

<blank>

Optional

[mxalcm]

Character

Alarm comment text for alarm condition.

<string>

80

<blank>

Optional

[szalcm]

Refer to the Alarm Comment definition chapter for more information about
the contents of these fields. Refer to the analogue 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).

Network Parameters
Fields of this sub-section apply to both analog and digital tags. Refer to the
analogue sub-section of generic tag definition for details.

OPC Parameters
Fields of this sub-section apply to both analog and digital tags. Refer to the
analogue sub-section of generic tag definition for details.

9AKK101130D1382

125

Totalization Parameters
The fields in Table 30 allow defining totalizations associated to the digital
tag. They are meaningful only 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.
Basically, the totalization collects the number activations (i.e. the changes
from a steady to a 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.
Table 30. Digital Tag - Totalization Parameters.
Format
Width
Opt/Mnd

Name
HRTRUNSTAT

HRTMAXCHGS

HRTMAXRUN

{0, 1}

Integer

Running status for digital totalization.

1
Optional

0
This field defines the status identifying
the operational condition of the dual-state None
device.

Integer

Maximum number of status changes.

5
Optional

This field defines the upper limit to the


number of allowed transitions from the
steady to the operational status of the
device.

Integer

Maximum running time.

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.

Optional

126

Range
Default
Parameter(s)

Description

0
None

0
None

9AKK101130D1382

Table 30. Digital Tag - Totalization Parameters.


Format
Width
Opt/Mnd

Name
HRTMAXRUNU

HRTMAXSRV

Integer

Time unit for maximum running time.

1
Optional

See Appendix A for the allowed time


units.

Integer

Maximum time from service.

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.

Optional

HRTMAXSRVU

Integer

Time unit for maximum time from service.

See Appendix A for the allowed time


units.

Optional

Range
Default
Parameter(s)

Description

0
None
0
None

0
None

Device Status Parameters


The fields in Table 31 apply to device status tag only. Those type of tags are
used for diagnostic purposes. The device status tags allow collecting and
keeping the diagnostic of the components of the hardware architecture:
computers, printers, hard disks. A general purpose diagnostic provides
information on the status of those tags.
One of the fields listed in the table provides the capability to route the alarm
acknowledgments for the tag through the Infinet when the ALMACKBC flag
is set. That allows you to broadcast acknowledgments among nodes when
the Ethernet cannot be the connection support. That is the case of
architectures where there are PGP and MCS or OIS 40.
The on-line configuration does not provide a Tab including the device status
fields. They can be defined by the off-line (database file) configuration only.

9AKK101130D1382

127

Table 31. Digital Tag - Device Status Parameters.


Format
Width
Opt/Mnd

Name
DEV_NAME

Range
Default
Parameter(s)

Description

<string>

Character

Device name.

20

Depending on the type of device (see the <blank>


field DEV_TYPE below), this field can
None
define the name of a printer, a computer
or a disk.

Optional

See Note 1 at the end of the table.


DEV_NUMBER

Integer

Device number.

<integer>

15

Allowed values are

Optional

1 - Printer,

None

2 - Node,
3 - Disk.
DEV_TYPE

Integer

Device type.

{Printer, Node, Disk}

15

The field qualifies the kind of device the


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

Optional

None

See Note 2 at the end of the table.


DEVSUBTYPE

Integer

Device sub-type.

This field is not required for module


diagnostic.

Optional

128

0
None

9AKK101130D1382

Table 31. Digital Tag - Device Status Parameters.


Format
Width
Opt/Mnd

Name
MODTYPE

Description

Range
Default
Parameter(s)

Character

Module type.

{MFP, OIS, MCS, ...}

20

This field defines the kind of hardware to


be either: MFP, OIS, MCS, TNT, ...

<blank>

Optional

[sznam]

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>

This field is not required for module


diagnostic.

<blank>

Optional

None

Note 1:
The name of devices are 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. PGPSERVER1) 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 surveys the availability of printers, the existence (or
the operability) of nodes and the space allocation of disks.
Nodes are checked issuing a ping through the Ethernet. All nodes, and not
only PGP nodes, can be submited for diagnostic check.
Disks are checked for allocation and alarm messages are issued when a
high or a very high limit is reached. Two optional registries, the
DiskUsageHighLimit and the DiskUsageVeryHighLimit, define the high and
very high limits of the disk space allocation.

9AKK101130D1382

129

Documentation Parameters
The field in Table 32 allows linking tag conditions and documentation.
Currently, PGP does not manage the field, but it may be loaded in the tag
database for a future use.
Refer to the analogue sub-section of generic tag definition for additional
fields.
Table 32. Digital Tag Documentation Parameters.
Format
Width
Opt/Mnd

Name
ALMDST

Integer
5

Range
Default
Parameter(s)

Description
Reference to status change
documentation

Optional

0
None

Hardware Description Parameters


Fields of this sub-section apply to both analog and digital tags. Refer to the
analogue 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
analogue 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.

General Parameters
The fields in Table 33 define 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.

130

9AKK101130D1382

Refer to engineering unit database chapter 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).
Table 33. Analog Tag - General Parameters.
Format
Width
Opt/Mnd

Name
EUDESC

NUMDECPL

I4_DATA

PLAYBACKCM

INITVAL

Range
Default
Parameter(s)

Description

Character

Engineering unit text.

<string>

16

<blank>

Optional

This text defines the engineering unit


associated to the tag.

Integer

Number of decimal places.

{0...9}

Optional

The information is used when displaying


the tag value.

Character

Integer/Real format flag.

{Y,N}

1
Optional

N
If set, the value of the tag will be stored
into realtime database as a 32-bit signed None
integer.

Character

Playback compression flag.

{Y,N}

Optional

If set, tag exception reports will be


compressed in the playback archive
according to compression rules.

Real

Initial value.

{lowlim...higlim}

15

This value is loaded into realtime


database at system start-up.

Optional

[sztags]

None

None

None

See Note 1 at the end of the table.

9AKK101130D1382

131

Table 33. Analog Tag - General Parameters.


Format
Width
Opt/Mnd

Name
SCA_VAL_0

Range
Default
Parameter(s)

Description

Real

0% scale value.

{lowlim...higlim}

15

Value (expressed in 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.

Optional

None

See Note 1 at the end of the table.


SCA_VL_100

Real

100% scale value.

{lowlim...higlim}

15

Value (expressed in engineering units)


representing the 100% scale to be used
for bar chart and trend representation of
the tag. If omitted or zero (blank), the
100% scale will be assumed to be the
high instrument limit.

Optional

None

See Note 1 at the end of the table.


PLAYBACKDB

Real

Playback dead-band.

{lowlim...higlim}

10

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.

Optional

None

See PLAYBACKTM also and the Note 3


at the end of the table.
See Note 1 at the end of the table.
PLAYBACKTM

Integer

Playback timer.

This field defines the timer (in seconds)


for dummy packet checking.

Optional

30
None

See PLAYBACKDB also and the Note 3


at the end of the table.

132

9AKK101130D1382

Table 33. Analog Tag - General Parameters.


Format
Width
Opt/Mnd

Name
PLBCOMPRDB

{0...100}

Integer

Playback compression dead-band.

15

0
This value (expressed in percentage)
defines the dead-band for playback
None
compression algorithm. If defined, must
be wider than the significative change the
tag value can take.

Optional

FILTER_TAU

Range
Default
Parameter(s)

Description

Integer

Time constant for filter factor.

0
This field defines a time constant for
filtering a tag value before updating the
None
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.

Optional

See Note 2 at the end of the table.


INCDECPRC

Real

Increment/Decrement percentage for


control station and RMSC device.

10
Optional

{0...100}
0.0
None

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 subsection.
Note 2:

9AKK101130D1382

133

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.

dt

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.
Note 3:
Playback dead-band and timer provide 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 deadband, 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.
That allows a higher reliability in data trending. This mechanism allows you
to exactly 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).

134

9AKK101130D1382

This mechanism must be used carefully and only when necessary, as it may
considerably decrease the playback archive capacity.
The parameters listed in the following table are not included in the Analog
General Tab of the on-line configuration.
Table 34. Analog Tag - General Parameters (cntd.).
Format
Width
Opt/Mnd

Name
EUINDEX

Integer

Engineering unit index.

{-1, 0...127}

This field defines the index into the


engineering unit database. A value of 1
forces automatic assignment of
engineering unit index and requires the
specification of the engineering unit text
(see next field).

-1

Real

Hourly constancy delta value.

{lowlim...higlim}

10

This value (expressed in engineering


units) defines the delta allowed as
tolerance for hourly constancy check.
This field is meaningful only if PGP has
been configured to support hourly
constancy function.

Optional

CONSTDELTA

Range
Default
Parameter(s)

Description

Optional

[mxeutx]

None

The on-line configuration does not


include the field in the PV General Tab.

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. See the Engineering Units section
for further details.

9AKK101130D1382

135

Process Parameters
Fields of this sub-section apply to both analog and digital tags. Refer to the
analogue sub-section of generic tag definition for details.

Generic Scanner Input Parameters


Fields of this sub-section apply to analog tags only.
Refer to the analogue sub-section of the generic tag definition for additional
fields.
The parameters listed in the following table are not included in the Tabs of
the on-line configuration.
Table 35. Analog Tag Generic Scanner Input Parameters.

Name
CONVCODE

Format
Width
Opt/Mnd
Character
20

Conversion code to be performed on the


input raw data.

Optional
CONVMIN

Integer
15
Integer
15

Minimum value (in engineering unit) of


the input raw data.

Integer
15

<blank>

0
None

Maximum value (in engineering unit) of


the input raw data.

Optional
CONVOFFS

<string>
[sznam]

Optional
CONVMAX

Range
Default
Parameter(s)

Description

0
None

Offset value to add on converting input


raw data.

Optional

0
None

Generic Scanner Output Parameters


Fields of this sub-section apply to both analog and digital tags. Refer to the
analogue sub-section of generic tag definition for details.

136

9AKK101130D1382

Symphony Input Parameters


Fields of this sub-section apply to both analog and digital tags. Refer to the
analogue sub-section of generic tag definition for details.

Command Parameters
Fields of this sub-section apply to digital tags only.

Alarm Processing Parameters


The fields in the Table 36 allow defining specific alarm priorities to be
associated to an analog tag.
Refer to the analogue sub-sections of generic tag definition for additional
fields concerning the default alarm priority and other specific alarm priorities.
See the description of the AL_PRI field for details on the definition of alarm
priorities.
Table 36. Analog Tag - Alarm Processing Parameters.
Format
Width
Opt/Mnd

Name
ALPRI_3H

ALPRI_2H

Range
Default
Parameter(s)
{0, 1 ... 16}

Integer

3-High alarm priority number.

2
Optional

0
This is the priority assigned to the tag
when a 3-high alarm condition takes
[mxalpr] or [mxxapr]
place. If set to 0 then the default priority is
assigned.

Integer

2-High alarm priority number.

0
This is the priority assigned to the tag
when a 2-high alarm condition takes
[mxalpr] or [mxxapr]
place. If set to 0 then the default priority is
assigned.

Optional

9AKK101130D1382

Description

{0, 1 ... 16}

137

Table 36. Analog Tag - Alarm Processing Parameters.


Format
Width
Opt/Mnd

Name
ALPRI_H

ALPRI_L

ALPRI_2L

ALPRI_3L

ALPRI_HROC

ALPRI_LROC

{0, 1 ... 16}

Integer

High alarm priority number.

2
Optional

0
This is the priority assigned to the tag
when a high alarm condition takes place. [mxalpr] or [mxxapr]
If set to 0 then the default priority is
assigned.

Integer

Low alarm priority number.

2
Optional

0
This is the priority assigned to the tag
when a low alarm condition takes place. If [mxalpr] or [mxxapr]
set to 0 then the default priority is
assigned.

Integer

2-Low alarm priority number.

{0, 1 ... 16}

Optional

This is the priority assigned to the tag


when a 2-low alarm condition takes
place.

Integer

3-Low alarm priority number.

{0, 1 ... 16}

2
Optional

0
This is the priority assigned to the tag
when a 3-low alarm condition takes
[mxalpr] or [mxxapr]
place. If set to 0 then the default priority is
assigned.

Integer

High rate of change priority number.

{0, 1 ... 16}

Optional

This is the priority assigned to the tag


when a high rate of change alarm
condition takes place. If set to 0 then the
default priority is assigned.

Integer

Low rate of change priority number.

{0, 1 ... 16}

This is the priority assigned to the tag


when a low rate of change alarm
condition takes place. If set to 0 then the
default priority is assigned.

Optional

138

Range
Default
Parameter(s)

Description

{0, 1 ... 16}

[mxalpr] or [mxxapr]

[mxalpr] or [mxxapr]

[mxalpr] or [mxxapr]

9AKK101130D1382

Table 36. Analog Tag - Alarm Processing Parameters.


Format
Width
Opt/Mnd

Name
ALPRI_HDEV

ALPRI_LDEV

Range
Default
Parameter(s)

Description

Integer

High deviation priority number.

{0, 1 ... 16}

Optional

This is the priority assigned to the tag


when a high deviation alarm condition
takes place. If set to 0 then the default
priority is assigned.

Integer

Low deviation priority number.

{0, 1 ... 16}

This is the priority assigned to the tag


when a low deviation alarm condition
takes place.

Optional

[mxalpr] or [mxxapr]

[mxalpr] or [mxxapr]

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

Alarm Level Parameters


The fields in Table 37 define all alarm levels and related information
concerning analog tags. All these fields are meaningful only if remote alarm
processing (AL_REM field) is not enabled. All fields are optional.
The range of an analog tag is characterized by values of zero and span.
They define the boundary limits to reasonable values assumed by tag value.
PGP automatically loads values of zero and span for tags coming from
Symphony. So, it is not requested to define them if those values are defined
within Symphony modules.
Within the range, each analog tag may have up to six fixed alarm levels:
three high alarm limits and three low alarm limits.
They may be 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.
Six fields allow the definition of fixed alarm levels. Only needed levels may
be defined.

9AKK101130D1382

139

Two further fields allow definition of dynamic high and low alarm thresholds.
A dynamic threshold is defined by the name of an analog tag. In such a
case, the value of the alarm threshold is not fixed and defined at
configuration time, it is retrieved from the realtime database when the alarm
processing is being performed for the current analog tag.
Raw and current threshold values are compared to decide if an alarm
condition must be notified. Of course, the dynamic threshold tags and the
current analog tag should represent the same physical entity to be
comparable.
Typically, dynamic thresholds are calculated tags.
Table 37. Analog Tag - Alarm Level Parameters.
Format
Width
Opt/Mnd

Name
HINS_LIMIT

SPAN

Real

High instrument limit.

15
Optional

This value (expressed in engineering


units) defines the 100% scale of the tag.
This parameter may be used instead of
SPAN.

Real

Instrument span.

15

This value (expressed in engineering


units) defines the range of the tag.

Optional

Range
Default
Parameter(s)

Description

0
None

0
None

When SPAN is used, the high instrument


limit is automatically calculated as the
result of VAL0 + SPAN.
HI_ACTIVE

140

Character

High instrument limit activation flag.

{Y, N}

Optional

None

9AKK101130D1382

Table 37. Analog Tag - Alarm Level Parameters.


Format
Width
Opt/Mnd

Name
HI_PROG

Program activation flag on high


instrument alarm.

{Y, N}

Optional

If set, the application action program


defined by AAP_NUM field will be
activated whenever a high instrument
alarm is generated.

None

Real

3-High alarm limit.

{lowlim...higlim}

15

This value (expressed in engineering


units) defines the third high alarm level.

Character
1

H3ALARM

Range
Default
Parameter(s)

Description

Optional

None

See Note 1 at the end of the table.


H3_ACTIVE

H2ALARM

Character

3-High alarm limit activation flag.

{Y, N}

Optional

None

Real

2-High alarm limit.

{lowlim...higlim}

15

This value (expressed in engineering


units) defines the second high alarm
level.

Optional

None

See Note 1 at the end of the table.


H2_ACTIVE

H23_PROG

Character

{Y, N}

Optional

None

Character
1
Optional

9AKK101130D1382

2-High alarm limit activation flag.

Program activation flag on 2 and 3-High


alarm.

{Y, N}

If set, the application action program


defined by AAP_NUM field will be
activated whenever a 2-High alarm or 3High alarm is generated.

None

141

Table 37. Analog Tag - Alarm Level Parameters.


Format
Width
Opt/Mnd

Name
HALARM

Range
Default
Parameter(s)

Description

Real

High alarm limit.

{lowlim...higlim}

15

This value (expressed in engineering


units) defines the first high alarm level.

Optional

None

See Note 1 at the end of the table.


H_ACTIVE

H_PROG

LALARM

Character

High alarm limit activation flag.

{Y, N}

Optional

None

Character

Program activation flag on high alarm.

{Y, N}

Optional

If set, the application action program


defined by AAP_NUM field will be
activated whenever a high alarm is
generated.

Real

Low alarm limit.

{lowlim...higlim}

15

This value (expressed in engineering


units) defines the first low alarm level.

Optional

None

None

See Note 1 at the end of the table.


L_ACTIVE

L_PROG

Character

{Y, N}

Optional

None

Character

Program activation flag on low alarm.

{Y, N}

If set, the application action program


defined by AAP_NUM field will be
activated whenever a low alarm is
generated.

Optional

142

Low alarm limit activation flag.

None

9AKK101130D1382

Table 37. Analog Tag - Alarm Level Parameters.


Format
Width
Opt/Mnd

Name
L2ALARM

L2_ACTIVE

L3ALARM

Range
Default
Parameter(s)

Description

{lowlim...higlim}

Real

2-Low alarm limit.

15
Optional

0
This value (expressed in engineering
units) defines the second low alarm level. None
See Note 1 at the end of the table.

Character

2-Low alarm limit activation flag.

{Y, N}

Optional

None

Real

3-Low alarm limit.

{lowlim...higlim}

15

This value (expressed in engineering


units) defines the third low alarm level.

Optional

None

See Note 1 at the end of the table.


L3_ACTIVE

L23_PROG

Character

LI_ACTIVE

9AKK101130D1382

{Y, N}

Optional

None
Program activation flag on 2 and 3-Low
alarm.

{Y, N}

Optional

If set, the application action program


defined by AAP_NUM field will be
activated whenever a 2-Low alarm or 3Low alarm is generated.

None

Real

Low instrument limit.

15
Optional

This value (expressed in engineering


0
units) represents the 0% scale of the tag. None

Character

Low instrument limit activation flag.

Character
1

VAL0

3-Low alarm limit activation flag.

{Y, N}

Optional

None

143

Table 37. Analog Tag - Alarm Level Parameters.


Format
Width
Opt/Mnd

Name
LI_PROG

Optional

Program activation flag on low instrument {Y, N}


alarm.
N
If set, the application action program
None
defined by AAP_NUM field will be
activated whenever a low instrument
alarm is generated.

Character

High variable alarm tag.

20
Optional

Name of an analog tag whose value will <blank>


be used as high alarm limit. If this field is [sznam]
defined, all values specified by fixed high
alarm limits will be ignored.

Character

2-High variable alarm tag.

20
Optional

Name of an analog tag whose value will <blank>


be used as 2-high alarm limit. If this field [sznam]
is defined, all values specified by fixed or
delta high alarm limits will be ignored.

Character

3-High variable alarm tag.

20
Optional

Name of an analog tag whose value will <blank>


be used as 3-high alarm limit. If this field [sznam]
is defined, all values specified by fixed or
delta high alarm limits will be ignored.

Real

2-High variable alarm delta.

{lowlim...higlim}

15

This value (expressed in engineering


units) will be added to the high variable
alarm tag value (if defined) to determine
the 2-High variable alarm limit. It is
ignored if the H2VARALMTAG field is
defined.

Character
1

HVARALMTAG

H2VARALMTG

H3VARALMTG

H2DELTA

Range
Default
Parameter(s)

Description

Optional

<string>

<string>

<string>

None

See Note 1 at the end of the table.

144

9AKK101130D1382

Table 37. Analog Tag - Alarm Level Parameters.

Name
H3DELTA

Format
Width
Opt/Mnd

Range
Default
Parameter(s)

Description

Real

3-High variable alarm delta.

{lowlim...higlim}

15

This value (expressed in engineering


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

Optional

None

See Note 1 at the end of the table.


LVARALMTAG

L2VARALMTG

Low variable alarm tag.

20
Optional

Name (or index) of an analog tag whose <blank>


value will be used as low high alarm limit. [sznam]
If this field is defined, all values specified
by fixed low alarm limits will be ignored.

Character

2-Low variable alarm tag.

20

Name (or index) of an analog tag whose <blank>


value will be used as 2-low high alarm
[sznam]
limit. If this field is defined, all values
specified by fixed or delta low alarm limits
will be ignored.

Optional

L3VARALMTG

<string>

<string>

Character

3-Low variable alarm tag.

20

Name (or index) of an analog tag whose <blank>


value will be used as 3-low high alarm
[sznam]
limit. If this field is defined, all values
specified by fixed or delta low alarm limits
will be ignored.

Optional

9AKK101130D1382

<string>

Character

145

Table 37. Analog Tag - Alarm Level Parameters.

Name
L2DELTA

Format
Width
Opt/Mnd

Description

Range
Default
Parameter(s)
{lowlim...higlim}

Real

2-Low variable alarm delta.

15

0
This value (expressed in engineering
units) will be subtracted from the low
None
variable alarm tag value (if defined) to
determine the 2-Low variable alarm limit.
It is ignored if the L3VARALMTAG field is
defined.

Optional

See Note 1 at the end of the table.


L3DELTA

{lowlim...higlim}

Real

3-Low variable alarm delta.

15

0
This value (expressed in engineering
units) will be subtracted from the low
None
variable alarm tag value (if defined) to
determine the 3-Low variable alarm limit.
It is ignored if the L3VARALMTAG field is
defined.

Optional

See Note 1 at the end of the table.

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

146

9AKK101130D1382

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

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 (see the PGP of the
generic tag definition section).

Alarm Option Parameters


The fields in Table 38 define some additional alarm and archive processing
information concerning 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.

9AKK101130D1382

147

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 processing nor alarm dead-band definitions are
affected by instrument limits.
The last two fields in the table concern the instrument limit violation. They
allow defining actions to be performed on tag database value when an
instrument limit is exceeded.
Table 38. Analog Tag Alarm Option Parameters.
Format
Width
Opt/Mnd

Name
HR_ACTIVE

Character
1

Increasing rate of change limit activation


flag.

{Y, N}
N
None

Optional
HROC_LIMIT

Range
Default
Parameter(s)

Description

{lowlim...higlim}

Real

Increasing rate of change limit.

15

0
This value (expressed in engineering
units) defines the maximum positive
None
change allowed for the tag value during a
period of one minute. If the value is
exceeded, a increasing rate of change
alarm is generated.

Optional

See Note 1 at the end of the table.


HR_PROG

Character
1
Optional

148

Program activation flag on increasing rate {Y, N}


of change alarm.
N
If set, the application action program
None
defined by AAP_NUM field will be
activated whenever an increasing rate of
change alarm is generated.

9AKK101130D1382

Table 38. Analog Tag Alarm Option Parameters.


Format
Width
Opt/Mnd

Name
LR_ACTIVE

Character
1

Decreasing rate of change limit activation {Y, N}


flag.
N

Optional
LROC_LIMIT

Range
Default
Parameter(s)

Description

None
{lowlim...higlim}

Real

Decreasing rate of change limit.

15

0
This value (expressed in engineering
units) defines the maximum negative
None
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.

Optional

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.
See Note 1 at the end of the table.
LR_PROG

Program activation flag on decreasing


rate of change alarm.

{Y, N}

Optional

If set, the application action program


defined by AAP_NUM field will be
activated whenever a decreasing rate of
change alarm is generated.

None

Real

Alarm dead-band.

{lowlim...higlim}

15

0
This value (expressed in engineering
units) defines a dead-band below the
None
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.

Character
1

ALARMDB

Optional

See Note 1 at the end of the table.

9AKK101130D1382

149

Table 38. Analog Tag Alarm Option Parameters.


Format
Width
Opt/Mnd

Name
LIMITDB

Real

Instrument dead-band.

15

0
This value (expressed in engineering
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.

Optional

VIOL_CD

Range
Default
Parameter(s)

Description

Integer

Instrument violation action code.

{0, 1, 2}

This field determines the value to store


into the realtime database when an
instrument limit violation occurs. The
table below lists allowed codes and the
action on the realtime database:

Optional

None

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}

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


second consecutive instrument limit
None
violation.

Optional

Note 1:
In the range boxes, values of lowlim and higlim are defined by the
general formulas:
lowlim

150

= VAL0

9AKK101130D1382

higlim

= VAL0 + SPAN

Values of VAL0 and SPAN are defined in the alarm level definition subsection.
When defining the alarm dead-band be sure the value does not exceed
the absolute difference between two consecutive alarm levels.

Alarm Comment Parameters


The fields in Table 39 allow linking or referencing descriptive texts to be
associated to alarm conditions of the tag.
Either a 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 chapter for more information about
the contents of these fields. Refer to the analogue 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).

9AKK101130D1382

151

Table 39. Analog Tag Alarm Comment Parameters.


Format
Width
Opt/Mnd

Name
ALRMCMNT3

ALRMCTXT3

ALRMCMNT4

ALRMCTXT4

ALRMCMNT5

ALRMCTXT5

ALRMCMNT6

ALRMCTXT6

152

Integer

Range
Default
Parameter(s)

Description
Low alarm comment index.

{1...100}

Optional

[mxalcm]

Character

Low alarm comment text.

<string>

80

<blank>

Optional

[szalcm]

Integer

2-high alarm comment index.

{1...100}

Optional

[mxalcm]

Character

2-high alarm comment text.

<string>

80

<blank>

Optional

[szalcm]

Integer

2-low alarm comment index.

{1...100}

Optional

[mxalcm]

Character

2-low alarm comment text.

<string>

80

<blank>

Optional

[szalcm]

Integer

3-high alarm comment index.

{1...100}

Optional

[mxalcm]

Character

3-high alarm comment text.

<string>

80

<blank>

Optional

[szalcm]

9AKK101130D1382

Table 39. Analog Tag Alarm Comment Parameters.


Format
Width
Opt/Mnd

Name
ALRMCMNT7

ALRMCTXT7

ALRMCMNT8

ALRMCTXT8

ALRMCMNT9

ALRMCTXT9

ALRMCMNT10

Integer

3-low alarm comment index.

Optional

[mxalcm]

Character

3-low alarm comment text.

<string>

80

<blank>

Optional

[szalcm]

Integer

High deviation alarm comment index.

{1...100}

Optional

[mxalcm]

Character

High deviation alarm comment text.

<string>

80

<blank>

Optional

[szalcm]

Integer

Low deviation alarm comment index.

{1...100}

Optional

[mxalcm]

Character

Low deviation alarm comment text.

<string>

80

<blank>

Optional

[szalcm]

Integer

Increasing rate of change comment


index.

Optional

9AKK101130D1382

{1...100}

5
ALRMCTXT10

Range
Default
Parameter(s)

Description

Character

{1...100}
0
[mxalcm]

Increasing rate of change comment text.

<string>

80

<blank>

Optional

[szalcm]

153

Table 39. Analog Tag Alarm Comment Parameters.


Format
Width
Opt/Mnd

Name
ALRMCMNT11

Integer
5
Optional

ALRMCTXT11

Character

Range
Default
Parameter(s)

Description
Decreasing rate of change comment
index.

{1...100}
0
[mxalcm]

Decreasing rate of change comment text. <string>

80

<blank>

Optional

[szalcm]

Network Parameters
Fields of this sub-section apply to both analog and digital tags. Refer to the
analogue sub-section of generic tag definition for details.

OPC Parameters
Fields of this sub-section apply to both analog and digital tags. Refer to the
analogue sub-section of generic tag definition for details.

Totalization Parameters
The fields in Table 40 allow definition of analog totalizations associated to
the analog tag. They are meaningful only if the TOT_LOG field is defined as
non zero value (i.e. a totalization has been associated to the tag).

154

9AKK101130D1382

Table 40. Analog Tag - Totalization Parameters.


Format
Width
Opt/Mnd

Name
ENELOST

ENEBAD

ENEEUINDEX

Integer

Lost samples management code.

1
Optional

When 1 the lost samples management is 0


active.
None

Integer

Bad samples management code.

1
Optional

When 1 the bad samples management is 0


active.
None

Integer

Engineering unit index.

{-1, 0 ...127}

This is a reference to the coding of


engineering units.

-1

Optional
ENELOSC1M

Real
15

Low scale value for 1 minute analog


totalization.

Optional
ENELOSC10M

Real
15
Real
15

Low scale value for 10 minute analog


totalization.

Real
15

Low scale value for 30 minute analog


totalization.

Real
15
Optional

9AKK101130D1382

[mxeutx]
0

0
None

Low scale value for 1 hour analog


totalization.

Optional
ENELOSC8H

{0, 1}

None

Optional
ENELOSC1H

{0, 1}

None

Optional
ENELOSC30M

Range
Default
Parameter(s)

Description

0
None

Low scale value for 8 hours analog


totalization.

0
None

155

Table 40. Analog Tag - Totalization Parameters.

Name
ENELOSCDAY

Format
Width
Opt/Mnd
Real
15

Low scale value for 1 day analog


totalization.

Optional
ENELOSCMON

Real
15
Real
15

Low scale value for 1 month analog


totalization.

Real
15

Low scale value for 1 year analog


totalization.

Real
15

High scale value for 1 minute analog


totalization.

Real
15

High scale value for 10 minute analog


totalization.

Real
15

High scale value for 30 minute analog


totalization.

Real
15
Optional

156

0
None

High scale value for 1 hour analog


totalization.

Optional
ENEHISC8H

0
None

Optional
ENEHISC1H

0
None

Optional
ENEHISC30M

0
None

Optional
ENEHISC10M

0
None

Optional
ENEHISC1M

0
None

Optional
ENELOSCYEA

Range
Default
Parameter(s)

Description

0
None

High scale value for 8 hours analog


totalization.

0
None

9AKK101130D1382

Table 40. Analog Tag - Totalization Parameters.

Name
ENEHISCDAY

Format
Width
Opt/Mnd
Real
15

High scale value for 1 day analog


totalization.

Optional
ENEHISCMON

Real
15
Real
15

High scale value for 1 month analog


totalization.

Real
15

High scale value for 1 year analog


totalization.

Real
15

Rescale factor for 1 minute analog


totalization.

Real
15

Rescale factor for 10 minute analog


totalization.

Real
15

Rescale factor for 30 minute analog


totalization.

Real
15
Optional

9AKK101130D1382

0
None

Rescale factor for 1 hour analog


totalization.

Optional
ENERESC8H

0
None

Optional
ENERESC1H

0
None

Optional
ENERESC30M

0
None

Optional
ENERESC10M

0
None

Optional
ENERESC1M

0
None

Optional
ENEHISCYEA

Range
Default
Parameter(s)

Description

0
None

Rescale factor for 8 hours analog


totalization.

0
None

157

Table 40. Analog Tag - Totalization Parameters.


Format
Width
Opt/Mnd

Name
ENERESCDAY

Real
15

Rescale factor for 1 day analog


totalization.

Optional
ENERESCMON

Real
15
Real
15

0
None

Rescale factor for 1 month analog


totalization.

0
None

Optional
ENERESCYEA

Range
Default
Parameter(s)

Description

Rescale factor for 1 year analog


totalization.

Optional

0
None

Device Status Parameters


Fields of this sub-section apply to digital tags only.

Documentation Parameters
The fields in Table 41 allow linking tag conditions and documentation.
Currently, PGP does not manage these fields, but they may be loaded in the
tag database for a future use.
Refer to the analogue sub-section of the generic tag definition for additional
fields.

158

9AKK101130D1382

Table 41. Analog Tag Documentation Parameters.


Format
Width
Opt/Mnd

Name
ALMDLA

Integer

Range
Default
Parameter(s)

Description
Reference to low alarm documentation

5
Optional
ALMDHH

Integer

Reference to 2 high alarm documentation

5
Optional
ALMDLL

ALMDSH

ALMDSL

ALMDHD

Integer

Reference 2 low alarm documentation

Optional

None

Integer

Reference to 3 high alarm documentation

Optional

None

Integer

Reference 3 low alarm documentation

Optional

None

Integer
5

Reference to high deviation alarm


documentation

Optional
ALMDLD

Integer
5
Optional

9AKK101130D1382

0
None

Reference to low deviation alarm


documentation

0
None

159

Table 41. Analog Tag Documentation Parameters.


Format
Width
Opt/Mnd

Name
ALMDHR

Integer
5

Reference to increasing rate of change


documentation

Optional
ALMDLR

Integer
5

Range
Default
Parameter(s)

Description

0
None

Reference to decreasing rate of change


documentation

0
None

Optional

Hardware Description Parameters


The descriptive fields in Table 42 define some additional information about
the source of analog tags. Refer to the analogue section of the generic tag
for other hardware description fields.
The on-line configuration does not provide a Tab page for hardware
description parameters.
Table 42. Analog Tag - Hardware Description Parameters.
Format
Width
Opt/Mnd

Name
INSTR_TYPE

Range
Default
Parameter(s)
<string>

Character

Instrument type.

This field describes the electrical range of <blank>


the signal and the relevant E.U.
None
conversion type. See Appendix A for the
valid instrument types.

Optional

160

Description

9AKK101130D1382

Table 42. Analog Tag - Hardware Description Parameters.


Format
Width
Opt/Mnd

Name
JBOX

Character

RTD_COMP

Description
Thermocouple junction box

Range
Default
Parameter(s)
<string>

<blank>

Optional

None

Character
14
Optional

Identifier of the compensation thermoresistance for thermocouple.

<string>
<blank>
None

Application Parameters
Fields of this sub-section apply to both analog and digital tags. Refer to the
analogue sub-section of generic tag definition for details.

Alarm Comments
Outline
Alarm comments are descriptive texts associated with all possible alarm
conditions of analog and digital tags.
These texts are collected into a dedicated 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 PGP 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.

9AKK101130D1382

161

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

Alarm Comment Definition


To configure alarm comments, select the entry in the alarm comment table
and double-click. A data entry dialog allows entering the text.
Table 43. Alarm Comment - Definition Parameters.
Format
Width
Opt/Mnd

Name
ALARMINDEX

ALARMTEXT

Integer

Range
Default
Parameter(s)

Description
Alarm comment index.

{1...100}

Mandatory

[mxalcm]

Character

Alarm comment text.

<string>

80

<blank>

Mandatory

[szalcm]

Engineering Units
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 dedicated 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 PGP
(if it is a different one) for final download.

162

9AKK101130D1382

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

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.
Table 44. Engineering Unit - Definition Parameters.
Format
Width
Opt/Mnd

Name
EUDINDEX

EUDTEXT

9AKK101130D1382

Integer

Range
Default
Parameter(s)

Description
Engineering unit index.

{1...127}

Mandatory

[mxeutx]

Character

Engineering unit text.

<string>

16

<blank>

Mandatory

[sztags]

163

Logic State Descriptors


Outline
A logic state descriptor may be associated to a digital tag. The logic state
descriptor is a descriptive text used to clearly identify the status represented
by the value of digital tags.
Depending on the number of bits used to represent and store the digital tag
multiple logic state descriptors are used.
These texts are usually collected into a dedicated 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 PGP
(if it is a different one) for final download.
Digital tags will internally refer logic state descriptors by their index.
When defining the tag database, the text of logical state descriptors must be
defined. The logical state descriptor file will be filled when tag database is
processed to add missing elements.
A non-existing text will be added in the first free location of the logical state
descriptor database, and an index will be assigned to it. After a new text has
been added, all digital tags using the same text will point to the same
location of logical state description database.
This section describes the structure of Logic State Descriptors Database.

Logic State Descriptors Definition


To configure logical state descriptors, select the entry in the logical state
descriptor table and double-click. A data entry dialog allows entering the
text.

164

9AKK101130D1382

Table 45. Logic State Descriptor - Definition Parameters.


Format
Width
Opt/Mnd

Name
LSDINDEX

Integer

LSDTEXT

Range
Default
Parameter(s)

Description
Logic state descriptor index.

{0...511}

Mandatory

[mxlstx] and [n.tagt]

Character

Logic state descriptor text.

<string>

16

<blank>

Mandatory

[sztags]

Text Selector
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 dedicated 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 PGP
(if it is a different one) for final download.
This section describes the structure of Text Selector Database.

Text Selector Definition


To configure text selectors, select the entry in the text selector table and
click two times. A data entry dialog allows entering the text.

9AKK101130D1382

165

Table 46. Text Selector - Definition Parameters.


Format
Width
Opt/Mnd

Name
TEXTSINDEX

TEXTSTEXT

166

Integer

Range
Default
Parameter(s)

Description
Text selector index.

{0...9999}

Mandatory

[mxtxts]

Character

Text selector string.

<string>

80

<blank>

Mandatory

[sztxts]

9AKK101130D1382

Alarm Management Subsystem


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.

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, OJ (Operations Journal) 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. The configuration of color/blink
override can be found in Color/Blink Override on page 367.

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 PGP (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 PGP internal database structures following the directives
given by a field assignment cross-reference file, previously processed by
builder program DBXRF.

9AKK101130D1382

167

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 PGP internal database.
If a target database does not exist, the builder processor creates it using the
whole PGP 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.

Alarm Group Definition


The following sub-sections list parameters to define and structure alarm
groups. There are both mandatory and optional parameters. Additional
fields are listed in the specific sections following this one.

General Parameters
The fields in Table 47 define the name and other additional parameters
used to identify the alarm group.
Table 47. Alarm Groups General Parameters.

Name
ALMINDEX

Format
Width
Opt/Mnd

Range
Default
Parameter(s)
{0, 1...272}

Integer

Alarm group index.

This field identifies the alarm group by 0


number. It must be unique for each
[mxclbk]
alarm group in the database. If omitted
or zero (blank), the first vacant index
will be allocated.

Optional

168

Description

9AKK101130D1382

Table 47. Alarm Groups General Parameters.


Format
Width
Opt/Mnd

Name
ALMNAME

Integer

Description
Alarm group name.

Range
Default
Parameter(s)
<string>

20

This must be a unique name within the <blank>


Mandatory alarm group database.
[sznam]
ALMDESC

Character

Alarm group description.

<string>

64

The description is used to identify the


alarm group in the alarm group tree.

<blank>

Optional

[szdesc]

Grouping Parameters
The fields in Table 48 define the level of an alarm group within the tree
structure and the sub-groups belonging to the alarm group.

9AKK101130D1382

169

Table 48. Alarm Groups Grouping Parameters.

Name
ALMLEVEL

Format
Width
Opt/Mnd
Integer

Range
Default
Parameter(s)

Description

{0,1...99}

Alarm sub-page level.

It identifies the level of the sub-page


Mandatory hierarchy in the alarm sub-page being
defined.

Character

<string>

ALMLIST

Alarm list.

254

The alarm list includes the alarm


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

None

<blank>
None

Legal alarm attributes are shown in


Table 49
Alarm attribute and group (sub-group)
numbers are separated by a comma. A
semicolon ends the alarm list.
See Note 1 below for an example of
alarm list definition.
FILENAME

Character
254
Optional

Specification of an ASCII file containing <string>


the alarm list.
<blank>
See Note 1 below for an example of
None
alarm list file definition.

Table 49. Alarm Attributes.


Attribute

Description

UNACKD

Unacknowledged alarms.

ALMTYP

Alarm type.

ITMTYP

Item type.

170

9AKK101130D1382

Table 49. Alarm Attributes.


Attribute

Description

ALMGRP

Alarm group.

ALMPRI

Alarm priority.

Note 1:
Basically, there are two methods for specifying alarm lists. Either an external
file or a internal alarm list can be used.
Alarm list
The alarm list is directly included in the alarm group database file. A field
defines all sub-groups.
The alarm list is a sequence of group definitions (a comma is the separator
between alarm sub-groups) prefixed by the alarm attribute.
An example of alarm list is the following:
ALMGRP, 17,18,19,20,21,22,23,24,25;
This method can be used when the tag list does not exceed the maximum of
254 characters (upper limit for Dbase III/IV fields).
Alarm list file
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.

9AKK101130D1382

171

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 PGP .
If a alarm group configuration refers to a 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

Security Parameters
The fields in Table 50 define the security parameters of the alarm group.
Security parameters control the access to alarm pages. Only authorized
users can gain access.

172

9AKK101130D1382

Table 50. Alarm Groups Security Parameters.

Name

Format
Width
Opt/Mnd

Description

Range
Default
Parameter(s)

SEC_LEVEL

Integer

Security level.

{0, 1...16}

This field is checked whenever an user 0


attempts to access the alarm group.
None
Only users whose security level is
greater or equal to what's hereby
defined are enabled to access the
alarm group.

Optional

SEC_GROUP

{0, 1...32}

Integer

Security group.

This field is checked whenever an user 0


attempts to access the alarm group.
None
Only users whose security group mask
includes what's hereby defined are
enabled to access the alarm group.

Optional

Additional Parameters
The fields in Table 51 define other additional parameters of the alarm group.

9AKK101130D1382

173

Table 51. Alarm Groups Additional Parameters.

Name

Format
Width
Opt/Mnd

Description

ALMSUMMTYP

Integer

Alarm summary type.

3
Optional

This field specifies a processing option 0


type for the digital output.
none

Character

Summary action tag name.

20

This field specifies the name of a valid <blank>


tag that is maintained updated with the [sznam]
current summary status. Typically, this
field is used to specify a digital output
tag that alarms external annunciators
or horns.

ALMSUMMTAG

Optional

PRIMDISP

Range
Default
Parameter(s)

<string>

<string>

Character

Primary display name.

80

This field specifies the name of a mimic <blank>


display that can be associated to this
None
alarm summary group and that can be
called by acting on the corresponding
alarm summary tile.

Optional

Audible Alarms
Outline
The audible alarm defines the tones PGP uses to notify alarms to the
operator. An audible can be played by the computer or played by horns
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 PGP application
(if it is a different one) for final download. Tags will refer to audible tones by
index.

174

9AKK101130D1382

Audible Alarms Definition


The on-line configuration does not provide data entry for audible tones.
Table 52. Audible Alarm - Definition Parameters.
Format
Width
Opt/Mnd

Name
AUDINDEX

AUDCODE

Integer

Range
Default
Parameter(s)

Description
Audible index.

{0...32}

Mandatory

[mxaud]

Integer

Audible code.

{0...4}

Valid codes are

Mandatory

0 = No sound,

None

1 = Beep sound,
2 = Wave file sound (continuous),
3 = Wave file sound (single shot),
4 = horn activation via RCM tag.
AUDFILE

Character

Audible wave file name.

<string>

64

It is meaningful when AUDCODE is 2 or 3.

<blank>

Optional

The wave file must be located within the

[szdesc]

\Config\Sound folder.
AUDRCM

9AKK101130D1382

Character

RCM tag name.

<string>

20

It is meaningful when AUDCODE is 4.

<blank>

Optional

The RCM tag must be defined within the tag [sznam]


database and must refer to a physical horn.

175

Calculation Subsystem
Calculations
Outline
The PGP 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.

Calculation example
As an example, let consider a user wishes 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.
Assume 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.

176

9AKK101130D1382

D001 -Calculated digital tag used for alarming purposes.


All tags involved in calculations must be defined by the tag database
configuration. See sections on tag database for 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
}
/************************************************/

9AKK101130D1382

177

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.

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 application PGP (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 PGP 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 PGP internal database.
If a target database does not exist, the builder processor creates it using the
whole PGP 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 calculation or may be a full
or partial database file. It must contain all (and only) fields to be exported.

Calculation Definition
General Parameters
The fields in Table 54 define the name and other additional parameters
used to identify the calculation and to give an explicit reference to the
process.
The last four fields in Table 54 are not included within the Tab of general
parameters.

178

9AKK101130D1382

Table 53. Calculation General Parameters.

Name

Format
Width
Opt/Mnd

Description

Range
Default
Parameter(s)

CALCINDEX

Integer

Calculation block index.

{0, 1...300}

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.

Calculation block name.

<string>

This field is a unique identifier of the


Mandatory calculation.

<blank>

Character

<string>

Optional

CALCNAME

Integer
20

CALCDESC

CALCINACT

NOSLAVE

Calculation block description.

[mxclbk]

[sznam]

64

<blank>

Optional

[szdesc]

Character

Deactivate flag.

{Y, N}

If set, the calculation block will be


initially set to inactive.

Optional
Character

Deactivate on secondary master flag.

{N, Y}

If set, the calculation block will be only


executed on the primary master in a
multi-master PGP architecture.

Optional

None

None

Log Parameters
The fields in Table 54 allow defining logs for operator actions and generic
information.
The on-line configuration does not provide a data entry Tab for such fields.

9AKK101130D1382

179

Table 54. Calculation Log Parameters.

Name

Format
Width
Opt/Mnd

Description

PR_OPACT

Character

Print flag for operator action messages. {Y, N}

If set, database modifications and all


other operator actions concerning this
calculation will be printed on alarm
printer(s).

Optional

Character

Print flag for information messages

{Y, N}

If set, information concerning this


calculation will be printed.

Save flag for operator action


messages.

{Y, N}

Optional

If set, information concerning this


calculation will be logged to the
Operator Journal file.

None

Character

Save flag for information messages

{Y, N}

If set, information concerning this


calculation will be logged to the
Operator Journal file.

PR_INFO

Optional
SV_OPACT

Character
1

SV_INFO

Optional

Range
Default
Parameter(s)

None

None
N

None

Frequency Parameters
The fields in Table 55 define the basic information to perform the
calculation.

180

9AKK101130D1382

Table 55. Calculation - Frequency Parameters.


Format
Width
Opt/Mnd

Name
CALCFRQ

CALCUNITS

Range
Default
Parameter(s)

Description

Integer

Calculation period.

{1...9999}

This field defines the timing of the


calculation. See the CALCUNITS field
also.

Mandatory
Integer

Calculation period unit.

{0...3}

This field qualifies the CALCFREQ field


assigning a time unit.

Mandatory

None

None

See Appendix A for the allowed time


units.
OFFSET

{1...9999}

Integer

Calculation offset.

0
This field defines a delay added to the
execution time of the calculation. See the None
OFFSUNITS field also. Calculation offset
must always be less than calculation
period.

Optional

See Note 1 at the end of the table.


OFFSUNITS

Integer

Calculation offset unit.

{0...3}

This field qualifies the OFFSET field


assigning a time unit.

Optional

None

See Appendix A for the allowed time


units.

9AKK101130D1382

181

Table 55. Calculation - Frequency Parameters.


Format
Width
Opt/Mnd

Name
SAMPLFRQ

Integer

Sampling period.

{0...99999}

Sampling period is used and must be


defined when the 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.

Integer

Sampling period unit.

{0...3}

See Appendix A for the allowed time


units.

Optional

SAMPLUNITS

Range
Default
Parameter(s)

Description

Optional

None

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.

Formula File Parameters


The field in the Table 56 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.

182

9AKK101130D1382

Table 56. Calculation Formula File Parameters.


Name

Format

CALCFILE

Description

Range

Width

Default

Opt/Mnd

Parameter(s)

Character
254
Mandatory

Source file specification for the


calculation block.

<string>

<blank>
The full path allows locating the source
None
file anywhere. Usually source calculation
files are allocated within the
\PGP\Config\Calc folder.

Network Parameters
The fields in Table 57 refer to PGP network communication subsystem.
They are used when multiple PGP 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 Nodes database for
details.

9AKK101130D1382

183

Table 57. Calculation Network Parameters.


Format
Width
Opt/Mnd

Name
CNFNODMSK

Destination node mask for calculation


configurations.

Sequence {Y, N}

Optional

First bit refers to node 1 in the node


definition, second bit refers to node 2,
and so on.

None

Character

Destination node mask for calculation


configurations.

Sequence {Y, N}

Destination node mask for calculation


configurations.

Sequence {Y, N}

Destination node mask for calculation


configurations.

Sequence {Y, N}

Character
16

CNFNODMS2

16
Optional
CNFNODMS3

Character
16
Optional

CNFNODMS4

Range
Default
Parameter(s)

Description

Character
16
Optional

16*N

16*N
The mask applies to nodes from 17 to 32. None
16*N
The mask applies to nodes from 33 to 48. None
16*N
The mask applies to nodes from 49 to 64 None

Macro Function Parameters


The fields in Table 58 apply to macro function definition only.
Table 58. Calculation Macro Function Parameters.

Name

Format
Width
Opt/Mnd

NUMPAR

Integer
3
Optional

184

Description
Number of parameters of the macro
function.
This field is used in the macro function
definition only.

Range
Default
Parameter(s)
0
None

9AKK101130D1382

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 may be used to make the expressions more
readable. Parentheses may be used anywhere to affect the order of
calculation.

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.

Operands
Operands are numbers, tag names, internal variables, constant names,
functions or macros.
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.

9AKK101130D1382

185

Tag Names
Tag names are used in the calculation blocks to represent values from the
realtime Database. Tag name may be up to 20 character 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.
Internal Variables or Constants
The calculation packages allows the definition of internal variables that may
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.
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.
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.

186

9AKK101130D1382

Comments
Comments may be placed anywhere to make the calculation block definition
more readable. The calculation processor recognizes the following
delimiters as comment:
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.
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.
C++ like comments
The characters following // (double slash) until the end of the line are
treated as comments.

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 to fit the statement on more then one line in
the formula file.
A couple of % characters allows 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)
{
.......

9AKK101130D1382

187

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

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 will be 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 may represent analog and
digital values. For example, 5.6 may be a constant analog value; VAR may
be a variable analog value if VAR is an internal variable and PV-TAG may
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.

188

9AKK101130D1382

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-toleft, according to the Table 59.
Table 59. Calculation - Operator Priorities.
Operator

Priority

Order

OR

Left to Right

AND

Left to Right

NOT

Left to Right

<, ==, >, <=, !=, >=

Left to Right

+, -

Left to Right

*, /

Left to Right

*, /

Right to Left

- (prefix)

Left to Right

Parentheses
Parentheses may 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 59.
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 Table 60 lists the arithmetic operands.
Operands are numeric entities.

9AKK101130D1382

189

Table 60. Calculation - Arithmetic Operators.


Operator
+

Description
The plus (+) is the addition operator.

Syntax
<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>

It raises the first operand to the power indicated


by the second operand. The second operand
can be an integer or a real value.

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. Table 61 lists the logic operands.

190

9AKK101130D1382

Table 61. Calculation - Logical Operators.


Operator
AND

Description

Syntax

The AND operator returns the value 1 when both <calc> = <dig_1> AND <dig_2>
arguments 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 true (not equal to zero).

<calc> = <dig_1> OR <dig_2>

If both arguments are false (zero) it returns zero.


NOT

The NOT operator returns the value 1 if


argument is false (zero).

<calc> = NOT <dig_1>

If argument is true (not equal zero) it returns


zero.

9AKK101130D1382

191

Relational operators
Relational operators compare two values. They return 1 if the relation is
true, 0 if the relation is false. Table 62 lists the relational operators.
Table 62. Calculation - Relational Operators.
Operator

Description

Syntax

<

The < (less than) operator gives a true result if the ( <ana_1> < <ana_2> )
first operand is less than the second.

==

The == (equal to) operator gives a true result if its


operand are equal.

( <ana_1> == <ana_2> )

>

The > (greter than) operator gives a true result if


the first operand is greater than the second.

( <ana_1> > <ana_2> )

<=

The <= (less than or equal to) operand gives a true ( <ana_1> <= <ana_2> )
result if the first operand is less than or equal to the
second.

!=

The != (not equal to) operator gives a true result if


operands are not equal.

( <ana_1> != <ana_2> )

>=

The >= (greater than or equal to) operator gives a


true result if the first operand is greater than or
equal to the second.

( <ana_1> >= <ana_2> )

192

9AKK101130D1382

Control Structures
Two control structures are available to calculation subsystem: IF-THENELSE 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.
C like syntax
IF (expression_0)
{
expression_1_1
expression_2_1
....
expression_N_1
}
ELSE
{
expression_1_2

9AKK101130D1382

193

expression_2_2
....
expression_N_2
}

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 continue 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.
C like syntax

194

9AKK101130D1382

WHILE (expression_0)
{
expression_1
expression_2
....
expression_N
}

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.
Be sure to avoid such cases carefully checking the main clause.
IF-THEN-ELSE and WHILE-DO structures can be nested. That is, the THEN
and the ELSE clause may include IF-THEN-ELSE and WHILE-DO
structures, the WHILE-DO body may include IF-THEN-ELSE and WHILEDO 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.

9AKK101130D1382

195

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> =
<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 will be 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,

196

9AKK101130D1382

<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 may represent analog
(<analog_n>) and digital (<digital_n>) values. For example, 5.6 is a constant
analog value; VAR may be a variable analog value if VAR is an internal
variable and PV-TAG may be an analog value represented by the current
value of the tag PV-TAG in the database.

Execution Functions
These functions affect the algorithm execution of a calculation.
Table 63. Calculation - Execution Functions.
Function
EXITCALC

Description
The function forces exit from the
calculation block.

Syntax

Eng. Unit

<calc> =
EXITCALC
(Input variables
End Variables)

9AKK101130D1382

197

Logical Functions
These functions perform logical calculations. They are an optimization of the
basic logical operators AND and OR.
Table 64. Calculation - Logical Functions.
Function
F_AND

Description

Syntax

Eng. Unit

<digital> =
The function returns the value 1 when
arguments are true (not equal to zero). If F_AND
one argument is false (zero) it returns
(Input variables
zero.
<digital_1>,
A variable number of arguments can be
<digital_2>,
passed to the function and only good
.......................
quality values are taken into account.
A maximum of 99 input parameters can <digital_n>
be defined.
End Variables)

F_OR

<digital> =
The function returns the value 1 when
one argument is true (not equal to zero). F_OR
If both arguments are false (zero) it
(Input variables
returns zero.
<digital_1>,
A variable number of arguments can be
<digital_2>,
passed to the function and only good
.......................
quality values are taken into account.
A maximum of 99 input parameters can <digital_n>
be defined.
End Variables)

198

9AKK101130D1382

Mathematical Functions
These functions perform mathematical calculations. They are typical
mathematical functions.
Table 65. Calculation - Mathematical Functions.
Function
ABS

Description
The function returns the absolute
value of a number.

Syntax

Eng. Unit

<calc> =
ABS
(Input variables
<analog>
End Variables)

ACOS

The function computes the inverse


cosine (arc cosine) of an angle.

<calc> =
ACOS
(Input variables
<angle>

rad

End Variables)
ASIN

The function computes the inverse


sine (arc sine) of an angle.

<calc> =
ASIN
(Input variables
<angle>

rad

End Variables)
ATAN

The function calculates the inverse


tangent (arc tangent) of an angle.

<calc> =
ATAN
(Input variables
<angle>

rad

End Variables)

9AKK101130D1382

199

Table 65. Calculation - Mathematical Functions.


Function
AVR

Description

Syntax

The function returns the average


value of n values.

<calc> =

A maximum of 99 input parameters


can be defined.

(Input variables

Eng. Unit

AVR
<analog_1>,
<analog_2>,
.......................
<analog_n>
End Variables)

COS

The function computes the cosine of <calc> =


an angle.
COS
(Input variables
<angle>

rad

End Variables)
EXP

The function returns the value 'e'


raised to the power specified by the
argument.
The value of 'e' is 2.7182818, the
base of natural logarithms.

INT

The function returns the integer part


of a real number.

<calc> =
EXP
(Input variables
<analog>
End Variables)
<integer part> =
INT
(Input variables
<real number>
End Variables)

200

9AKK101130D1382

Table 65. Calculation - Mathematical Functions.


Function
INTERP

Description
The function computes the
interpolation of pair of values in a
table.
The interpolation value is the entry
within the table. Pairs must be
ordered in increasing order of Xi
elements.

Syntax

Eng. Unit

<calc> =
INTERP
(Input variables
<interpolation value>,
X1, Y1, ... , Xn, Yn
End Variables)

A maximum of 99 input parameters


can be defined.
LN

The LN function computes the


natural logarithm of a number.
Natural logarithms are calculated
using 'e' = 2.71822818 as a base.
The number must be positive.

<calc> =
LN
(Input variables
<positive real>
End Variables)

LOG10

The function computes the logarithm <calc> =


of a number.
LOG10
The base for the calculation is the
(Input variables
value 10. The number must be
<positive real>
positive.
End Variables)

MAX

The function returns the maximum


among n values.

<calc> =

A maximum of 99 input parameters


can be defined.

(Input variables

MAX
<analog_1>,
.......................
<analog_n>
End Variables)

9AKK101130D1382

201

Table 65. Calculation - Mathematical Functions.


Function
MIN

Description

Syntax

The function returns the minimum


among n values.

<calc> =

A maximum of 99 input parameters


can be defined.

(Input variables

Eng. Unit

MIN
<analog_1>,
.......................
<analog_n>
End Variables)

PIGREEK

The function return the value


3.14159.

<calc> =
PIGREEK
(Input variables
End Variables)

SIGN

SIN

The function returns a representation


of the numerical sign of its argument.
If its argument is negative, the
function returns 1. If the argument is
zero, it returns 0. If the argument is
positive, it returns 1.

<calc> =
SIGN
(Input variables
<analog>
End Variables)

The function computes the sine of an <calc> =


angle.
SIN
(Input variables
<angle>

rad

End Variables)
SQR

The function returns the square root


of the argument.

<calc> =
SQR
(Input variables
<analog>
End Variables)

202

9AKK101130D1382

Table 65. Calculation - Mathematical Functions.


Function
TAN

Description
The function returns the tangent of
an angle.

Syntax

Eng. Unit

<calc> =
TAN
(Input variables
<angle>

rad

End Variables)
VALMAX

The function returns the maximum


among n values.

<calc> =

It is an optimization of the MAX


function and take care of the good
quality samples only. Bad values are
discharged, then the maximum is
evaluated. The quality of the result is
set to good if the percentage of
remaining samples is greater than
the required validity percentage.

(Input variables

VALMAX
<% validity>,
<analog_1>,
.......................
<analog_n>
End Variables)

A maximum of 99 input parameters


can be defined.

9AKK101130D1382

203

Table 65. Calculation - Mathematical Functions.


Function
VALMED

Description

Syntax

The function returns the average


among n values.

<calc> =

It is an optimization of the AVR


function and takes care of the good
quality samples only. Bad values are
discharged. After the mean value has
been computed, all involved samples
are compared to the mean value. A
sample is discharged if it differs more
than the required deviation. Then a
mean 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.

(Input variables

Eng. Unit

VALMED
<% validity>,
<% deviation>,
<analog_1>,
.......................
<analog_n>
End Variables)

A maximum of 99 input parameters


can be defined.
VALMIN

The function returns the minimum


among n values.

<calc> =

It is an optimization of the MIN


function and take care of the good
quality samples only. Bad values are
discharged, then the minimum is
evaluated. The quality of the result is
set to good if the percentage of
remaining samples is greater than
the required validity percentage.

(Input variables

VALMIN
<% validity>,
<analog_1>,
.......................
<analog_n>
End Variables)

A maximum of 99 input parameters


can be defined.

204

9AKK101130D1382

Tag Functions
The functions allow operating on tags and interacting with the configuration
database and the realtime database.
Table 66. Calculation - Tag Functions.
Function
FORCE_APPL1

Description
The function forces the application
bit 1 of a tag, irrespective of the
quality of input tag.

Syntax

Eng. Unit

<tag> =
FORCE_APPL1
(Input variables
<tag>,
<digital>
End Variables)

FORCE_APPL2

The function forces the application


bit 2 of a tag, irrespective of the
quality of input tag.

<tag> =
FORCE_APPL2
(Input variables
<tag>,
<digital>
End Variables)

FORCE_APPL3

The function forces the application


bit 3 of a tag, irrespective of the
quality of input tag.

<tag> =
FORCE_APPL3
(Input variables
<tag>,
<digital>
End Variables)

<tag> =
FORCE_QUALITY The function forces the quality of a
tag, irrespective of the quality of input FORCE_QUALITY
tag.
(Input variables
Value 0 forces good quality, value 1
<tag>,
forces bad quality.
<digital>
End Variables)

9AKK101130D1382

205

Table 66. Calculation - Tag Functions.


Function
DESCR_OR

GETINFO

Description

Syntax

OR function, with variable elements.


Special function which manipulate
descriptions (strings) instead of
values: giving an OR function, the
description of the result is the
chaining of the description of the
single components which are TRUE.

<tag> =

The function returns PGP system


information. System information are
identified by a symbolic code as
defined in the System Parameter
Table (see Appendix A).

<calc> =

Eng. Unit

DESCR_OR
(Input variables
<elem_1>, ... ,<elem_n>,
<qual_1>, ... ,<qual_n>
End Variables)
GETINFO
(Input variables
<system parameter>
End Variables)

GETTAG

The function returns database


configuration parameters of tags.
Configuration parameters are
identified by a symbolic code as
defined in the Configuration
Parameter Table (see Appendix A).

<calc> =
GETTAG
(Input variables
<tag>,
<config. parameter>
End Variables)

SAVEVALUE

206

The function saves a value of a tag <calc> =


as initial value to be restored later at SAVEVALUE
restart time.
(Input variables
The function returns a value 0 (with
<tag>,
quality bad) on failure and a value 1
(with quality good) on success. The <value>
End Variables)
function writes the value in the
realtime database also. Thus, tag
assignment is not required within
calculation.

9AKK101130D1382

Table 66. Calculation - Tag Functions.


Function
SETTAG

Description
The function writes database
configuration parameters of tags.
Configuration parameters are
identified by a symbolic code as
defined in the Configuration
Parameter Table (see Appendix A).

Syntax

Eng. Unit

<calc> =
SETTAG
(Input variables
<tag>,
<config. parameter>,
<parameter value>
End Variables)

TEST_ALARM

The function checks if a tag is in an


alarm condition.

<digital> =

TEST_ALARM
It returns 1 if the tag is alarmed and 0 (Input variables
if not.
<tag>
End Variables)

TEST_INSERTED The function checks if a tag has a


inserted value.
It returns 1 if the tag has inserted
value and 0 if not.

<digital> =
TEST_INSERTED
(Input variables
<tag>
End Variables)

TEST_QUALITY

The function returns the quality of a


tag.

<digital> =

It returns 0 if the tag quality is good


and 1 if the quality is bad.

(Input variables

TEST_QUALITY
<tag>
End Variables)

TEST_UNACKED

The function checks if the tag is to


acknowledge.

<digital> =

It returns 1 if the tag is to


acknowledge and 0 if not.

(Input variables

TEST_UNACKED
<tag>
End Variables)

9AKK101130D1382

207

Table 66. Calculation - Tag Functions.


Function
TEST_APPL1

Description
The function returns the application
bit 1 of the quality tag.

Syntax

Eng. Unit

<digital> =
TEST_APPL1
(Input variables
<tag>
End Variables)

TEST_APPL2

The function returns the application


bit 2 of the quality tag.

<digital> =
TEST_APPL2
(Input variables
<tag>
End Variables)

TEST_APPL3

The function returns the application


bit 3 of the quality tag.

<digital> =
TEST_APPL3
(Input variables
<tag>
End Variables)

208

9AKK101130D1382

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.
Table 67. Calculation - Time Functions.
Function
DAY

Description

Syntax

The function returns the current day


of the month.

<calc> =

The value is in the range 1 to 31.

(Input variables

Eng. Unit

DAY
End Variables)

DAYOFWEEK

The function returns the current day


of the week.

<calc> =

The function returns the current day


of the year.

<calc> =

The value is in the range 1 to 366.

(Input variables

DAYOFWEEK
The value is in the range 0 to 6 and 0 (Input variables
refers to sunday.
End Variables)
DAYOFYEAR

DAYOFYEAR
End Variables)

9AKK101130D1382

209

Table 67. Calculation - Time Functions.


Function
DELTATIME

Description

Syntax

The function returns the difference in <calc> =


seconds between two times (time1 DELTATIME
time2). Integer numbers represent
(Input variables
day, month, year, hour and minute.
<day of time1>,

Eng. Unit
sec

<month of time1>,
<year of time1>,
<hour of time1>,
<minute of time1>,

min

<second of time1>,

sec

<day of time2>,
<month of time2>,
<year of time2>,
<hour of time2>,
<minute of time2>

min

<second of time2>

sec

End Variables)
HOUR

The function returns the current hour <calc> =


of the day.
HOUR
The value is in the range 0 to 23.
(Input variables
End Variables)

JULSEC

The function returns the number of


seconds since a reference date.

<calc> =

The function returns the current


minute of the hour.

<calc> =

The value is in the range 0 to 59.

(Input variables

sec

JULSEC
The reference date is assumed to be (Input variables
January, 1 1991.
End Variables)
MINUTE

min

MINUTE
End Variables)

210

9AKK101130D1382

Table 67. Calculation - Time Functions.


Function
MONTH

Description

Syntax

The function returns the current


month.

<calc> =

The value is in the range 1 to 12.

(Input variables

Eng. Unit

MONTH
End Variables)

SECOND

The function returns the current


second within the minute.

<calc> =

The value is in the range 0 to 59.

(Input variables

sec

SECOND
End Variables)

WEEKOFYEAR

The function returns the current


week of the year.

<calc> =

The value is in the range 1 to 52.

(Input variables

WEEKOFYEAR
End Variables)

YEAR

The function returns the current year. <calc> =


YEAR
(Input variables
End Variables)

9AKK101130D1382

211

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.
Table 68. Calculation - Steam Functions.
Function
CP_at_TP

Description

Syntax

<specific heat> =
The function computes the specific
heat, relative to steam and water, as CP_at_TP
function of temperature and
(Input variables
pressure.
<temperature>,
<pressure>

Eng. Unit
kJ/kg/C

C
bar

End Variables)
DV_at_TP

The function computes the water


viscosity, relative to steam and
water, as function of temperature
and pressure.

<water viscosity> =

kg/s m

DV_at_TP
(Input variables
<temperature>,

<pressure>

bar

End Variables)
H_at_PS

The function computes the enthalpy, <enthalpy> =


relative to steam and water, as
H_at_PS
function of pressure and entropy.
(Input variables

kJ/kg

<pressure>,

bar

<entropy>

kJ/kg C

End Variables)
H_at_TP

The function computes the enthalpy, <enthalpy> =


relative to steam and water, as
H_at_TP
function of temperature and
(Input variables
pressure.
<temperature>,
<pressure>

kJ/kg

C
bar

End Variables)

212

9AKK101130D1382

Table 68. Calculation - Steam Functions.


Function
K_at_TP

Description
The function computes the water
conducibility, relative to steam and
water, as function of temperature
and pressure.

Syntax
<water conducibility> =

Eng. Unit
W/m C

K_at_TP
(Input variables
<temperature>,

<pressure>

bar

End Variables)
P_sat_at_T

Given the temperature, the function


returns the pressure of saturation.

<saturation pressure> =

bar

PSAT_at_T
(Input variables
<temperature>

End Variables)
S_at_PH

The function computes the entropy,


relative to steam and water, as
function of pressure and enthalpy.

<entropy> =

kJ/kg C

S_at_PH
(Input variables
<pressure>,

bar

<enthalpy>

kJ/kg

End Variables)
S_at_TP

The function computes the entropy,


relative to steam and water, as
function of temperature and
pressure.

<entropy> =

kJ/kg C

S_at_TP
(Input variables
<temperature>,

<pressure>

bar

End Variables)

9AKK101130D1382

213

Table 68. Calculation - Steam Functions.


Function
T_at_PH

Description
The function computes the
temperature, relative to steam and
water, as function of pressure and
enthalpy.

Syntax

Eng. Unit
C

<temperature> =
T_at_PH
(Input variables
<pressure>,

bar

<enthalpy>

kJ/kg

End Variables)
T_at_PS

The function computes the


temperature, relative to steam and
water, as function of pressure and
entropy.

<temperature> =
T_at_PS
(Input variables
<pressure>,

bar

<entropy>

kJ/kg C

End Variables)
T_sat_at_P

Given the pressure, the function


returns the temperature of
saturation.

<saturation temp.> =

TSAT_at_P
(Input variables
<pressure>

bar

End Variables)
V_at_TP

<specific volume> =
The function computes the specific
volume, relative to steam and water, V_at_TP
as function of temperature and
(Input variables
pressure.
<temperature>,
<pressure>

m3/kg

C
bar

End Variables)

214

9AKK101130D1382

Gas Property Functions


The functions concern gas properties and apply to various kind of gasses.
They involve temperature, pressure, enthalpy, entropy, molecular weight,
volume and specific heat of gas.
Table 69. Calculation - Gas Property Functions.
Function
CP_GAS

Description
The function computes the specific
heat of a gas as function of the
temperature.

Syntax
<specific heat> =

The function computes the enthalpy


of a gas as function of the
temperature.

<enthalpy> =

9AKK101130D1382

C
nbr
kJ/kg

H_GAS

(Input variables
The gas is defined according to the
<temperature>,
gas table. See Appendix A for the list
<gas index>
of gas indexes.
End Variables)
M_GAS

kJ/kg C

CP_GAS

(Input variables
The gas is defined according to the
<temperature>,
gas table. See Appendix A for the list
<gas index>
of gas indexes.
End Variables)

H_GAS

Eng. Unit

The function computes the molecular <molecular weight>=


weight of a gas.
M_GAS
The gas is defined according to the (Input variables
gas table. See Appendix A for the list
<gas index>
of gas indexes.
End Variables)

C
nbr
kg/Mole

nbr

215

Table 69. Calculation - Gas Property Functions.


Function
S_GAS

Description

Syntax

The function computes the entropy of <entropy> =


a gas as function of temperature and S_GAS
pressure.
(Input variables
The gas is defined according to the
<temperature>,
gas table. See Appendix A for the list
<pressure>,
of gas indexes.
<gas index>

Eng. Unit
kJ/kg C

C
bar
nbr

End Variables)
V_GAS

The function computes the volume of <volume> =


a gas as function of temperature and V_GAS
pressure.
(Input variables
The gas is defined according to the
<temperature>,
gas table. See Appendix A for the list
<pressure>,
of gas indexes.
<gas index>

m3/Kg

C
bar
nbr

End Variables)

216

9AKK101130D1382

Sea Water Functions


The functions concern sea water. They involve temperature, salt
concentration, enthalpy, density, conducibility, 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.
Table 70. Calculation - Sea Water Functions.
Function

Description

SEAW

Syntax

The function computes a property of


the sea water as function of the
temperature and salt concentration.
The property to be returned is
specified by an index as third
parameter.

<property> =

See Table 71 for the list of allowed


properties and the corresponding
returned engineering unit.

Eng. Unit
Table 71

SEAW
(Input variables
<temperature>,

<salt concentration>,

<function index>

nbr

End Variables)

Table 71. Calculation - Sea Water Function Indexes.


Function

Index

Eng. Unit

Enthalpy

kJ/kg

Specific Heat

kJ/kg C

Density

kg/m3

Thermal Conducibility

W/m C

Dynamic Viscosity

kg/s m

9AKK101130D1382

217

Fuel Combustion Functions


The functions listed in Table 72 concern fuel combustion and flue gas, the
functions listed in Table 73 concern fuel combustion and fuel characteristics.
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 PGP.
Refer to the documentation of previous versions for details. The names are
reserved keywords and cannot be used within calculations to define internal
variables.

218

9AKK101130D1382

Table 72. Calculation - Fuel Combustion Functions Based on Flue Gas.


Function
CP_FGAS_T

Description
The function computes the specific
heat of flue gas as function of the
temperature and the flue gas
composition. An index specifies if
flue gas composition is expressed in
weight (index = 0) or volume (index =
1).

Syntax
<specific heat> =

Eng. Unit
kJ/kg C

CP_FGAS_T
(Input variables
<temperature>,

<index>,

nbr

<carbon bi-oxide>,

<oxygen>,

<carbon oxide>,

<sulphur bi-oxide>,
<water>,

%
%

<argon>

End Variables)
H_FGAS_T

The function computes the enthalpy


of flue gas as function of the
temperature and the flue gas
composition. An index specifies if
flue gas composition is expressed in
weight (index = 0) or volume (index =
1).

<enthalpy> =

kJ/kg

H_FGAS_T
(Input variables
<temperature>,

<index>,

nbr

<carbon bi-oxide>,

<oxygen>,

<carbon oxide>,

<sulphur bi-oxide>,

<water>,

<argon>

End Variables)

9AKK101130D1382

219

Table 72. Calculation - Fuel Combustion Functions Based on Flue Gas.


Function
S_FGAS_TP

Description
The function computes the entropy of
flue gas as function of the
temperature, the pressure and the
flue gas composition. An index
specifies if flue gas composition is
expressed in weight (index = 0) or
volume (index = 1).

Syntax
<entropy> =

Eng. Unit
kJ/kg C

S_FGAS_TP
(Input variables
<temperature>,

<index>,

bar

<pressure>,

nbr

<carbon bi-oxide>,

<oxygen>,

<carbon oxide>,

<sulphur bi-oxide>,
<water>,

%
%

<argon>

End Variables)

220

9AKK101130D1382

Table 72. Calculation - Fuel Combustion Functions Based on Flue Gas.


Function
T_FGAS_H

Description
The function computes the
temperature of flue gas as function of
the enthalpy and the flue gas
composition. An index specifies if
flue gas composition is expressed in
weight (index = 0) or volume (index =
1).

Syntax
<temperature> =

Eng. Unit
C

T_FGAS_H
(Input variables
<enthalpy>,

kJ/kg

<index>,

nbr

<carbon bi-oxide>,

<oxygen>,

<carbon oxide>,

<sulphur bi-oxide>,
<water>,

%
%

<argon>

End Variables)
T_FGAS_PS

The function computes the


temperature of flue gas as function of
the pressure, the entropy and the
flue gas composition. An index
specifies if flue gas composition is
expressed in weight (index = 0) or
volume (index = 1).

<temperature> =

T_FGAS_PS
(Input variables
<pressure>,

bar

<entropy>,

kJ/kg C

<index>,

nbr

<carbon bi-oxide>,

<oxygen>,

<carbon oxide>,

<sulphur bi-oxide>,
<water>,

%
%

<argon>

End Variables)

9AKK101130D1382

221

Table 73. Calculation - Combustion Functions Based on Fuel Characteristics.


Function
AIR_MIN

Description
The function computes the
stechiometric air in the fuel as
function of the fuel composition.
The stechiometric air is returned in
kg dry air/kg fuel.

Syntax
<air in fuel>=

Eng. Unit
kg/kg

AIR_MIN
(Input variables
<carbon>,

<hydrogen>,

<sulphur>,

<oxygen>

End Variables)
CP_FCOMB_T

<specific heat> =
The function computes the specific
heat of air and fuel as function of the CP_FCOMB_T
temperature and the fuel
(Input variables
composition.
<temperature>,

kJ/kg C

<carbon>,

<hydrogen>,

<sulphur>,

<oxygen>,

<nitron>,

<dry air/fuel>

kg/kg

End Variables)

222

9AKK101130D1382

Table 73. Calculation - Combustion Functions Based on Fuel Characteristics.


Function
H_FCOMB_T

Description
The function computes the enthalpy
of air and fuel as function of the
temperature and the fuel
composition.

Syntax
<enthalpy> =

Eng. Unit
kJ/kg

H_FCOMB_T
(Input variables
<temperature>,

<carbon>,

<hydrogen>,

<sulphur>,

<oxygen>,

<nitron>,

<dry air/fuel>

kg/kg

End Variables)
S_FCOMB_TP

The function computes the entropy of <entropy> =


air and fuel as function of the
S_FCOMB_TP
temperature and the fuel
(Input variables
composition.
<temperature>,

kJ/kg C

<pressure>,

bar

<carbon>,

<hydrogen>,

<sulphur>,

<oxygen>,

<nitron>,

<dry air/fuel>

kg/kg

End Variables)

9AKK101130D1382

223

Table 73. Calculation - Combustion Functions Based on Fuel Characteristics.


Function
T_FCOMB_H

Description
The function computes the
temperature of air and fuel as
function of the enthalpy and the fuel
composition.

Syntax
<temperature> =

Eng. Unit
C

T_FCOMB_H
(Input variables
<enthalpy>,

kJ/kg

<carbon>,

<hydrogen>,

<sulphur>,

<oxygen>,

<nitron>,

<dry air/fuel>

kg/kg

End Variables)
T_FCOMB_PS

<temperature> =
The function computes the
temperature of air and fuel as
T_FCOMB_PS
function of the pressure, entropy and
(Input variables
the fuel composition.
<pressure>,

bar

<entropy>,

kJ/kg C

<carbon>,

<hydrogen>,

<sulphur>,

<oxygen>,

<nitron>,

<dry air/fuel>

kg/kg

End Variables)

224

9AKK101130D1382

Wet Air Functions


The functions concern wet air. They involve temperature, pressure, absolute
humidity, enthalpy, entropy and specific heat of wet air.
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 PGP.
Refer to the documentation of previous versions for details. The names are
reserved keywords and cannot be used within calculations to define internal
variables.

9AKK101130D1382

225

Table 74. Calculation - Wet Air Functions.


Function
CP_AIR_T

Description
The function computes the specific
heat of wet air as function of the
temperature and absolute humidity.
The absolute humidity is expressed
in kg vapor/kg dry air.

Syntax

Eng. Unit
kJ/kg C

<specific heat> =
CP_AIR_T
(Input variables
<temperature>,

<absolute humidity>

kg/kg

End Variables)
H_AIR_T

The function computes the enthalpy


of wet air as function of the
temperature and absolute humidity.
The absolute humidity is expressed
in kg vapor/kg dry air.
This enthalpy is considered on the
basis of a unit mass of wet air and
zero value for T = 0 C.

kJ/kg

<enthalpy> =
H_AIR_T
(Input variables
<temperature>,

<absolute humidity>

kg/kg

End Variables)

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.

226

9AKK101130D1382

Table 74. Calculation - Wet Air Functions.


Function
S_AIR_TP

Description

Syntax

The function computes the entropy of <entropy> =


wet air as function of the
S_AIR_TP
temperature, pressure and absolute
(Input variables
humidity.
<temperature>,
The absolute humidity is expressed
<pressure>,
in kg vapor/kg dry air.
<absolute humidity>

Eng. Unit
kJ/kg C

C
bar
kg/kg

End Variables)
T_AIR_H

The function computes the


temperature of wet air as function of
the enthalpy and absolute humidity.
The absolute humidity is expressed
in kg vapor/kg dry air.

<temperature> =

T_AIR_H
(Input variables
<enthalpy>,

kJ/kg

<absolute humidity>

kg/kg

End Variables)
T_AIR_PS

The function computes the


temperature of wet air as function of
the pressure, entropy and absolute
humidity.
The absolute humidity is expressed
in kg vapor/kg dry air.

<temperature> =

T_AIR_PS
(Input variables
<pressure>,

bar

<entropy>,

kJ/kg C

<absolute humidity>

kg/kg

End Variables)
WHY

The function computes the


percentage of humidity per kg of dry
air as function of dry bulb
temperature, atmospheric pressure
and measured relative humidity.

<humidity> =
WHY
(Input variables
<dry bulb temp.>,

The temperature is assumed to be in <atmospheric press.>,


the range 10 to 50 C and pressure <relative humidity>
in the range 0.9 to 1.2 bar.
End Variables)

9AKK101130D1382

C
bar
%

227

Data File Functions


The two functions allow operations on PGP database data files. They
interfaces PGP standard data files and specific application data files.
Table 75. Calculation - Data File Functions.
Function

Description

READFILE

Syntax

The function read data from a


specified word of a record in a file.

<calc> =

See Table 76 for the list of allowed


formats.

(Input variables

Eng. Unit

READFILE
<file name>,
<record number>,
<word number>,
<format>
End Variables)

WRITEFILE

The function writes data to a


specified word of a record in a file.

<calc> =

The value to be written is an


parameter to the function.

(Input variables

See Table 76 for the list of allowed


formats.

<record number>,

WRITEFILE
<file name>,
<word number>,
<format>,
<value>
End Variables)

Table 76. Read/Write File Formats.


Number

Description

BYTE

USHORT

SHORT

228

9AKK101130D1382

Table 76. Read/Write File Formats.


Number

Description

UINT

INT

FLOAT

DOUBLE

9AKK101130D1382

229

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.
Table 77. Calculation - Historical Functions.
Function
COUNTER

Description

Syntax

Up/down counter.

<calc> =

The function adds the increment


value to the previous counter value
when the input variable reaches the
threshold value. The increment value
will be > 0 for up counting and < 0 for
down counting.

COUNTER

When the reset flag is set to 1, the


counter is set to the initial value.

<reset flag>,

(Input variables
<pv_tag>,
<threshold value>,
<increment value>,
<initial value>,
3
End Variables)

DELAY

Delay.

<calc> =

The function returns the previous


value of the input.

DELAY

When the reset flag is set to 1, the


function returns the current value of
the input.

<tag>,

(Input variables
<reset flag>,
2
End Variables)

230

9AKK101130D1382

Table 77. Calculation - Historical Functions.


Function
DERIV

Description
Derivative.

Syntax
<calc> =

The function returns the derivative of DERIV


last 4 sampled values according to
(Input variables
the following simplified (based on 4
<pv_tag>,
samples) formula:
4
Vn = ((-3*V3)-V2+V1+(3*Vi))/10*dt
End Variables)
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> =


The time of last event with a given
value is retrieved from the playback
archive (at the moment within the
last hour).

EVENTTIME
(Input variables
<tag>,
<value>
End Variables)

FILT

Filter.

<calc> =

The function returns a filtered value


according to the following formula:

FILT

(Input variables
Vn = Vn1*(tau/(dt+tau)+Vi(dt/(dt+tau) <pv_tag>,
where:
<time constant>,
Vn1 - previous FILT calculated value, <reset flag>,
Vi - current sampled value,
<initial value>
dt - sampling time.

tau - time constant.

End Variables)

When the reset flag is set to 1, the


function is set to the initial value.

9AKK101130D1382

231

Table 77. Calculation - Historical Functions.


Function
GRAD

Description
Gradient.

Syntax
<calc> =

The function returns the gradient of GRAD


two sampled values according to the (Input variables
following formula:
<pv_tag>,
Vn = (Vi - V1) / dt
2
where:
End Variables)
V1 - previous sampled value,
Vi - current sampled value.
dt - sampling time.
H_AVR

Historical average.

<calc> =

The function returns the average of


last sampled values.

H_AVR

If the percentage of samples with a


good quality is greater than the
minimum percentage, the quality of
average is set to good. Elsewhere,
the quality is set to bad.

(Input variables

GRAD
<pv_tag>,
<min. % good>,
<discharge bad flag>,

<number of samples>
Bad samples are discharged if the
discharge flag is set to 0. Elsewhere, End Variables)
they are taken into account in
computing the average.

232

9AKK101130D1382

Table 77. Calculation - Historical Functions.


Function
H_MAX

Description
Historical maximum.

Syntax
<calc> =

The function returns the maximum of H_MAX


last sampled values.
(Input variables
If the percentage of samples with a <pv_tag>,
good quality is greater than the
<min. % good>,
minimum percentage, the quality of
maximum is set to good. Elsewhere, <discharge bad flag>,
<number of samples>
the quality is set to bad.
End Variables)
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> =

The function returns the minimum of H_MIN


last sampled values.
(Input variables
If the percentage of samples with a <pv_tag>,
good quality is greater than the
<min. % good>,
minimum percentage, the quality of
minimum is set to good. Elsewhere, <discharge bad flag>,
<number of samples>
the quality is set to bad.
End Variables)
Bad samples are discharged if the
discharge flag is set to 0. Elsewhere,
they are taken into account in
computing the minimum.

9AKK101130D1382

233

Table 77. Calculation - Historical Functions.


Function
H_SUM

Description

Syntax

Historical sum.

<calc> =

The function returns the sum of last


sampled values.

H_SUM

If the percentage of samples with a


good quality is greater than the
minimum percentage, the quality of
sum is set to good. Elsewhere, the
quality is set to bad.

<pv_tag>,

(Input variables
<min. % good>,
<discharge bad flag>,
<number of samples>

End Variables)
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
The function returns the integral of
last sampled values according to the (Input variables
following formula:
<pv_tag>,
Vn = Vn1 + (Vi * dt)
<reset flag>,
where:
<initial value>,
Vn1 - previous INTEG calculated
3
value.
End Variables)
Vi - current sampled value.
dt - sampling time.
When the reset flag is set to 1, the
function is set to the initial value.

234

9AKK101130D1382

Table 77. Calculation - Historical Functions.


Function
HIST_VAL

Description
Historical value.

Syntax
<calc> =

The function returns the value of the HIST_VAL


tag within an historical group at a
(Input variables
defined time.
<hist group name>,
A negative offset refers to the
<tag>,
preceding sample with respect to the
<day>,
sample identified by the time.
<month>,
A positive offset refers to the next
sample.

<year>,

A null offset refers to the sample


identified by the time.

<hour>,
<minute>,

min

<second>,

sec

<offset>
End Variables)
HIST_WRT

Write Historical value.

<calc> =

The function writes the value of the


tag within an historical group for the
defined time.

HIST_WRT

sample.

<year>,

A null offset refers to the sample


identified by the time.

<hour>,

(Input variables

<hist group name>,


A negative offset refers to the
<tag>,
preceding sample with respect to the
<day>,
sample identified by the time.
<month>,
A positive offset refers to the next

<minute>,

min

<second>,

sec

<offset>,
<value>
End Variables)

9AKK101130D1382

235

Table 77. Calculation - Historical Functions.


Function
HIST_REGR

Description
Historical regression.

Syntax
<calc> =
HIST_REGR
(Input variables
<hist group name>,
<tag>,
<filter tag>,
<filter high value>,
<Filter low value>,
<day>,
<month>,
<year>,
<hour>,
<minute>,

min

<second>,

sec

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

236

9AKK101130D1382

Table 77. Calculation - Historical Functions.


Function
SDEV

Description

Syntax

Standard deviation.

<calc> =

The function returns the standard


deviation value of last sampled
values.

SDEV

If the percentage of samples with a


good quality is greater than the
minimum percentage, the quality of
standard deviation is set to good.
Elsewhere, the quality is set to bad.

(Input variables
<pv_tag>,
<min. % good>,
<discharge bad flag>,
<number of samples>
End Variables)

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> =

The function performs pulsed timing


(timing=0), timed out delay
(timing=1) or timing (timing=2)
functions using the delay time
defined in seconds. See Function
Code 35 for more detailed
information.

TIMER
(Input variables
<pv_tag>,
<timing code>,
<delay>,

sec

2
End Variables)

NUM_ALARM

Number of alarms in an alarm group. <calc> =


The function returns the number of
alarms within an alarm group at the
requested time.

NUM_ALARM
(Input variables

<alarm group number>,


If unacked flag not equal 0, returns
<unacked flag>
the number of alarms to
End Variables)
acknowledge.

9AKK101130D1382

237

Trend Group Subsystem


Trend Groups
Outline
PGP provides an integrated trend group processor for both analog and
digital tags. The trend group package, like all PGP 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.

Examples of Trend Groups


The following is a list of the three classes of trend groups that can be
configured in a PGP 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.

238

9AKK101130D1382

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.

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 application PGP (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 PGP 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 PGP internal database. If a target database does not exist,
the builder processor creates it using the whole PGP 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.

Generic Trend Group Definition


The following sub-sections list parameters to characterize all kind of trend
groups.

9AKK101130D1382

239

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.

General Parameters
The fields in Table 78 define the name and other additional parameters
used to identify and characterize the trend group.
Table 78. Generic Trend Group General Parameters.
Format
Width
Opt/Mnd

Name
GROUPINDEX

GROUPNAME

GROUPUID

GROUPDESC

240

Description

Range
Default
Parameter(s)
{0, 1...100}

Integer

Group index.

6
Optional

This field identifies the group by number. 0


It must be unique for each trend group in [mxhgrp]
the database. If omitted or zero (blank),
the first vacant index will be allocated.

Character

Group name.

<string>

20

<blank>

Mandatory

This field identifies the group by name. It


must be unique for each trend group in
the database.

Character

Trend group unique identification.

<string>

36
Optional

This field provides a unique identification <blank>


within the PGP life cycle.
None
See Note 1 at the end of the table.

Character

Group description.

[sznam]

<string>

64

<blank>

Optional

[szdesc]

9AKK101130D1382

Table 78. Generic Trend Group General Parameters.


Format
Width
Opt/Mnd

Name
EUINDEX

Range
Default
Parameter(s)

Description

{-1, 0 ...127}

Integer

Engineering unit index.

-1
This field defines the index into the
engineering unit database. It can be used [mxeutx]
to assign a unique engineering unit to the
group. It supersedes the engineering
units of the tags belonging to the group.

Optional

The field is not included within the fields


of the on-line configuration Tab.
EUDESC

Character

Engineering unit text.

<string>

16

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.

<blank>

Optional

GROUPCLASS

ARCHTYPE

None

Integer

Class of trend group.

Customer may class trend groups using


this field.

Optional
Character

Type of archiving.

<string>

This parameter qualifies the trend group. <blank>


Depending on the type, the set of
None
parameters required to fully configuring
the group changes.

Mandatory

None

See the Table 79 for the list of all


archiving types.
EXP_VAL

Character
1
Optional

9AKK101130D1382

Relational database update (tag values)


flag.

{Y, N}

If set, tag values will be automatically


sent to the relational database.

None

241

Note 1:
The GROUPUID code is internally generated the first time a group is added
to the PGP 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, an 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
PGP database. An error message will be issued for a duplicate group, since
a new GROUPUID is generated. A PGP 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.
The Table 79 lists all types of trend groups. 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 79. 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.

242

9AKK101130D1382

Table 79. Trend Group - Archiving Types.


Type

Description

Kind

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.

Display Parameters
The fields in Table 80 define some displaying parameters of the trend group.
Table 80. Generic Trend Group Display Parameters.
Format
Width
Opt/Mnd

Name
TIMESPAN

Integer

Default time range for group displaying.

It applies to both realtime and historical


trend groups. It applies to both curve
(continuous trace) and table (discrete
values) group presentation mode.

Optional

Range
Default
Parameter(s)

Description

0
None

The value must be grather than 10


seconds for realtime trend groups and
greather than the archive frequency for
historical trend groups.
SPANUNITS

Integer

Time units to qualify time span field.

{0...5}

See Appendix A for allowed time units.

Optional

9AKK101130D1382

None

243

Table 80. Generic Trend Group Display Parameters.


Format
Width
Opt/Mnd

Name
DISPFRQ

Range
Default
Parameter(s)

Description

Integer

Default list display frequency.

0
It is the time interval between two
consecutive values when a trend group is None
displayed as a table (discrete values).

Optional

It applies to both realtime and historical


trend groups.
The value must be greather than or equal
to 1 second for realtime trends and equal
to or a multiple of the archive frequency
for historical trend groups.
DISPUNITS

CURVETYPE

Time units to qualify display frequency


field.

Optional

See Appendix A for allowed time units.

None

Integer

{0,1,2}

Kind of representation for the trend


curves.

Optional

Allowed values are:

None

Integer

{0...5}

0 - default (interpolation),
1 - step,
2 - interpolation.

Link Parameters
The fields in Table 81 define links to displays or other trend groups for
exploring purposes.

244

9AKK101130D1382

Table 81. Generic Trend Group Link Parameters.

Name
PRIMDISP

FWDNAME

BWDNAME

ESCNAME

ENTNAME

Format
Width
Opt/Mnd

Range
Default
Parameter(s)

Character

Primary display reference.

<string>

80

Name of a graphic display associated to


the group.

<blank>

Optional
Character

Forward link among trend groups.

<string>

20
Optional

<blank>
This field defines the name of another
group chained as following to the current [sznam]
one.

Character

Backward link among trend groups.

<string>

20

<blank>

Optional

This field defines the name of another


group chained as previous to the current
one.

Character

Escape page name.

<string>

20

<blank>

Optional

This field defines the name of an escape


display to leave the trend group
subsystem. Typically it is the name of a
plant or menu mimic.

Character

Menu page name.

<string>

20

This field defines the name of an menu


display.

<blank>

Optional

9AKK101130D1382

Description

None

[sznam]

[sznam]

[sznam]

245

Log Parameters
The fields in Table 82 allow defining logs for operator actions and generic
information.
Table 82. Generic Trend Group General Parameters.
Format
Width
Opt/Mnd

Name
PR_OPACT

PR_INFO

SV_OPACT

SV_INFO

Character

Print flag for operator action messages.

{Y, N}

Optional

If set, database modifications and all


other operator actions concerning this
group will be printed on the alarm
printer(s).

Character

Print flag for information messages

{Y, N}

Optional

If set, information concerning this group


will be printed on the alarm printer(s).

Character

Save flag for operator actions.

{Y, N}

1
Optional

N
If set, database modifications and all
other operator actions concerning this
None
group will be logged to Operator Journal.

Character

Save flag for information messages

{Y, N}

If set, information concerning this group


will be logged to Operator Journal.

Optional

246

Range
Default
Parameter(s)

Description

None

None

None

9AKK101130D1382

Tag List Parameters


The fields in Table 83 define the basic information to identify tags belonging
to the trend group.
Table 83. Generic Trend Group - Tag List Parameters.
Format
Width
Opt/Mnd

Name
TAGFILE

Character
254

TAGLIST

Specification of an ASCII file containing


the tag list.

Range
Default
Parameter(s)
<string>
<blank>

Optional

See Note 1 at the end of the table for


details.

Character

List of tags belonging to the trend group.

<string>

254

See Note 1 at the end of the table for


details.

<blank>

Number of tags defined in the trend


group.

{0...60}

Optional
NUMTAGS

Description

Integer
3
Optional

None

0
If not specified, it is assumed to be the
[grptag]
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 fileds
of the on-line configuration Tab.

Note 1:
Basically, there are two methods for specifying tags belonging to a trend
group. Either an external tag file or a internal tag list can be used.

9AKK101130D1382

247

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 PGP\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

248

9AKK101130D1382

$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.
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 PGP.
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.

9AKK101130D1382

249

Network Parameters
The fields in Table 84 refer to PGP network communication subsystem.
They are used when multiple PGP in a multi master architecture exchange
data (values and configurations).
All fields are optional.
Table 84. Generic Trend Group - Network Parameters.

Name
CNFNODMSK

Format
Width
Opt/Mnd

Sequence {Y, N}

Optional

First bit refers to node 1 in the node


definition, second bit refers to node 2,
and so on.

None

Character

Destination node mask for trend group


configurations.

Sequence {Y, N}

Destination node mask for trend group


configurations.

Sequence {Y, N}

Destination node mask for trend group


configurations.

Sequence {Y, N}

Destination node mask for tag values of


trend group.

Sequence {Y, N}

16
Optional
CNFNODMS3

Character
16
Optional

CNFNODMS4

Character
16
Optional

DESTVALMSK

Character
16
Optional

250

Range
Default
Parameter(s)

Destination node mask for trend group


configurations.

Character
16

CNFNODMS2

Description

16*N

16*N
The mask applies to nodes from 17 to 32. None
16*N
The mask applies to nodes from 33 to 48. None
16*N
The mask applies to nodes from 49 to 64 None
16*N
Tag values of group are routed from the None
current node to the nodes set in the
destination mask. First bit refers to node
1 in the node definition, second bit refers
to node 2, and so on.

9AKK101130D1382

Table 84. Generic Trend Group - Network Parameters.


Format
Width
Opt/Mnd

Name
DESTVALMS2

Character
16
Optional

DESTVALMS3

Character
16
Optional

DESTVALMS4

Character
16
Optional

Description

Range
Default
Parameter(s)

Destination node mask for tag values of


trend group.

Sequence {Y, N}

Destination node mask for tag values of


trend group.

Sequence {Y, N}

Destination node mask for tag values of


trend group.

Sequence {Y, N}

16*N
The mask applies to nodes from 17 to 32. None
16*N
The mask applies to nodes from 33 to 48. None
16*N
The mask applies to nodes from 49 to 64. None

Realtime Trend Group Definition


Realtime trend groups are fully defined by the fields listed in the Generic
Trend Group section. Refer to that section for details.

Historic Group Definition


Historic groups require additional parameters to be fully defined. The
following subsections list parameters specifically related to historical groups.
See also the section on generic trend group for the basic parameter
definitions.

9AKK101130D1382

251

History Parameters
The parameters listed in Table 85 allow defining archive and size of an
historical trend group.
Table 85. Historic Trend Group - History Parameters (Archiving).
Format
Width
Opt/Mnd

Name
ARCHFRQ

Range
Default
Parameter(s)

Description

Integer

Archiving frequency.

0
The value defines the time interval
between two consecutive values stored in None
a historical group. Data are processed
and archived with the frequency defined
bu this field.

Mandatory

It applies to historical trend groups only.


ARCHUNITS

Time units to qualify archiving frequency


field.

{0...5}

Mandatory

See Appendix A for the allowed time


units.

None

Integer

Archiving offset.

This field defines a delay added to


processing time of the group. See the
OFFSUNITS field also. Archiving offset
must always be less than archiving
period.

Integer
1

OFFSET

Optional

0
None

See Note 1 at the end of the table.


OFFSUNITS

Integer

Time units to qualify offset field.

{0...5}

See the Appendix A for the allowed time


units.

Optional

252

None

9AKK101130D1382

Table 85. Historic Trend Group - History Parameters (Archiving).


Format
Width
Opt/Mnd

Name
TOTSAMPLES

Integer

Total number of elements kept archived.

The value defines the number of


elements (that is, the size) of a trend
group file. The total refers to each tag of
the trend group.

Mandatory

Range
Default
Parameter(s)

Description

0
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

If defined, this tag allows inhibiting data


archiving when it leaves its normal state.
Data archiving resumes when the
inhibiting tag returns to the normal state.

<blank>

Optional

[sznam]

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.
The parameters listed in Table 86 must be defined only when the archive
type is TOTAL, AVERAGE, MIN or MAX. These type of archiving only
process a set of samples to archive a computed value. Samples are
collected within the archiving period.

9AKK101130D1382

253

Table 86. Historic Trend Group - History Parameters (Sampling).


Format
Width
Opt/Mnd

Name
SAMPLFRQ

Integer

Sampling frequency.

The value is the time interval between


two consecutive samples gathered to
store a computed value in a trend group
file.

Mandatory

Range
Default
Parameter(s)

Description

0
None

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

Time units to qualify sampling frequency


field.

{0...5}

Mandatory

See Appendix A for the allowed time


units.

None

Integer

Percent of allowed bad samples.

{0...99}

If greater than 0, a datum to be archived 0


is marked bad when the percentage of
None
bad samples among collected samples is
greater than the defined percent value.

Integer
1

BADSAMPLES

Optional

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.
The two parameters in Table 87 allow retrieving 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.

254

9AKK101130D1382

Deriving a group from another allows producing long term historical


archives. For example, a daily archive may be derived from a hourly archive;
a yearly archive may be derived from a monthly archive.
Table 87. Historic Trend Group - History Parameters (Deriving).
Format
Width
Opt/Mnd

Name
DERIVED

INPGROUP

Character

Derived group flag.

{Y,N}

Optional

This flag states the current group is a


derived one. Another group defined by
the field below is the source of
information.

Character

Name of the input group.

<string>

20

If the derived group flag is set, this field


specifies the name of the source group.

<blank>

Optional

9AKK101130D1382

Range
Default
Parameter(s)

Description

None

[sznam]

255

Time Function Parameters


The parameters in the Table 88 must be defined only when the archive type
is COUNT, MONITOR or RATIO.
Table 88. Historic Trend Group - Time Function Parameters.
Format
Width
Opt/Mnd

Name
MONVALUE

Range
Default
Parameter(s)

Description

Character

Monitor flag for value of tags.

{Y, N}

If the flag is set, the value of each tag is


monitored and compared to threshold
limits.

Optional

None

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

{Y, N}

Character

Monitor flag for quality of tags.

If the flag is set, the quality of each tag is N


monitored and compared to the quality
None
mask.

Optional

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.

256

9AKK101130D1382

Table 88. Historic Trend Group - Time Function Parameters.


Format
Width
Opt/Mnd

Name
MONREVERSE

MONUNITS

Range
Default
Parameter(s)

Description

{Y, N}

Character

Reverse monitoring flag.

1
Optional

Reverse the counting or monitoring rules N


defined by the couple of fields above.
None
Values or qualities outside threshold
limits are considered.

Integer

Time units for monitoring.

{0...5}

This field defines the interval used as


time basis for monitoring evaluation.

Optional

None

See the Appendix A for the allowed time


units.
MONFACT

Integer

Monitor factor.

{1, 10, 100, 1000}

This field applies to RATIO groups only.

Optional
TARGETLOW

Integer

TARGETHIGH

Low threshold limit for value monitoring.

10

Optional

None

Integer

TARGETQUAL

None

High threshold limit for value monitoring.

10

Optional

None
Sequence {0, 1}

Character

Bit mask for quality monitoring.

32

<blank>
This bit mask must match the bit mask
organization of quality bits (see Appendix None
A for the quality bit structure).

Optional

Post Trip Trend Group


Post trip groups require additional parameters to be fully defined. The
following sub-sections list parameters specifically related to post trip groups.
See also the section on realtime groups for the basic parameter definitions.

9AKK101130D1382

257

Trip Parameters
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.
Table 89. Historic Trend Group - Trip Parameters.
Format
Width
Opt/Mnd

Name
PRETIME

POSTTIME

{0...99999}

Integer

Pre trip time.

It defines the amount of time to be taken 0


into account before trip. Exception reports None
found in this time interval are retrieved
from playback and archived as post trip
data.

Optional

PREUNITS

Range
Default
Parameter(s)

Description

Integer

Time units to qualify pre trip time field.

{0...5}

See Appendix A for the allowed time


units.

Optional
Integer

Post trip time.

{0...99999}

It defines the amount of time to be taken


into account after trip. Exception reports
incoming during this time interval are
gathered and archived as post trip data.

Optional

None

None

See Note 1 at the end of the table.


POSTUNITS

Integer

Time units to qualify post trip time field.

{0...5}

See Appendix A for the allowed time


units.

Optional

258

None

9AKK101130D1382

Table 89. Historic Trend Group - Trip Parameters.


Format
Width
Opt/Mnd

Name
TRIPCOUNT

TRIPCLOS

Range
Default
Parameter(s)

Description

<string>

Character

Trip counter tag name.

20
Optional

The tag defined here keeps track of trips. <blank>


Each time a trip takes place, the counter [sznam]
increments.

Character

Close trip flag.

{Y,N}

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.

Optional

None

See Note 1 at the end of the table.

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

9AKK101130D1382

259

Report Subsystem
Report
Outline
PGP provides a complete set of functionalities for generating and managing
reports.
Report logs are used to obtain data from the PGP database, either from the
realtime and the historical archives, and to load data into spreadsheets,
allowing the user to format, store and perform calculations using live and
historic process data.
The reports are generated and maintained on the PGP Server computer.
The report generation program produces files that may be printed and/or
archived on the hard disk. To control the disk allocation of the report archive,
the maximum number of files kept archived and the maximum latency time
can be defined for each report.
The report configuration is based on Microsoft Excel work-sheets.
PGP provides the features listed in the following items.

The reports can be generated upon user request or on a periodic basis,


triggered by an alarm (tag in alarm condition). The scheduling
parameters can be configured by using the standard Build utility.

The reports can be archived into dedicated directory folders and/or


printed. These features can be configured by using the standard Build
utility.

The reports provide the capability to include into the Excel work-sheet
data coming from the PGP realtime and historical databases by using
the Dynamic Data Exchange (DDE) functionality.

The user will have the possibility to view the archived reports, print
and/or delete them, using the PGP report interface.

This chapter does not deal with the structure of a report. Refer to Microsoft
Excel manuals for details about work-sheet implementation.

260

9AKK101130D1382

In the following sections the structure of the definition database and the set
of functions to access PGP data are described.

Report Database
The report definition 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 application PGP (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
PGP 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 PGP internal database. If PGPa target database does not
exist, the builder processor creates it using the whole PGP 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.

Report Definition
The following sub-sections defines the parameters required to configure
reports within PGP (i.e. to notify PGP a 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 PGP databases
from Excel work-sheets.

9AKK101130D1382

261

General Parameters
The fields in Table 90 define the name and other 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 subsections following this one.
Table 90. Report - General Parameters.
Format
Width
Opt/Mnd

Name
REPINDEX

REPNAME

REPDESC

REPINHTAG

Range
Default
Parameter(s)
{0...50}

Integer

Report index.

6
Optional

This field identifies the report by number. 0


It must be unique for each report in the
[nmrpts]
database. If omitted or zero (blank), the
first vacant index will be allocated.

Character

Report name.

20
Mandatory

This field identifies the report by name. It <blank>


must be unique for each report in the
[sznam]
database.

Character

Report description.

<string>

<string>

64

<blank>

Mandatory

[szdesc]
<string>

Character

Report inhibit tag name.

20

<blank>
Name of a tag that, while in alarm, will
disable the generation of the report. If the [sznam]
field is blank, no report inhibit is defined.

Optional

262

Description

9AKK101130D1382

Activation Parameters
The fields in Table 91 define scheduling or activation parameters used to
generate the report.
Table 91. Report - Activation Parameters.
Format
Width
Opt/Mnd

Name
SCHDFRQ

Range
Default
Parameter(s)

Description

Integer

Schedule frequency.

{1...99999}

If greater than 0, the field allows


automatically generating a report.

Optional

None

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

OFFSET

Integer

Time unit to qualify scheduling frequency. {0...3}

Optional

See Appendix A for the allowed time


units.

Integer

Report offset.

{0...99999}

This field defines a delay added to the


scheduling time of report. See the
OFFSUNITS field also. Report offset
must always be less than report period.

Optional

None

None

See Note 1 at the end of the table.

9AKK101130D1382

263

Table 91. Report - Activation Parameters.


Format
Width
Opt/Mnd

Name
OFFSUNITS

ACTONEVENT

Range
Default
Parameter(s)

Description

Integer

Time unit to qualify report offset.

{0...3}

Optional

See Appendix A for the allowed time


units.

Character

Activate report flag on event.

{Y,N}

The tag whose REP_NUM field refers to N


this report will activate reporting. If set,
None
the field makes the report eligible for
activation when the activating tag goes in
an alarm condition.

Optional

None

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.

Archiving Parameters
The fields in Table 92 define the 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.

264

9AKK101130D1382

Table 92. Report - Archiving Parameters.


Format
Width
Opt/Mnd

Name
ARCHIVE

MAXLATENCY

MAXREPORTS

SAVEHTM

Character

Disk archiving flag.

{Y,N}

When a report is generated from its


template, it is stored on the hard disk.
Each report has a its own folder in the
\PGP\Reports folder.

Optional

Integer

Maximum latency time (days).

5
Optional

Reports older than the latency days are


deleted from the hard disk.

Integer

Maximum number of reports.

4
Optional

The oldest reports exceeding the allowed 0


maximum are deleted from the hard disk. None

Character

Html file archiving flag.

If set, the report is saved in a html format Y


file.
None

Optional

9AKK101130D1382

Range
Default
Parameter(s)

Description

None

0
None

{Y,N}

265

Printing Parameters
The fields in Table 93 define the parameters involved in printing the report.
Table 93. Report - Printing Parameters.
Format
Width
Opt/Mnd

Name
PRINT

PRINTER

Character

Print flag.

{Y,N}

When a report is generated from its


template, it is printed on the
documentation printer.

Optional
Character

Printer name.

<string>

20

Name of the documentation printer.

<blank>

Optional

266

Range
Default
Parameter(s)

Description

None

[sznam]

9AKK101130D1382

Excel Parameters
The fields in Table 94 define the parameters used to reference the Excel
work-sheet. They allow linking the report definition and the report Excel
template.
Table 94. Report - Excel Parameters.

Name
XLSDATCELL

Format
Width
Opt/Mnd

Description

Range
Default
Parameter(s)
<string>

Character

Date cell reference.

10

The field is a reference to a cell within the <blank>


Excel template file. The syntax is n!Am
None
where n is the sheet number and Am is
the cell reference (e.g. 1!M3 is a
reference to cell M3 of sheet 1).

Optional

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 PGP format.

9AKK101130D1382

267

Table 94. Report - Excel Parameters.


Format
Width
Opt/Mnd

Name
XLSFILE

Description

Range
Default
Parameter(s)

Character

Excel work-sheet file name.

<string>

64

The field refers to the Excel template file


where the structure of the report is
implemented.

<blank>

Mandatory

[szdesc]

The Excel work-sheet must be located


within the \PGP\Config\Reports folder.
XLSSHEET

{1...99)

Integer

Excel sheet index.

A Excel work-sheet (report template) may 0


contain multiple sheets. From the
None
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.

Mandatory

SOE Parameters
The fields in Table 95 define the 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.

268

9AKK101130D1382

Table 95. Report - SOE Parameters.


Format
Width
Opt/Mnd

Name
SOETYPE

Range
Default
Parameter(s)

Description

Integer

Type of sequence of events.

{0, 1}

The value of this field can be

Optional

0 - Standard SOE

None

1 - Summary SOE
SOEDEVICE

Integer

Sequence of event device.

Number of the SER device generating the 0


sequence of events.
[mxsedv]

Optional

{0, 1, 2}

Excel Work-Sheet
A report is generated on demand or periodically based on scheduling
parameters as introduced in the previous section. A template work-sheet
created by Excel is the cell matrix used to generate the actual report.

Public and Themodynamic Functions


A set of public functions and thermodynamic functions are listed in the
following sub-sections. Refer to Microsoft manuals for details on work-sheet
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>,

......................
[n]

9AKK101130D1382

<parameter n>,

269

End Variables)

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

Libraries of Functions
The following sub-sections define the functions available with the PGP
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
\PGP\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
\PGP\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.

Public functions
A set of public functions allow interacting PGP in order to retrieve data for
reporting. They include function to interface the tag configuration database,
the realtime database, the playback and the historic groups. Time
manipulation functions are included also.

270

9AKK101130D1382

Table 96. Reports - Public Functions.


Function
BLKDEALLOC

Description
The function de-allocates data structures
previously allocated for data retrieving from
historical archives or playback.

Syntax
BLKDEALLOC

(Input variables
The subroutine can be called from VBA Excel
End Variables)
code only.
FPBLKQUAL

The function returns the quality mask of a tag [<long> =]


of a historical group.
FPBLKQUAL
On error, a null quality is returned.
(Input variables
<group name>,
<tag name>,
<retrieving time>
End Variables)

FPBLKQUALTIME

The function retrieves the quality of a tag from [<long> =]


FPBLKQUALTIME
a data packet (as returned by the
Fpblksample function) of an historical group. (Input variables
On error, a null quality is returned.
<retrieving time>
End Variables)

9AKK101130D1382

271

Table 96. Reports - Public Functions.


Function
FPBLKSAMPLE

Description

Syntax

The function returns a data packet of a tag


within a historical group.

[<long> =]
FPBLKSAMPLE

The returned value, the number of found


records, can be used by the Fpblkqualtime,
Fpblkvaldtime and Fpfromblkvald functions.

(Input variables

Depending on the sign of the number of


records different searches are performed:

<group name>,
<tag name>,
<start time>,

<end time>,
> 0 - The function searches forward beginning
<number of records>
from start time,
= 0 - The function retrieves all records within End Variables)
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 [<double> =]


a historical group.
FPBLKVALD
On error, a null value is returned.

(Input variables
<group name>,
<tag name>,
<retrieving time>
End Variables)

FPBLKVALDTIME

The function retrieves the value of a tag from


a data packet (as returned by the
Fpblksample function) of an historical group.

[<double> =]
FPBLKVALDTIME

On error, null value is returned.

<retrieving time>

(Input variables
End Variables)

272

9AKK101130D1382

Table 96. Reports - Public Functions.


Function
FPFROMBLKVALD

Description
The function retrieves the value of a tag from
a data packet (as returned by Fpblksample
function) of an historical group.

Syntax
[<double> =]
FPFROMBLKVALD

(Input variables
The record index is a number from 1 to N
<record index>
where N is the number of records returned by
End Variables)
the Fpblksample function.
On error, a null value is returned.
FPGET

The function retrieves a tag value from the


realtime database.

[<string> =]

On error, a null value is returned.

(Input variables

See Note 1 at the end of table.

<tag name>,

FPGET

<force recalculation>
End Variables)
FPGETD

The function retrieves a tag value from the


realtime database.

[<double> =]

On error, a null value is returned.

(Input variables

See Note 1 at the end of table.

<tag name>,

FPGETD

<force recalculation>
End Variables)
FPHGETD

The function retrieves the value of a tag from


the playback archive.

[<double> =]

On error, a null value is returned.

(Input variables

FPHGETD
<tag name>,
<retrieving time>
End Variables)

9AKK101130D1382

273

Table 96. Reports - Public Functions.


Function
FPHXGETVAL

Description
The function retrieves the value of a tag from
a data packet (as returned by Fphxnumval
function) of the playback archive.

Syntax
[<double/string/date> =]
FPHXGETVAL

(Input variables
The record index is a number from 1 to N
<record index>,
where N is the number of records returned by
<returned type>
the Fphxnumval function.
End Variables)
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 playback archive.

[<long> =]
FPHXNUMVAL

The returned value, the number of found


records, may be used by the Fphxgetval
function.

(Input variables

Depending on the sign of the number of


records different searches are performed:

<tag name>,
<start time>,
<end time>,

<number of records>
> 0 - The function searches forward beginning
End Variables)
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.

274

9AKK101130D1382

Table 96. Reports - Public Functions.


Function
GETAPMSTIME

GETDATEFROMSEC

Description

Syntax

The function translates a standard date and


time in the internal PGP format.

[<long> =]
GETAPMSTIME

The date and time is a string in the format

(Input variables

DD/MM/YY hh:mm:ss.

<date and time>

The returned value, in the internal PGP date


and time format, is the number of seconds
since January 1, 1991.

End Variables)

The function translates a PGP date and time


in the Excel date and time format.

[<string> =]
GETDATEFROMSEC

The input parameter, in the internal PGP date (Input variables


and time format, is the number of seconds
<PGP date and time>,
since January 1, 1991.
<force recalculation>
If the input parameter is not defined, the
End Variables)
current PGP date and time is converted.
The returned date and time is a string in the
format DD/MM/YY hh:mm:ss.
See Note 1 at the end of table.
GETSECFROMDATE

The function translates the current date and


time or the date entered for manual forced
reporting in the PGP format.

[<long> =]
GETSECFROMDATE

The input date is defined by a reference to a


cell in the work-sheet.

<Xls date cell>

(Input variables

<force recalculation>
If defined, the input parameter references a
End Variables)
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.
See Note 1 at the end of table.

9AKK101130D1382

275

Table 96. Reports - Public Functions.


Function

Description

Syntax

The function retrieves tag information from the [<string> =]


configuration database based on a info type
TAGINFO
parameter.
(Input variables
On error, a null info is returned.
<tag name>,
See the table TagInfo Types within the
<tag info>,
Section 1 of the PGP Application Program
<force recalculation>
Interface manual for a list of tag information
End Variables)
codes.

TAGINFO

See Note 1 at the end of table.


TAGREAD

The function retrieves the tag value from the


realtime database.

[<double> =]

On error, a null value is returned.

(Input variables

See Note 1 at the end of table.

<tag name>,

TAGREAD

<force recalculation>
End Variables)
TAGREADBINARY

The function retrieves the tag value from the


realtime database.

[<binary string> =]

On error, a null value is returned.

(Input variables

See Note 1 at the end of table.

<tag name>,

TAGREADBINARY

<force recalculation>
End Variables)
TAGREADVAL

The function retrieves the tag value from the


realtime database.

[<double> =]

On error, a null value is returned.

(Input variables

See Note 1 at the end of table.

<tag name>,

TAGREADBINARY

<force recalculation>
End Variables)

Note 1:

276

9AKK101130D1382

The force recalculation parameter is a optional date field. If used, it must be


set to NOW() and forces recalculation of value each time the cell is
referenced.

Steam Functions
Steam functions of calculations can be used and referenced within Excel
work-sheets. They are listed in Table 97.
Table 97. Report - Steam Functions.
Function
CP_at_TP

Description
Specific heat as function of temperature and
pressure.

Syntax
[<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 and entropy.

[<enthalpy> =]
H_at_PS
(Input variables
<pressure>,
<entropy>
End Variables)

9AKK101130D1382

277

Table 97. Report - Steam Functions.


Function
H_at_TP

Description
Enthalpy, relative to steam and water, as
function of temperature and pressure.

Syntax
[<enthalpy> =]
H_at_TP
(Input variables
<temperature>,
<pressure>
End Variables)

K_at_TP

Water conducibility, relative to steam and


water, as function of temperature and
pressure.

[<conducibility> =]
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 and enthalpy.

[<entropy> =]
S_at_PH
(Input variables
<pressure>,
<enthalpy>
End Variables)

278

9AKK101130D1382

Table 97. Report - Steam Functions.


Function
S_at_TP

Description
Entropy, relative to steam and water, as
function of temperature and pressure.

Syntax
[<entropy> =]
S_at_TP
(Input variables
<temperature>,
<pressure>
End Variables)

T_at_PH

Temperature, relative to steam and water, as


function of pressure and enthalpy.

[<temperature> =]
T_at_PH
(Input variables
<pressure>,
<enthalpy>
End Variables)

T_at_PS

Temperature, relative to steam and water, as


function of pressure and entropy.

[<temperature> =]
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 temperature and pressure.

[<specific volume> =]
V_at_TP
(Input variables
<temperature>,
<pressure>
End Variables)

9AKK101130D1382

279

Gas Property Functions


Gas property functions of calculations can be used and referenced within
Excel work-sheets. They are listed in Table 98.
Table 98. Report - Gas Property Functions.
Function
CP_GAS

Description
Specific heat of a gas as function of the
temperature.

Syntax
[<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)

280

9AKK101130D1382

Sea Water Functions


Sea water functions of calculations can be used and referenced within Excel
work-sheets. They are listed in Table 99.
Table 99. Report - Sea Water Functions.
Function
SEAW

Description
Property of the sea water as function of the
temperature and salt concentration. The
property to be returned is specified as third
parameter.

Syntax
[<property> =]
SEAW
(Input variables
<temperature>,
<salt concentration>,
<function index>
End Variables)

9AKK101130D1382

281

Fuel Combustion Functions


Fuel combustion functions of calculations can be used and referenced within
Excel work-sheets. They are listed in Table 100 and Table 101.
Table 100. Report - Fuel Combustion Functions Based on Flue Gas.
Function
CP_FGAS_T

Description
Specific heat of flue gas as function of the
temperature and the flue gas composition.

Syntax
[<specific heat> =]
CP_FGAS_T
(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 flue gas composition.

[<enthalpy> =]
H_FGAS_T
(Input variables
<temperature>,
<gas index>,
<% CO2>,
<% O2>,
<% CO>,
<% SO2>,
<% H2O>,
<% AR>
End Variables)

282

9AKK101130D1382

Table 100. Report - Fuel Combustion Functions Based on Flue Gas.


Function
S_FGAS_TP

Description
Entropy of flue gas as function of the
temperature, the pressure and the flue gas
composition.

Syntax
[<entropy> =]
S_FGAS_TP
(Input variables
<temperature>,
<pressure>,
<gas index>,
<% CO2>,
<% O2>,
<% CO>,
<% SO2>,
<% H2O>,
<% AR>
End Variables)

9AKK101130D1382

283

Table 100. Report - Fuel Combustion Functions Based on Flue Gas.


Function
T_FGAS_H

Description
Temperature of flue gas as function of the
enthalpy and the flue gas composition.

Syntax
[<temperature> =]
T_FGAS_H
(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 entropy and the flue gas
composition.

[<temperature> =]
T_FGAS_PS
(Input variables
<pressure>,
<entropy>,
<gas index>,
<% CO2>,
<% O2>,
<% CO>,
<% SO2>,
<% H2O>,
<% AR>
End Variables)

284

9AKK101130D1382

Table 101. Report - Combustion Functions Based on Fuel Characteristics.


Function
AIR_MIN

Description
Stechiometric air in the fuel as function of
the fuel composition.

Syntax
[<air in fuel> =]
AIR_MIN
(Input variables
<% C>,
<% H>,
<% S>,
<% O>
End Variables)

H_FCOMB_T

Enthalpy of air and fuel as function of the


temperature and the fuel composition.

[<enthalpy> =]
H_FCOMB_T
(Input variables
<temperature>,
<% C>,
<% H>,
<% S>,
<% O>,
<% N>,
<dry air/fuel>
End Variables)

9AKK101130D1382

285

Table 101. Report - Combustion Functions Based on Fuel Characteristics.


Function
CP_FCOMB_T

Description
Specific heat of air and fuel as function of
the temperature and the fuel composition.

Syntax
[<specific heat> =]
CP_FCOMB_T
(Input variables
<temperature>,
<% C>,
<% H>,
<% S>,
<% O>,
<% N>,
<dry air/fuel>
End Variables)

S_FCOMB_TP

Entropy of air and fuel as function of the


temperature, the pressure and the fuel
composition.

[<entropy> =]
S_FCOMB_T
(Input variables
<temperature>,
<pressure>,
<% C>,
<% H>,
<% S>,
<% O>,
<% N>,
<dry air/fuel>
End Variables)

286

9AKK101130D1382

Table 101. Report - Combustion Functions Based on Fuel Characteristics.


Function
T_FCOMB_H

Description
Temperature of air and fuel as function of
the enthalpy and the fuel composition.

Syntax
[<temperature> =]
T_FCOMB_H
(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, entropy and the fuel
composition.

[temperature=]
T_FCOMB_PS
(Input variables
<pressure>,
<entropy>,
<% C>,
<% H>,
<% S>,
<% O>,
<% N>,
<dry air/fuel>
End Variables)

9AKK101130D1382

287

Wet Air Functions


Wet air functions of calculations can be used and referenced within Excel
work-sheets. They are listed in Table 102.
Table 102. Report - Wet Air Functions.
Function
CP_AIR_T

Description
Specific heat of wet air as function of the
temperature and absolute humidity.

Syntax
[<specific heat> =]
CP_AIR_T
(Input variables
<temperature>,
<absolute humidity>
End Variables)

H_AIR_T

Enthalpy of wet air as function of the


temperature and absolute humidity.

[<enthalpy> =]
H_AIR_T
(Input variables
<temperature>,
<absolute humidity>
End Variables)

S_AIR_TP

Entropy of wet air as function of the


temperature, pressure and absolute

[<entropy> =]
S_AIR_TP
(Input variables
<temperature>,
<pressure>,
<absolute humidity>
End Variables)

288

9AKK101130D1382

Table 102. Report - Wet Air Functions.


Function
T_AIR_H

Description
Temperature of wet air as function of the
enthalpy and absolute humidity.

Syntax
[<temperature> =]
T_AIR_H
(Input variables
<enthalpy>,
<absolute humidity>
End Variables)

T_AIR_PS

Temperature of wet air as function of the


pressure, entropy and absolute humidity.

[<temperature> =]
T_AIR_PS
(Input variables
<pressure>,
<entropy>,
<absolute humidity>
End Variables)

WHY

[<humidity> =]
Percentage of humidity per kg of dry air as
function of dry bulb temperature, atmospheric WHY
pressure and measured relative humidity.
(Input variables
<dry bulb temp.>,
<atmospheric press.>,
<relative humidity>
End Variables)

9AKK101130D1382

289

Pegboard Subsystem
Outline
PGP provides an integrated pegboard subsystem for process control. The
pegboard package, like all PGP subsystems, can be configured to meet
specific application requirements without programming. It maintains sets of
control tags organized as special mimics.
Process control devices (stations, MSDD, RCM etc.) can be defined as
components of a pegboard. Also displaying devices for analog and digital
tags can be defined as pegboard components. A pegboard is a special
mimic where space is divided in 32 rectangles. Up to 32 process control
devices can be arranged within the space. Since control devices require
different space for allocation, the total number of devices depends on the
their type. For example, stations requires 4 unit rectangles and up to 8
stations may fit the pegboard space.
Each pegboard allows process control by interacting with the control devices
it hosts.

Pegboard Database
The pegboard 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 application PGP (if it is a different one) for final
import.
Pegboard 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 PGP 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 PGP internal database. If a target database does not exist,
the builder processor creates it using the whole PGP 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

290

9AKK101130D1382

the fields specified in it. The target database file may have just a single
pegboard or may be a full or partial database file. It must contain all (and
only) fields to be exported.

Pegboard Definition
The following sections list the parameters to characterize all kind of
pegboards. There are both mandatory and optional parameters.

General Parameters
The fields in Table 103 define the name and other parameters used to
identify the pegboard. Additional fields are listed in the specific sections
following this one.
Table 103. Pegboard - General Parameters.
Format
Width
Opt/Mnd

Name
PAGEINDEX

Range
Default
Parameter(s)

Description

Integer

Pegboard page index.

{0, 1...100}

This field identifies the pegboard by


number. It must be unique for each
pegboard in the database.

Optional

[nmopds]

If omitted or zero (blank), the first vacant


index will be allocated.
PAGENAME

PAGEDESC

9AKK101130D1382

Character

Pegboard name.

<string>

20

<blank>

Mandatory

This field identifies the pegboard by


name. It must be unique for each
pegboard in the database.

Character

Pegboard description.

<string>

[sznam]

64

<blank>

Optional

[szdesc]

291

Link Parameters
The fields in Table 104 define links to displays or other pegboards. Those
links are used when exploring the pegboards as a continuous sequence.
Table 104. Pegboard - General Parameters.

Name
FWDNAME

BWDNAME

ESCNAME

ENTNAME

Format
Width
Opt/Mnd

Range
Default
Parameter(s)

Character

Forward link among pegboards.

<string>

20

<blank>

Optional

It is the name of another pegboard


chained as next to the current one.

Character

Backward link among pegboards.

<string>

20

<blank>

Optional

It is the name of another pegboard


chained as previous to the current one.

Character

Escape page name.

<string>

20

<blank>

Optional

It is the name of an escape display.


Typically it is the name of a mimic.

Character

Menu page name.

<string>

20

It is the name of an menu display.

<blank>

Optional

292

Description

[sznam]

[sznam]

[sznam]

[sznam]

9AKK101130D1382

Popup Parameters
The fields in Table 105 define structure of the pegboard.
Two parameters: type of popup and tag name identify each popup within the
pegboard.
Table 105. Pegboard - Popup Parameters.
Format
Width
Opt/Mnd

Name
POP01TYPE

Type of the first popup.

{0...3}

See Table 106 for allowed popup types.

Optional

See Notes 1 and 2 at the of the table.

None

Character

Tag name of the first popup.

<string>

Integer

POP01TAG

Range
Default
Parameter(s)

Description

20

<blank>

Optional

[sznam]

..................

...............

.................................................

.........

POP32TYPE

Integer

Type of the 32-nd popup.

{0...3}

See Table 106 for allowed popup types.

Optional

See Notes 1 and 2 at the of the table.

None

Character

Tag name of the 32-nd popup.

<string>

POP32TAG

20

<blank>

Optional

[sznam]

Table 106. Pegboard - Popup Types.


Type

Description

Buckets

Undefined

Normal

9AKK101130D1382

293

Table 106. Pegboard - Popup Types.


Type

Description

Buckets

Large

Small

Note 1:
Up to 32 popup may fit within a pegboard. The actual number of pop-ups
within a pegboard depends on the number of buckets required by each
single popup to fit and on the type of pop-ups included within a pegboard.
A control station, for example, has a size of 4 buckets and, consequently, 8
control stations may fit within a pegboard. A MSDD has a size of 2 buckets
and up to 16 MSDDs may fit within a pegboard. An analog or digital
visualization popup has a size of one bucket and up to 32 visualization
popup may fit within a pegboard. Be careful on configuring pegboards to
allocate pop-ups in the correct positions to avoid overlaps.
Note 2:
Other than control tags, lab data entry tags also can be defined in a
pegboard. Of course, they will only set a value in the realtime database.

294

9AKK101130D1382

Operator Station Subsystem


Menu and Tool-bars
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.

Menu and Tool-bar Database


The menu and tool-bar 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 application PGP (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 will be
used to compile PGP 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 PGP internal database.
If a target database does not exist, the builder processor creates it using the
whole PGP 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.

Menu and Tool-bar Definition


The following sections list parameters to customize menu and tool-bar.
There are both mandatory and optional parameters.

9AKK101130D1382

295

Identification Parameters
The fields in Table 109 define the name and other 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.
Table 107. Menu and Tool-bar - Identification Parameters.
Format
Width
Opt/Mnd

Name
MENUINDEX

Description

Range
Default
Parameter(s)

Integer

Item number.

{1...100}

This is a unique number to identify each


menu and tool-bar item.

[n.menu]

Optional

It must be unique for each item within


database. If omitted or zero (blank), the
first vacant index will be allocated.
MENULABEL

Item description.

64

If the item is a icon, this field is the tool-tip <blank>


text. If the item is a menu element, this
[szdesc]
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.

Mandatory

BUTTONTYPE

<string>

Character

Character

Item type.

See Table 108

The field identifies the item to be an


element of a menu, a tool-bar (button) or
a display tree.

None

Mandatory

Allowed item types are listed in Table 108

296

9AKK101130D1382

Table 108. Menu and Tool-bar - Item Types.


Item Type

Description

NONE

Null element.

BUTTON

Icon of the tool-bar.


An action is associated to the button.

MENU

Element of a menu.
An action is associated to this item.

TREE

Element of a display tree.


A display is associated to this item.

Action Parameters
The fields in Table 109 define the 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 PGP function.
Table 109. Menu and Tool-bar - Action Parameters.
Format
Width
Opt/Mnd

Name
BUTTONACT

Description

Range
Default
Parameter(s)

Character

Associated kind of action.

See Table 110

The field identifies the action to be


performed upon item selection.

None

Mandatory

Allowed values are listed in Table 110

9AKK101130D1382

297

Table 109. Menu and Tool-bar - Action Parameters.


Format
Width
Opt/Mnd

Name
MENUPGM

MENUCMDLIN

Description

Range
Default
Parameter(s)
<string>

Character

Program name.

9
Optional

<blank>
The field is the name of the program to
activate when the menu or tool-bar item is None
selected. It is valid only if the action is
program activation.

Character

Program parameter.

128

<blank>
This field is a parameter (if any) to be
passed to the program at activation time. None
Standard command lines are listed in
Table 111

Optional

<string>

Table 110. Menu and Tool-bar - Action Types.


Action Type
NONE

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

298

9AKK101130D1382

Table 110. Menu and Tool-bar - Action Types.


Action Type

Description

SHELL

Document displaying.
This field allows displaying a document (the name must be defined in the
Command Line field).

TRENDS

Trend group displaying.


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 a Internet
address (the HTML page name or the Internet address must be defined in
the Command Line field).

Table 111. Menu and Tool-bar - Standard Command Lines.


Action Type

Program Name

ALMDIS

Command Line

Description

<alarm group>

The alarm page of the alarm group


defined in the command line is
displayed.

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

ALMDIS

ICISTA

9AKK101130D1382

299

Table 111. Menu and Tool-bar - Standard Command Lines.


Action Type

Program Name

DISPLAY

Command Line

Description

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

300

9AKK101130D1382

Table 111. Menu and Tool-bar - Standard Command Lines.


Action Type

Program Name

Command Line

Description

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.

9AKK101130D1382

301

Presentation Parameters
The fields in Table 112 and Table 116 define additional parameters used to
graphically qualify menu and tool-bar items. These fields defines the icon
names of buttons and optionally the functional key of the keyboard to be
used instead of the mouse (track-ball) to select.
Table 112. Menu and Tool-bar - Presentation Parameters.

Name
IMGNORMAL

Format
Width
Opt/Mnd

Description

Range
Default
Parameter(s)

Character

Icon name or tree element.

<string>

10

If ButtonType is set to Button, the field is


the icon name used to display a normal
state or a steady state.

<blank>

Mandatory

None

See Note 1 at the end of the table.


If ButtonType is set to Tree, the field is
the tree element.
Standard normal icons are listed in
Table 113
IMGALARM

Character

Icon name or tree element.

<string>

10

If ButtonType is set to Button, the field is


the icon name used to display an alarm
state.

<blank>

Mandatory

None

See Note 1 at the end of the table.


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 114

302

9AKK101130D1382

Table 112. Menu and Tool-bar - Presentation Parameters.


Format
Width
Opt/Mnd

Name
IMGBLINK

Range
Default
Parameter(s)

Description

Character

Icon name.

<string>

10

If ButtonType is set to Button, the field is


the icon name used to display an
unacknowledged alarm state.

<blank>

Mandatory

None

It applies to alarm tile icons only.


See Note 1 at the end of the table.
Standard blink icons are listed in
Table 115
MENUFKEY

Integer

Function key.

{0, 1, ..., 90}

The field identifies a function key button


of the keyboard to be associated to the
menu or tool-bar item.

Optional

None

A value of 0 means that no functional key


button has been associated to the item.
MENULEVEL

Integer

Menu level.

{0, ..., 9}

It applies to menu items only and


identifies the level in the menu structure.

Optional

None

The value 0 is the root level.


MENUSEP

{Y, N}

Character

Item separator.

The field specifies if a separator must be N


placed between the previous and the
None
current items. If set, the item separator is
a space for tool-bars and a line for
menus.

Optional

Note 1:
The icons whose names are defined above must exist or must be included
within the \PGP\Icons folder.

9AKK101130D1382

303

Table 113. Menu and Tool-bar - Standard Normal Icons.


Action Type

Program Name

ALMDIS

Normal Icon
GRAn

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

304

9AKK101130D1382

Table 114. Menu and Tool-bar - Standard Alarm Icons.


Action Type

Program Name

ALMDIS

Normal Icon
REDn

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

Table 115. Menu and Tool-bar - Standard Blink Icons.


Action Type

Program Name

ALMDIS

Normal Icon
YELn

Description
Yellow number n inside a button.
By default n can range between 1 and
20.

The parameters listed in Table 116 are not included in the on-line
configuration utility.
Table 116. Menu and Tool-bar - Presentation Parameters (cntd.).

Name
MENUTAG

Format
Width
Opt/Mnd

Range
Default
Parameter(s)

Character

Tag name.

<string>

20

The field is the name of a tag associated


to the menu item.

<blank>

Optional

9AKK101130D1382

Description

[sznam]

305

Allowed Parameters
The fields in Table 117 define security parameters to grant access to
various menu and tool-bar items.
Table 117. Menu and Tool-bar - Allowed Parameters.
Format
Width
Opt/Mnd

Name
MENUOPSTA

Integer

Number of operator station.

{0, 1...32}

It allows assign the item to a single


operator station. The code 0 means the
item is assigned to all operator stations.

Privilege to access tags and displays


belonging to the security group 1.

{Y,N}

Optional
SECGROUP1

Range
Default
Parameter(s)

Description

Character
1
Optional

[nmcrts]

N
None

..................

...............

.................................................

.........

SECGROUP32

Character

Privilege to access tags and displays


belonging to the security group 32.

{Y,N}

None

Optional
SECLEVEL

{0, 1, ..., 16}

Integer

Security level.

0
The value is compared to the security
level assigned to the user before to grant None
access. A value of 0 means no security
check.

Optional

306

9AKK101130D1382

Privilege Parameters
The fields in Table 118 define security parameters to grant access to
various menu and tool-bar items.
Table 118. Menu and Tool-bar - Privilege Parameters.
Format
Width
Opt/Mnd

Name
ALARMS

Character
1

Privilege for executing general alarm


management.

Character
1

Privilege for accessing specific


application functions.

Optional
APPL2

Character
1

CLSERVER

Character

Privilege for accessing specific


application functions.

{Y,N}
N

Privilege for configuring calculations.

{Y,N}
N

Optional

None

Character

Character
1
Optional
Character
1
Optional

9AKK101130D1382

None

Privilege for accessing the client/server


management functions.

Optional

DIAGNOSTIC

{Y,N}

1
CONFIG

None

Optional
CALCUL

{Y,N}
None

Optional
APPL1

Range
Default
Parameter(s)

Description

{Y,N}
N
None

{Y,N}
Privilege for configuring some
miscellaneous functions (e.g. engineering N
units, logic state descriptors).
None
Privilege for executing diagnostic
functions.

{Y,N}
N
None

307

Table 118. Menu and Tool-bar - Privilege Parameters.


Format
Width
Opt/Mnd

Name
GRAPHICS

Character
1

Privilege for performing mimic


configuration.

Optional
GROUPS

Character
1
Character
1
Optional

INFINET

Character
1

Privilege for configuring historical and


realtime groups.

Character
1
Optional

LTERMHIST

Character
1

ODBC

Character

Privilege for executing functions related


to the C-NET modules.

{Y,N}
N
None

Privilege for modifying the configuration


of the reports, for triggering and deleting
archived reports.

{Y,N}
N
None

Privilege for executing long term historical {Y,N}


functions.
N
None
Privilege for WEB navigation.

{Y,N}

Optional

None

Character
1
Optional

308

{Y,N}

Privilege for performing general historical {Y,N}


functions (e.g. initialize historical
N
counters).
None

Optional
NAVIGATE

None

Optional
LOGS

{Y,N}
None

Optional
HISTORY

Range
Default
Parameter(s)

Description

Privilege for configuring the ODBC


functions.

{Y,N}
N
None

9AKK101130D1382

Table 118. Menu and Tool-bar - Privilege Parameters.


Format
Width
Opt/Mnd

Name
REMWRITEF

Character
1

Privilege for writing a file in remote


access (e.g. using DDE functions).

Optional
SECURITY

Character
1

TRENDS

UTILITY

Character

Privilege for accessing and modifying


security and users.

Privilege for setting the time and date.

{Y,N}
N

Optional

None

Character

Privilege for accessing trend functions.

{Y,N}

Optional

None

Character

Character
1

Privilege for executing general utility


functions.

{Y,N}
N
None

Privilege for displaying the configuration


databases.

Optional

{Y,N}
N
None

Character

Privilege for viewing displays.

{Y,N}

If set, display viewing is submitted to


security group check also.

Optional

9AKK101130D1382

{Y,N}
None

Optional

VIEWDISP

1
VIEWCONFIG

{Y,N}
None

Optional
TIMEDATE

Range
Default
Parameter(s)

Description

None

309

Table 118. Menu and Tool-bar - Privilege Parameters.


Format
Width
Opt/Mnd

Name
VIEWHIST

WINDOWSNT

Character

Privilege for viewing historical data.

{Y,N}

Optional

None

Character
1
Optional

310

Range
Default
Parameter(s)

Description

Privilege for accessing Windows


functions (e.g. window sizing, Windows
desktop usage).

{Y,N}
N
None

9AKK101130D1382

Network Subsystem
Nodes
Outline
A network structure may involve two or more PGP. Data exchange can be,
in general, required to transfer process information or configuration data
from a node to the other(s).
As an example, the alarm acknowledge broadcasting from a PGP to the
other(s) can be required.
The node definition allows defining the structure of the cooperating PGPs
within a network.

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 application PGP (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 PGP 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 PGP internal database. If a target database does not exist,
the builder processor creates it using the whole PGP 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.

9AKK101130D1382

311

Node Definition
The following sections list parameters to characterize nodes within a
network. There are both mandatory and optional parameters.
A node item is configured as a pseudo-tag: it is not included within tags, but
has some of fields typical of tag configuration.

General Parameters
The fields in Table 119 define the name and other additional parameters
used to identify nodes in the network. Additional fields are listed in the
specific sections following this one.
Table 119. Node - General Parameters.
Format
Width
Opt/Mnd

Name
NODEINDEX

NODENAME

NODEDESC

PRIMDISP

Range
Default
Parameter(s)
{0...32}

Integer

Node index.

5
Optional

This field identifies the node by number. It 0


must be unique for each node in the
[mxnode]
database. If omitted or zero (blank), the
first vacant index will be allocated.

Character

Node name.

<string>

20

The node name must be the name


assigned to the computer and can be
retrieved by the Network function of the
Control Panel.

<blank>

Mandatory

Character

Node description.

<string>

[sznam]

64

<blank>

Optional

[szdesc]
<string>

Character

Primary display reference.

Name of a graphic display associated to <blank>


the node. For example, it could be the
None
name of a diagnostic display showing the
network component.

Optional

312

Description

9AKK101130D1382

Table 119. Node - General Parameters.


Format
Width
Opt/Mnd

Name
ZEROSTATE

ONESTATE

PLANTUNIT

WEIGHT

Character

Zero state descriptor.

6
Optional

This field defines the text to represent the <blank>


failure state.
[sztags]

Character

One state descriptor.

6
Optional

This field defines the text to represent the <blank>


normal state.
[sztags]

Integer

Plant unit number.

2
Optional

This field identifies the plant unit


(applicable only to multi-unit plants).

Integer

Node weight.

In a multi-master network configuration,


the highest value (weight) defines the
master node.

Destination node mask for snapshot


alignment at PGP start-up.

Sequence {Y, N}

Optional

First bit refers to node 1 in the node


definition, second bit refers to node 2,
and so on.

None

Character

Destination node mask for snapshot


alignment at PGP start-up.

Sequence {Y, N}

Destination node mask for snapshot


alignment at PGP start-up.

Sequence {Y, N}

Optional
SNAPALGMSK

Character
16

SNAPALGMS2

16
Optional
SNAPALGMS3

Character
16
Optional

9AKK101130D1382

Range
Default
Parameter(s)

Description

<string>

<string>

0
None

None

16*N

16*N
The mask applies to nodes from 17 to 32. None
16*N
The mask applies to nodes from 33 to 48. None

313

Table 119. Node - General Parameters.

Name
SNAPALGMS4

Format
Width
Opt/Mnd
Character

Sequence {Y, N}

Destination node mask for configuration


alignment at PGP start-up.

Sequence {Y, N}

Optional

First bit refers to node 1 in the node


definition, second bit refers to node 2,
and so on.

None

Character

Destination node mask for configuration


alignment at PGP start-up.

Sequence {Y, N}

Destination node maskPGP for


configuration alignment at PGP start-up.

Sequence {Y, N}

Destination node mask for configuration


alignment at PGP start-up.

Sequence {Y, N}

Destination node mask for chronological


alarm file alignment at PGP start-up.

Sequence {Y, N}

Optional

First bit refers to node 1 in the node


definition, second bit refers to node 2,
and so on.

None

Character

Destination node mask for chronological


alarm file alignment at PGP start-up.

Sequence {Y, N}

Optional
Character
16

CNFALGMS2

16
Optional
CNFALGMS3

Character
16
Optional

CNFALGMS4

Character
16
Optional

OJALGMSK

Character
16

OJALGMS2

16
Optional

314

Range
Default
Parameter(s)

Destination node mask for snapshot


alignment at PGP start-up.

16
CNFALGMSK

Description

16*N
The mask applies to nodes from 49 to 64 None
16*N

16*N
The mask applies to nodes from 17 to 32. None
16*N
The mask applies to nodes from 33 to 48. None
16*N
The mask applies to nodes from 49 to 64 None
16*N

16*N
The mask applies to nodes from 17 to 32. None

9AKK101130D1382

Table 119. Node - General Parameters.

Name
OJALGMS3

Format
Width
Opt/Mnd
Character

Sequence {Y, N}

Destination node mask for chronological


alarm file alignment at PGP start-up.

Sequence {Y, N}

Destination node mask for playback


alignment at (1) start-up.

Sequence {Y, N}

Optional

First bit refers to node 1 in the node


definition, second bit refers to node 2,
and so on.

None

Character

Destination node mask for playback


alignment at PGP start-up.

Sequence {Y, N}

Destination node mask for playback


alignment at PGP start-up.

Sequence {Y, N}

Destination node mask for playback


alignment at PGP start-up.

Sequence {Y, N}

Destination node mask for historical files


alignment at PGP start-up.

Sequence {Y, N}

First bit refers to node 1 in the node


definition, second bit refers to node 2,
and so on.

None

Optional
Character
16
Optional
PLBALGMSK

Character
16

PLBALGMS2

16
Optional
PLBALGMS3

Character
16
Optional

PLBALGMS4

Character
16
Optional

HISTALGMSK

Character
16
Optional

9AKK101130D1382

Range
Default
Parameter(s)

Destination node mask for chronological


alarm file alignment at PGP start-up.

16
OJALGMS4

Description

16*N
The mask applies to nodes from 33 to 48. None
16*N
The mask applies to nodes from 49 to 64 None
16*N

16*N
The mask applies to nodes from 17 to 32. None
16*N
The mask applies to nodes from 33 to 48. None
16*N
The mask applies to nodes from 49 to 64 None
16*N

315

Table 119. Node - General Parameters.


Format
Width
Opt/Mnd

Name
HISTALGMS2

Character
16
Optional

HISTALGMS3

Character
16
Optional

HISTALGMS4

Character
16
Optional

Description

Range
Default
Parameter(s)

Destination node mask for historical filesk Sequence {Y, N}


alignment at PGP start-up.
16*N
The mask applies to nodes from 17 to 32. None
Destination node mask for historical files
alignment at PGP start-up.

Sequence {Y, N}

Destination node mask for historical files


alignment at PGP start-up.

Sequence {Y, N}

16*N
The mask applies to nodes from 33 to 48. None
16*N
The mask applies to nodes from 49 to 64 None

(1)

316

9AKK101130D1382

Alarm Process Parameters


The fields in Table 120 define additional information for the alarm
processing of the node pseudo-tag.
Table 120. Node - Alarm Process Parameters.
Format
Width
Opt/Mnd

Name
DS_ALARM

DS_RTN

Range
Default
Parameter(s)

Description

Character

Display alarm flag.

{Y, N}

Optional

If set, an alarm message concerning this


pseudo-tag will be displayed on alarm
display page (LAD).

Character

Display flag for return to normal.

{Y, N}

If set, a RTN message concerning this


pseudo-tag will be displayed on alarm
display page (LAD).

Optional

None

None

The alarm acknowledge will remove the


message.
BOT_ALARM

Display flag for unacknowledged on


bottom.

{Y, N}

Optional

If set, a unacknowledged alarm


concerning this pseudo-tag will be
displayed on the bottom of screen
window.

None

Character

Remove flag on acknowledgment.

{Y, N}

Optional

On alarm acknowledgment the message


concerning this pseudo-tag is removed
from the alarm page.

Character

Log flag on alarm acknowledgment.

{Y, N}

When an alarm concerning this pseudotag is acknowledged a info message is


logged to the Operator Journal.

Character
1

REM_ONACK

INFO_ONACK

Optional

9AKK101130D1382

None

None

317

Table 120. Node - Alarm Process Parameters.


Format
Width
Opt/Mnd

Name
PR_ALARM

Range
Default
Parameter(s)

Description

Character

Print alarm flag.

{Y, N}

If set, an alarm message concerning this


pseudo-tag will be printed on the alarm
printer.

Optional

None

See the field ALMPRINTER also.


PR_OPACT

Character

Print flag for operator action message.

{Y, N}

If set, database modifications and all


other operator actions concerning this
pseudo-tag will be printed.

Optional

None

See the field ALMPRINTER also.


PR_RTN

Character

Print flag for return to normal message.

{Y, N}

If set, a RTN massage concerning this


pseudo-tag will be printed.

Optional

None

See the field ALMPRINTER also.


PR_INFO

SV_ALARM

SV_OPACT

Print flag for information message.

1
Optional

If set, a information message concerning N


this pseudo-tag will be printed.
None
See the field ALMPRINTER also.

Character

Save alarm flag.

1
Optional

If set, an alarm message concerning this Y


pseudo-tag will be logged to the Operator None
Journal.

Character

Save flag for operator action.

Y
If set, database modifications and all
other operator actions concerning this
None
pseudo-tag will be logged to the Operator
Journal.

Optional

318

{Y, N}

Character

{Y, N}

{Y, N}

9AKK101130D1382

Table 120. Node - Alarm Process Parameters.


Format
Width
Opt/Mnd

Name
SV_RTN

SV_INFO

ALMPRINTER

Range
Default
Parameter(s)

Description

{Y, N}

Character

Save flag for return to normal message.

1
Optional

Y
If set, a RTN message concerning this
pseudo-tag will be logged to the Operator None
Journal.

Character

Save flag for information message.

1
Optional

If set, a information message concerning Y


this pseudo-tag will be logged to the
None
Operator Journal.

Integer

Alarm printer index.

0
Reference index to the printer where
messages concerning the tag are printed. None
See the fields PR_xxx (e.g. PR_ALARM)
also.

Optional

{Y, N}

It is a pointer to a registry defining the


alarm printer. Refer to the system option
configuration for details.
ALMGROUP

AL_PRI

Integer

Alarm group.

{0, 1...272}

Optional

Refer to the same field of the tag


database for a complete description.

Integer

Alarm priority.

{0, 1...15}

Refer to the same field of the tag


database for a complete description.

Activate flag for audible signals on alarm


occurrences.

{Y,N}

Optional
AUD_ALARM

Character
1
Optional

9AKK101130D1382

[sladnm] and
[mxxagp]

[mxalpr] and
[mxxapr]
Y
None

319

Table 120. Node - Alarm Process Parameters.


Format
Width
Opt/Mnd

Name
AUDINDEX

Integer

Audible alarm index.

{0, 1...32}

This field defines the index into audible


alarm database to determine which
audible is to be activated upon alarm
and/or return to normal.

Print flag for audible signal on return to


normal.

{Y, N}

Optional

AUD_RTN

Character
1

EXP_ALA

Character

Application program activation flag.

{Y,N}

If set, trigger an application program on


alarm occurrence.

Optional
Character

Relational database update flag.

{Y,N}

If set, alarm messages are automatically


sent to the external relational database.

Optional

320

[mxaud]

None

Optional
APPL_ALA

Range
Default
Parameter(s)

Description

None

None

9AKK101130D1382

Security Subsystem
Security
Outline
PGP offers a security subsystem allowing definition of internal users. Each
user is identified by a name and a password.
A set of access rights and permissions can be assigned to each user. In
such a way access to PGP functions or operations (e.g. tag configuration)
can be denied.
In configuring PGP, 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.
PGP provides the following validity masks:
Tag Access Right Mask.
Enable or disable operations related to single tags. The following security
rights are defined:

9AKK101130D1382

Monitor,

321

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.

322

9AKK101130D1382

The security definition file contains the information to define the User
Authorization File and to provide operator passwords.
PGP 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 PGP 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.

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 application PGP (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 will be used to
compile PGP 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 PGP internal database. If a target database does not exist,
the builder processor creates it using the whole PGP 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.

Security Definition
The following sections list a set of parameters to define a PGP user. There
are both mandatory and optional parameters.

9AKK101130D1382

323

General Parameters
The fields in Table 121 define the name and other additional parameters
used to identify the PGP user.
Table 121. Security - General Parameters.
Format
Width
Opt/Mnd

Name
USERINDEX

USERNAME

PASSWORD

Description

Range
Default
Parameter(s)
{0...20}

Integer

User index.

3
Optional

0
This field identifies the PGP user by
number. It must be unique for each user [n.pswd]
in the database. If omitted or zero (blank),
the first vacant index will be allocated.

Character

User name.

<string>

18

<blank>

Mandatory

This field identifies the PGP user by


name. It must be unique for each user in
the database.

Character

User password.

<string>

18

The export function does not fill in this


field to prevent password decoding.

<blank>

Mandatory

[szunam]

[szunam]

A new created security database file does


not include the field.
See also the caution Note at the end of
the table.
CRYPTPWD1

Integer

Encrypted user password.

18

The export function fills in this field.

Mandatory

A new created security database file


includes the field.

None

See also the caution Note at the end of


the table.

324

9AKK101130D1382

Table 121. Security - General Parameters.


Format
Width
Opt/Mnd

Name
USERCODE

LANGUAGE

Integer

User code.

4
Optional

Numeric code, such as a payroll code,


associated to the user. It is used only for
display purposes.

Integer

Man machine interface language.

The value 0 defaults to the English


language. Any other value set an
alternate language. Of course, the
dictionary for such alternate language
must be defined.

Optional

ACTIVE USER

Character
1
Mandatory

WINGROUP

Character
64
Optional

9AKK101130D1382

Range
Default
Parameter(s)

Description

0
None

0
None

Define if the inserted item refers to a real <string>


user or identify a Users group
<blank>
[szunam]
Define if the inserted item refers to a real <string>
user or identify a Users group
<blank>
[szunam]

325

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

326

9AKK101130D1382

Access Control Parameters


The fields in Table 122 define access control parameters used to restrict
user accesses and to prevent unauthorized accesses.
Table 122. Security - Access Control Parameters.
Format
Width
Opt/Mnd

Name
LOGOFFTMO

Range
Default
Parameter(s)

Description

Character

Log-off on time-out.

{Y,N}

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.

Optional

None

Automatic log-off is forced when the


screen saver time-out expires.
LOGINDISP

LOGOFFDISP

LOGINPROG

LOGOFFPROG

Character

Log-in display.

9
Optional

Name of a mimic displayed when the user <blank>


logs in.
None

Character

Log-off display.

9
Optional

Name of a mimic displayed when the user <blank>


logs out or the time-out forces a log out. None

Character

Log-in program.

<string>

Name of the application program to run


when the user logs in.

<blank>

Optional
Character

Log-off program.

<string>

Name of the application program to run


when the user logs out or the time-out
forces a log out.

<blank>

Optional

9AKK101130D1382

<string>

<string>

None

None

327

Table 122. Security - Access Control Parameters.


Format
Width
Opt/Mnd

Name
MAXLOGINFAIL

Range
Default
Parameter(s)

Description

Integer

Maximum number of log-in trials.

{0, 1...9999}

The user is no longer allowed to log-in


after the maximum number of trials is
reached and wrong passwords have
been typed at each log-in trial.

Optional

None

The user is locked.


The system manager must manually
unlock the user in order to allow user
logging-in again.
PWDAGING

Password aging (number of days).

After that time has elapsed, the user is no 0


longer allowed to log-in. The user must
None
change the password before its expiration
or the system manager must set a new
password after expiration.

Optional

328

{0, 1...9999}

Integer

9AKK101130D1382

Access Security Parameters


The fields in Table 123 define security parameters to operate on single tags.
Table 123. Security - Tag Operation Parameters.
Format
Width
Opt/Mnd

Name
TAGMONITOR

TAGCONFIG

TAGCONTROL

Character

Privilege to monitor tags.

Optional

None

Character

Privilege to configure tags.

TAGENTDATA

TAGOFFSCAN

9AKK101130D1382

{Y,N}

Optional

None

Character

Privilege to execute process control on


tags.

Optional

TAGDELETE

{Y,N}

1
TAGTUNE

Range
Default
Parameter(s)

Description

Character

{Y,N}
N
None

Privilege to tune the process tags.

{Y,N}

Optional

None

Character

Privilege to delete tags.

{Y,N}

Optional

None

Character

Privilege to perform data entry on tags.

{Y,N}

Optional

None

Character

Privilege to put tags off scan and on scan. {Y,N}

Optional

None

329

Table 123. Security - Tag Operation Parameters.


Format
Width
Opt/Mnd

Name
TAGOFFALM

Character
1

Privilege to put tags off alarm check and


on alarm check.

Optional
TAGLIMIT

TAGACK

TAGMONALL

TAGREMOTE

TAGENTHIST

Character

Range
Default
Parameter(s)

Description

{Y,N}
N
None

Privilege to change alarm limits of tags.

{Y,N}

Optional

None

Character

Privilege to acknowledge alarms.

{Y,N}

Optional

None

Character

Privilege to perform full tag monitoring.

{Y,N}

1
Optional

Security level and security group check is N


bypassed.
None

Character

Privilege for remote access on tags.

{Y,N}

Optional

None

Character

Privilege to enter historical data on tags.

{Y,N}

Optional

None

The fields in Table 124 define security parameters to grant access to


various PGP functions.

330

9AKK101130D1382

Table 124. Security - Privilege Parameters.


Format
Width
Opt/Mnd

Name
ALARMS

Character
1

Privilege for executing general alarm


management.

Character
1

Privilege for accessing specific


application functions.

Optional
APPL2

Character
1

CLSERVER

Character

Privilege for accessing specific


application functions.

Privilege for configuring calculations.

{Y,N}

Optional

None

Character

Character
Optional
Character
1

Privilege for accessing the client/server


functions.

Character
1
Optional

{Y,N}
N
None

Privilege for configuring some


miscellaneous functions (such as
engineering units and logic state
descriptors).

{Y,N}

Privilege for executing diagnostic


functions.

{Y,N}

Optional

9AKK101130D1382

{Y,N}

GRAPHICS

None

Optional

DIAGNOSTIC

{Y,N}

1
CONFIG

None

Optional
CALCUL

{Y,N}
None

Optional
APPL1

Range
Default
Parameter(s)

Description

N
None

N
None

Privilege for performing mimic


configuration.

{Y,N}
N
None

331

Table 124. Security - Privilege Parameters.


Format
Width
Opt/Mnd

Name
GROUPS

Character
1

Privilege for configuring historical and


realtime groups.

Optional
HISTORY

Character
1
Optional

INFINET

Character
1
Character
1
Optional

LTERMHIST

Character
1
Character
1

{Y,N}

Privilege for executing functions related


to the C-NET modules.

{Y,N}

Character
1

Privilege for modifying the configuration


of the reports, for triggering and deleting
archived reports.

Character
1
Optional

332

None
N
{Y,N}
N
None

Privilege for executing long term historical {Y,N}


functions.
N
None
Privilege for navigating through WEB
pages.

{Y,N}
N
None

Privilege for configuring the ODBC


functions.

Optional
REMWRITEF

None

Optional
ODBC

Privilege for performing general historic


functions (such as initializing the
historical counters).

Optional
NAVIGATE

{Y,N}
None

Optional
LOGS

Range
Default
Parameter(s)

Description

{Y,N}
N
None

Privilege for writing a file in remote


access (such as using DDE functions).

{Y,N}
N
None

9AKK101130D1382

Table 124. Security - Privilege Parameters.


Format
Width
Opt/Mnd

Name
SECURITY

Character
1

Privilege for accessing and modifying


security and users.

Optional
TIMEDATE

TRENDS

UTILITY

Character

Privilege for setting the time and date.

Optional

None

Character

Privilege for accessing trend functions.

Optional

None

Character

Character

Privilege for executing general utility


functions.

{Y,N}
N
None

Privilege for displaying the configuration


databases.

{Y,N}
N
None

Character

Privilege for viewing displays.

{Y,N}

Optional

If set, display viewing is submitted to


security group check also.

Character

Privilege for viewing historical data.

{Y,N}

None

Optional

None

Character
1
Optional

9AKK101130D1382

{Y,N}

Optional

WINDOWSNT

{Y,N}
N

VIEWHIST

N
None

Optional

VIEWDISP

{Y,N}

1
VIEWCONFIG

Range
Default
Parameter(s)

Description

Privilege for accessing Windows


functions (such as window sizing,
Windows desktop usage).

{Y,N}
N
None

333

The fields in Table 125 define the security group mask. Each field refers to a
security group. Another field to control the access is the security level.
Table 125. Security - Group and Level Parameters.
Format
Width
Opt/Mnd

Name
SECGROUP1

Character
1

Range
Default
Parameter(s)

Description
Privilege to access tags and displays
belonging to the security group 1.

{Y,N}
N
None

Optional
.....................

.............

.....................................

........................

SECGROUP32

Character

Privilege to access tags and displays


belonging to the security group 32.

{Y,N}

1
Optional
SEC_LEVEL

N
None

Integer

Security level.

{0, 1...16}

This field is used for security checking


whenever a user attempts to operate on
PGP.

Optional

None

Only if the value is greater or equal the


security level of the requested function
the user gains access.

334

9AKK101130D1382

Client Parameters
The fields in Table 126 define the remote access parameters. They 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 126. Security - Remote Access Parameters.

Name
CRTMASK1

Format
Width
Opt/Mnd

Description

Range
Default
Parameter(s)

Character

Crt enable mask.

Sequence {Y, N}

16

The bit mask allows enabling access or


preventing access to clients.

16*Y

Optional

None

The mask applies to clients from 1 to 16.


Character

Crt enable mask.

Sequence {Y, N}

16

Same as CRTMASK1 above.

16*Y

Optional

The mask applies to clients from 17 to 32. None

Character

Plant unit enable mask 1.

Sequence {Y, N}

16

16*N

Optional

The current user can only access to the


plant units enabled.

.....................

.............

.....................................

........................

PLANTUMSK9

Character

Plant unit enable mask 9.

Sequence {Y, N}

16

Same as above.

16*N

CRTMASK2

PLANTUMSK1

Optional
PLANTUMS10

None

Character

Plant unit enable mask 10.

Sequence {Y, N}

16

The current user can only access to the


plant units enabled.

16*N

Optional

9AKK101130D1382

None

None

335

Table 126. Security - Remote Access Parameters.

Name

Format
Width
Opt/Mnd

Description

Range
Default
Parameter(s)

.....................

.............

.....................................

........................

PLANTUMS16

Character

Plant unit enable mask 16.

Sequence {Y, N}

16

Same as above.

16*N

Optional

None

Enhanced User Management


Since these releases the Logon function was provided only for Power
Generation Portal defined users, based on a Power Generation Portal 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 does not
correspond to an 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 that user records and group template records can be mixed inside the
User Database.
The Logon function provided by Power Generation Portal has been
enhanced in the following way.

336

9AKK101130D1382

When an user try to logon on Power Generation Portal, providing Username


and Password, the Power Generation Portal 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 Power
Generation Portal 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 Power Generation Portal logon function will continue providing to the
new logged user the security characteristics that are defined in the Power
Generation Portal group template record.
The previously described feature allows an independent management of
users between Power Generation Portal and the Operating System. In
Power Generation Portal, the definition of group templates is mainly related
to the specific features of Power Generation Portal, 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 Power
Generation Portal 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 Power Generation
Portal HMI interface (TntExplorer) is activated, also takes into consideration
the previously described feature. This gives the possibility to apply the
Power Generation Portal 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 Power Generation Portal.

9AKK101130D1382

337

How to define Windows Users


The link between Power Generation Portal users and Windows users is
provided by means of group template records defined into the Power
Generation Portal 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 Power Generation Portal 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 Power
Generation Portal 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 correspond to the ones defined in Power Generation Portal.
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.
Select Groups and perform the Action: New Group.
Add one or more group corresponding to the ones defined into the Power
Generation Portal User Database. Referring to the sample, you have to add:
Power Generation Portal Guests
Power Generation Portal Users
Power Generation Portal Administrators

338

9AKK101130D1382

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 previously described procedures may also be applied on a domain
server, centralizing the user management

Some Hints
In case Power Generation Portal is started by an Interactive User (i.e. not
started as a Window Service), then the currently logged user has to have
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
Power Generation Portal Setup is performed.
Whenever a Power Generation Portal User Logon is performed the Power
Generation Portal User Database is scanned first, then the Windows
Database is checked. In case of duplicated names the Power Generation
Portal 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 Power Generation Portal group.
In case of multiple assignments then the first in the alphabetical order will be
considered.

9AKK101130D1382

339

Security Defaults
PGP provides a default security configuration to grant its basic operation.
This section lists those default settings in Table 127 The table lists security
level, security groups, tag operation rights and privileges of each user.
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 127. Security - Default Settings.
User Name

Password

Sec.
Level

Sec.
Groups

Tag Operation Rights

Privileges

OPERATOR

LEVEL0

All

TagMonitor,
TagControl, TagAck

ViewDisp

ENGINEER

LEVEL1

All

TagMonitor,
TagConfig, TagDelete,
TagEntData,
TagOffScan,
TagOffAlm, TagLimit.

Alarms, Graphics,
Logs, History, Security,
TimeDate, Trends,
Infinet, Groups, Utility,
ViewConfig, ViewDisp,
LTermHist, ClServer,
Calcul, ViewHist,
Windows.

SYSMGR

PRIV

16

All

All rights.

All privileges.

340

9AKK101130D1382

Foreign Database Support Subsystem


Foreign Database
Outline
PGP supports interaction with a wide range of commercial database
managers, by exporting its internal data structures via ODBC standard. In
this environment, PGP 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, PGP 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.
PGP 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 whats 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.

Target Database Requirements


The target database can be any commercial DBMS providing an ODBC
driver for Windows. Actually, PGP fully supports

9AKK101130D1382

MS Access,

341

MS SQL Server 6.5 and

Oracle 8

The target DBMS engine may run on the same machine as PGP, as well as
on a remote machine connected via network.
Although PGP 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 PGP, 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 PGP 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.

Static Tables
As mentioned, 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 PGP
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 PGP by compiling a deckfile for database cross reference builder DBXRF (see Configuration Guide)
before the tables are created on target database. Once a table is created,
initialized and aligned, its structure must never change, unless another
realignment is made.
Static tables are created and initialized by PGP at system generation time,
regardless they already exist or not. Then, they are updated whenever the

342

9AKK101130D1382

system processes a change in the configuration of tags and trend groups,


either the system is active or not.
If no error occurs, PGP 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 PGP database files to prevent such a
case.
The data type of the fields is function of the target DBMS. Table 128 and
Table 129 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.
Table 128. Foreign Database Support - Tag Static Table (TAGS).
Format
Width
Opt/Mnd

Name
TAGINDEX

Decimal

Description

Range
Default
Parameter(s)

Tag index.

6
Optional
TAGNAME

Character2

None
Tag name.

20
Optional
TAGDESC

Character2

None
Tag description.

64
Optional

9AKK101130D1382

None

343

Table 128. Foreign Database Support - Tag Static Table (TAGS).


Format
Width
Opt/Mnd

Name
TAGTYPE

Character2

Description

Range
Default
Parameter(s)

Tag type.

8
Optional
EUDESC

Character2

None
Engineering unit description.

16
Optional
VAL0

Dbl. Prec.

None
Value of 0% scale.

Optional
SPAN

Dbl. Prec.

None
Instrument range.

Optional
ZEROSTATE

Character2

None
Descriptor for state 0.

16
Optional
ONESTATE

Character2

None
Descriptor for state 1.

16
Optional
TWOSTATE

Character2

None
Descriptor for state 2.

16
Optional

344

None

9AKK101130D1382

Table 128. Foreign Database Support - Tag Static Table (TAGS).


Format
Width
Opt/Mnd

Name
THREESTATE

Character2

Description

Range
Default
Parameter(s)

Descriptor for state 3.

16
Optional
FOURSTATE

Character2

None
Descriptor for state 4.

16
Optional

None

Table 129. Foreign Database Support - Trend Groups Static Table (GROUPS).
Format
Width
Opt/Mnd

Name
GROUPINDEX

Decimal

Description

Range
Default
Parameter(s)

Group index.

6
Optional
GROUPNAME

Character2

None
Group name.

20
Optional
GROUPDESC

Character2

None
Group description.

64
Optional
ARCHTYPE

Character2

None
Archive type.

7
Optional

9AKK101130D1382

None

345

Table 129. Foreign Database Support - Trend Groups Static Table (GROUPS).
Format
Width
Opt/Mnd

Name
EUDESC

Character2

Description

Range
Default
Parameter(s)

Engineering unit description.

16
Optional
ARCHFRQ

Decimal

None
Archive frequency.

6
Optional
ARCHUNITS

Decimal

None
Archive time units.

6
Optional
OFFSET

Decimal

None
Archive time offset.

6
Optional
OFFSUNITS

Decimal

None
Archive time offset units.

6
Optional
SAMPLFRQ

Decimal

None
Sample frequency.

6
Optional
SAMPLUNITS

Decimal

None
Sample time units.

6
Optional
TOTSAMPLES

Decimal

None
Total number of samples.

6
Optional

346

None

9AKK101130D1382

Table 129. Foreign Database Support - Trend Groups Static Table (GROUPS).
Format
Width
Opt/Mnd

Name
TAG1

Character2

Description

Range
Default
Parameter(s)

Name of the 1st tag in the group.

20
Optional

None

..................

...............

.................................................

TAG60

Character2

Name of the 60th tag in the group.

.........

20
Optional

None

Dynamic tables
As mentioned, 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 PGP
database. That is, target databases 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 PGP
by compiling a deck-file for database cross reference builder DBXRF (see
Configuration Guide) 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, PGP 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.

9AKK101130D1382

347

The tag dynamic table is updated whenever PGP 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 PGP 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 PGP 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 130,
Table 131 and Table 132 give a sample structure for dynamic tables,
assuming the target DBMS is Oracle8.
Table 130. Foreign Database Support - Tag Dynamic Table (RTDB).
Format
Width
Opt/Mnd

Name
TAGTIME

Date

Description
Tag time and date.

Optional
TAGMILSEC

Decimal

Range
Default
Parameter(s)

None
Tag milliseconds.

3
Optional

348

None

9AKK101130D1382

Table 130. Foreign Database Support - Tag Dynamic Table (RTDB).


Format
Width
Opt/Mnd

Name
TAGINDEX

Decimal

Description

Range
Default
Parameter(s)

Tag index.

6
Optional
TAGUID

Character2

None
Tag unique identification.

36
Optional
TAGVALUE

Dbl. Prec.

None
Tag value.

Optional
TAGSTATE

Character2

None
Tag state.

16
Optional
TAGQUALITY

Character2

[sztags]
Tag quality.

4
Optional

9AKK101130D1382

None

349

Table 131. Foreign Database Support - Alarm Dynamic Table (ALARMS).


Format
Width
Opt/Mnd

Name
ALARMTIME

Date

Description
Alarm message time and date.

Optional
ALARMILSEC

Decimal

Range
Default
Parameter(s)

None
Alarm message milliseconds.

3,0
Optional
TAGINDEX

Decimal

None
Tag index.

6
Optional
TAGUID

Character2

None
Tag unique identification.

36
Optional
ALARMTYPE

Character2

None
Alarm type.

6
Optional
ALARMTEXT

Character2

None
Alarm text.

132
Optional

350

[s.aldb]

9AKK101130D1382

Table 132. Foreign Database Support - Group Dynamic Table (<group name>).
Name
TAGTIME

Fmt
Date

Description
Tag time and date.

Optional
TAGMILSEC

Decimal

Param

None
Tag milliseconds.

3
Optional
TAGINDEX

Decimal

None
Tag index.

6
None
TAGVALUE

Dbl.Prec.

Tag value.
None

TAGSTATE

Character2

Tag state.

16
[sztags]
TAGQUALITY

Character2

Tag quality.

2
None
TRIPTIME

Date
Optional

9AKK101130D1382

Trip time and date.


None

351

Table 132. Foreign Database Support - Group Dynamic Table (<group name>).
Name

Fmt

TRIPMILSEC

Decimal

Description

Param

Trip milliseconds.

3
Optional
GROUPINDEX

Decimal

None
Group index.

6
Optional

None

Data Export Manager


PGP 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 PGP has been configured to support
the ODBC interface):

Connect PGP 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 PGP 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.

352

9AKK101130D1382

The first time the program is activated, it creates a new data source
specifically dedicated to PGP. 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 manufacturers documentation. After the data source has been
properly setup, the program will ask the operator to make the selection
permanent and to link all PGP 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 PGP 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, PGP 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 PGP 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:

Each table in list may be inspected to get its structure by the function
Properties, associated with the icon key:

9AKK101130D1382

353

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.

Setup Guidelines
The support to foreign database export may be added at any time to an
existing (and licensed) PGP 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:

354

Create or modify the system option customizations. Use the


SYSSETUP utility to turn the database export flag OdbcInterface to
YES.

9AKK101130D1382

Create or modify the data export customization file DBXRF2DECK.INS


in folder PGP\Config, adding those fields that need to be exported in
addition to standard exported fields, according to the instructions
contained in the Configuration Guide.

Run the Data Export Manager and define the PGP specific data
source, according to whats 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


PGP database (Build All procedure).

Tuning and Troubleshooting


PGP logs all unsuccessful queries and function calls in standard error log
file (PGP\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:
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 registry entry:
%PGP registry root%\APPS\ODBC\BufferSize
Use the SYSSETUP utility to tune registry value. After the change, the
system must be restarted.

9AKK101130D1382

355

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).
The registry key:
%PGP registry root%\APPS\ODBC
also contains other entries that can be changed to tune the foreign database
support. These registry entries are listed below:
AcceptWarning.
If 0, ODBC warnings will be considered as errors.
If 1, ODBC warnings will be considered ok. The default is 1.
TraceQuery.
If 1, all queries will be traced on a log file (PGP\logs\TraceQuery.Txt). This
feature may be useful to debug target DBMS problems, but must be
normally set to 0 (the default).
AlarmTable.
Name of alarm dynamic table. The default is ALARMS.
GroupTable.
Name of trend group static table. The default is GROUPS.
RtdbTable.
Name of tag dynamic table. The default is RTDB.

356

9AKK101130D1382

TagTable.
Name of 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.

9AKK101130D1382

357

358

9AKK101130D1382

Section 3 System Configuration


Server Configuration Subsystem
Direct Access File System
PGP operates using a set of data files that store configuration information,
run time information, etc. This set of files is the PGP Direct Access File
System (DAFS).
The file BFILDECK.XML, located in the \Deck folder, defines the PGP direct
access file system.
The file BFIL2DECK.XML, located in the \Config\Deck folder, may define the
application specific direct access file system.
Both files define the entire direct access file system. The format of the two
files is the same.
The base PGP does not provide an empty BFIL2DECK file. It may be
derived from BFILDECK when application specific files must be added.
The processor BFIL performs the configuration of Direct Access File
System. The XML format, support the standard XMl syntax, and is defined in
the following example:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<DAFS_FILES action="xxx">
<dafs_file name="xxx" key="xxx" descr="xxx" type="xxx" records="xxx" size=xxx
path=xxx remote_write=xxx save_snapshot=xxx save_initial=xxx
skip_initialization=xxx/>
...
...
</DAFS_FILES>

9AKK101130D1382

353

In the following description lists the parameters that are defined as xxx in
the previous XML snapshot. They define the structure of the file. The form
essentially defines the file key, the number of records and the record size.
Files defined here may be disk files, core files (memory resident) and
parallel files.
Parallel files are both disk and memory resident. At PGP start-up time the
contents of a parallel file is copied from the disk file to the memory.
Table 133. Builder BFIL XML Format File System General Definition.
Parameter
action

Format
Opt/Mnd
Character

Action Code.

Mandatory

Allowed action codes are:

Range
Default
{init, add, replace,
delete}

init - Initialize disk resident file directory,

None

Description

add - Add file to disk resident file directory,


replace - Replace file to disk resident file
directory,
delete - Delete file from disk resident
directory.

name

Character
Mandatory

description

Character
Optional

type

A maximum of [N.DIR] files may be added


to the file system.
File name.
This field is defined the name of the file as
a 6 character string.
File description.

<string>
<blank>
<string>

Character

Free format description of the data file, as a <blank>


32 character string.
{D,C,P}
File type.

Mandatory

Allowed file types are:

None

D - Disk file,
C - Core file,
P - Parallel file.

354

9AKK101130D1382

Table 133. Builder BFIL XML Format File System General Definition.
Parameter
key

Format
Opt/Mnd
Character
Mandatory

path

Character
Optional

records

Character
Mandatory

remote_write

Character
Optional

size

Character
Optional

save_snapshot

Character
Optional

save_initial

Character
Optional

9AKK101130D1382

Description
File key.
The file key is an integer numeric name of
three digits, which refer to the file.
It must correspond with the number
assegned internally to the software for
accessing the files.
Specifies the path of the file.

Range
Default
{1...999}
None

None

If a valid file path is not specified, the file is None


assumed to be: key.DAT (located in the
\Data folder) where key is specified in the
file key field on card
{1...65535}
Number of records in the file.
The number of records is an integer
numeric value.

None

It can be directly defined using a numeric


value, or using an Ascii string, whic refer to
the corresponding parameter defined in the
registry, under the sizes folder.
Remote file writing enabled.
{Y,N}
If set, a remote client can update the file via N
DDE service.
{0, 1...65535}
Record size in words.
The size of records is an integer numeric
value.
If it is 0 the system supplies the size of the
internal structure which defines the record
of file.
Snapshot file.
If set, the file will be created on multiple
snapshot folders for simulation purposes.
Save Initial condition file.
If set, the file will be saved as intial
condition for simulation purposes.

{Y,N}
N
{Y,N}
N

355

Table 133. Builder BFIL XML Format File System General Definition.
Format
Opt/Mnd
skip_initialization Character
Parameter

Optional

Range
Default

Description
Skip Initialization.

{Y,N}

If set, the file will not be initilized when


created.

Process Scheduling
Process scheduling allows management of timers in order to activate
system and possibly application programs.
These functions take typically place when timers expire.
The file BTIMDECK.XML, located in the \Deck folder, defines the PGP
timers for process scheduling and the file BFIL2DECK, located in the
\Config\Deck folder, may define the application specific timers. Both files
define the whole system timers. The format of the two files is the same.
The base PGP does not provide an empty BTIM2DECK file. It may be
derived from BTIMDECK when application specific timers must be added.
The processor BTIM performs the definition of timers. The XML format,
support the standard XMl syntax, and is defined in the following example:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<TIMERS action="xxx">
<TIMER name=xxx" active=xxx" frequency=xxx" freq_unit=xxx" offset=xxx"
offs_unit=xxx" delay=xxx" delay_unit=xxx"/>
...
...
</TIMERS>

Timer definition parameters, defined as xxx in the previous XML snapshot,


are listed in the following table.

356

9AKK101130D1382

Table 134. Builder BTIM - Timer Definition.


Parameter
action

Format
Opt/Mnd
Character

Action code.

Range
Default
{init,add,replace}

Mandatory

Allowed action codes are:

None

Description

init - Initialize timer definition file,


add - Add timer definition,
replace - Replace timer definition,
name

Character

frequency

Mandatory
Integer

A maximum of [N.SCTM] timers can be added.


Timer name., according to the internal software None
definition
None
Timer Period.

freq_unit

Optional
Character

A value of 0 means self scheduled process.


Units for timer period.

0
None}

Optional

Allowed values are: sec, min, hour, day,


month, year
Timer offset.

None

offset

Integer
Optional

offs_unit

Character
1Optional

delay

Integer
Optional

9AKK101130D1382

It specifies a time value added to the base time 0


before timer is executed. Base time depends on
timer period units. If timer period unit is
seconds: base time begins at last minute. If
timer period unit is minutes: base time begins at
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 Mondays
midnight. Delay must be less than timer period.
Units for timer offset.
Allowed values are: sec, min, hour, day,
month, year.Timer offset must be less than
timer period.
Initial delay.

None

It specifies a delay to apply before to start the


timer.

357

Table 134. Builder BTIM - Timer Definition.


Parameter
delay_unit

Format
Opt/Mnd
Character
Optional

active

Range
Default

Description
Units for initial delay.

Character

Allowed values are: sec, min, hour, day,


month, year
Active flag.

None
{Y,N}

Mandatory

Specifies if the timer is active or not.

Daylight Saving Time


The daylight saving time builder provides the capability to define the DST
periods by specifying a start date and an end date. During this period of time
the PGP automatically increments 1 hour the system date and time.
The file BDSTDECK.XML, located in the \Deck folder, defines the standard
daylight saving time dates of several locations around the world and the file
BFIL2DECK.XML, located in the \Config\Deck folder, may define the
application specific dates. Both files define the whole DST. The format of the
two files is the same.
The base PGP does not provide an empty BDST2DECK file. It may be
derived from BDSTDECK when application specific dates to be added
The configuration of DayLight Saving Time periods is performed considering
the Time Zone Regional Settings provided for the Time And Data Properties
from the Windows Control Panel. Only the DST_PERIODS matching the
locale settings are processed. Furthermore, if the local zone is not listed in
the provided BDSTDECK.XML file an AUTO option is available: DST
periods are generated automatically starting from the definitions contained
in the Windows Operating System.
The processor BDST performs the configuration of daylight saving time
dates. The XML format, support the standard XMl syntax, and is defined in
the following example:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<DST_PERIODS action="xxx" timezone=xxx auto=xxx>

358

9AKK101130D1382

<DST_PERIOD start=xxx" end=xxx" />


...
...
</DST_PERIODS>

DST definition parameters, defined as xxx in the previous XML snapshot,


are listed in the following table.
Table 135. Builder BDST Daylight Saving Time Definition.
Column
action

Format
Opt/Mnd
Character

Action code.

Range
Default
{init, add}

Mandatory

Allowed action codes are:

None

Description

add - Add a DST definition,


init - iInitialize the DST definition file,
timezone Character

A maximum of 30 records may be added .


Timezone description, according to the Windows
Control Panel definition

<string>

<string>

auto

Character

None
Automatic generation of DST Periods starting from {yes, no}
Windows Operating System
No

start

Character

Daylight Saving Time start date.

Mandatory

Start date DST is in the ISO-SQL standard format None


yyyy-mm-dd hh:mm:ss, which is independent form
interface language.
<string>
Daylight Saving Time enddate.

end

Character
Mandatory

9AKK101130D1382

Start date DST is in the ISO-SQL standard format None


yyyy-mm-dd hh:mm:ss, which is independent form
interface language.

359

Operator Station Subsystem


Language
The Language definition file provides the system a dictionary to translate
texts used in the man machine interface. The default language is English.
Foreign languages are supported providing the dictionary.
The file BLANGDECK.XML, located in the \Deck folder, defines the PGP
default dictionary and the file BLANG2DECK.XML, located in the
\Config\Deck folder, may define an application specific dictionary. Both files
define the dictionary of the whole system. The format of the two files is the
same.
The base PGP provides an empty BLANG2DECK file. It may be completed
when an application specific dictionary must be added.
The processor BLANG is used to define the translation dictionary,
processing a free format, slightly different from the others, DECK file.
A set of strings, enclosed between double quotes, forms the dictionary. The
first string of the set must be the English text of the string and must be
preceded by the keyword ENGLISH.
Additional strings, which are translated into national languages, must be
preceded by the keyword related to the national language. For example
Italian strings must be preceded by the keyword ITALIAN.
The dictionary can be multi-language. Multiple translation lines may follow
the ENGLISH line to allow changing languages on an application.
To support non-ASCII languages, the files is Unicode compliant. For such
reason it must be edited using any unicode compliant editor.
Special characters, such as &, have to be defined according to the XML
syntax rules (in the previuous example as &amp;). Avoid to use Microsoft
WORD since it manipulates those special characters
The processor BLANG performs the configuration of multilanguage texts.
The XML format, support the standard XMl syntax, and is defined in the
following example:

360

9AKK101130D1382

<?xml version="1.0" encoding="UTF-16" standalone="no"?>


<POWER GENERATION PORTAL_TEXTS>
<TEXT english=xxx" italian=yyyy" french=zzzz />
...
...
</POWER GENERATION PORTAL_TEXTS>

where yyyy and zzzz represent respectively the italian and the french
translation of the english text xxxx.
Of course other languages can be added.

Database Subsystem
Field Assignment Cross-Reference
The Field Assignment Cross-Reference definition file (DBXRFDECK.XML
located in the \Deck folder) contains all field definitions and all site-specific
changes to be used when processing a database file. Database files are the
tag database file, the trend group database file, the calculation database file,
the tag related (engineering units, alarm comments, logical state descriptors
and text selectors) database files, the node network database file, the
pegboard database file, the alarm grouping database file.
The file DBXRFDECK, located in the \Deck folder, defines the PGP field
assignment definition and the file BFIL2DECK.XML, located in the
\Config\Deck folder, may define the application specific field assignments.
Both files define the field assignment definition of the whole system. The
format of the two files is the same.
The base PGP does not provide an empty DBXRF2DECK file. It may be
derived from DBXRFDECK when application specific field assignments
must be added.

9AKK101130D1382

361

The processor DBXRF performs the definition of field assignments. The


XML format, support the standard XMl syntax, and is defined in the following
example:
<?xml version="1.0" encoding="UTF-16" standalone="no"?>
<DB_XREFS>
<DB_XREF name=xxx" descr=xxx" code=xxx default=xxx callback=xxx
unbuild_callback=xxx dbfunbuild=xxx xlsunbuild=xxx>
<ITEMTYPE type=xxx/>
...
<ALIAS name=xxx flags=xxx />
...
<UNBUILD name=xxx type=xxx length=xxx dbf=xxx xls=xxx />
</DB_XREF>
...
...
</DB_XREFS>

The assignment may be either direct or by call-back. If direct assignment is


selected, the PGP field will be directly filled with the content of input field. If
call-back assignment is selected, the PGP field will be filled with the output
value returned by the call-back. A call-back uses input field(s) to evaluate
the output value.
A wrong compilation of PGP database structures may result in
configuration errors as well as in unexpected operations.
Timer definition parameters, defined as xxx in the previous XML snapshot,
are listed in the following table

362

9AKK101130D1382

Table 136. Builder DBXRF - Database Field Assignment Definition.


Column
action

Format
Opt/Mnd
Character

Action code.

Mandatory

Allowed action codes are:

Range
Default
{init,add,replac
e}

init - Initialize DBXRF definition file,

None

Description

add - Add DBXRF definition,


replace - Replace DBXRF definition,

descr

Character

A maximum of 1200 definitions can be added.


DB_XREF
The name of the database fileld. It correspond to <string>
the name of the column in the DBF or XLS file.
None
Notice that DBF limit the column names to 10
characters.
The description of the database field.
<string>

code

Optional
Character

This filed is limited to 28 characters.


Reference of database field.

None
<string>

Mandatory

It uniquely identifies the field to allow handling


during database processing.

None

name

Character
Mandatory

Field reference is an string value and may be


specified according to the parameter file
LOADPRM which include the symbols.

default

Character
Optional

callback

Character
Optional

Symbolic prefixes for word offsets are listed in


the Appendix A.
Default value.
The default value is assigned when field is not
defined within the input database.
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).

<string>
None

<string>
None

If no name is supplied, direct field assignment is


selected.

9AKK101130D1382

363

Table 136. Builder DBXRF - Database Field Assignment Definition.


Format
Opt/Mnd
unbuild_callback Character
Column

dbfunbuild

Optional
Character
Optional

Export call-back name (case sensitive).

Range
Default
<string>

DBF Export inhibit flag.

None
{Y, N}

Description

If set, the field is considered optional and will not N


be created upon database export. Otherwise it is
mandatory and it will be created.
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 will
be exported, ignoring the export inhibit flag
setting.

xlsunbuild

Character
Optional

This flag is duplicated by the DBF under the


UNBUILD section
XLS Export inhibit flag.

{Y, N}

If set, the field is considered optional and will not N


be created upon database export. Otherwise it is
mandatory and it will be created.
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 will
be exported, ignoring the export inhibit flag
setting.
This flag is duplicated by the XLS under the
UNBUILD section
ITEMTYPE

364

9AKK101130D1382

Table 136. Builder DBXRF - Database Field Assignment Definition.


Column
type

Format
Opt/Mnd
Character
Mandatory

Description
Item type to which field assignment is applied.
Item type is an string value according to the
parameter file SYSPRM.

Range
Default
<string>
None

A list of legal item types is shown in the Appendix


A.

name

Character
Optional

At least one of these types must be specified for


each DB_XREF definition.
ALIAS
Name of an aliases field. Defines an alternative <string>
name for the column of the DBF or XLS file
None
Up to 8 alias name can be assigned for a
DB_XREF.

name

Character

Alias name are limited, by DBF, to 10 characters


UNBUILD
The name of the field
<string>

type

Mandatory
Character

Output field type.

None
{C, N}

Mandatory

Allowed output field types are:

None

C - Character.
N - Numeric.

length

Integer

dbf

Mandatory
Character

xls

Optional
Character
Optional

9AKK101130D1382

This selection only applies to export operations


specifying a new target database. If a reference
database is specified, its structure will be used.
Output field size.

<number>

0
Flag specifiing if the field will be exported to DBF {Y,N}
files (see above)
N
Flag specifiing if the field will be exported to XLS {Y,N}
files (see above)
N

365

The DB_XREF allows users to define a list of input database fields to be


used for direct or call-back assignment.
If direct assignment is selected, the system will get the value of the first field
in the list that is found in the input database.
If call-back assignment is selected, the system will get the value of all the
fields defined in the list (passing them to the call-back).
In both cases, the maximum number of fields that may be defined is 8.
A small set of call-backs is supplied to perform basic operations:
CbkAccInt.
Accepts only those records whose numeric integer fields specified by
arguments 1,3,5,7 are equal to values specified by arguments 2,4,6,8.
CbkAccReal.
Accepts only those records whose numeric real fields specified by
arguments 1,3,5,7 are equal to values specified by arguments 2,4,6,8.
CbkAccText.
Accepts only those records whose text fields specified by arguments 1,3,5,7
are equal to values specified by arguments 2,4,6,8.
CbkRejInt.
Accepts only those records whose numeric integer fields specified by
arguments 1,3,5,7 are not equal to values specified by arguments 2,4,6,8.
CbkRejReal.
Accepts only those records whose numeric real fields specified by
arguments 1,3,5,7 are not equal to values specified by arguments 2,4,6,8.

366

9AKK101130D1382

CbkRejText.
Accepts only those records whose text fields specified by arguments 1,3,5,7
are not equal to values specified by arguments 2,4,6,8.

Alarm Management Subsystem


Introduction
The main goal of alarm subsystem is to process up to three types of event
(information events, return-to-normal events and alarm events) and to notify
them to operators by a wide range of peripheral devices, such as LADs
(Latest Alarm Displays), printers, OJ (Operations Journal) and audible alarm
tones.
All these events may be queued by scan subsystem (in the simplest
scheme) as well as by calculation package, configuration subsystem or user
programs.
The following section shows how to configure color/blink override requested
by alarm subsystem to process these events. The configuration of alarm
groups can be found in the same chapter of Table 1.

Color/Blink Override
The color/blink override table configures the attributes for displaying analog
and digital tags.
PGP supports the colored display of tags. The operator can easily
understand the status of a displayed variable.
Tag values are displayed using different foreground and background colors
and blink, depending on the status of the tag and its priority. In addition, one
or two trailing characters may be appended to a value to qualify the status.
This prevents problems resulting from color-blindness, monochromatic
visual display units, hard-copy, etc.
The table allows the user to have flexibility in what combinations of blink
colors and appended characters are displayed, given various status
conditions.

9AKK101130D1382

367

The file BATTDECK.XML, located in the \Deck folder, defines the PGP
color/blink override table and the file BATT2DECK.XML, located in the
\Config\Deck folder, may define the application specific overrides.
Both files define the override table of the whole system. The format of the
two files is the same. The base PGP does not provide an empty
BATT2DECK file. It may be derived from BATTDECK when application
specific overrides must be added or changed.
The processor BATT performs the configuration of the override table. The
XML format, support the standard XML syntax, and is defined in the
following example:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<PRIORITIES action="xxx">
<PRIORITY number=xxx" type=xxx" >
<PROCESSING ds_alarm="xxx pr_alarm=xxx sv_alarm=xxx aud_alarm=xxx
bot_alarm=xxx ds_rtn=xxx pr_rtn=xxx sv_rtn=xxx ds_stchng=xxx pr_stchng=xxx
sv_stchng=xxx pr_opact=xxx sv_opact=xxx pr_info=xxx sv_info=xxx
rem_onack=xxx appl_ala=xxx info_onack=xxx exp_ala=xxx opc_ala=xxx
audidx=xxx />
<ITEM pos=xxx descr=xxx bit=xxx type=xxx color=xxx symbol=xxx invert=xxx/>
...
...
</PRIORITY>
...
...
</PRIORITIES>

Alarm Attribute definition parameters, defined as xxx in the previous XML


snapshot, are listed in the following table.

368

9AKK101130D1382

Table 137. Builder BATT Color/Blink Override Basic Definition.


Parameter
action

Format
Opt/Mnd
Character

Action code.

Range
Default
{init, add, replace}

Mandatory

Allowed action codes are:

None

Description

init- Initialize the color/blink definition file,


add - Add a color/blink definition,
replace - Replace a color/blink definition,

number

Integer

type

Mandatory
Character
Mandatory

copy_from_priority Integer
Optional

bit

Character
Mandatory

type

If a color/blink definition does not exist,


action code R means add.
PRIORITY
Priority number.
Item type for which the priority definition is
applied.
Allowed values are PV and Di.
Priority number to copy the definition from.

{1...16}
None
{PV,DI}
None
{1...16}

(this just to avoid to duplicate many


None
statements, which very likely are the same)
ITEM
Bit of interest in quality status word .
A status word defines the quality of digital
tags, two status words define the quality of
analog tags.

{0...31}
None

Character

See the Appendix for quality bit definitions.


Override type.

{BL, BC, FG}

Mandatory

Allowed override type are:

None

BL - Blink,
BC - Background color,
FC - Foreground color.

9AKK101130D1382

369

Table 137. Builder BATT Color/Blink Override Basic Definition.


Parameter
color

Format
Opt/Mnd
Characte
Mandatory

symbol

Character

Description
Color.
The names refers an entry in the
BattColors.ins file located in the \Config
folder.
See the Appendix for the default allowed
colors and the syntax of the BattColors file.
The color scheme can be modified
changing the BattColors file.
Quality symbol.

Range
Default
<string>
None

<string>

The symbol is appended to tag values to


represent tag quality. (up to 4 characters
are allowed)
Invert code.

None

Optional

I - Invert tag status before testing for


override.
Description. (up to 28 characters are
allowed for describit this quality)

ds_alarm

Character

PROCESSING
Display alarm.

{Y, N}

pr_alarm

Optional
Character

Print alarm.

N
{Y, N}

sv_alarm

Optional
Character

Archive alarm.

N
{Y, N}

aud_alarm

Optional
Character

Audible on alarm.

N
{Y, N}

bot_alarm

Optional
Character

Alarm at bottom of screen window.

N
{Y, N}

ds_rtn

Optional
Character

Display return to normal.

N
{Y, N}

Optional

invert

Character
Optional

descr

Character

Optional

370

{Y, N}

<string>
None

9AKK101130D1382

Table 137. Builder BATT Color/Blink Override Basic Definition.

pr_rtn

Format
Opt/Mnd
Character

Print return to normal.

{Y, N}

sv_rtn

Optional
Character

Archive return to normal.

N
{Y, N}

ds_stchng

1
Character

Display event.

N
{Y, N}

pr_stchng

Optional
Character

Print event.

N
{Y, N}

sv_stchng

Optional
Character

Archive event.

N
{Y, N}

pr_opact

Optional
Character

Print operator action.

N
{Y, N}

sv_opact

Optional
Character

Archive operator action.

N
{Y, N}

pr_info

Optional
Character

Print info messages.

N
{Y, N}

sv_info

Optional
Character

Archive info messages.

N
{Y, N}

rem_onack

Optional
Character

Remove alarm on acknowledge.

N
{Y, N}

info_onack

Optional
Character

Log on acknowledge.

N
{Y, N}

app_ala

Optional
Character

Application specific action.

N
{Y, N}

exp_ala

Optional
Character

Export to external DBMS.

N
{Y, N}

opc_ala

Optional
Character

Export to OPC Server.

N
{Y, N}

audidx

Optional
Integer

Audible Alarm index

N
{0,16}

Parameter

Optional

9AKK101130D1382

Range
Default

Description

371

Message Subsystem
Alarm message
PGP allows user configuring of a great number of different formats to display
and print an event according to alarm category definition.
The file BALMDECK.XML, located in the \Deck folder, defines the PGP
alarm messages and the file BALM2DECK.XML, located in the \Config\Deck
folder, may define the application specific messages.
Both files define the alarm messages of the whole system. The format of the
two files is the same.
The base PGP does not provide an empty BALM2DECK file. It may be
derived from BALMDECK when application specific alarm messages must
be added.
The processor BALM performs the configuration of alarm messages. The
XML format, support the standard XMl syntax, and is defined in the following
example:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<ALARM_MESSAGES action="xxx">
<MESSAGE code=xxx" value=xxx" >
<PARAMETERS p1=xxx l1=xxx ....p30=xxx l30=xxx />
<PROCESSING ds_alarm="xxx pr_alarm=xxx sv_alarm=xxx aud_alarm=xxx
bot_alarm=xxx ds_rtn=xxx pr_rtn=xxx sv_rtn=xxx ds_stchng=xxx pr_stchng=xxx
sv_stchng=xxx pr_opact=xxx sv_opact=xxx pr_info=xxx sv_info=xxx
rem_onack=xxx appl_ala=xxx info_onack=xxx exp_ala=xxx opc_ala=xxx
audidx=xxx prtidx=xxx opstation=xxx priority=xxx group=xxx translate=xxx
opc=xxx/>
</MESSAGE>
...
...
</ALARM_MESSAGES>

372

9AKK101130D1382

Alarm Attribute definition parameters, defined as xxx in the previous XML


snapshot, are listed in the following table
Table 138. Builder BALM - Alarm Message Definition.
Parameter
action

Format
Opt/Mnd
Character

Action code.

Range
Default
{init,add,replace}

Mandatory

Allowed action codes are:

None

Description

Init - Initialize alarm messages definition file,


Add - Add an alarm message,
code

Char or Int
Mandatory

value

Character
Mandatory

PARAMETERS
p1
Character

l1

Replace- Replace an alarm message,


Alarm message code/number.
The field specifies the alarm message being
defined.

Optional

Integer

Up to 30 paramaters can be specified for an


alarm message
Length (in characters) of the first parameters.

PROCESSING
ds_alarm
Character
Optional

9AKK101130D1382

{1...999}

The alarm message number is an integer


[mxamsg]
value and 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 <string>
message. The definition correspond to a
None
standared C Language format, where the
parameters are replaced by the parameters
defined below.
Symbolic definition of the type of the first
parameter. Refer to table 3-15 for the list.

Optional

<string> or

<string>
None

Integer

Refer to table 3-15 for the legth of default


parameters

Display alarm.

{Y, N}
N

373

Table 138. Builder BALM - Alarm Message Definition.

pr_alarm

Format
Opt/Mnd
Character

Print alarm.

{Y, N}

sv_alarm

Optional
Character

Archive alarm.

N
{Y, N}

aud_alarm

Optional
Character

Audible on alarm.

N
{Y, N}

bot_alarm

Optional
Character

Alarm at bottom of screen window.

N
{Y, N}

ds_rtn

Optional
Character

Display return to normal.

N
{Y, N}

pr_rtn

Optional
Character

Print return to normal.

N
{Y, N}

sv_rtn

Optional
Character

Archive return to normal.

N
{Y, N}

ds_stchng

1
Character

Display event.

N
{Y, N}

pr_stchng

Optional
Character

Print event.

N
{Y, N}

sv_stchng

Optional
Character

Archive event.

N
{Y, N}

pr_opact

Optional
Character

Print operator action.

N
{Y, N}

sv_opact

Optional
Character

Archive operator action.

N
{Y, N}

pr_info

Optional
Character

Print info messages.

N
{Y, N}

sv_info

Optional
Character

Archive info messages.

N
{Y, N}

Remove alarm on acknowledge.

N
{Y, N}

Parameter

Optional
rem_onack Character
Optional

374

Range
Default

Description

9AKK101130D1382

Table 138. Builder BALM - Alarm Message Definition.


Format
Opt/Mnd
info_onack Character
Parameter

Range
Default

Description
Log on acknowledge.

{Y, N}

app_ala

Optional
Character

Application specific action.

N
{Y, N}

exp_ala

Optional
Character

Export to external DBMS.

N
{Y, N}

opc_ala

Optional
Character

Export to OPC Server.

N
{Y, N}

audidx

Optional
Integer

Audible Alarm index

N
{0,16}

opstation

Optional
Integer

Operator station.

0
{0...32}

Optional
priority

Integer
Optional

group

Integer
Optional

translate

Character
Optional

prtiidx

Integer
Optional

The field specifies the operator station where


to output the message.
Alarm priority.

[nmcrts]

The field specifies the alarm priority assigned


to the message.
Alarm group.

{0...8}

{0...SLADNM}

The field specifies the alarm group assigned to 0


the message.
Translation flag.
{Y, N}
If set, the message is submitted to translation
at generation time. Otherwise, translation
takes place at run time.
Alarm printer Index.

Number
0

The message text may contain symbols and ASCII text in a specific order.
These symbols represent variable text to be formatted at run time. The data
for these fields is supplied from the alarm queue header or the alarm queue
data buffer or the item description record when the message is requested for
displaying.

9AKK101130D1382

375

In the text, a dynamic is represented by symbol %. The symbol is replaced


by the data defined in the corresponding dynamic Table 139 lists possible
symbols.
Table 139. Message Subsystem - Dynamic Text Definition Symbols.
Symbol
%s

Field Type
String

Description
The field will be filled by a sequence of characters.

Error messages
This section describes the configuration of the message texts that are
presented to the PGP user.
Error messages are generated by validation processes and presented within
appropriate windows.
Messages and helps are provided with the basic system. Texts may be
customized and/or translated into national languages, before running the
appropriate builder processors.
The file BEMFDECK.XML, located in the \Deck folder, defines the PGP error
messages.
The file BEMF2DECK.XML, located in the \Config\Deck folder, may define
the application specific messages.
Both files define the error messages of the whole system. The format of the
two files is the same.
The base PGP does not provide an empty BEMF2DECK file. It may be
derived from BEMFDECK when application specific error messages must be
added.
The processor BEMF performs the configuration of error messages. The
XML format, support the standard XMl syntax, and is defined in the following
example:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<ERR_MESSAGES action="xxx">
<MESSAGE code=xxx" value=xxx" />

376

9AKK101130D1382

...
...
</ERR_MESSAGES>

Alarm Attribute definition parameters, defined as xxx in the previous XML


snapshot, are listed in the following table.
Table 140. Builder BEMF - Error Message Definition
Column
action

Format
Opt/Mnd
Character

Action code.

Range
Default
{init,add,replace}

Mandatory

Allowed action codes are:

None

Description

Init - Initialize error message definition file,


Aadd - Add error message definition,
Replace - Replace error message definition,

code

Character
or integer
Mandatory

value

Character
Mandatory

If a message does not exist, action code R means


add.
{1...999}
Error message identifier.
The identifier is an integer value and may 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 is
according to the standard C language formatting;
the meaning of the parameters is defined below.

None

<string>
None

The syntax of error messages is not quite the same as the syntax used for
alarm messages. A dynamic is represented by the symbol %. The following
table lists possible symbols used in text definitions.
Table 141. Message Subsystem - Text Definition Symbols.
Symbol
%s
%d

Field Type
String
Digit

9AKK101130D1382

Description
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 number.

377

The format of the dynamic is specified as part of the text. It is located at the
end of the message and is preceded by a comma.
Below, an example of an error message with a dynamic is given.
Name %s already defined for another item, a20

The message text includes the dynamic %s. That is, a string will be
embedded within the text and its length is 20 characters as defined by a20
at the end of the message.
Each message text is closed by a double quote.

378

9AKK101130D1382

Section 4 Off-line Utilities


Introduction
PGP off-line utilities can be classified in three main categories: start-up,
configuration and maintenance utilities.
PGP start-up, PGP Explorer start-up, People Finder start-up belong to the
first category.
System setup, database builder, display builder, display translator, display
compiler and data export manager belong to the second category.
Historian backup, Long Term Archiving, One Shot Backup and SaveRestore Configuration belong to the third category.
Off-line utilities can be called from the Start menu. Shortcuts may be created
to call utilities from desktop. In the following description, the standard
activations from menu are explained.

Start PGP
Overview
PGP can be activated on demand or automatically. The Start PGP function
allows for on-demand activation.

Activating PGP
Select following menu:
> Start (on the desktop)
> Programs
> ABB Industrial IT
> Power Generation Portal

9AKK101130D1382

379

> Start Power Generation Portal


The PGP application will start-up in a few moments.

PGP Description
Refer to the InformIT Power Generation Portal User Manual.

PGP Explorer
Overview
PGP Explorer is the main interface window to the operator, it can be opened
on demand. The PGP Explorer function allows on demand activation.
When PGP starts up, PGP Explorer automatically opens the interface
window. If the interface window closes or is closed for any reason PGP
Explorer function re-opens it without to completely shutdown and restart
PGP.

Calling PGP Explorer


Select following menu:
> Start (on the desktop)
> Programs
> ABB Industrial IT
> Power Generation Portal
> Power Generation Portal Explorer.

SODG Display Translator


Overview
Application displays can be realized using the Screen Oriented Display
Graphic (SODG) utility tool which is part of the Composer WinTool
package.

380

9AKK101130D1382

This package allows the complete configuration (including database, trends,


displays) of other standard consoles such as the MCS and OIS families.
Refer to the appropriate manuals for details on the use of these products.
The SODG utility, after the user has configured a display, can generate a file
(in an ASCII format) with an extension that is usually DT. This file can be
imported into the PGP environment and used to create displays for the
presentation in the PGP windows.
Usually displays refer to static and dynamic symbols. They are graphic
representations of devices and apparatuses (e.g. valves, motors, etc.) used
several times.
A set of standard symbols is predefined in the SODG utility; they may be
referenced in the displays. The SODG utility allows configuring application
symbols also.
Both standard and application symbols must be imported together displays
to completely perform display importing in the PGP environment.
The following the procedure to import and process for use the displays is
explained.

Importing the displays


PGP hosts files related to presentations on screen into three folders. These
folders are located in the <INSTALLDIR>\Config\Sodg folder. The three
folders are
DISPLAYS

This is the folder available to host the application displays, i.e. the graphic
pages to be presented on the screen.
STD_SYM

This is the folder available to host the SODG standard symbols.

9AKK101130D1382

381

SYM

This is the folder available to host the application symbols.


On a virgin PGP, the three folders are empty. Import all DT files via network
or using a removable device. Be careful to properly locate files in the three
folders to prevent reference mismatching.
Displays cannot be immediately displayed on screen after importing. They
need a translation and a compilation.
This processing produces an output view and displays can be presented on
the screen of PGP.

Calling Display Translator


Select following menu:
> Start (on the desktop)
> Programs
> ABB Industrial IT
> Power Generation Portal
> System Setup
In this way, the interface window of the System setup management is
opened. Open on the left the tree of the item Utility to show the list of
configured utilities: click on
SODG to PGP Display Translator.
double clicking SODG in the right view, the interface window of the
translator will be opened.

Translating Displays and Symbols


The first step preparing displays for PGP environment is the translation of
symbols and displays imported from the SODG utility.
Symbols (either standard or application) referenced in the displays and
displays themselves need to be translated in a format the PGP display
compiler can process.

382

9AKK101130D1382

Begin translating symbols: standard symbols before and then application


symbols. Complete the operation translating displays.
Defining in the PGP data base at index 1 the tagname %TAG%,
automatically the transaltor will solve the tag index 1 with this tagname.
%TAG% is the sintax used by PGP to load the page sending it the
tagname to use.
In the following description a complete translation is explained (i.e. the
translation of all elements). In any case the same procedure may be applied
to translate a single element (symbol or display).
The operations to be carried out are similar for symbols and displays: just
the folder selection differs.
Once display translator has been activated the translator window will be
opened as shown in the figure below.

9AKK101130D1382

383

Figure 14. Display Translator - Translation Window


A data entry field allows definition of path to file(s) and file name(s) to
process. An echo area shows messages related to the translation. Three
selection areas allow selecting the translation options.
The path to file(s) and file name(s) to process can be specified typing a full
path in the data entry field or selecting the full path through the Open
function in the File menu or the Open folder icon.
Examples of full path specification are the following. Note that the default
installation directory is referred as <INSTALLDIR>
<INSTALLDIR>\Config\Sodg\Std_sym\*.dt
<INSTALLDIR>\Config\Sodg\Std_sym\<std_symbol_name>.dt
<INSTALLDIR>\Config\Sodg\Sym\*.dt

384

9AKK101130D1382

<INSTALLDIR>\Config\Sodg\Sym\<appl_symbol_name>.dt
<INSTALLDIR>\Config\Sodg\Display\*.dt
<INSTALLDIR>\Config\Sodg\Display\<display_name>.dt

The wild-card allows specifying all elements in the path. The file
specifications <std_symbol_name>, <appl_symbol_name> and
<display_name> identify a generic name.
This is the syntax to be used to process a single element.
The figure below shows the path identification and selection window.

Figure 15. Display Translator Selection Window

Through this window it is possible, by the usual operational modes, to


identify the path and the file. When all files must be translated, select one of
them and then, in the translation window, change the file name with the wildcard (the asterisk).
Translator outputs the result to following folders:
<INSTALLDIR>\Display\UDR (symbols in graphic format - *.G).
<INSTALLDIR>\Display\UPG (displays in Text Format - *.G, *.DIAG_A,
*.PGVAR_A)

9AKK101130D1382

385

<INSTALLDIR>\Display\Work (displays in Editable Format - *.UCBG,


*.UCBP, *.UCBD, *.UCBV)
<INSTALLDIR>\Display\Bin (displays in Executable Format - *.G,
*.PAGE, *.DIAG, *.VAR)
The folder <INSTALLDIR>\Display\UPG will be the input folders during the
display compilation.
Three options may be selected before to run translation:
Output Type: Normal/View

The View option allows you to process a symbol as a display, so the


symbol is translated and then compiled.
Normal is the default setting.
Dynamic Style: PGP/OIS

The selection of OIS dynamic style requires translator to handle


dynamics in the same way as Bailey OIS families do. The PGP option
requires translator to apply the standard handling to dynamics
(background and foreground on values and colors managed using PGP
configuration).
Refresh Time: 1/5 SEC

Allows you to choose the refresh time of dynamics.


The default setting is 5 seconds.
Form: KeepRatio/Stretch

Displays can be stretched to fully fit the display area or can be forced to
keep the horizontal/vertical aspect ratio. This option allows selecting
one of the two display formats. The keep ratio option is the default
setting.

386

9AKK101130D1382

The Process button starts the translation of selected elements (symbols or


displays).
The output (echo and errors) will be displayed in the echo area.
The output can include also informations about problems on used tags. The
detailed list of the undefined tag is not displayed: is displayed only a warning
message and you can see the detailed list in the .LOG file; this solution
reduces the times of translation when the tag Data Base in not complete.
The first time symbols and displays are imported in a PGP a complete
translation of all elements will be performed. In sequence: all standard
SODG symbols, all application symbols and all displays will be translated.
Then, single items or groups of items (symbols and/or displays) will be
translated in case of changes.
The translator provides display compilation also. However, the compilation
is explained in the following section. It may be invoked in case of changes to
the tag database, displays refers tags by index and must be compiled. A
complete translation is not required.

Extracted processed symbols


During the translation will be created automatically symbols starting from
"dynamic" commands included in the .DT file(s).
This function creates automatically (in the subfolder SODGLIBSYM,
automatically created if not found, of the directory defined by the registry
Sodg_sym) new files .DT; each file defines an "extracted" dynamic symbol.
To the extracted symbol file is assigned a name formatted as
SuffEscapePicture_XX.DT where:
Suff = String extracted from the registry
APPS\SODG\ExportedSymbolsSuffix (string type - max 10 characters). This
registry could be undefined, but is better to use it to identify "easily" the new
global symbols that will be created.
Escape - is the "SODG command" from which derives the symbol.

9AKK101130D1382

387

Picture - This field is inserted in the symbol name only for the "graphic"
symbols (Advanced dynamic analog/digital) and is the name of the first
graphic object included to define the dynamic.
_XX - This field is automatically included when the symbol name file is
already existing but defines a different dynamic (could change a color, a
name of one graphic symbol, etc.); in this case is necessary to assign
another name to the new symbol in order to distinguish symbols similar but
not equal. You can verify the differences opening with a text editor the .DT
files.
At the end of the processing of the custom SODG .DT files (first standard
symbols, then symbols and then displays) in the SODGLIBSYM you can
found the new .DT files; processing these files, will be created global
dynamic symbols (in the eix_work folder the editable files, in the eix_bin
folder the executable files).
These global symbols will be displayed by the DisplayBuilder in the list of the
global symbols and could be selected to insert them in the displays.
These global symbols are "simple" because they include only a single
dynamic object without actions: therefore details (like parts of valves to
define the type), sensible areas, etc. are missing.
These global symbols can be customized with more details using the
DisplayBuilder.
In these global symbols the tags are defined normally as %TAG%, but,
where is required a specific tag type, you can found also %TAG_DIGITAL%,
%TAG_ANALOG%, %TAG_MSDD%, etc.
NOTES: in the displays generated with the SODG translator there aren't link
with these global symbols: the graphic pages are created like old releases.

DT Symbols Files
The SODG.EXE program manages the symbols pages (in the previous
release was skipped) to generate from them the PGP global symbols; these
symbols could be many complexes according to the commands included in
the .DT file.

388

9AKK101130D1382

Display Compiler (EIXCMP)


Overview
The second step preparing displays for PGP environment is the compilation
of displays imported from the SODG utility or implemented using the onboard display builder. The translator automatically calls the compiler: the
activation of the compiler alone is explained to give the customer the
capability to compile all displays after changes to the tag database looking
for possible tag mismatch or to import from other plant the displays using the
Text Format.
Actually, display compilation is not required after changes to the tag
database since references to tags by index are resolved at run time.
Symbols (either standard or application) do not need a compilation, they are
referenced within the displays and the display compilation solves
references.
In the following description a complete compilation is explained. In any case
the same procedure may be applied to compile a single element (display).

Calling Display Compiler


Select following menu:
> Start (on the desktop)
> Programs
> ABB Industrial IT
> Power Generation Portal
> System Setup
In this way, the interface window of the System setup management is
opened. Open on the left the tree of the item Utility to show the list of
configured utilities: click on
Text Format Display Compiler.

9AKK101130D1382

389

Double clicking EIXCMP in the right view, the interface window of the
display compiler will be opened.

Compiling Displays
The figure below shows the schematic of the compiler window.

Figure 16. Display Compiler - Compilation Window


A data entry field allows definition of path to file(s) and file name(s) to
process. An echo area lists messages related to the compilation.
The path to file(s) and file name(s) to process can be specified typing a full
path in the data entry field or selecting the full path through the Open
function in the File menu or the Open folder icon.
Examples of full path specification are the following:

390

9AKK101130D1382

<INSTALLDIR>\Display\Upg\*.g
<INSTALLDIR>\Display\Upg\<display_name>.g
The wild-card allows specifying all elements in the path. The file
specification <display_name> identifies a generic name. This is the syntax
to be used to process a single element.
The figure below shows the Path identification and selection window.

Figure 17. Display Compiler Selection Window


Through this window it is possible, by the usual operational modes, to
identify the path and the file. When all files must be compiled, select one of
them and then, in the translation window, change the file name with the wildcard (the asterisk).
Compiler outputs the result to the following folders:
<INSTALLDIR>Display\Work - displays in the editable format (UCBG,
UCBP, UCBD, UCBV).
<INSTALLDIR>Display\Bin - displays in the executable format (G, PAGE,
DIAG, VAR).
The Process button starts the compilation of selected elements (displays).
The output (echo and errors) will be displayed in the echo area.

9AKK101130D1382

391

Display Builder
Overview
A built-in display builder allows you to edit application displays on board the
PGP. Translated displays or new displays can be edited. Edit of drawing is
based on an on-board editor.
Refer to the InformIT Power Generation Portal Display Builder Manual for
more information.

Calling Display Builder


Select following menu:
> Start (on the desktop)
> Programs
> ABB Industrial IT
> Power Generation Portal
> Display Builder
The interface window of the display builder will be opened.

Display Builder Description


Refer to the InformIT Power Generation Portal Display Builder Manual for
more information.

Data Export Manager


Overview
PGP supports interaction with a wide range of commercial database
managers, by exporting its internal data structures via ODBC standard. In
this environment, PGP acts as a data provider for the foreign database
(target database).

392

9AKK101130D1382

Once the target database has been created and initialized, PGP 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.

Calling Data Export Manager


Select following menu:
> Start (on the desktop)
> Programs
> ABB Industrial IT
> Power Generation Portal
> System Setup
In this way, the interface window of the System setup management is
opened. Open on the left the tree of the item Utility to show the list of
configured utilities: click on
ODBC DB Export Manager.
Double clicking DBXMGR the interface window of the data export manager
will be opened.

Data Export Manager Description


Refer to the InformIT Power Generation Portal User Manual for more
information.

Historical Backup
Overview
PGP gives the capability of historical backup archiving for most important
medium term archives.

9AKK101130D1382

393

The words historical backup classes a set of archives kept for a non predefined amount of time. All medium term archives last a fixed time interval or
keep a fixed number of items thus limiting de-facto the time interval or keep
a fixed number of files. Historical backup archiving allows keeping
snapshots of medium term archives for a long period of time without any
time or counter expires.
That does not mean historical backup archiving enlarges medium term
archiving time capabilities. Medium term archiving keeps its time limits as
configured. Historical backup archiving saves images of medium term
archives.
Historical backup archiving media may be the same hard disk hosting PGP
or may be an external device as a tape or a CD device. Historical backup
data files are created on the hard disk, then they can be possibly copied to
the external device.
The backup files produced by the Historical backup will not saved to
the Long Term Archive, also if it is configured.
The hard disk area will be called intermediate storage in the following
description.
This section describes the procedures to activate the utility. Moreover, it
describes the steps to save archives, to retrieve saved archives.

Archives
Some of the medium term archives are eligible for historical backup
archiving. They can be saved and, in a later time, retrieved for analysis.
The archives listed below are eligible for historical backup archiving:
> Alarm Archive
> Trend Group Archive
> Playback Archive
> Post Trip Archive
> Totalization Archive

394

9AKK101130D1382

Once retrieved, an archive may be analyzed using the same functions


provided for the medium term archive. Refer to the user manual for a
description of analysis of data of historical backup archives. Archived data
cannot be directly analyzed, retrieval is always required.

Alarm Archive
The alarm archive, called Operator Journal or OJ also, stores the most
recent alarm messages, information messages, diagnostic messages, etc.
generated as result of the alarm processing.
Historical backup archiving copies the current contents of the archive to the
intermediate storage area.
Retrieving dumps data from the intermediate storage to the PGP internal
area. That area is parallel to the current alarm archive area. Retrieved
historical alarm archive does not overwrite current alarm archive.
The viewer of historical alarm archive allows switching between current and
retrieved archive.

Trend Group Archive


Historic trend groups are collections of tags. They periodically process
playback data and store the result of processing. Archiving period and kind
of processing are parameters defined at trend group configuration time.
Examples of historic trend groups are: instantaneous value, average value,
maximum value, minimum value, totalization, monitoring.
Historic trend groups only can be saved; real-time trend group cannot be
saved.
Archiving saves data of a single group.
Retrieving restores data from a previously saved historic trend group.

Playback Archive
Playback archive keeps the history on the medium term for all tags
configured in the PGP database. Only tags whose playback flag is set within
the PGP database are kept on playback.

9AKK101130D1382

395

On playback tag data are stored in form of exception reports. A playback


archive has a size defined at configuration time. Basically, two size
parameters define playback: the maximum number of hours and the
maximum number of days.
The maximum number of hours (default 24 hours) defines the size of the
current playback. The maximum number of days defines the time interval
playback data are kept on the hard disk.

Archiving saves data of the current playback.

Retrieving restores data from a previously saved playback.

Post Trip Archive


Post trip archive is a special kind of historic trend group. It is activated on
event (trip) and stores all exception reports found within playback since a
begin time to an end time. Begin and end time are defined in term of time
before trip and time post trip.

Archiving saves data of a single post trip archive.

Retrieving restores data from a previously saved post trip archive.

Totalization Archive
The value of a tag can be involved in a totalization archive at configuration
time. Totalizers periodically process playback data of tags involved and
store the result of processing.
Both analog and digital tags can be configured for totalization. Refer to the
tag database configuration for details.
Archiving saves both analog and digital totalizations.
Retrieving restores data from a previously saved totalization archive and
overwrites the current one.

Calling Historical Backup Archiving


Select following menu:
> Start (on the desktop)

396

9AKK101130D1382

> Programs
> ABB Industrial IT
> Power Generation Portal
> System Setup
In this way, the interface window of the System setup management is
opened. Open on the left the tree of the item Utility to show the list of
configured utilities: click on
Historian Backup Manager
Double clicking HISBACKUP in the right view, the interface window of the
historian backup manager will be opened.

Archiving Interface
After the historical backup archiving has been activated the main interface
window opens. The figure below shows the main interface window of the
historian backup manager. The archive save-set list is empty: any archive
has been saved before for historical backup keeping.

9AKK101130D1382

397

Figure 18. Historian Backup Manager


Five icons call the save functions (one for each kind of archive). Five icons
call the restore functions. Five icons call the delete functions. Three menus
also allow calling the functions above mentioned.
The save functions begin a dialog with the user in order to perform storaging
on the intermediate storage area. The restore functions begin a dialog with
the user to perform restoring archived data from the intermediate storage
area.
The delete functions allow deleting restored archives. After deletion restored
archives will be no longer available to the PGP for on-line viewing. Backup
files in the intermediate storage area are not involved in the delete
operation. Unless they are intentionally deleted, a restore operation may be
done again.

398

9AKK101130D1382

In the following description the generic save, restore and delete procedures
are outlined. Specific save procedures may differ a little depending on the
kind of archive involved. The examples refer to trend groups.

Saving Procedure
Click the save icon or the save item of the Save menu to initiate a save
procedure.

Figure 19. Trend Group Archive - Group Selection Window


Since multiple archives may exist in a PGP application and may be involved
in a save operation, a dialog window opens to allow selection. Figure 20
shows such a window for trend groups. The selection dialog window does
not exist for alarm and totalization archives.
Select the archive to be saved and press the Next button.
The label and description identify the save-set where data will be saved.
The figure below shows the dialog window to enter name and description of
save-set.

9AKK101130D1382

399

Figure 20. Trend Group Archive - Save-set Dialog Window


Press Finish button to proceed. The dialog window to select the destination
of saved data is displayed. It displays the default destination folder
(hisbackup of PGP folder).
The file name is defaulted to the save-set label as shown below.

400

9AKK101130D1382

Figure 21. Trend Group Archive - Destination Dialog Window


Defaults may be changed according to specific backup criteria or rules.
Navigate through folders to locate the destination folder if it differs from the
default folder.
Press Save button to start saving. When the saving procedure completes
the message is shown.
Press the OK button. The completion window closes and the archive saveset list updates. The new save-set will be enclosed in the list.

Restoring Procedure
Click the Restore icon or select the Restore item of the Restore menu to
initiate a restore procedure.
The Restore dialog window opens. It lists all historical backup files located in
the default intermediate backup (hisbackup) folder. Navigate through folders
to locate the location folder if it differs from the default folder.
Select the archive to be restored. The figure below shows a dialog window
where a file has been selected for restoring.

9AKK101130D1382

401

Figure 22. Trend Group Archive - Restore Dialog Window


Press Open button to start restoring. When restoring procedure completes
the message shown below is displayed.

Figure 23. Trend Group Archive - Completion Window

Deleting Procedure
Click the delete icon or select the delete item of the Delete menu to initiate a
delete operation.

402

9AKK101130D1382

Figure 24. Delete Dialog Window.


Select the archive to be deleted. Figure 24 shows the dialog window where
a file has been selected for deletion.
Press OK button to delete. Press YES button to confirm the operation.
The delete function deletes a retrieved archive only. It does not delete
backup files.

One Shot Backup


Overview
PGP gives the capability of historical backup archiving for most important
medium term archives as already written talking about historian backup
utility. Historian backup is a user driven utility.
PGP supplies an automatic utility, named OneShotBckp, which allows
automatic backup of the items handled by historian backup: historical alarm
archive, trend group archive, playback archive and post trip archive.

9AKK101130D1382

403

The one shot backup utility can be configured to run periodically (each
individual day can be flagged for activation) and the running time (hh:mm)
can be defined. Archives involved in backup can be flagged also. By default
all archives are involved.
A set of registries, defined under the OneShotBckp sub-root of the PGP
registries, allows defining all environment parameters. Refer to Section 1 of
the Configuration Manual (Chapter on System Configuration) for details on
OneShotBckp registry set. The utility itself can set default registry values.
All files produced with one shot backup will be sent to the Long Term
Archive, if it is configured.
This section describes the procedures to activate the utility.

Calling One Shot Backup


Select following menu:
> Start (on the desktop)
> Programs
> ABB Industrial IT
> Power Generation Portal
> System Setup
In this way, the interface window of the System setup management is
opened. Open on the left the tree of the item Utility to show the list of
configured utilities: click on
Automatic Historical Backup - Option.
Double clicking ONESHOTBCKP in the right view, the requested option will
be executed.
The utility activates and does not open any interface window since it is an
auto-scheduled application.
The generic activation parameter Option depends on the kind of action to be
executed. See the description for details.

404

9AKK101130D1382

One Shot Backup Description


Once the one shot backup has been activated, it schedules itself for
execution and runs based on registry definition. The user may interface the
utility, changing the registry setting.
The one shot backup can be activated providing one of three qualifying
options.
Registry configuration (-regconf)
The option creates the registry set and assigns them default values or
assigns default values to the existing registry set.
This option does not schedule the utility for execution. Later, OneShotBckp
must be scheduled.
Scheduling configuration (-schedconf)
The option schedules the utility after a registry assignment (-regconf option)
or reschedules the utility after scheduling registries (activation day flag or
running time) have been changed.
Full configuration (-fullconf)
The option merges the two previous options.
A default registry set is created or initialized and the utility is scheduled for
execution.
The OneShotBckp utility requires the Windows service Schedule (or Task
Schedule) is started in order to operate. Be sure the service is set for an
automatic startup. Services may be accessed through Settings and
Control Panel.

9AKK101130D1382

405

Save/Restore Configuration
Overview
A specific application PGP configuration is generically based on registry
values, configuration and displays files.
Registry values are located under the PGP folder of registry keys.
Configuration files are located under the <INSTALLDIR>\Config folder.
Displays files are located under the <INSTALLDIR>\display folder.
The Save/Restore Configuration utility allows you to save and to restore
registry and files of configuration and displays.

Calling Save Settings


Select following menu:
> Start (on the desktop)
> Programs
> ABB Industrial IT
> Power Generation Portal
> System Setup
In this way, the interface window of the System setup management is
opened. Open on the left the tree of the item Save Configuration to show the
two subItem: Save and Restore.

Save Config/Display/Data
When the Save item is selected, the right side of the dialog window
changes.
Check boxes, which select the elements of the configuration in order to save
them, are shown on the right side. Registry values are always saved as a
whole. The file configuration or displays can be either fully or partially saved.

406

9AKK101130D1382

The interface window of the utility is shown in below: the procedure shows
the interface to save the configuration files; the same procedure can be
followed to save the displays files.

Figure 25. Save Config Window


All folders within the Config (or Display or, enabled only if the system is not
active, Data) directory are eligible for saving and are listed in the dialog
window.
The figure below shows a partial save selection.

9AKK101130D1382

407

Figure 26. Save Config Selection Window


Partial save selection can be used when some folders are left empty in the
specific application. In any case the full save selection (all boxes checked)
can be performed for all applications.
All sub-folders of the Config folder are listed in the selection area. Deck files
and License files under the Config folder also can be selected for backup.

408

9AKK101130D1382

At the bottom of the interface window a data entry field allows you to type
the destination folder. The path and file name can be typed within or a
browser can be opened clicking on the square button on the right side.
Since the save settings utility uses a DOS program, the file names must be
limited to 8 characters.
The figure below shows the browser window.

Figure 27. Save Config Browser Window


In the example the Temp folder of the installation disk has been selected.
The destination can also be the floppy disk driver. It is strongly discouraged
to save configuration under the PGP folder: if PGP is de-installed for any
reason, the configuration backup is lost.
The extension in the file name field is not required. It will be set to SVS.
Press the Save button to set path and file name in the destination field.
After all selections have been made press the Backup button to start saving.
The operation takes a while to complete. A small console window opens at
the top left of the window. Wait for the completion: the console window
closes.
The backup function creates a SVS file tracing the saved configuration, a
TXT file containing a list of all saved files, a set of nnn files (001, 002, ...)

9AKK101130D1382

409

containing the saved configuration. All files are named as defined in the file
name field.
Is possible also to send the backup files to the Long Term Archive function;
a specific question will be showed at the end of the save function: choosing
YES, the backup files will be saved in a compressed file (using the
command defined in the registry APPS\OneShotBckp\ZipCmdLine) that will
be archived in the Long Term Archive as Miscellaneous file.

Restore
A saved configuration can be restored in the same application or on another
application (another machine).
When the Restore icon is selected the right side of the dialog window
changes again. The figure below shows the selection to restore the
previously saved configuration.

410

9AKK101130D1382

Figure 28. Restore Window


The source path may only be selected by calling the browser (press the
square button on the right side of the path field.
Upon selection the backup information area is filled in. The figure below
shows the source browser.

9AKK101130D1382

411

Figure 29. Restore Config Browser Window


Press the Open button to return back to the restore window. The full path
browsed is copied to the path field.
Press the Restore button to start the operation.

Long Term Archive (LTA)


Overview
PGP gives the capability of long term archiving for most important medium
term archives.
Each PGP server can be configured to send medium term files to the LTA
manager to be saved to the Long Term Archive (that will be indicated in the
following description with LTA).
The name of the servers configured to send files to the LTA function
cannot include following sequence of characters: - .
For example server name SRV - 01 will create problems.
The LTA manager can run on one PGP server or on a dedicated server.

412

9AKK101130D1382

The LTA saves on a specific drive these files; the drive may be the same
hard disk hosting PGP or may be an external device.

Long Term Archive Explorer Activation


The LTAExplorer program can be activated also without activate PGP. If you
want to use as LTA server a PGP server, you have to add a new key named
LTAExplorer in the PGP registry Startup; if you want to activate only the
LTAExplorer you can manage the program activation using the system
tools.

Archives
The archives listed below are eligible for LTA: they can be saved and, in a
later time, retrieved for analysis; the boldface text describes the suffix to
identify the file type:
> ALM - Alarm Archive (One Shot Backup)
> GRP - Trend Group Archive (One Shot Backup)
> PLB - Playback Archive (One Shot Backup)
> PTL - Post Trip Archive (One Shot Backup)
> REP - Report Archive (RPTPRN)
> MSC - Total Counter Archive (TENESM)
> MSC - Maintenance Archive (HRTLSM)
> MSC - Sequence of Events Archive (ALACSOE - RISPRN)
> MSC - SysSetup saved files (SYSSETUP)

Registry
In the PGP server(s) must be written in the registry
APPS\OneShotBck\LTAServer the name of the PGP where is activated
the LTA function (LTA server): can be itself or another server; defining this
registry with a valid server name, will be enabled the function to send the
medium term historical files to the LTA.
On the LTA server must be changed in Sizes following registry:

9AKK101130D1382

413

> N.DAYS - defines the number of days of the Circular Buffer (default 0;
insert a positive value to enable LTA function)
> N.LTAS - defines the number of record for file F_LTAS (default 0; set
to 1 to enable the LTA function because onle one record is necessary
for this file)
> N.SRVR - defines the number of servers configured to collect
historical files (default 0; set equal at the value assigned to the registry
Sizes\MXNODE to enable the LTA function)
In the LTA server must be defined the registry Directories\LTAHisBackup
defining the path where the medium term archives will be sent.
On the LTA server must be defined for Directories\LTA following registry:
> CircleBufferPath - defines the main path where will be saved the files
of the Circular Buffer.
> EmergencyPath - defines the path where will be saved the daily files
when some error will be found on search room in the Circular Buffer.
> InBufferPath - defines the path where are copied momentarily the
daily files received from PGP servers.
> ReportPath - defines the folder where will be saved the report
produced after the save of the daily files.
On the LTA server must be defined for APPS\LTA following registry:
> InitialWait - defines the number of milliseconds to delay the start of
the LTA manager (default 30000).
> PollingDeadLine - defines the end polling time (string - hour.minutes)
(default 08.15)
> PollingStartTime - defines the start polling time (string hour.minutes) (default 08.10)
> PollingTime - defines in milliseconds the timer used in the polling
phase to check the received daily files (default 30000).
> StatusTagName - defines the name of the tag defined on the linked
servers to notify the status of the LTA function; the tag must be
configured as:

414

9AKK101130D1382

- TAGNAME - Type EXTDIG - values:


0 = STOPPED
1 = GOOD
2 = PROBLEMS
- ATOM1 - Type DIGITAL - current LTA status
-1 = STOPPED - LTAExplorer program is not active
0 = Wait Polling Start Time (WAIT_START_TIME)
1 = Polling in progress (POLLING)
2 = Polling terminated ("POLLING_DEAD)
3 = Copy files from Server to local disk in progress
("SERVER_TO_IN)
4 = Update Circular Buffer in progress ("UPDATING_CB)
5 = Update LTA Drive in progress ("WRITING_DRIVE)
6 = Daily Polling executed - Wait tomorrow ("WAIT_TOMORROW)
- ATOM3 - Type STRING - description of the local CB disk
- ATOM4- Type ANALOG - value (%) of the free space of the local CB
disk
- ATOM5 - Type DIGITAL - status of the local CB disk
0 = ENABLED
1 = DISABLED
2 = UNFORMATTED
3 = READONLY
4 = FULL
5 = FUNCTION DISABLED
- ATOM6/7/8 - like 3/4/5 but for the LTA drive (if configured)
- ATOM9/10/11 - like 3/4/5 but for the Removable drive (if configured)

9AKK101130D1382

415

> Trace - enables the complete trace in the LTA log file of all messages
produced by LTA manager (default NO).
Additional APPS\LTA registry used to define the parameters to archive files
(LTADrive functionality) on specific path (LTADrivePath) organized by
servername/date/type without time limits (suspended only when the drive is
FULL):
> LTADriveIsToActivate - flag to enable LTADrive function
Additional Directories\LTA registry for LTADrive functionality:
> LTADrivePath - defines the path where will be saved the files by
servername/date/type.
Installing on the LTA server a program like NERO InCD (only for
rewritable disks) or Sonic DLA to format discs (CD/DVD) in such a way
that they can be used like hard disks, you can define in the LTADrivePath
registry directly the path of the CD/DVD to archive on it the files. Using
one of these tools you can archive your files to a removable drive without
use the LTADriveCmd program: in this case is necessary to
remove/rename the PGP registry trees named RemovableDrive
(APPS\LTA and Directories\LTA) following described.
Additional APPS\LTA\RemovableDrive registry used to activate specific
program to transfer files from LTADrivePath to a removable drive:
> CmdGetInfo- command string to send to the specified program to
have the info about the used removable drive; the activated program will
write following registry:
> SizeFree - free size of the removable drive
> SizeTotal - total size of the removable drive
> SizeUmCode - Number to indicate the E.U. used for the Size*
(0=GB, 1=MB, 2=Blocks)
> CmdPgmCode - resulting command code - defines the status of the
last requested command (-1=InProgress, 0=Good, Other=Error).
> CmdPgmName - Name of the program to active to write the archived
files on the removable drive.

416

9AKK101130D1382

> CmdWrite- command string to send to the specified program to write


archived files to the removable drive.
> CmdWriteEmpty- command string to send to the specified program
to write archived files to the removable drive when the drive is empty.
> StartDate - Registry used by the program to save the date of the
oldest file archived on the removable drive.
> EndDate - Registry used by the program to save the date of the most
recent file archived on the removable drive.
Additional Directories\LTA\RemovableDrive registry used to transfer files
from LTADrivePath to a removable drive:
> RemDrivePath - Removable drive path
The PGP is pre configured to activate the program named LTADriveCmd
following described.

Functionality
The managers of medium term archives send to the LTA server, in the folder
defined by the LTAHisBackup registry, a copy of the produced files, naming
servername+filename
servername can be the name of sending server, if is not defined the
PlantUnit, or PLANT_UNIT_n where n is the number of defined PlantUnit.
Following the main phases of LTAExplorer:
> Internal timer - with a specific delta time (5 seconds) are executed
following actions:
- all configured server are checked to get the status;
- to all connected server is updated the tag (named as defined in the
StatusTagName registry) with the current status of the LTA function
- all files written by the PGP servers to the folder defined by
LTAHisBackup are copied to the folder defined by InBufferPath,
removing from the file name the servername+; the files are ordered by
server name/archive type.

9AKK101130D1382

417

> Polling - When a start polling time is found, is activated a timer scheduled
as defined in the PollingTime registry; each time, are checked all received
files to send a message to the server when not all historical configured types
are found.
> Updating Circular Buffer- When the end polling time is found, all files in
the InBufferPath are copied to the circular buffer ordered by server
name/archive type.
> Writing to LTA drive - this phase is activated only if is enabled the
LTADrive function; the files archived in the CB are copied to the
LTADrivePath; the files will be saved on LTA drive by server
name/date/archive type. If is defined also the RemovableDrive program
management, in this phase will be executed also the transfer from the
LTADrivePath to the removable drive; all transferred files will be removed
from the LTADrivePath.
The phases in boldface can be also forced manually by operator using
specific dialog.

LTA Interface
After the LTA Explorer has been activated, the main interface window is
opened. The figure below shows the main interface window of the LTA
Explorer.
The window includes different areas to show LTA informations.

418

9AKK101130D1382

Figure 30. Long Term Archive Explorer

FileView
This area shows the folders of different intermediate storage used by LTA.

9AKK101130D1382

419

Figure 31. File View


> Circular Buffer - shows the folder/files of the folder defined by the
CircleBufferPath registry and are, ordered by server/archive type, the files of
the last configured days (defined by the registry
APPS\LTA\CircleBufferDays). The Circular Buffer will be called CB in the
following description.
> Today Input - shows the folder/files of the folder defined by the
InBufferPath registry; here are momentarily copied the files received from
the linked servers.

420

9AKK101130D1382

> Emergency - this folder is used by the LTA Explorer only to save the files
received by the servers when no place is found in the CB (for example when
is found a file too much old to be inserted in the CB).
> LTA Drive or Recording drive - LTA Drive is displayed only when the
LTADrive function is active; if an external drive manager is defined (used
LTADriveCmd), will be showed Recording Drive. Shows the folder/files of
Long Term Archive files ordered by server/date/type.
Configured Servers
This area shows the configured servers.

Figure 32. Configured servers


The configured servers are readed from the system files configured with the
SysSetup->Build Data Base -> Node Data Base Builder.
For each server are showed following informations:
> Server Name - shows the name of the configured server.
> Plant Unit - shows the Plant Unit number: if is 0, the folders for this server
will be named like the server; if is not 0, the folders will be named
PLANT_UNIT_n where n will be the Plant Unit number.
> Last Update - Date/Time of last server status change.
> Status - shows the current server status.
> XXX Req/Rec- for each managed archive, shows the flags for
Requested/Received daily files. Requested is forced to YES for all types.

9AKK101130D1382

421

LTA Status
This area shows informations about the status of the LTA manager.

Figure 33. LTA Status


In this area includes following informations:
> Date/Time - shows the current date and time.
> Polling - shows the Start Time and the End Time configured for the
Polling phase like configured initially in the specific registry.
> Change Parameters - when clicked, actives the dialog to change the
Polling start and end time or to active manually a specific phase. Figure 35
shows the dialog window.
> Open Log File- when clicked, opens a window to show the messages
included in the daily LTA log file.

422

9AKK101130D1382

> Message Log - in this area are written all LTA messages (trace and
errors); double clicking on one row, you can remove, selecting YES in the
displayed window, all rows currently showed in this area.
> LTA phases - In this area are showed all possible status of the LTA
manager:
Waiting Start Time - The Day is changed and the program is waiting for
the Polling Start Time
Polling - The polling phase is in progress
Polling - Time Terminated - Intermediate status between end of Polling
and activation of Server to In; probably never visible because the
execution time is very short.
Server to In - After the polling the program check in the LTAHisBackup
folder to transfer files received by servers to InBufferPath folder; this
phase will be selected only if a big number of files will be sent by
servers because normally this copy is executed periodically by the
internal LTA timer.
Updating Circular Buffer - all files received form the connected servers
are copying to the CB folders.
Writing to LTA Drive - If configured, the LTA drive manager is copying
all files from CB to the LTA drive and, if configured, from LTA drive to
Removable drive.
LTA drive status
This area shows the status of the drives used by LTA manager.

9AKK101130D1382

423

Figure 34. LTA Drive Status


CB Drive shows the status of the drive defined by the registry
CircleBufferPath.
LTA Drive (or Removable Drive) is showed only if is configured the LTA
drive manager and shows the status of the configured drive.
Change Parameters
The figure below shows the LTA parameters management window.

424

9AKK101130D1382

Figure 35. LTA Change Parameters


> Time Parameters - includes the fields to configure the Polling parameters;
the changes will be accepted selecting Update Time Param. button.
> LTA status - includes the fields to show the current LTA status (Current
status) and to select manually a new phase (Change to); selectable phases
are following:
Waiting Start Time - wait daily polling start time
Polling - will be activated the polling to check all files received by the
linked servers.
Updating Circular Buffer - all files received from linked servers will be
written to the circular buffer

9AKK101130D1382

425

Writing to LTA Drive (if configured) - all new files will be written from CB
to archive disk
Waiting Tomorrow - wait tomorrow
The changes will be accepted selecting Update LTA Status button.

LTADriveCmd program
LTADriveCmd works using NERO 6 utilities and is necessary to install
NERO 6 on the LTA server to can use it; derives from NeroCmd and
manages the access to the defined removable drive. Is activated by
LTAExplorer using following PGP APPL\LTA\RemovableDrive registry:
> CmdGetInfo - this is the command line used to activate the program
when is necessary to have the informations about the drive: the
program will load these registry
> SizeFree - free size of the removable drive
> SizeTotal - total size of the removable drive
> SizeUmCode - Number to indicate the E.U. used for the Size*
(0=GB, 1=MB, 2=Blocks)
> CmdWrite - this is the command line used to activate the program
when is necessary to write archived files to the drive if is not empty.
> CmdWriteEmpty - cthis is the command line used to activate the
program when is necessary to write archived files to the drive if is
empty.
> CmdPgmCode - in this registry (initialized with -1 by LTAExplorer
before activate the program) will be written the resulting command
code:
> -1 - In Progress
> 0 - command executed
> Other values - Error on command execution
In the command lines you can use following specific keys:

426

9AKK101130D1382

> ?WRITE - this key will be replaced with the default command line to
write files to the drive
> ?WRITE_EMPTY - this key will be replaced with the default command
line to write files to the drive when is empty
> ?APPEND - normally a new log file is produced when is executed a
write to the drive: you can add this key to the write command lines to
append the trace lines to the existing log file (for example you can use
this key only for CmdWrite command line to create a new log file only at
the first write to an empty drive).
> %drive - this key will be automatically replaced by LTAExplorer
before activate the program with the root of the defined drive.
> %label - this key will be automatically replaced by LTAExplorer before
activate the program with the label to assigne to the drive: the label is
formatted as YYMMDD-yymmdd where YYMMDD is the date of the
oldest file archived on the drive and yymmdd is the most recently.
> %folder - this key will be automatically replaced by LTAExplorer
before activate the program with the folder including the files to archive
to the drive (defined in the LTADrivePath registry).
LTADriveCmd program produces in the folder defined by the system
environment registry TEMP following trace files:
> LTADriveCmdInfo.log when are requested the informations about the
managed drive
> LTADriveCmdWrite.log when is executed a write to the drive.

9AKK101130D1382

427

People Finder
Overview
The People Finder application allows the notification to the assigned staff of
the occurrence of alarm situations by means of the dispatch of a SMS to a
mobile phone.
Following a user defined event, like any type of configurable alarms, the
OGP server, using a GSM modem (not included in the PGP supply, will send
a SMS to the shift operator defined in the shift book, and a warning call to
his/her mobile phone. The answer to the warning call will determine the
acknowledgement of the alarm.
If the shift operator does not answer the call (which is repeated for a
configurable number of times) the program repeats the dispatch of the
message and dials a call to the mobile phone defines as Recovery.
Following the list of GSM modems tested for People Finder function:
Digicom Pocket GSM
Falcon A2D-1
Siemens TC35t-AT

Database
In order to trigger the sending of a SMS in case of alarms, the corresponding
tags in the PGP database must be configured with a positive value (1-15) in
the SMS Index field. This index refers to the SMS to use in case of the
occurrence of an alarm for that tag (see section: Shift book configuration
file).

Registry
In the PGP server must be defined for APPS\Finder following registry:
Serial Port configuration parameters (name - default):
> Port - COM3
> BaudRate - 19200

428

9AKK101130D1382

> ByteLength - 8
> StopBits - 1
> Parity - NONE
Function customizing parameters (name - default - description):
> CPIN - 8629 - PIN code
> Repeat - 3 - Number of call attempts to the shift operator before
transferring to the recovery number
> Read_Timer - 11000 - Wait time (in milliseconds) for an answer from the
modem
> Drin-Timer - 20 - Wait time (in seconds) for an answer to the call
> CnfPhonesFile - <INSTALLDIR>\Config\PeopleFinderPhones.xml - Name
of the Finder configuration file
> CnfShiftsFile - <INSTALLDIR>\Config\PeopleFinderShifts.txt - Removed
since 4.1 release
> WebFile - data\eMaintenanceStatus.xml - Web file definition for log
recording
> SendTagDescription - NO - YES to send in the SMS message the tag
description rather then the alarm comment
> SendExTagDescription - NO - YES to send in the SMS message the
extented tag description rather then the description
> DataCall - NO - YES to make a data call to the mobile phone (a voice call
is otherwise made)
> DisableAckFromSms - NO - YES to acknowledge the alarms only
answering to the mobile phone call
> TraceLog - NO - YES to have more details in the log file about the
operations executed by the program

Calling Finder Configuration

9AKK101130D1382

429

Defining in the registry CnfPhonesFile a file name with .XML extension,


the configuration of the Shifts and Phones for the Finder function is
managed by SYSSETUP; all configuration parameters will be included in
a single XML file. If you have already used an XML file created with
previous PGP releases, you have to change manually in the XML file
the format of the DATE like this new format: YYYY-MM-DD hh:mm:ss.
Select following menu:
> Start (on the desktop)
> Programs
> ABB Industrial IT
> Power Generation Portal
> System Setup
In this way, the interface window of the System setup management is
opened. Open on the left the tree of the item People Finder to show the two
subItem: Index and Phones.

430

9AKK101130D1382

Figure 36. SysSetup - People Finder


If the configuration file is empty, you can only click on the items with the right
mouse button to show the configuration menu:
> New Sms Index
> New Phone

9AKK101130D1382

431

New Phone
Selecting New Phone will be showed following window

Figure 37. SysSetup - People Finder - Configure New Phone


> Phone ID - select the ID - Automatically will be showed only the unused
ID; the max number of configurable phones is 35 (34 + Recovery)
> Number - enter the number of the mobile phone
> Name - Name of the operator to which is assigned the phone
> Max Sms - Number of call/sms attempts (> 1)
Select OK to add the configured phone.

New Sms Index


Selecting New Sms Index will be showed following window

432

9AKK101130D1382

Figure 38. SysSetup - People Finder - Configure New Sms Index


> SMS Index - Enter the number to identify the SMS index (1-15)
> Phone ID - Select a Phone ID to assigne to this SMS index (will be
automatically showed only the configured phones)
> From/To - Select Date/Time for shitf start and end
> Delay - Wait time (in minutes) for ack
Select OK to add the configured SMS Index.

Phones
When the Phones item is selected, the right side of the dialog window
changes.

9AKK101130D1382

433

Figure 39. SysSetup - Phones


Double clicking on a row on the right view, will be showed a window to
view/change the phone parameters: the layout is the same of Figure 37 but
the Phone ID is read only and the additional button Cancel is showed only
if the phone is not used by some Sms Index. This button can be used to
remove the Phone configuration; is possible to cancel a Phone also select it
on the right view and after press the Delete key of the keyboard.

434

9AKK101130D1382

Sms Index
Opening all items in the Index tree and selecting an item Index n, the right
side of the dialog window changes.

Figure 40. SysSetup - Index N

Double clicking on a row on the right view, will be showed a window to


view/change the SMS index parameters: the layout is the same of Figure 38
but an additional button Cancel is showed. This button can be used to

9AKK101130D1382

435

remove the SMS Index configuration; is possible to cancel a SMS Index also
select it on the right view and after press the Delete key of the keyboard.
Shift and Phones configuration files (before PGP 4.1 release)
To manage also the old configuration files, People Finder can read the
configured shifts and phones from two different files defined in the specific
registry: the old configuration is managed only when in the CnfPhonesFile
registry is defined a file name not .xml.
Shift Book Configuration File
Each record of the Shift Book Configuration File must have the following
structure:
IDXSMS,START_DATE,END_DATE,CODGSM,TIMEOUTACK
Where:
> IDXSMS - SMS index (1-15)
> START_DATE - Shift start date (DD MMM YYYY hh:mm:ss)
> END_DATE - Shift end date (DD MMM YYYY hh:mm:ss)
> CODGSM - identification code of the shift operator (0-9 A-Q)
> TIMEOUTACK - Wait time (in minutes) for ack
Example:
1,28 NOV 2003 02:00:00,31 DEC 2003 23:00:00,A,1
2,28 NOV 2003 02:00:00,31 DEC 2003 23:00:00,B,1
Notes:
> The comment lines in the file are identified by the character !
> Dont use numbers or upper case letters after a space in comments
> The identification code of the shift operator is used to access the phone
book definition file: dont use the R code (recovery)
> The SMS Index, together with the date/time when the alarm happened, is
the access key to the file, and will identify the code of the shift operator to
which the event must be reported

436

9AKK101130D1382

Phone Book Configuration File


The phone book configuration file (not xml version) must have the following
structure:
CODGSM,PHONE_NO,MAXCALL,DESCRIPTION
Where:
> CODGSM - Identification code of the shift operator (0-9 A-Q), R identifies
the Recovery number
> PHONE_NO - Number of the mobile phone of the shift operator
> MAXCALL - Number of call attempts (> 1)
> DESCRIPTION - Description (name) of the assignee of the mobile phone
Example:
A,3331111111,2,JOHN SMITH
B,3351111111,2,TOM BROWN
R,3401111111,3,RECOVERY
Notes:
> The comment lines in the file are identified by the character !
> Dont use numbers or upper case letters after a space in comments
> Dont insert comments after the name of the assignee
> The identification code R is used to identify the Recovery number which
will be called when there is no answer from the shift operator

Functionality
Following the occurrence of an alarm for a tag where SMS Index field is
greater than zero, the People Finder program (Finder.exe) will use this index
combined with the current date and time to retrieve from the Shift Book
configuration the code of the shift operator to which the notification must be
sent.
With this code, it will access the Phone Book parameters to retrieve the
mobile phone number and send the SMS formatted as follow:

9AKK101130D1382

437

IDX HH:MM:SS DD-MM-YY DESC


where:
IDX - SMS Index
HH:MM:SS DD-MM-YY - alarm time stamp
DESC - Alarm comment or tag description or tag extended description
(like defines in the registry settings)
A timer is then started to wait for an acknowledge message formatted as
follows:
IDX HH:MM
where:
IDX - SMS Index
HH:MM - reply time stamp
If the shift operator does not send the answer message before the timer
expiration, the program dials the mobile phone to warn to receiver of the
incoming message.
The reception of acknowledge or the answer to the call will acknowledge all
SMS with index IDX and time stamp earlier than the reply time stamp.
If the shift operator does not answer, the program cyclically repeats the call
for the configured number of times and then it repeats the same sequence
(message+phone calls) with the recovery number.
All actions performed by the program and the results are registered in the
log file: if the TraceLog registry is YES, more informations are registered.
The same messages are registered in the file (if existing) defined in the
WebFile registry to be consulted with the WebServer from remote positions.
Master/Slave
In a PGP Master/Slave configuration, the Finder.exe program will be
activated on all machines but it will execute the functions only on the primary
server; on the slave, it will wait to be primary.

438

9AKK101130D1382

Real-time Utilities
By clicking with the right mouse button on the icon (a small phone) in the
System Tray showing the program activity, a menu containing the following
items are displayed:
Close - closes the menu
Open Log File - opens a window to access and display the log file
Function Status - presents the state of the function
Enable - enables the function suspended
Disable - disables the function if active
Update Shifts - after the modification of the shifts, loads the new
configuration
Acknowledge all Alarms - acknowledges all pending alarms
Stop - stops the program

9AKK101130D1382

439

440

9AKK101130D1382

Section 5 Distributed Architecture


Introduction
PGP is available for use on a wide range of PC platforms running the
Microsoft Windows operating system.
Each system architecture depends on the requirements of the specific
application. Figure 41 shows a general configuration where some servers
and clients are connected via a LAN cable. They are connected via Ethernet
TCP/IP protocol. Client PCs receive data from a Server and interact with the
user by displaying mimics, alarm list, trends, etc. The figure shows only the
main components.
PGP servers may operate as individual stations, each one independent from
any other, except for client interconnection, or they may operate in a
distributed architecture where all servers are interconnected from a
configuration and a operation point of view.
The distributed architecture is based on the inter-operability among different
PGP server nodes to accomplish a consistent configuration and operation
environment in the whole system.

9AKK101130D1382

439

Figure 41. Example of PGP Architecture


The main features implemented on a PGP node can be subdivided as
follows:

440

Server functions, which mainly consist of data acquisition, alarm


processing, calculation generation, historical data recording, report
generation and so on.

Client functions, which provides the Human System Interface towards


the Server functions. These functions provides the capability to access
the Server data by mimic displays, alarm lists, trends, and to
control/command the field devices. The Client functions also provide the
capability for an engineer to configure and maintain the various
databases, which are implemented on the Server.

9AKK101130D1382

According to the feature implemented, a node can be defined as Server


only, Client /Server or Client only.
While the PGP Client/Server architecture is based on a single Server node
which may connect several Client nodes, the distributed architecture
described in this section refers to two or more Servers which may connect
several Client nodes.
Each Server is totally independent from the others from a operational point
of view. That is, it does not need any support from any other node to fully
operate and to provide information to the user. However, intra-server data
exchange is performed in order to keep congruency of data and
configurations of the whole system as will be explained in the following
description.

Assumptions
The following assumptions apply to a distributed architecture.

The same release of PGP must be implemented in all Servers


belonging to the distributed architecture.

Servers are independent as far as concerning the database


configuration. They may have an identical database or share a portion
of the database or musttally different databases.

In order to accomplish the functions described below, especially those


related to the tags, there are no restrictions concerning the name of the
tags, the ordering and the size of the databases. Databases can be
completely different as stated above also. The only requirement is
related to the Tag Unique Identifier: it must be consistent throughout the
different databases.

Servers that cooperate to the distributed architecture must have a


consistent database of nodes. This database defines the names and
the characteristics of each node. Refer to Section 2, Database
Configuration of this manual for details.

9AKK101130D1382

441

Furthermore, propagation of data from a Server to other Servers


depend on the proper definition of the destination masks in the tag,
trend group and calculation databases.

Refer to Tag Database Subsystem on page 71, Trend Group


Subsystem on page 238 and Calculation Subsystem on page 176 for
details.

Server Functions
PGP maintains a consistent configuration and operational environment on
all nodes of the distributed architecture.
The Server nodes exchange information and data, either during the on-line
operation or in off-line mode. Some data exchange is performed
automatically by the system, while other exchanges are activated by a user
request, as described in the following description.

On-line Features
The main data exchanged among servers, during the normal on-line
operations, is related to the following functions.

442

Monitoring of the network nodes configuration and realtime diagnostic


functions. Each node keeps track of the status of the other nodes of the
system and maintains updated a dedicated tag. This tag can be used to
animate mimics and/or to generate alarm messages. The status of the
nodes is used to activate or enable the functions described below.

Propagating the actions carried out by an operator, regarding some


basic actions performed on tags, such as:

acknowledge alarms,

put tags on scan and off scan,

disable and enable alarm checking for tags,

insert value for tags.

9AKK101130D1382

This propagation is automatically performed on a per-tag basis. In fact


the configuration of each tag foresees a field indicating the list of nodes
to which propagated the operator actions.

Propagating to other nodes realtime values acquired from one single


node. This action is performed automatically on a per-tag basis. In fact
the configuration of each tag foresees a field indicating the list of nodes
to which propagate the values.

Maintaining a consistent configuration of the tags databases over the


nodes upon changes entered by the system engineers. This function is
achieved directly by the system engineers by using the database
download/upload facilities.
After performing on-line configuration changes the system engineer can
export the changed portion of tag database to a DBF file. This file can
be copied to the other nodes of the system, and imported using the
standard import function.

Managing the single outputs such as the automatic printouts, the


ODBC connections and eventually other functions, which must be
carried out by only one node at a time. This feature is implemented by
configuring for each node a weight parameter in the configuration of
nodes. The diagnostic functions will take care of individuating the node
with higher weight and enable for it the control of the single outputs
functions.

Initialization Features
The following functions are performed during the start-up phase of a server,
in order to keep it updated the most as possible.

9AKK101130D1382

Aligning the Server databases at start-up time to include possible


changes entered on other Servers while the starting up Server has been
off-line. An off-line, on-demand function shall be available for this
scope.

443

Aligning historical archives at Server start-up time to avoid or minimize


loss of data concerning:

chronological alarms,

periodic logs,

playback data,

calculated tags,

historical groups.

Client Functions
Similar to the standard Client/Server architecture, each Client participating
to a distributed architecture can be connected to one or more Servers at a
time.
Each Client, however, may connect every Server in the system, without any
restriction. Each Client maintains a list of known Servers, which is used by
the following functions; the first Server in the list is considered as the
referring Server.

Re-assigning the Client, upon user request, to another Server. This


function allows a user, with appropriate privileges, to locate a PGP
Server on the Network, either from the known node list or selecting it by
name.
Once the node has been located and the connection has been
established the user has the possibility to re-assign the Client functions
to the selected Server. This switch-over is transparent for the main PGP
Explorer application (the application which manages mimics, alarms,
trends), while other applications, such as configuration functions, are
terminated and must be restarted.

Re-assigning the Client, automatically, to another Server in case of the


current Server failure.
The previously described function is also automatically activated by the
system in case of failures in the connection between the Client and the
Server. If some communication function fails, the Client can scan the list

444

9AKK101130D1382

of known Servers, and try to connect to the Server until the connection
is successful. The same procedure is performed during the Client startup.

ALIGNSPECS Program
This program manages the alignment of the specs of the INFI stations to the
configured servers (parameters defined in the APPS\ALIGNSPECS
registries) when is defined a PGP architecture with PGP servers not directly
connected to INFINET via ICI.
Runs only at PGP startup and the initial delay must be enough to grant that
the servers connected to the ICI have their database updated.

9AKK101130D1382

445

446

9AKK101130D1382

Section 6 OLE for Process Control


Introduction
O.P.C. (Ole for Process Control) represents a standard mechanism based
on the Microsoft OLE/COM technology for communicating to numerous data
sources, in order to grant inter-operability between automation/control
applications, field systems/devices, and business/office applications in the
process control industry.
The OPC Foundation, a non-profit corporation (the OPC Foundation), has
established a set of standard OLE/COM interfaces to provide different
functionality (i.e. Data Access, Historical Data Access and Alarm/Events
Handling).
The PGP OPC server provides Data Access (name OPC.Power Generation
Portal.1) and Alarm&Event (name OPC.Power Generation PortalAE.1)
functionalities and it is implemented according to the 2.03 (DA) and 1.02
(AE) specifications.
It is designed to allow simultaneous connections by OPC clients developed
accordingly to the OPC specifications described above. See the following
sections for further explanations about OPC client connections.
This section provides a brief overview about OPC architecture, and explains
the PGP OPC server.

9AKK101130D1382

445

OPC Overview
The OPC specification describes the OPC COM Objects and their interfaces
implemented by OPC Servers. An OPC Client can connect to OPC Servers
provided by one or more vendors as shown in the figure below.

Figure 42. OPC Client


Different vendors may provide OPC Servers. Vendor supplied code
determines the devices and data to which each server has access, the data
names, and the details about how the server physically accesses that data.

446

9AKK101130D1382

Multiple OPC Clients can be connected to multiple OPC Servers in a


completely free architecture as shown in the figure below.

Figure 43. OPC Client/Server Relationship


At a high level, an OPC DA server is comprised of several objects: the
server, the group, and the item.
The OPC server object maintains information about the server, and serves
as a container for OPC group objects.
The OPC group object maintains information about itself, and provides the
mechanism for containing and logically organizing OPC items.
The groups are associated to a update rate, which determines when item
values and qualities must be checked, in order to update internal buffer, and
to notify item changes to the OPC clients.
The OPC Groups provide a way for clients to organize data. For example,
the group might represent items in a particular operator display or report.
Data can be read and written. Exception based connections can also be
created between the client and the items in the group, and can be enabled
and disabled as needed.
An OPC client can configure the rate that an OPC server should provide the
data changes to the OPC client.

9AKK101130D1382

447

There are two types of groups, public and local (or private). Public is for
sharing across multiple clients, local is local to a client.
The PGP OPC server does not support public groups, neither any
specific interfaces about such a groups. Only private groups are
supported.
Within each Group the client can define one or more OPC Items.

Figure 44. OPC Group/Item Relationship


The OPC Items represent connections to data sources within the server. An
OPC Item, from the custom interface perspective, is not accessible as an
object by an OPC Client. Therefore, there is no external interface defined for
an OPC Item. All access to OPC Items is via an OPC Group object that
contains the OPC item, or simply where the OPC Item is defined.
Associated with each item is a Value, Quality and Time Stamp. Note that the
items are not the data sources: they are just connections to them. For
example, the tags in a DCS system exist regardless of whether an OPC
client is currently accessing them. The OPC Item should be thought of as
simply specifying the address of the data, not as the actual physical source
of the data that the address references.
The OPC specification dictates that OPC clients are allowed to specify that
some operations can be performed on CACHE or DEVICE by the OPC

448

9AKK101130D1382

server. Items read operation, for example, could be performed in such a


ways.
The implementation details of such a mechanism are server specific but
access to CACHE data is expected to be faster than DEVICE data.
The 1.02 AE specification details with entities commonly referred to as alarm
and event, having distinct meanings. A condition is a named state of the
OPC Event Server, or of one of its contained object, which is of interest to is
OPC clients.
An alarm is intended as an abnormal condition, that is a special case of
condition.
On the other hand, an event is a detectable occurrance which is of
significance to the OPC Event server, the device it represents, and its OPC
clients. An event may or may not be associated with a condition.
The AE specifications state that the expectation is to have the available
events and conditions organized within one or more process areas. An area
is a grouping of plant equipment configured by the user. If areas are
available, an OPC area browser object may be provided by an OPC server
in order to allow process area browsing by OPC clients. Event categories
define grouping of events supported by an OPC Event server. Examples of
event categories might include process events, system events etc and
categories may be defined for all event types, i.e. simple, tracking and
condition related.
In order to receive event notifications, OPC clients must subscribe to them
and, for each subscription, events may be selected (event filtering) using
event types (simple, condition, tracking), categories, priority, areas and
event sources.
See the OPC Data Access and Alarm Event Specification section for further
details and explanations.

9AKK101130D1382

449

PGP OPC Client


PGP may connect OPCservers DA and AE, in order to receive data from a
external device. To use an AE connection you must connect also the DA
server, i.e. connections using only a AE server will not work.
In the tag database, OPC source tags must be configured properly. Refer to
the section on tag database configuration for details on OPC tags.

PGP OPC Server


The PGP OPC Server provides Data Access functionality for all the
predefined PGP tags (analog and digital) which can be readable, writable or
both. Therefore the server does not access directly to a physical device, but
this is done by the PGP itself. In other words, PGP is logically placed
between the OPC server and the physical devices.
The OPC server doesnt require PGP to be activated. This is necessary, of
course, to read and write tags provided by PGP, but not for server
activation.
The OPC specifications foresee the server can be used in a TEST mode
when outputs are disconnected from the actual hardware (from PGP in such
a case). The server will otherwise behave normally, and inputs may be
actual or simulated depending on the vendor implementation.
The PGP OPC Server in TEST mode does not simulate any input, but all
items values are set to 0. All provided server interfaces are available to be
tested, and the server behaves normally.
The OPC client takes care to activate and close the OPC server; this is not a
task for PGP.
Once PGP is activated, the OPC server status will be set to RUNNING
mode (if the server is active) and data access is now possible.

450

9AKK101130D1382

OPC Data Acquisition


OPC Client Data Acquisition
For remote server connections, when network resources are involved, a
time delay could occur if the network cable is detached, or the server is
closed in an incorrect manner. System performance could be decreased.
The PGP OPC client is designed to have proper timeouts without being
affected by the above delays.
These timeouts can be set from the windows registry. Open the
KEY_LOCAL_MACHINE key, then the SOFTWARE key, then the ABB key,
then the PGP key, then the APPS key and finally the OPC key. The
following registry values can be set:

CacheTimeOut: used by synchronous read from Cache;

DeviceTimeOut: used by synchronous read from Device;

StatusTimeOut: used by exception read. The OPC Client is advised by


the server about item changes. No read requests are done by client,
therefore it checks the server status periodically.

All these entries are in seconds.


The OPC specification does not dictate anything about the number of items
that can be specified in a single read operation by the client. In order to
avoid any problems about managing of a large amount of items, the PGP
OPC client is able to pack the amount of item to be read in data packets
having a configurable size.
The read methods can be set from the windows registry. Open the
KEY_LOCAL_MACHINE key, then the SOFTWARE key, then the ABB key,
then the PGP key, then the APPS key and finally the OPC key. The
ItemPacketSize registry value can be set to the number of items contained
in a single data packet.

9AKK101130D1382

451

See Table 188 for the default values:


Table 142. OPC Server Registry default values
Name
CacheTimeOut
DeviceTimeOut

Default Value
2 seconds
4 seconds
See note 1 at the end of the table.

StatusTimeOut

1 seconds

ItemPacketSize

500

Note 1:
Generally the DeviceTimeOut value is greater than CacheTimeOut one.
The PGP OPC server supports six group update rates.
Refer to Table 189 for the DataAccess Client refresh rates.
Table 143. Client DA Refresh Rates
Code

Description

500

500 milliseconds.

1 second

4 seconds

10

10 seconds

30

30 seconds

60

60 seconds

Note 2:
Any other refresh rate configured by the user will be rounded towards one of
the above PGP supported rates.

452

9AKK101130D1382

OPC Server Data Acquisition


Once an OPC Client is connected to the server (and groups and items have
been configured) the PGP OPC Server updates and stores internally (in its
own CACHE) the values and qualities of the configured items.
This can be done by means of two different ways:

The server requires periodically to PGP the values of the active items
belonging to groups that are active and scheduled in that specific time.
The group refresh rate establishes when group must be managed (in
other words, whether it is scheduled) in that specific time. This is done
in order to avoid server overhead but read is done regardless item value
changes.

The server periodically checks the PGP queue for item changes. Items
not changed are not managed (because they are not contained in
queue) but it is possible to receive items not active or belonging to
inactive and/or not scheduled groups (the PGP ignores OPC
specifications).

These read methods can be set from the windows registry. Open the
KEY_LOCAL_MACHINE key, then the SOFTWARE key, then the ABB key,
then the PGP key, then the APPS key and finally the OPC key.
ReadFromQueue registry can be set to the following values:
1.

NO : it corresponds to read items by polling (first way).

2.

YES: it corresponds to read items from queue (second way).

The default value for the ReadFromQueue key is NO.


This two different read methods allow you to have two different solutions for
server updating (and for server overhead from a performance point of view).
An OPC client itself could set the best solution on the basis of both such a
server behavior and the different OPC read modes.
The DEVICE data is not obtained from a physical device but from the PGP
system. Therefore data values are subject to data updating by the system.
The CACHE data instead are obtained from an internal server buffer,
without any request to and values are subject to the group update rates.

9AKK101130D1382

453

In both cases, the data value could be slightly different from the value at the
time when the client requires data.
The PGP OPC server supports several group update rates. Refer to the
refresh rates in the description of OPC parameters of a database tag.

Client refresh rates less than 500 msec will be set to 500 msec.

Client refresh rates higher than 60 sec will be set to 60 sec.

Client refresh rates between two server supported rates will be set to
the higher one.

For example, a refresh rate of 15 sec will be set to 30.


The OPC Data Access server implements all the mandatory interfaces
related to the 2.03 OPC specifications and also the optional interface
IOPCBrowseServerAddressSpace.

454

9AKK101130D1382

Table 190, Table 191and Table 192 summarize .


Table 144. OPC Server Interfaces.
Interface

Implemented

IOPCServer

Yes

IOPCServerPublicGroups (optional)

No

IOPCBrowseServerAddressSpace (optional)

Yes

IOPCItemProperties (new 2.0)

Yes

IConnectionPointContainer (new 2.0)

Yes

IOPCCommon (new 2.0)

Yes

IPersistFile (optional)

No

Table 145. OPC Group Interfaces.


Interface

Implemented

IOPCGroupStateMgt

Yes

IOPCPublicGroupStateMgt (optional)

No

IOPCASyncIO2 (new 2.0)

Yes

IOPCAsyncIO (obsolete - V1)

No

IOPCItemMgt

Yes

IConnectionPointContainer (new 2.0)

Yes

IOPCSyncIO

Yes

IDataObject (obsolete - V1)

No

9AKK101130D1382

455

Table 146. Enum OPC Item Attributes.


Interface
IEnumOPCItemAttributes

Implemented
Yes

The 1.0a interfaces have not been implemented. However 1.0a registry
setting are still present. An OPC client 1.0 is able to connect to the PGP
OPC Server. For example reading items in the synchronous read mode
version 2.03 differs from the 1.0a in the exception and asynchronous read
mode.

OPC ALARM & EVENT


OPC Client Alarm & Event
In accordance to the OPC AE 1.02 specifications, there are three types of
events:

Condition-Related events are associated with conditions. They


represent transitions into or out of the states represented by the OPC
Conditions, an abstract object model used by inside the server and
associated to OPC source (a process tag, a device, a subsystem).

Tracking - Related events are associated with conditions but represents


occurences which involve the inteaction of an OPC Client with a target
object within the OPC Event Server.

Simple events are all events other than the above.

The PGP OPC AE Client does support only condition related events and
does not allow any filtering on the OPC Server.
The PGP system supports Level, Deviation and Rate Of Change alarm
categories for analog tags. Therefore, PGP OPC AE Client manages related
PGP structures for these alarms but uses the Bad quality flag of the tag to
notify alarm to PGP.

456

9AKK101130D1382

The PGP OPC AE Client does not support any generic alarms from an OPC
Event server not related to a PGP tag. It is required that the Tag Name
configured in the PGP database corresponds to the OPC alarm source.

OPC Server AE
The OPC AE Server implements all the mandatory interfaces related to the
1.02 OPC specifications and also the optional interface
IOPCEventAreaBrowser.
Table 193, Table 194 and Table 195 summarize.
Table 147. OPC Event Server
Interface

Implemented

IOPCEventServer

Yes

IOPCCommon

Yes

IConnectionPointContainer

Yes

Table 148. OPC Event Area Browser


Interface
IOPCEventAreaBrowser (optional)

Implemented
Yes

Table 149. OPC Event Subscript


Interface

Implemented

IOPCEventSubscriptionMgt

Yes

IConnectionPointContainer

Yes

It is losely coupled (as the PGP DA OPC) to the PGP system. All the alarms
provided by the server are received from the PGP system and forwarded to
any connected client.

9AKK101130D1382

457

OPC Client Redundancy


The OPC client is able to connect to more than one opc server on different
machines at the same time and gets data from one server only. This is how
PGP implements opc redundancy. In case of error, the client switches to
another server. Note that the opc server must be the same, that is the same
ProgID must be used for all the machines.
Such mechanism is accomplished by using both an "alias" as server' ProgID
and the key word "MULTI_CMP" as computer name (stored in the "Power
Generation Portal\deck\alias.xml" file). You must take care to use the same
alias name in both the DA and AE database fields corresponding to the opc
server ProgIDs and especially the key word "MULTI_CMP" to get the
redundancy mechanism started up. See Appendix B of this manual for more
information
According to the example above (alias "Server4"), the PGP OPC client will
connect to a DA opc server only (the AE ProgID is empty) on three different
computers (PC4, PC5 and PC6). More precisely, the client will :
1) connect to ALL the opc DA servers (the "OPC.Iconics.1" on PC4, PC5
and PC6 machines). Note that the AE server is not used (empty field); if AE
were present, the client would connect to it as well. Both DA and AE
connection/configuration must be completed successfully otherwise
connection/configuration is repeated periodically.
2) configure ALL the opc servers (addgroup, additems, AE subscription,
etc.)
3) choose the machine PC4 as data source because it is the first one in list.
The opc client selects PC4 the first time only; then, if some errors occur, it
switches to another server but no privileges or policy will be applied
anymore about what computer to select.

458

9AKK101130D1382

DA opc groups and AE subscription will be activated for the source machine
only (they will be inactive in all the other machines). In accordance with the
OPC Specification, data will be received from one server only (the "active"
one) that is no multiple read will take place.
If the client reads by exception, it periodically calls the opc "GetStatus"
method to know the server status. If some errors occur (wrong server state
or RPC errors) it will switch onto another available server, simply making its
opc group active (quick data reception and short transition time).
If the client reads in sync way, errors on the periodical "SyncRead" opc call
will get the client switched to another server. Therefore, the automatic
switchover policy during client's activity is basically based on errors on OPC
calls.
Note that the client does not "switch" among the servers actually. It is always
connected to them and it simply sets the opc groups inactive/active (in other
words, it is the data source that is different).

9AKK101130D1382

459

OPC Server Registration


The PGP OPC Server must be registered on the machine, typing the
following command:
OPCSERVER.EXE /REGSERVER
The OPC Server browser must be registered on the machine, typing the
following command:
OPCENUM.EXE /REGSERVER
Those registration are automatically performed when PGP is installed.

DCOM Security Setting


If the OPC Server to connect to resides on another machine, connection is
performed using Microsoft DCOM technology. Here is an example of one
of the most common DCOM configuration used by OPC Servers and
Clients.
On the Client Machine.
1.

Run the DCOMCNFG.EXE utility.

2.

In the Default Properties area, check the Enable Distributed COM on


this computer box, set Default Authentication Level to None and
Default Impersonation Level to Anonymous.

3.

In the Default Security set:


Default Access Permissions
empty list

460

9AKK101130D1382

Default Launch Permissions:


Administrators

Allow Launch

INTERACTIVE

Allow Launch

SYSTEM

Allow Launch

Default Configuration Permissions:

4.

Administrators

Full Control

CREATOR OWNER

Full Control

Everyone

Read

INTERACTIVE

Special Access

SYSTEM

Full Control

Exit by clicking the OK button.

On the Server Machine.


1.

Run the DCOMCNFG.EXE utility.

2.

Default Properties and Default Security Tabs can be left the same as
the ones of the client machine.

3.

Select the OPC Server from the list of the available applications.

4.

Click the Properties button: a new dialog box appears on the screen.

5.

The configuration should be set as follows


Location:
Run Application on this computer
Security:
Use Custom Access Permissions

9AKK101130D1382

461

Allow Access to Everyone:


SYSTEM

Allow Access

Use Custom Launch Permissions:


Administrators

Allow Launch

Everyone

Allow Launch

INTERACTIVE

Allow Launch

SYSTEM

Allow Launch

Use Custom Configuration Permissions:


Administrators

Full Control

CREATOR OWNER

Full Control

Everyone

Read

INTERACTIVE

Special Access

SYSTEM

Full Control

Identity:
The interactive user

462

6.

Click the Apply button.

7.

Exit by clicking on the OK button.

9AKK101130D1382

OPC Priority Mapping


OPC alarms/events priority values range from 1 to 1000, with 1 being the
lowest and 1000 being the highest. As default, such values are mapped to
PGP priorities according to the following table:

PGP

OPC

1 - 200

201 - 400

401 - 600

601 - 800

801 - 1000

Such mapping is configurable and therefore it can be changed. It is stored in


the "Power Generation Portal\deck\OpcPriority.xml" file :

9AKK101130D1382

463

Note that the opc priority values range ("OpcRange") can be represented by
using "[" or "(" parenthesis, where "[" means "value included" and "(" means
"value not included" and therefore both range "[1,300)" and "[1,299]" have
the same meaning.
Mappings can be accomplished both on a opc AE server and alarm category
basis. If the name (ProgID) of the current connected AE server is not
defined in the OpcPriority.xml file, the below default section will be used
during OPC to PGP priority translation:

464

9AKK101130D1382

The proposed mapping is the default one described in the table above. Note
that you can define different alarm categories inside this section. In this
case, not any category is defined but the "DEFAULT" one, meaning that all
received alarms/events priorities will be mapped that way regardless any
category.
If you want to define a different mapping for a specific opc AE server, you
should define that AE server inside the file. You can manually copy and
paste the section below and change it on the basis of your needs:

9AKK101130D1382

465

The "Opc.AE.1" AE ProgID in figure is a dummy ProgID provided as an


example. The OpcPriority.xml file defines sample sections that can be
updated by user. In this case, those settings will be used for that opc ae
server only and you can also see the mapping used for the "SYSTEM" alarm
category and the one used for ALL the others categories ("DEFAULT"
category).
As described above, such file is stored in the "Power Generation
Portal\deck" folder. PGP uses the "Power Generation Portal\Config\deck"
folder in order to configure custom settings without changing installed files
directly. Thus, you can copy the "OpcPriority.xml" file and paste it in the
latter folder but you must change the name to "Opc2Priority.xml".

OPC Proxy DLL


In order that the opc communication between client/server be accomplished,
it is required that the so-called "proxy" DLLs be registered on both client and
server side.

466

9AKK101130D1382

The following table lists the proxy dll names corresponding to the different
opc specifications:
Name

OPC Specification

"OPCCOMN_PS.DLL

"Definitions common to all specification

"OPCPROXY.DLL

"Data Access

"OPC_AEPS.DLL

"Alarms & Events

"OPCHDA_PS.DLL

"Historical Data Access

Such DLLs are registered automatically by PGP during installation.


Anyway, the manual registration of such files can be accomplished by using
the "RegSvr32.exe" utility

9AKK101130D1382

467

OPC Server Browser


The OPC Foundation supplies (and suggest to use) the "OpcEnum.exe" opc
server which accesses the local Component Categories Manager and
determines what types and brands of servers are available on that machine.
Such server should be installed on any machine which hosts OPC servers
and the client should connect to it in order to retrieve information about the
server to be connected.
The OPC Server Browser ("OpcEnum.exe") and the required proxy/stub
("OPCCOMN_PS.DLL" see below) can be obtained from the OPC
Foundation Web Site but they are also stored in the "PGP\bin" folder.
As any other opc server, the opcenum.exe must be registered on the
machine. The manual registration of the server can be accomplished by
running it with the following options (the example below refers to a
registration/de-registration from a command prompt):
"D:\> opcenum.exe /RegServer" to register it.
"D:\> opcenum.exe /UnregServer" to un-register it.

468

9AKK101130D1382

Appendix A Tables
Tag Types
Table 150. Tag Types.
Code
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

Tag Type
ANALOG
CLIF
DAANALG
DADIG
DADIGTL
DANG
DD
DEVSTAT
DIGITAL
INTANG
INTDIG
MSDD
N90STA
RCM
RMCB
RMSC
STATION
TEXT
TEXTSTR
UNDEF
EXTANG
EXTDIG
ANGRPT
DIGRPT
LABANG

9AKK101130D1382

Description
Analog.
Configured logic interface function (not supported).
Data acquisition analog.
Data acquisition digital.
Data acquisition digital (not supported).
Data acquisition analog.
Device driver.
Device status.
Digital.
Internal analog.
Internal digital.
Multi state device driver.
Symphony status.
Remote control memory.
Remote motor control block.
Remote manual set constant.
Station.
Text selector tag.
Text string.
Undefined tag type.
External analog.
External digital.
Symphony generated analog.
Symphony generated digital.
Analog lab data entry.

469

Table 150. Tag Types.


Code
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

470

Tag Type
LABDIG
CALCANG
CALCDIG
APMSSTA
NODESTA
BITMASK
COMPOSIT
INTEGER
UINTEGER
BYTEARR
ANAEIN
ANAEOUT
DIGEIN
DIGEOUT
DATETIME
DELTATIME
TCPADR

Description
Digital lab data entry.
Analog calculated tag.
Digital calculated tag.
Node status.
Node status.
Mask of bits.
Composite.
Integer format.
Unsigned integer format.
Byte array format.
Analog Extended input.
Analog Extended output.
Digital Extended input.
Digital Extended output.
Date and Time format.
Deltatime format.
TCP address.

9AKK101130D1382

Tag Sources
Table 151. Tag Sources.
Code
1
2
3
4
5
6
7
8
9
10
11
12
13
14

Tag Source
C-NET
EXT
CALC
LAB
USER
DEVSTA
TAGGEN
OPC
AC800F
AC800M
MELODY
AC870P
PROP13

Description
Infinet tag.
Generic external communication.
Internal calculated tag.
Lab data entry tag.
User application tag
Device status tag.
Generated tag.
OPC tag.
Reserved
AC800F tag.
AC800M tag.
MELODY tag.
AC870P tag.
PRO Control P13 tag.

Default Color Map


Table 152. Color Map.
Code
0
1
2
3
4
5
6
7
8
9

9AKK101130D1382

Color
Black
Red
Green
Yellow
Blue
Magenta
Cyan
White
Orange
Slate Blue

471

Table 152. Color Map.


Code
10
11
12
13
14
15
16
17
18
19

Color
Hot Pink
Sea Green
Spring Green
Chocolate
Lavender
Sandy Brown
Tomato
Turquoise
Deep Pink
Dark Violet

For compatibility with older PGP 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 a 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 a 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 definitiona 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

472

9AKK101130D1382

RGB(00,FF,00) - lime // Same as previous


RGB(00,CC,00) - darklime // 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
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

9AKK101130D1382

473

RGB( -1, -1, -1) - deeppink // 18


RGB( -1, -1, -1) - darkviolet // 19

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 153. Digital Tag Field Applicability.
Field
ZEROSTATE
ONESTATE
TWOSTATE
THREESTATE
FOURSTATE to

DI
*
*

RCM
*
*

DD
*
*

MSDD
*
*
*
*

SPDT
*
*
*
*

DCS
*
*

MS
*
*
*
*
*

FVTEESTATE
FB1_0STATE
FB1_1STATE
FB2_0STATE
FB2_1STATE
FB3_0STATE
FB3_1STATE
FB4_0STATE
FB4_1STATE

*
*
*
*

*
*
*
*
*
*
*
*

ICI Action Codes


Table 154. ICI Action Codes.
Index
1
2
3
4

474

Action Code
X
E
C
D

Description
Skip. ICI ignore the tag.
Establish Only.
Establish and Connect.
Define for Output.

9AKK101130D1382

ICI Point Types


Table 155. ICI Point Types.
Code
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24 to 28
29
30
31
32
33

9AKK101130D1382

Point Type
Not defined.
Process Variable.
Set-point Read.
Control Output Read.
Ratio Index Read.
Analog Read.
Station Status.
Digital Read.
Set-point Write.
Control Output Write.
Ratio Index Write.
Station Mode.
Analog Report.
Digital Report.
Module Status.
RCM Read.
RCM Write.
Single Index Station.
Station Report.
RMSC Read.
RMSC Report.
R4 Analog Read.
R4 Analog Report.
Extended Module Status.
Not Defined.
DANG.
Not Defined.
Not Defined.
DD.
MSDD.

475

Table 155. ICI Point Types.


Code
34
35 to 52
53
54
55 to 59
60

476

Point Type
SPDT.
Not Defined.
RMCB.
DDIG.
Not Defined.
Text Selector.

9AKK101130D1382

Time Units
Table 156. Time Units.
Code

Time Unit

0
1
2
3
4
5

Sec.
Min.
Hours
Days
Months
Years

Description
Seconds
Minutes
Hours
Days
Months
Years

Instrument Types
Table 157. Instrument Types.
Instrument Type
1-5 V
4-20 mA
TCK
TCJ
TCT
RTD

Description
High Level.
High Level.
Type K thermocouple.
Type J thermocouple.
Type T thermocouple.
RTD 100 ohms.

Tag Quality Bits


Tag quality bits are summarized in the two following tables. Table 158 lists
the quality bits valid for both analog and digital tags. Table 159 lists the
quality bits valid for analog tags only.
Table 158. Analog and Digital Tag Quality Bits.
Code
0
1
2

Description
Implemented
Unacknowledged
In alarm

9AKK101130D1382

477

Table 158. Analog and Digital Tag Quality Bits.


Code
3
4
5
6
7
8
9
10
11
12
13
14
15

478

Description
Old data
Off scan
Reserved
Inserted value
Alarm check disabled
Alarm inhibited
Reserved
Bad calculated value
Application specific 3
Red tagged
Hardware channel failure
Application specific 1
Application specific 2

9AKK101130D1382

Table 159. Analog (Only) Tag Quality Bits.


Code
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

Description
High instrument range
2-High alarm limit
High alarm limit
Low alarm limit
2-Low alarm limit
Low instrument range
Increasing ROC
Decreasing ROC
High deviation
Low deviation
Integer format
Tracking
3-High alarm limit
3-Low alarm limit
Auto/Manual
Dummy Packet (Playback only)

System Information
Table 160. Tag Configuration Retrieving Parameters.
Parameter
ProductName
ShortProductName
FullProductName
ProductFamily
ProductVersion
ProductCompany
ProductCorporate
Version
SubVersion
Build

9AKK101130D1382

Description
Name of the Product
Short name of the Product
Full name of the Product
Family Name of the Product
Version of the product
Company Name of the Product
Corporate Name of the Product
Release version
Release sub-version
Build Version

479

Table 160. Tag Configuration Retrieving Parameters.


Parameter
HotFix
MaximumTags
MaximumConfiguredTags
MaximumCrts
MaximumPV
MaximumDI
MaximumPlaybacks
MaximumPrinters
MaximumICI
MaximumICIIndex
MaximumCalculations
MaximumTrendGroups
MaximumTagInfoType
MaximumFileKey
MaximumTotalizationLogs
MaximumSoeEvents
MaximumMaintenanceLogs
MaximumPTLArchives
MaximumDisplays
MaximumOpConfDisplays
MaximumAlarmPriorities
MaximumAlarmGroups
MaximumFiles
MaximumTagNameLenght
MaximumTagDescrlenght
MaximumTagsetLenght
RecordsInPtlFiles
RecordsInPlaybackFiles
EntriesInPlbQueue
EntriesInPtlQueue
EntriesInPlbmemory
EntriesInCompressedPlbFiles

480

Description
Hot Fix
Number of tags
Numer of Tags Configured
Maximum number of Clients
Maximum number of PV
Maximum number of DI
Apms Parameter
Maximum number of Printers
Maximum number of ICIs
Number of ICI index
Maximum number of Calculation Blocks
Maximum Number of Historical Groups
Maximum Tag Info Type
Maximum File Key
Maximum Number of Totalizations
Maximum Events for SOE
Maximum Number of maintenance
Maximum Number of Post Trip Logs
Maximum Nuber of Displays
Maximum Nuber of Op Conf Displays
Maximum Numer of Alarm Priorities
Maximum # of alarm groups
Maximum number of Files
Maximum Lenght of Tag Name in presentations
Maximum Lenght of Tag Description in presentations
Maximum Lenght of Logic State Descr in presentations
Apms Parameter
Apms Parameter
Apms Parameter
Apms Parameter
Apms Parameter
Apms Parameter

9AKK101130D1382

Table 160. Tag Configuration Retrieving Parameters.


Parameter
HistDataRetrievalLimit
MaxTagPerGroup
MaximumAlacPrograms
MaximumPlaybackDays
MaximumIndexNo
MaximumSoeDevices
NumberOfPlaybackFiles
MaximumPtlDays
MaximumPlantUnits
LicensedClients
LicensedAPI
LicensedSpecificAPI
LicensedODBC
LicensedWeb
LicensedPrc_Infi
LicensedDisplayBuilder
LicensedDaOpcServer
LicensedAeOpcServer
LicensedHdaOpcServer
LicensedDawOpcServer
LicensedOPCTags
LicensedDDE
LicensedTags
LicensedHistTags
LicensedSimulation
LicensedCalculation
LicensedCalcSteam
LicensedCalcMacro
LicensedScanDrivers
LicensedAPI_RT
LicensedPrc_Ac800f
LicDrv_Infi

9AKK101130D1382

Description
Apms Parameter
Maximum tags per Historical Group
Number of Alarm Action Programs
Maximum Number of Days for Keeping Playback archive
Maximum Tag Index
Maximum SOE Device
Number of files reserved for Playback
Maximum Number of Days for Keeping PTL archive
Apms Parameter
Number of Clients licensed
API is Licensed
Specific API is Licensed
ODBC is Licensed
WEB is Licensed
Process Control for INFI is Licensed
Display Builder is Licensed
Licensed DA Opc Server
Licensed AE OPC Server
Licensed HDA OPC Server
Licensed DA- write OPC Server
Numer of tags licensed for OPC
DDE is Licensed
Number of Tags licensed
Number of Tags Licensed
Simulation is Licensed
Calculation is Licensed
Steam Calculation is Licensed
Macro Calculation is Licensed
Scanner Drivers are Licensed
API RunTime is Licensed
Process Control is Licensed
Driver for INFI is Licensed

481

Table 160. Tag Configuration Retrieving Parameters.


Parameter
LicDrv_Dci
LicDrv_Odbc
LicDrv_Modbus
LicDrv_OpcClient
LicDrv_Spabus
LicDrv_Iec101
LicDrv_Iec104
LicDrv_Text
LicDrv_Teleperm
LicDrv_GsmMarkV
LicDrv_Iec103
LicDrv_XX2
LicDrv_XX3
LicDrv_XX4
LicDrv_XX5
LicDrv_App
LicAppl_MaintTrigger
LicAppl_XmlToCmms
LicAppl_PPP
LicAppl_DPP
LicAppl_TSE
LicAppl_BSE
LicAppl_TPA
LicAppl_STP
LicAppl_TSEOP
LicAppl_BSEOP
LicAppl_MSFDPP
LicAppl_CPA
LicAppl_Harmony_Cfg
LicAppl_XX2
LicAppl_XX3
LicAppl_XX4

482

Description
Driver for DCI is Licensed
Driver for ODBC is Licensed
Driver for Modbus is Licensed
Driver for is Licensed
Driver for Spabus is Licensed
Driver for Iec101 is Licensed
Driver for Iec104 is Licensed
Driver for Text is Licensed
Driver for teleperm is Licensed
Driver for GsmMarkV is Licensed
Driver for Iec103 is Licensed
Driver for XX2 is Licensed
Driver for XX3 is Licensedr
Driver for XX4 is Licensed
Driver for XX5 is Licensed
Application Driver is Licensed
Maint Trigger Application is Licensed
Xml To CMMS Application is Licensed
PPP Application is Licensed
DPP Application is Licensed
TSE Application is Licensed
BSE Application is Licensed
TPA Application is Licensed
STP Application is Licensed
TSEOP Application is Licensed
BSEOP Application is Licensed
MSFDPP Application is Licensed
CPA Application is Licensed
Harmony Cfg Application is Licensed
XX2 Application is Licensed
XX3 Application is Licensed
XX 4Application is Licensed

9AKK101130D1382

Table 160. Tag Configuration Retrieving Parameters.


Parameter
LicAppl_XX5
LicAppl_PeopleFinder
LicensedPrc_Ac870p
LicensedPrc_ProP13
LicenseExpiration
ServerName
IsServer
IsSystemActive
IsRundownInProgress
IsSimulationActive
IsSimulationFrozen
ClientName
CurrentTimeIM
CurrentTimeString
CurrentExTimeX
ConvertedTime
CurrentOSTimeX
StartupTimeIM
PercentDiskUsed_A
PercentDiskUsed_B
PercentDiskUsed_C
PercentDiskUsed_D
PercentDiskUsed_E
PercentDiskUsed_F
PercentDiskUsed_G
PercentDiskUsed_H
PercentDiskUsed_I
PercentDiskUsed_J
PercentDiskUsed_K
PercentDiskUsed_L
PercentOJUsed
PercentPlaybackUsed

9AKK101130D1382

Description
XX5 Application is Licensed
People Finder is Licensed
Licensed Process Control for Ac870P
Licensed Process Control for ProP13
License expiration
Server Name
Apms Parameter
The system is active
System shutdown in progress
Simulation is Active
Simulation is Frozen
Name of Client
Current Time
Current Time (string)
Current Time
Converted Time
Current Time from OS
Time of Last Startup
Percentage of use of Disk A
Percentage of use of Disk B
Percentage of use of Disk C
Percentage of use of Disk D
Percentage of use of Disk E
Percentage of use of Disk F
Percentage of use of Disk G
Percentage of use of Disk H
Percentage of use of Disk I
Percentage of use of Disk J
Percentage of use of Disk A
Percentage of use of Disk L
Percentage of use of Operator Journal File
Percentage of use of Playback Archive

483

Table 160. Tag Configuration Retrieving Parameters.


Parameter
PercentCpuLoad
PercentMemoryUsed
PhysicalMemory
IsLowResources
LoggedUser
LoginTime
LogoffTimeout
LoggedUserRecord
LoggedUserID
LocalNode
IsSystemMaster
MasterNode
NodeWeight
IsConfigAligned
IsOjAligned
IsHistAligned
IsPlbAligned
IsPtlAligned
IsNodeAligned
IsAlignInProgress
NodeAligning
NodeStatusMask
NetWorkerLifeCycle
NodeConnected
ConnectionTime
ConnectionUpdate
AlarmPrintMask
IgnoreRio
OisTimeSynch
DstOnInfi
FlagOldAlarms
InfiTimeSynch

484

Description
Percent of CPU Load
Apms Parameter
Size of Physical Memory
Low System Resources
Name of Logged User
Time of Login
Timeout For Auto Logoff
Record Index of Logged User
ID of Logged User
Local Node
The system is master
Index of the Master Node
Node Weight
Configuration is Aligned
Operator Journal file is Aligned
Historical Files are aligned
Playback Archive is Aligned
Post Trip Log Archive is Aligned
Node is Aligned
Node Alignment in Progress
Apms Parameter
Node Status Mask
Life Cycle for Networker
Nmber of nodes connected
Connection time
Connection Update
Mask of Enabled Alarm Printers
Ignore Remote IO Alarms
Time Synch INFI as OIS
DST sent on INFI
Apms Parameter
Time Synch Infi

9AKK101130D1382

Table 160. Tag Configuration Retrieving Parameters.


Parameter
UnackAlarm
PercentSaveOJ
LadValueUpdate
QueueSOEtoDip
QueueSOEtoLog
ExceptionScreen
DisableAudibleOnAck
PlaybackCompress
MsddFeedbacksInverted
BadQualityAlarms
RemoteClients
AlarmsWithMillisec
AlarmsAckBroadcast
AlarmsSilBroadcast
Language
RedTagCommands
EnableAlarmPrintouts
IncrementControls
FastIncrementControls
DemoSystem
AlarmsPerLad
EUText
LSDText
Qf1bad
Qf2bad
TimeUnitText
TagTypeText
HistArchText
HistArchHDB
TypeInfo
TagInfoType
AlarmBitmap

9AKK101130D1382

Description
New Alarms are Uncked
Apms Parameter
Update tag value on Alarm Display
Queue Sequence of Events to Data Processor
Queue Sequence of Events to Log processor
Apms Parameter
Apms Parameter
Compress Playback
Invert Feedbacks on MSDD popup
Bad Quality marked as Alarms
Apms Parameter
Alarm Time includes Milliseconds
Broadcast Alarm Acknowledgements
Broadcast Alarm Silencing
Human Machine Language
Commands arfe enabled if Red Tag
Enable Printouts of all alarms
Rate for Control Increment
Rate for Control Fast Increment
Demo System
Maximum Alarm Messages per Display
Engineering Unit Text
Logic State Descriptor Tests
Mask of Quality Flag 1 for Bad
Mask of Quality Flag 2 for Bad
Time Unit Text
Tag Type Text
Historical Archive Text
Historical Archive DB
Type Info
Tag Info Type
Alarm Bitmap

485

Table 160. Tag Configuration Retrieving Parameters.


Parameter
WeekTimeInfo
DayLightSavingTimeInfo
SoeQueueEntries
CompositeTime
StandaloneSystem
AlacQueueEntries
FirstPlaybackFile
FirstPTLFile
NumberOfPTLFiles
FirstHistorianFile
FirstHistorianRetrievedFile
FirstHistorianGhostFile
NumberOfHistorianGhostFiles
OpstationLayout
OpstationDisplay
AlarmMimic
OdbcInterface
OdbcTagHistory
RundownNotInProgress
DipQueueEntries
OdbcQueueEntries
IciStatus
TextSelector
Tagset
AlarmComment
NationalLanguage
UserPar1
UserPar2
UserPar3
UserPar4
UserPar5
UserPar6

486

Description
Day Of the Week
Day Light Saving Time is ON
Entries in Sequence of Events Queue
TIme in Composite Format
System Standalone
Entries in Alarm Action Queue
Key for First Playback File
Key of first Post Trip Log File
Number of files reserved for PTL
Key of first Historical File
Key of first Historical Retrieved File
Key of first Historical GhostFile
Number of Historical Retrived Files
Operator Station Layout
Operator Station Display
Alarm Mimic
ODBC Interface
ODBC Tag History
Rundown Not In Progress
Entries in Data Input Processor Queueu
Entries in ODBC queue
Status of the ICI
Text Selector
Tagset
Alarm Comment
National language
User Application Parameter 1
User Application Parameter 2
User Application Parameter 3
User Application Parameter 4
User Application Parameter 5
User Application Parameter 6

9AKK101130D1382

Table 160. Tag Configuration Retrieving Parameters.


Parameter
UserPar7
UserPar8
LongTermPlayback
PlbComprHorzBand
PlbComprSlopeBand
TimeZone
IgnoreAlarmGroup0
NodesInNetwork
PopupTimeout
BlackPopups
RequestReport
DSysUseUID
NetQueEntries
PopupToBeSelected
CalculReload
SecurityGroup
SecurityLevel
SecurityPrivileges
ConnectionCnt
EnableEventPrint
AlarmsWithStdDate
ControlAcknowlegmentRequired
IncrementControlsRate
OpcQueEntries
GenDiagStatus
NetWorkerStatus
OpcClientStatus
OpcServerStatus
DipReload
OpcReload
HistReload
SmsReload

9AKK101130D1382

Description
User Application Parameter 7
User Application Parameter 8
Playback Saved for Long Term
Playback Compression Horizontal DeadBand
Playback Compression Slope Band
Time Zoner
Ignore Alarms belonging to Group Zero
Number of Nodes in Network
Timeout for Popups
Popups with Black Background
Trigger for requesting Reports
Use tag UID in Network messages
Entries in Network queue
Popu to be selected to enable commands
Trigger for Reloading Calculations
Security Group
Security Level
Security Privileges
Nodes Connection Count
Enable Pinting of Event Messages
Enable STD time format for alarms
Acknowledgement fo Control is Required
Rate for Control Increment
Entriesd in OPC queue
General Diagnostic Status
NetWorker Status
OPC Client Status
OPC Server Status
Trigger for Reloading the Data Input Processor
Trigger for Reloading OPC
Trigger for Reloading History
Trigger for Reloading People Finder

487

Table 160. Tag Configuration Retrieving Parameters.


Parameter
AudibleCode
AudibleFile
AtomSeparator
SmsEnabled
SmsActive
SmsErrors
SmsAckAll
SmsAck
BuildTagInProgress
ScannerReload
SimulationState
SimulationRate
OpstaPlantUnit
PlantUnitMatch
UserReload
OpcAERefresh
FileInfoX
FileVersion
DisableAutoNetMasterSwitch
LocalRemoteControlInhibitTagDX
V23Reload
V23Recalculate
NumMultipleOutputDrivers
FreezeDIP
PlbSwitch

488

Description
Code of Alarm Audible
File for Alarm Audible
Character for Atom Sepatation
People Finder is Enabld
People Finder Error logging is Active
People Finder Error logging is Enabled
People Finder Acknowlege All Alarms
People Finder Acknowlege Alarms
Tag Builder is in Progress
Trigger for Reloading the Scanner
Simulation State
Simulation Reate
Apms Parameter
Apms Parameter
Apms Parameter
OPC AE Refresh
File Info
File Version
Disable Auto-Switch from Master to Slave
Tag for Local-Remote Control
Trigger for Reloading V23 logic
Recalculate Voting 2 of 3
Number of Output Drivers
Data Input Process is Frozen
Playback Switch

9AKK101130D1382

Tag Configuration Retrieving Parameters


Table 161. Tag Configuration Retrieving Parameters.
Parameter
DB_TAGINDEX
DB_TAGNAME
DB_TAGDESC
DB_TAGIDX
DB_TAGTYPE
DB_TAGTYPEDESCR
DB_TAGSRC
DB_VALUE
DB_RAWVALUE
DB_NUMVALUE
DB_NUMUVALUE
DB_PERCENT_VALUE
DB_QUALITY
DB_TIMESTAMP
DB_TIMESTAMP_TEXT
DB_ISO_TIMESTAMP
DB_VALUE_QUALITY
DB_VALUE_QUALITY_RA
DB_EXTQUALITY
DB_TAGVAL
DB_TAGVALEX
DB_TSTAMP_VALUE_QUALITY
DB_TVQ_STRING
DB_CUSTTAGID
DB_AL_PRI
DB_AL_CAT
DB_ALMGROUP
DB_EUDESC
DB_EUINDEX
DB_NUMDECPL

9AKK101130D1382

Description
Index
Name
Description
Internal Tag Index
Tag Type
Tag Type Description
Tag Source
Current Value
Current Raw Value
Numeric Value
Numeric Unsigned Value
Percent Value
Current Quality
Time Stamp
Time Stamp Text
Time Stamp
Current Value and Quality
Current Value and Quality
Current Quality
Current Value and Quality
Current Value and Quality
Timestamp
Timestamp (string)
Plant Tag Name
Current Alarm Priority
Alarm Processing Categorized
Alarm Group
Engineering Unit
EU Index
Decimal Places

489

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_I4_DATA
DB_FGCOLOR
DB_BGCOLOR
DB_FGCOLORREF
DB_BGCOLORREF
DB_FGCOLORSTRING
DB_BGCOLORSTRING
DB_ALRMCMNT1
DB_ALRMCMNT2
DB_ALRMCMNT3
DB_ALRMCMNT4
DB_ALRMCMNT5
DB_ALRMCMNT6
DB_ALRMCMNT7
DB_ALRMCMNT8
DB_ALRMCMNT9
DB_ALRMCMNT10
DB_ALRMCMNT11
DB_ALRMCMNT12
DB_ALRMCMNT13
DB_PRIMDISP
DB_PRIMGROUP
DB_SEC_LEVEL
DB_SEC_GROUP
DB_AAP_NUM
DB_ACK_PROG
DB_RTN_PROG
DB_ALM_PROG
DB_EVT_PROG
DB_HI_PROG
DB_H23_PROG
DB_H_PROG

490

Description
Integer Format
Foreground Color
Background Color
Foreground Color Ref.
Background Color Ref.
Foreground Color String
Background Color String
RTN Comment
Hi Alarm Comment
Lo Alarm Comment
2-Hi Alarm Comment
2-Lo Alarm Comment
3-Hi Alarm Comment
3-Lo Alarm Comment
Hi Deviation Comment
Lo Deviation Comment
Hi ROC Alarm Comment
Lo ROC Alarm Comment
Event Comment
Channel Failure Comment
Primary Display
Primary Trend Group
Security Level
Security Group
Alarm Action Program
Activate on Ack
Activate on RTN
Activate on Alarm
Activate on Event
Activate on HI
Activate on H3-H2
Activate on H

9AKK101130D1382

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_L_PROG
DB_L23_PROG
DB_LI_PROG
DB_HR_PROG
DB_LR_PROG
DB_AL_REM
DB_TRIG_CALC
DB_ICI_NUM
DB_ICI_NDX
DB_LOOP
DB_PCU
DB_MODULE
DB_BLOCK
DB_SER_NUMBER
DB_SER_INDEX
DB_ICISTA_CD
DB_AUD_IDX
DB_OIS_ALA
DB_DS_ALARM
DB_PR_ALARM
DB_SV_ALARM
DB_AUD_ALARM
DB_AUD_RTN
DB_BOT_ALARM
DB_DS_RTN
DB_PR_RTN
DB_SV_RTN
DB_DS_STCHNG
DB_PR_STCHNG
DB_SV_STCHNG
DB_PR_OPACT
DB_SV_OPACT

9AKK101130D1382

Description
Activate on L
Activate on L3-L2
Activate on LI
Activate on PROC
Activate on NROC
Remote Alarm Processing
Triggered Calculation
ICI Number
ICI Index
Ring
Pcu
Module
Block
SER Number
SER Index
ICI Action Code
Audible Alarm Index
OIS Alarm Proc.
Display Alarms
Print Alarms
Save Alarms
Activate Audible
Audible on RTNs
Bottom of Screen
Display RTNs
Print RTNs
Save RTNs
Display Events
Print Events
Save Events
Print Actions
Save Actions

491

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_PR_INFO
DB_SV_INFO
DB_REM_ONACK
DB_INFO_ONACK
DB_NO_UNACK
DB_ALARM_MIMIC
DB_ACK_BROAD
DB_APPL_ALA
DB_EXP_ALA
DB_OPC_ALARM
DB_SMSINDEX
DB_ALMINHTAG
DB_CTRLINHTAG
DB_CONFIRM_COMMAND
DB_CTRLCMDTAG
DB_HVARALMTAG
DB_H2VARALMTG
DB_H3VARALMTG
DB_LVARALMTAG
DB_L2VARALMTG
DB_L3VARALMTG
DB_CTRLINH
DB_REMOTE_CTRLINH
DB_LOCAL_CTRLINH
DB_S_COORD
DB_S_TYPE
DB_S_TTID
DB_S_TOBO
DB_S_TTCO
DB_S_SMOD
DB_S_SCHA
DB_S_FRBO

492

Description
Print Infos
Save Infos
Remove on Ack
Info on Ack
Do not set Unack
Display Mimic when alarm
Broadcast Ack to the field
Trigger Application Event
Export Alarms to Foreign DB
Export Alarms to OPC Server
SMS index for Alarms
Alarm Inhibit Tag
Control Inhibit Tag
Need Confirm Command
Control Commad Tag
Hi Variable Alarm Tag
2-Hi Variable Alarm Tag
3-Hi Variable Alarm Tag
Lo Variable Alarm Tag
2-Lo Variable Alarm Tag
3-Lo Variable Alarm Tag
Control Inhibit
Remote Control Inhibit
Local Control Inhibit
Slave Module Coordinates
Slave Module Type
Termination Unit Type
Termination Unit Identifier
Termination Unit Coordinates
S-Slave Module
S-Slave Channel
Field Cabinet Identifier

9AKK101130D1382

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_S_MODULE
DB_S_CHANNEL
DB_OFFSCINI
DB_OFFALINI
DB_INITVAL
DB_SCA_VAL_0
DB_SCA_VL_100
DB_VIOL_CD
DB_VIOL_SCAN
DB_UT_TEXT
DB_UT_TEXT1
DB_UT_TEXT2
DB_UT_IN1
DB_UT_IN2
DB_UT_IN3
DB_UT_IN4
DB_UT_RE1
DB_UT_RE2
DB_UT_RE3
DB_UT_RE4
DB_UT_RE5
DB_UT_RE6
DB_VAL100
DB_VAL0
DB_LALARM
DB_L2ALARM
DB_L3ALARM
DB_HALARM
DB_H2ALARM
DB_H3ALARM
DB_LROC_LIMIT
DB_HROC_LIMIT

9AKK101130D1382

Description
Slave Module
Slave Channel
Off Scan Initially
Off Alarm Check Initially
Initial Value
0% Presentation Scale
100% Presentation Scale
Violation Code
Off Scan on Violation
Text (10 characters)
Text (16 characters)
Text (32 characters)
Integer 1
Integer 2
Integer 3
Integer 4
Real 1
Real 2
Real 3
Real 4
Real 5
Real 6
High Instrument Limit
Low Instrument Limit
Low Alarm Limit
2-Low Alarm Limit
3-Low Alarm Limit
High Alarm Limit
2-High Alarm Limit
3-High Alarm Limit
Increasing Rate Of Change
Decreasing Rate Of Change

493

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_H3_DELTA
DB_H2_DELTA
DB_L2_DELTA
DB_L3_DELTA
DB_SPAN
DB_H_ACTIVE
DB_H2_ACTIVE
DB_H3_ACTIVE
DB_L_ACTIVE
DB_L2_ACTIVE
DB_L3_ACTIVE
DB_HR_ACTIVE
DB_LR_ACTIVE
DB_LI_ACTIVE
DB_HI_ACTIVE
DB_ALARMDB
DB_ALARMDB_PERC
DB_EVENTTAG
DB_ISALARM0
DB_ISALARM1
DB_ISALARM2
DB_ISALARM3
DB_ISALARM4
DB_ISALARM5
DB_ISALARM6
DB_ISALARM7
DB_ISALARM8
DB_ISALARM9
DB_ISALARM10
DB_ISALARM11
DB_ISALARM12
DB_ISALARM13

494

Description
3-Hi Variable Alarm Delta
2-Hi Variable Alarm Delta
2-Lo Variable Alarm Delta
3-Lo Variable Alarm Delta
Span
H-Limit Active
H2-Limit Active
H3-Limit Active
L-Limit Active
L2-Limit Active
L3-Limit Active
HR Active
LR Active
LI Active
HI Active
Alarm Deadband
Alarm Deadband (percent)
Event Tag
State is Alarm
State is Alarm
State is Alarm
State is Alarm
State is Alarm
State is Alarm
State is Alarm
State is Alarm
State is Alarm
State is Alarm
State is Alarm
State is Alarm
State is Alarm
State is Alarm

9AKK101130D1382

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_ISALARM14
DB_ISALARM15
DB_ISALARM16
DB_ISALARM17
DB_ISALARM18
DB_ISALARM19
DB_ISALARM20
DB_ISALARM21
DB_ISALARM22
DB_ISALARM23
DB_ISALARM24
DB_ISALARM25
DB_ISALARM26
DB_ISALARM27
DB_ISALARM28
DB_ISALARM29
DB_ISALARM30
DB_ISALARM31
DB_ALARM_MASK
DB_MAX_ROC
DB_ALMACK_NET_MASK
DB_NET_NODE_SOURCE
DB_TAGVAL_NET_MASK
DB_CONFIG_NET_MASK
DB_TOTALIZER_NUM
DB_TRIP_NUM
DB_RPT_NUM
DB_TOTALIZER_1_MIN
DB_TOTALIZER_10_MIN
DB_TOTALIZER_30_MIN
DB_TOTALIZER_1_HOUR
DB_TOTALIZER_8_HOUR

9AKK101130D1382

Description
State is Alarm
State is Alarm
State is Alarm
State is Alarm
State is Alarm
State is Alarm
State is Alarm
State is Alarm
State is Alarm
State is Alarm
State is Alarm
State is Alarm
State is Alarm
State is Alarm
State is Alarm
State is Alarm
State is Alarm
State is Alarm
Alarm BitMask
Maximum Rate of Change
Dest. node mask for alarm ack
Source node mask
Dest. node mask for values
Dest. node mask for config
Totalization Log
Trip Log
Report Number
Totalizer 1 min.
Totalizer 10 min.
Totalizer 30 min.
Totalizer 1 hour
Totalizer 8 hour

495

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_TOTALIZER_1_DAY
DB_TOTALIZER_1_MONTH
DB_TOTALIZER_1_YEAR
DB_TOTALIZED_1_MIN
DB_TOTALIZED_10_MIN
DB_TOTALIZED_30_MIN
DB_TOTALIZED_1_HOUR
DB_TOTALIZED_8_HOUR
DB_TOTALIZED_1_DAY
DB_TOTALIZED_1_MONTH
DB_TOTALIZED_1_YEAR
DB_HRT_TOTSTA
DB_HRT_TOTSTO
DB_HRT_TOTTON
DB_HRT_TOTTLR
DB_HRT_TOTTOF
DB_HRT_TOTTIN
DB_HRT_TOTDWN
DB_PLB_COMPR
DB_PLB_LTKEEP
DB_PLB_RECORD
DB_REL_DB
DB_EXPFIL
DB_ZEROSTATE
DB_ONESTATE
DB_TWOSTATE
DB_THREESTATE
DB_FOURSTATE
DB_FIVESTATE
DB_SIXSTATE
DB_SEVENSTATE
DB_EIGTHSTATE

496

Description
Totalizer 1 day
Totalizer 1 month
Totalizer 1 year
Totalized 1 min.
Totalized 10 min.
Totalized 30 min.
Totalized 1 hour
Totalized 8 hour
Totalized 1 day
Totalized 1 month
Totalized 1 year.
Totalized number of start
Totalized number of stop
Totalized running time
Totalized time from last reset
Totalized stop time
Totalized BAD quality time
Totalized system shutdown time
Playback Compression
Long Term Playback Archive
Playback Archive
Export Values to Foreign DB
Export Values to File
State 0
State 1
State 2
State 3
State 4
State 5
State 6
State 7
State 8

9AKK101130D1382

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_NINESTATE
DB_TENSTATE
DB_ELEVNSTATE
DB_TWELVSTATE
DB_THTEESTATE
DB_FRTEESTATE
DB_FVTEESTATE
DB_FB1_0STATE
DB_FB1_1STATE
DB_FB2_0STATE
DB_FB2_1STATE
DB_FB3_0STATE
DB_FB3_1STATE
DB_FB4_0STATE
DB_FB4_1STATE
DB_SET_POINT
DB_CONTROL_POINT
DB_RATIO_INDEX
DB_STATION_STATUS
DB_CONSTDELTA
DB_CONTROLINCDEC
DB_FASTCONTROLINCDEC
DB_PLAYBACKDB
DB_PLAYBACKTM
DB_PVCACT
DB_INH_CHAIN
DB_CONTROL_TYPE
DB_LAST_UPDATE
DB_IS_DEFINED
DB_LAD_LEVEL
DB_LAD_HAS_SUBGROUP
DB_LAD_SUMMARY

9AKK101130D1382

Description
State 9
State 10
State 11
State 12
State 13
State 14
State 15
Feedback 1 State 0
Feedback 1 State 1
Feedback 2 State 0
Feedback 2 State 1
Feedback 3 State 0
Feedback 3 State 1
Feedback 4 State 0
Feedback 4 State 1
Set Point index
Control Point Index
Ratio Index
Station Status Index
Hourly Constancy Delta
Increment/decrement %
Fast Inc./dec. %
Playback Deadband
Playback Timer
Alarm Active Mask
Alarm Inhibition Chain
Control Type
Last Data Base Update
Tag Defined
Alarm Group Level
Alarm Group With Subgroups
Alarm Group Summary

497

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_LOCALHOST
DB_NODEWEIGHT
DB_QUALITYEX
DB_COLOR_ATTRIBUTES
DB_ALARM_COMMENT
DB_ANY_ALARM_COMMENT
DB_PLANT_UNIT
DB_PLANT_UNIT_NAME
DB_ALMACKNL
DB_OPCSRVVIS
DB_ALPRINUM
DB_TAG_GUID
DB_TAG_GUID_SZ
DB_SOE_NUM
DB_SOE_TYPE
DB_COMPRESSION_SPAN
DB_DEV_TYPE
DB_DEV_NUMBER
DB_DEV_NAME
DB_MODTYPE
DB_MODREV
DB_OTXIDX
DB_OTXENB
DB_OPERPARAM
DB_OPCPROGID
DB_OPCCMPTR
DB_OPCITEMID
DB_OPCACCPATH
DB_OPCREFRESH
DB_OPCREADTYP
DB_OPCCLIENT
DB_OPCSERVER

498

Description
Local Host
Node Weight
Current Decoded Quality
Alarm Color Attributes
Current Alarm Comment
Any Alarm Comment
Plant Unit
Plant Unit Name
Alarm ack broad. node list
OPC Server visibility
Alarm printer number
Tag global UID
Tag global UID (formatted)
Triggered SOE number
Triggered SOE type
Plb compr. span (%)
Device Type
Device Number
Device Name
Module Type
Module Rev.
Output Transfer Tag Index
Output Transfer Enabled
Operating Parameter
OPC Program ID
OPC Computer name
OPC Item ID
OPC Access path
OPC Refresh time
OPC Read type
Export to Client OPC
Export to Server OPC

9AKK101130D1382

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_OPCALARMSOURCE
DB_EXTDESC
DB_MAINT_TRIG
DB_FIELD_AD1
DB_FIELD_AD2
DB_FIELD_AD3
DB_FIELD_AD4
DB_FIELD_AD5
DB_FIELD_AD6
DB_FIELD_AD7
DB_FIELD_AD8
DB_FIELD_AD9
DB_FIELD_AD10
DB_FIELD_DRV
DB_FIELD_TX1
DB_FIELD_TX2
DB_FIELD_TX3
DB_FIELD_TX4
DB_FIELD_TX5
DB_FIELD_TX6
DB_FIELD_TX7
DB_FIELD_TX8
DB_FIELD_TX9
DB_FIELD_TX10
DB_DRV_INDEX
DB_DRV_INDEX2
DB_DRV_INDEX3
DB_DRV_INDEX4
DB_DRV_INDEX5
DB_DRV_INDEXIN
DB_DATA_PROCESSOR
DB_OUT1_AD1

9AKK101130D1382

Description
OPC Alarm Source
Extended Description
Maintenance Trigger
Field Address 1
Field Address 2
Field Address 3
Field Address 4
Field Address 5
Field Address 6
Field Address 7
Field Address 8
Field Address 9
Field Address 10
Field Driver Name
Field Drv Text 1
Field Drv Text 2
Field Drv Text 3
Field Drv Text 4
Field Drv Text 5
Field Drv Text 6
Field Drv Text 7
Field Drv Text 8
Field Drv Text 9
Field Drv Text 10
Driver Index 1
Driver Index 2
Driver Index 3
Driver Index 4
Driver Index 5
Driver Input Index
Data Processor Name
Output Address 1

499

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_OUT1_AD2
DB_OUT1_AD3
DB_OUT1_AD4
DB_OUT1_AD5
DB_OUT1_AD6
DB_OUT1_AD7
DB_OUT1_AD8
DB_OUT1_AD9
DB_OUT1_AD10
DB_OUT1_DRV
DB_OUT1_TX1
DB_OUT1_TX2
DB_OUT1_TX3
DB_OUT1_TX4
DB_OUT1_TX5
DB_OUT1_TX6
DB_OUT1_TX7
DB_OUT1_TX8
DB_OUT1_TX9
DB_OUT1_TX10
DB_OUT2_AD1
DB_OUT2_AD2
DB_OUT2_AD3
DB_OUT2_AD4
DB_OUT2_AD5
DB_OUT2_AD6
DB_OUT2_AD7
DB_OUT2_AD8
DB_OUT2_AD9
DB_OUT2_AD10
DB_OUT2_DRV
DB_OUT2_TX1

500

Description
Output Address 2
Output Address 3
Output Address 4
Output Address 5
Output Address 6
Output Address 7
Output Address 8
Output Address 9
Output Address 10
Output Driver Name
Output Drv Text 1
Output Drv 1 Text 2
Output Drv 1 Text 3
Output Drv 1 Text 4
Output Drv 1 Text 5
Output Drv 1 Text 6
Output Drv 1 Text 7
Output Drv 1 Text 8
Output Drv 1 Text 9
Output Drv 1 Text 10
Output 1 Address 1
Output 1 Address 2
Output 1 Address 3
Output 1 Address 4
Output 1 Address 5
Output 1 Address 6
Output 1 Address 7
Output 1 Address 8
Output 1 Address 9
Output 1 Address 10
Output Driver Name
Output 2 Drv Text 1

9AKK101130D1382

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_OUT2_TX2
DB_OUT2_TX3
DB_OUT2_TX4
DB_OUT2_TX5
DB_OUT2_TX6
DB_OUT2_TX7
DB_OUT2_TX8
DB_OUT2_TX9
DB_OUT2_TX10
DB_TAGGEN
DB_COMPONENT
DB_FACEPLATE
DB_FEEDBACK1
DB_FEEDBACK2
DB_FEEDBACK3
DB_FEEDBACK4
DB_AUTOMAN
DB_GOODSTATE
DB_REQSTATE
DB_REDTAG
DB_PERMISSIVE1
DB_PERMISSIVE2
DB_ASPECT1NAM
DB_ASPECT1CMD
DB_ASPECT2NAM
DB_ASPECT2CMD
DB_ASPECT3NAM
DB_ASPECT3CMD
DB_ASPECT4NAM
DB_ASPECT4CMD
DB_ASPECT5NAM
DB_ASPECT5CMD

9AKK101130D1382

Description
Output 2 Drv Text 2
Output 2 Drv Text 3
Output 2 Drv Text 4
Output 2 Drv Text 5
Output 2 Drv Text 6
Output 2 Drv Text 7
Output 2 Drv Text 8
Output 2 Drv Text 9
Output 2 Drv Text 10
Generator Tag
Component Tag
Faceplate
Feedback 1
Feedback 2
Feedback 3
Feedback 4
Auto/Manual
Good State
Requested State
Red Tag
Permissive 1
Permissive 2
Name of Aspect #1
Command for Aspect #1
Name of Aspect #2
Command for Aspect #2
Name of Aspect #3
Command for Aspect #3
Name of Aspect #4
Command for Aspect #4
Name of Aspect #5
Command for Aspect #5

501

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_NUMATOMS
DB_ATOM1NAM
DB_ATOM1VAL
DB_ATOM2NAM
DB_ATOM2VAL
DB_ATOM3NAM
DB_ATOM3VAL
DB_ATOM4NAM
DB_ATOM4VAL
DB_ATOM5NAM
DB_ATOM5VAL
DB_ATOM6NAM
DB_ATOM6VAL
DB_ATOM7NAM
DB_ATOM7VAL
DB_ATOM8NAM
DB_ATOM8VAL
DB_ATOM9NAM
DB_ATOM9VAL
DB_ATOM10NAM
DB_ATOM10VAL
DB_ATOM11NAM
DB_ATOM11VAL
DB_ATOM12NAM
DB_ATOM12VAL
DB_ATOM13NAM
DB_ATOM13VAL
DB_ATOM14NAM
DB_ATOM14VAL
DB_ATOM15NAM
DB_ATOM15VAL
DB_ATOM16NAM

502

Description
Number of Atoms
Name for Atom #1
Value for Atom #1
Name for Atom #2
Value for Atom #2
Name for Atom #3
Value for Atom #3
Name for Atom #4
Value for Atom #4
Name for Atom #5
Value for Atom #5
Name for Atom #6
Value for Atom #6
Name for Atom #7
Value for Atom #7
Name for Atom #8
Value for Atom #8
Name for Atom #9
Value for Atom #9
Name for Atom #10
Value for Atom #10
Name for Atom #11
Value for Atom #11
Name for Atom #12
Value for Atom #12
Name for Atom #13
Value for Atom #13
Name for Atom #14
Value for Atom #14
Name for Atom #15
Value for Atom #15
Name for Atom #16

9AKK101130D1382

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_ATOM16VAL
DB_ATOM17NAM
DB_ATOM17VAL
DB_ATOM18NAM
DB_ATOM18VAL
DB_ATOM19NAM
DB_ATOM19VAL
DB_ATOM20NAM
DB_ATOM20VAL
DB_ATOM21NAM
DB_ATOM21VAL
DB_ATOM22NAM
DB_ATOM22VAL
DB_ATOM23NAM
DB_ATOM23VAL
DB_ATOM24NAM
DB_ATOM24VAL
DB_ATOM25NAM
DB_ATOM25VAL
DB_ATOM26NAM
DB_ATOM26VAL
DB_ATOM27NAM
DB_ATOM27VAL
DB_ATOM28NAM
DB_ATOM28VAL
DB_ATOM29NAM
DB_ATOM29VAL
DB_ATOM30NAM
DB_ATOM30VAL
DB_ATOM31NAM
DB_ATOM31VAL
DB_ATOM32NAM

9AKK101130D1382

Description
Value for Atom #16
Name for Atom #17
Value for Atom #17
Name for Atom #18
Value for Atom #18
Name for Atom #19
Value for Atom #19
Name for Atom #20
Value for Atom #20
Name for Atom #21
Value for Atom #21
Name for Atom #22
Value for Atom #22
Name for Atom #23
Value for Atom #23
Name for Atom #24
Value for Atom #24
Name for Atom #25
Value for Atom #25
Name for Atom #26
Value for Atom #26
Name for Atom #27
Value for Atom #27
Name for Atom #28
Value for Atom #28
Name for Atom #29
Value for Atom #29
Name for Atom #30
Value for Atom #30
Name for Atom #31
Value for Atom #31
Name for Atom #32

503

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_ATOM32VAL
DB_ATOM33NAM
DB_ATOM33VAL
DB_ATOM34NAM
DB_ATOM34VAL
DB_ATOM35NAM
DB_ATOM35VAL
DB_ATOM36NAM
DB_ATOM36VAL
DB_ATOM37NAM
DB_ATOM37VAL
DB_ATOM38NAM
DB_ATOM38VAL
DB_ATOM39NAM
DB_ATOM39VAL
DB_ATOM40NAM
DB_ATOM40VAL
DB_ATOM41NAM
DB_ATOM41VAL
DB_ATOM42NAM
DB_ATOM42VAL
DB_ATOM43NAM
DB_ATOM43VAL
DB_ATOM44NAM
DB_ATOM44VAL
DB_ATOM45NAM
DB_ATOM45VAL
DB_ATOM46NAM
DB_ATOM46VAL
DB_ATOM47NAM
DB_ATOM47VAL
DB_ATOM48NAM

504

Description
Value for Atom #32
Name for Atom #33
Value for Atom #33
Name for Atom #34
Value for Atom #34
Name for Atom #35
Value for Atom #35
Name for Atom #36
Value for Atom #36
Name for Atom #37
Value for Atom #37
Name for Atom #38
Value for Atom #38
Name for Atom #39
Value for Atom #39
Name for Atom #40
Value for Atom #40
Name for Atom #41
Value for Atom #41
Name for Atom #42
Value for Atom #42
Name for Atom #43
Value for Atom #43
Name for Atom #44
Value for Atom #44
Name for Atom #45
Value for Atom #45
Name for Atom #46
Value for Atom #46
Name for Atom #47
Value for Atom #47
Name for Atom #48

9AKK101130D1382

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_ATOM48VAL
DB_ATOM49NAM
DB_ATOM49VAL
DB_ATOM50NAM
DB_ATOM50VAL
DB_ATOM51NAM
DB_ATOM51VAL
DB_ATOM52NAM
DB_ATOM52VAL
DB_ATOM53NAM
DB_ATOM53VAL
DB_ATOM54NAM
DB_ATOM54VAL
DB_ATOM55NAM
DB_ATOM55VAL
DB_ATOM56NAM
DB_ATOM56VAL
DB_ATOM57NAM
DB_ATOM57VAL
DB_ATOM58NAM
DB_ATOM58VAL
DB_ATOM59NAM
DB_ATOM59VAL
DB_ATOM60NAM
DB_ATOM60VAL
DB_ATOM61NAM
DB_ATOM61VAL
DB_ATOM62NAM
DB_ATOM62VAL
DB_ATOM63NAM
DB_ATOM63VAL
DB_ATOM64NAM

9AKK101130D1382

Description
Value for Atom #48
Name for Atom #49
Value for Atom #49
Name for Atom #50
Value for Atom #50
Name for Atom #51
Value for Atom #51
Name for Atom #52
Value for Atom #52
Name for Atom #53
Value for Atom #53
Name for Atom #54
Value for Atom #54
Name for Atom #55
Value for Atom #55
Name for Atom #56
Value for Atom #56
Name for Atom #57
Value for Atom #57
Name for Atom #58
Value for Atom #58
Name for Atom #59
Value for Atom #59
Name for Atom #60
Value for Atom #60
Name for Atom #61
Value for Atom #61
Name for Atom #62
Value for Atom #62
Name for Atom #63
Value for Atom #63
Name for Atom #64

505

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_ATOM64VAL
DB_ATOM65NAM
DB_ATOM65VAL
DB_ATOM66NAM
DB_ATOM66VAL
DB_ATOM67NAM
DB_ATOM67VAL
DB_ATOM68NAM
DB_ATOM68VAL
DB_ATOM69NAM
DB_ATOM69VAL
DB_ATOM70NAM
DB_ATOM70VAL
DB_ATOM71NAM
DB_ATOM71VAL
DB_ATOM72NAM
DB_ATOM72VAL
DB_ATOM73NAM
DB_ATOM73VAL
DB_ATOM74NAM
DB_ATOM74VAL
DB_ATOM75NAM
DB_ATOM75VAL
DB_ATOM76NAM
DB_ATOM76VAL
DB_ATOM77NAM
DB_ATOM77VAL
DB_ATOM78NAM
DB_ATOM78VAL
DB_ATOM79NAM
DB_ATOM79VAL
DB_ATOM80NAM

506

Description
Value for Atom #64
Name for Atom #65
Value for Atom #65
Name for Atom #66
Value for Atom #66
Name for Atom #67
Value for Atom #67
Name for Atom #68
Value for Atom #68
Name for Atom #69
Value for Atom #69
Name for Atom #70
Value for Atom #70
Name for Atom #71
Value for Atom #71
Name for Atom #72
Value for Atom #72
Name for Atom #73
Value for Atom #73
Name for Atom #74
Value for Atom #74
Name for Atom #75
Value for Atom #75
Name for Atom #76
Value for Atom #76
Name for Atom #77
Value for Atom #77
Name for Atom #78
Value for Atom #78
Name for Atom #79
Value for Atom #79
Name for Atom #80

9AKK101130D1382

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_ATOM80VAL
DB_ATOM81NAM
DB_ATOM81VAL
DB_ATOM82NAM
DB_ATOM82VAL
DB_ATOM83NAM
DB_ATOM83VAL
DB_ATOM84NAM
DB_ATOM84VAL
DB_ATOM85NAM
DB_ATOM85VAL
DB_ATOM86NAM
DB_ATOM86VAL
DB_ATOM87NAM
DB_ATOM87VAL
DB_ATOM88NAM
DB_ATOM88VAL
DB_ATOM89NAM
DB_ATOM89VAL
DB_ATOM90NAM
DB_ATOM90VAL
DB_ATOM91NAM
DB_ATOM91VAL
DB_ATOM92NAM
DB_ATOM92VAL
DB_ATOM93NAM
DB_ATOM93VAL
DB_ATOM94NAM
DB_ATOM94VAL
DB_ATOM95NAM
DB_ATOM95VAL
DB_ATOM96NAM

9AKK101130D1382

Description
Value for Atom #80
Name for Atom #81
Value for Atom #81
Name for Atom #82
Value for Atom #82
Name for Atom #83
Value for Atom #83
Name for Atom #84
Value for Atom #84
Name for Atom #85
Value for Atom #85
Name for Atom #86
Value for Atom #86
Name for Atom #87
Value for Atom #87
Name for Atom #88
Value for Atom #88
Name for Atom #89
Value for Atom #89
Name for Atom #90
Value for Atom #90
Name for Atom #91
Value for Atom #91
Name for Atom #92
Value for Atom #92
Name for Atom #93
Value for Atom #93
Name for Atom #94
Value for Atom #94
Name for Atom #95
Value for Atom #95
Name for Atom #96

507

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_ATOM96VAL
DB_ATOM97NAM
DB_ATOM97VAL
DB_ATOM98NAM
DB_ATOM98VAL
DB_ATOM99NAM
DB_ATOM99VAL
DB_ATOM100NAM
DB_ATOM100VAL
DB_ATOM1TYP
DB_ATOM2TYP
DB_ATOM3TYP
DB_ATOM4TYP
DB_ATOM5TYP
DB_ATOM6TYP
DB_ATOM7TYP
DB_ATOM8TYP
DB_ATOM9TYP
DB_ATOM10TYP
DB_ATOM11TYP
DB_ATOM12TYP
DB_ATOM13TYP
DB_ATOM14TYP
DB_ATOM15TYP
DB_ATOM16TYP
DB_ATOM17TYP
DB_ATOM18TYP
DB_ATOM19TYP
DB_ATOM20TYP
DB_ATOM21TYP
DB_ATOM22TYP
DB_ATOM23TYP

508

Description
Value for Atom #96
Name for Atom #97
Value for Atom #97
Name for Atom #98
Value for Atom #98
Name for Atom #99
Value for Atom #99
Name for Atom #100
Value for Atom #100
Type of Atom #1
Type of Atom #2
Type of Atom #3
Type of Atom #4
Type of Atom #5
Type of Atom #6
Type of Atom #7
Type of Atom #8
Type of Atom #9
Type of Atom #10
Type of Atom #11
Type of Atom #12
Type of Atom #13
Type of Atom #14
Type of Atom #15
Type of Atom #16
Type of Atom #17
Type of Atom #18
Type of Atom #19
Type of Atom #20
Type of Atom #21
Type of Atom #22
Type of Atom #23

9AKK101130D1382

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_ATOM24TYP
DB_ATOM25TYP
DB_ATOM26TYP
DB_ATOM27TYP
DB_ATOM28TYP
DB_ATOM29TYP
DB_ATOM30TYP
DB_ATOM31TYP
DB_ATOM32TYP
DB_ATOM33TYP
DB_ATOM34TYP
DB_ATOM35TYP
DB_ATOM36TYP
DB_ATOM37TYP
DB_ATOM38TYP
DB_ATOM39TYP
DB_ATOM40TYP
DB_ATOM41TYP
DB_ATOM42TYP
DB_ATOM43TYP
DB_ATOM44TYP
DB_ATOM45TYP
DB_ATOM46TYP
DB_ATOM47TYP
DB_ATOM48TYP
DB_ATOM49TYP
DB_ATOM50TYP
DB_ATOM51TYP
DB_ATOM52TYP
DB_ATOM53TYP
DB_ATOM54TYP
DB_ATOM55TYP

9AKK101130D1382

Description
Type of Atom #24
Type of Atom #25
Type of Atom #26
Type of Atom #27
Type of Atom #28
Type of Atom #29
Type of Atom #30
Type of Atom #31
Type of Atom #32
Type of Atom #33
Type of Atom #34
Type of Atom #35
Type of Atom #36
Type of Atom #37
Type of Atom #38
Type of Atom #39
Type of Atom #40
Type of Atom #41
Type of Atom #42
Type of Atom #43
Type of Atom #44
Type of Atom #45
Type of Atom #46
Type of Atom #47
Type of Atom #48
Type of Atom #49
Type of Atom #50
Type of Atom #51
Type of Atom #52
Type of Atom #53
Type of Atom #54
Type of Atom #55

509

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_ATOM56TYP
DB_ATOM57TYP
DB_ATOM58TYP
DB_ATOM59TYP
DB_ATOM60TYP
DB_ATOM61TYP
DB_ATOM62TYP
DB_ATOM63TYP
DB_ATOM64TYP
DB_ATOM65TYP
DB_ATOM66TYP
DB_ATOM67TYP
DB_ATOM68TYP
DB_ATOM69TYP
DB_ATOM70TYP
DB_ATOM71TYP
DB_ATOM72TYP
DB_ATOM73TYP
DB_ATOM74TYP
DB_ATOM75TYP
DB_ATOM76TYP
DB_ATOM77TYP
DB_ATOM78TYP
DB_ATOM79TYP
DB_ATOM80TYP
DB_ATOM81TYP
DB_ATOM82TYP
DB_ATOM83TYP
DB_ATOM84TYP
DB_ATOM85TYP
DB_ATOM86TYP
DB_ATOM87TYP

510

Description
Type of Atom #56
Type of Atom #57
Type of Atom #58
Type of Atom #59
Type of Atom #60
Type of Atom #61
Type of Atom #62
Type of Atom #63
Type of Atom #64
Type of Atom #65
Type of Atom #66
Type of Atom #67
Type of Atom #68
Type of Atom #69
Type of Atom #70
Type of Atom #71
Type of Atom #72
Type of Atom #73
Type of Atom #74
Type of Atom #75
Type of Atom #76
Type of Atom #77
Type of Atom #78
Type of Atom #79
Type of Atom #80
Type of Atom #81
Type of Atom #82
Type of Atom #83
Type of Atom #84
Type of Atom #85
Type of Atom #86
Type of Atom #87

9AKK101130D1382

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_ATOM88TYP
DB_ATOM89TYP
DB_ATOM90TYP
DB_ATOM91TYP
DB_ATOM92TYP
DB_ATOM93TYP
DB_ATOM94TYP
DB_ATOM95TYP
DB_ATOM96TYP
DB_ATOM97TYP
DB_ATOM98TYP
DB_ATOM99TYP
DB_ATOM100TYP
DB_ATOM1DESC
DB_ATOM2DESC
DB_ATOM3DESC
DB_ATOM4DESC
DB_ATOM5DESC
DB_ATOM6DESC
DB_ATOM7DESC
DB_ATOM8DESC
DB_ATOM9DESC
DB_ATOM10DESC
DB_ATOM11DESC
DB_ATOM12DESC
DB_ATOM13DESC
DB_ATOM14DESC
DB_ATOM15DESC
DB_ATOM16DESC
DB_ATOM17DESC
DB_ATOM18DESC
DB_ATOM19DESC

9AKK101130D1382

Description
Type of Atom #88
Type of Atom #89
Type of Atom #90
Type of Atom #91
Type of Atom #92
Type of Atom #93
Type of Atom #94
Type of Atom #95
Type of Atom #96
Type of Atom #97
Type of Atom #98
Type of Atom #99
Type of Atom #100
Description for Atom #1
Description for Atom #2
Description for Atom #3
Description for Atom #4
Description for Atom #5
Description for Atom #6
Description for Atom #7
Description for Atom #8
Description for Atom #9
Description for Atom #10
Description for Atom #11
Description for Atom #12
Description for Atom #13
Description for Atom #14
Description for Atom #15
Description for Atom #16
Description for Atom #17
Description for Atom #18
Description for Atom #19

511

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_ATOM20DESC
DB_ATOM21DESC
DB_ATOM22DESC
DB_ATOM23DESC
DB_ATOM24DESC
DB_ATOM25DESC
DB_ATOM26DESC
DB_ATOM27DESC
DB_ATOM28DESC
DB_ATOM29DESC
DB_ATOM30DESC
DB_ATOM31DESC
DB_ATOM32DESC
DB_ATOM33DESC
DB_ATOM34DESC
DB_ATOM35DESC
DB_ATOM36DESC
DB_ATOM37DESC
DB_ATOM38DESC
DB_ATOM39DESC
DB_ATOM40DESC
DB_ATOM41DESC
DB_ATOM42DESC
DB_ATOM33DESC
DB_ATOM44DESC
DB_ATOM45DESC
DB_ATOM46DESC
DB_ATOM47DESC
DB_ATOM48DESC
DB_ATOM49DESC
DB_ATOM50DESC
DB_ATOM51DESC

512

Description
Description for Atom #20
Description for Atom #21
Description for Atom #22
Description for Atom #23
Description for Atom #24
Description for Atom #25
Description for Atom #26
Description for Atom #27
Description for Atom #28
Description for Atom #29
Description for Atom #30
Description for Atom #31
Description for Atom #32
Description for Atom #33
Description for Atom #34
Description for Atom #35
Description for Atom #36
Description for Atom #37
Description for Atom #38
Description for Atom #39
Description for Atom #40
Description for Atom #41
Description for Atom #42
Description for Atom #43
Description for Atom #44
Description for Atom #45
Description for Atom #46
Description for Atom #47
Description for Atom #48
Description for Atom #49
Description for Atom #50
Description for Atom #51

9AKK101130D1382

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_ATOM52DESC
DB_ATOM53DESC
DB_ATOM54DESC
DB_ATOM55DESC
DB_ATOM56DESC
DB_ATOM57DESC
DB_ATOM58DESC
DB_ATOM59DESC
DB_ATOM60DESC
DB_ATOM31DESC
DB_ATOM62DESC
DB_ATOM63DESC
DB_ATOM64DESC
DB_ATOM65DESC
DB_ATOM66DESC
DB_ATOM67DESC
DB_ATOM68DESC
DB_ATOM69DESC
DB_ATOM70DESC
DB_ATOM71DESC
DB_ATOM72DESC
DB_ATOM73DESC
DB_ATOM74DESC
DB_ATOM75DESC
DB_ATOM76DESC
DB_ATOM77DESC
DB_ATOM78DESC
DB_ATOM79DESC
DB_ATOM80DESC
DB_ATOM81DESC
DB_ATOM82DESC
DB_ATOM83DESC

9AKK101130D1382

Description
Description for Atom #52
Description for Atom #53
Description for Atom #54
Description for Atom #55
Description for Atom #56
Description for Atom #57
Description for Atom #58
Description for Atom #59
Description for Atom #60
Description for Atom #61
Description for Atom #62
Description for Atom #63
Description for Atom #64
Description for Atom #65
Description for Atom #66
Description for Atom #67
Description for Atom #68
Description for Atom #69
Description for Atom #70
Description for Atom #71
Description for Atom #72
Description for Atom #73
Description for Atom #74
Description for Atom #75
Description for Atom #76
Description for Atom #77
Description for Atom #78
Description for Atom #79
Description for Atom #80
Description for Atom #81
Description for Atom #82
Description for Atom #83

513

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_ATOM84DESC
DB_ATOM85DESC
DB_ATOM86DESC
DB_ATOM87DESC
DB_ATOM88DESC
DB_ATOM89DESC
DB_ATOM90DESC
DB_ATOM91DESC
DB_ATOM92DESC
DB_ATOM93DESC
DB_ATOM94DESC
DB_ATOM95DESC
DB_ATOM96DESC
DB_ATOM97DESC
DB_ATOM98DESC
DB_ATOM99DESC
DB_ATOM100DESC
DB_APP2
DB_APP1
DB_HCFV
DB_RTAG
DB_APP3
DB_BAD
DB_B9
DB_ALIA
DB_ALIN
DB_INSV
DB_EVT
DB_OFSC
DB_OLDD
DB_ALRM
DB_UNAK

514

Description
Description for Atom #84
Description for Atom #85
Description for Atom #86
Description for Atom #87
Description for Atom #88
Description for Atom #89
Description for Atom #90
Description for Atom #91
Description for Atom #92
Description for Atom #93
Description for Atom #94
Description for Atom #95
Description for Atom #96
Description for Atom #97
Description for Atom #98
Description for Atom #99
Description for Atom #100
Quality Status: APP2
Quality Status: APP1
Quality Status: HCFV
Quality Status: RTAG
Quality Status: APP3
Quality Status: BAD
Quality Status: B9
Quality Status: ALIA
Quality Status: ALIN
Quality Status: INSV
Quality Status: EVT
Quality Status: OFSC
Quality Status: OLDD
Quality Status: ALRM
Quality Status: UNAK

9AKK101130D1382

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_IMP
DB_DUMM
DB_AM
DB_SLAV
DB_SHAV
DB_TRAK
DB_I4
DB_LDEV
DB_HDEV
DB_DROC
DB_IROC
DB_LIRV
DB_LLAV
DB_LAV
DB_HAV
DB_HHAV
DB_HIRV
DB_CONVCODE
DB_CONVCODESTR
DB_CONVMIN
DB_CONVMAX
DB_CONVOFFS
DB_ALRMCTXT1
DB_ALRMCTXT2
DB_ALRMCTXT3
DB_ALRMCTXT4
DB_ALRMCTXT5
DB_ALRMCTXT6
DB_ALRMCTXT7
DB_ALRMCTXT8
DB_ALRMCTXT9
DB_ALRMCTXT10

9AKK101130D1382

Description
Quality Status: IMP
Quality Status: DUMM
Quality Status: AM
Quality Status: SLAV
Quality Status: SHAV
Quality Status: TRAK
Quality Status: I4
Quality Status: LDEV
Quality Status: HDEV
Quality Status: DROC
Quality Status: IROC
Quality Status: LIRV
Quality Status: LLAV
Quality Status: LAV
Quality Status: HAV
Quality Status: HHAV
Quality Status: HIRV
Conversion Code
Conversion Code String
Conversion Min
Conversion Max
Conversion Offset
RTN Alarm Comment
High Alarm Comment
Low Alarm Comment
2-high Alarm Comment
2-low Alarm Comment
3-high Alarm Comment
3-low Alarm Comment
H dev Alarm Comment
L dev Alarm Comment
H roc Alarm Comment

515

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_ALRMCTXT11
DB_ALRMCTXT12
DB_ALRMCTXT13
DB_ALPRI_DEF
DB_ALPRI_RTN
DB_ALPRI_H
DB_ALPRI_L
DB_ALPRI_2H
DB_ALPRI_2L
DB_ALPRI_3H
DB_ALPRI_3L
DB_ALPRI_HDEV
DB_ALPRI_LDEV
DB_ALPRI_HROC
DB_ALPRI_LROC
DB_ALPRI_STCH
DB_ALPRI_HCF
DB_SNAP_ALIGN
DB_CNF_ALIGN
DB_OJ_ALIGN
DB_PLB_ALIGN
DB_HIST_ALIGN
DB_GRP_TYPE_ARCH
DB_GRP_TIMESPAN
DB_GRP_HIST_TYPE
DB_GRP_ARCHFREQ
DB_GRP_ARCHOFFSET
DB_GRP_SAMPFREQ
DB_GRP_DISPFREQ
DB_GRP_ISDERIVED
DB_GRP_INPGROUP
DB_GRP_NUMTAGS

516

Description
L roc Alarm Comment
Status Chg Alarm Comment
HCF Alarm Comment
Default Alarm Priority
Alarm Priority: RTN
Alarm Priority: H
Alarm Priority: L
Alarm Priority: 2H
Alarm Priority: 2L
Alarm Priority: 3H
Alarm Priority: 3L
Alarm Priority: HDEV
Alarm Priority: LDEV
Alarm Priority: HROC
Alarm Priority: LROC
Alarm Priority: STCH
Alarm Priority: BAD
Node mask for snap align.
Node mask for cnf align
Node mask for OJ align
Node mask for plb align
Node mask for hist align
Archive Type
Time Span
Archive Hist. Type
Archive Frequency
Archive Offset
Sample Frequency
Display Frequency
Derived Group
Input Group
# of Tags

9AKK101130D1382

Table 161. Tag Configuration Retrieving Parameters.


Parameter
DB_GRP_TOTSAMP
DB_GRP_PRE_TRIP
DB_GRP_POST_TRIP
DB_GRP_ARCH_END_TIME
DB_GRP_ARCH_START_TIME
DB_GRP_CLASS
DB_GRP_CLOSE_TRIP
DB_GRP_CURVE_TYPE
DB_GRP_INITMODE
DB_GRP_FRAMECOL
DB_GRP_BORDERCOL
DB_GRP_GRIDCOL
DB_GRP_TEXTCOL
DB_GRP_DRAWMODE
DB_GRP_LISTMODE
DB_GRP_LISTMODE
DB_GRP_XLSFILE
DB_GRP_VIEWER
DB_USR_PASSWEXPIRED
DB_USR_PASSWAGING
DB_USR_LANGUAGE
DB_USR_LOGINDISPLAY
DB_USR_LOGINPROG
DB_USR_LOGOUTDISPLAY
DB_USR_LOGOUTPROG
DB_USR_CODE
DB_USR_PASSWCHANGED
DB_USR_ACTIVE
DB_USR_CRTMASK
DB_RESERVED_BY_USER
DB_IS_LOCAL_SOURCE
DB_ROWCOUNT

9AKK101130D1382

Description
# of Archive Samples
Pre-trip Time
Post-trip Time
Archive End Time
Archive Start Time
Group Class
Close trip on return
Curve Type
Initial Presentation Mode
Trend Frame Color
Trend Border Color
Trend Grid Color
Trend Text Color
Trend Draw Mode
Trend List Mode
Trend List Mode
Report file name
Group viewer program
User Password Expired
User Password Aging
User Language
User Login Display
User Login Program
User Logout Display
User Logout Program
User Payroll Code
User Password Changed
User Active
Mask of user allowed CRT
Reserved for Command by User
This node is Local source for the tag
Row Count for Alarm retrieval

517

Gas Index Table and Gas Molecular Weight


Table 162. Gas Index Table - Gas Molecular Weight.
Index
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

Gas
Hydrogen
Carbon monoxide
Methane
Acetylene (Ethyne)
Ethylene
Ethane
Propane
N-Butane
Iso-Butane
N-Pentane
Neohexane
Hydrogen sulfide
Carbon dioxide
Oxygen
Water
Sulfur dioxide
Nitrogen
Argon
Air

Chemical Formula
H2
CO
CH4
C2H2
C2H4
C2H6
C3H8
C4H10-N
C4H10-I
C5H12-N
C6H14
H2S
CO2
O2
H2O
SO2
N2
Ar
Air

Molecular Weight
2.016
28.010
16.043
26.038
28.054
30.070
44.097
58.124
58.124
72.151
86.178
34.080
44.010
31.999
18.015
64.063
28.016
39.948
28.959

Item Types for Field Assignment


Table 163. Item Types for Field Assignment.
Symbol
HNMPV
HNMDI
HNMMSD
HNMCAL
HNMGRP

518

Code
1
2
3
4
5

Description
Analog tag.
Digital tag.
Multi State Device Driver.
Calculation.
Trend group.

9AKK101130D1382

Table 163. Item Types for Field Assignment.


Symbol
HNMRGP
HNMNOD
HNMDVC
HNMLSD
HNMEU
HNMALC
HNMTXS
HNMLAD
HNMALM
HNMOPC
HNMDIS
HNMREP
HNMAUD
HNMUSR
HNMMEN
HNMAPP

9AKK101130D1382

Code
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
29

Description
Retrieved trend group.
Node (network server).
Device.
Logic state descriptor.
Engineering unit.
Alarm comment.
Text selector.
Alarm summary group.
Generic alarm.
Pegboard.
Display.
Report.
Audible alarm.
Security (user and authorization).
Menu and tool-bar.
Application specific item.

519

Word Offset Prefixes


Table 164. Word Offset Prefixes.
Prefix
LA_
LC_
LG_
LH_
LM_
LN_
LO_
LP_
LR_
LT_
LX_

Database
Audible tones database and alarm grouping database.
Calculation database.
Tag related databases (Engineering Units, Logic State Descriptors, Alarm
Comments, Text Selectors).
Trend group database.
Menu and tool-bar database.
Node database.
Security database.
Pegboard database.
Report database.
Tag database.
Export to foreign database.

Field Types
Table 165. Field Types.
Type
DT_CHAR
DT_VARCHAR
DT_LONGVARCHAR
DT_BIT
DT_TINYINT
DT_SMALLINT
DT_INTEGER
DT_BIGINT
DT_DECIMAL
DT_NUMERIC
DT_REAL
DT_DOUBLE

520

Code
1
2
3
4
5
6
7
8
9
10
11
12

9AKK101130D1382

Table 165. Field Types.


Type
DT_FLOAT
DT_DATE
DT_TIME
DT_TIMESTAMP
DT_BINARY
DT_VARBINARY
DT_LONGVBINARY

9AKK101130D1382

Code
13
14
15
16
17
18
19

521

Alarm Types
Table 166. Alarm Types.
Code
1
2
3
4
5
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
40
41
42
43
44

522

Symbol
ALEINF
ALERTN
ALEOPE
ALEACK
ALEEVT
ALEDIA
ALEHIR
ALELIR
ALESHA
ALESLA
ALEHHA
ALELLA
ALEHAL
ALELAL
ALERCP
ALERCN
ALEHDV
ALELDV
ALEHCF
ALEALA
ALEVOT
ALEMUL
ALERTM
ALEOPR
ALELST

Description
Information event.
Return to normal.
Operator action.
Alarm acknowledge event.
Digital status event.
Digital alarm.
High instrument alarm.
Low instrument alarm.
3-high alarm.
3-low alarm.
2-high alarm.
2-low alarm.
High alarm.
Low alarm.
Increasing rate of change alarm
Decreasing rate of change alarm
High deviation alarm.
Low deviation alarm.
Hardware channel failure.
Generic alarm.
Voting alarm (reserved).

9AKK101130D1382

Dynamic Symbol Table


Table 167. Dynamic Symbol Table.
Code
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

Symbol
A_NAME
A_DESC
A_INDX
A_CUST
A_GROU
A_PRIO
A_EU
A_CMNT
A_ITMT
A_ITMN
A_VAL
A_VALQ
A_STAT
A_STAQ
A_TIME
A_DATE
A_DATI
A_HTIM
A_HDAT
A_HDTI
A_OPER
A_CANC
A_ASCI
A_REAL
A_LONG
A_INTE
A_HEXL
A_HEXA
A_YENO
A_TUTS

9AKK101130D1382

Description
Tag name
Tag description
Tag index
Customer tag id (plant tag name)
Alarm group
Alarm priority
EU descriptor
Alarm comment (buffer, 2W value + 2W quality)
Item type
Item number
Value (buffer, 2W value + 2W quality)
Value and quality (buffer, 2W value + 2W quality)
Status (buffer, 2W value + 2W quality)
Status and quality (buffer, 2W value + 2W quality)
Time
Date
Date and Time
Historical time (buffer, 2W)
Historical date (buffer, 2W)
Historical date and time (buffer, 2W)
Operator name (buffer, 1W)
Cancode parameter (buffer, n/3 W)
Ascii parameter (buffer, n/2 W)
Real parameter (buffer, 2W)
Long integer parameter (buffer, 2W)
Short integer parameter (buffer, 1W)
Long integer (hex) parameter (buffer, 2W)
Short integer (hex) parameter (buffer, 1W)
Yes (1) / Not (0) (buffer, 1W)
Timer units (buffer, 1W)

523

Table 167. Dynamic Symbol Table.


Code
31
32
33
34
35
36
37
38
39
40
41
42
43
44

524

Symbol
A_NREF
A_EDSC
A_NODE
A_QUAL
A_PROD
A_SKVL
A_BKVL
A_DBXF
A_UTX1
A_UTX2
A_UTX3
A_UTX4
A_UTX5
A_CHAR

Description
Item number referenced (buffer, 4W)
Extended description
Local node name
Tag quality
Product name
Skip value
Backward Skip value
Data Base Reference
Text from OPC AE (1)
Text from OPC AE (2)
Text from OPC AE (3)
Text from OPC AE (4)
Text from OPC AE (5)
Plain ASCII text (non UNICODE Compliant)

9AKK101130D1382

Data Processor file


Following an example of a DataProcessor.XML file to define a specific macro with
atoms and a table to describe 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>

9AKK101130D1382

525

Table 168. DataProcessor file - XML structure.


Element

Item

MACRO
name
separator
mainatom
type
ATOM
name
descr
type

526

Description
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 example
AC450.Block.XmlFileName.CFG)
Character separator of the OPC items
Used to identify the name of the atom that will be used by
PGP as main
Tagtype used in the PGP database. Accepted values:
DIGITAL, ANALOG, INTEGER
Identifies the section to specify the name and the
attributes of the atoms in the macro
Atom name
Atom description
Canonical OPC item type (like distribuited by OPC
server) Accepted values: BOOL, INTEGER, DINT, REAL,
STRn (where n is the number of characters in the string)

9AKK101130D1382

Appendix B AC800F Support


Overview
Traditionally, in order to connect the AC800F to third-party operator
interface systems, a PLC File (.plc extension) is exported from AC800F
configuration tools and converted by the third-party system.
The PLC file can be considered as a partial representation of the AC800F
configuration. Parsing of such file makes it possible to access the PLC
objects implemented by the AC800F software configuration tools.
Notice that formerly the AC800F was named Freelance; reference to the
former name is found in the PGP interface
The PGP PLC File Builder is able to parse the AC800F generated PLC file
and to automatically configure the PGP internal database by building a
temporary PGP database (.dbf extension) containing some of the AC800Fs
PLC objects (Function Blocks and Variables only).
The data communication between the PGP and AC800F is implemented
using the OPC (Ole for Process Control) industry standard.
During PLC File parsing, the PLC File Builder selects and builds ONLY
the above described PLC objects exported by AC800F via OPC.
OPC is a standard mechanism based on Microsoft OLE/COM technology
providing data from a data source and communicating the data to any
client application in a standard way.

Functionalities
The PLC File Builder is an application (the process name is
PlcFileBuilder.exe located in the PGP\Bin folder) that operates using the
following three main steps:

9AKK101130D1382

527

PARSING.
It parses the specified PLC File first, listing all the OPC gateway stations
found (See the AC800F manuals for information about gateway station
definition).
CREATE DB.
After parsing, a temporary database is created that corresponds to the
selected OPC gateway.

Selected, or checked OPC gateways are discussed in the following


sections.

The database name is created from the gateway name with the suffix
_tmp.

For example, if the gateway name is OPC1, then the database name
will be OPC1_tmp.dbf.

BUILDING.
After database creation, the database is imported in to the PGP system.
There is no need to close the database before importing.
The PGP PLC File Builder temporarily stores some needed information in an
XML format. It also uses some additional information permanantly stored in
the same format.
The PLC File Builder creates (and optionally removes) the temporary
database (.dbf extension) file and locates it in the usual PGP\Config\Tag
folder.
Be sure that a your own database file named <Gateway name>_tmp.dbf
does not already exist in the folder. If it does, then the PLC File Builder
will overwrite the existing file without checking. Any previously stored
information will be lost.
If a large amount of information is retrieved during parsing, the Builder can
store the information in more than one XML file. This reduces the size of

528

9AKK101130D1382

each XML file, which can improve performance during the processing of
these files. This feature is only available for one checked OPC gateway.

Selected, or checked OPC gateways are discussed in the following


sections.

The Builder stores and uses some informations stored in the following XML
format files:

Plc File parsing results xml file/s

FreelanceTemplate.xml

DBHeader.xml

Correspondences.xml

Plc File parsing results xml file/s (Temporary File)


This file contains the PLC File Parsing result. That is, all the OPC resources
found in the PLC file during parsing. The PLC File Builder uses such file to
find the OPC gateways and all the related objects.
In order to improve the performances during access/management of these
files, the Builder stores the informations retrieved fron the PLC parsing on
more than one xml file. This is done for one checked OPC gateway only
(see later for explanations). These files are enumerated and called on the
basis of the selected gateway. For example, if the OPC1 gateway is
checked and the Builder needs to create three xml files for storing
informations, the PLC Parsing results can be checked in the following files:
PLCFile_OPC1_1.xml
PLCFile_OPC1_2.xml
PLCFile_OPC1_3.xml
These files are located in the folder designated as location for temporary
files (the complete path is listed in the Messages window at the bottom of
the Builder display). It is removed when the application is closed.
Before closing the application (i.e. before the file is destroyed), the XML file
can be explored to check PLC parsing result using any XML editor.

9AKK101130D1382

529

FreelanceTemplate.xml (Temporary File)


PGP needs some mandatory information and parameters to later get the
OPC data from the AC800F OPC server (e.g. the tag name, the OPC server
name, the computer name and so on) and some further specific information
and parameters retrieved from the PLC file and concerning the PLCs
objects (e.g. the tag description).
As an example, PGP identifies a tag by a tag name, a database field named
TAGNAME retains this information. The value to be assigned to this field will
be retrieved from the PLC file. Each tag is defined within the
FreelanceTemplate file by all required PGP database fields names and the
corresponding values retrieved from the PLC file. The Builder uses such file
to fill in a temporary PGP database file (Freelance_tmp.dbf is the default
name) containing all the Freelance OPC objects.
This file is stored in the directory designated as location for temporary files
(the complete path is listed in the Messages window at the bottom of the
Builder display). It is removed when the application is closed.
Before closing the application (i.e. before the file is destroyed), the XML file
can be explored to check PLC parsing result using any XML editor.

DBHeader.xml (Persistent File)


This file contains the list of all the names of the PGP database fields
matching the AC800F function block and variables parameters.
This list can be thought as a single empty sample tag or a skeleton of the
PGP tag corresponding to the AC800F one.
The above described temporary FreelanceTemplate.xml file is composed by
a lot of such sample tags, as many as the OPC objects found during
parsing, each one filled in with a specific value.
This persistent file is stored in the PGP\Deck folder (the complete path is
listed in the Messages window at the bottom of the Builder display).
Any XML editor can be used to explore the file.

530

9AKK101130D1382

Correspondences.xml (Persistent File)


This file contains all the correspondences between the specific PGP field
name and the specific AC800F parameter. As an example, the AC800F tag
name IDF_1 is contained in the MSRNAME parameter of a AC800F
Function Block and it is assigned to the TAGNAME field of the PGP
database.
Hence, this file stores the link or correspondence between MSRNAME and
TAGNAME. In this way, the Builder is able to get the value (e.g. IDF_1 or
M_ANA) of the MSRNAME parameter and associate it to the TAGNAME
field of the previously described sample tag in order to finally compile the
temporary FreelanceTemplate.xml file.
This persistent file is stored in the PGP\Deck folder (the complete path is
listed in the Messages window at the bottom of the Builder display).
Any XML editor can be used to explore the file.

9AKK101130D1382

531

Starting-up the PLC File Builder


Running the application an interface window is opened as shown below.

Figure 45. PLC File Browsing Window.


At this time, all buttons are disabled except the OK and Open PLC File ones.

532

9AKK101130D1382

Open a PLC File


Clicking on the Open PLC File button a typical browsing window for
selecting the PLC file is opened as shown in Figure 46.
After the PLC file has been selected and opened, the PLC File Builder
immediately starts parsing the file.
In the AC800F OPC Gateways window, all the OPC gateways found are
listed (see Figure 47).

Figure 46. Open PLC File Builder

9AKK101130D1382

533

Figure 47. Create the PLC File


The PLC File Builder allows you to select multiple OPC gateways. Note
however, that in this case multiple temporary database files will be
created. The same information may be present in multiple files. You must
be careful when managing and building these files.
Since the PGP typically runs on the same machine as the OPC gateway, the
PLC File Builder automatically checks the gateway corresponding to the
local machine.

534

9AKK101130D1382

In this example, two opc gateways have been defined in the opened plc file
and, for some reason, the IP addresses have not been resolved
successfully with the corresponding host names.

9AKK101130D1382

535

As described previously, the PlcFileBuilder create as many databases as


the number of the OPC gateways defined in the .plc file. By double-clicking
on the listed gateway, the window below will appear:

You are allowed to:


1 set a computer name instead of the unresolved IP address or change the
address itself.
2 specify the initial tag index of the related temporary PGP database.

536

9AKK101130D1382

3 select areas you want to be excluded. In this way all the CBF tags
referring to those areas will not be imported in the database. These settings
work as a filter option during plc file browsing. As an example, we have

inserted "Computer1", "1000" and checked some areas for gateway

9AKK101130D1382

537

"OPC1". We have repeated similar settings for gateway "OPC2" and


created the databases:

Note:
1.you are able to set a computer name (and the "Alias.xml" file will be
updated accordingly) and such name will be retrieved later by the opc client
and used for connection to server.
2.you can set the initial tag index for each gateway but the PlcFileBuilder
does not make any check or notification about common indexes among
different temporary databases. In the example above, let's suppose 1500
tags be defined for both the gateways. If the initial tag index has been set to
1000 and to 2000 for gateways "OPC1" and "OPC2" respectively, the
indexes range in "OPC1_tmp.dbf" will be [1000,2500] and in
"OPC2_tmp.dbf" will be [2000,3500]. This means that indexes from 2000 to
2500 will result common to both databases and you must take care yourself

538

9AKK101130D1382

about the appropriate initial index value to set in order to avoid having
common indexes.
3.The "Tagindex" column is included in the temporary database. If you don't
set any initial index, all indexes will be set to "0" the first time (CBF tags not
imported yet in PGP). After importing, the index value will be retrieved
directly from PGP (for all the tags already imported in PGP).

9AKK101130D1382

539

Build a PLC File


If an OPC gateway is checked, the following actions can be initiated
CREATE.
The temporary PGP database file containing the AC800F OPC objects is
created in the default PGP folder (PGP\Config\tag).
BUILD.
The temporary PGP database is processed. That means that all data
configured and associated to the OPC gateway will be automatically
configured on the PGP without having to close it.
The build operation doesnt initialize the PGP database, therefore any
other tags previously configured in the PGP (tags referring to other NonAC800F systems) will not be deleted or changed.
UNBUILD.
Optionally, the whole PGP database may be automatically exported by
checking the correspondent flag. That means, all tags configured in the PGP
database (not only tags referring to AC800F) will be exported in a single
DBF file (located in the usual \PGP\Config\Tag folder of PGP).
Such a DBF file is automatically named on the basis of the current date and
time. For example
TAGS_19_06_2001_12_09.dbf
concerns an UnBuild operation occurred on June 19th, 2001 at 12 hours
and 9 minutes.
UNDO.
It reverts the operations just done. That means, all the resources created by
the Builder will be removed (temporary DBF and XML files) and all Builder
windows will be cleared (windows of messages and gateways).

540

9AKK101130D1382

The Builder will go back to the initial condition, as if it were started the first
time, ready to open another PLC file.
Click the Build button to display the Builder interface window as shown
below.

Figure 48. PGP DataBase Build


The Builder, as previously described, builds a temporary database
containing all the OPC tags associated to the selected OPC gateway. This is
done to preserve all the tags already configured within the PGP internal
database.

9AKK101130D1382

541

Then, after building, the Builder scans the PGP internal database and
checks if each AC800F tag in the PGP database is going to be re-built.
If a AC800F tag in the PGP database is not managed by the PLC File
Builder, such a tag is considered unused. That means, it is no longer in the
AC800F Configuration Project, but it is still configured in the PGP database.
Such a tag can manually be removed from the PGP database. It is NOT
automatically removed.
In order to find out the "Unused Tags", in the PGP database, the
PlcFileBuilder application "marks" optionally these tags by adding a "?"
character at the end of the string stored in the "User3" PGP database field.
This is done after the optional UnBuild operation and therefore the updated
field doesn't appear in the current exported database
(TAGS_19_06_2001_12_09.dbf in the above example).
The Builder displays all such unused tags in the Messages window at
runtime. See the Messages window and Log File sections for further
explanations about.

542

9AKK101130D1382

You can keep the temporary database files by clearing the Remove
Temporary databases option.

Figure 49.
The Remove Temporary databases option is selected by default. With this
option any older temporary files will be overwritten by new files.
Eventually, the PGP Tag Description database field can be optionally
updated by the PlcFileBuilder, by using the correspondent AC800F tag
description (this is done by checking the optional checkbox). Otherwise, the
original PGP tag description will result unchanged.

9AKK101130D1382

543

Messages window
All the messages are trace/debug messages and/or error messages. Among
the other, the following messages could be found.
Tag IDF_1 successfully managed (# tags managed: 170)
This message is displayed for each AC800F Tag (or Variable) successfully
managed by the PLC File Builder during the creation of the
FreelanceTemplate.xml file. Such tag will be later included in the temporary
database and then imported within the PGP database. In the message
example, related to the tag IDF_1, a total of 170 tags have been
successfully managed.
*** Error: Tag "C_ANA" NOT MANAGED ! (# 4)
This message is displayed for each AC800F Tag (or Variable) NOT
successfully managed by the PLC File Builder during the creation of the
FreelanceTemplate.xml file. Such tag will NOT be later included in the
temporary database and, consequently, it will NOT be imported within the
PGP database. In the message example, related to the tag C_ANA, a total
of 4 tags have been discharged.
Variable PStx.ProjectName: type STRING[16] not imported
This message is displayed only for AC800F variable types that PGP is not
able to manage. Such variable will be ignored.
Found PGP unused tag : ANALOG1
This message is displayed for each PGP tag (AC800F tag and/or variable)
still configured in the PGP database but no longer configured in the parsed
PLC File. Such tags can be manually removed. In the message example,
ANALOG1 is the name of the tag (i.e. the value of the TAGNAME field in
the PGP database).

544

9AKK101130D1382

Log file
The PLC File Builder displays a few messages in the Messages window
during execution. All these messages are also logged in the
PlcParserLog.txt file located in the \PGP\Logs folder.

Add a New PLC Object Type (Example)


Lets assume a new AC800F Function Block parameter (e.g. the KTEXT
parameter) needs to be managed. Lets assume the value of that parameter
must be associated to the CUSTTAGID field of the PGP database.
As previously described, the PLC File Builder creates a temporary PGP
database and fills in it with the values stored in the FreelanceTemplate.xml
file. Such XML file is composed by a lot of sample tag (having no empty
values), whose structure (the parameters it is composed of) is stored in the
DBHeader.xml file.
The steps to introduce the new management are listed below.
Add the new item.
The PGP field name corresponding to the new parameter (e.g.
CUSTTAGID) must be added to the DBHeader file. In this way such
database field will be managed.
Define the association between AC800F and PGP.
The association between the AC800F parameter (e.g. KTEXT) and the PGP
database field (e.g. CUSTTAGID) must be specified in the
Correspondences.xml file. In this way the Builder will be able to set a value
for the PGP field (e.g. CUSTTAGID) retrieving the value of the
corresponding AC800F parameter (e.g. KTEXT).
Add a new field (i.e. a new column) in the database template DBF file.
Since the PLC File Builder creates the temporary database on the basis of a
sample database (FreelanceTemplate.dbf) file located in the \PGP\Deck

9AKK101130D1382

545

folder, the new PGPfield (e.g. CUSTTAGID) must be added to the template
file.
In the Correspondences.xml file, a AC800F parameter cannot be
associated to multiple PGP fields.

AC800F Requirements
As described above, the client PGP retrieves data from the AC800F server
via OPC only.
The FreelanceAC800F software tools need to configure a gateway station
(GS) for each defined AC800F OPC Server. Since a GS can be of different
types, it must be defined as an OPC gateway (such gateways are the only
ones the PGP PLC File Builder must manage to get OPC data).
The PLC file doesnt have any information about the gateway type; therefore
the AC800F OPC gateway names MUST contain the OPC character
string. Valid OPC gateways names (no case-sensitive) are OPC1, Opc2,
OPCA, 1OPC, etc.

PGP Requirements
PGP needs the following DLLs.
PLCPARSER.DLL
Build # 1392, used to parse the PLC File for AC800F system version 6.1
FREELANCE.DLL
MSXML.DLL
The Microsoft XML parser version 2.5a, number 5.0.2919.6303, included
with Internet Explorer 5.0.1.

546

9AKK101130D1382

Alias.xml
The PlcFileBuilder creates the PGP database but hides both the opc
server's ProgID (both DA and AE) and the computer name by inserting in
the corresponding DB fields the same "alias" name and the key word
"MULTI_CMP" respectively. The mapping between the alias name and the
true ProgIDs (as well as the MULTI_CMP key word and the computer name)
is stored in the "Power Generation Portal\deck\alias.xml" file. Note that such
file is created automatically by the Builder, if missing.
The Builder opens the file and looks for the exact matching between both
the DA/AE ProgIDs being managed and the ones listed inside the file and
retrieves the stored alias name if search succeeds. If not, it updates the file
by choosing a default unique alias name ("Server1", "Server2" "ServerN",
depending on the alias names inside the file). See the example below:

9AKK101130D1382

547

548

9AKK101130D1382

The PGP opc client will be in charge of resolving such mapping on the basis
of the configured alias in the database. If "Server2" is defined, the opc client
will connect to "Freelance.30" DA/AE servers on the "PC2" machine.
The alias.xml file is also used to accomplish the PGP OPC Client
Redundancy by defining a list of computers instead of one only as in figure
above. Note that in order to set up redundancy, the configuration of the file
must be done manually. See the example below referring to the
"OPC.Iconics.1" DA server and the list of three different machines:Before
entering in details about the configuration above, it is important to highlight
that both the DA and AE ProgIDs are always common to the listed
computers, meaning that the same opc server and the same ProgID must
be installed on those machines. Therefore the configuration for client
redundancy cannot be applied in case of "Freelance" OPC Servers for
instance because the Freelance ProgID must be different on different
machines.

9AKK101130D1382

549

550

9AKK101130D1382

9AKK101130D1382 Printed in Italy October 2007


Copyright 2005 by ABB. All Rights Reserved
Registered Trademark of ABB.
Trademark of ABB.

http://www.abb.com/powergeneration
ABB Power Systems
Via Hermada 6
16154 Genova - Italy
e-mail pgp.supportline@it.abb.com

You might also like