9AKK101130D1382 - PGP Configuration Manual

Configuration Manual

Power Generation Portal

Version 4.1

Power Generation Portal

Version 4.1

Configuration Manual

Release: Oct 2007 Document number: 9AKK101130D1382

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

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

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

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

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

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

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

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

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

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

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

About This Book

ScopeThe 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 UserThis manual can be used by anyone who performs the functions of a system manager or configuration manager on a PGP application.

Document StructureThe 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:

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

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.

14 9AKK101130D1382

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

Related Documentation

On-line DocumentationAll documentation is supplied in Adobe® Acrobat® reader (.pdf) format.

The Power Generation Portal User Manual is also available as online Help.

Category Title Description

Software Installation

Power Generation Portal Installation Manual How to install Power Generation Portal.

Power Generation Portal Release Notes

Known problems, fixed problems and other release information.

Configuration

Power Generation Portal Configuration Manual

Shows you how to configure and use Power Generation Portal.

Power Generation Portal Display Builder Manual

Provides instructions for building custom graphic displays using the Display Builder.

Power Generation Portal Scanner Manual

Shows you how to configure Power Generation Portal drivers

Power Generation Portal Registry Settings

List all registry settings used by Power Generation Portal Software

Power Generation Portal 800xA Connectivity Package

Shows you how to interface AC800M controllers.

9AKK101130D1382 15

Operation

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 Guide An overview of functions offered by PGP

Power Generation Portal Troubleshooting Manual Assist in troubleshooting problems

Category Title Description

16 9AKK101130D1382

Section 1 Configuration Guide

Main FeaturesPGP is a versatile software package that allows various configurations, which can have a number of functions and a specific capability according to the client’s 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 0 128 512

Logic States Number of Descriptors 0 512 2,048

Alarm Comments Number of Comments 0 100 1,024

Alarm Handling

Tags Number of Handled Alarms N/A N/A Unlimited N/A

No. of Analog Alarm Levels N/A 6 6 6

No. of Rate of Change Levels N/A 2 2 2

No. of Deviation Levels N/A 2 2 2

Unacked Alarm Msg. Capacity 0 2 10

Groups Number of Alarm Groups 0 272 1,024

Nodes Alarm Broadcasted Nodes 0 4 64

Priorities Number of Alarm Priorities 0 8 16

Number of Alarm Colors 0 8 20

Tones Number of Audible Tones 0 32 512

Calculations

Tags No. of Tags per Calc. Block 0 100 2,000

Blocks No. of Calculation Blocks 0 100 10,000

Statements Statement Length N/A 256 256 256

18 9AKK101130D1382

Human Interface

Displays Number of Displays N/A N/A Unlimited

Pegboards Number of Pegboard 0 100 500

Windows Number of Operator Windows 1 32 32

No. of Menu Items and Icons N/A 500 1,000

Process Control SP and CO Increment (%) 0 0.2 99.0

SP and CO Fast Increment (%) 0 4.0 99.0

Popup Time-out (m) 0 0 60

Security

Users Number of Individual Users 1 20 100

User Name Number of Characters 1 18 18

Password Number of Characters 1 18 18

Process Events

SOE Number of SOE Tags 0 0 256/SER 5,000/SEM

Number of SOE Devices 0 2 10

Summaries

Tags realtime Tag Summaries N/A N/A Unlimited

Tag Operating Parameters N/A N/A Unlimited

Hist. Archiving

Playback Number of Playback Hours 1 24 24

No. of Playback Snapshots 1 10 100



9AKK101130D1382 19

Trend Groups Number of Trend Groups (Value includes historical, post trip and realtime groups)

0 100 1,000

No. of Tags per Trend Group 1 60 512

No. of Colors for Trend Curves 15 15 15 15

Chronol. Alarms No. of archived messages N/A 10,000 100,000

Maintenance Number of Digital Totalizations 0 100 1,000

Totalizations Number of Analog Totalizations 0 100 1,000

Post Trips Max Latency Days 1 7 10,000

Max Number of Files 1 100 9,999

Long Term Arch.

Number of Long Term Logs N/A N/A Unlimited N/A

Reports

Number of Unique Reports 0 50 1,000

Printing

Printers Number of Printers 0 N/A 99

Ext. Interfacing

Interfaces Number of Unique Interfaces N/A N/A Unlimited N/A

Hardware

Clients Number of Clients Served 1 32 64

Nodes Number of Nodes 1 32 64

Communication

Infinet Number of INICIs 0 1 8



20 9AKK101130D1382

Table 2. Features: Details.

Category Parameter or Feature Details

Database

General Configuration On-line and Off-line.

Tags Standard Format Dbase III/IV (DBF) or Excel (XLS).

Compatibility to ... Win Tools, Composer (conversion to or from MDB file).

Eng. Units Standard Format Dbase III/IV (DBF), Excel (XLS) or CF File.

Compatibility to ... Win Tools (CF File).

Logic States Standard Format Dbase III/IV (DBF), Excel (XLS) or CF File.

Compatibility to ... Win Tools (CF File).

Alarm Comments Standard Format 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 Configurable per individual tag.

Alarm Dead-band Configurable per individual tag.

9AKK101130D1382 21

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



22 9AKK101130D1382

Date and Time Configurable.Standard: dd-mmm-yy orAlternate: according to Regional Option settings.

International Date Configurable according to Regional Option settings.

Calculations

General Configuration On-line and Off-line.

Triggering On event and On schedule.

Statements Statement Length Configurable.

Operators Arithmetical Operations +, - (prefix), - (infix), *, /, % (module), ^ (exponential).

Logical Operators AND, OR, NOT.

Relational Operators <, ==, >, <=, !=, >=.

Structures Control Structures IF-THEN-ELSE,WHILE-DO.

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



9AKK101130D1382 23

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) Configurable within 32 cells.

Standard Input Format Dbase III/IV (DBF) or Excel (XLS).



24 9AKK101130D1382

Windows Multi-screen Configurable (default NO).

Draggable Windows Configurable (default NO).

Process Control SP and CO Increment Configurable (default 0.2%).

SP and CO Fast Increment Configurable (default 4%).

Double Click to Select Popup Configurable (default NO).

Security

General Access Individual users.

Technology Proprietary.

Log In Log In 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 Standard and distributed.

Sequence of Events Resolution 1 Millisecond.

Tags Number of SOE Events Configurable.

Duplication of SOE to Digital Inputs Configurable (default YES).

Logs Multiple SOE Logs Kept individual or merged.



9AKK101130D1382 25

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

Trend Groups Types of Historical Trend Groups 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 On-line or Off-line.



26 9AKK101130D1382

Trend Group Display Configurability 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 Multiple Filtering Criteria.

Post Trips Latency on Disk 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 Custom Excel Work-sheet.



9AKK101130D1382 27

SOE Sequence of Events Logging 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 DDE Functions.

ODBC ODBC Interface Oracle, Access, dBase IV, Excel, MS SQL Server.

OPC OPC Interface OPC Server and OPC Client.

WEB WEB Extensions Internet and Corporate Intranet.

Hardware

Hosts Architecture Client/Server.

Host PC Custom (Dell and Compaq suggested).

Clients Client Switch-over to Server Automatic or Manual.

Server List for Clients Configurable.



28 9AKK101130D1382

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

Nodes Redundancy Multi-Master Nodes.

Field Field Hardware Freelance 2000, Symphony, Infi 90,Network 90, Foreign Devices.

Communication

Standard Supported C-Net, Infinet, Plant Loop.

Scanner Suite Capability to Host Drivers for 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.



9AKK101130D1382 29

Outline of ConfigurationThis 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 cross-reference 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 ConfigurationThis section defines configuration parameters and discusses things to consider in determining appropriate values. Configuration parameters are defined into the Windows Registry.

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

For a complete list of PGP registry read the manual “9AKK101130D8771- PGP Registry Settings”.

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.

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.

Figure 1. System Setup Interface

38 9AKK101130D1382

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

Changing Registry ValuesThe 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

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

Figure 3. Change Registry Value

9AKK101130D1382 41

System Configuration Parameters

System SizesFor details on size parameters please refere to the “9AKK101130D8771- PGP 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 OptionsThis 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 “9AKK101130D8771- PGP Registry Settings” manual.

Configuration Procedure

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

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.

Figure 4. PGP Setup 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.

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.

Figure 5. Unbuild Data Base - Offline Database Builder Window

46 9AKK101130D1382

Building ProcedureEach 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 StepEditing 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 StepBuilding 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 WindowThe following sections describe the elements of the builder window.

Builder ListThe 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) builderThe 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 builderThe 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 builderThe 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 builderThe 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 builderThe 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

.

Menu and Tool-bar builderThe 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 Tool-bar . 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 builderThe 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 builderThe 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.

The default BDSTDECK.XML file distributed with the PGP setup is configured for the European DayLight Saving Time rules.

9AKK101130D1382 51

Engineering Unit Descriptor Database builderThe 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 builderThe 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 builderThe 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 builderThe 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 builderThe 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 builderThe 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 builderPegboards 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 builderReports 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 builderThe 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 builderThe 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 BuilderThe 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 ButtonsThe 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.

In the following description the functions related to the action buttons are described.

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

Figure 6. Builders – Builder Selection

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

Figure 7. Builders - Import Window

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.

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

Figure 8. Builders – File Initialization Window

9AKK101130D1382 59

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

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

Figure 9. Builders – Output Message Window

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.

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 ButtonThe Abort button abandons processing without performing any file initialization and any building. This button does not allow you to close the builder window.

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

Figure 10. Builders – Data File Initialization Window

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.

Refer to the following sections for details on each option of the builder window.

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

Figure 11. Builders – Builder Options

9AKK101130D1382 63

Ignore Error OptionIf 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 OptionIf 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 OptionWhen 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 OptionWhen 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).

Initialize OptionWhen 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 OptionWhen selected, this option forces the builder to add in the PGP internal database only the items which can’t 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.

Figure 12. Builders – Pre-PostApp Option

9AKK101130D1382 65

Replace OptionThis option, when it is selected, forces the builder to replace in the PGP internal database the items found in the submitted definition file. The not-existing 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 OptionWhen 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 FileWhen 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 WindowThe 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 buttonDuring 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.

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 ButtonThe Abort button abandons processing without performing any export file. This button does not allow you to close the export window.

Figure 13. Builders - Export Window

68 9AKK101130D1382

Select OptionWhen 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

IntroductionIn 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

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

Default Default value.It applies to optional fields only and defines the value assigned to the field if the user does not define a value.

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

Table 3. Database structure.

Item Description

70 9AKK101130D1382

Tag Database Subsystem

OutlineThe 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 tagsThe 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 tagsThe 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 DatabaseThe 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 DefinitionThis section describes all common fields used to configure both analog and digital tags.

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

INDEX Integer6Optional

Tag index. 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 allocatedTAGINDEX is an alias name for this field.

{0, 1...128000}0[mxindx]

NAME Character20Mandatory

Tag name. This field identifies the tag by name. It may be a combination of alphabetic characters (A-Z), numeric characters (0-9) and special symbols ("+", "-", "_", "/", "$", ".", " "), with at least one alphabetic character. This name must be unique for each tag within database.TAGNAME is an alias name for this field.

<string><blank>[sznam]

UID Character36Mandatory

Tag unique identification. This field provides a unique identification in the PGP application history. It is assigned at import time. Export database to update the field in the DBF file.TAGUID is an alias name for this field.See Note 1 at the end of the table.

<string><blank>None

DESC Character64Optional

Tag description. This field is a character string used to describe the tag on the different outputs (alarm messages, reports, summaries, etc.).TAGDESC is an alias name for this field.

<string><blank>[szdesc]

74 9AKK101130D1382

TAGTYPE Character8Mandatory

Tag type code. This field specifies the type of the tag according to Appendix A.TAGTYPE is an alias name for this field.

UNDEF[sztype]

TAGSRC Character7Optional

Tag source code. This field specifies the source type of the tag according to Appendix A.

<blank>None

CUSTTAGID Character32Optional

Plant tag name. 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.

<string><blank>None

PRIMDISP Character80Optional

Primary display reference. Name of a graphic display associated to the tag. This page can be directly called from tag presentation displays or from alarm pages.

<string><blank>None

SEC_LEVEL Integer2Optional

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

{0, 1...16}0None


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 75

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

SEC_GROUP Integer2Optional

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

{0, 1...32}0None

EXTDESC Character80Optional

Extended tag description. This field is a character string used to completely define the tag or to enhance the tag description.

<string><blank>[szedsc]


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

76 9AKK101130D1382

The parameter listed in the following table is not included in the General Tab of the on-line configuration.

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

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.

Table 5. Generic Tag - General Parameters (continued)

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

PLANTUNIT Integer2Optional

Plant unit. This field identifies the plant unit (applicable to multi-unit plants only) and allows grouping the tags per unit group.

{0, 1...12}0None

9AKK101130D1382 77

Table 6. Generic Tag - Process Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

AL_REM Character1Optional

Remote alarm processing flag. If set, the alarm processing for this tag will be performed remotely (PCU level or PLC level), otherwise it will be performed locally (computer level). This field is meaningful for tags coming from smart devices able to check for an alarm condition. For all other tags, alarm processing is always performed locally.

{Y, N}Y None

OFFSCINI Character1Optional

Initially off scan flag. If set, the tag is put off scan at PGP start-up time.The operator must manually put on scan the tag.

{Y, N}NNone

OFFALINI Character1Optional

Initially off alarm check flag. If set, the tag is put off alarm check at PGP start-up time.The operator must manually put on alarm check the tag.

{Y, N}NNone

EXP_VAL Character1Optional

Export to ODBC flag.If set, tag values are exported via ODBC interface.

{Y, N}NNone

PLAYBACK Character1Optional

Playback archive flag.If set, the tag will be recorded on the playback archive.

{Y, N}YNone

78 9AKK101130D1382

AAP_NUM Integer2Optional

Index to an application action program. If greater than 0, this field defines a link which will cause an user defined application program to be activated upon status changes for this tag. The name of the application program must be ALACxx, where xx is the number corresponding to the value of the field.

{ 0, 1...63}0None

TRIG_CALC Integer3Optional

Triggered calculation block number. If greater than 0, it identifies the calculation block to be triggered when the tag goes into alarm or returns to normal.Triggering takes place on both state transitions.

{0, 1...999}0[mxxcal]

REP_NUM Integer4Optional

Triggered report number. If greater than 0, it identifies the report to be triggered when the tag goes into alarm or returns to normal.Triggering takes place on both state transitions.

{0,1...50}0[nmrpts]

DATA_PROC Character64 Optional

Application component name.The field defines the name of a program used to perform some specific handling (e.g. raw data conversion) on the tag values. See Appendix A for details about the DataProcessor xml file.


FACEPLATE Character80 Optional

Pop-up handling program name.The field applies to control tags only and defines the name of the program used to manage control commands.



NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 79

CONFIRMCM Character1 Optional

Confirm command enable flag.If set, will be requested the confimation to execute a control command on the tag.

{Y,N}NNone

CTRLINHTAG Char20Optional

Control inhibit tag name. Tag name of control inhibit tag. It must refer to a digital tag.Control inhibit tag is a digital tag used to disable actions upon analog (RMSC) and digital (RCM, DD, MSDD) control tags.


OTXNAME Character56 Optional

Output transfer tag name.Name of a output tag to be linked to the current tag for outputting to loop.The output tag must exist within the tag database.

<string><blank>

OTXENB Character1Optional

Output transfer enable flag.If set, output transfer to the tag defined in the OTXNAME field is enabled.

{Y,N}NNone


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

80 9AKK101130D1382

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

MAINTTRIG Integer6Optional

Maitenance log number. If greater than 0, it identifies the maintenance log to be triggered when the tag goes into alarm or returns to normal.Triggering takes place on both state transitions.

{0, 1...100}0[n.hrtl]

OPCSRVVIS Integer2Optional

OPC server visibility.Defines if the tag will be exported by the OPC server.0 = NO1 = Read only2 = R/W

{0, 1, 2}2

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.


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 81

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

ACK_PROG Character1Optional

Program activation flag on acknowledge.If set, the application action program defined by the AAP_NUM field will be activated when an alarm acknowledge is performed.The on-line configuration includes the field within the Alarm Level Tab for analog tags and the DI Process Tab for digital tags.

{Y,N}NNone

CTRLCMDTAG Char20Optional

Control command tag name. Not longer used.


EXPFIL Character1Optional

Export to file flag.If set, tag values are exported to an ASCII file.The on-line configuration does not include the field.

{Y, N}NNone

PLAYBACKLT Character1Optional

Playback flag for long term archiving.If set, reduced size data packets will be recorded on the playback to save disk space.The on-line configuration does not include the field.

{Y,N}NNone

82 9AKK101130D1382

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

PLAYBACKSP Character1Optional

Playback specific processing flag.If set, tag exception reports will be submitted to specific processing on playback archiving. A specific application routine must be implemented.The on-line configuration does not include the field.

{Y,N}YNone

RTN_PROG Character1Optional

Activate an application action program on return to normal condition.If set, the application action program defined by AAP_NUM field will be activated whenever a return to normal condition takes place.The on-line configuration includes the field within the Alarm Level Tab for analog tags and the DI Process Tab for digital tags.

{Y,N}NNone

TOT_LOG Integer3Optional

Totalization log number. If greater than 0, it identifies the index into the analog or digital totalization log archive at which tag values are accumulated.The on-line configuration includes the field within the PV General Tab for analog tags and the DI Process Tab for digital tags.

{0,1...100}0n.tene

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

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.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

FIELD_AD1 Integer6Mandatory

Field input address 1.0None

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

FIELD_AD10 Integer6Mandatory

Field input address 10.0None

FIELD_TX1 Character80Optional

Field input driver text 1. <string><blank>[mxopcn]

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

84 9AKK101130D1382

Generic Scanner Output ParametersThe 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.

FIELD_TX10 Character80Optional

Field input driver text 10. <string><blank>[mxopcn]

FIELD_DRV Character20Mandatory

Field input driver name.This name identifies the kind of driver interfacing PGP to the process for input data communication.


Table 8. Generic Tag – Generic Scanner Input Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 85

Table 9. Generic Tag – Generic Scanner Output Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

OUT1_AD1 Integer6Mandatory

Field output driver 1 address 1.See the Note 1 at the end of the table. 0

None

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


Field output driver 1 address 10.See the Note 1 at the end of the table. 0

None

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


Field output driver 5 address 10.0None

OUT1_TX1 Character64Optional

Field output driver 1 text 1.See the Note 2 at the end of the table.


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


Field output driver 1 text 10.See the Note 2 at the end of the table.


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


Field output driver 5 text 10. <string><blank>[szdesc]

86 9AKK101130D1382

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.

OUT1_DRV Character20Mandatory

Field output driver name 1.This name identifies the kind of driver interfacing PGP to the process for output communication.See the Note 3 at the end of the table.


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

OUT5_DRV Character20Mandatory

Field output driver name 5.This name identifies the kind of driver interfacing PGP to the process for output communication.


Table 9. Generic Tag – Generic Scanner Output Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 87

Symphony Input ParametersThe 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.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

ICI_NUM Integer2Optional

ICI Number.Number of the physical ICI device when multiple ICIs are connected to PGP.

{1...8}1[mxciu] or [mxxciu]

ICI_NDX Integer5Optional

ICI index. This is the reference index in the internal ICI table.If omitted or less than zero, the first vacant ICI index will be allocated. Index zero is legal only for ICI module status tags. If this field is zero (blank) and ICI point type is not module status, an error will be generated. Therefore, this field must be omitted or explicitly defined as –1, except for those particular tags requiring fixed indexes.

{-1, 0...29999}-1[mxcpts]

LOOP Integer3Mandatory

Ring number. {0..63}0None

88 9AKK101130D1382

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

Alarm Processing ParametersThe 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

PCU Integer3Mandatory

PCU number. {1...256}0None

MODULE Integer2Mandatory

Module number. {0...31}0None

BLOCK Integer5Mandatory

Block number. {0...99999}0None

ICISTA_CD Character1Optional

ICI action code.This code specifies the ICI action at start-up time. See Appendix A for the meaning of supported actions.

{X, E, C, D}CNone

Table 10. Generic Tag - Symphony Input Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 89

Table 11. Generic Tag - Alarm Processing Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

DS_ALARM Character1Optional

Display alarm flag. If set, alarms concerning this tag will be displayed on alarm display pages (LADs).

{Y, N}Y None

PR_ALARM Character1Optional

Print alarm flag. If set, alarms concerning this tag will be printed on alarm printer(s).See the field ALMPRINTER also.

{Y, N}NNone

SV_ALARM Character1Optional

Save alarm flag. If set, alarms concerning this tag will be logged to the Operator Journal.

{Y, N}Y None

AUD_ALARM Character1Optional

Audible tone activation flag. If set, the audible tone defined by AUDINDEX will be activated when an alarm will occur.

{Y, N}Y None

BOT_ALARM Character1Optional

Bottom alarm displaying flag.If set, unacknowledged alarms concerning this tag will be displayed in the bottom of screen alarm window.

{Y, N}Y None

REM_ONACK Character1Optional

Remove alarm flag on acknowledgment.If set, alarm messages are removed from the alarm display page (LAD) when an alarm acknowledgment involving the tag is performed.

{Y, N}NNone

90 9AKK101130D1382

INFO_ONACK Character1Optional

Log information flag on acknowledgment.If set, an information message is logged to the Operator Journal when alarm acknowledgment involving the tag is performed.

{Y, N}NNone

DS_RTN Character1Optional

Display flag for return to normal condition. If set, a RTN message concerning this tag will be displayed on alarm display pages (LADs). An alarm acknowledge will then remove the message.

{Y, N}YNone

PR_RTN Character1Optional

Print flag for return to normal condition. If set, RTNs concerning this tag will be printed.See the field ALMPRINTER also.

{Y, N}NNone

SV_RTN Character1Optional

Save message flag on return to normal. If set, return to normal condition messages concerning this tag will be logged to the Operator Journal.

{Y, N}Y None

AUD_RTN Character1Optional

Activate flag for audible tone on return to normal. If set, the audible tone defined by AUDINDEX will be activated when the tag will return to a normal condition. An audible acknowledge or an alarm acknowledge will then clear the audible tone.

{Y, N}NNone


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 91

PR_STCHNG Character1Optional

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

{Y, N}NNone

SV_STCHNG Character1Optional

Save flag for state changes. If set, the changes of state concerning this tag will be recorded into the Operator Journal.

{Y, N}Y None

DS_STCHNG Character1Optional

Save flag for display events. If set, the changes of state concerning this tag will be displayed on the alarm pages

{Y, N}N None

PR_OPACT Character1Optional

Print flag for operator action messages.If set, on-line database modifications and all other operator actions concerning this tag will be printed on alarm printer(s).See the field ALMPRINTER also.

{Y, N}NNone

SV_OPACT Character1Optional

Save flag for operator action messages. If set, on-line database modifications and all other operator actions concerning this tag will be recorded into the Operator Journal.

{Y, N}YNone

PR_INFO Character1Optional

Print flag for information messages.If set, information concerning this tag will be printed.See the field ALMPRINTER also.

{Y, N}NNone


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

92 9AKK101130D1382

SV_INFO Character1Optional

Save flag for information messages.If set, information concerning this tag will be logged to the Operator Journal.

{Y, N}Y None

EXP_ALA Character1Optional

Relational database update (alarms) flag.If set, alarm messages will be automatically sent to the external relational database.

{Y, N}NNone

APPL_ALA Character1Optional

Trigger flag for application program. On alarm occurrence, an application program is triggered for execution.The on-line configuration does not include the field.

{Y, N}NNone

ALMACKBC Character1Optional

Broadcast flag for alarm acknowledge. If set, alarm acknowledgments are broadcasted to other nodes in the same multi-master architecture.

{Y, N}NNone

ALMGROUP Integer3Optional

Alarm group number. This field allows you to group all tags belonging to a given plant area or component. Alarm group numbers are used to sort the alarms for the presentation on screen. Alarm groups are customer defined. By default, groups 1 to 16 are defined as first level groups, directly addressed by alarm displays and summaries. Groups 17 to 32 are defined as sub-groups of group 1, groups 33 to 48 are defined as sub-groups of group 2 and so on.

{0, 1...272}0[sladnm] or [mxxagp]


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 93

AL_PRI Integer2Optional

Alarm priority number. This is the default priority number and is used when a specific alarm priority is not defined for a single alarm condition. Specific priority numbers can be assigned to each alarm condition. See the following fields and the fields of the analogue sub-sections of analog and digital tag definitions for a description.This default priority field and the specific priority fields determine the colors used to display alarms of the tag. Alarm priorities can be customer defined. The BATTDECK system configuration file defines the default alarm priorities.

{1 ... 16}1[mxalpr] or [mxxapr]

ALMINHTAG Char20Optional

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


AUDINDEX Integer3Optional

Audible alarm index. This field defines the index into audible alarm database to determine which audible is to be activated upon alarm and/or return to normal.

{0, 1...32}0[mxaud]


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

94 9AKK101130D1382

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

ALMPRINTER Integer2Optional

Alarm printer index.Reference index to the printer where messages concerning the tag are printed.See the fields PR_xxx (e.g. PR_ALARM) also.It is a pointer to a registry defining the alarm printer. Refer to the system option configuration for details.

{1...99}1None

SMSINDEX Integer3Optional

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.


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 95

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

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

Alarm Comment ParametersThe 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.

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

ALPRI_RTN Integer2Optional

Return to normal priority number. 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.See the description of the AL_PRI field for the definition of alarm priorities.

{0, 1 ... 16}0[mxalpr] or [mxxapr]

ALPRI_HCF Integer2Optional

Hardware channel failure priority number.This is the priority assigned to the tag when a hardware channel failure takes place. If set to 0 then the default priority is assigned.See the description of the AL_PRI field for the definition of alarm priorities.


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.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

ALRMCMNT1 Integer5Optional

Return to normal comment index. {1...100}0[mxalcm]

ALRMCTXT1 Character80Optional

Return to normal comment text. <string><blank>[szalcm]


High alarm (for analog tags) or alarm (for digital tags) comment index.

{1...100}0[mxalcm]


High alarm (for analog tags) or alarm (for digital tags) comment text.

<string><blank>[szalcm]

9AKK101130D1382 97

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


Hardware channel failure comment index. {1...100}0[mxalcm]


Hardware channel failure comment text. <string><blank>[szalcm]

Table 13. Generic Tag – Alarm Comment Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

98 9AKK101130D1382

Table 14. Generic Tag – Network Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

CNFNODMSK Character16Optional

Destination node mask for tag configurations.First bit refers to node 1 in the node definition, second bit refers to node 2, and so on.

Sequence {Y, N}16*NNone

CNFNODMS2 Character16Optional

Destination node mask for tag configurations.The mask applies to nodes from 17 to 32.



Destination node mask for tag configurations.The mask applies to nodes from 33 to 48.



Destination node mask for tag configurations.The mask applies to nodes from 49 to 64


DESTNODMSK Character16Optional

Destination mask for operator actions.Operator actions are routed from the 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.


DESTNODMS2 Character16Optional

Destination mask for operator actions.The mask applies to nodes from 17 to 32.





9AKK101130D1382 99




DESTVALMSK Character16Optional

Destination node mask for tag values.Tag values are routed from the 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.


DESTVALMS2 Character16Optional

Destination node mask for tag values.The mask applies to nodes from 17 to 32.



Destination node mask for tag value.The mask applies to nodes from 33 to 48.



Destination node mask for tag value.The mask applies to nodes from 49 to 64.


SRCNODMSK Character16Optional

Source node mask for tag values.First bit refers to node 1 in the node definition, second bit refers to node 2, and so on.


SRCNODMS2 Character16Optional

Source node mask for tag values.The mask applies to nodes from 17 to 32.



NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

100 9AKK101130D1382

OPC ParametersOPC (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.


Source node mask for tag values.The mask applies to nodes from 33 to 48.



Source node mask for tag values.The mask applies to nodes from 49 to 64



NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 101

Table 15. Generic Tag - OPC Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

OPCPROGID Character80Mandatory

Server name.This is the name of the OPC Data Access Server.

<string><blank>[mxopcn]

OPCPROGAE Character80Mandatory

Alarm event server name.This is the name of the OPC Alarm Event Access Server.


OPCCMPTR Character80Optional

Computer name.This is the name of the machine hosting the OPC Data Access Server and OPC Alarm&Event Server. It may be left undefined to establish a local connection.


OPCITEMID Character80Mandatory

Item identification.This is the unique identification of data item to be accessed in the server specific address space. The value to be specified depends on the OPC server.

<string><blank>[mxopci]

OPCACCPATH Character80Optional

Access path.This may be additional information to qualify access to data item. The value to be specified depends on the OPC server.


102 9AKK101130D1382

OPCREFRESH Integer6Optional

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

1None

OPCREADTYP Integer6Optional

Read type.See Table 17 for allowed read types. 120

None

OPCEXPCLNT Character1Optional

Flag to enable commands to OPC client.If set, for a control tag, commands are allowed to the OPC server.

{Y,N}NNone

Table 16. Server DA Refresh Rates.

Code Description

500 500 milliseconds.

1 1 second.

2 2 second.

3 3 seconds.

Table 15. Generic Tag - OPC Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 103

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

5 5 second.

10 10 seconds.

30 30 seconds.

60 60 seconds.

Table 17. Read Types.

Code Description

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

Table 16. Server DA Refresh Rates.

Code Description

104 9AKK101130D1382

Totalization ParametersFields 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 ParametersFields of this sub-section apply to digital tags only. Refer to the analogue sub-section of digital tags for details.

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

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

OPC_ALA Character1Optional

Flag for export alarms to OPC server.If set, alarm messages will be automatically sent to the OPC server.

{Y, N}NNone

OPCPROGHS Character80Mandatory

Historian server name.This is the name of the OPC Historian Access Server.


9AKK101130D1382 105

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

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


Table 19. Generic Tag - Documentation Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

ALMDHF Integer5Optional

Reference to documentation on hardware channel failure condition. 0

None

ALMDRN Integer5Optional

Reference to documentation on return to normal condition. 0

None

ALMDHA Integer5Optional

Reference to documentation on alarm (digital tags) or high alarm (analog tags) condition.

0None

106 9AKK101130D1382

Table 20. Generic Tag - Hardware Description Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

S_COORD Character10Optional

Slave module coordinates. <string><blank>None

S_MODULE Character2Optional

Slave module number. <string><blank>None

S_CHANNEL Character2Optional

Slave channel number. <string><blank>None

S_TYPE Character6Optional

Slave module type. <string><blank>None

TO_BOARD Character14Optional

Termination unit identifier. <string><blank>None

TO_TU_TY Character6Optional

Termination unit type. <string><blank>None

TO_TU_CO Character10Optional

Termination unit coordinates. <string><blank>None

TO_TB_ID Character3Optional

Board identifier on termination unit. <string><blank>None

9AKK101130D1382 107

TO_PIN1 Character2Optional

First pin on termination board. <string><blank>None


Second pin on termination board. <string><blank>None


Third pin on termination board. <string><blank>None

DRAW_REF Character14Optional

Drawing reference code description. <string><blank>None

DESC_CABLE Character20Optional

Field cable identifier. Name of field cable wiring termination unit to field termination board.

<string><blank>None

FR_BOARD Character14Optional

Field termination cabinet identifier. Name of field cabinet to which termination unit is wired.

<string><blank>None

FR_TB_ID Character4Optional

Field termination board identifier. <string><blank>None

FR_ROW Character4Optional

Field termination board coordinates. <string><blank>None


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

108 9AKK101130D1382

FR_PIN1 Character3Optional

First pin on field termination board. <string><blank>None


Second pin on field termination board.

<string><blank>None


Third pin on field termination board. <string><blank>None

WIN_PANEL Character8Optional

External alarm window panel identifier.

<string><blank>None

WIN_NUMBER Character3Optional

External alarm window number. <string><blank>None

WIN_ROW1 Character14Optional

External alarm window description row 1.

<string><blank>None



<string><blank>None



<string><blank>None


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 109

Application ParametersThe fields in Table 21 and Table 22 are available for additional tag qualification or to be used by application specific programs.


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.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

USER3 Character8Optional

ASCII text. <string><blank>None





UT_IN1 Integer6Optional

Integer value. {-32767...+32767}0None





110 9AKK101130D1382



UT_RE1 Real9Optional

Real number. <9 digit real>0 None












NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 111

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>

ASPECT1NAM Character20Optional

Aspect program menu text 1.Aspects allows you to add specific menu items for tag handling. Menu items are added to the operating parameters and to the context menu. See the field ASPECT1CMD also.The aspect name defines the text of the menu item.


ASPECT1CMD Character80Optional

Aspect command line 1.Aspects allows you to add specific menu items for tag handling. See the field ASPECT1NAM also.The aspect command defines the command line to be executed.See the Note 1 at the end of the table.


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

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

ASPECT5NAM Character20Optional

Aspect program menu text 5.Same as ASPECT1NAM above.


ASPECT5CMD Character80Optional

Aspect command line 5.Same as ASPECT1CMD above.See the note 1 at the end of the table.



NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

ATOM1NAM Character64Optional

Atom name 1. <string><blank>[szdesc]

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

ATOM50NAM Character64Optional

Atom name 50.Same as ATOM1NAM above.


ATOM1TYP Integer6Optional

Atom type 1.0None

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

ATOM50TYP Integer6Optional

Atom type 50.Same as ATOM1TYP above. 0

None

9AKK101130D1382 113

Digital Tag DefinitionThis 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.

ATOM1VAL Integer10Optional

Atom value 1. {-32767...+32767}0None

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

ATOM50VAL Integer10Optional

Atom value 50.Same as ATOM1VAL above.

{-32767...+32767}0None

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

114 9AKK101130D1382

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

ZEROSTATE Character16Mandatory

Zero state descriptor. This field defines the text to be displayed or printed to represent the state 0.

<string>

[sztags]

ONESTATE Character16Mandatory

Same as above for state 1. <string>

[sztags]

TWOSTATE Character16Optional

Same as above for state 2.The field is mandatory for MSDDs.

<string><blank>[sztags]

THREESTATE Character16Optional

Same as above for state 3.The field is mandatory for MSDDs.


FOURSTATE Character16Optional

Same as above for state 4. <string><blank>[sztags]

9AKK101130D1382 115

FIVESTATE Character16Optional


SIXSTATE Character16Optional


SEVENSTATE Character16Optional


EIGHTSTATE Character16Optional


NINESTATE Character16Optional


TENSTATE Character16Optional


ELEVNSTATE Character16Optional


TWELVSTATE Character16Optional



NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

116 9AKK101130D1382

Note 1:

THTEESTATE Character16Optional


FRTEESTATE Character16Optional


FVTEESTATE Character16Optional


LSD1INDEX Integer16Optional

Index for logic state descriptor 1.0None

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

LSD16INDEX Integer16Optional

Index for logic state descriptor 16.0None

ISALARM0 Character1Optional

Alarm flag for state 0. Is set, state 0 is an alarm state.See Note 1 at the end of the table.

{Y, N}N None

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

ISALARM31 Character1Optional

Alarm flag for state 31. Is set, state 31 is an alarm state.See Note 1 at the end of the table.

{Y, N}N None


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

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 ParametersThe fields in Table 24 define some alarm processing information concerning digital tags. All fields are optional.

Table 24. Digital Tag - Process Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

EVENTTAG Character1Optional

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

{Y, N}NNone

INITVAL Integer15Optional

Initial value. This value is loaded into the realtime database at system star-up.

{0...15}0 None

118 9AKK101130D1382

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

MAX_ROC Integer3Optional

Maximum allowed rate of changes.This field defines the maximum number of state changes allowed for this tag during 1 minute. If the number of changes exceeds this limit, the tag is automatically put out of scan. The function is useful for filter exception reports due to hardware failures in the digital contacts. Those no-meaningful exception reports might significantly reduce or saturate the playback storage area.

{0...999}0 None

TRIP_NUM Integer4Optional

Triggered post trip group number.If greater than 0, it identifies the post trip group to be triggered when the tag goes into alarm or returns to normal.

{0,1...100}0[mxhgrp]

ALM_PROG Character1Optional

Program activation flag on alarm.If set, the application action program defined by AAP_NUM field will be activated whenever an alarm condition occurs.

{Y,N}NNone

EVT_PROG Character1Optional

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

{Y,N}NNone

Table 24. Digital Tag - Process Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 119

Generic Scanner Output ParametersFields 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 ParametersThe 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

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

Table 25. Digital Tag - Symphony Input Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

SER_NUMBER Integer2Optional

SER number. {0, 1, 2}0[mxsedv]

SER_INDEX Integer4Optional

SER index. {0, 1...512}0[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.

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

SOELOG Integer3Optional

Number of sequence of events log.This field identifies the log of each SER device.

0None

SOETYPE Integer1Optional

Type of sequence of events.The value of this field can be0 - Standard SOE,1 - Summary SOE.

{0, 1}0None

9AKK101130D1382 121

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

SOETIMEOUT Integer3Optional

Sequence of events time-out.This field defines the interval of time the sequence of events is kept opened ready to collect all changes following the first event (the SOE event activating).

0None

SOETUNITS Integer1Optional

Time unit to qualify the SOE time-out.The value can be0 - Seconds,1 - Minutes.

{0, 1}0None

SOEMAXEVT Integer5Optional

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

0None

SOEOUTLOG Integer3Optional

Output log for SOE merging.When multiple SER devices are in use, a single log can be generated merging logs. 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.

0None

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

122 9AKK101130D1382

The on-line configuration includes the fields in the DI Feedback Tab..Table 27. Digital Tag – Command Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

FB1_0STATE Character16Optional

Zero state descriptor for feedback 1. This field defines the text to be displayed for the state 0 of feedback 1.



One state descriptor for feedback 1. This field defines the text to be displayed for the state 1 of feedback 1.



Same as above for state 0 of feedback 2. <string><blank>[sztags]











9AKK101130D1382 123

Alarm Processing ParametersThe 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.

Alarm Level ParametersFields of this sub-section apply to analog tags only.

Alarm Option ParametersFields of this sub-section apply to analog tags only.

Alarm Comment ParametersThe 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

Table 28. Digital Tag - Alarm Processing Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

ALPRI_STCH Integer2Optional

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


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.

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.


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

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

Table 29. Digital Tag - Alarm Comment Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)


Alarm comment index for alarm condition. {1...100}<blank>[mxalcm]


Alarm comment text for alarm condition. <string><blank>[szalcm]

9AKK101130D1382 125

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

HRTRUNSTAT Integer1Optional

Running status for digital totalization.This field defines the status identifying the operational condition of the dual-state device.

{0, 1}0None

HRTMAXCHGS Integer5Optional

Maximum number of status changes.This field defines the upper limit to the number of allowed transitions from the steady to the operational status of the device.

0 None

HRTMAXRUN Integer3Optional

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.

0 None

126 9AKK101130D1382

Device Status ParametersThe 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.

HRTMAXRUNU Integer1Optional

Time unit for maximum running time.See Appendix A for the allowed time units.

0 None

HRTMAXSRV Integer3Optional

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.

0 None

HRTMAXSRVU Integer1Optional

Time unit for maximum time from service.See Appendix A for the allowed time units.

0 None

Table 30. Digital Tag - Totalization Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 127

Table 31. Digital Tag - Device Status Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

DEV_NAME Character20Optional

Device name.Depending on the type of device (see the field DEV_TYPE below), this field can define the name of a printer, a computer or a disk. See Note 1 at the end of the table.

<string><blank>None

DEV_NUMBER Integer15Optional

Device number.Allowed values are1 - Printer,2 - Node,3 - Disk.

<integer>0None

DEV_TYPE Integer15Optional

Device type.The field qualifies the kind of device the tag applies to. It may define a printer, a node or a disk diagnostic tag.See Note 2 at the end of the table.

{Printer, Node, Disk}0None

DEVSUBTYPE Integer2Optional

Device sub-type.This field is not required for module diagnostic.

0None

128 9AKK101130D1382

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.

MODTYPE Character20Optional

Module type.This field defines the kind of hardware to be either: MFP, OIS, MCS, TNT, ...This field is not required for module diagnostic. The field value is used, when the ALMACKBC flag is set, to route the alarm acknowledge through the Infinet.

{MFP, OIS, MCS, ...}<blank>[sznam]

MODREV Character2Optional

Module revision.This field is not required for module diagnostic.

<string><blank>None

Table 31. Digital Tag - Device Status Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 129

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

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

Application ParametersFields 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 DefinitionThis section describes all specific fields used, together the fields defined in the generic tag definition chapter, to configure analog tags.

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

Table 32. Digital Tag – Documentation Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

ALMDST Integer5Optional

Reference to status change documentation 0

None

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.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

EUDESC Character16Optional

Engineering unit text. This text defines the engineering unit associated to the tag.


NUMDECPL Integer1Optional

Number of decimal places.The information is used when displaying the tag value.

{0...9}2None

I4_DATA Character1Optional

Integer/Real format flag. If set, the value of the tag will be stored into realtime database as a 32-bit signed integer.

{Y,N}NNone

PLAYBACKCM Character1Optional

Playback compression flag.If set, tag exception reports will be compressed in the playback archive according to compression rules.

{Y,N}YNone

INITVAL Real15Optional

Initial value. This value is loaded into realtime database at system start-up.See Note 1 at the end of the table.

{lowlim...higlim}0None

9AKK101130D1382 131

SCA_VAL_0 Real15Optional

0% scale value. 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.See Note 1 at the end of the table.


SCA_VL_100 Real15Optional

100% scale value. 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.See Note 1 at the end of the table.


PLAYBACKDB Real10Optional

Playback dead-band. 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.See PLAYBACKTM also and the Note 3 at the end of the table.See Note 1 at the end of the table.


PLAYBACKTM Integer5Optional

Playback timer. This field defines the timer (in seconds) for dummy packet checking.See PLAYBACKDB also and the Note 3 at the end of the table.

30None


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

132 9AKK101130D1382

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

Values of VAL0 and SPAN are defined in the alarm level definition sub-section.

Note 2:

PLBCOMPRDB Integer15Optional

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

{0...100}0None

FILTER_TAU Integer4Optional

Time constant for filter factor. This field defines a time constant for filtering a tag value before updating the realtime database. A value of zero will disable filtering. The value stored in the realtime database is computed using new input (raw) value and old realtime database value.See Note 2 at the end of the table.

0None

INCDECPRC Real10Optional

Increment/Decrement percentage for control station and RMSC device.

{0...100}0.0None

lowlim = VAL0

higlim = VAL0 + SPAN


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

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:

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 dead-band, and last stored packet is older than the defined playback timer, an additional dummy packet is queued to playback with the same value and quality as the old one and the same time as the new one. Then the new packet is stored.

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

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.

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

EUINDEX Integer3Optional

Engineering unit index. 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, 0...127}-1[mxeutx]

CONSTDELTA Real10Optional

Hourly constancy delta value. 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.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 ParametersFields 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 ParametersFields 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.

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

Table 35. Analog Tag – Generic Scanner Input Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

CONVCODE Character20Optional

Conversion code to be performed on the input raw data.


CONVMIN Integer15Optional

Minimum value (in engineering unit) of the input raw data. 0

None

CONVMAX Integer15Optional

Maximum value (in engineering unit) of the input raw data. 0

None

CONVOFFS Integer15Optional

Offset value to add on converting input raw data. 0

None

136 9AKK101130D1382

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

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

Alarm Processing ParametersThe 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.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

ALPRI_3H Integer2Optional

3-High alarm priority number. This is the priority assigned to the tag when a 3-high alarm condition takes place. If set to 0 then the default priority is assigned.


ALPRI_2H Integer2Optional

2-High alarm priority number. This is the priority assigned to the tag when a 2-high alarm condition takes place. If set to 0 then the default priority is assigned.


9AKK101130D1382 137

ALPRI_H Integer2Optional

High alarm priority number. This is the priority assigned to the tag when a high alarm condition takes place. If set to 0 then the default priority is assigned.


ALPRI_L Integer2Optional

Low alarm priority number. This is the priority assigned to the tag when a low alarm condition takes place. If set to 0 then the default priority is assigned.


ALPRI_2L Integer2Optional

2-Low alarm priority number. This is the priority assigned to the tag when a 2-low alarm condition takes place.


ALPRI_3L Integer2Optional

3-Low alarm priority number. This is the priority assigned to the tag when a 3-low alarm condition takes place. If set to 0 then the default priority is assigned.


ALPRI_HROC Integer2Optional

High rate of change priority number. 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.


ALPRI_LROC Integer2Optional

Low rate of change priority number. 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.



NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

138 9AKK101130D1382

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

Alarm Level ParametersThe 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.

ALPRI_HDEV Integer2Optional

High deviation priority number. 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.


ALPRI_LDEV Integer2Optional

Low deviation priority number. This is the priority assigned to the tag when a low deviation alarm condition takes place.



NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

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.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

HINS_LIMIT Real15Optional

High instrument limit.This value (expressed in engineering units) defines the 100% scale of the tag. This parameter may be used instead of SPAN.

0None

SPAN Real15Optional

Instrument span. This value (expressed in engineering units) defines the range of the tag. When SPAN is used, the high instrument limit is automatically calculated as the result of VAL0 + SPAN.

0None

HI_ACTIVE Character1Optional

High instrument limit activation flag. {Y, N}NNone

140 9AKK101130D1382

HI_PROG Character1Optional

Program activation flag on high instrument alarm. If set, the application action program defined by AAP_NUM field will be activated whenever a high instrument alarm is generated.

{Y, N}NNone

H3ALARM Real15Optional

3-High alarm limit. This value (expressed in engineering units) defines the third high alarm level.See Note 1 at the end of the table.


H3_ACTIVE Character1Optional

3-High alarm limit activation flag. {Y, N}NNone

H2ALARM Real15Optional

2-High alarm limit. This value (expressed in engineering units) defines the second high alarm level.See Note 1 at the end of the table.


H2_ACTIVE Character1Optional

2-High alarm limit activation flag. {Y, N}NNone

H23_PROG Character1Optional

Program activation flag on 2 and 3-High alarm. If set, the application action program defined by AAP_NUM field will be activated whenever a 2-High alarm or 3-High alarm is generated.

{Y, N}NNone


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 141

HALARM Real15Optional

High alarm limit. This value (expressed in engineering units) defines the first high alarm level.See Note 1 at the end of the table.


H_ACTIVE Character1Optional

High alarm limit activation flag. {Y, N}NNone

H_PROG Character1Optional

Program activation flag on high alarm. If set, the application action program defined by AAP_NUM field will be activated whenever a high alarm is generated.

{Y, N}NNone

LALARM Real15Optional

Low alarm limit. This value (expressed in engineering units) defines the first low alarm level.See Note 1 at the end of the table.


L_ACTIVE Character1Optional

Low alarm limit activation flag. {Y, N}NNone

L_PROG Character1Optional

Program activation flag on low alarm. If set, the application action program defined by AAP_NUM field will be activated whenever a low alarm is generated.

{Y, N}NNone


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

142 9AKK101130D1382

L2ALARM Real15Optional

2-Low alarm limit.This value (expressed in engineering units) defines the second low alarm level.See Note 1 at the end of the table.


L2_ACTIVE Character1Optional

2-Low alarm limit activation flag. {Y, N}NNone

L3ALARM Real15Optional

3-Low alarm limit. This value (expressed in engineering units) defines the third low alarm level.See Note 1 at the end of the table.


L3_ACTIVE Character1Optional

3-Low alarm limit activation flag. {Y, N}NNone

L23_PROG Character1Optional

Program activation flag on 2 and 3-Low alarm. If set, the application action program defined by AAP_NUM field will be activated whenever a 2-Low alarm or 3-Low alarm is generated.

{Y, N}NNone

VAL0 Real15Optional

Low instrument limit. This value (expressed in engineering units) represents the 0% scale of the tag.

0None

LI_ACTIVE Character1Optional

Low instrument limit activation flag. {Y, N}NNone


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 143

LI_PROG Character1Optional

Program activation flag on low instrument alarm. If set, the application action program defined by AAP_NUM field will be activated whenever a low instrument alarm is generated.

{Y, N}NNone

HVARALMTAG Character20Optional

High variable alarm tag. Name of an analog tag whose value will be used as high alarm limit. If this field is defined, all values specified by fixed high alarm limits will be ignored.


H2VARALMTG Character20Optional

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


H3VARALMTG Character20Optional

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


H2DELTA Real15Optional

2-High variable alarm delta. 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.See Note 1 at the end of the table.



NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

144 9AKK101130D1382

H3DELTA Real15Optional

3-High variable alarm delta. 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.See Note 1 at the end of the table.


LVARALMTAG Character20Optional

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


L2VARALMTG Character20Optional

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


L3VARALMTG Character20Optional

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



NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 145



L2DELTA Real15Optional

2-Low variable alarm delta. This value (expressed in engineering units) will be subtracted from the low variable alarm tag value (if defined) to determine the 2-Low variable alarm limit. It is ignored if the L3VARALMTAG field is defined.See Note 1 at the end of the table.


L3DELTA Real15Optional

3-Low variable alarm delta. This value (expressed in engineering units) will be subtracted from the low variable alarm tag value (if defined) to determine the 3-Low variable alarm limit. It is ignored if the L3VARALMTAG field is defined.See Note 1 at the end of the table.


lowlim = VAL0


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.


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

146 9AKK101130D1382

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

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

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.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

HR_ACTIVE Character1Optional

Increasing rate of change limit activation flag.

{Y, N}NNone

HROC_LIMIT Real15Optional

Increasing rate of change limit. This value (expressed in engineering units) defines the maximum positive 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.See Note 1 at the end of the table.


HR_PROG Character1Optional

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

{Y, N}NNone

148 9AKK101130D1382

LR_ACTIVE Character1Optional

Decreasing rate of change limit activation flag.

{Y, N}NNone

LROC_LIMIT Real15Optional

Decreasing rate of change limit. This value (expressed in engineering units) defines the maximum negative change allowed for the tag value during a period of one minute. If the value is exceeded, a decreasing rate of change alarm is generated.It is usually entered as a negative number. If an accumulator must increase at a minimum rate, this value may be entered as a positive number.See Note 1 at the end of the table.


LR_PROG Character1Optional

Program activation flag on decreasing rate of change alarm. If set, the application action program defined by AAP_NUM field will be activated whenever a decreasing rate of change alarm is generated.

{Y, N}NNone

ALARMDB Real15Optional

Alarm dead-band. This value (expressed in engineering units) defines a dead-band below the high alarm limits and above the low alarm limits. A high (low) alarm will return to normal only when the value is below (above) the high (low) alarm limit minus (plus) the alarm dead-band.See Note 1 at the end of the table.



NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 149


lowlim = VAL0

LIMITDB Real15Optional

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

0None

VIOL_CD Integer1Optional

Instrument violation action code. 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: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.

{0, 1, 2}1None

VIOL_SCAN Character1Optional

Off scan flag for instrument limit violation. If set, the tag will be put off scan upon the second consecutive instrument limit violation.

{Y, N}NNone


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

150 9AKK101130D1382



Alarm Comment ParametersThe 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.


When defining the alarm dead-band be sure the value does not exceed the absolute difference between two consecutive alarm levels.

9AKK101130D1382 151

Table 39. Analog Tag – Alarm Comment Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)


Low alarm comment index. {1...100}0[mxalcm]


Low alarm comment text. <string><blank>[szalcm]


2-high alarm comment index. {1...100}0[mxalcm]


2-high alarm comment text. <string><blank>[szalcm]


2-low alarm comment index. {1...100}0[mxalcm]


2-low alarm comment text. <string><blank>[szalcm]


3-high alarm comment index. {1...100}0[mxalcm]


3-high alarm comment text. <string><blank>[szalcm]

152 9AKK101130D1382


3-low alarm comment index. {1...100}0[mxalcm]


3-low alarm comment text. <string><blank>[szalcm]


High deviation alarm comment index. {1...100}0[mxalcm]


High deviation alarm comment text. <string><blank>[szalcm]


Low deviation alarm comment index. {1...100}0[mxalcm]


Low deviation alarm comment text. <string><blank>[szalcm]


Increasing rate of change comment index.

{1...100}0[mxalcm]


Increasing rate of change comment text. <string><blank>[szalcm]


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 153

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

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

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


Decreasing rate of change comment index.

{1...100}0[mxalcm]


Decreasing rate of change comment text. <string><blank>[szalcm]


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

154 9AKK101130D1382

Table 40. Analog Tag - Totalization Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

ENELOST Integer1Optional

Lost samples management code.When 1 the lost samples management is active.

{0, 1}0None

ENEBAD Integer1Optional

Bad samples management code.When 1 the bad samples management is active.

{0, 1}0None

ENEEUINDEX Integer3Optional

Engineering unit index.This is a reference to the coding of engineering units.

{-1, 0 ...127}-1[mxeutx]

ENELOSC1M Real15Optional

Low scale value for 1 minute analog totalization. 0

None



None



None

ENELOSC1H Real15Optional

Low scale value for 1 hour analog totalization. 0

None

ENELOSC8H Real15Optional

Low scale value for 8 hours analog totalization. 0

None

9AKK101130D1382 155

ENELOSCDAY Real15Optional

Low scale value for 1 day analog totalization. 0

None

ENELOSCMON Real15Optional

Low scale value for 1 month analog totalization. 0

None

ENELOSCYEA Real15Optional

Low scale value for 1 year analog totalization. 0

None

ENEHISC1M Real15Optional

High scale value for 1 minute analog totalization. 0

None



None



None

ENEHISC1H Real15Optional

High scale value for 1 hour analog totalization. 0

None

ENEHISC8H Real15Optional

High scale value for 8 hours analog totalization. 0

None


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

156 9AKK101130D1382

ENEHISCDAY Real15Optional

High scale value for 1 day analog totalization. 0

None

ENEHISCMON Real15Optional

High scale value for 1 month analog totalization. 0

None

ENEHISCYEA Real15Optional

High scale value for 1 year analog totalization. 0

None

ENERESC1M Real15Optional

Rescale factor for 1 minute analog totalization. 0

None



None



None

ENERESC1H Real15Optional

Rescale factor for 1 hour analog totalization. 0

None

ENERESC8H Real15Optional

Rescale factor for 8 hours analog totalization. 0

None


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 157

Device Status ParametersFields of this sub-section apply to digital tags only.

Documentation ParametersThe fields in Table 41 allow linking tag conditions and documentation.


Refer to the analogue sub-section of the generic tag definition for additional fields.

ENERESCDAY Real15Optional

Rescale factor for 1 day analog totalization. 0

None

ENERESCMON Real15Optional

Rescale factor for 1 month analog totalization. 0

None

ENERESCYEA Real15Optional

Rescale factor for 1 year analog totalization. 0

None


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

158 9AKK101130D1382

Table 41. Analog Tag – Documentation Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

ALMDLA Integer5Optional

Reference to low alarm documentation

ALMDHH Integer5Optional

Reference to 2 high alarm documentation

ALMDLL Integer5Optional

Reference 2 low alarm documentation0None

ALMDSH Integer5Optional

Reference to 3 high alarm documentation0None

ALMDSL Integer5Optional

Reference 3 low alarm documentation0None

ALMDHD Integer5Optional

Reference to high deviation alarm documentation 0

None

ALMDLD Integer5Optional

Reference to low deviation alarm documentation 0

None

9AKK101130D1382 159

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

ALMDHR Integer5Optional

Reference to increasing rate of change documentation 0

None

ALMDLR Integer5Optional

Reference to decreasing rate of change documentation 0

None

Table 42. Analog Tag - Hardware Description Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

INSTR_TYPE Character8Optional

Instrument type.This field describes the electrical range of the signal and the relevant E.U. conversion type. See Appendix A for the valid instrument types.

<string><blank>None

Table 41. Analog Tag – Documentation Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

160 9AKK101130D1382

Application ParametersFields 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

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

JBOX Character6Optional

Thermocouple junction box <string><blank>None

RTD_COMP Character14Optional

Identifier of the compensation thermo-resistance for thermocouple.

<string><blank>None

Table 42. Analog Tag - Hardware Description Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

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 DefinitionTo configure alarm comments, select the entry in the alarm comment table and double-click. A data entry dialog allows entering the text.

Engineering Units

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

Table 43. Alarm Comment - Definition Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

ALARMINDEX Integer5Mandatory

Alarm comment index. {1...100}0[mxalcm]

ALARMTEXT Character80Mandatory

Alarm comment text. <string><blank>[szalcm]

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

EUDINDEX Integer3Mandatory

Engineering unit index. {1...127}0[mxeutx]

EUDTEXT Character16Mandatory

Engineering unit text. <string><blank>[sztags]

9AKK101130D1382 163

Logic State Descriptors

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


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

Text Selector

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


This section describes the structure of Text Selector Database.

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

Table 45. Logic State Descriptor - Definition Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

LSDINDEX Integer3Mandatory

Logic state descriptor index. {0...511}0[mxlstx] and [n.tagt]

LSDTEXT Character16Mandatory

Logic state descriptor text. <string><blank>[sztags]

9AKK101130D1382 165

Table 46. Text Selector - Definition Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

TEXTSINDEX Integer5Mandatory

Text selector index. {0...9999}0[mxtxts]

TEXTSTEXT Character80Mandatory

Text selector string. <string><blank>[sztxts]

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

OutlineThe 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 DatabaseThe 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 DefinitionThe 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 ParametersThe fields in Table 47 define the name and other additional parameters used to identify the alarm group.

Table 47. Alarm Groups – General Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

ALMINDEX Integer3Optional

Alarm group index. This field identifies the alarm group by number. It must be unique for each alarm group in the database. If omitted or zero (blank), the first vacant index will be allocated.

{0, 1...272}0[mxclbk]

168 9AKK101130D1382

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

ALMNAME Integer20Mandatory

Alarm group name.This must be a unique name within the alarm group database.


ALMDESC Character64Optional

Alarm group description.The description is used to identify the alarm group in the alarm group tree.


Table 47. Alarm Groups – General Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 169

Table 48. Alarm Groups – Grouping Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

ALMLEVEL Integer3Mandatory

Alarm sub-page level.It identifies the level of the sub-page hierarchy in the alarm sub-page being defined.

{0,1...99}0None

ALMLIST Character254Mandatory

Alarm list.The alarm list includes the alarm attribute to check when displaying an alarm sub-page and the list of alarm groups (sub-groups) belonging to the group.Legal alarm attributes are shown in Table 49Alarm 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.

<string><blank>None

FILENAME Character254Optional

Specification of an ASCII file containing the alarm list.See Note 1 below for an example of alarm list file definition.

<string><blank>None

Table 49. Alarm Attributes.

Attribute Description

UNACKD Unacknowledged alarms.

ALMTYP Alarm type.

ITMTYP Item type.

170 9AKK101130D1382

Note 1:Basically, there are two methods for specifying alarm lists. Either an external file or a internal alarm list can be used.

Alarm listThe 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 fileThe 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.

ALMGRP Alarm group.

ALMPRI Alarm priority.

Table 49. Alarm Attributes.

Attribute Description

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.

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

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

172 9AKK101130D1382

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

Table 50. Alarm Groups – Security Parameters.

NameFormatWidth Opt/Mnd

DescriptionRange Default Parameter(s)


Security level. This field is checked whenever an user attempts to access the alarm group. Only users whose security level is greater or equal to what's hereby defined are enabled to access the alarm group.

{0, 1...16}0None

SEC_GROUP Integer2Optional

Security group. This field is checked whenever an user attempts to access the alarm group. Only users whose security group mask includes what's hereby defined are enabled to access the alarm group.

{0, 1...32}0None

9AKK101130D1382 173

Audible Alarms

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

Table 51. Alarm Groups – Additional Parameters.



ALMSUMMTYP Integer3Optional

Alarm summary type.This field specifies a processing option type for the digital output.

0none

ALMSUMMTAG Character20Optional

Summary action tag name. This field specifies the name of a valid tag that is maintained updated with the current summary status. Typically, this field is used to specify a digital output tag that alarms external annunciators or horns.



Primary display name. This field specifies the name of a mimic display that can be associated to this alarm summary group and that can be called by acting on the corresponding alarm summary tile.

<string><blank>None

174 9AKK101130D1382

Audible Alarms DefinitionThe on-line configuration does not provide data entry for audible tones.

Table 52. Audible Alarm - Definition Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

AUDINDEX Integer3Mandatory

Audible index. {0...32}0[mxaud]

AUDCODE Integer1Mandatory

Audible code.Valid codes are0 = No sound,1 = Beep sound,2 = Wave file sound (continuous),3 = Wave file sound (single shot),4 = horn activation via RCM tag.

{0...4}0None

AUDFILE Character64Optional

Audible wave file name.It is meaningful when AUDCODE is 2 or 3.The wave file must be located within the \Config\Sound folder.


AUDRCM Character20Optional

RCM tag name. It is meaningful when AUDCODE is 4.The RCM tag must be defined within the tag database and must refer to a physical horn.


9AKK101130D1382 175

Calculation Subsystem

Calculations

OutlineThe 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 exampleAs 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 DatabaseThe 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.


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

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

Table 53. Calculation – General Parameters.



CALCINDEX Integer6Optional

Calculation block index. 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.

{0, 1...300}0[mxclbk]

CALCNAME Integer20Mandatory

Calculation block name.This field is a unique identifier of the calculation.


CALCDESC Character64Optional

Calculation block description. <string><blank>[szdesc]

CALCINACT Character1Optional

Deactivate flag. If set, the calculation block will be initially set to inactive.

{Y, N}NNone

NOSLAVE Character1Optional

Deactivate on secondary master flag. If set, the calculation block will be only executed on the primary master in a multi-master PGP architecture.

{N, Y}NNone

9AKK101130D1382 179

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

Table 54. Calculation – Log Parameters.




Print flag for operator action messages.If set, database modifications and all other operator actions concerning this calculation will be printed on alarm printer(s).

{Y, N}NNone


Print flag for information messages If set, information concerning this calculation will be printed.

{Y, N}NNone


Save flag for operator action messages.If set, information concerning this calculation will be logged to the Operator Journal file.

{Y, N}NNone


Save flag for information messages If set, information concerning this calculation will be logged to the Operator Journal file.

{Y, N}NNone

180 9AKK101130D1382

Table 55. Calculation - Frequency Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

CALCFRQ Integer5Mandatory

Calculation period.This field defines the timing of the calculation. See the CALCUNITS field also.

{1...9999}0None

CALCUNITS Integer1Mandatory

Calculation period unit.This field qualifies the CALCFREQ field assigning a time unit.See Appendix A for the allowed time units.

{0...3}0None

OFFSET Integer5Optional

Calculation offset.This field defines a delay added to the execution time of the calculation. See the OFFSUNITS field also. Calculation offset must always be less than calculation period.See Note 1 at the end of the table.

{1...9999}0None

OFFSUNITS Integer1Optional

Calculation offset unit.This field qualifies the OFFSET field assigning a time unit.See Appendix A for the allowed time units.

{0...3}0None

9AKK101130D1382 181

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

SAMPLFRQ Integer5Optional

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

{0...99999}0None

SAMPLUNITS Integer1Optional

Sampling period unit.See Appendix A for the allowed time units.

{0...3}0None

Table 55. Calculation - Frequency Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

182 9AKK101130D1382

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

Table 56. Calculation – Formula File Parameters.

Name FormatWidth Opt/Mnd

Description Range Default Parameter(s)

CALCFILE Character254Mandatory

Source file specification for the calculation block.The full path allows locating the source file anywhere. Usually source calculation files are allocated within the \PGP\Config\Calc folder.

<string><blank>None

9AKK101130D1382 183

Macro Function ParametersThe fields in Table 58 apply to macro function definition only.

Table 57. Calculation – Network Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)


Destination node mask for calculation configurations.First bit refers to node 1 in the node definition, second bit refers to node 2, and so on.



Destination node mask for calculation configurations.The mask applies to nodes from 17 to 32.



Destination node mask for calculation configurations.The mask applies to nodes from 33 to 48.



Destination node mask for calculation configurations.The mask applies to nodes from 49 to 64


Table 58. Calculation – Macro Function Parameters.



NUMPAR Integer3Optional

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

0None

184 9AKK101130D1382

Calculation Formula SyntaxA 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 SetThe 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.

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

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

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.

9AKK101130D1382 185

Tag NamesTag 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 ConstantsThe 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.

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

MacrosMacros 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

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

C like commentsAll 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 StatementsTypically 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 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.

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

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.

188 9AKK101130D1382

Operator prioritiesOperators are executed in order of priority, from highest priority to lowest. Within the same priority, operators are executed from left-to-right or right-to-left, according to the Table 59.

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

Table 59. Calculation - Operator Priorities.

Operator Priority Order

OR 1 Left to Right

AND 2 Left to Right

NOT 3 Left to Right

<, ==, >, <=, !=, >= 4 Left to Right

+, - 5 Left to Right

*, / 6 Left to Right

*, / 7 Right to Left

- (prefix) 8 Left to Right

9AKK101130D1382 189

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

Table 60. Calculation - Arithmetic Operators.

Operator Description Syntax

+ The plus (+) is the addition operator. It yields the sum of two operands.

<calc> = <ana_1> + <ana_2>

- (infix) The minus (-) is the subtraction operator. It yields the difference between two operands.

<calc> = <ana_1> - <ana_2>

- (prefix) The minus (-) is the unary operator.When used as a prefix to a single numeric operand, it yields the negative value of the number.

<calc> = - <ana_1>

* The star (*) is the multiplication operator. It yields the product of two numbers.

<calc> = <ana_1> * <ana_2>

/ The slash (/) is the division operator. It yields the quotient of the first number divided by the second number.

<calc> = <ana_1> / <ana_2>

% The percent (%) is the module operator. It yields the remainder of the division between first and the second number.

<calc> = <ana_1> % <ana_2>

^ The caret (^) is the exponential operator. It raises the first operand to the power indicated by the second operand. The second operand can be an integer or a real value.

<calc> = <ana_1> ^ <ana_2>

190 9AKK101130D1382

Table 61. Calculation - Logical Operators.


AND The AND operator returns the value 1 when both arguments are true (not equal to zero). If one argument is false (zero) it returns zero.

<calc> = <dig_1> AND <dig_2>

OR The OR operator returns the value 1 when one argument is true (not equal to zero). If both arguments are false (zero) it returns zero.

<calc> = <dig_1> OR <dig_2>

NOT The NOT operator returns the value 1 if argument is false (zero). If argument is true (not equal zero) it returns zero.

<calc> = NOT <dig_1>

9AKK101130D1382 191

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


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

( <ana_1> < <ana_2> )

== 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 result if the first operand is less than or equal to the second.

( <ana_1> <= <ana_2> )

!= 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 StructuresTwo control structures are available to calculation subsystem: IF-THEN-ELSE and WHILE-DO.

IF-THEN-ELSE The IF-THEN-ELSE structure is a compound operator. Its operands are one logical expression (the IF clause) and several expressions (the THEN and the ELSE clauses).

The processor evaluates the first (IF clause) expression. If that expression is true (not equal to zero), the expressions comprised in the THEN branch are evaluated and the expression comprised in the ELSE branch are skipped. Otherwise the expressions comprised in the THEN branch are skipped and the expressions comprised in the ELSE branch are evaluated.

The ELSE branch is optional and can be omitted. In such a case, if the IF clause is false, no expressions of the IF-THEN-ELSE structure are evaluated.

There are two formats allowed for the syntax of the IF-THEN-ELSE structure: a C like structure and a Fortran like structure. The two structures are shown in the following examples.

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)

THENexpression_1_1

expression_2_1

....

expression_N_1

ELSEexpression_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

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 WHILE-DO structures.

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.

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 FunctionsFunctions 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 FunctionsThese functions affect the algorithm execution of a calculation.

Table 63. Calculation - Execution Functions.

Function Description Syntax Eng. Unit

EXITCALC The function forces exit from the calculation block.

<calc> = EXITCALC(Input variablesEnd Variables)

9AKK101130D1382 197

Logical FunctionsThese functions perform logical calculations. They are an optimization of the basic logical operators AND and OR.

Table 64. Calculation - Logical Functions.


F_AND The function returns the value 1 when arguments are true (not equal to zero). If one argument is false (zero) it returns zero. A variable number of arguments can be passed to the function and only good quality values are taken into account.A maximum of 99 input parameters can be defined.

<digital> = F_AND(Input variables<digital_1>,<digital_2>,.......................<digital_n>End Variables)

F_OR The function returns the value 1 when one argument is true (not equal to zero). If both arguments are false (zero) it returns zero.A variable number of arguments can be passed to the function and only good quality values are taken into account.A maximum of 99 input parameters can be defined.

<digital> = F_OR(Input variables<digital_1>,<digital_2>,.......................<digital_n>End Variables)

198 9AKK101130D1382

Mathematical FunctionsThese functions perform mathematical calculations. They are typical mathematical functions.

Table 65. Calculation - Mathematical Functions.


ABS The function returns the absolute value of a number.

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

ACOS The function computes the inverse cosine (arc cosine) of an angle.

<calc> = ACOS(Input variables<angle>End Variables)

rad

ASIN The function computes the inverse sine (arc sine) of an angle.

<calc> = ASIN(Input variables<angle>End Variables)

rad

ATAN The function calculates the inverse tangent (arc tangent) of an angle.

<calc> = ATAN(Input variables<angle>End Variables)

rad

9AKK101130D1382 199

AVR The function returns the average value of n values.A maximum of 99 input parameters can be defined.

<calc> =AVR(Input variables<analog_1>,<analog_2>,.......................<analog_n>End Variables)

COS The function computes the cosine of an angle.

<calc> = COS(Input variables<angle>End Variables)

rad

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

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

INT The function returns the integer part of a real number.

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



200 9AKK101130D1382

INTERP 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.A maximum of 99 input parameters can be defined.

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

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 of a number. The base for the calculation is the value 10. The number must be positive.

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

MAX The function returns the maximum among n values.A maximum of 99 input parameters can be defined.

<calc> = MAX(Input variables<analog_1>,.......................<analog_n>End Variables)



9AKK101130D1382 201

MIN The function returns the minimum among n values.A maximum of 99 input parameters can be defined.

<calc> = MIN(Input variables<analog_1>,.......................<analog_n>End Variables)

PIGREEK The function return the value 3.14159.

<calc> = PIGREEK(Input variablesEnd Variables)

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

SIN The function computes the sine of an angle.

<calc> = SIN(Input variables<angle>End Variables)

rad

SQR The function returns the square root of the argument.

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



202 9AKK101130D1382

TAN The function returns the tangent of an angle.

<calc> = TAN(Input variables<angle>End Variables)

rad

VALMAX The function returns the maximum among n values.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.A maximum of 99 input parameters can be defined.

<calc> = VALMAX(Input variables<% validity>,<analog_1>,.......................<analog_n>End Variables)



9AKK101130D1382 203

VALMED The function returns the average among n values.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.A maximum of 99 input parameters can be defined.

<calc> = VALMED(Input variables<% validity>,<% deviation>,<analog_1>,.......................<analog_n>End Variables)

VALMIN The function returns the minimum among n values.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.A maximum of 99 input parameters can be defined.

<calc> = VALMIN(Input variables<% validity>,<analog_1>,.......................<analog_n>End Variables)



204 9AKK101130D1382

Tag FunctionsThe functions allow operating on tags and interacting with the configuration database and the realtime database.

Table 66. Calculation - Tag Functions.


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

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





FORCE_QUALITY The function forces the quality of a tag, irrespective of the quality of input tag. Value 0 forces good quality, value 1 forces bad quality.

“<tag>” = FORCE_QUALITY(Input variables“<tag>”,<digital>End Variables)

9AKK101130D1382 205

DESCR_OR 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>” = DESCR_OR(Input variables<elem_1>, ... ,<elem_n>,<qual_1>, ... ,<qual_n>End Variables)

GETINFO 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> = 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 The function saves a value of a tag as initial value to be restored later at restart time.The function returns a value 0 (with quality bad) on failure and a value 1 (with quality good) on success. The function writes the value in the realtime database also. Thus, tag assignment is not required within calculation.

<calc> = SAVEVALUE(Input variables“<tag>”,<value>End Variables)



206 9AKK101130D1382

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

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

TEST_ALARM The function checks if a tag is in an alarm condition.It returns 1 if the tag is alarmed and 0 if not.

<digital> = TEST_ALARM(Input variables“<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. It returns 0 if the tag quality is good and 1 if the quality is bad.

<digital> = TEST_QUALITY(Input variables“<tag>”End Variables)

TEST_UNACKED The function checks if the tag is to acknowledge.It returns 1 if the tag is to acknowledge and 0 if not.

<digital> = TEST_UNACKED(Input variables“<tag>”End Variables)



9AKK101130D1382 207

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

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







208 9AKK101130D1382

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


DAY The function returns the current day of the month.The value is in the range 1 to 31.

<calc> = DAY(Input variablesEnd Variables)

DAYOFWEEK The function returns the current day of the week.The value is in the range 0 to 6 and 0 refers to sunday.

<calc> = DAYOFWEEK(Input variablesEnd Variables)

DAYOFYEAR The function returns the current day of the year.The value is in the range 1 to 366.

<calc> = DAYOFYEAR(Input variablesEnd Variables)

9AKK101130D1382 209

DELTATIME The function returns the difference in seconds between two times (time1 – time2). Integer numbers represent day, month, year, hour and minute.

<calc> = DELTATIME(Input variables<day of time1>,<month of time1>,<year of time1>,<hour of time1>,<minute of time1>,<second of time1>,<day of time2>,<month of time2>,<year of time2>,<hour of time2>,<minute of time2><second of time2>End Variables)

sec

minsec

minsec

HOUR The function returns the current hour of the day.The value is in the range 0 to 23.

<calc> = HOUR(Input variablesEnd Variables)

JULSEC The function returns the number of seconds since a reference date.The reference date is assumed to be January, 1 1991.

<calc> = JULSEC(Input variablesEnd Variables)

sec

MINUTE The function returns the current minute of the hour.The value is in the range 0 to 59.

<calc> = MINUTE(Input variablesEnd Variables)

min



210 9AKK101130D1382

MONTH The function returns the current month.The value is in the range 1 to 12.

<calc> = MONTH(Input variablesEnd Variables)

SECOND The function returns the current second within the minute.The value is in the range 0 to 59.

<calc> = SECOND(Input variablesEnd Variables)

sec

WEEKOFYEAR The function returns the current week of the year.The value is in the range 1 to 52.

<calc> = WEEKOFYEAR(Input variablesEnd Variables)

YEAR The function returns the current year. <calc> = YEAR(Input variablesEnd Variables)



9AKK101130D1382 211

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


CP_at_TP The function computes the specific heat, relative to steam and water, as function of temperature and pressure.

<specific heat> = CP_at_TP(Input variables<temperature>,<pressure>End Variables)

kJ/kg/°C

°Cbar

DV_at_TP The function computes the water viscosity, relative to steam and water, as function of temperature and pressure.

<water viscosity> = DV_at_TP(Input variables<temperature>,<pressure>End Variables)

kg/s m

°Cbar

H_at_PS The function computes the enthalpy, relative to steam and water, as function of pressure and entropy.

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

kJ/kg

barkJ/kg °C

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

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

kJ/kg

°Cbar

212 9AKK101130D1382

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

<water conducibility> = K_at_TP(Input variables<temperature>,<pressure>End Variables)

W/m °C

°Cbar

P_sat_at_T Given the temperature, the function returns the pressure of saturation.

<saturation pressure> = PSAT_at_T(Input variables<temperature>End Variables)

bar

°C

S_at_PH The function computes the entropy, relative to steam and water, as function of pressure and enthalpy.

<entropy> = S_at_PH(Input variables<pressure>,<enthalpy>End Variables)

kJ/kg °C

barkJ/kg

S_at_TP The function computes the entropy, relative to steam and water, as function of temperature and pressure.

<entropy> = S_at_TP(Input variables<temperature>,<pressure>End Variables)

kJ/kg °C

°Cbar



9AKK101130D1382 213

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

<temperature> = T_at_PH(Input variables<pressure>,<enthalpy>End Variables)

°C

barkJ/kg

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>,<entropy>End Variables)

°C

barkJ/kg °C

T_sat_at_P Given the pressure, the function returns the temperature of saturation.

<saturation temp.> = TSAT_at_P(Input variables<pressure>End Variables)

°C

bar

V_at_TP The function computes the specific volume, relative to steam and water, as function of temperature and pressure.

<specific volume> = V_at_TP(Input variables<temperature>,<pressure>End Variables)

m3/kg

°Cbar



214 9AKK101130D1382

Gas Property FunctionsThe 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.


CP_GAS The function computes the specific heat of a gas as function of the temperature.The gas is defined according to the gas table. See Appendix A for the list of gas indexes.

<specific heat> = CP_GAS(Input variables<temperature>,<gas index>End Variables)

kJ/kg °C

°Cnbr

H_GAS The function computes the enthalpy of a gas as function of the temperature.The gas is defined according to the gas table. See Appendix A for the list of gas indexes.

<enthalpy> = H_GAS(Input variables<temperature>,<gas index>End Variables)

kJ/kg

°Cnbr

M_GAS The function computes the molecular weight of a gas.The gas is defined according to the gas table. See Appendix A for the list of gas indexes.

<molecular weight>= M_GAS(Input variables<gas index>End Variables)

kg/Mole

nbr

9AKK101130D1382 215

S_GAS The function computes the entropy of a gas as function of temperature and pressure.The gas is defined according to the gas table. See Appendix A for the list of gas indexes.

<entropy> = S_GAS(Input variables<temperature>,<pressure>,<gas index>End Variables)

kJ/kg °C

°Cbarnbr

V_GAS The function computes the volume of a gas as function of temperature and pressure.The gas is defined according to the gas table. See Appendix A for the list of gas indexes.

<volume> = V_GAS(Input variables<temperature>,<pressure>,<gas index>End Variables)

m3/Kg

°Cbarnbr

Table 69. Calculation - Gas Property Functions.


216 9AKK101130D1382

Sea Water FunctionsThe 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.


SEAW 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. See Table 71 for the list of allowed properties and the corresponding returned engineering unit.

<property> = SEAW(Input variables<temperature>,<salt concentration>,<function index>End Variables)

Table 71

°C%nbr

Table 71. Calculation - Sea Water Function Indexes.

Function Index Eng. Unit

Enthalpy 1 kJ/kg

Specific Heat 2 kJ/kg °C

Density 3 kg/m3

Thermal Conducibility 4 W/m °C

Dynamic Viscosity 5 kg/s m

9AKK101130D1382 217

Fuel Combustion FunctionsThe 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.


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

<specific heat> = CP_FGAS_T(Input variables<temperature>,<index>,<carbon bi-oxide>,<oxygen>,<carbon oxide>,<sulphur bi-oxide>,<water>,<argon>End Variables)

kJ/kg °C

°Cnbr%%%% %%

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> = H_FGAS_T(Input variables<temperature>,<index>,<carbon bi-oxide>,<oxygen>,<carbon oxide>,<sulphur bi-oxide>,<water>,<argon>End Variables)

kJ/kg

°Cnbr%%%%%%

9AKK101130D1382 219

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

<entropy> = S_FGAS_TP(Input variables<temperature>,<index>,<pressure>,<carbon bi-oxide>,<oxygen>,<carbon oxide>,<sulphur bi-oxide>,<water>,<argon>End Variables)

kJ/kg °C

°Cbarnbr%%%% %%



220 9AKK101130D1382

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

<temperature> = T_FGAS_H(Input variables<enthalpy>,<index>,<carbon bi-oxide>,<oxygen>,<carbon oxide>,<sulphur bi-oxide>,<water>,<argon>End Variables)

°C

kJ/kgnbr%%%% %%

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>,<entropy>,<index>,<carbon bi-oxide>,<oxygen>,<carbon oxide>,<sulphur bi-oxide>,<water>,<argon>End Variables)

°C

barkJ/kg °Cnbr%%%% %%



9AKK101130D1382 221

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


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

<air in fuel>= AIR_MIN(Input variables<carbon>,<hydrogen>,<sulphur>,<oxygen>End Variables)

kg/kg

%%%%

CP_FCOMB_T The function computes the specific heat of air and fuel as function of the temperature and the fuel composition.

<specific heat> = CP_FCOMB_T(Input variables<temperature>,<carbon>,<hydrogen>,<sulphur>,<oxygen>,<nitron>,<dry air/fuel>End Variables)

kJ/kg °C

°C%%%%%kg/kg

222 9AKK101130D1382

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

<enthalpy> = H_FCOMB_T(Input variables<temperature>,<carbon>,<hydrogen>,<sulphur>,<oxygen>,<nitron>,<dry air/fuel>End Variables)

kJ/kg

°C%%%%%kg/kg

S_FCOMB_TP The function computes the entropy of air and fuel as function of the temperature and the fuel composition.

<entropy> = S_FCOMB_TP(Input variables<temperature>,<pressure>,<carbon>,<hydrogen>,<sulphur>,<oxygen>,<nitron>,<dry air/fuel>End Variables)

kJ/kg °C

°Cbar%%%%%kg/kg



9AKK101130D1382 223

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

<temperature> = T_FCOMB_H(Input variables<enthalpy>,<carbon>,<hydrogen>,<sulphur>,<oxygen>,<nitron>,<dry air/fuel>End Variables)

°C

kJ/kg%%%%%kg/kg

T_FCOMB_PS The function computes the temperature of air and fuel as function of the pressure, entropy and the fuel composition.

<temperature> =T_FCOMB_PS(Input variables<pressure>,<entropy>,<carbon>,<hydrogen>,<sulphur>,<oxygen>,<nitron>,<dry air/fuel>End Variables)

°C

barkJ/kg °C%%%%%kg/kg



224 9AKK101130D1382

Wet Air FunctionsThe 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.


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

<specific heat> = CP_AIR_T(Input variables<temperature>,<absolute humidity>End Variables)

kJ/kg °C

°Ckg/kg

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. The usual enthalpy for air conditioning applications (psychrometric chart) can be obtained as follows:Hhum=(1+X)*H_AIR_T(T,X) + 2501.7*Xexpressed in kJ/kg dry air. In the above formula X represent the absolute humidity and T the temperature.

<enthalpy> = H_AIR_T(Input variables<temperature>,<absolute humidity>End Variables)

kJ/kg

°Ckg/kg

226 9AKK101130D1382

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

<entropy> = S_AIR_TP(Input variables<temperature>,<pressure>,<absolute humidity>End Variables)

kJ/kg °C

°Cbarkg/kg

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>,<absolute humidity>End Variables)

°C

kJ/kgkg/kg

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>,<entropy>,<absolute humidity>End Variables)

°C

barkJ/kg °Ckg/kg

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.The temperature is assumed to be in the range –10 to 50 °C and pressure in the range 0.9 to 1.2 bar.

<humidity> = WHY(Input variables<dry bulb temp.>,<atmospheric press.>,<relative humidity>End Variables)

%

°Cbar%

Table 74. Calculation - Wet Air Functions.


9AKK101130D1382 227

Data File FunctionsThe 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.


READFILE The function read data from a specified word of a record in a file.See Table 76 for the list of allowed formats.

<calc> = READFILE(Input variables<file name>,<record number>,<word number>,<format>End Variables)

WRITEFILE The function writes data to a specified word of a record in a file. The value to be written is an parameter to the function.See Table 76 for the list of allowed formats.

<calc> = WRITEFILE(Input variables<file name>,<record number>,<word number>,<format>,<value>End Variables)

Table 76. Read/Write File Formats.

Number Description

1 BYTE

2 USHORT

3 SHORT

228 9AKK101130D1382

4 UINT

5 INT

6 FLOAT

7 DOUBLE

Table 76. Read/Write File Formats.

Number Description

9AKK101130D1382 229

Historical FunctionsHistorical 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 Description Syntax

COUNTER Up/down counter.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.When the reset flag is set to 1, the counter is set to the initial value.

<calc> = COUNTER(Input variables“<pv_tag>”,<threshold value>,<increment value>,<reset flag>,<initial value>,3End Variables)

DELAY Delay.The function returns the previous value of the input.When the reset flag is set to 1, the function returns the current value of the input.

<calc> = DELAY (Input variables“<tag>”,<reset flag>,2End Variables)

230 9AKK101130D1382

DERIV Derivative.The function returns the derivative of last 4 sampled values according to the following simplified (based on 4 samples) formula: Vn = ((-3*V3)-V2+V1+(3*Vi))/10*dtwhere:V3 - 3rd previously sampled value,V2 - 2nd previously sampled value,V1 - previous sampled value,Vi - current sampled value.dt - sampling time.

<calc> = DERIV (Input variables“<pv_tag>”,4End Variables)

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

<calc> =EVENTTIME(Input variables“<tag>”,<value>End Variables)

FILT Filter.The function returns a filtered value according to the following formula: Vn = Vn1*(tau/(dt+tau)+Vi(dt/(dt+tau)where: Vn1 - previous FILT calculated value,Vi - current sampled value,dt - sampling time.tau - time constant.When the reset flag is set to 1, the function is set to the initial value.

<calc> = FILT (Input variables“<pv_tag>”,<time constant>,<reset flag>,<initial value>3End Variables)



9AKK101130D1382 231

GRAD Gradient.The function returns the gradient of two sampled values according to the following formula: Vn = (Vi - V1) / dt where:V1 - previous sampled value,Vi - current sampled value.dt - sampling time.

<calc> = GRAD (Input variables“<pv_tag>”,2End Variables)

H_AVR Historical average.The function returns the average of last sampled values.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.Bad samples are discharged if the discharge flag is set to 0. Elsewhere, they are taken into account in computing the average.

<calc> = H_AVR GRAD (Input variables“<pv_tag>”,<min. % good>,<discharge bad flag>,<number of samples>End Variables)



232 9AKK101130D1382

H_MAX Historical maximum.The function returns the maximum of last sampled values.If the percentage of samples with a good quality is greater than the minimum percentage, the quality of maximum is set to good. Elsewhere, the quality is set to bad.Bad samples are discharged if the discharge flag is set to 0. Elsewhere, they are taken into account in computing the maximum.

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

H_MIN Historical minimum.The function returns the minimum of last sampled values.If the percentage of samples with a good quality is greater than the minimum percentage, the quality of minimum is set to good. Elsewhere, the quality is set to bad.Bad samples are discharged if the discharge flag is set to 0. Elsewhere, they are taken into account in computing the minimum.

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



9AKK101130D1382 233

H_SUM Historical sum.The function returns the sum of last sampled values.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.Bad samples are discharged if the discharge flag is set to 0. Elsewhere, they are taken into account in computing the sum.

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

INTEG Integral.The function returns the integral of last sampled values according to the following formula: Vn = Vn1 + (Vi * dt) where:Vn1 - previous INTEG calculated value.Vi - current sampled value.dt - sampling time.When the reset flag is set to 1, the function is set to the initial value.

<calc> = INTEG (Input variables“<pv_tag>”,<reset flag>,<initial value>,3End Variables)



234 9AKK101130D1382

HIST_VAL Historical value.The function returns the value of the tag within an historical group at a defined time.A negative offset refers to the preceding sample with respect to the sample identified by the time.A positive offset refers to the next sample.A null offset refers to the sample identified by the time.

<calc> = HIST_VAL (Input variables“<hist group name>”,“<tag>”,<day>,<month>,<year>,<hour>,<minute>,<second>,<offset>End Variables)

minsec

HIST_WRT Write Historical value.The function writes the value of the tag within an historical group for the defined time.A negative offset refers to the preceding sample with respect to the sample identified by the time.A positive offset refers to the next sample.A null offset refers to the sample identified by the time.

<calc> = HIST_WRT (Input variables<hist group name>,“<tag>”,<day>,<month>,<year>,<hour>,<minute>,<second>,<offset>,<value>End Variables)

minsec



9AKK101130D1382 235

HIST_REGR Historical regression. <calc> = HIST_REGR(Input variables<hist group name>,“<tag>”,“<filter tag>”,<filter high value>,<Filter low value>,<day>,<month>,<year>,<hour>,<minute>,<second>,<offset value>,<offset time unit>,<number of samples>,<analisys interval>,<interval time unit>,<min. % good>,<discharge bad flag>,<angle coeff>,<const coeff>,<error on angle coeff>,<error on const coeff>,<standard error>End Variables)

minsec



236 9AKK101130D1382

SDEV Standard deviation.The function returns the standard deviation value of last sampled values.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.Bad samples are discharged if the discharge flag is set to 0. Elsewhere, they are taken into account in computing the standard deviation.

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

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

<calc> = TIMER (Input variables“<pv_tag>”,<timing code>,<delay>,2End Variables)

sec

NUM_ALARM Number of alarms in an alarm group.The function returns the number of alarms within an alarm group at the requested time.If “unacked flag” not equal 0, returns the number of alarms to acknowledge.

<calc> = NUM_ALARM (Input variables<alarm group number>,<unacked flag>End Variables)



9AKK101130D1382 237

Trend Group Subsystem

Trend Groups

OutlinePGP 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 GroupsThe 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 DatabaseThe 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 DefinitionThe 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 ParametersThe 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.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

GROUPINDEX Integer6Optional

Group index. This field identifies the group by number. It must be unique for each trend group in the database. If omitted or zero (blank), the first vacant index will be allocated.

{0, 1...100}0[mxhgrp]

GROUPNAME Character20Mandatory

Group name.This field identifies the group by name. It must be unique for each trend group in the database.


GROUPUID Character36Optional

Trend group unique identification. This field provides a unique identification within the PGP life cycle.See Note 1 at the end of the table.

<string><blank>None

GROUPDESC Character64Optional

Group description. <string><blank>[szdesc]

240 9AKK101130D1382

EUINDEX Integer3Optional

Engineering unit index. This field defines the index into the engineering unit database. It can be used to assign a unique engineering unit to the group. It supersedes the engineering units of the tags belonging to the group.The field is not included within the fields of the on-line configuration Tab.

{-1, 0 ...127}-1[mxeutx]


Engineering unit text. 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.

<string><blank>None

GROUPCLASS Integer3Optional

Class of trend group.Customer may class trend groups using this field.

0None

ARCHTYPE Character7Mandatory

Type of archiving.This parameter qualifies the trend group. Depending on the type, the set of parameters required to fully configuring the group changes. See the Table 79 for the list of all archiving types.

<string><blank>None

EXP_VAL Character1Optional

Relational database update (tag values) flag. If set, tag values will be automatically sent to the relational database.

{Y, N}NNone


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

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

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.

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.

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

Display ParametersThe fields in Table 80 define some displaying parameters of the trend group.

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.

Table 80. Generic Trend Group – Display Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

TIMESPAN Integer5Optional

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.The value must be grather than 10 seconds for realtime trend groups and greather than the archive frequency for historical trend groups.

0None

SPANUNITS Integer1Optional

Time units to qualify time span field.See Appendix A for allowed time units.

{0...5}0None

Table 79. Trend Group - Archiving Types.

Type Description Kind

9AKK101130D1382 243

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

DISPFRQ Integer5Optional

Default list display frequency.It is the time interval between two consecutive values when a trend group is displayed as a table (discrete values).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.

0None

DISPUNITS Integer1Optional

Time units to qualify display frequency field.See Appendix A for allowed time units.

{0...5}0None

CURVETYPE Integer1Optional

Kind of representation for the trend curves.Allowed values are:0 - default (interpolation),1 - step,2 - interpolation.

{0,1,2}0None

Table 80. Generic Trend Group – Display Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

244 9AKK101130D1382

Table 81. Generic Trend Group – Link Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)


Primary display reference. Name of a graphic display associated to the group.

<string><blank>None

FWDNAME Character20Optional

Forward link among trend groups.This field defines the name of another group chained as following to the current one.


BWDNAME Character20Optional

Backward link among trend groups.This field defines the name of another group chained as previous to the current one.


ESCNAME Character20Optional

Escape page name.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.


ENTNAME Character20Optional

Menu page name.This field defines the name of an menu display.


9AKK101130D1382 245

Log ParametersThe fields in Table 82 allow defining logs for operator actions and generic information.


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)


Print flag for operator action messages.If set, database modifications and all other operator actions concerning this group will be printed on the alarm printer(s).

{Y, N}NNone


Print flag for information messages If set, information concerning this group will be printed on the alarm printer(s).

{Y, N}NNone


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

{Y, N}NNone


Save flag for information messages If set, information concerning this group will be logged to Operator Journal.

{Y, N}NNone

246 9AKK101130D1382

Tag List ParametersThe fields in Table 83 define the basic information to identify tags belonging to the trend group.

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.

Table 83. Generic Trend Group - Tag List Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

TAGFILE Character254Optional

Specification of an ASCII file containing the tag list.See Note 1 at the end of the table for details.

<string><blank>

TAGLIST Character254Optional

List of tags belonging to the trend group.See Note 1 at the end of the table for details.

<string><blank>None

NUMTAGS Integer3Optional

Number of tags defined in the trend group.If not specified, it is assumed to be the total number of tags in the group as found in the tag list or tag file (see next fields). If specified, it must be greater or equal to the total number of defined tags. If greater, it keeps space allocated to allow adding tags later on without collected historical data are lost (i.e. the group initialization is not required).The field is not included within the fileds of the on-line configuration Tab.

{0...60}0[grptag]

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


Table 84. Generic Trend Group - Network Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)


Destination node mask for trend group configurations.First bit refers to node 1 in the node definition, second bit refers to node 2, and so on.



Destination node mask for trend group configurations.The mask applies to nodes from 17 to 32.



Destination node mask for trend group configurations.The mask applies to nodes from 33 to 48.



Destination node mask for trend group configurations.The mask applies to nodes from 49 to 64


DESTVALMSK Character16Optional

Destination node mask for tag values of trend group.Tag values of group are routed from the 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.


250 9AKK101130D1382

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

Historic Group DefinitionHistoric 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.


Destination node mask for tag values of trend group.The mask applies to nodes from 17 to 32.








Table 84. Generic Trend Group - Network Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 251

History ParametersThe parameters listed in Table 85 allow defining archive and size of an historical trend group.

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

ARCHFRQ Integer5Mandatory

Archiving frequency.The value defines the time interval between two consecutive values stored in a historical group. Data are processed and archived with the frequency defined bu this field.It applies to historical trend groups only.

0None

ARCHUNITS Integer1Mandatory

Time units to qualify archiving frequency field.See Appendix A for the allowed time units.

{0...5}0None


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

0None


Time units to qualify offset field.See the Appendix A for the allowed time units.

{0...5}0None

252 9AKK101130D1382

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.

TOTSAMPLES Integer9Mandatory

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

0None

ARCHINHTAG Character20Optional

Archiving inhibit tag name.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.


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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 253

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.

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

SAMPLFRQ Integer5Mandatory

Sampling frequency.The value is the time interval between two consecutive samples gathered to store a computed value in a trend group file.This field applies when the historical trend group needs to collect samples in order to store processed data (e.g average value). The value must be less than archiving frequency.

0None

SAMPLUNITS Integer1Mandatory

Time units to qualify sampling frequency field.See Appendix A for the allowed time units.

{0...5}0None

BADSAMPLES Integer2Optional

Percent of allowed bad samples.If greater than 0, a datum to be archived is marked bad when the percentage of bad samples among collected samples is greater than the defined percent value.

{0...99}0None

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.

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

DERIVED Character1Optional

Derived group flag.This flag states the current group is a derived one. Another group defined by the field below is the source of information.

{Y,N}NNone

INPGROUP Character20Optional

Name of the input group.If the derived group flag is set, this field specifies the name of the source group.


9AKK101130D1382 255

Time Function ParametersThe 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.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

MONVALUE Character1Optional

Monitor flag for value of tags.If the flag is set, the value of each tag is monitored and compared to threshold limits. For a MONITOR or RATIO group, the historical group subsystem archives the absolute or relative time (within the archive frequency) the tag assumes a value within the threshold limits. For a COUNT group, the number of times the value of a tag enters within the threshold limits is archived.

{Y, N}NNone

MONQUALITY Character1Optional

Monitor flag for quality of tags.If the flag is set, the quality of each tag is monitored and compared to the quality mask. For a MONITOR or RATIO group, the historical group subsystem archives the absolute or relative time (within the archive frequency) the tag assumes a quality matching the quality mask. For a COUNT group, the number of times the quality of a tag matches the quality mask is archived.

{Y, N}NNone

256 9AKK101130D1382

Post Trip Trend GroupPost 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.

MONREVERSE Character1Optional

Reverse monitoring flag.Reverse the counting or monitoring rules defined by the couple of fields above. Values or qualities outside threshold limits are considered.

{Y, N}NNone

MONUNITS Integer1Optional

Time units for monitoring.This field defines the interval used as time basis for monitoring evaluation.See the Appendix A for the allowed time units.

{0...5}0None

MONFACT Integer2Optional

Monitor factor.This field applies to RATIO groups only.

{1, 10, 100, 1000}1None

TARGETLOW Integer10Optional

Low threshold limit for value monitoring. 0None

TARGETHIGH Integer10Optional

High threshold limit for value monitoring. 0None

TARGETQUAL Character32Optional

Bit mask for quality monitoring.This bit mask must match the bit mask organization of quality bits (see Appendix A for the quality bit structure).

Sequence {0, 1}<blank>None

Table 88. Historic Trend Group - Time Function Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 257

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

PRETIME Integer5Optional

Pre trip time.It defines the amount of time to be taken into account before trip. Exception reports found in this time interval are retrieved from playback and archived as post trip data.

{0...99999}0None

PREUNITS Integer1Optional

Time units to qualify pre trip time field.See Appendix A for the allowed time units.

{0...5}0None

POSTTIME Integer5Optional

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

{0...99999}0None

POSTUNITS Integer1Optional

Time units to qualify post trip time field.See Appendix A for the allowed time units.

{0...5}0None

258 9AKK101130D1382

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.

TRIPCOUNT Character20Optional

Trip counter tag name.The tag defined here keeps track of trips. Each time a trip takes place, the counter increments.


TRIPCLOS Character1Optional

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

{Y,N}NNone

Table 89. Historic Trend Group - Trip Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 259

Report Subsystem

Report

OutlinePGP 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 DatabaseThe 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 DefinitionThe 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 ParametersThe 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 sub-sections following this one.

Table 90. Report - General Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

REPINDEX Integer6Optional

Report index. This field identifies the report by number. It must be unique for each report in the database. If omitted or zero (blank), the first vacant index will be allocated.

{0...50}0[nmrpts]

REPNAME Character20Mandatory

Report name.This field identifies the report by name. It must be unique for each report in the database.


REPDESC Character64Mandatory

Report description. <string><blank>[szdesc]

REPINHTAG Character20Optional

Report inhibit tag name.Name of a tag that, while in alarm, will disable the generation of the report. If the field is blank, no report inhibit is defined.


262 9AKK101130D1382

Activation ParametersThe fields in Table 91 define scheduling or activation parameters used to generate the report.

Table 91. Report - Activation Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

SCHDFRQ Integer5Optional

Schedule frequency.If greater than 0, the field allows automatically generating a report.The minimum allowed value is 1 minute (SCHDFRQ=1 and SCHDUNITS=1).A value of 1 second (SCHDFRQ=1 and SCHDUNITS=0) means no automatic scheduling and may be used when defining a manually activated or a scheduled on event report.

{1...99999}0None

SCHDUNITS Integer1Optional

Time unit to qualify scheduling frequency.See Appendix A for the allowed time units.

{0...3}0None


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

{0...99999}0None

9AKK101130D1382 263

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


Time unit to qualify report offset.See Appendix A for the allowed time units.

{0...3}0None

ACTONEVENT Character1Optional

Activate report flag on event.The tag whose REP_NUM field refers to this report will activate reporting. If set, the field makes the report eligible for activation when the activating tag goes in an alarm condition.

{Y,N}NNone

Table 91. Report - Activation Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

264 9AKK101130D1382

Table 92. Report - Archiving Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

ARCHIVE Character1Optional

Disk archiving flag. 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.

{Y,N}YNone

MAXLATENCY Integer5Optional

Maximum latency time (days).Reports older than the latency days are deleted from the hard disk.

0None

MAXREPORTS Integer4Optional

Maximum number of reports.The oldest reports exceeding the allowed maximum are deleted from the hard disk.

0None

SAVEHTM Character1Optional

Html file archiving flag. If set, the report is saved in a html format file.

{Y,N}YNone

9AKK101130D1382 265

Printing ParametersThe fields in Table 93 define the parameters involved in printing the report.

Table 93. Report - Printing Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

PRINT Character1Optional

Print flag.When a report is generated from its template, it is printed on the documentation printer.

{Y,N}NNone

PRINTER Character20Optional

Printer name.Name of the documentation printer.


266 9AKK101130D1382

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

XLSDATCELL Character10Optional

Date cell reference.The field is a reference to a cell within the Excel template file. The syntax is n!Am 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).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.

<string><blank>None

9AKK101130D1382 267

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

XLSFILE Character64Mandatory

Excel work-sheet file name.The field refers to the Excel template file where the structure of the report is implemented.The Excel work-sheet must be located within the \PGP\Config\Reports folder.


XLSSHEET Integer2Mandatory

Excel sheet index.A Excel work-sheet (report template) may contain multiple sheets. From the reporting point of view each sheet must be referenced as a report. In other words, a report must exist for each sheet. Instead, a multiple page work-sheet is considered as a single report.

{1...99)0None

Table 94. Report - Excel Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

268 9AKK101130D1382

Excel Work-SheetA 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 FunctionsA 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] <parameter n>,

Table 95. Report - SOE Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

SOETYPE Integer1Optional

Type of sequence of events.The value of this field can be0 - Standard SOE1 - Summary SOE

{0, 1}0None

SOEDEVICE Integer2Optional

Sequence of event device.Number of the SER device generating the sequence of events.

{0, 1, 2}0[mxsedv]

9AKK101130D1382 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 FunctionsThe 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 functionsA 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.


BLKDEALLOC The function de-allocates data structures previously allocated for data retrieving from historical archives or playback. The subroutine can be called from VBA Excel code only.

BLKDEALLOC(Input variablesEnd Variables)

FPBLKQUAL The function returns the quality mask of a tag of a historical group.On error, a null quality is returned.

[<long> =]FPBLKQUAL(Input variables<group name>,<tag name>,<retrieving time>End Variables)

FPBLKQUALTIME The function retrieves the quality of a tag from a data packet (as returned by the Fpblksample function) of an historical group.On error, a null quality is returned.

[<long> =] FPBLKQUALTIME(Input variables<retrieving time>End Variables)

9AKK101130D1382 271

FPBLKSAMPLE The function returns a data packet of a tag within a historical group.The returned value, the number of found records, can be used by the Fpblkqualtime, Fpblkvaldtime and Fpfromblkvald functions.Depending on the sign of the number of records different searches are performed:> 0 - The function searches forward beginning from start time,= 0 - The function retrieves all records within the time interval,< 0 - The function searches backward beginning from the end time.If the absolute value is not null, only the first <number of records> (or less) are returned.

[<long> =] FPBLKSAMPLE(Input variables<group name>,<tag name>,<start time>,<end time>,<number of records>End Variables)

FPBLKVALD The function retrieves the value of a tag within a historical group.On error, a null value is returned.

[<double> =] FPBLKVALD(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.On error, null value is returned.

[<double> =] FPBLKVALDTIME(Input variables<retrieving time>End Variables)



272 9AKK101130D1382

FPFROMBLKVALD The function retrieves the value of a tag from a data packet (as returned by Fpblksample function) of an historical group.The record index is a number from 1 to N where N is the number of records returned by the Fpblksample function.On error, a null value is returned.

[<double> =] FPFROMBLKVALD(Input variables<record index>End Variables)

FPGET The function retrieves a tag value from the realtime database.On error, a null value is returned.See Note 1 at the end of table.

[<string> =] FPGET(Input variables<tag name>,<force recalculation>End Variables)

FPGETD The function retrieves a tag value from the realtime database.On error, a null value is returned.See Note 1 at the end of table.

[<double> =] FPGETD(Input variables<tag name>,<force recalculation>End Variables)

FPHGETD The function retrieves the value of a tag from the playback archive.On error, a null value is returned.

[<double> =] FPHGETD(Input variables<tag name>,<retrieving time>End Variables)



9AKK101130D1382 273

FPHXGETVAL The function retrieves the value of a tag from a data packet (as returned by Fphxnumval function) of the playback archive.The record index is a number from 1 to N where N is the number of records returned by the Fphxnumval function.The record type is represented by a characterd - Return a double precision value,s - Return a string format valuet - Return the time (in string format) when the value was collected.

[<double/string/date> =] FPHXGETVAL(Input variables<record index>,<returned type>End Variables)

FPHXNUMVAL The function retrieves records of a tag within the playback archive.The returned value, the number of found records, may be used by the Fphxgetval function.Depending on the sign of the number of records different searches are performed:> 0 - The function searches forward beginning from start time,= 0 - The function retrieves all records within the time interval,< 0 - The function searches backward beginning from the end time.If the absolute value is not null, only the first <number of records> (or less) are returned.

[<long> =] FPHXNUMVAL(Input variables<tag name>,<start time>,<end time>,<number of records>End Variables)



274 9AKK101130D1382

GETAPMSTIME The function translates a standard date and time in the internal PGP format. The date and time is a string in the format DD/MM/YY hh:mm:ss.The returned value, in the internal PGP date and time format, is the number of seconds since January 1, 1991.

[<long> =] GETAPMSTIME(Input variables<date and time>End Variables)

GETDATEFROMSEC The function translates a PGP date and time in the Excel date and time format.The input parameter, in the internal PGP date and time format, is the number of seconds since January 1, 1991.If the input parameter is not defined, the 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.

[<string> =] GETDATEFROMSEC(Input variables<PGP date and time>,<force recalculation>End Variables)

GETSECFROMDATE The function translates the current date and time or the date entered for manual forced reporting in the PGP format. The input date is defined by a reference to a cell in the work-sheet.If defined, the input parameter references a cell in the work-sheet representing a date and time in the Excel format.If the input parameter is not defined, the current date and time is converted.The returned date and time is formatted according to the format of the cell containing the function reference.See Note 1 at the end of table.

[<long> =] GETSECFROMDATE(Input variables<Xls date cell><force recalculation>End Variables)



9AKK101130D1382 275

Note 1:

TAGINFO The function retrieves tag information from the configuration database based on a info type parameter. On error, a null info is returned.See the table TagInfo Types within the Section 1 of the PGP Application Program Interface manual for a list of tag information codes.See Note 1 at the end of table.

[<string> =] TAGINFO(Input variables<tag name>,<tag info>,<force recalculation>End Variables)

TAGREAD The function retrieves the tag value from the realtime database.On error, a null value is returned.See Note 1 at the end of table.

[<double> =] TAGREAD(Input variables<tag name>,<force recalculation>End Variables)

TAGREADBINARY The function retrieves the tag value from the realtime database.On error, a null value is returned.See Note 1 at the end of table.

[<binary string> =] TAGREADBINARY(Input variables<tag name>,<force recalculation>End Variables)

TAGREADVAL The function retrieves the tag value from the realtime database.On error, a null value is returned.See Note 1 at the end of table.

[<double> =] TAGREADBINARY(Input variables<tag name>,<force recalculation>End Variables)



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 FunctionsSteam functions of calculations can be used and referenced within Excel work-sheets. They are listed in Table 97.

Table 97. Report - Steam Functions.


CP_at_TP Specific heat as function of temperature and pressure.

[<specific heat> =] CP_at_TP(Input variables<temperature>,<pressure>End Variables)

DV_at_TP Water viscosity as function of temperature and pressure.

[<viscosity> =] DV_at_TP(Input variables<temperature>,<pressure>End Variables)

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

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

9AKK101130D1382 277

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

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

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

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


CP_GAS Specific heat of a gas as function of the temperature.

[<specific heat> =] CP_GAS(Input variables<temperature>,<gas index>End Variables)

H_GAS Enthalpy of a gas as function of the temperature.

[<enthalpy> =] H_GAS(Input variables<temperature>,<gas index>End Variables)

M_GAS Molecular weight of a gas. [<molecular weight> =] M_GAS(Input variables<gas index>End Variables)

S_GAS Entropy of a gas as function of temperature and pressure.

[<entropy> =] S_GAS(Input variables<temperature>,<pressure>,<gas index>End Variables)

280 9AKK101130D1382

Sea Water FunctionsSea 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.


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

[<property> =] SEAW(Input variables<temperature>,<salt concentration>,<function index>End Variables)

9AKK101130D1382 281

Fuel Combustion FunctionsFuel 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.


CP_FGAS_T Specific heat of flue gas as function of the temperature and the flue gas composition.

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

S_FGAS_TP Entropy of flue gas as function of the temperature, the pressure and the flue gas composition.

[<entropy> =]S_FGAS_TP(Input variables<temperature>,<pressure>,<gas index>,<% CO2>,<% O2>,<% CO>,<% SO2>,<% H2O>,<% AR>End Variables)



9AKK101130D1382 283

T_FGAS_H Temperature of flue gas as function of the enthalpy and the flue gas composition.

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


AIR_MIN Stechiometric air in the fuel as function of the fuel composition.

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

CP_FCOMB_T Specific heat of air and fuel as function of the temperature and the fuel composition.

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

T_FCOMB_H Temperature of air and fuel as function of the enthalpy and the fuel composition.

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


CP_AIR_T Specific heat of wet air as function of the temperature and absolute humidity.

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

T_AIR_H Temperature of wet air as function of the enthalpy and absolute humidity.

[<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 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.>,<atmospheric press.>,<relative humidity>End Variables)

Table 102. Report - Wet Air Functions.


9AKK101130D1382 289

Pegboard Subsystem

OutlinePGP 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 DatabaseThe 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 DefinitionThe following sections list the parameters to characterize all kind of pegboards. There are both mandatory and optional parameters.

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

PAGEINDEX Integer6Optional

Pegboard page index. This field identifies the pegboard by number. It must be unique for each pegboard in the database. If omitted or zero (blank), the first vacant index will be allocated.

{0, 1...100}0[nmopds]

PAGENAME Character20Mandatory

Pegboard name.This field identifies the pegboard by name. It must be unique for each pegboard in the database.


PAGEDESC Character64Optional

Pegboard description. <string><blank>[szdesc]

9AKK101130D1382 291

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

FWDNAME Character20Optional

Forward link among pegboards.It is the name of another pegboard chained as next to the current one.


BWDNAME Character20Optional

Backward link among pegboards.It is the name of another pegboard chained as previous to the current one.


ESCNAME Character20Optional

Escape page name.It is the name of an escape display. Typically it is the name of a mimic.


ENTNAME Character20Optional

Menu page name.It is the name of an menu display.


292 9AKK101130D1382

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

POP01TYPE Integer1Optional

Type of the first popup.See Table 106 for allowed popup types.See Notes 1 and 2 at the of the table.

{0...3}0None

POP01TAG Character20Optional

Tag name of the first popup. <string><blank>[sznam]

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

POP32TYPE Integer1Optional

Type of the 32-nd popup.See Table 106 for allowed popup types.See Notes 1 and 2 at the of the table.

{0...3}0None

POP32TAG Character20Optional

Tag name of the 32-nd popup. <string><blank>[sznam]

Table 106. Pegboard - Popup Types.

Type Description Buckets

0 Undefined 0

1 Normal 2

9AKK101130D1382 293

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.

2 Large 4

3 Small 1

Table 106. Pegboard - Popup Types.

Type Description Buckets

294 9AKK101130D1382

Operator Station Subsystem

Menu and Tool-bars

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


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 DefinitionThe following sections list parameters to customize menu and tool-bar. There are both mandatory and optional parameters.

9AKK101130D1382 295

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

MENUINDEX Integer5Optional

Item number.This is a unique number to identify each menu and tool-bar item.It must be unique for each item within database. If omitted or zero (blank), the first vacant index will be allocated.

{1...100}

[n.menu]

MENULABEL Character64Mandatory

Item description.If the item is a icon, this field is the tool-tip text. If the item is a menu element, this field is the text of the element. If the item is a leaf of a display tree, this field is the text of the leaf.


BUTTONTYPE Character9Mandatory

Item type.The field identifies the item to be an element of a menu, a tool-bar (button) or a display tree. Allowed item types are listed in Table 108

See Table 108

None

296 9AKK101130D1382

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

Table 109. Menu and Tool-bar - Action Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

BUTTONACT Character9Mandatory

Associated kind of action. The field identifies the action to be performed upon item selection. Allowed values are listed in Table 110

See Table 110

None

9AKK101130D1382 297

MENUPGM Character9Optional

Program name.The field is the name of the program to activate when the menu or tool-bar item is selected. It is valid only if the action is program activation.

<string><blank>None

MENUCMDLIN Character128Optional

Program parameter.This field is a parameter (if any) to be passed to the program at activation time.Standard command lines are listed in Table 111

<string><blank>None

Table 110. Menu and Tool-bar - Action Types.

Action Type Description

NONE None to do.This field defines a root or sub-root of a menu or display tree.

ALMDIS Alarm page displaying. This field allows displaying an alarm page given the alarm group (to be defined in the Command Line field).

PROGRAM Program activation.This field allows activating a program (the name must be defined in the Program Name field).

DISPLAY Mimic displaying. This field allows displaying a mimic (the name must be defined in the Command Line field).

Table 109. Menu and Tool-bar - Action Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

298 9AKK101130D1382

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 Command Line Description

ALMDIS <alarm group> The alarm page of the alarm group defined in the command line is displayed.

ALMDIS ICISTA - 100 The ICI status diagnostic function is activated.

BROWSER <HTML page> The local HTML page is displayed.

BROWSER <www address> The home page of the Internet address defined in the command line is displayed.

Table 110. Menu and Tool-bar - Action Types.

Action Type Description

9AKK101130D1382 299

DISPLAY <display name> The mimic whose name is defined in the command line is displayed.

PROGRAM EIXKEY PAGE_PRINT The print screen function is activated.

PROGRAM EIXKEY PAGE_HOME The home page is displayed.

PROGRAM EIXKEY PAGE_PREV The previous page is displayed.The previous page is any page displayed before the current one.

PROGRAM EIXKEY PAGE_BWRD The page backward is displayed.The page backward is any page linked at configuration time to the currently displayed page.

PROGRAM EIXKEY PAGE_FWRD The page forward is displayed.The page forward is any page linked at configuration time to the currently displayed page.

PROGRAM EIXKEY PAGE_ACKN The alarms on the current page are acknowledged.

PROGRAM EIXKEY PAGE_BYNAME The dialog window to enter a page name and call a page by its name is displayed.

PROGRAM EIXKEY PAGE_SAVE The name of the currently displayed page is saved for later recall.

PROGRAM EIXKEY PAGE_RECA The name of the page previously saved is displayed.

PROGRAM EIXKEY PRTENB The alarm printer management function is activated.

PROGRAM IBLSD EUD The engineering unit configuration function is activated.



300 9AKK101130D1382

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

IMGNORMAL Character10Mandatory

Icon name or tree element.If ButtonType is set to Button, the field is the icon name used to display a normal state or a steady state.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

<string><blank>None

IMGALARM Character10Mandatory

Icon name or tree element.If ButtonType is set to Button, the field is the icon name used to display an alarm state.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

<string><blank>None

302 9AKK101130D1382

Note 1:The icons whose names are defined above must exist or must be included within the \PGP\Icons folder.

IMGBLINK Character10Mandatory

Icon name.If ButtonType is set to Button, the field is the icon name used to display an unacknowledged alarm state.It applies to alarm tile icons only.See Note 1 at the end of the table.Standard blink icons are listed in Table 115

<string><blank>None

MENUFKEY Integer3Optional

Function key.The field identifies a function key button of the keyboard to be associated to the menu or tool-bar item.A value of 0 means that no functional key button has been associated to the item.

{0, 1, ..., 90}0None

MENULEVEL Integer3Optional

Menu level.It applies to menu items only and identifies the level in the menu structure.The value 0 is the root level.

{0, ..., 9}0None

MENUSEP Character1Optional

Item separator. The field specifies if a separator must be placed between the previous and the current items. If set, the item separator is a space for tool-bars and a line for menus.

{Y, N}NNone

Table 112. Menu and Tool-bar - Presentation Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 303

Table 113. Menu and Tool-bar - Standard Normal Icons.

Action Type Program Name Normal Icon Description

ALMDIS GRAn Gray number n inside a button.By default n can range between 1 and 20.

ALMDIS ICISTA GREENLED Green led button (for ICI status).

BROWSER EXPLORER Internet explorer shaped icon.

BROWSER WFOLDER Network shaped icon.

DISPLAY PLANT Plant shaped button.

DISPLAY FOLDER Closed folder shaped icon.

DISPLAY FILE Page shaped icon.

NONE FOLDER Closed folder shaped icon.

NONE WFOLDER Network shaped icon.

PROGRAM ACKAUD AUDSILENCE Crossed horn shaped button.

PROGRAM EIXKEY HOME House shaped button.

PROGRAM EIXKEY LEFTKEY Left arrow shaped button.

PROGRAM EIXKEY PRINT Printer shaped button.

PROGRAM EIXKEY RIGHTKEY Right arrow shaped button.

PROGRAM EIXKEY UPKEY Up arrow shaped button.

PROGRAM LOGON LOGON Key shaped button.

PROGRAM TGROUP TRENDS Trend shaped button.

304 9AKK101130D1382

The parameters listed in Table 116 are not included in the on-line configuration utility.

Table 114. Menu and Tool-bar - Standard Alarm Icons.


ALMDIS REDn Red number n inside a button.By default n can range between 1 and 20.

ALMDIS ICISTA REDLED Red led button (for ICI status).

DISPLAY OPFOLDER Opened folder shaped icon.

NONE OPFOLDER Opened folder shaped icon.

Table 115. Menu and Tool-bar - Standard Blink Icons.


ALMDIS YELn Yellow number n inside a button.By default n can range between 1 and 20.

Table 116. Menu and Tool-bar - Presentation Parameters (cntd.).

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

MENUTAG Character20Optional

Tag name.The field is the name of a tag associated to the menu item.


9AKK101130D1382 305

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

MENUOPSTA Integer3Optional

Number of operator station.It allows assign the item to a single operator station. The code 0 means the item is assigned to all operator stations.

{0, 1...32}0[nmcrts]

SECGROUP1 Character1Optional

Privilege to access tags and displays belonging to the security group 1.

{Y,N}NNone

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



{Y,N}NNone

SECLEVEL Integer2Optional

Security level.The value is compared to the security level assigned to the user before to grant access. A value of 0 means no security check.

{0, 1, ..., 16}0None

306 9AKK101130D1382

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

ALARMS Character1Optional

Privilege for executing general alarm management.

{Y,N}NNone

APPL1 Character1Optional

Privilege for accessing specific application functions.

{Y,N}NNone



{Y,N}NNone

CALCUL Character1Optional

Privilege for configuring calculations. {Y,N}NNone

CLSERVER Character1Optional

Privilege for accessing the client/server management functions.

{Y,N}NNone

CONFIG Character1Optional

Privilege for configuring some miscellaneous functions (e.g. engineering units, logic state descriptors).

{Y,N}NNone

DIAGNOSTIC Character1Optional

Privilege for executing diagnostic functions.

{Y,N}NNone

9AKK101130D1382 307

GRAPHICS Character1Optional

Privilege for performing mimic configuration.

{Y,N}NNone

GROUPS Character1Optional

Privilege for configuring historical and realtime groups.

{Y,N}NNone

HISTORY Character1Optional

Privilege for performing general historical functions (e.g. initialize historical counters).

{Y,N}NNone

INFINET Character1Optional

Privilege for executing functions related to the C-NET modules.

{Y,N}NNone

LOGS Character1Optional

Privilege for modifying the configuration of the reports, for triggering and deleting archived reports.

{Y,N}NNone

LTERMHIST Character1Optional

Privilege for executing long term historical functions.

{Y,N}NNone

NAVIGATE Character1Optional

Privilege for WEB navigation. {Y,N}NNone

ODBC Character1Optional

Privilege for configuring the ODBC functions.

{Y,N}NNone


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

308 9AKK101130D1382

REMWRITEF Character1Optional

Privilege for writing a file in remote access (e.g. using DDE functions).

{Y,N}NNone

SECURITY Character1Optional

Privilege for accessing and modifying security and users.

{Y,N}NNone

TIMEDATE Character1Optional

Privilege for setting the time and date. {Y,N}NNone

TRENDS Character1Optional

Privilege for accessing trend functions. {Y,N}NNone

UTILITY Character1Optional

Privilege for executing general utility functions.

{Y,N}NNone

VIEWCONFIG Character1Optional

Privilege for displaying the configuration databases.

{Y,N}NNone

VIEWDISP Character1Optional

Privilege for viewing displays. If set, display viewing is submitted to security group check also.

{Y,N}NNone


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 309

VIEWHIST Character1Optional

Privilege for viewing historical data. {Y,N}NNone

WINDOWSNT Character1Optional

Privilege for accessing Windows functions (e.g. window sizing, Windows desktop usage).

{Y,N}NNone


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

310 9AKK101130D1382

Network Subsystem

Nodes

OutlineA 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 DatabaseThe 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 DefinitionThe 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 ParametersThe 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.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

NODEINDEX Integer5Optional

Node index. This field identifies the node by number. It must be unique for each node in the database. If omitted or zero (blank), the first vacant index will be allocated.

{0...32}0[mxnode]

NODENAME Character20Mandatory

Node name.The node name must be the name assigned to the computer and can be retrieved by the Network function of the Control Panel.


NODEDESC Character64Optional

Node description. <string><blank>[szdesc]


Primary display reference. Name of a graphic display associated to the node. For example, it could be the name of a diagnostic display showing the network component.

<string><blank>None

312 9AKK101130D1382

ZEROSTATE Character6Optional

Zero state descriptor. This field defines the text to represent the failure state.


ONESTATE Character6Optional

One state descriptor. This field defines the text to represent the normal state.


PLANTUNIT Integer2Optional

Plant unit number. This field identifies the plant unit (applicable only to multi-unit plants).

0None

WEIGHT Integer2Optional

Node weight.In a multi-master network configuration, the highest value (weight) defines the “master” node.

0None

SNAPALGMSK Character16Optional

Destination node mask for snapshot alignment at PGP start-up.First bit refers to node 1 in the node definition, second bit refers to node 2, and so on.


SNAPALGMS2 Character16Optional

Destination node mask for snapshot alignment at PGP start-up.The mask applies to nodes from 17 to 32.



Destination node mask for snapshot alignment at PGP start-up.The mask applies to nodes from 33 to 48.



NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 313


Destination node mask for snapshot alignment at PGP start-up.The mask applies to nodes from 49 to 64


CNFALGMSK Character16Optional

Destination node mask for configuration alignment at PGP start-up.First bit refers to node 1 in the node definition, second bit refers to node 2, and so on.


CNFALGMS2 Character16Optional

Destination node mask for configuration alignment at PGP start-up.The mask applies to nodes from 17 to 32.



Destination node maskPGP for configuration alignment at PGP start-up.The mask applies to nodes from 33 to 48.



Destination node mask for configuration alignment at PGP start-up.The mask applies to nodes from 49 to 64


OJALGMSK Character16Optional

Destination node mask for chronological alarm file alignment at PGP start-up.First bit refers to node 1 in the node definition, second bit refers to node 2, and so on.


OJALGMS2 Character16Optional

Destination node mask for chronological alarm file alignment at PGP start-up.The mask applies to nodes from 17 to 32.



NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

314 9AKK101130D1382


Destination node mask for chronological alarm file alignment at PGP start-up.The mask applies to nodes from 33 to 48.



Destination node mask for chronological alarm file alignment at PGP start-up.The mask applies to nodes from 49 to 64


PLBALGMSK Character16Optional

Destination node mask for playback alignment at (1) start-up.First bit refers to node 1 in the node definition, second bit refers to node 2, and so on.


PLBALGMS2 Character16Optional

Destination node mask for playback alignment at PGP start-up.The mask applies to nodes from 17 to 32.



Destination node mask for playback alignment at PGP start-up.The mask applies to nodes from 33 to 48.



Destination node mask for playback alignment at PGP start-up.The mask applies to nodes from 49 to 64


HISTALGMSK Character16Optional

Destination node mask for historical files alignment at PGP start-up.First bit refers to node 1 in the node definition, second bit refers to node 2, and so on.



NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 315

HISTALGMS2 Character16Optional

Destination node mask for historical filesk alignment at PGP start-up.The mask applies to nodes from 17 to 32.



Destination node mask for historical files alignment at PGP start-up.The mask applies to nodes from 33 to 48.



Destination node mask for historical files alignment at PGP start-up.The mask applies to nodes from 49 to 64


(1)


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

316 9AKK101130D1382

Alarm Process ParametersThe fields in Table 120 define additional information for the alarm processing of the node pseudo-tag.

Table 120. Node - Alarm Process Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

DS_ALARM Character1Optional

Display alarm flag. If set, an alarm message concerning this pseudo-tag will be displayed on alarm display page (LAD).

{Y, N}YNone

DS_RTN Character1Optional

Display flag for return to normal. If set, a RTN message concerning this pseudo-tag will be displayed on alarm display page (LAD).The alarm acknowledge will remove the message.

{Y, N}YNone

BOT_ALARM Character1Optional

Display flag for unacknowledged on bottom.If set, a unacknowledged alarm concerning this pseudo-tag will be displayed on the bottom of screen window.

{Y, N}YNone

REM_ONACK Character1Optional

Remove flag on acknowledgment.On alarm acknowledgment the message concerning this pseudo-tag is removed from the alarm page.

{Y, N}NNone

INFO_ONACK Character1Optional

Log flag on alarm acknowledgment.When an alarm concerning this pseudo-tag is acknowledged a info message is logged to the Operator Journal.

{Y, N}NNone

9AKK101130D1382 317

PR_ALARM Character1Optional

Print alarm flag. If set, an alarm message concerning this pseudo-tag will be printed on the alarm printer.See the field ALMPRINTER also.

{Y, N}NNone


Print flag for operator action message.If set, database modifications and all other operator actions concerning this pseudo-tag will be printed.See the field ALMPRINTER also.

{Y, N}NNone

PR_RTN Character1Optional

Print flag for return to normal message. If set, a RTN massage concerning this pseudo-tag will be printed.See the field ALMPRINTER also.

{Y, N}NNone


Print flag for information message.If set, a information message concerning this pseudo-tag will be printed.See the field ALMPRINTER also.

{Y, N}NNone

SV_ALARM Character1Optional

Save alarm flag. If set, an alarm message concerning this pseudo-tag will be logged to the Operator Journal.

{Y, N}YNone


Save flag for operator action. If set, database modifications and all other operator actions concerning this pseudo-tag will be logged to the Operator Journal.

{Y, N}YNone


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

318 9AKK101130D1382

SV_RTN Character1Optional

Save flag for return to normal message. If set, a RTN message concerning this pseudo-tag will be logged to the Operator Journal.

{Y, N}YNone


Save flag for information message.If set, a information message concerning this pseudo-tag will be logged to the Operator Journal.

{Y, N}YNone

ALMPRINTER Integer2Optional

Alarm printer index.Reference index to the printer where messages concerning the tag are printed.See the fields PR_xxx (e.g. PR_ALARM) also.It is a pointer to a registry defining the alarm printer. Refer to the system option configuration for details.

0None

ALMGROUP Integer3Optional

Alarm group. Refer to the same field of the tag database for a complete description.

{0, 1...272}0[sladnm] and [mxxagp]

AL_PRI Integer2Optional

Alarm priority. Refer to the same field of the tag database for a complete description.

{0, 1...15}1[mxalpr] and [mxxapr]

AUD_ALARM Character1Optional

Activate flag for audible signals on alarm occurrences.

{Y,N}YNone


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 319

AUDINDEX Integer3Optional

Audible alarm index. This field defines the index into audible alarm database to determine which audible is to be activated upon alarm and/or return to normal.

{0, 1...32}0[mxaud]

AUD_RTN Character1Optional

Print flag for audible signal on return to normal.

{Y, N}NNone

APPL_ALA Character1Optional

Application program activation flag.If set, trigger an application program on alarm occurrence.

{Y,N}NNone

EXP_ALA Character1Optional

Relational database update flag. If set, alarm messages are automatically sent to the external relational database.

{Y,N}NNone


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

320 9AKK101130D1382

Security Subsystem

Security

OutlinePGP 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:

• Monitor,

9AKK101130D1382 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 DatabaseThe 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 DefinitionThe following sections list a set of parameters to define a PGP user. There are both mandatory and optional parameters.

9AKK101130D1382 323

General ParametersThe fields in Table 121 define the name and other additional parameters used to identify the PGP user.

Table 121. Security - General Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

USERINDEX Integer3Optional

User index. This field identifies the PGP user by number. It must be unique for each user in the database. If omitted or zero (blank), the first vacant index will be allocated.

{0...20}0[n.pswd]

USERNAME Character18Mandatory

User name.This field identifies the PGP user by name. It must be unique for each user in the database.

<string><blank>[szunam]

PASSWORD Character18Mandatory

User password.The export function does not fill in this field to prevent password decoding.A new created security database file does not include the field.See also the caution Note at the end of the table.


CRYPTPWD1 Integer18Mandatory

Encrypted user password. The export function fills in this field.A new created security database file includes the field.See also the caution Note at the end of the table.

None

324 9AKK101130D1382

USERCODE Integer4Optional

User code.Numeric code, such as a payroll code, associated to the user. It is used only for display purposes.

0None

LANGUAGE Integer2Optional

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.

0None

ACTIVE USER Character1Mandatory

Define if the inserted item refers to a real user or identify a Users’ group


WINGROUP Character64Optional

Define if the inserted item refers to a real user or identify a Users’ group


Table 121. Security - General Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 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 ParametersThe fields in Table 122 define access control parameters used to restrict user accesses and to prevent unauthorized accesses.

Table 122. Security - Access Control Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

LOGOFFTMO Character1Optional

Log-off on time-out.The log-off time-out is related to the screen saver setting. It is required to set the screen sever time-out in order to control the automatic user log-off.Automatic log-off is forced when the screen saver time-out expires.

{Y,N}NNone

LOGINDISP Character9Optional

Log-in display.Name of a mimic displayed when the user logs in.

<string><blank>None

LOGOFFDISP Character9Optional

Log-off display.Name of a mimic displayed when the user logs out or the time-out forces a log out.

<string><blank>None

LOGINPROG Character6Optional

Log-in program.Name of the application program to run when the user logs in.

<string><blank>None

LOGOFFPROG Character6Optional

Log-off program.Name of the application program to run when the user logs out or the time-out forces a log out.

<string><blank>None

9AKK101130D1382 327

MAXLOGINFAIL Integer4Optional

Maximum number of log-in trials. 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. The user is locked. The system manager must manually unlock the user in order to allow user logging-in again.

{0, 1...9999}0None

PWDAGING Integer4Optional

Password aging (number of days). After that time has elapsed, the user is no longer allowed to log-in. The user must change the password before its expiration or the system manager must set a new password after expiration.

{0, 1...9999}0None

Table 122. Security - Access Control Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

328 9AKK101130D1382

Access Security ParametersThe fields in Table 123 define security parameters to operate on single tags.

Table 123. Security - Tag Operation Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

TAGMONITOR Character1Optional

Privilege to monitor tags. {Y,N}NNone

TAGCONFIG Character1Optional

Privilege to configure tags. {Y,N}NNone

TAGCONTROL Character1Optional

Privilege to execute process control on tags.

{Y,N}NNone

TAGTUNE Character1Optional

Privilege to tune the process tags. {Y,N}NNone

TAGDELETE Character1Optional

Privilege to delete tags. {Y,N}NNone

TAGENTDATA Character1Optional

Privilege to perform data entry on tags. {Y,N}NNone

TAGOFFSCAN Character1Optional

Privilege to put tags off scan and on scan. {Y,N}NNone

9AKK101130D1382 329

The fields in Table 124 define security parameters to grant access to various PGP functions.

TAGOFFALM Character1Optional

Privilege to put tags off alarm check and on alarm check.

{Y,N}NNone

TAGLIMIT Character1Optional

Privilege to change alarm limits of tags. {Y,N}NNone

TAGACK Character1Optional

Privilege to acknowledge alarms. {Y,N}NNone

TAGMONALL Character1Optional

Privilege to perform full tag monitoring. Security level and security group check is bypassed.

{Y,N}NNone

TAGREMOTE Character1Optional

Privilege for remote access on tags. {Y,N}NNone

TAGENTHIST Character1Optional

Privilege to enter historical data on tags. {Y,N}NNone

Table 123. Security - Tag Operation Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

330 9AKK101130D1382

Table 124. Security - Privilege Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

ALARMS Character1Optional

Privilege for executing general alarm management.

{Y,N}NNone



{Y,N}NNone



{Y,N}NNone

CALCUL Character1Optional

Privilege for configuring calculations. {Y,N}NNone

CLSERVER Character1Optional

Privilege for accessing the client/server functions.

{Y,N}NNone

CONFIG Character1Optional

Privilege for configuring some miscellaneous functions (such as engineering units and logic state descriptors).

{Y,N}NNone

DIAGNOSTIC Character1Optional

Privilege for executing diagnostic functions.

{Y,N}NNone

GRAPHICS Character1Optional

Privilege for performing mimic configuration.

{Y,N}NNone

9AKK101130D1382 331

GROUPS Character1Optional

Privilege for configuring historical and realtime groups.

{Y,N}NNone

HISTORY Character1Optional

Privilege for performing general historic functions (such as initializing the historical counters).

{Y,N}NNone

INFINET Character1Optional

Privilege for executing functions related to the C-NET modules.

{Y,N}NNone

LOGS Character1Optional

Privilege for modifying the configuration of the reports, for triggering and deleting archived reports.

{Y,N}NNone

LTERMHIST Character1Optional

Privilege for executing long term historical functions.

{Y,N}NNone

NAVIGATE Character1Optional

Privilege for navigating through WEB pages.

{Y,N}NNone

ODBC Character1Optional

Privilege for configuring the ODBC functions.

{Y,N}NNone

REMWRITEF Character1Optional

Privilege for writing a file in remote access (such as using DDE functions).

{Y,N}NNone


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

332 9AKK101130D1382

SECURITY Character1Optional

Privilege for accessing and modifying security and users.

{Y,N}NNone

TIMEDATE Character1Optional

Privilege for setting the time and date. {Y,N}NNone

TRENDS Character1Optional

Privilege for accessing trend functions. {Y,N}NNone

UTILITY Character1Optional

Privilege for executing general utility functions.

{Y,N}NNone

VIEWCONFIG Character1Optional

Privilege for displaying the configuration databases.

{Y,N}NNone

VIEWDISP Character1Optional

Privilege for viewing displays. If set, display viewing is submitted to security group check also.

{Y,N}NNone

VIEWHIST Character1Optional

Privilege for viewing historical data. {Y,N}NNone

WINDOWSNT Character1Optional

Privilege for accessing Windows functions (such as window sizing, Windows desktop usage).

{Y,N}NNone


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)



{Y,N}NNone

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



{Y,N}NNone


Security level. This field is used for security checking whenever a user attempts to operate on PGP. Only if the value is greater or equal the security level of the requested function the user gains access.

{0, 1...16}1None

334 9AKK101130D1382

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

CRTMASK1 Character16Optional

Crt enable mask.The bit mask allows enabling access or preventing access to clients.The mask applies to clients from 1 to 16.

Sequence {Y, N}16*YNone

CRTMASK2 Character16Optional

Crt enable mask.Same as CRTMASK1 above.The mask applies to clients from 17 to 32.

Sequence {Y, N}16*YNone

PLANTUMSK1 Character16Optional

Plant unit enable mask 1.The current user can only access to the plant units enabled.


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

PLANTUMSK9 Character16Optional

Plant unit enable mask 9.Same as above.


PLANTUMS10 Character16Optional

Plant unit enable mask 10.The current user can only access to the plant units enabled.


9AKK101130D1382 335

Enhanced User ManagementSince 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.

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

PLANTUMS16 Character16Optional

Plant unit enable mask 16.Same as above.


Table 126. Security - Remote Access Parameters.

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

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 UsersThe 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 HintsIn 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 DefaultsPGP 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 1 All TagMonitor, TagControl, TagAck

ViewDisp

ENGINEER LEVEL1 1 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

OutlinePGP 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 what’s described in the following sections. In general, there is a table for tag static data, a table for trend group static data, a table for tag dynamic data, a table for alarm dynamic data and n tables for trend group dynamic data, where n is the maximum number of trend groups in the system.

Target Database RequirementsThe target database can be any commercial DBMS providing an ODBC driver for Windows. Actually, PGP fully supports

• MS Access,

9AKK101130D1382 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 TablesAs 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 deck-file 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’.

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.

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.

Table 128. Foreign Database Support - Tag Static Table (TAGS).

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

TAGINDEX Decimal6Optional

Tag index.

None

TAGNAME Character220Optional

Tag name.

None

TAGDESC Character264Optional

Tag description.

None

9AKK101130D1382 343

TAGTYPE Character28Optional

Tag type.

None


Engineering unit description.

None

VAL0 Dbl. Prec.

Optional

Value of 0% scale.

None

SPAN Dbl. Prec.

Optional

Instrument range.

None

ZEROSTATE Character216Optional

Descriptor for state 0.

None

ONESTATE Character216Optional


None

TWOSTATE Character216Optional


None


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

344 9AKK101130D1382

THREESTATE Character216Optional


None

FOURSTATE Character216Optional


None

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

GROUPINDEX Decimal6Optional

Group index.

None

GROUPNAME Character220Optional

Group name.

None

GROUPDESC Character264Optional

Group description.

None

ARCHTYPE Character27Optional

Archive type.

None


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 345


Engineering unit description.

None

ARCHFRQ Decimal6Optional

Archive frequency.

None

ARCHUNITS Decimal6Optional

Archive time units.

None

OFFSET Decimal6Optional

Archive time offset.

None

OFFSUNITS Decimal6Optional

Archive time offset units.

None

SAMPLFRQ Decimal6Optional

Sample frequency.

None

SAMPLUNITS Decimal6Optional

Sample time units.

None

TOTSAMPLES Decimal6Optional

Total number of samples.

None


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

346 9AKK101130D1382

Dynamic tablesAs 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 database’s administrator can manipulate dynamic table contents as desired, for instance deleting or dumping to tape old records.

Like static tables, the structure of dynamic tables may be changed to fit specific application requirements. These changes must be set up on 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.

TAG1 Character220Optional

Name of the 1st tag in the group.

None

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

TAG60 Character220Optional

Name of the 60th tag in the group.

None


NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

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

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

TAGTIME Date

Optional

Tag time and date.

None

TAGMILSEC Decimal3Optional

Tag milliseconds.

None

348 9AKK101130D1382


Tag index.

None

TAGUID Character236Optional

Tag unique identification.

None

TAGVALUE Dbl. Prec.

Optional

Tag value.

None

TAGSTATE Character216Optional

Tag state.

[sztags]

TAGQUALITY Character24Optional

Tag quality.

None

Table 130. Foreign Database Support - Tag Dynamic Table (RTDB).

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

9AKK101130D1382 349

Table 131. Foreign Database Support - Alarm Dynamic Table (ALARMS).

NameFormatWidth

Opt/MndDescription

Range Default

Parameter(s)

ALARMTIME Date

Optional

Alarm message time and date.

None

ALARMILSEC Decimal3,0Optional

Alarm message milliseconds.

None


Tag index.

None

TAGUID Character236Optional

Tag unique identification.

None

ALARMTYPE Character26Optional

Alarm type.

None

ALARMTEXT Character2132Optional

Alarm text.

[s.aldb]

350 9AKK101130D1382

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

Name Fmt Description Param

TAGTIME Date

Optional

Tag time and date.

None

TAGMILSEC Decimal3Optional

Tag milliseconds.

None

TAGINDEX Decimal6

Tag index.

None

TAGVALUE Dbl.Prec. Tag value.

None

TAGSTATE Character216

Tag state.

[sztags]

TAGQUALITY Character22

Tag quality.

None

TRIPTIME Date

Optional

Trip time and date.

None

9AKK101130D1382 351

Data Export ManagerPGP 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.

TRIPMILSEC Decimal3Optional

Trip milliseconds.

None

GROUPINDEX Decimal6Optional

Group index.

None

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

Name Fmt Description Param

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 manufacturer’s documentation. After the data source has been properly setup, the program will ask the operator to make the selection permanent and to link all 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 GuidelinesThe 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:

• Create or modify the system option customizations. Use the SYSSETUP utility to turn the database export flag ‘OdbcInterface’ to ‘YES’.

354 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 what’s described in previous section. Exit the ‘Data Export Manager’.

• Add the proper fields to tag database (‘EXP_VAL’ and ‘EXP_ALA’) and trend group database (‘EXP_VAL’), and decide which tags and/or groups must be exported.

After these steps, continue the post-installation procedure by generating PGP database (Build All procedure).

Tuning and TroubleshootingPGP 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 SystemPGP 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 FormatOpt/Mnd Description Range

Defaultaction Character

MandatoryAction Code.Allowed action codes are:init - Initialize disk resident file directory,add - Add file to disk resident file directory,replace - Replace file to disk resident file directory,delete - Delete file from disk resident directory.A maximum of [N.DIR] files may be added to the file system.

{init, add, replace, delete}None

name CharacterMandatory

File name.This field is defined the name of the file as a 6 character string.

<string><blank>

description CharacterOptional

File description.Free format description of the data file, as a 32 character string.

<string><blank>

type CharacterMandatory

File type.Allowed file types are:D - Disk file,C - Core file,P - Parallel file.

{D,C,P}None

354 9AKK101130D1382

key CharacterMandatory

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.

{1...999}None

path CharacterOptional

Specifies the path of the file.If a valid file path is not specified, the file is assumed to be: key.DAT (located in the \Data folder) where key is specified in the file key field on card

NoneNone

records CharacterMandatory

Number of records in the file.The number of records is an integer numeric value.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.

{1...65535}None

remote_write CharacterOptional

Remote file writing enabled. If set, a remote client can update the file via DDE service.

{Y,N}N

size CharacterOptional

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.

{0, 1...65535}0

save_snapshot CharacterOptional

Snapshot file. If set, the file will be created on multiple snapshot folders for simulation purposes.

{Y,N}N

save_initial CharacterOptional

Save Initial condition file. If set, the file will be saved as intial condition for simulation purposes.

{Y,N}N



Default

9AKK101130D1382 355

Process SchedulingProcess 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:


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

skip_initialization CharacterOptional

Skip Initialization.If set, the file will not be initilized when created.

{Y,N}N



Default

356 9AKK101130D1382

Table 134. Builder BTIM - Timer Definition.



MandatoryAction code.Allowed action codes are:init - Initialize timer definition file,add - Add timer definition,replace - Replace timer definition,A maximum of [N.SCTM] timers can be added.

{init,add,replace}None

name CharacterMandatory

Timer name., according to the internal software definition

NoneNone

frequency IntegerOptional

Timer Period.A value of 0 means self scheduled process. 0

freq_unit CharacterOptional

Units for timer period.Allowed values are: “sec”, “min”, “hour’, “day”, “month”, “year’

None}None

offset IntegerOptional

Timer offset. It specifies a time value added to the base time 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 Monday’s midnight. Delay must be less than timer period.

0

offs_unit Character1Optional

Units for timer offset.Allowed values are: “sec”, “min”, “hour’, “day”, “month”, “year’.Timer offset must be less than timer period.

None

delay IntegerOptional

Initial delay. It specifies a delay to apply before to start the timer.

0

9AKK101130D1382 357

Daylight Saving TimeThe 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:


<DST_PERIODS action="xxx" timezone=”xxx” auto=”xxx”>

delay_unit CharacterOptional

Units for initial delay.Allowed values are: “sec”, “min”, “hour’, “day”, “month”, “year’

None

active CharacterMandatory

Active flag. Specifies if the timer is active or not.

{Y,N}N

Table 134. Builder BTIM - Timer Definition.


Default

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 FormatOpt/Mnd Description Range


MandatoryAction code.Allowed action codes are:add - Add a DST definition,init - iInitialize the DST definition file,A maximum of 30 records may be added .

{init, add}None

timezone Character Timezone description, according to the Windows Control Panel definition

<string>None

auto Character Automatic generation of DST Periods starting from Windows Operating System

{yes, no}No

start CharacterMandatory

Daylight Saving Time start date. Start date DST is in the ISO-SQL standard format yyyy-mm-dd hh:mm:ss, which is independent form interface language.

<string>None

end CharacterMandatory

Daylight Saving Time enddate. Start date DST is in the ISO-SQL standard format yyyy-mm-dd hh:mm:ss, which is independent form interface language.

<string>None

9AKK101130D1382 359

Operator Station Subsystem

LanguageThe 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 “&”). 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


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


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

Timer definition parameters, defined as “xxx” in the previous XML snapshot, are listed in the following table

A wrong compilation of PGP database structures may result in configuration errors as well as in unexpected operations.

362 9AKK101130D1382

Table 136. Builder DBXRF - Database Field Assignment Definition.



MandatoryAction code.Allowed action codes are:init - Initialize DBXRF definition file,add - Add DBXRF definition,replace - Replace DBXRF definition,A maximum of 1200 definitions can be added.


DB_XREFname Character

MandatoryThe name of the database fileld. It correspond to the name of the column in the DBF or XLS file.Notice that DBF limit the column names to 10 characters.

<string>None

descr CharacterOptional

The description of the database field.This filed is limited to 28 characters.

<string>None

code CharacterMandatory

Reference of database field.It uniquely identifies the field to allow handling during database processing.Field reference is an string value and may be specified according to the parameter file LOADPRM which include the symbols.Symbolic prefixes for word offsets are listed in the Appendix A.

<string>None

default CharacterOptional

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

<string>None

callback CharacterOptional

Field assignment call-back name (case sensitive). If no name is supplied, direct field assignment is selected.

<string>None

9AKK101130D1382 363

unbuild_callback CharacterOptional

Export call-back name (case sensitive). <string>None

dbfunbuild CharacterOptional

DBF Export inhibit flag. If set, the field is considered optional and will not be created upon database export. Otherwise it is mandatory and it 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 “DBF” under the UNBUILD section

{Y, N}N

xlsunbuild CharacterOptional

XLS Export inhibit flag. If set, the field is considered optional and will not be created upon database export. Otherwise it is mandatory and it will be created. This selection only applies to export 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

{Y, N}N

ITEMTYPE



Default

364 9AKK101130D1382


Item type to which field assignment is applied. Item type is an string value according to the parameter file SYSPRM. A list of legal item types is shown in the Appendix A.

At least one of these types must be specified for each DB_XREF definition.

<string> None

ALIASname Character

OptionalName of an aliases field. Defines an alternative name for the column of the DBF or XLS fileUp to 8 alias name can be assigned for a DB_XREF.Alias name are limited, by DBF, to 10 characters

<string>None

UNBUILDname Character

MandatoryThe name of the field <string>

Nonetype Character

MandatoryOutput field type.Allowed output field types are:C - Character.N - Numeric.This selection only applies to export operations specifying a new target database. If a reference database is specified, its structure will be used.

{C, N}None

length IntegerMandatory

Output field size. <number>0

dbf CharacterOptional

Flag specifiing if the field will be exported to DBF files (see above)

{Y,N}N

xls CharacterOptional

Flag specifiing if the field will be exported to XLS files (see above)

{Y,N}N



Default

9AKK101130D1382 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

IntroductionThe 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 OverrideThe 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:


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



MandatoryAction code.Allowed action codes are:init- Initialize the color/blink definition file,add - Add a color/blink definition,replace - Replace a color/blink definition,If a color/blink definition does not exist, action code R means add.

{init, add, replace}None

PRIORITYnumber Integer

MandatoryPriority number. {1...16}

Nonetype Character

MandatoryItem type for which the priority definition is applied.Allowed values are PV and Di.

{PV,DI}None

copy_from_priority IntegerOptional

Priority number to copy the definition from.(this just to avoid to duplicate many statements, which very likely are the same)

{1...16}None

ITEMbit Character

MandatoryBit of interest in quality status word .A status word defines the quality of digital tags, two status words define the quality of analog tags.See the Appendix for quality bit definitions.

{0...31}

None


Override type.Allowed override type are:BL - Blink,BC - Background color,FC - Foreground color.

{BL, BC, FG}None

9AKK101130D1382 369

color CharacteMandatory

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.

<string>None

symbol CharacterOptional

Quality symbol.The symbol is appended to tag values to represent tag quality. (up to 4 characters are allowed)

<string>None

invert CharacterOptional

Invert code.I - Invert tag status before testing for override.

{Y, N}N

descr CharacterOptional

Description. (up to 28 characters are allowed for describit this quality)

<string>None

PROCESSINGds_alarm Character

OptionalDisplay alarm. {Y, N}

Npr_alarm Character

OptionalPrint alarm. {Y, N}

Nsv_alarm Character

OptionalArchive alarm. {Y, N}

Naud_alarm Character

OptionalAudible on alarm. {Y, N}

Nbot_alarm Character

Optional Alarm at bottom of screen window. {Y, N}

Nds_rtn Character

OptionalDisplay return to normal. {Y, N}

N



Default

370 9AKK101130D1382

pr_rtn CharacterOptional

Print return to normal. {Y, N}N

sv_rtn Character1

Archive return to normal. {Y, N}N

ds_stchng CharacterOptional

Display event. {Y, N}N

pr_stchng CharacterOptional

Print event. {Y, N}N

sv_stchng CharacterOptional

Archive event. {Y, N}N

pr_opact CharacterOptional

Print operator action. {Y, N}N

sv_opact CharacterOptional

Archive operator action. {Y, N}N

pr_info CharacterOptional

Print info messages. {Y, N}N

sv_info CharacterOptional

Archive info messages. {Y, N}N

rem_onack CharacterOptional

Remove alarm on acknowledge. {Y, N}N

info_onack CharacterOptional

Log on acknowledge. {Y, N}N

app_ala CharacterOptional

Application specific action. {Y, N}N

exp_ala CharacterOptional

Export to external DBMS. {Y, N}N

opc_ala CharacterOptional

Export to OPC Server. {Y, N}N

audidx IntegerOptional

Audible Alarm index {0,16}0



Default

9AKK101130D1382 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:


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



MandatoryAction code.Allowed action codes are:Init - Initialize alarm messages definition file,Add - Add an alarm message,Replace- Replace an alarm message,


code Char or IntMandatory

Alarm message code/number. The field specifies the alarm message being defined.The alarm message number is an integer value and may be specified either by number or by a symbol (the parameter file BALMPRM includes the symbols).

<string> or {1...999}

[mxamsg]

value CharacterMandatory

The text string, which correspond to the alarm message. The definition correspond to a standared C Language format, where the parameters are replaced by the “parameters” defined below.

<string>None

PARAMETERSp1 Character

OptionalSymbolic definition of the type of the first parameter. Refer to table 3-15 for the list.

Up to 30 paramaters can be specified for an alarm message

<string>None

l1 IntegerOptional

Length (in characters) of the first parameters.Refer to table 3-15 for the legth of default parameters

Integer0

PROCESSINGds_alarm Character

OptionalDisplay alarm. {Y, N}

N

9AKK101130D1382 373

pr_alarm CharacterOptional

Print alarm. {Y, N}N

sv_alarm CharacterOptional

Archive alarm. {Y, N}N

aud_alarm CharacterOptional

Audible on alarm. {Y, N}N

bot_alarm CharacterOptional

Alarm at bottom of screen window. {Y, N}N

ds_rtn CharacterOptional

Display return to normal. {Y, N}N

pr_rtn CharacterOptional

Print return to normal. {Y, N}N

sv_rtn Character1

Archive return to normal. {Y, N}N

ds_stchng CharacterOptional

Display event. {Y, N}N

pr_stchng CharacterOptional

Print event. {Y, N}N

sv_stchng CharacterOptional

Archive event. {Y, N}N

pr_opact CharacterOptional

Print operator action. {Y, N}N

sv_opact CharacterOptional

Archive operator action. {Y, N}N

pr_info CharacterOptional

Print info messages. {Y, N}N

sv_info CharacterOptional

Archive info messages. {Y, N}N

rem_onack CharacterOptional

Remove alarm on acknowledge. {Y, N}N



Default

374 9AKK101130D1382

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.

info_onack CharacterOptional

Log on acknowledge. {Y, N}N

app_ala CharacterOptional

Application specific action. {Y, N}N

exp_ala CharacterOptional

Export to external DBMS. {Y, N}N

opc_ala CharacterOptional

Export to OPC Server. {Y, N}N

audidx IntegerOptional

Audible Alarm index {0,16}0

opstation IntegerOptional

Operator station.The field specifies the operator station where to output the message.

{0...32}[nmcrts]

priority IntegerOptional

Alarm priority.The field specifies the alarm priority assigned to the message.

{0...8}0

group IntegerOptional

Alarm group.The field specifies the alarm group assigned to the message.

{0...SLADNM}0

translate CharacterOptional

Translation flag.If set, the message is submitted to translation at generation time. Otherwise, translation takes place at run time.

{Y, N}N

prtiidx IntegerOptional

Alarm printer Index. Number0



Default

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.

Error messagesThis 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:


<ERR_MESSAGES action="xxx">

<MESSAGE code=”xxx" value=”xxx" />

Table 139. Message Subsystem - Dynamic Text Definition Symbols.

Symbol Field Type Description%s String The field will be filled by a sequence of characters.

376 9AKK101130D1382

...

...

</ERR_MESSAGES>

Alarm Attribute definition parameters, defined as “xxx” in the previous XML snapshot, are listed in the following table.

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 140. Builder BEMF - Error Message Definition



MandatoryAction code.Allowed action codes are:Init - Initialize error message definition file,Aadd - Add error message definition,Replace - Replace error message definition,If a message does not exist, action code R means add.


code Character or integerMandatory

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

{1...999}None

value CharacterMandatory

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.

<string>None

Table 141. Message Subsystem - Text Definition Symbols.

Symbol Field Type Description%s String The field will be filled by a sequence of characters.%d Digit The field will be filled by a set of digits to represent an integer or a

real number.

9AKK101130D1382 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

IntroductionPGP 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 Save-Restore 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

OverviewPGP can be activated on demand or automatically. The Start PGP function allows for on-demand activation.

Activating PGPSelect 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 DescriptionRefer to the InformIT Power Generation Portal User Manual.

PGP Explorer

OverviewPGP 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 ExplorerSelect following menu:


> Programs

> ABB Industrial IT


> Power Generation Portal Explorer.

SODG Display Translator

OverviewApplication 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 displaysPGP 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 TranslatorSelect following menu:


> Programs

> ABB Industrial IT


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

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.

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.

9AKK101130D1382 383

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

Figure 14. Display Translator - Translation Window

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.

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 wild-card (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)

Figure 15. Display Translator – Selection Window

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

OverviewThe second step preparing displays for PGP environment is the compilation of displays imported from the SODG utility or implemented using the on-board 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 CompilerSelect following menu:


> Programs

> ABB Industrial IT


> System Setup


Text Format Display Compiler.

9AKK101130D1382 389

Double clicking EIXCMP in the right view, the interface window of the display compiler will be opened.

Compiling DisplaysThe figure below shows the schematic of the compiler 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:

Figure 16. Display Compiler - Compilation Window

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.

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 wild-card (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.

Figure 17. Display Compiler – Selection Window

9AKK101130D1382 391

Display Builder

OverviewA 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 BuilderSelect following menu:


> Programs

> ABB Industrial IT


> Display Builder

The interface window of the display builder will be opened.

Display Builder DescriptionRefer to the InformIT Power Generation Portal Display Builder Manual for more information.

Data Export Manager

OverviewPGP 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 ManagerSelect following menu:


> Programs

> ABB Industrial IT


> System Setup


ODBC DB Export Manager.

Double clicking DBXMGR the interface window of the data export manager will be opened.

Data Export Manager DescriptionRefer to the InformIT Power Generation Portal User Manual for more information.

Historical Backup

OverviewPGP 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 pre-defined 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.

ArchivesSome 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 ArchiveThe 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 ArchiveHistoric 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 ArchivePlayback 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 ArchivePost 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 ArchiveThe 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 ArchivingSelect following menu:


396 9AKK101130D1382

> Programs

> ABB Industrial IT


> System Setup


Historian Backup Manager

Double clicking HISBACKUP in the right view, the interface window of the historian backup manager will be opened.

Archiving InterfaceAfter 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

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.

Figure 18. Historian Backup Manager

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 ProcedureClick the save icon or the save item of the Save menu to initiate a save procedure.

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.

Figure 19. Trend Group Archive - Group Selection Window

9AKK101130D1382 399

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.

Figure 20. Trend Group Archive - Save-set Dialog Window

400 9AKK101130D1382

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 save-set list updates. The new save-set will be enclosed in the list.

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

Figure 21. Trend Group Archive - Destination Dialog Window

9AKK101130D1382 401

Press Open button to start restoring. When restoring procedure completes the message shown below is displayed.

Deleting ProcedureClick the delete icon or select the delete item of the Delete menu to initiate a delete operation.

Figure 22. Trend Group Archive - Restore Dialog Window

Figure 23. Trend Group Archive - Completion Window

402 9AKK101130D1382

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

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

Figure 24. Delete Dialog Window.

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 BackupSelect following menu:


> Programs

> ABB Industrial IT


> System Setup


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

OverviewA 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 SettingsSelect following menu:


> Programs

> ABB Industrial IT


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

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.

Figure 25. Save Config Window

9AKK101130D1382 407

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.

Figure 26. Save Config Selection Window

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.

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

Figure 27. Save Config Browser Window

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.

RestoreA 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

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.

Figure 28. Restore Window

9AKK101130D1382 411

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)

OverviewPGP 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 LTA manager can run on one PGP server or on a dedicated server.

Figure 29. Restore Config Browser Window

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.

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

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

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

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.

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.

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.

FunctionalityThe 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+filenameservername 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 InterfaceAfter 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

FileViewThis area shows the folders of different intermediate storage used by LTA.

Figure 30. Long Term Archive Explorer

9AKK101130D1382 419

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

Figure 31. File View

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 ServersThis area shows the 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.

Figure 32. Configured servers

9AKK101130D1382 421

LTA StatusThis area shows informations about the status of the LTA manager.

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.

Figure 33. LTA Status

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 statusThis area shows the status of the drives used by LTA manager.

9AKK101130D1382 423

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 ParametersThe figure below shows the LTA parameters management window.

Figure 34. LTA Drive Status

424 9AKK101130D1382

> 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

Figure 35. LTA Change Parameters

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

OverviewThe 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

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

RegistryIn 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

Select following menu:


> Programs

> ABB Industrial IT


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

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.

430 9AKK101130D1382

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

Figure 36. SysSetup - People Finder

9AKK101130D1382 431

New PhoneSelecting New Phone will be showed following window

> 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 IndexSelecting New Sms Index will be showed following window

Figure 37. SysSetup - People Finder - Configure New Phone

432 9AKK101130D1382

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

PhonesWhen the Phones item is selected, the right side of the dialog window changes.

Figure 38. SysSetup - People Finder - Configure New Sms Index

9AKK101130D1382 433

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.

Figure 39. SysSetup - Phones

434 9AKK101130D1382

Sms IndexOpening all items in the Index tree and selecting an item “Index n”, the right side of the dialog window changes.

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

Figure 40. SysSetup - Index N

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 “!”

> Don’t 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: don’t 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 “!”

> Don’t use numbers or upper case letters after a space in comments

> Don’t 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

FunctionalityFollowing 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/SlaveIn 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 UtilitiesBy 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

IntroductionPGP 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

The main features implemented on a PGP node can be subdivided as follows:

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

Figure 41. Example of PGP Architecture

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

AssumptionsThe 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 FunctionsPGP 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 FeaturesThe main data exchanged among servers, during the normal on-line operations, is related to the following functions.

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

442 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 FeaturesThe following functions are performed during the start-up phase of a server, in order to keep it updated the most as possible.

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

9AKK101130D1382 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 FunctionsSimilar 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 start-up.

ALIGNSPECS ProgramThis 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

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

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.

Figure 42. OPC Client

446 9AKK101130D1382

Multiple OPC Clients can be connected to multiple OPC Servers in a completely free architecture as shown in the figure below.

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.

Figure 43. OPC Client/Server Relationship

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.

Within each Group the client can define one or more OPC Items.

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

The PGP OPC server does not support public groups, neither any specific interfaces about such a groups. Only private groups are supported.

Figure 44. OPC Group/Item Relationship

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 ClientPGP 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 ServerThe 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 doesn’t 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 AcquisitionFor 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:

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.

Note 2:Any other refresh rate configured by the user will be rounded towards one of the above PGP supported rates.

Table 142. OPC Server Registry default values

Name Default Value

CacheTimeOut 2 seconds

DeviceTimeOut4 secondsSee note 1 at the end of the table.

StatusTimeOut 1 seconds

ItemPacketSize 500

Table 143. Client DA Refresh Rates

Code Description

500 500 milliseconds.

1 1 second

4 4 seconds

10 10 seconds

30 30 seconds

60 60 seconds

452 9AKK101130D1382

OPC Server Data AcquisitionOnce 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.


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

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

Table 146. Enum OPC Item Attributes.


IEnumOPCItemAttributes Yes

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

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.

Table 147. OPC Event Server


IOPCEventServer Yes

IOPCCommon Yes

IConnectionPointContainer Yes

Table 148. OPC Event Area Browser


IOPCEventAreaBrowser (optional) Yes

Table 149. OPC Event Subscript


IOPCEventSubscriptionMgt Yes

IConnectionPointContainer Yes

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 RegistrationThe PGP OPC Server must be registered on the machine, typing the following command:

OPCSERVER.EXE /REGSERVERThe OPC Server browser must be registered on the machine, typing the following command:

OPCENUM.EXE /REGSERVERThose registration are automatically performed when PGP is installed.

DCOM Security SettingIf 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:

Default Configuration Permissions:

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

Administrators Allow Launch

INTERACTIVE Allow Launch

SYSTEM Allow Launch

Administrators Full Control

CREATOR OWNER Full Control

Everyone Read

INTERACTIVE Special Access

SYSTEM Full Control

9AKK101130D1382 461

Allow Access to Everyone:

Use Custom Launch Permissions:

Use Custom Configuration Permissions:

Identity:

The interactive user

6. Click the Apply button.

7. Exit by clicking on the OK button.

SYSTEM Allow Access

Administrators Allow Launch

Everyone Allow Launch

INTERACTIVE Allow Launch

SYSTEM Allow Launch

Administrators Full Control

CREATOR OWNER Full Control

Everyone Read

INTERACTIVE Special Access

SYSTEM Full Control

462 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:

Such mapping is configurable and therefore it can be changed. It is stored in the "Power Generation Portal\deck\OpcPriority.xml" file :

PGP OPC5 1 - 2004 201 - 4003 401 - 6002 601 - 8001 801 - 1000

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 Tag Type Description1 ANALOG Analog.2 CLIF Configured logic interface function (not supported).3 DAANALG Data acquisition analog.4 DADIG Data acquisition digital.5 DADIGTL Data acquisition digital (not supported).6 DANG Data acquisition analog.7 DD Device driver.8 DEVSTAT Device status.9 DIGITAL Digital.10 INTANG Internal analog.11 INTDIG Internal digital.12 MSDD Multi state device driver.13 N90STA Symphony status.14 RCM Remote control memory.15 RMCB Remote motor control block.16 RMSC Remote manual set constant.17 STATION Station.18 TEXT Text selector tag.19 TEXTSTR Text string.20 UNDEF Undefined tag type.21 EXTANG External analog.22 EXTDIG External digital.23 ANGRPT Symphony generated analog.24 DIGRPT Symphony generated digital.25 LABANG Analog lab data entry.

9AKK101130D1382 469

26 LABDIG Digital lab data entry.27 CALCANG Analog calculated tag.28 CALCDIG Digital calculated tag.29 APMSSTA Node status.30 NODESTA Node status.31 BITMASK Mask of bits.32 COMPOSIT Composite.33 INTEGER Integer format.34 UINTEGER Unsigned integer format.35 BYTEARR Byte array format.36 ANAEIN Analog Extended input.37 ANAEOUT Analog Extended output.38 DIGEIN Digital Extended input.39 DIGEOUT Digital Extended output.40 DATETIME Date and Time format.41 DELTATIME Deltatime format.42 TCPADR TCP address.

Table 150. Tag Types.

Code Tag Type Description

470 9AKK101130D1382

Tag Sources

Default Color Map

Table 151. Tag Sources.

Code Tag Source Description1 C-NET Infinet tag.2 EXT Generic external communication.3 CALC Internal calculated tag.4 LAB Lab data entry tag.5 USER User application tag6 DEVSTA Device status tag.7 TAGGEN Generated tag.8 OPC OPC tag.9 Reserved10 AC800F AC800F tag.11 AC800M AC800M tag.12 MELODY MELODY tag.13 AC870P AC870P tag.14 PROP13 PRO Control P13 tag.

Table 152. Color Map.

Code Color0 Black1 Red2 Green3 Yellow4 Blue5 Magenta6 Cyan7 White8 Orange9 Slate Blue

9AKK101130D1382 471

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

10 Hot Pink11 Sea Green12 Spring Green13 Chocolate14 Lavender15 Sandy Brown16 Tomato17 Turquoise18 Deep Pink19 Dark Violet

Table 152. Color Map.

Code Color

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

ICI Action Codes

Table 153. Digital Tag Field Applicability.

Field DI RCM DD MSDD SPDT DCS MS ZEROSTATE * * * * * * *ONESTATE * * * * * * *TWOSTATE * * *THREESTATE * * *FOURSTATE toFVTEESTATE

*

FB1_0STATE * *FB1_1STATE * *FB2_0STATE * *FB2_1STATE * *FB3_0STATE *FB3_1STATE *FB4_0STATE *FB4_1STATE *

Table 154. ICI Action Codes.

Index Action Code Description1 X Skip. ICI ignore the tag.2 E Establish Only.3 C Establish and Connect.4 D Define for Output.

474 9AKK101130D1382

ICI Point Types

Table 155. ICI Point Types.

Code Point Type0 Not defined.1 Process Variable.2 Set-point Read.3 Control Output Read.4 Ratio Index Read.5 Analog Read.6 Station Status.7 Digital Read.8 Set-point Write.9 Control Output Write.10 Ratio Index Write.11 Station Mode.12 Analog Report.13 Digital Report.14 Module Status.15 RCM Read.16 RCM Write.17 Single Index Station.18 Station Report.19 RMSC Read.20 RMSC Report.21 R4 Analog Read.22 R4 Analog Report.23 Extended Module Status.24 to 28 Not Defined.29 DANG.30 Not Defined.31 Not Defined.32 DD.33 MSDD.

9AKK101130D1382 475

34 SPDT.35 to 52 Not Defined.53 RMCB.54 DDIG.55 to 59 Not Defined.60 Text Selector.

Table 155. ICI Point Types.

Code Point Type

476 9AKK101130D1382

Time Units

Instrument Types

Tag Quality BitsTag 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 156. Time Units.

Code Time Unit Description0 Sec. Seconds1 Min. Minutes2 Hours Hours3 Days Days4 Months Months5 Years Years

Table 157. Instrument Types.

Instrument Type Description1-5 V High Level. 4-20 mA High Level. TCK Type K thermocouple. TCJ Type J thermocouple. TCT Type T thermocouple. RTD RTD 100 ohms.

Table 158. Analog and Digital Tag Quality Bits.

Code Description0 Implemented1 Unacknowledged2 In alarm

9AKK101130D1382 477

3 Old data4 Off scan5 Reserved6 Inserted value7 Alarm check disabled8 Alarm inhibited9 Reserved10 Bad calculated value11 Application specific 312 Red tagged13 Hardware channel failure 14 Application specific 115 Application specific 2

Table 158. Analog and Digital Tag Quality Bits.

Code Description

478 9AKK101130D1382

System Information

Table 159. Analog (Only) Tag Quality Bits.

Code Description0 High instrument range1 2-High alarm limit2 High alarm limit3 Low alarm limit4 2-Low alarm limit5 Low instrument range6 Increasing ROC7 Decreasing ROC8 High deviation9 Low deviation10 Integer format11 Tracking12 3-High alarm limit13 3-Low alarm limit14 Auto/Manual15 Dummy Packet (Playback only)

Table 160. Tag Configuration Retrieving Parameters.

Parameter Description ProductName Name of the ProductShortProductName Short name of the ProductFullProductName Full name of the ProductProductFamily Family Name of the ProductProductVersion Version of the productProductCompany Company Name of the ProductProductCorporate Corporate Name of the ProductVersion Release versionSubVersion Release sub-versionBuild Build Version

9AKK101130D1382 479

HotFix Hot FixMaximumTags Number of tagsMaximumConfiguredTags Numer of Tags ConfiguredMaximumCrts Maximum number of ClientsMaximumPV Maximum number of PVMaximumDI Maximum number of DIMaximumPlaybacks Apms ParameterMaximumPrinters Maximum number of PrintersMaximumICI Maximum number of ICIsMaximumICIIndex Number of ICI indexMaximumCalculations Maximum number of Calculation BlocksMaximumTrendGroups Maximum Number of Historical GroupsMaximumTagInfoType Maximum Tag Info TypeMaximumFileKey Maximum File KeyMaximumTotalizationLogs Maximum Number of TotalizationsMaximumSoeEvents Maximum Events for SOEMaximumMaintenanceLogs Maximum Number of maintenanceMaximumPTLArchives Maximum Number of Post Trip LogsMaximumDisplays Maximum Nuber of DisplaysMaximumOpConfDisplays Maximum Nuber of Op Conf DisplaysMaximumAlarmPriorities Maximum Numer of Alarm PrioritiesMaximumAlarmGroups Maximum # of alarm groupsMaximumFiles Maximum number of FilesMaximumTagNameLenght Maximum Lenght of Tag Name in presentationsMaximumTagDescrlenght Maximum Lenght of Tag Description in presentationsMaximumTagsetLenght Maximum Lenght of Logic State Descr in presentationsRecordsInPtlFiles Apms ParameterRecordsInPlaybackFiles Apms ParameterEntriesInPlbQueue Apms ParameterEntriesInPtlQueue Apms ParameterEntriesInPlbmemory Apms ParameterEntriesInCompressedPlbFiles Apms Parameter


Parameter Description

480 9AKK101130D1382

HistDataRetrievalLimit Apms ParameterMaxTagPerGroup Maximum tags per Historical GroupMaximumAlacPrograms Number of Alarm Action ProgramsMaximumPlaybackDays Maximum Number of Days for Keeping Playback archiveMaximumIndexNo Maximum Tag IndexMaximumSoeDevices Maximum SOE DeviceNumberOfPlaybackFiles Number of files reserved for PlaybackMaximumPtlDays Maximum Number of Days for Keeping PTL archiveMaximumPlantUnits Apms ParameterLicensedClients Number of Clients licensedLicensedAPI API is LicensedLicensedSpecificAPI Specific API is LicensedLicensedODBC ODBC is LicensedLicensedWeb WEB is LicensedLicensedPrc_Infi Process Control for INFI is LicensedLicensedDisplayBuilder Display Builder is LicensedLicensedDaOpcServer Licensed DA Opc ServerLicensedAeOpcServer Licensed AE OPC ServerLicensedHdaOpcServer Licensed HDA OPC ServerLicensedDawOpcServer Licensed DA- write OPC ServerLicensedOPCTags Numer of tags licensed for OPCLicensedDDE DDE is LicensedLicensedTags Number of Tags licensedLicensedHistTags Number of Tags LicensedLicensedSimulation Simulation is LicensedLicensedCalculation Calculation is LicensedLicensedCalcSteam Steam Calculation is LicensedLicensedCalcMacro Macro Calculation is LicensedLicensedScanDrivers Scanner Drivers are LicensedLicensedAPI_RT API RunTime is LicensedLicensedPrc_Ac800f Process Control is LicensedLicDrv_Infi Driver for INFI is Licensed



9AKK101130D1382 481

LicDrv_Dci Driver for DCI is LicensedLicDrv_Odbc Driver for ODBC is LicensedLicDrv_Modbus Driver for Modbus is LicensedLicDrv_OpcClient Driver for is LicensedLicDrv_Spabus Driver for Spabus is LicensedLicDrv_Iec101 Driver for Iec101 is LicensedLicDrv_Iec104 Driver for Iec104 is LicensedLicDrv_Text Driver for Text is LicensedLicDrv_Teleperm Driver for teleperm is LicensedLicDrv_GsmMarkV Driver for GsmMarkV is LicensedLicDrv_Iec103 Driver for Iec103 is LicensedLicDrv_XX2 Driver for XX2 is LicensedLicDrv_XX3 Driver for XX3 is LicensedrLicDrv_XX4 Driver for XX4 is LicensedLicDrv_XX5 Driver for XX5 is LicensedLicDrv_App Application Driver is LicensedLicAppl_MaintTrigger Maint Trigger Application is LicensedLicAppl_XmlToCmms Xml To CMMS Application is LicensedLicAppl_PPP PPP Application is LicensedLicAppl_DPP DPP Application is LicensedLicAppl_TSE TSE Application is LicensedLicAppl_BSE BSE Application is LicensedLicAppl_TPA TPA Application is LicensedLicAppl_STP STP Application is LicensedLicAppl_TSEOP TSEOP Application is LicensedLicAppl_BSEOP BSEOP Application is LicensedLicAppl_MSFDPP MSFDPP Application is LicensedLicAppl_CPA CPA Application is LicensedLicAppl_Harmony_Cfg Harmony Cfg Application is LicensedLicAppl_XX2 XX2 Application is LicensedLicAppl_XX3 XX3 Application is LicensedLicAppl_XX4 XX 4Application is Licensed



482 9AKK101130D1382

LicAppl_XX5 XX5 Application is LicensedLicAppl_PeopleFinder People Finder is LicensedLicensedPrc_Ac870p Licensed Process Control for Ac870PLicensedPrc_ProP13 Licensed Process Control for ProP13LicenseExpiration License expirationServerName Server NameIsServer Apms ParameterIsSystemActive The system is activeIsRundownInProgress System shutdown in progressIsSimulationActive Simulation is ActiveIsSimulationFrozen Simulation is FrozenClientName Name of ClientCurrentTimeIM Current TimeCurrentTimeString Current Time (string)CurrentExTimeX Current TimeConvertedTime Converted TimeCurrentOSTimeX Current Time from OSStartupTimeIM Time of Last StartupPercentDiskUsed_A Percentage of use of Disk APercentDiskUsed_B Percentage of use of Disk BPercentDiskUsed_C Percentage of use of Disk CPercentDiskUsed_D Percentage of use of Disk DPercentDiskUsed_E Percentage of use of Disk EPercentDiskUsed_F Percentage of use of Disk FPercentDiskUsed_G Percentage of use of Disk GPercentDiskUsed_H Percentage of use of Disk HPercentDiskUsed_I Percentage of use of Disk IPercentDiskUsed_J Percentage of use of Disk JPercentDiskUsed_K Percentage of use of Disk APercentDiskUsed_L Percentage of use of Disk LPercentOJUsed Percentage of use of Operator Journal FilePercentPlaybackUsed Percentage of use of Playback Archive



9AKK101130D1382 483

PercentCpuLoad Percent of CPU LoadPercentMemoryUsed Apms ParameterPhysicalMemory Size of Physical MemoryIsLowResources Low System ResourcesLoggedUser Name of Logged UserLoginTime Time of LoginLogoffTimeout Timeout For Auto LogoffLoggedUserRecord Record Index of Logged UserLoggedUserID ID of Logged UserLocalNode Local NodeIsSystemMaster The system is masterMasterNode Index of the Master NodeNodeWeight Node WeightIsConfigAligned Configuration is AlignedIsOjAligned Operator Journal file is AlignedIsHistAligned Historical Files are alignedIsPlbAligned Playback Archive is AlignedIsPtlAligned Post Trip Log Archive is AlignedIsNodeAligned Node is AlignedIsAlignInProgress Node Alignment in ProgressNodeAligning Apms ParameterNodeStatusMask Node Status MaskNetWorkerLifeCycle Life Cycle for NetworkerNodeConnected Nmber of nodes connectedConnectionTime Connection timeConnectionUpdate Connection UpdateAlarmPrintMask Mask of Enabled Alarm PrintersIgnoreRio Ignore Remote IO AlarmsOisTimeSynch Time Synch INFI as OISDstOnInfi DST sent on INFIFlagOldAlarms Apms ParameterInfiTimeSynch Time Synch Infi



484 9AKK101130D1382

UnackAlarm New Alarms are UnckedPercentSaveOJ Apms ParameterLadValueUpdate Update tag value on Alarm DisplayQueueSOEtoDip Queue Sequence of Events to Data ProcessorQueueSOEtoLog Queue Sequence of Events to Log processorExceptionScreen Apms ParameterDisableAudibleOnAck Apms ParameterPlaybackCompress Compress PlaybackMsddFeedbacksInverted Invert Feedbacks on MSDD popupBadQualityAlarms Bad Quality marked as AlarmsRemoteClients Apms ParameterAlarmsWithMillisec Alarm Time includes MillisecondsAlarmsAckBroadcast Broadcast Alarm AcknowledgementsAlarmsSilBroadcast Broadcast Alarm SilencingLanguage Human Machine LanguageRedTagCommands Commands arfe enabled if Red TagEnableAlarmPrintouts Enable Printouts of all alarmsIncrementControls Rate for Control IncrementFastIncrementControls Rate for Control Fast IncrementDemoSystem Demo SystemAlarmsPerLad Maximum Alarm Messages per DisplayEUText Engineering Unit TextLSDText Logic State Descriptor TestsQf1bad Mask of Quality Flag 1 for BadQf2bad Mask of Quality Flag 2 for BadTimeUnitText Time Unit TextTagTypeText Tag Type TextHistArchText Historical Archive TextHistArchHDB Historical Archive DBTypeInfo Type InfoTagInfoType Tag Info TypeAlarmBitmap Alarm Bitmap



9AKK101130D1382 485

WeekTimeInfo Day Of the WeekDayLightSavingTimeInfo Day Light Saving Time is ONSoeQueueEntries Entries in Sequence of Events QueueCompositeTime TIme in Composite FormatStandaloneSystem System StandaloneAlacQueueEntries Entries in Alarm Action QueueFirstPlaybackFile Key for First Playback FileFirstPTLFile Key of first Post Trip Log FileNumberOfPTLFiles Number of files reserved for PTLFirstHistorianFile Key of first Historical FileFirstHistorianRetrievedFile Key of first Historical Retrieved FileFirstHistorianGhostFile Key of first Historical GhostFileNumberOfHistorianGhostFiles Number of Historical Retrived FilesOpstationLayout Operator Station LayoutOpstationDisplay Operator Station DisplayAlarmMimic Alarm MimicOdbcInterface ODBC InterfaceOdbcTagHistory ODBC Tag HistoryRundownNotInProgress Rundown Not In ProgressDipQueueEntries Entries in Data Input Processor QueueuOdbcQueueEntries Entries in ODBC queueIciStatus Status of the ICITextSelector Text SelectorTagset TagsetAlarmComment Alarm CommentNationalLanguage National languageUserPar1 User Application Parameter 1UserPar2 User Application Parameter 2UserPar3 User Application Parameter 3UserPar4 User Application Parameter 4UserPar5 User Application Parameter 5UserPar6 User Application Parameter 6



486 9AKK101130D1382

UserPar7 User Application Parameter 7UserPar8 User Application Parameter 8LongTermPlayback Playback Saved for Long TermPlbComprHorzBand Playback Compression Horizontal DeadBandPlbComprSlopeBand Playback Compression Slope BandTimeZone Time ZonerIgnoreAlarmGroup0 Ignore Alarms belonging to Group ZeroNodesInNetwork Number of Nodes in NetworkPopupTimeout Timeout for PopupsBlackPopups Popups with Black BackgroundRequestReport Trigger for requesting ReportsDSysUseUID Use tag UID in Network messagesNetQueEntries Entries in Network queuePopupToBeSelected Popu to be selected to enable commandsCalculReload Trigger for Reloading CalculationsSecurityGroup Security GroupSecurityLevel Security LevelSecurityPrivileges Security PrivilegesConnectionCnt Nodes Connection CountEnableEventPrint Enable Pinting of Event MessagesAlarmsWithStdDate Enable STD time format for alarmsControlAcknowlegmentRequired Acknowledgement fo Control is RequiredIncrementControlsRate Rate for Control IncrementOpcQueEntries Entriesd in OPC queueGenDiagStatus General Diagnostic StatusNetWorkerStatus NetWorker StatusOpcClientStatus OPC Client StatusOpcServerStatus OPC Server StatusDipReload Trigger for Reloading the Data Input ProcessorOpcReload Trigger for Reloading OPCHistReload Trigger for Reloading HistorySmsReload Trigger for Reloading People Finder



9AKK101130D1382 487

AudibleCode Code of Alarm AudibleAudibleFile File for Alarm AudibleAtomSeparator Character for Atom SepatationSmsEnabled People Finder is EnabldSmsActive People Finder Error logging is ActiveSmsErrors People Finder Error logging is EnabledSmsAckAll People Finder Acknowlege All AlarmsSmsAck People Finder Acknowlege AlarmsBuildTagInProgress Tag Builder is in ProgressScannerReload Trigger for Reloading the ScannerSimulationState Simulation StateSimulationRate Simulation ReateOpstaPlantUnit Apms ParameterPlantUnitMatch Apms ParameterUserReload Apms ParameterOpcAERefresh OPC AE Refresh FileInfoX File InfoFileVersion File VersionDisableAutoNetMasterSwitch Disable Auto-Switch from Master to SlaveLocalRemoteControlInhibitTagDX Tag for Local-Remote ControlV23Reload Trigger for Reloading V23 logicV23Recalculate Recalculate Voting 2 of 3NumMultipleOutputDrivers Number of Output DriversFreezeDIP Data Input Process is FrozenPlbSwitch Playback Switch



488 9AKK101130D1382

Tag Configuration Retrieving Parameters


Parameter Description DB_TAGINDEX IndexDB_TAGNAME NameDB_TAGDESC DescriptionDB_TAGIDX Internal Tag IndexDB_TAGTYPE Tag TypeDB_TAGTYPEDESCR Tag Type DescriptionDB_TAGSRC Tag SourceDB_VALUE Current ValueDB_RAWVALUE Current Raw ValueDB_NUMVALUE Numeric ValueDB_NUMUVALUE Numeric Unsigned ValueDB_PERCENT_VALUE Percent ValueDB_QUALITY Current QualityDB_TIMESTAMP Time StampDB_TIMESTAMP_TEXT Time Stamp TextDB_ISO_TIMESTAMP Time StampDB_VALUE_QUALITY Current Value and QualityDB_VALUE_QUALITY_RA Current Value and QualityDB_EXTQUALITY Current QualityDB_TAGVAL Current Value and QualityDB_TAGVALEX Current Value and QualityDB_TSTAMP_VALUE_QUALITY TimestampDB_TVQ_STRING Timestamp (string)DB_CUSTTAGID Plant Tag NameDB_AL_PRI Current Alarm PriorityDB_AL_CAT Alarm Processing CategorizedDB_ALMGROUP Alarm GroupDB_EUDESC Engineering UnitDB_EUINDEX EU IndexDB_NUMDECPL Decimal Places

9AKK101130D1382 489

DB_I4_DATA Integer FormatDB_FGCOLOR Foreground ColorDB_BGCOLOR Background ColorDB_FGCOLORREF Foreground Color Ref.DB_BGCOLORREF Background Color Ref.DB_FGCOLORSTRING Foreground Color StringDB_BGCOLORSTRING Background Color StringDB_ALRMCMNT1 RTN CommentDB_ALRMCMNT2 Hi Alarm CommentDB_ALRMCMNT3 Lo Alarm CommentDB_ALRMCMNT4 2-Hi Alarm CommentDB_ALRMCMNT5 2-Lo Alarm CommentDB_ALRMCMNT6 3-Hi Alarm CommentDB_ALRMCMNT7 3-Lo Alarm CommentDB_ALRMCMNT8 Hi Deviation CommentDB_ALRMCMNT9 Lo Deviation CommentDB_ALRMCMNT10 Hi ROC Alarm CommentDB_ALRMCMNT11 Lo ROC Alarm CommentDB_ALRMCMNT12 Event CommentDB_ALRMCMNT13 Channel Failure CommentDB_PRIMDISP Primary DisplayDB_PRIMGROUP Primary Trend GroupDB_SEC_LEVEL Security LevelDB_SEC_GROUP Security GroupDB_AAP_NUM Alarm Action ProgramDB_ACK_PROG Activate on AckDB_RTN_PROG Activate on RTNDB_ALM_PROG Activate on AlarmDB_EVT_PROG Activate on EventDB_HI_PROG Activate on HIDB_H23_PROG Activate on H3-H2DB_H_PROG Activate on H



490 9AKK101130D1382

DB_L_PROG Activate on LDB_L23_PROG Activate on L3-L2DB_LI_PROG Activate on LIDB_HR_PROG Activate on PROCDB_LR_PROG Activate on NROCDB_AL_REM Remote Alarm ProcessingDB_TRIG_CALC Triggered CalculationDB_ICI_NUM ICI NumberDB_ICI_NDX ICI IndexDB_LOOP RingDB_PCU PcuDB_MODULE ModuleDB_BLOCK BlockDB_SER_NUMBER SER NumberDB_SER_INDEX SER IndexDB_ICISTA_CD ICI Action CodeDB_AUD_IDX Audible Alarm IndexDB_OIS_ALA OIS Alarm Proc.DB_DS_ALARM Display AlarmsDB_PR_ALARM Print AlarmsDB_SV_ALARM Save AlarmsDB_AUD_ALARM Activate AudibleDB_AUD_RTN Audible on RTNsDB_BOT_ALARM Bottom of ScreenDB_DS_RTN Display RTNsDB_PR_RTN Print RTNsDB_SV_RTN Save RTNsDB_DS_STCHNG Display EventsDB_PR_STCHNG Print EventsDB_SV_STCHNG Save EventsDB_PR_OPACT Print ActionsDB_SV_OPACT Save Actions



9AKK101130D1382 491

DB_PR_INFO Print InfosDB_SV_INFO Save InfosDB_REM_ONACK Remove on AckDB_INFO_ONACK Info on AckDB_NO_UNACK Do not set UnackDB_ALARM_MIMIC Display Mimic when alarmDB_ACK_BROAD Broadcast Ack to the fieldDB_APPL_ALA Trigger Application EventDB_EXP_ALA Export Alarms to Foreign DBDB_OPC_ALARM Export Alarms to OPC ServerDB_SMSINDEX SMS index for AlarmsDB_ALMINHTAG Alarm Inhibit TagDB_CTRLINHTAG Control Inhibit TagDB_CONFIRM_COMMAND Need Confirm CommandDB_CTRLCMDTAG Control Commad TagDB_HVARALMTAG Hi Variable Alarm TagDB_H2VARALMTG 2-Hi Variable Alarm TagDB_H3VARALMTG 3-Hi Variable Alarm TagDB_LVARALMTAG Lo Variable Alarm TagDB_L2VARALMTG 2-Lo Variable Alarm TagDB_L3VARALMTG 3-Lo Variable Alarm TagDB_CTRLINH Control InhibitDB_REMOTE_CTRLINH Remote Control InhibitDB_LOCAL_CTRLINH Local Control InhibitDB_S_COORD Slave Module CoordinatesDB_S_TYPE Slave Module TypeDB_S_TTID Termination Unit TypeDB_S_TOBO Termination Unit IdentifierDB_S_TTCO Termination Unit CoordinatesDB_S_SMOD S-Slave ModuleDB_S_SCHA S-Slave ChannelDB_S_FRBO Field Cabinet Identifier



492 9AKK101130D1382

DB_S_MODULE Slave ModuleDB_S_CHANNEL Slave ChannelDB_OFFSCINI Off Scan InitiallyDB_OFFALINI Off Alarm Check InitiallyDB_INITVAL Initial ValueDB_SCA_VAL_0 0% Presentation ScaleDB_SCA_VL_100 100% Presentation ScaleDB_VIOL_CD Violation CodeDB_VIOL_SCAN Off Scan on ViolationDB_UT_TEXT Text (10 characters)DB_UT_TEXT1 Text (16 characters)DB_UT_TEXT2 Text (32 characters)DB_UT_IN1 Integer 1DB_UT_IN2 Integer 2DB_UT_IN3 Integer 3DB_UT_IN4 Integer 4DB_UT_RE1 Real 1DB_UT_RE2 Real 2DB_UT_RE3 Real 3DB_UT_RE4 Real 4DB_UT_RE5 Real 5DB_UT_RE6 Real 6DB_VAL100 High Instrument LimitDB_VAL0 Low Instrument LimitDB_LALARM Low Alarm LimitDB_L2ALARM 2-Low Alarm LimitDB_L3ALARM 3-Low Alarm LimitDB_HALARM High Alarm LimitDB_H2ALARM 2-High Alarm LimitDB_H3ALARM 3-High Alarm LimitDB_LROC_LIMIT Increasing Rate Of ChangeDB_HROC_LIMIT Decreasing Rate Of Change



9AKK101130D1382 493

DB_H3_DELTA 3-Hi Variable Alarm DeltaDB_H2_DELTA 2-Hi Variable Alarm DeltaDB_L2_DELTA 2-Lo Variable Alarm DeltaDB_L3_DELTA 3-Lo Variable Alarm DeltaDB_SPAN SpanDB_H_ACTIVE H-Limit ActiveDB_H2_ACTIVE H2-Limit ActiveDB_H3_ACTIVE H3-Limit ActiveDB_L_ACTIVE L-Limit ActiveDB_L2_ACTIVE L2-Limit ActiveDB_L3_ACTIVE L3-Limit ActiveDB_HR_ACTIVE HR ActiveDB_LR_ACTIVE LR ActiveDB_LI_ACTIVE LI ActiveDB_HI_ACTIVE HI ActiveDB_ALARMDB Alarm DeadbandDB_ALARMDB_PERC Alarm Deadband (percent)DB_EVENTTAG Event TagDB_ISALARM0 State is AlarmDB_ISALARM1 State is AlarmDB_ISALARM2 State is AlarmDB_ISALARM3 State is AlarmDB_ISALARM4 State is AlarmDB_ISALARM5 State is AlarmDB_ISALARM6 State is AlarmDB_ISALARM7 State is AlarmDB_ISALARM8 State is AlarmDB_ISALARM9 State is AlarmDB_ISALARM10 State is AlarmDB_ISALARM11 State is AlarmDB_ISALARM12 State is AlarmDB_ISALARM13 State is Alarm



494 9AKK101130D1382

DB_ISALARM14 State is AlarmDB_ISALARM15 State is AlarmDB_ISALARM16 State is AlarmDB_ISALARM17 State is AlarmDB_ISALARM18 State is AlarmDB_ISALARM19 State is AlarmDB_ISALARM20 State is AlarmDB_ISALARM21 State is AlarmDB_ISALARM22 State is AlarmDB_ISALARM23 State is AlarmDB_ISALARM24 State is AlarmDB_ISALARM25 State is AlarmDB_ISALARM26 State is AlarmDB_ISALARM27 State is AlarmDB_ISALARM28 State is AlarmDB_ISALARM29 State is AlarmDB_ISALARM30 State is AlarmDB_ISALARM31 State is AlarmDB_ALARM_MASK Alarm BitMaskDB_MAX_ROC Maximum Rate of ChangeDB_ALMACK_NET_MASK Dest. node mask for alarm ackDB_NET_NODE_SOURCE Source node maskDB_TAGVAL_NET_MASK Dest. node mask for valuesDB_CONFIG_NET_MASK Dest. node mask for configDB_TOTALIZER_NUM Totalization LogDB_TRIP_NUM Trip LogDB_RPT_NUM Report NumberDB_TOTALIZER_1_MIN Totalizer 1 min.DB_TOTALIZER_10_MIN Totalizer 10 min.DB_TOTALIZER_30_MIN Totalizer 30 min.DB_TOTALIZER_1_HOUR Totalizer 1 hourDB_TOTALIZER_8_HOUR Totalizer 8 hour



9AKK101130D1382 495

DB_TOTALIZER_1_DAY Totalizer 1 dayDB_TOTALIZER_1_MONTH Totalizer 1 monthDB_TOTALIZER_1_YEAR Totalizer 1 yearDB_TOTALIZED_1_MIN Totalized 1 min.DB_TOTALIZED_10_MIN Totalized 10 min.DB_TOTALIZED_30_MIN Totalized 30 min.DB_TOTALIZED_1_HOUR Totalized 1 hourDB_TOTALIZED_8_HOUR Totalized 8 hourDB_TOTALIZED_1_DAY Totalized 1 dayDB_TOTALIZED_1_MONTH Totalized 1 monthDB_TOTALIZED_1_YEAR Totalized 1 year.DB_HRT_TOTSTA Totalized number of startDB_HRT_TOTSTO Totalized number of stopDB_HRT_TOTTON Totalized running timeDB_HRT_TOTTLR Totalized time from last resetDB_HRT_TOTTOF Totalized stop timeDB_HRT_TOTTIN Totalized BAD quality timeDB_HRT_TOTDWN Totalized system shutdown timeDB_PLB_COMPR Playback CompressionDB_PLB_LTKEEP Long Term Playback ArchiveDB_PLB_RECORD Playback ArchiveDB_REL_DB Export Values to Foreign DBDB_EXPFIL Export Values to FileDB_ZEROSTATE State 0DB_ONESTATE State 1DB_TWOSTATE State 2DB_THREESTATE State 3DB_FOURSTATE State 4DB_FIVESTATE State 5DB_SIXSTATE State 6DB_SEVENSTATE State 7DB_EIGTHSTATE State 8



496 9AKK101130D1382

DB_NINESTATE State 9DB_TENSTATE State 10DB_ELEVNSTATE State 11DB_TWELVSTATE State 12DB_THTEESTATE State 13DB_FRTEESTATE State 14DB_FVTEESTATE State 15DB_FB1_0STATE Feedback 1 State 0DB_FB1_1STATE Feedback 1 State 1DB_FB2_0STATE Feedback 2 State 0DB_FB2_1STATE Feedback 2 State 1DB_FB3_0STATE Feedback 3 State 0DB_FB3_1STATE Feedback 3 State 1DB_FB4_0STATE Feedback 4 State 0DB_FB4_1STATE Feedback 4 State 1DB_SET_POINT Set Point indexDB_CONTROL_POINT Control Point IndexDB_RATIO_INDEX Ratio IndexDB_STATION_STATUS Station Status IndexDB_CONSTDELTA Hourly Constancy DeltaDB_CONTROLINCDEC Increment/decrement %DB_FASTCONTROLINCDEC Fast Inc./dec. %DB_PLAYBACKDB Playback DeadbandDB_PLAYBACKTM Playback TimerDB_PVCACT Alarm Active MaskDB_INH_CHAIN Alarm Inhibition ChainDB_CONTROL_TYPE Control TypeDB_LAST_UPDATE Last Data Base UpdateDB_IS_DEFINED Tag DefinedDB_LAD_LEVEL Alarm Group LevelDB_LAD_HAS_SUBGROUP Alarm Group With SubgroupsDB_LAD_SUMMARY Alarm Group Summary



9AKK101130D1382 497

DB_LOCALHOST Local HostDB_NODEWEIGHT Node WeightDB_QUALITYEX Current Decoded QualityDB_COLOR_ATTRIBUTES Alarm Color AttributesDB_ALARM_COMMENT Current Alarm CommentDB_ANY_ALARM_COMMENT Any Alarm CommentDB_PLANT_UNIT Plant UnitDB_PLANT_UNIT_NAME Plant Unit NameDB_ALMACKNL Alarm ack broad. node listDB_OPCSRVVIS OPC Server visibilityDB_ALPRINUM Alarm printer numberDB_TAG_GUID Tag global UIDDB_TAG_GUID_SZ Tag global UID (formatted)DB_SOE_NUM Triggered SOE numberDB_SOE_TYPE Triggered SOE typeDB_COMPRESSION_SPAN Plb compr. span (%)DB_DEV_TYPE Device TypeDB_DEV_NUMBER Device NumberDB_DEV_NAME Device NameDB_MODTYPE Module TypeDB_MODREV Module Rev.DB_OTXIDX Output Transfer Tag IndexDB_OTXENB Output Transfer EnabledDB_OPERPARAM Operating ParameterDB_OPCPROGID OPC Program IDDB_OPCCMPTR OPC Computer nameDB_OPCITEMID OPC Item IDDB_OPCACCPATH OPC Access pathDB_OPCREFRESH OPC Refresh timeDB_OPCREADTYP OPC Read typeDB_OPCCLIENT Export to Client OPCDB_OPCSERVER Export to Server OPC



498 9AKK101130D1382

DB_OPCALARMSOURCE OPC Alarm SourceDB_EXTDESC Extended DescriptionDB_MAINT_TRIG Maintenance TriggerDB_FIELD_AD1 Field Address 1DB_FIELD_AD2 Field Address 2DB_FIELD_AD3 Field Address 3DB_FIELD_AD4 Field Address 4DB_FIELD_AD5 Field Address 5DB_FIELD_AD6 Field Address 6DB_FIELD_AD7 Field Address 7DB_FIELD_AD8 Field Address 8DB_FIELD_AD9 Field Address 9DB_FIELD_AD10 Field Address 10DB_FIELD_DRV Field Driver NameDB_FIELD_TX1 Field Drv Text 1DB_FIELD_TX2 Field Drv Text 2DB_FIELD_TX3 Field Drv Text 3DB_FIELD_TX4 Field Drv Text 4DB_FIELD_TX5 Field Drv Text 5DB_FIELD_TX6 Field Drv Text 6DB_FIELD_TX7 Field Drv Text 7DB_FIELD_TX8 Field Drv Text 8DB_FIELD_TX9 Field Drv Text 9DB_FIELD_TX10 Field Drv Text 10DB_DRV_INDEX Driver Index 1DB_DRV_INDEX2 Driver Index 2DB_DRV_INDEX3 Driver Index 3DB_DRV_INDEX4 Driver Index 4DB_DRV_INDEX5 Driver Index 5DB_DRV_INDEXIN Driver Input IndexDB_DATA_PROCESSOR Data Processor NameDB_OUT1_AD1 Output Address 1



9AKK101130D1382 499

DB_OUT1_AD2 Output Address 2DB_OUT1_AD3 Output Address 3DB_OUT1_AD4 Output Address 4DB_OUT1_AD5 Output Address 5DB_OUT1_AD6 Output Address 6DB_OUT1_AD7 Output Address 7DB_OUT1_AD8 Output Address 8DB_OUT1_AD9 Output Address 9DB_OUT1_AD10 Output Address 10DB_OUT1_DRV Output Driver NameDB_OUT1_TX1 Output Drv Text 1DB_OUT1_TX2 Output Drv 1 Text 2DB_OUT1_TX3 Output Drv 1 Text 3DB_OUT1_TX4 Output Drv 1 Text 4DB_OUT1_TX5 Output Drv 1 Text 5DB_OUT1_TX6 Output Drv 1 Text 6DB_OUT1_TX7 Output Drv 1 Text 7DB_OUT1_TX8 Output Drv 1 Text 8DB_OUT1_TX9 Output Drv 1 Text 9DB_OUT1_TX10 Output Drv 1 Text 10DB_OUT2_AD1 Output 1 Address 1DB_OUT2_AD2 Output 1 Address 2DB_OUT2_AD3 Output 1 Address 3DB_OUT2_AD4 Output 1 Address 4DB_OUT2_AD5 Output 1 Address 5DB_OUT2_AD6 Output 1 Address 6DB_OUT2_AD7 Output 1 Address 7DB_OUT2_AD8 Output 1 Address 8DB_OUT2_AD9 Output 1 Address 9DB_OUT2_AD10 Output 1 Address 10DB_OUT2_DRV Output Driver NameDB_OUT2_TX1 Output 2 Drv Text 1



500 9AKK101130D1382

DB_OUT2_TX2 Output 2 Drv Text 2DB_OUT2_TX3 Output 2 Drv Text 3DB_OUT2_TX4 Output 2 Drv Text 4DB_OUT2_TX5 Output 2 Drv Text 5DB_OUT2_TX6 Output 2 Drv Text 6DB_OUT2_TX7 Output 2 Drv Text 7DB_OUT2_TX8 Output 2 Drv Text 8DB_OUT2_TX9 Output 2 Drv Text 9DB_OUT2_TX10 Output 2 Drv Text 10DB_TAGGEN Generator TagDB_COMPONENT Component TagDB_FACEPLATE FaceplateDB_FEEDBACK1 Feedback 1DB_FEEDBACK2 Feedback 2DB_FEEDBACK3 Feedback 3DB_FEEDBACK4 Feedback 4DB_AUTOMAN Auto/ManualDB_GOODSTATE Good StateDB_REQSTATE Requested StateDB_REDTAG Red TagDB_PERMISSIVE1 Permissive 1DB_PERMISSIVE2 Permissive 2DB_ASPECT1NAM Name of Aspect #1DB_ASPECT1CMD Command for Aspect #1DB_ASPECT2NAM Name of Aspect #2DB_ASPECT2CMD Command for Aspect #2DB_ASPECT3NAM Name of Aspect #3DB_ASPECT3CMD Command for Aspect #3DB_ASPECT4NAM Name of Aspect #4DB_ASPECT4CMD Command for Aspect #4DB_ASPECT5NAM Name of Aspect #5DB_ASPECT5CMD Command for Aspect #5



9AKK101130D1382 501

DB_NUMATOMS Number of AtomsDB_ATOM1NAM Name for Atom #1DB_ATOM1VAL Value for Atom #1DB_ATOM2NAM Name for Atom #2DB_ATOM2VAL Value for Atom #2DB_ATOM3NAM Name for Atom #3DB_ATOM3VAL Value for Atom #3DB_ATOM4NAM Name for Atom #4DB_ATOM4VAL Value for Atom #4DB_ATOM5NAM Name for Atom #5DB_ATOM5VAL Value for Atom #5DB_ATOM6NAM Name for Atom #6DB_ATOM6VAL Value for Atom #6DB_ATOM7NAM Name for Atom #7DB_ATOM7VAL Value for Atom #7DB_ATOM8NAM Name for Atom #8DB_ATOM8VAL Value for Atom #8DB_ATOM9NAM Name for Atom #9DB_ATOM9VAL Value for Atom #9DB_ATOM10NAM Name for Atom #10DB_ATOM10VAL Value for Atom #10DB_ATOM11NAM Name for Atom #11DB_ATOM11VAL Value for Atom #11DB_ATOM12NAM Name for Atom #12DB_ATOM12VAL Value for Atom #12DB_ATOM13NAM Name for Atom #13DB_ATOM13VAL Value for Atom #13DB_ATOM14NAM Name for Atom #14DB_ATOM14VAL Value for Atom #14DB_ATOM15NAM Name for Atom #15DB_ATOM15VAL Value for Atom #15DB_ATOM16NAM Name for Atom #16



502 9AKK101130D1382

DB_ATOM16VAL Value for Atom #16DB_ATOM17NAM Name for Atom #17DB_ATOM17VAL Value for Atom #17DB_ATOM18NAM Name for Atom #18DB_ATOM18VAL Value for Atom #18DB_ATOM19NAM Name for Atom #19DB_ATOM19VAL Value for Atom #19DB_ATOM20NAM Name for Atom #20DB_ATOM20VAL Value for Atom #20DB_ATOM21NAM Name for Atom #21DB_ATOM21VAL Value for Atom #21DB_ATOM22NAM Name for Atom #22DB_ATOM22VAL Value for Atom #22DB_ATOM23NAM Name for Atom #23DB_ATOM23VAL Value for Atom #23DB_ATOM24NAM Name for Atom #24DB_ATOM24VAL Value for Atom #24DB_ATOM25NAM Name for Atom #25DB_ATOM25VAL Value for Atom #25DB_ATOM26NAM Name for Atom #26DB_ATOM26VAL Value for Atom #26DB_ATOM27NAM Name for Atom #27DB_ATOM27VAL Value for Atom #27DB_ATOM28NAM Name for Atom #28DB_ATOM28VAL Value for Atom #28DB_ATOM29NAM Name for Atom #29DB_ATOM29VAL Value for Atom #29DB_ATOM30NAM Name for Atom #30DB_ATOM30VAL Value for Atom #30DB_ATOM31NAM Name for Atom #31DB_ATOM31VAL Value for Atom #31DB_ATOM32NAM Name for Atom #32



9AKK101130D1382 503




504 9AKK101130D1382




9AKK101130D1382 505




506 9AKK101130D1382




9AKK101130D1382 507

DB_ATOM96VAL Value for Atom #96DB_ATOM97NAM Name for Atom #97DB_ATOM97VAL Value for Atom #97DB_ATOM98NAM Name for Atom #98DB_ATOM98VAL Value for Atom #98DB_ATOM99NAM Name for Atom #99DB_ATOM99VAL Value for Atom #99DB_ATOM100NAM Name for Atom #100DB_ATOM100VAL Value for Atom #100DB_ATOM1TYP Type of Atom #1DB_ATOM2TYP Type of Atom #2DB_ATOM3TYP Type of Atom #3DB_ATOM4TYP Type of Atom #4DB_ATOM5TYP Type of Atom #5DB_ATOM6TYP Type of Atom #6DB_ATOM7TYP Type of Atom #7DB_ATOM8TYP Type of Atom #8DB_ATOM9TYP Type of Atom #9DB_ATOM10TYP Type of Atom #10DB_ATOM11TYP Type of Atom #11DB_ATOM12TYP Type of Atom #12DB_ATOM13TYP Type of Atom #13DB_ATOM14TYP Type of Atom #14DB_ATOM15TYP Type of Atom #15DB_ATOM16TYP Type of Atom #16DB_ATOM17TYP Type of Atom #17DB_ATOM18TYP Type of Atom #18DB_ATOM19TYP Type of Atom #19DB_ATOM20TYP Type of Atom #20DB_ATOM21TYP Type of Atom #21DB_ATOM22TYP Type of Atom #22DB_ATOM23TYP Type of Atom #23



508 9AKK101130D1382

DB_ATOM24TYP Type of Atom #24DB_ATOM25TYP Type of Atom #25DB_ATOM26TYP Type of Atom #26DB_ATOM27TYP Type of Atom #27DB_ATOM28TYP Type of Atom #28DB_ATOM29TYP Type of Atom #29DB_ATOM30TYP Type of Atom #30DB_ATOM31TYP Type of Atom #31DB_ATOM32TYP Type of Atom #32DB_ATOM33TYP Type of Atom #33DB_ATOM34TYP Type of Atom #34DB_ATOM35TYP Type of Atom #35DB_ATOM36TYP Type of Atom #36DB_ATOM37TYP Type of Atom #37DB_ATOM38TYP Type of Atom #38DB_ATOM39TYP Type of Atom #39DB_ATOM40TYP Type of Atom #40DB_ATOM41TYP Type of Atom #41DB_ATOM42TYP Type of Atom #42DB_ATOM43TYP Type of Atom #43DB_ATOM44TYP Type of Atom #44DB_ATOM45TYP Type of Atom #45DB_ATOM46TYP Type of Atom #46DB_ATOM47TYP Type of Atom #47DB_ATOM48TYP Type of Atom #48DB_ATOM49TYP Type of Atom #49DB_ATOM50TYP Type of Atom #50DB_ATOM51TYP Type of Atom #51DB_ATOM52TYP Type of Atom #52DB_ATOM53TYP Type of Atom #53DB_ATOM54TYP Type of Atom #54DB_ATOM55TYP Type of Atom #55



9AKK101130D1382 509

DB_ATOM56TYP Type of Atom #56DB_ATOM57TYP Type of Atom #57DB_ATOM58TYP Type of Atom #58DB_ATOM59TYP Type of Atom #59DB_ATOM60TYP Type of Atom #60DB_ATOM61TYP Type of Atom #61DB_ATOM62TYP Type of Atom #62DB_ATOM63TYP Type of Atom #63DB_ATOM64TYP Type of Atom #64DB_ATOM65TYP Type of Atom #65DB_ATOM66TYP Type of Atom #66DB_ATOM67TYP Type of Atom #67DB_ATOM68TYP Type of Atom #68DB_ATOM69TYP Type of Atom #69DB_ATOM70TYP Type of Atom #70DB_ATOM71TYP Type of Atom #71DB_ATOM72TYP Type of Atom #72DB_ATOM73TYP Type of Atom #73DB_ATOM74TYP Type of Atom #74DB_ATOM75TYP Type of Atom #75DB_ATOM76TYP Type of Atom #76DB_ATOM77TYP Type of Atom #77DB_ATOM78TYP Type of Atom #78DB_ATOM79TYP Type of Atom #79DB_ATOM80TYP Type of Atom #80DB_ATOM81TYP Type of Atom #81DB_ATOM82TYP Type of Atom #82DB_ATOM83TYP Type of Atom #83DB_ATOM84TYP Type of Atom #84DB_ATOM85TYP Type of Atom #85DB_ATOM86TYP Type of Atom #86DB_ATOM87TYP Type of Atom #87



510 9AKK101130D1382

DB_ATOM88TYP Type of Atom #88DB_ATOM89TYP Type of Atom #89DB_ATOM90TYP Type of Atom #90DB_ATOM91TYP Type of Atom #91DB_ATOM92TYP Type of Atom #92DB_ATOM93TYP Type of Atom #93DB_ATOM94TYP Type of Atom #94DB_ATOM95TYP Type of Atom #95DB_ATOM96TYP Type of Atom #96DB_ATOM97TYP Type of Atom #97DB_ATOM98TYP Type of Atom #98DB_ATOM99TYP Type of Atom #99DB_ATOM100TYP Type of Atom #100DB_ATOM1DESC Description for Atom #1DB_ATOM2DESC Description for Atom #2DB_ATOM3DESC Description for Atom #3DB_ATOM4DESC Description for Atom #4DB_ATOM5DESC Description for Atom #5DB_ATOM6DESC Description for Atom #6DB_ATOM7DESC Description for Atom #7DB_ATOM8DESC Description for Atom #8DB_ATOM9DESC Description for Atom #9DB_ATOM10DESC Description for Atom #10DB_ATOM11DESC Description for Atom #11DB_ATOM12DESC Description for Atom #12DB_ATOM13DESC Description for Atom #13DB_ATOM14DESC Description for Atom #14DB_ATOM15DESC Description for Atom #15DB_ATOM16DESC Description for Atom #16DB_ATOM17DESC Description for Atom #17DB_ATOM18DESC Description for Atom #18DB_ATOM19DESC Description for Atom #19



9AKK101130D1382 511

DB_ATOM20DESC Description for Atom #20DB_ATOM21DESC Description for Atom #21DB_ATOM22DESC Description for Atom #22DB_ATOM23DESC Description for Atom #23DB_ATOM24DESC Description for Atom #24DB_ATOM25DESC Description for Atom #25DB_ATOM26DESC Description for Atom #26DB_ATOM27DESC Description for Atom #27DB_ATOM28DESC Description for Atom #28DB_ATOM29DESC Description for Atom #29DB_ATOM30DESC Description for Atom #30DB_ATOM31DESC Description for Atom #31DB_ATOM32DESC Description for Atom #32DB_ATOM33DESC Description for Atom #33DB_ATOM34DESC Description for Atom #34DB_ATOM35DESC Description for Atom #35DB_ATOM36DESC Description for Atom #36DB_ATOM37DESC Description for Atom #37DB_ATOM38DESC Description for Atom #38DB_ATOM39DESC Description for Atom #39DB_ATOM40DESC Description for Atom #40DB_ATOM41DESC Description for Atom #41DB_ATOM42DESC Description for Atom #42DB_ATOM33DESC Description for Atom #43DB_ATOM44DESC Description for Atom #44DB_ATOM45DESC Description for Atom #45DB_ATOM46DESC Description for Atom #46DB_ATOM47DESC Description for Atom #47DB_ATOM48DESC Description for Atom #48DB_ATOM49DESC Description for Atom #49DB_ATOM50DESC Description for Atom #50DB_ATOM51DESC Description for Atom #51



512 9AKK101130D1382

DB_ATOM52DESC Description for Atom #52DB_ATOM53DESC Description for Atom #53DB_ATOM54DESC Description for Atom #54DB_ATOM55DESC Description for Atom #55DB_ATOM56DESC Description for Atom #56DB_ATOM57DESC Description for Atom #57DB_ATOM58DESC Description for Atom #58DB_ATOM59DESC Description for Atom #59DB_ATOM60DESC Description for Atom #60DB_ATOM31DESC Description for Atom #61DB_ATOM62DESC Description for Atom #62DB_ATOM63DESC Description for Atom #63DB_ATOM64DESC Description for Atom #64DB_ATOM65DESC Description for Atom #65DB_ATOM66DESC Description for Atom #66DB_ATOM67DESC Description for Atom #67DB_ATOM68DESC Description for Atom #68DB_ATOM69DESC Description for Atom #69DB_ATOM70DESC Description for Atom #70DB_ATOM71DESC Description for Atom #71DB_ATOM72DESC Description for Atom #72DB_ATOM73DESC Description for Atom #73DB_ATOM74DESC Description for Atom #74DB_ATOM75DESC Description for Atom #75DB_ATOM76DESC Description for Atom #76DB_ATOM77DESC Description for Atom #77DB_ATOM78DESC Description for Atom #78DB_ATOM79DESC Description for Atom #79DB_ATOM80DESC Description for Atom #80DB_ATOM81DESC Description for Atom #81DB_ATOM82DESC Description for Atom #82DB_ATOM83DESC Description for Atom #83



9AKK101130D1382 513

DB_ATOM84DESC Description for Atom #84DB_ATOM85DESC Description for Atom #85DB_ATOM86DESC Description for Atom #86DB_ATOM87DESC Description for Atom #87DB_ATOM88DESC Description for Atom #88DB_ATOM89DESC Description for Atom #89DB_ATOM90DESC Description for Atom #90DB_ATOM91DESC Description for Atom #91DB_ATOM92DESC Description for Atom #92DB_ATOM93DESC Description for Atom #93DB_ATOM94DESC Description for Atom #94DB_ATOM95DESC Description for Atom #95DB_ATOM96DESC Description for Atom #96DB_ATOM97DESC Description for Atom #97DB_ATOM98DESC Description for Atom #98DB_ATOM99DESC Description for Atom #99DB_ATOM100DESC Description for Atom #100DB_APP2 Quality Status: APP2DB_APP1 Quality Status: APP1DB_HCFV Quality Status: HCFVDB_RTAG Quality Status: RTAGDB_APP3 Quality Status: APP3DB_BAD Quality Status: BADDB_B9 Quality Status: B9DB_ALIA Quality Status: ALIADB_ALIN Quality Status: ALINDB_INSV Quality Status: INSVDB_EVT Quality Status: EVTDB_OFSC Quality Status: OFSCDB_OLDD Quality Status: OLDDDB_ALRM Quality Status: ALRMDB_UNAK Quality Status: UNAK



514 9AKK101130D1382

DB_IMP Quality Status: IMPDB_DUMM Quality Status: DUMMDB_AM Quality Status: AMDB_SLAV Quality Status: SLAVDB_SHAV Quality Status: SHAVDB_TRAK Quality Status: TRAKDB_I4 Quality Status: I4DB_LDEV Quality Status: LDEVDB_HDEV Quality Status: HDEVDB_DROC Quality Status: DROCDB_IROC Quality Status: IROCDB_LIRV Quality Status: LIRVDB_LLAV Quality Status: LLAVDB_LAV Quality Status: LAVDB_HAV Quality Status: HAVDB_HHAV Quality Status: HHAVDB_HIRV Quality Status: HIRVDB_CONVCODE Conversion CodeDB_CONVCODESTR Conversion Code StringDB_CONVMIN Conversion MinDB_CONVMAX Conversion MaxDB_CONVOFFS Conversion OffsetDB_ALRMCTXT1 RTN Alarm CommentDB_ALRMCTXT2 High Alarm CommentDB_ALRMCTXT3 Low Alarm CommentDB_ALRMCTXT4 2-high Alarm CommentDB_ALRMCTXT5 2-low Alarm CommentDB_ALRMCTXT6 3-high Alarm CommentDB_ALRMCTXT7 3-low Alarm CommentDB_ALRMCTXT8 H dev Alarm CommentDB_ALRMCTXT9 L dev Alarm CommentDB_ALRMCTXT10 H roc Alarm Comment



9AKK101130D1382 515

DB_ALRMCTXT11 L roc Alarm CommentDB_ALRMCTXT12 Status Chg Alarm CommentDB_ALRMCTXT13 HCF Alarm CommentDB_ALPRI_DEF Default Alarm PriorityDB_ALPRI_RTN Alarm Priority: RTNDB_ALPRI_H Alarm Priority: HDB_ALPRI_L Alarm Priority: LDB_ALPRI_2H Alarm Priority: 2HDB_ALPRI_2L Alarm Priority: 2LDB_ALPRI_3H Alarm Priority: 3HDB_ALPRI_3L Alarm Priority: 3LDB_ALPRI_HDEV Alarm Priority: HDEVDB_ALPRI_LDEV Alarm Priority: LDEVDB_ALPRI_HROC Alarm Priority: HROCDB_ALPRI_LROC Alarm Priority: LROCDB_ALPRI_STCH Alarm Priority: STCHDB_ALPRI_HCF Alarm Priority: BADDB_SNAP_ALIGN Node mask for snap align.DB_CNF_ALIGN Node mask for cnf alignDB_OJ_ALIGN Node mask for OJ alignDB_PLB_ALIGN Node mask for plb alignDB_HIST_ALIGN Node mask for hist alignDB_GRP_TYPE_ARCH Archive TypeDB_GRP_TIMESPAN Time SpanDB_GRP_HIST_TYPE Archive Hist. TypeDB_GRP_ARCHFREQ Archive FrequencyDB_GRP_ARCHOFFSET Archive OffsetDB_GRP_SAMPFREQ Sample FrequencyDB_GRP_DISPFREQ Display FrequencyDB_GRP_ISDERIVED Derived GroupDB_GRP_INPGROUP Input GroupDB_GRP_NUMTAGS # of Tags



516 9AKK101130D1382

DB_GRP_TOTSAMP # of Archive SamplesDB_GRP_PRE_TRIP Pre-trip TimeDB_GRP_POST_TRIP Post-trip TimeDB_GRP_ARCH_END_TIME Archive End TimeDB_GRP_ARCH_START_TIME Archive Start TimeDB_GRP_CLASS Group ClassDB_GRP_CLOSE_TRIP Close trip on returnDB_GRP_CURVE_TYPE Curve TypeDB_GRP_INITMODE Initial Presentation ModeDB_GRP_FRAMECOL Trend Frame ColorDB_GRP_BORDERCOL Trend Border ColorDB_GRP_GRIDCOL Trend Grid ColorDB_GRP_TEXTCOL Trend Text ColorDB_GRP_DRAWMODE Trend Draw ModeDB_GRP_LISTMODE Trend List ModeDB_GRP_LISTMODE Trend List ModeDB_GRP_XLSFILE Report file nameDB_GRP_VIEWER Group viewer programDB_USR_PASSWEXPIRED User Password ExpiredDB_USR_PASSWAGING User Password AgingDB_USR_LANGUAGE User LanguageDB_USR_LOGINDISPLAY User Login DisplayDB_USR_LOGINPROG User Login ProgramDB_USR_LOGOUTDISPLAY User Logout DisplayDB_USR_LOGOUTPROG User Logout ProgramDB_USR_CODE User Payroll CodeDB_USR_PASSWCHANGED User Password ChangedDB_USR_ACTIVE User ActiveDB_USR_CRTMASK Mask of user allowed CRTDB_RESERVED_BY_USER Reserved for Command by UserDB_IS_LOCAL_SOURCE This node is Local source for the tagDB_ROWCOUNT Row Count for Alarm retrieval



9AKK101130D1382 517

Gas Index Table and Gas Molecular Weight

Item Types for Field Assignment

Table 162. Gas Index Table - Gas Molecular Weight.

Index Gas Chemical Formula Molecular Weight1 Hydrogen H2 2.0162 Carbon monoxide CO 28.0103 Methane CH4 16.0434 Acetylene (Ethyne) C2H2 26.0385 Ethylene C2H4 28.0546 Ethane C2H6 30.0707 Propane C3H8 44.0978 N-Butane C4H10-N 58.1249 Iso-Butane C4H10-I 58.12410 N-Pentane C5H12-N 72.15111 Neohexane C6H14 86.17812 Hydrogen sulfide H2S 34.08013 Carbon dioxide CO2 44.01014 Oxygen O2 31.99915 Water H2O 18.01516 Sulfur dioxide SO2 64.06317 Nitrogen N2 28.01618 Argon Ar 39.94819 Air Air 28.959

Table 163. Item Types for Field Assignment.

Symbol Code DescriptionHNMPV 1 Analog tag.HNMDI 2 Digital tag.HNMMSD 3 Multi State Device Driver.HNMCAL 4 Calculation.HNMGRP 5 Trend group.

518 9AKK101130D1382

HNMRGP 6 Retrieved trend group.HNMNOD 7 Node (network server).HNMDVC 8 Device.HNMLSD 9 Logic state descriptor.HNMEU 10 Engineering unit.HNMALC 11 Alarm comment.HNMTXS 12 Text selector.HNMLAD 13 Alarm summary group.HNMALM 14 Generic alarm.HNMOPC 15 Pegboard.HNMDIS 16 Display.HNMREP 17 Report.HNMAUD 18 Audible alarm.HNMUSR 19 Security (user and authorization).HNMMEN 20 Menu and tool-bar.HNMAPP 29 Application specific item.

Table 163. Item Types for Field Assignment.

Symbol Code Description

9AKK101130D1382 519

Word Offset Prefixes

Field Types

Table 164. Word Offset Prefixes.

Prefix DatabaseLA_ Audible tones database and alarm grouping database.LC_ Calculation database.

LG_ Tag related databases (Engineering Units, Logic State Descriptors, Alarm Comments, Text Selectors).

LH_ Trend group database.LM_ Menu and tool-bar database.LN_ Node database.LO_ Security database.LP_ Pegboard database.LR_ Report database.LT_ Tag database.LX_ Export to foreign database.

Table 165. Field Types.

Type CodeDT_CHAR 1DT_VARCHAR 2DT_LONGVARCHAR 3DT_BIT 4DT_TINYINT 5DT_SMALLINT 6DT_INTEGER 7DT_BIGINT 8DT_DECIMAL 9DT_NUMERIC 10DT_REAL 11DT_DOUBLE 12

520 9AKK101130D1382

DT_FLOAT 13DT_DATE 14DT_TIME 15DT_TIMESTAMP 16DT_BINARY 17DT_VARBINARY 18DT_LONGVBINARY 19

Table 165. Field Types.

Type Code

9AKK101130D1382 521

Alarm Types

Table 166. Alarm Types.

Code Symbol Description1 ALEINF Information event.2 ALERTN Return to normal.3 ALEOPE Operator action.4 ALEACK Alarm acknowledge event.5 ALEEVT Digital status event.11 ALEDIA Digital alarm.12 ALEHIR High instrument alarm.13 ALELIR Low instrument alarm.14 ALESHA 3-high alarm.15 ALESLA 3-low alarm.16 ALEHHA 2-high alarm.17 ALELLA 2-low alarm.18 ALEHAL High alarm.19 ALELAL Low alarm.20 ALERCP Increasing rate of change alarm21 ALERCN Decreasing rate of change alarm22 ALEHDV High deviation alarm.23 ALELDV Low deviation alarm.24 ALEHCF Hardware channel failure.25 ALEALA Generic alarm.40 ALEVOT Voting alarm (reserved).41 ALEMUL42 ALERTM43 ALEOPR44 ALELST

522 9AKK101130D1382

Dynamic Symbol Table

Table 167. Dynamic Symbol Table.

Code Symbol Description1 A_NAME Tag name2 A_DESC Tag description3 A_INDX Tag index4 A_CUST Customer tag id (plant tag name)5 A_GROU Alarm group6 A_PRIO Alarm priority7 A_EU EU descriptor8 A_CMNT Alarm comment (buffer, 2W value + 2W quality)9 A_ITMT Item type10 A_ITMN Item number11 A_VAL Value (buffer, 2W value + 2W quality)12 A_VALQ Value and quality (buffer, 2W value + 2W quality)13 A_STAT Status (buffer, 2W value + 2W quality)14 A_STAQ Status and quality (buffer, 2W value + 2W quality)15 A_TIME Time16 A_DATE Date17 A_DATI Date and Time18 A_HTIM Historical time (buffer, 2W)19 A_HDAT Historical date (buffer, 2W)20 A_HDTI Historical date and time (buffer, 2W)21 A_OPER Operator name (buffer, 1W)22 A_CANC Cancode parameter (buffer, n/3 W)23 A_ASCI Ascii parameter (buffer, n/2 W)24 A_REAL Real parameter (buffer, 2W)25 A_LONG Long integer parameter (buffer, 2W)26 A_INTE Short integer parameter (buffer, 1W)27 A_HEXL Long integer (hex) parameter (buffer, 2W)28 A_HEXA Short integer (hex) parameter (buffer, 1W)29 A_YENO Yes (1) / Not (0) (buffer, 1W)30 A_TUTS Timer units (buffer, 1W)

9AKK101130D1382 523

31 A_NREF Item number referenced (buffer, 4W)32 A_EDSC Extended description33 A_NODE Local node name34 A_QUAL Tag quality35 A_PROD Product name36 A_SKVL Skip value37 A_BKVL Backward Skip value38 A_DBXF Data Base Reference39 A_UTX1 Text from OPC AE (1)40 A_UTX2 Text from OPC AE (2)41 A_UTX3 Text from OPC AE (3)42 A_UTX4 Text from OPC AE (4)43 A_UTX5 Text from OPC AE (5)44 A_CHAR Plain ASCII text (non UNICODE Compliant)

Table 167. Dynamic Symbol Table.

Code Symbol Description

524 9AKK101130D1382

Data Processor fileFollowing 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>



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

MACRO Identifies the section of the xml file to specify the object type (including the list of the atoms of the type)

nameName of the type specified in the DataProcessor field in the data base of the tag (for example “AC450.Block.XmlFileName.CFG”)

separator Character separator of the OPC items

mainatom Used to identify the name of the atom that will be used by PGP as “main”

type Tagtype used in the PGP database. Accepted values: DIGITAL, ANALOG, INTEGER

ATOM Identifies the section to specify the name and the attributes of the atoms in the macro

name Atom namedescr Atom description

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

526 9AKK101130D1382

Appendix B AC800F Support

OverviewTraditionally, 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 AC800F’s 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.

FunctionalitiesThe 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:

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.

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.

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

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.

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 PLC’s 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 BuilderRunning the application an interface window is opened as shown below.

At this time, all buttons are disabled except the OK and Open PLC File ones.

Figure 45. PLC File Browsing Window.

532 9AKK101130D1382

Open a PLC FileClicking on the Open PLC File button a typical browsing window for selecting the PLC file is opened as shown in Figure 46.

In the AC800F OPC Gateways window, all the OPC gateways found are listed (see Figure 47).

After the PLC file has been selected and opened, the PLC File Builder immediately starts parsing the file.

Figure 46. Open PLC File Builder

9AKK101130D1382 533

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.

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.

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 FileIf 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 doesn’t initialize the PGP database, therefore any other tags previously configured in the PGP (tags referring to other Non-AC800F 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.

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.

Figure 48. PGP DataBase Build

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.

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.

Figure 49.

9AKK101130D1382 543

Messages windowAll 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 importedThis message is displayed only for AC800F variable types that PGP is not able to manage. Such variable will be ignored.

Found PGP “unused“ tag : ANALOG1This 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 fileThe 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)Let’s assume a new AC800F Function Block parameter (e.g. the KTEXT parameter) needs to be managed. Let’s 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.

AC800F RequirementsAs 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 doesn’t 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 RequirementsPGP needs the following DLLs.

PLCPARSER.DLLBuild # 1392, used to parse the PLC File for AC800F system version 6.1

FREELANCE.DLL

MSXML.DLLThe Microsoft XML parser version 2.5a, number 5.0.2919.6303, included with Internet Explorer 5.0.1.

In the Correspondences.xml file, a AC800F parameter cannot be associated to multiple PGP fields.

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.

ABB Power SystemsVia Hermada 616154 Genova - Italye-mail [email protected]

http://www.abb.com/powergeneration

9AKK101130D1382 - PGP Configuration Manual

Documents

Transcript of 9AKK101130D1382 - PGP Configuration Manual