Documente Academic
Documente Profesional
Documente Cultură
Version 4.1
Configuration Manual
Power Generation Portal
Version 4.1
Configuration Manual
Release: Oct 2007
Document number: 9AKK101130D1382
TRADEMARKS
Registrations and trademarks used in this document include:
Acrobat Registered trademark of Adobe Systems, Incorporated.
Scope
The Power Generation Portal Configuration Manual provides an efficient
means to define all information needed to configure or update the Power
Generation Portal (PGP) basic software and application software.
Intended User
This manual can be used by anyone who performs the functions of a system
manager or configuration manager on a PGP application.
Document Structure
The Power Generation Portal Configuration Manual contains seven major
sections:
The first section introduces configuration from a general point of view.
The approach to configuration is depicted here. The general
configuration procedure is also described. This section is intended to
give the reader the basic information and knowledge to perform a
configuration change.
The second section details the database files configuration items.
The structures of the databases for tags, trend groups and calculations
are explained giving description of each field. Customers will use this
section commonly since it is strictly related to application entities.
The third section details the system files configuration items.
The structure of XML files used to configure system files is explained
giving description of each field. Normal users are not required to use
this section. Just in case an application must be deeply customized,
experienced users may must use this section.
9AKK101130D1382 13
The fourth section outlines some off-line procedures not embedded
within the on-line basic menus of PGP. These procedures are PGP
Startup, PGP Explorer Startup, Database Builder, Display Translator,
Data Export Manager, Long Term Archiving and System Setup Utility.
The last three sections introduce the distributed architecture and the
OPC server and client.
A final Appendix section collects tables referenced throughout the
document. Other Appendix sections introduce the PLC File Builder designed
to interface the Freelance and the Tag Export designed to interface the
Composer.
Use of Warning, Caution, Information, and Tip Icons
This publication includes Warning, Caution, and Information, where
appropriate, to point out safety related or other important information. It also
includes Tip to point out useful hints to the reader. The corresponding
symbols should be interpreted as follows:
Electrical warning indicates the presence of a hazard which could result in
electrical shock.
Tip indicates advice on, for example, how to design your project or how to
use a certain function
Although Warning hazards are related to personal injury, and Caution
hazards are associated with equipment or property damage, it should be
understood that operation of damaged equipment could, under certain
operational conditions, result in degraded process performance leading to
14 9AKK101130D1382
personal injury or death. Therefore, comply fully with all Warning and
Caution notices.
Related Documentation
On-line Documentation
All documentation is supplied in Adobe® Acrobat® reader (.pdf) format.
The Power Generation Portal User Manual is also available as online Help.
9AKK101130D1382 15
Category Title Description
Power Generation Portal User Provides instructions for using Power
Manual Generation Portal features.
Power Generation Portal Information on how to create application
Application Programmer programs that execute Power Generation
Operation Interface Portal functions.
Power Generation Portal Product
An overview of functions offered by PGP
Guide
Power Generation Portal
Assist in troubleshooting problems
Troubleshooting Manual
16 9AKK101130D1382
Section 1 Configuration Guide
Main Features
PGP is a versatile software package that allows various configurations,
which can have a number of functions and a specific capability according to
the clients requests.
Minimum, default and maximum values of sized features of the package are
described here below in Table 1 Current system features are left blank and
may be written in accordance with the sizing of the individual application. If
no specific sizing is required, the package will be configured with the sizing
indicated in the fourth column of the table. Most of unlimited maximum
values are only limited by disk capacity.
9AKK101130D1382 17
Further features are listed and detailed below.
Table 1. Features: Sizes.
18 9AKK101130D1382
Table 1. Features: Sizes.
9AKK101130D1382 19
Table 1. Features: Sizes.
20 9AKK101130D1382
Table 2. Features: Details.
9AKK101130D1382 21
Table 2. Features: Details.
22 9AKK101130D1382
Table 2. Features: Details.
9AKK101130D1382 23
Table 2. Features: Details.
24 9AKK101130D1382
Table 2. Features: Details.
9AKK101130D1382 25
Table 2. Features: Details.
26 9AKK101130D1382
Table 2. Features: Details.
9AKK101130D1382 27
Table 2. Features: Details.
28 9AKK101130D1382
Table 2. Features: Details.
Configuration Overview
These instructions provide information to configure PGP. The configuration
steps assume that the system is being generated for the first time, and
therefore may include some steps that could be skipped on subsequent
generations.
Some configurations can be performed just to reflect the hardware
configuration of the system, others may be performed to implement
archiving, or to customize alarm management. The former takes place
during the system set up or when new hardware equipment is going to be
installed, the latter may take place several times during the life-cycle of the
PGP application.
9AKK101130D1382 29
Outline of Configuration
This section outlines the general steps for configuring PGP. The following
sections provide the necessary information to actually perform the
configuration steps outlined here.
PGP database is mainly loaded by a set of (at least one) DBF or XLS files.
The content of these files is processed and loaded in the PGP data files by
running a build procedure. These files are located, unless differently
specified, in the CONFIG folder and sub-folders.
PGP is mainly off-line customized editing a set of XML files. They are
commonly named (for historical reason) DECK files or DECKs. These files
are located, unless differently specified, in the DECK folder.
The content of DECK files is processed and loaded in the PGP data files by
running a build procedure.
Database configuration and system customizations are separated activities.
They can be performed in different time and, with some restrictions, in
whatever order. Each operation can be performed separately from the
others. Only changing the system sizes or rebuilding the file system requires
a complete build procedure. A single DECK can be processed to change a
specific configuration. Restrictions in the sequence of processing take place
when DECKs have some relationship.
Changes to the configuration of a DECK file must be carried out by copying
the DECK file to the CONFIG\DECK folder as 2DECK (e.g. to change
BATTDECK configuration, copy the file as BATT2DECK in the
CONFIG\DECK folder). A 2DECK file must contain only changes to the
default (defined by DECK file) configuration.
A DECK file automatically references the 2DECK file, if existing, during the
build phase.
Displays are configured by a dedicated procedure, it is described in a
separated manual. Here just the directions to convert and compile displays
are given.
In the following description, bold and underlined characters are used to
highlight mandatory configuration actions and bold characters are used to
highlight optional configuration actions to be performed for each installation.
30 9AKK101130D1382
Optional configurations depend on the specific application. Normal
characters are used to list activities that are usually responsibility of ABB
Energy Automation people and may optionally involve the customer. PGP is
delivered with a default configuration. It allows the system to run properly.
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.
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.
9AKK101130D1382 33
The configuration of calculated tag falls in the tag database configuration:
calculation tags are a kind of the tags in the database.
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.
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.
36 9AKK101130D1382
System Configuration
This section defines configuration parameters and discusses things to
consider in determining appropriate values. Configuration parameters are
defined into the Windows Registry.
For a complete list of PGP registry read the manual 9AKK101130D8771-
PGP Registry Settings
Running SysSetup
Select the Programs menu from the Start button. Then, select the ABB
Industrial IT then Power Generation Portal item and finally the System
Setup process.
The process displays the configuration builders.
The main dialog window of the process displays five button on the left side
and the process welcome page on the right side.
The SysSetup process only interfaces the PGP registry set.
9AKK101130D1382 37
When selecting the Registry button, the process dialog window changes.
The tree of registry folders is displayed on the left side of the dialog window.
On the right side of the dialog window the registry items are listed by
selecting the registry folder.
The dialog window of the process is shown below.
A copy of the registry values is kept within a disk file. The administrator may
align registry values from the file or align files from the registry values.
38 9AKK101130D1382
On top of the list of registries, the alignment of the registry values is
displayed.
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.
40 9AKK101130D1382
Figure 3. Change Registry Value
Press the Cancel button to exit without any change or press the OK button
to set the change and exit the window.
9AKK101130D1382 41
System Configuration Parameters
System Sizes
For details on size parameters please refere to the 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 Options
This section defines a set of symbols, called System Options, that allow
customization of some running features of PGP.
The System Option registry set is read each time PGP starts up. After some
options have been changed, the shutdown and start-up of PGP must be
performed in order for changes to be applied.
Changing System Options could affect performance and operation of the
PGP application
For details on size parameters please refere to the 9AKK101130D8771-
PGP Registry Settings manual.
Configuration Procedure
Introduction
A set of configuration operations customizes PGP for the operational
conditions. They allow PGP to meet specific application requirements, and
to carry out monitoring and control on the specific process.
The number of configuration operations depends on the kind, the size and
complexity of the PGP application.
They range from a simple tag database configuration to a full tag, Trend
Group and calculation configuration.
42 9AKK101130D1382
It is out of the scope of this manual to list all combinations of configuration
operations: such a list could not be exhaustive.
Basically, the configuration procedure is the process of transferring
information from external files to the internal PGP databases. These
external files, called definition files, are variously structured: there are ASCII,
Dbase or Excel files.
The configuration operations are generically called building. Builders are the
processes involved in configuration.
In the following sections the general procedure to execute a configuration
operation is explained. It will be applied every time configurations must be
performed.
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.
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.
46 9AKK101130D1382
Building Procedure
Each configuration activity typically involves a single definition file or a few
definition files. For example, changes in the tag database involve the tag
database definition file if all tags are kept in a single file, or the set of tag
database definition files if multiple files are used.
In this section, the most frequent usage of builder environment is described.
First Step
The first step upon entering the builder environment is the identification of
the builder. The builder identification is mandatory both for editing and
building (importing or exporting) in order to point to the right set of definition
files.
Second Step
Editing the definition file(s) is the second step. Changing the existing
definition file(s) or creating new definition file(s) take place at this stage.
Depending on the type of definition file submitted for editing, Excel or
Notepad are invoked.
Of course, Excel will only be successfully invoked if it is installed on the
computer.
Rules for editing definition files can be found in Section 2, Database
Configuration and Section 3, System Configuration.
Third Step
Building the definition file(s) is the third step. After editing, the building phase
converts the information of a definition file to the PGP internal databases.
A building phase must always follow an editing phase, otherwise PGP
internal databases will not be updated. The Import button allows the
building operation.
(See the Third Step on page 47).
Errors during the building phase may require editing and re-building
definition.
9AKK101130D1382 47
Builder Window
The following sections describe the elements of the builder window.
Builder List
The builder list section lists all the available builders. Each builder is
designed to process an XML definition file. A definition file defines all the
information to transfer in the internal PGP database at build time.
The following information is a complete list of the database builders with a
brief description. Refer to Section 2, Database Configuration and Section 3,
System Configuration for a detailed description of each definition file.
48 9AKK101130D1382
Error Message builder
The Error Message builder processes the list of the error messages PGP
may output in the event of a system error.
The file related to this builder is BEMFDECK.XML.
Additional error messages for application tasks may be included in the
BEMF2DECK.XML file. This file is automatically appended to BEMFDECK
file at build time.
The file BEMF2DECK.XML must be located in the \CONFIG\DECK folder.
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.
50 9AKK101130D1382
.
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 builder
The Engineering Unit (E.U.) Descriptor Database builder defines a table
containing the engineering units to qualify analog tag values.
The builder establishes a correspondence between a numeric code and an
engineering unit descriptor. The codes may be used in the tag database to
define the engineering unit of each analog tag.
The definition file for engineering units is not used if E.U. descriptions for
analog tags are defined in the tag database itself.
The file related to this builder is *.CF (e.g. EUDSCP.CF). A DBF or XLS file
may also be used.
The location of EU definition file is \CONFIG\EU.
52 9AKK101130D1382
Trend Group Database builder
The Trend Group Database builder defines the archiving criteria, the
archiving timing and the tag list for each realtime, historic, post trip and time
function group to be configured.
The file related to this builder is *.DBF or *.XLS (e.g. GROUPS.DBF).
The location of Trend Group definition file is \CONFIG\GROUP.
Pegboard builder
Pegboards are control displays where all elements are pop-ups (e.g. RCMs,
Stations, RMSCs, etc.) used in command operations. Each pegboard may
have up to 32 pop-ups.
The Pegboard builder defines the structure of such displays. The position
and type of each pop-up and the associated tag is defined.
The file related to this builder is *.DBF or *.XLS (e.g. PEGBOARD).
9AKK101130D1382 53
The location of pegboard definition file is \CONFIG\PEGBOARD.
Audible Alarm builder
The Audible Alarm builder processes the definition of the audible PGP plays
when an alarm arises.
The file related to this builder is *.DBF or *.XLS (e.g. AUDIBLE.DBF). The
location of audible definition file is \CONFIG\SOUND.
If wave files are used, they have also to be located in the \CONFIG\SOUND
folder.
Report builder
Reports are based on Excel files. The Report builder defines a link among
each report, the Excel file and the scheduling criteria.
The file related to this builder is *.DBF or *.XLS (e.g. REPORT.DBF). The
location of report definition file is \CONFIG\REPORTS.
Excel files have also to be located within the \CONFIG\REPORTS folder.
Security builder
The Security builder defines user names, passwords and access rights of
PGP users.
The file related to this builder is *.DBF or *.XLS (e.g. USER.DBF).
The location of security definition file is \CONFIG\USERS.
Node builder
The Node builder defines the structure of the nodes in a multi-master PGP
architecture.
The file related to this builder is *.DBF or *.XLS (e.g. NODE.DBF).
The location of node definition file is \CONFIG\NODE.
54 9AKK101130D1382
Alarm Message builder
The Alarm Message builder processes the list of the alarm, communication,
inquiry messages foreseen in the PGP.
The file related to this builder is BALMDECK.XML.
Additional alarm messages for application tasks may be included in the
BALM2DECK.XML file. This file is automatically appended to BALMDECK
file at build time.
The file BALM2DECK.XML must be located in the \CONFIG\DECK folder.
Alarm Group builder
The Alarm Group builder defines the alarm grouping. PGP has a default
configuration consisting of 16 main alarm groups and 16 sub-groups
associated to each main group.
The file related to this builder is *.DBF or *.XLS (e.g. ALRMGRP.DBF).
The location of node definition file is \CONFIG\ALMGR.
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 button
Through the Import button, different actions are allowed to be performed
according to the choice between the selection of the Build All icon and the
selection of a specific builder icon.
9AKK101130D1382 57
When a specific builder icon has been selected, the import function enables
the user to process a definition file after an editing phase.
When modifications have been done on a definition file, the operator must
submit the file to the proper builder in order to transfer modifications to the
internal PGP database, and to make modifications operational.
By clicking the Import button, definition files related to the selected
(highlighted on blue) builder are used for building
Figure 7 shows the window opened after the Import button has been
pressed. This is the standard dialog window used by Windows programs to
access an existing file. Therefore, all usual features are available to
navigate inside the folder.
The default folder is \CONFIG. Depending on the selected builder a
corresponding \CONFIG sub-folder is chosen and displayed in the Look-in
field.
By clicking the Import button, the building phase can begin.
If the definition file (DECK files only) includes the file initialization
specification, the user is requested to confirm file initialization. A dialog
58 9AKK101130D1382
window is opened. The OK button confirm the file initialization. The Cancel
button starts to process without performing any file initialization.
The figure below shows an example of file initialization window displayed
when the alarm group builder runs.
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
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 Button
The Abort button abandons processing without performing any file
initialization and any building. This button does not allow you to close the
builder window.
Builder Options
Before running builders, a set of options may be selected for specific
purposes.
9AKK101130D1382 61
These options are facilities offered to collect information on building
activities, or to change the usual behavior of builders. Depending on the
builder, options may be or may be not pre-selected.
The user may change (select or deselect) each option by clicking the check
box on the left of the option name.
62 9AKK101130D1382
The figure below shows an example of builder window where two options
are selected.
Refer to the following sections for details on each option of the builder
window.
Echo Option
If selected, it allows you to echo building messages to the builder message
window. Otherwise builder does not echo messages.
By default, the echo option is never selected.
9AKK101130D1382 63
Ignore Error Option
If selected, this option prevents builder from signalling each error occurred
during operations and pausing. Error notification requires user
acknowledgment and consequently it stops builder operation.
The option can be useful when user runs a heavy builder operation (typically
a build all operation) so as to avoid continuous interactions. An example is
represented by the building of all data files during the night.
By default, the ignore error option is never selected.
Propagate Option
When selected, this option allows you to transfer build settings from the
current node to all other nodes in a multi-master architecture. That option
allows you to update all nodes in a multi-master network without executing a
build on each node.
The nodes part of the multi-master architecture must be configured by the
Node builder so that PGP can know all the possible destinations.
Use the option carefully in order to prevent an excessive load in the network.
Pre-PostApp Option
When selected, this option allows you to execute application programs
before and/or after a build.
64 9AKK101130D1382
A dialog window allows you to type the path to the application(s).
Initialize Option
When selected, this option forces the builder to initialize the PGP internal
database before processing the definition file. The Initialization option does
not require the presence of the initialization card when a deck definition file
is submitted.
By default, the initialize option is not selected.
When the option is selected, the user is inquired before initialization
proceed.
Add Option
When selected, this option forces the builder to add in the PGP internal
database only the items which cant be found (new items). Existing items are
left unchanged and a warning message is output unless the ignore error
options is selected.
For example, if the tag database builder has been selected, the add option
forces builder to add all tags which are not found in the PGP internal
database.
By default, the add option is never selected. That means items are added or
replaced into the PGP database.
9AKK101130D1382 65
Replace Option
This option, when it is selected, forces the builder to replace in the PGP
internal database the items found in the submitted definition file. The 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 Option
When selected, this option, reverses the builder operation in order to delete
from the PGP internal database the items found in the submitted definition
file.
For example, if the tag database builder has been selected, the delete
option forces the builder to delete from PGP tag database all the tags found
in the submitted tag definition DBF file.
By default, the delete option is not selected. It means that tags are added or
replaced in the PGP database.
Log File
When the log file option is selected, a log file specification may be entered in
the field of this area. Disk drive, folder path and file name identify the file
specification.
The default file name is BUILD.LOG and will be allocated in the \LOGS
folder.
Export Window
The following sections describe the structure of the elements the export
window.
See the previous section Builder List for further details on the builder
description.
66 9AKK101130D1382
Export Action Buttons
Export button
During the normal operation operators or maintenance people can modify
the configuration by adding, deleting or changing some database entities
(e.g. tags, Trend Groups, and calculations) using on-line builders.
The Export function allows you to download the current configuration on a
target definition file to include all the on-line changes. The function allows
you to keep a definition file consistent with the on-line configuration, and
ready to be built up later on.
The Export function only applies to the following databases:
Menu and Tool-bar database.
Logic State Descriptor database,
Engineering Unit database,
Tag database,
Calculation database,
Trend Group database,
Alarm comment database,
Text selector database,
Pegboard database.
Audible database,
Report database,
Security database,
Node database,
Alarm Grouping database.
They correspond to the definition files having extension DBF or XLS.
The Figure 13 shows the window opened after the Export button has been
pressed. This is a standard dialog window used by Windows programs to
9AKK101130D1382 67
interface an existing file. Therefore, all usual features are available to
navigate inside the folder.
The default folder is \CONFIG. Depending on the selected builder a
corresponding \CONFIG sub-folder is chosen and displayed in the Look-in
field.
If an existing target file is selected, the un-build function downloads all the
items (unless a selection is required: see PGP) and only the fields
embedded within the target file are involved. If a new target file is typed, the
un-build function downloads all the fields of the PGP internal database.
In the example figure the exported items are tags.
The Cancel button allows you to close the export window and to quit the
export environment. The exit icon at the top right of the builder window does
the same operation.
Abort Button
The Abort button abandons processing without performing any export file.
This button does not allow you to close the export window.
68 9AKK101130D1382
Select Option
When selected, this option allows you to define selection criteria during the
export procedure.
Criteria allows you to set a modification time interval within which it is
possible to select the items going to be processed. The initial and the final
date and time can be defined.
Further, a SQL like specification allows you to filter items satisfying a
selection criteria. Database field names must be typed in uppercase. For
example, the select condition TAGTYPE = CALCANG allows you to refer
only analog calculated tags.
9AKK101130D1382 69
70 9AKK101130D1382
Section 2 Database Configuration
Introduction
In the following sections, one for each major subsystem, the fields of various
databases are described. Fields are identified by name.
All tables in the following sections are structured as shown in the table
below.
Table 3. Database structure.
Item Description
Name Field name identification within the database.
Format Field format.
Allowed field formats are:
- character (char),
- integer (int) or
- real.
If a numeric (integer or real) field is left blank, it is treated as zero.
Width Field width.
It is the maximum number of characters or digits (including decimal point if real
number) allowed to assign a value to the field.
Opt/Mnd Optional or Mandatory field.
A field can be optionally (O) defined or it must be defined as mandatory (M).
An optional field, left undefined, may be loaded into the database with a default
value or left blank (or zero) depending on the definition of a default value in the
cross reference database. In any case, the item configuration is not rejected.
Description Field description.
Range Range of legal values.
9AKK101130D1382 69
Table 3. Database structure.
Item Description
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.
Each field has a format and a width defined. Most of them have a range of
legal values and a default value defined. Further, sizing parameters may be
defined.
In the on-line configuration most of boolean fields are set using the check
mark. A check mark means Y(es), nothing (empty cell) means N(o).
The tables in the following sections always refer to the database
configuration, and boolean fields have values Y(es) or N(o).
70 9AKK101130D1382
Tag Database Subsystem
Outline
The tag database is unique for all tags in the system, although it may be
loaded starting from different files that may be merged at any time.
In order to simplify the description of the database structure, two major types
of tag will be described separately:
Analog tags
The current value of analog tags is maintained in the realtime database as
either a 32-bit floating point number or a 32-bit integer (I*4) depending on
the internal representation format.
Also, a 32-bit status indicator is maintained in the realtime database. It flags
alarm and quality conditions of each tag.
Digital tags
The current value of digital tags is maintained in the realtime database as up
to 16 bits of status. Also, a 16-bit status indicator is maintained in the
realtime database. It flags alarm and quality conditions of each tag.
Independently of the source, a tag will always be defined with certain basic
information. For example, it will have a name, a description and alarm
processing options defined. Other information is defined depending on the
kind of tag. Other information may be defined or omitted as desired.
Both tag types may be acquired from the field or generated by calculation
packages, user programs or remote nodes.
In the following sections a single database will always be referred. In
general, it must be intended as a collection of multiple database files.
Tag Database
The tag database consists of one or more files generated on a Personal
Computer using standard packages like DBase III/IV or EXCEL, the SLDG
9AKK101130D1382 71
package (component of the Bailey Engineering Work Stations) or the ABB
Symphony Composer. Then, it must be copied to the computer running the
PGP application (if it is a different one) for final download.
Tag database downloading is performed by submitting the database file(s)
to the database builder. During this phase, the field contents of the input
file(s) will be used to compile PGP internal database structures following the
directives given by a field assignment cross-reference file, previously
processed by builder program DBXRF.
The database builder may also perform export operations, creating a target
database file (DBase III/IV or Excel format) containing all items as they are
currently defined in the PGP internal database.
If a target database does not exist, the exporter creates it using the whole
PGP database structure (i.e. all fields are included).
Alternatively, a target database file may be specified as template. In this
case, the exporter updates the target database file handling only the fields
specified within it.
The target database file may have just a single tag, or may be a full or partial
database file. It must contain all (and only) fields to be exported.
Although many fields are part of the whole database, only a limited set of
them is mandatory. All others are optional and, if omitted, a proper default
value provided by builder will be assigned.
Those fields that do not apply to a given type of tag (e.g. the engineering
unit does not apply to digital tags) will be ignored without any error reporting.
The structure of a database file (i.e. the definition or the order of optional
fields) may change according to user preferences, except for field names. A
database file will include, at least, all mandatory fields. Other possible fields
(i.e. site-specific additional descriptive text), although not interfering with
database building procedures, are out of the scope of the manual, and are
not described or considered here.
Several fields are common to both analog and digital tags. The following
description is structured in a common information section (that applies to all
tags) and two specific information sections (that applies only to analog or
digital tags).
72 9AKK101130D1382
All fields are grouped into three main sections:
Generic Tag Definition
Digital Tag Definition
Analog Tag Definition.
Fields are classed into sub-sections for an easy use and reference. The
three main sections contain the same number of sub-sections to allow easy
cross-reference. If a section does not define any field for the specific main
section, it will be left empty.
General Parameters
The fields in Table 4 and Table 5 define the name and other additional
parameters used to identify the tag, and to give an explicit reference to the
process.
They define three key characteristics of a tag: the index and the name to
uniquely identify the tag, and the type to characterize it. Tag name and tag
type are mandatory fields.
9AKK101130D1382 73
Table 4. Generic Tag - General Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
INDEX Integer Tag index. {0, 1...128000}
6 This field identifies the tag by number. It 0
Optional must be unique for each tag within [mxindx]
database. If omitted or zero (blank), the
first vacant index will be allocated
TAGINDEX is an alias name for this field.
NAME Character Tag name. <string>
20 This field identifies the tag by name. It <blank>
Mandatory may be a combination of alphabetic [sznam]
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.
UID Character Tag unique identification. <string>
36 This field provides a unique identification <blank>
Mandatory in the PGP application history. It is None
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.
DESC Character Tag description. <string>
64 This field is a character string used to <blank>
Optional describe the tag on the different outputs [szdesc]
(alarm messages, reports, summaries,
etc.).
TAGDESC is an alias name for this field.
74 9AKK101130D1382
Table 4. Generic Tag - General Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
TAGTYPE Character Tag type code. UNDEF
8 This field specifies the type of the tag [sztype]
Mandatory according to Appendix A.
TAGTYPE is an alias name for this field.
TAGSRC Character Tag source code. <blank>
7 This field specifies the source type of the None
Optional tag according to Appendix A.
9AKK101130D1382 75
Table 4. Generic Tag - General Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
SEC_GROUP Integer Security group. {0, 1...32}
2 This field is checked whenever an user 0
Optional attempts to operate over the tag. Only None
users whose security group mask
includes what's hereby defined are
enabled to access the tag for changes or
control.
EXTDESC Character Extended tag description. <string>
80 This field is a character string used to <blank>
Optional completely define the tag or to enhance [szedsc]
the tag description.
Note 1:
The TAGUID code is internally generated the first time a tag is added to the
PGP database (i.e. each time a tag database build follows a database
initialization).
Add the TAGUID field to the tag database and leave it initially blank when
the tag database file is filled in.
Following a tag database build, an un-build operation must be executed in
order the TAGUID field is filled. If the TAGUID is left blank, later on the tag
cannot be replaced within the PGP database, an error message is issued for
duplicate tag since a new TAGUID is generated. A PGP database
initialization only allows replacing (actually adding) the tag.
Once assigned, the TAGUID may be kept unchanged for the whole history
of a tag. The tag name or the tag index may change, the TAGUID is not
affected. That allows you to keep track of a tag during the history of the
application (for example within the trend historical groups).
76 9AKK101130D1382
As a general rule, perform a database export immediately after a build
operation in order to fill in a non-assigned TAGUID field within a tag
database file.
The parameter listed in the following table is not included in the General Tab
of the on-line configuration.
Table 5. Generic Tag - General Parameters (continued)
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
PLANTUNIT Integer Plant unit. {0, 1...12}
2 This field identifies the plant unit 0
Optional (applicable to multi-unit plants only) and None
allows grouping the tags per unit group.
Process Parameters
The fields of Table 6 and Table 7 define the basic information for the tag
configuration: initial condition (setting at start-up time), alarm processing,
playback saving, application program activation, output transferring, value
exporting, triggering (calculation, report, totalization), process control inhibit.
All fields are optional.
9AKK101130D1382 77
Table 6. Generic Tag - Process Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
AL_REM Character Remote alarm processing flag. {Y, N}
1 If set, the alarm processing for this tag Y
Optional will be performed remotely (PCU level or None
PLC level), otherwise it will be performed
locally (computer level). This field is
meaningful for tags coming from smart
devices able to check for an alarm
condition. For all other tags, alarm
processing is always performed locally.
OFFSCINI Character Initially off scan flag. {Y, N}
1 If set, the tag is put off scan at PGP start- N
Optional up time. None
The operator must manually put on scan
the tag.
OFFALINI Character Initially off alarm check flag. {Y, N}
1 If set, the tag is put off alarm check at N
Optional PGP start-up time. None
The operator must manually put on alarm
check the tag.
EXP_VAL Character Export to ODBC flag. {Y, N}
1 If set, tag values are exported via ODBC N
Optional interface. None
PLAYBACK Character Playback archive flag. {Y, N}
1 If set, the tag will be recorded on the Y
Optional playback archive. None
78 9AKK101130D1382
Table 6. Generic Tag - Process Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
AAP_NUM Integer Index to an application action program. { 0, 1...63}
2 If greater than 0, this field defines a link 0
Optional which will cause an user defined None
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.
TRIG_CALC Integer Triggered calculation block number. {0, 1...999}
3 If greater than 0, it identifies the 0
Optional calculation block to be triggered when the [mxxcal]
tag goes into alarm or returns to normal.
Triggering takes place on both state
transitions.
REP_NUM Integer Triggered report number. {0,1...50}
4 If greater than 0, it identifies the report to 0
Optional be triggered when the tag goes into alarm [nmrpts]
or returns to normal.
Triggering takes place on both state
transitions.
DATA_PROC Character Application component name. <string>
64 The field defines the name of a program <blank>
Optional used to perform some specific handling [szdesc]
(e.g. raw data conversion) on the tag
values. See Appendix A for details about
the DataProcessor xml file.
FACEPLATE Character Pop-up handling program name. <string>
80 The field applies to control tags only and <blank>
Optional defines the name of the program used to [szedsc]
manage control commands.
9AKK101130D1382 79
Table 6. Generic Tag - Process Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
CONFIRMCM Character Confirm command enable flag. {Y,N}
1 If set, will be requested the confimation to N
Optional execute a control command on the tag. None
CTRLINHTAG Char Control inhibit tag name. <string>
20 Tag name of control inhibit tag. It must <blank>
Optional refer to a digital tag. [sznam]
Control inhibit tag is a digital tag used to
disable actions upon analog (RMSC) and
digital (RCM, DD, MSDD) control tags.
OTXNAME Character Output transfer tag name. <string>
56 Name of a output tag to be linked to the <blank>
Optional current tag for outputting to loop.
The output tag must exist within the tag
database.
OTXENB Character Output transfer enable flag. {Y,N}
1 If set, output transfer to the tag defined in N
Optional the OTXNAME field is enabled. None
80 9AKK101130D1382
Table 6. Generic Tag - Process Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
MAINTTRIG Integer Maitenance log number. {0, 1...100}
6 If greater than 0, it identifies the 0
Optional maintenance log to be triggered when the [n.hrtl]
tag goes into alarm or returns to normal.
Triggering takes place on both state
transitions.
OPCSRVVIS Integer OPC server visibility. {0, 1, 2}
2 Defines if the tag will be exported by the 2
Optional OPC server.
0 = NO
1 = Read only
2 = R/W
The EXP_VAL field that allows you to specify a relational database (i.e.
Oracle, Access) must be updated with the values of the tag. That requires
the installation of a specific (ODBC Connection Support) optional PGP
license and a relational database package to manage the tag values.
The parameters listed in the following table are not included in the Process
Tab of the on-line configuration.
9AKK101130D1382 81
Table 7. Generic Tag - Process Parameters (cntd.).
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ACK_PROG Character Program activation flag on acknowledge. {Y,N}
1 If set, the application action program N
Optional defined by the AAP_NUM field will be None
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.
CTRLCMDTAG Char Control command tag name. <string>
20 Not longer used. <blank>
Optional [sznam]
EXPFIL Character Export to file flag. {Y, N}
1 If set, tag values are exported to an ASCII N
Optional file. None
The on-line configuration does not
include the field.
PLAYBACKLT Character Playback flag for long term archiving. {Y,N}
1 If set, reduced size data packets will be N
Optional recorded on the playback to save disk None
space.
The on-line configuration does not
include the field.
82 9AKK101130D1382
Table 7. Generic Tag - Process Parameters (cntd.).
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
PLAYBACKSP Character Playback specific processing flag. {Y,N}
1 If set, tag exception reports will be Y
Optional submitted to specific processing on None
playback archiving. A specific application
routine must be implemented.
The on-line configuration does not
include the field.
RTN_PROG Character Activate an application action program on {Y,N}
1 return to normal condition. N
Optional If set, the application action program None
defined by AAP_NUM field will be
activated whenever a return to normal
condition takes place.
The on-line configuration includes the
field within the Alarm Level Tab for
analog tags and the DI Process Tab for
digital tags.
TOT_LOG Integer Totalization log number. {0,1...100}
3 If greater than 0, it identifies the index into 0
Optional the analog or digital totalization log n.tene
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.
9AKK101130D1382 83
process interface devices. They are meaningful only for tags acquired from
external (foreign) acquisition devices. In any other case, their contents will
be ignored.
These fields only provide an addressing criterion for external tags. The base
system does not support any type of driver for foreign acquisition devices.
Such drivers, whenever required, must be developed as specific application
packages.
All fields are mandatory if an external acquisition device is used. Otherwise
they must not be defined.
The Generic Scanner parameters replace previous External and Modbus
Acquisition parameters. Their description has been removed from the
configuration manual.
However, those parameters are still supported for compatibility with previous
versions of PGP. Refer to configuration manual of release 1.3 (or previous)
for details.
Table 8. Generic Tag Generic Scanner Input Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
FIELD_AD1 Integer Field input address 1.
6 0
Mandatory None
................... ................ ................................. ............
FIELD_AD10 Integer Field input address 10.
6 0
Mandatory None
FIELD_TX1 Character Field input driver text 1. <string>
80 <blank>
Optional [mxopcn]
................ ................ .................................. .............
84 9AKK101130D1382
Table 8. Generic Tag Generic Scanner Input Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
FIELD_TX10 Character Field input driver text 10. <string>
80 <blank>
Optional [mxopcn]
FIELD_DRV Character Field input driver name. <string>
20 This name identifies the kind of driver <blank>
Mandatory interfacing PGP to the process for input [sznam]
data communication.
9AKK101130D1382 85
Table 9. Generic Tag Generic Scanner Output Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
OUT1_AD1 Integer Field output driver 1 address 1.
6 See the Note 1 at the end of the table. 0
Mandatory None
................. ................ .................................. ........
OUT1_AD10 Integer Field output driver 1 address 10.
6 See the Note 1 at the end of the table. 0
Mandatory None
................. ................ .................................. ........
OUT5_AD10 Integer Field output driver 5 address 10.
6 0
Mandatory None
OUT1_TX1 Character Field output driver 1 text 1. <string>
64 See the Note 2 at the end of the table. <blank>
Optional [szdesc]
.............. ................ .................................... ............
OUT1_TX10 Character Field output driver 1 text 10. <string>
64 See the Note 2 at the end of the table. <blank>
Optional [szdesc]
.............. ................ .................................... ............
OUT5_TX10 Character Field output driver 5 text 10. <string>
64 <blank>
Optional [szdesc]
86 9AKK101130D1382
Table 9. Generic Tag Generic Scanner Output Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
OUT1_DRV Character Field output driver name 1. <string>
20 This name identifies the kind of driver <blank>
Mandatory interfacing PGP to the process for output [sznam]
communication.
See the Note 3 at the end of the table.
.............. ................ .................................... ............
OUT5_DRV Character Field output driver name 5. <string>
20 This name identifies the kind of driver <blank>
Mandatory interfacing PGP to the process for output [sznam]
communication.
Note 1:
The OUT1_ADn fields replace the OUT_ADn fields. The description of
OUT_ADn has been removed from the configuration manual. However, the
field is still supported for compatibility with previous PGP versions. Refer to
configuration manual of release 4.0 (or previous) for details.
Note 2:
The OUT1_TXn fields replace the OUT_TXn fields. The description of
OUT_TXn has been removed from the configuration manual. However, the
field is still supported for compatibility with previous PGP versions. Refer to
configuration manual of release 4.0 (or previous) for details.
Note 3:
The OUT1_DRV field replaces the OUT_DRV field. The description of
OUT_DRV has been removed from the configuration manual. However, the
field is still supported for compatibility with previous PGP versions. Refer to
configuration manual of release 4.0 (or previous) for details.
9AKK101130D1382 87
Symphony Input Parameters
The fields in Table 10 define the logic address and other additional
parameters used to locate the source of tags coming from Symphony
modules. They are meaningful only for those kind of tags. In any other case,
their contents will be ignored.
The mandatory fields all together uniquely identify the location of the tag in
terms of acquisition sub-system (PCU). They must not be defined if a
generic acquisition device is used (see the previous section).
Table 10. Generic Tag - Symphony Input Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ICI_NUM Integer ICI Number. {1...8}
2 Number of the physical ICI device when 1
Optional multiple ICIs are connected to PGP. [mxciu] or [mxxciu]
ICI_NDX Integer ICI index. {-1, 0...29999}
5 This is the reference index in the internal -1
Optional ICI table. [mxcpts]
If omitted or less than zero, the first
vacant ICI index will be allocated.
Index zero is legal only for ICI module
status tags. If this field is zero (blank) and
ICI point type is not module status, an
error will be generated. Therefore, this
field must be omitted or explicitly defined
as 1, except for those particular tags
requiring fixed indexes.
LOOP Integer Ring number. {0..63}
3 0
Mandatory None
88 9AKK101130D1382
Table 10. Generic Tag - Symphony Input Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
PCU Integer PCU number. {1...256}
3 0
Mandatory None
MODULE Integer Module number. {0...31}
2 0
Mandatory None
BLOCK Integer Block number. {0...99999}
5 0
Mandatory None
ICISTA_CD Character ICI action code. {X, E, C, D}
1 This code specifies the ICI action at start- C
Optional up time. See Appendix A for the meaning None
of supported actions.
Command Parameters
Fields of this sub-section apply to digital tags only. Refer to the analogue
sub-section of digital tag definition for details.
9AKK101130D1382 89
Table 11. Generic Tag - Alarm Processing Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
DS_ALARM Character Display alarm flag. {Y, N}
1 If set, alarms concerning this tag will be Y
Optional displayed on alarm display pages (LADs). None
90 9AKK101130D1382
Table 11. Generic Tag - Alarm Processing Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
INFO_ONACK Character Log information flag on acknowledgment. {Y, N}
1 If set, an information message is logged N
Optional to the Operator Journal when alarm None
acknowledgment involving the tag is
performed.
DS_RTN Character Display flag for return to normal condition. {Y, N}
1 If set, a RTN message concerning this Y
Optional tag will be displayed on alarm display None
pages (LADs). An alarm acknowledge will
then remove the message.
PR_RTN Character Print flag for return to normal condition. {Y, N}
1 If set, RTNs concerning this tag will be N
Optional printed. None
See the field ALMPRINTER also.
SV_RTN Character Save message flag on return to normal. {Y, N}
1 If set, return to normal condition Y
Optional messages concerning this tag will be None
logged to the Operator Journal.
AUD_RTN Character Activate flag for audible tone on return to {Y, N}
1 normal. N
Optional If set, the audible tone defined by None
AUDINDEX will be activated when the tag
will return to a normal condition. An
audible acknowledge or an alarm
acknowledge will then clear the audible
tone.
9AKK101130D1382 91
Table 11. Generic Tag - Alarm Processing Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
PR_STCHNG Character Print flag for state changes. {Y, N}
1 If set, the changes of state concerning N
Optional this tag will be printed on alarm printer(s). None
State changes are intended as
alarms/RTNs of digital tags defined as
events (field EVENTTAG set to Y).
See the field ALMPRINTER also.
SV_STCHNG Character Save flag for state changes. {Y, N}
1 If set, the changes of state concerning Y
Optional this tag will be recorded into the Operator None
Journal.
DS_STCHNG Character Save flag for display events. {Y, N}
1 If set, the changes of state concerning N
Optional this tag will be displayed on the alarm None
pages
PR_OPACT Character Print flag for operator action messages. {Y, N}
1 If set, on-line database modifications and N
Optional all other operator actions concerning this None
tag will be printed on alarm printer(s).
See the field ALMPRINTER also.
SV_OPACT Character Save flag for operator action messages. {Y, N}
1 If set, on-line database modifications and Y
Optional all other operator actions concerning this None
tag will be recorded into the Operator
Journal.
PR_INFO Character Print flag for information messages. {Y, N}
1 If set, information concerning this tag will N
Optional be printed. None
See the field ALMPRINTER also.
92 9AKK101130D1382
Table 11. Generic Tag - Alarm Processing Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
SV_INFO Character Save flag for information messages. {Y, N}
1 If set, information concerning this tag will Y
Optional be logged to the Operator Journal. None
EXP_ALA Character Relational database update (alarms) flag. {Y, N}
1 If set, alarm messages will be N
Optional automatically sent to the external None
relational database.
APPL_ALA Character Trigger flag for application program. {Y, N}
1 On alarm occurrence, an application N
Optional program is triggered for execution. None
The on-line configuration does not
include the field.
ALMACKBC Character Broadcast flag for alarm acknowledge. {Y, N}
1 If set, alarm acknowledgments are N
Optional broadcasted to other nodes in the same None
multi-master architecture.
ALMGROUP Integer Alarm group number. {0, 1...272}
3 This field allows you to group all tags 0
Optional belonging to a given plant area or [sladnm] or [mxxagp]
component. Alarm group numbers are
used to sort the alarms for the
presentation on screen. Alarm groups are
customer defined. By default, groups 1 to
16 are defined as first level groups,
directly addressed by alarm displays and
summaries. Groups 17 to 32 are defined
as sub-groups of group 1, groups 33 to
48 are defined as sub-groups of group 2
and so on.
9AKK101130D1382 93
Table 11. Generic Tag - Alarm Processing Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
AL_PRI Integer Alarm priority number. {1 ... 16}
2 This is the default priority number and is 1
Optional used when a specific alarm priority is not [mxalpr] or [mxxapr]
defined for a single alarm condition.
Specific priority numbers can be assigned
to each alarm condition. See the following
fields and the fields of the analogue 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.
ALMINHTAG Char Alarms inhibit tag. <string>
20 Name of a tag that, while in alarm, will <blank>
Optional disable the generation of alarm [sznam]
messages for this tag. If the field is blank,
no alarm inhibit tag is defined.
AUDINDEX Integer Audible alarm index. {0, 1...32}
3 This field defines the index into audible 0
Optional alarm database to determine which [mxaud]
audible is to be activated upon alarm
and/or return to normal.
94 9AKK101130D1382
Table 11. Generic Tag - Alarm Processing Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ALMPRINTER Integer Alarm printer index. {1...99}
2 Reference index to the printer where 1
Optional messages concerning the tag are printed. None
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.
SMSINDEX Integer Index for Short Message Send (SMS)
3 alarm messaging. 0
Optional None
The parameters listed in the following table are not included in the Alarm
Process Tab of the on-line configuration.
9AKK101130D1382 95
Table 12. Generic Tag - Alarm Processing Parameters (cntd.).
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ALPRI_RTN Integer Return to normal priority number. {0, 1 ... 16}
2 This is the priority assigned to the tag 0
Optional when a return to normal condition takes [mxalpr] or [mxxapr]
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.
ALPRI_HCF Integer Hardware channel failure priority number. {0, 1 ... 16}
2 This is the priority assigned to the tag 0
Optional when a hardware channel failure takes [mxalpr] or [mxxapr]
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.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ALRMCMNT1 Integer Return to normal comment index. {1...100}
5 0
Optional [mxalcm]
ALRMCTXT1 Character Return to normal comment text. <string>
80 <blank>
Optional [szalcm]
ALRMCMNT2 Integer High alarm (for analog tags) or alarm (for {1...100}
5 digital tags) comment index. 0
Optional [mxalcm]
ALRMCTXT2 Character High alarm (for analog tags) or alarm (for <string>
80 digital tags) comment text. <blank>
Optional [szalcm]
9AKK101130D1382 97
Table 13. Generic Tag Alarm Comment Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ALRMCMNT13 Integer Hardware channel failure comment index. {1...100}
5 0
Optional [mxalcm]
ALRMCTXT13 Character Hardware channel failure comment text. <string>
80 <blank>
Optional [szalcm]
Network Parameters
The fields in Table 14 refer to the PGP network communication subsystem.
They are used when multiple PGP servers in a multi-master architecture
exchange data (values, alarm acknowledges, messages, configurations)
among them.
All fields are optional and they must be defined when servers (nodes) are
intended to cooperate in a multi-master architecture.
The fields reference the node definition. Refer to the Nodes database for
details.
98 9AKK101130D1382
Table 14. Generic Tag Network Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
CNFNODMSK Character Destination node mask for tag Sequence {Y, N}
16 configurations. 16*N
Optional First bit refers to node 1 in the node None
definition, second bit refers to node 2,
and so on.
CNFNODMS2 Character Destination node mask for tag Sequence {Y, N}
16 configurations. 16*N
Optional The mask applies to nodes from 17 to 32. None
9AKK101130D1382 99
Table 14. Generic Tag Network Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
DESTNODMS4 Character Destination mask for operator actions. Sequence {Y, N}
16 The mask applies to nodes from 49 to 64. 16*N
Optional None
DESTVALMSK Character Destination node mask for tag values. Sequence {Y, N}
16 Tag values are routed from the current 16*N
Optional node to the nodes set in the destination None
mask. First bit refers to node 1 in the
node definition, second bit refers to node
2, and so on.
DESTVALMS2 Character Destination node mask for tag values. Sequence {Y, N}
16 The mask applies to nodes from 17 to 32. 16*N
Optional None
DESTVALMS3 Character Destination node mask for tag value. Sequence {Y, N}
16 The mask applies to nodes from 33 to 48. 16*N
Optional None
DESTVALMS4 Character Destination node mask for tag value. Sequence {Y, N}
16 The mask applies to nodes from 49 to 64. 16*N
Optional None
SRCNODMSK Character Source node mask for tag values. Sequence {Y, N}
16 First bit refers to node 1 in the node 16*N
Optional definition, second bit refers to node 2, None
and so on.
SRCNODMS2 Character Source node mask for tag values. Sequence {Y, N}
16 The mask applies to nodes from 17 to 32. 16*N
Optional None
100 9AKK101130D1382
Table 14. Generic Tag Network Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
SRCNODMS3 Character Source node mask for tag values. Sequence {Y, N}
16 The mask applies to nodes from 33 to 48. 16*N
Optional None
SRCNODMS4 Character Source node mask for tag values. Sequence {Y, N}
16 The mask applies to nodes from 49 to 64 16*N
Optional None
OPC Parameters
OPC (OLE for Process Control) is a standard mechanism based on the
Microsoft OLE/COM technology for communicating to numerous data
sources in order to grant inter-operability between automation/control
application, field systems/devices and business/office applications in the
process control industry.
The PGP OPC Client provides Data Access (in accordance to the 1.0a and
2.03 specifications) and Alarm&Event (in accordance to the 1.02
specification) functionalities and allows simultaneous connections to local
and remote OPC servers.The PGP OPC Server provides Data Access and
Alarm&Event functionalities as well but, as far as the DA specification is
concerned, only the 2.03 is supported..
The fields in Table 15 and Table 12 refer to the PGP OPC subsystem and
can be used to define the database from the OPC point of view. They are
meaningful for OPC tag types only.
OPC tags can be successfully used only if the PGP OPC Support has been
installed and licensed. In such a case, the on-line configuration provides a
Tab for OPC parameters.
9AKK101130D1382 101
Table 15. Generic Tag - OPC Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
OPCPROGID Character Server name. <string>
80 This is the name of the OPC Data Access <blank>
Mandatory Server. [mxopcn]
OPCPROGAE Character Alarm event server name. <string>
80 This is the name of the OPC Alarm Event <blank>
Mandatory Access Server. [mxopcn]
OPCCMPTR Character Computer name. <string>
80 This is the name of the machine hosting <blank>
Optional the OPC Data Access Server and OPC [mxopcn]
Alarm&Event Server. It may be left
undefined to establish a local connection.
OPCITEMID Character Item identification. <string>
80 This is the unique identification of data <blank>
Mandatory item to be accessed in the server specific [mxopci]
address space. The value to be specified
depends on the OPC server.
OPCACCPATH Character Access path. <string>
80 This may be additional information to <blank>
Optional qualify access to data item. The value to [mxopcn]
be specified depends on the OPC server.
102 9AKK101130D1382
Table 15. Generic Tag - OPC Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
OPCREFRESH Integer Requested refresh time.
6 Each OPC server updates data items 1
Optional based on its own refresh time None
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.
OPCREADTYP Integer Read type.
6 See Table 17 for allowed read types. 120
Optional None
OPCEXPCLNT Character Flag to enable commands to OPC client. {Y,N}
1 If set, for a control tag, commands are N
Optional allowed to the OPC server. None
Code Description
500 500 milliseconds.
1 1 second.
2 2 second.
3 3 seconds.
9AKK101130D1382 103
Table 16. Server DA Refresh Rates.
Code Description
5 5 second.
10 10 seconds.
30 30 seconds.
60 60 seconds.
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.
The parameters listed in the following table are not included in the OPC Tab
of the on-line configuration.
104 9AKK101130D1382
Table 18. Generic Tag - OPC Parameters (cntd.).
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
OPC_ALA Character Flag for export alarms to OPC server. {Y, N}
1 If set, alarm messages will be N
Optional automatically sent to the OPC server. None
OPCPROGHS Character Historian server name. <string>
80 This is the name of the OPC Historian <blank>
Mandatory Access Server. [mxopcn]
Totalization Parameters
Fields of this sub-section differ for analog and digital tags. Refer to the
analogue sub-section of analog and digital tags for details.
Documentation Parameters
The fields in Table 19 allow linking tag conditions and documentation.
Currently, PGP does not manage these fields, but they may be loaded in the
tag database for a future use.
9AKK101130D1382 105
Table 19. Generic Tag - Documentation Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ALMDHF Integer Reference to documentation on hardware
5 channel failure condition. 0
Optional None
ALMDRN Integer Reference to documentation on return to
5 normal condition. 0
Optional None
ALMDHA Integer Reference to documentation on alarm
5 (digital tags) or high alarm (analog tags) 0
condition.
Optional None
Refer to the analogue sub-sections of digital and analog tag definition for
additional fields.
106 9AKK101130D1382
Table 20. Generic Tag - Hardware Description Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
S_COORD Character Slave module coordinates. <string>
10 <blank>
Optional None
S_MODULE Character Slave module number. <string>
2 <blank>
Optional None
S_CHANNEL Character Slave channel number. <string>
2 <blank>
Optional None
S_TYPE Character Slave module type. <string>
6 <blank>
Optional None
TO_BOARD Character Termination unit identifier. <string>
14 <blank>
Optional None
TO_TU_TY Character Termination unit type. <string>
6 <blank>
Optional None
TO_TU_CO Character Termination unit coordinates. <string>
10 <blank>
Optional None
TO_TB_ID Character Board identifier on termination unit. <string>
3 <blank>
Optional None
9AKK101130D1382 107
Table 20. Generic Tag - Hardware Description Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
TO_PIN1 Character First pin on termination board. <string>
2 <blank>
Optional None
TO_PIN2 Character Second pin on termination board. <string>
2 <blank>
Optional None
TO_PIN3 Character Third pin on termination board. <string>
2 <blank>
Optional None
DRAW_REF Character Drawing reference code description. <string>
14 <blank>
Optional None
DESC_CABLE Character Field cable identifier. <string>
20 Name of field cable wiring <blank>
Optional termination unit to field termination None
board.
FR_BOARD Character Field termination cabinet identifier. <string>
14 Name of field cabinet to which <blank>
Optional termination unit is wired. None
FR_TB_ID Character Field termination board identifier. <string>
4 <blank>
Optional None
FR_ROW Character Field termination board coordinates. <string>
4 <blank>
Optional None
108 9AKK101130D1382
Table 20. Generic Tag - Hardware Description Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
FR_PIN1 Character First pin on field termination board. <string>
3 <blank>
Optional None
FR_PIN2 Character Second pin on field termination <string>
3 board. <blank>
Optional None
FR_PIN3 Character Third pin on field termination board. <string>
3 <blank>
Optional None
WIN_PANEL Character External alarm window panel <string>
8 identifier. <blank>
Optional None
WIN_NUMBER Character External alarm window number. <string>
3 <blank>
Optional None
WIN_ROW1 Character External alarm window description <string>
14 row 1. <blank>
Optional None
WIN_ROW2 Character External alarm window description <string>
14 row 2. <blank>
Optional None
WIN_ROW3 Character External alarm window description <string>
14 row 3. <blank>
Optional None
9AKK101130D1382 109
Application Parameters
The fields in Table 21 and Table 22 are available for additional tag
qualification or to be used by application specific programs.
All fields are optional.
Application parameters may be statically used by defining a value for them.
Values will be unchanged. They may also be dynamically used to update
values by application programs. Initial values may be set.
Table 21. Generic Tag - Application Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
USER3 Character ASCII text. <string>
8 <blank>
Optional None
USER7 Character ASCII text. <string>
16 <blank>
Optional None
USER10 Character ASCII text. <string>
32 <blank>
Optional None
UT_IN1 Integer Integer value. {-32767...+32767}
6 0
Optional None
UT_IN2 Integer Integer value. {-32767...+32767}
6 0
Optional None
UT_IN3 Integer Integer value. {-32767...+32767}
6 0
Optional None
110 9AKK101130D1382
Table 21. Generic Tag - Application Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
UT_IN4 Integer Integer value. {-32767...+32767}
6 0
Optional None
UT_RE1 Real Real number. <9 digit real>
9 0
Optional None
UT_RE2 Real Real number. <9 digit real>
9 0
Optional None
UT_RE3 Real Real number. <9 digit real>
9 0
Optional None
UT_RE4 Real Real number. <9 digit real>
9 0
Optional None
UT_RE5 Real Real number. <9 digit real>
9 0
Optional None
UT_RE6 Real Real number. <9 digit real>
9 0
Optional None
9AKK101130D1382 111
Table 21. Generic Tag - Application Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ASPECT1NAM Character Aspect program menu text 1. <string>
20 Aspects allows you to add specific menu <blank>
Optional items for tag handling. Menu items are [sznam]
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 Character Aspect command line 1. <string>
80 Aspects allows you to add specific menu <blank>
Optional items for tag handling. See the field [szedsc]
ASPECT1NAM also.
The aspect command defines the
command line to be executed.
See the Note 1 at the end of the table.
...................... ............... .............................................. ............
...................... ............... .............................................. ............
ASPECT5NAM Character Aspect program menu text 5. <string>
20 Same as ASPECT1NAM above. <blank>
Optional [sznam]
ASPECT5CMD Character Aspect command line 5. <string>
80 Same as ASPECT1CMD above. <blank>
Optional See the note 1 at the end of the table. [szedsc]
Note 1:
The aspect command line defines the command to be executed when the
menu item is selected. The syntax of the command line is
<program name>
112 9AKK101130D1382
or
<program name> <parameters>
The program name identifies the program to be activated and the
parameters to define possible input data to the program.
A parameter can be a tag name. It can be symbolically referenced using the
syntax %TAG%. At execution time the symbolic reference will be replaced
with the actual tag name.
The parameters listed in the following table are not included in the
Application Tab of the on-line configuration.
Table 22. Generic Tag - Application Parameters (cntd.).
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ATOM1NAM Character Atom name 1. <string>
64 <blank>
Optional [szdesc]
................... ............... .................... ............................
ATOM50NAM Character Atom name 50. <string>
64 Same as ATOM1NAM above. <blank>
Optional [szdesc]
ATOM1TYP Integer Atom type 1.
6 0
Optional None
................... ............... .................... ............................
ATOM50TYP Integer Atom type 50.
6 Same as ATOM1TYP above. 0
Optional None
9AKK101130D1382 113
Table 22. Generic Tag - Application Parameters (cntd.).
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ATOM1VAL Integer Atom value 1. {-32767...+32767}
10 0
Optional None
................... ............... .................... ............................
ATOM50VAL Integer Atom value 50. {-32767...+32767}
10 Same as ATOM1VAL above. 0
Optional None
114 9AKK101130D1382
General Parameters
The fields in Table 23 define the text strings to be associated as logic state
descriptors to each possible status of the tag.
The total number of status text descriptors to be defined in a tag definition
depends on the tag type. For example, a MSDD tag has four statuses and,
in general, it will need four text descriptors.
Since all digital tags have at least two statuses, the first two logic state
descriptors are mandatory, all others are optional.
Table 23. Digital Tag - General Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ZEROSTATE Character Zero state descriptor. <string>
16 This field defines the text to be displayed
Mandatory or printed to represent the state 0. [sztags]
ONESTATE Character Same as above for state 1. <string>
16
Mandatory [sztags]
TWOSTATE Character Same as above for state 2. <string>
16 The field is mandatory for MSDDs. <blank>
Optional [sztags]
THREESTATE Character Same as above for state 3. <string>
16 The field is mandatory for MSDDs. <blank>
Optional [sztags]
FOURSTATE Character Same as above for state 4. <string>
16 <blank>
Optional [sztags]
9AKK101130D1382 115
Table 23. Digital Tag - General Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
FIVESTATE Character Same as above for state 5. <string>
16 <blank>
Optional [sztags]
SIXSTATE Character Same as above for state 6. <string>
16 <blank>
Optional [sztags]
SEVENSTATE Character Same as above for state 7. <string>
16 <blank>
Optional [sztags]
EIGHTSTATE Character Same as above for state 8. <string>
16 <blank>
Optional [sztags]
NINESTATE Character Same as above for state 9. <string>
16 <blank>
Optional [sztags]
TENSTATE Character Same as above for state 10. <string>
16 <blank>
Optional [sztags]
ELEVNSTATE Character Same as above for state 11. <string>
16 <blank>
Optional [sztags]
TWELVSTATE Character Same as above for state 12. <string>
16 <blank>
Optional [sztags]
116 9AKK101130D1382
Table 23. Digital Tag - General Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
THTEESTATE Character Same as above for state 13. <string>
16 <blank>
Optional [sztags]
FRTEESTATE Character Same as above for state 14. <string>
16 <blank>
Optional [sztags]
FVTEESTATE Character Same as above for state 15. <string>
16 <blank>
Optional [sztags]
LSD1INDEX Integer Index for logic state descriptor 1.
16 0
Optional None
.................. ............... ................................................. .........
LSD16INDEX Integer Index for logic state descriptor 16.
16 0
Optional None
ISALARM0 Character Alarm flag for state 0. {Y, N}
1 Is set, state 0 is an alarm state. N
Optional See Note 1 at the end of the table. None
.................. ............... ................................................. .........
ISALARM31 Character Alarm flag for state 31. {Y, N}
1 Is set, state 31 is an alarm state. N
Optional See Note 1 at the end of the table. None
Note 1:
9AKK101130D1382 117
The IsAlarm0, IsAlarm1, ... IsAlarmn fields replace the Refstat field. The
description of Refstat has been removed from the configuration manual.
However, the field is still supported for compatibility with previous PGP
versions. Refer to configuration manual of release 1.4 (or previous) for
details.
The IsAlarm<i> set of fields allow defining multiple alarm statuses for a
multi-state tag. A tag can have:
A single alarm status and all other normal.
A single normal status and all other alarm.
Any combination of alarm and normal statuses.
Process Parameters
The fields in Table 24 define some alarm processing information concerning
digital tags. All fields are optional.
Table 24. Digital Tag - Process Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
EVENTTAG Character State information flag. {Y, N}
1 If set, all possible states of the tag will be N
Optional considered normal and the only type of None
alarm output enabled is Operator Journal
recording (while alarm display pages,
reports and post trip logs are not
affected).
INITVAL Integer Initial value. {0...15}
15 This value is loaded into the realtime 0
Optional database at system star-up. None
118 9AKK101130D1382
Table 24. Digital Tag - Process Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
MAX_ROC Integer Maximum allowed rate of changes. {0...999}
3 This field defines the maximum number 0
Optional of state changes allowed for this tag None
during 1 minute. If the number of changes
exceeds this limit, the tag is automatically
put out of scan. The function is useful for
filter exception reports due to hardware
failures in the digital contacts. Those no-
meaningful exception reports might
significantly reduce or saturate the
playback storage area.
TRIP_NUM Integer Triggered post trip group number. {0,1...100}
4 If greater than 0, it identifies the post trip 0
Optional group to be triggered when the tag goes [mxhgrp]
into alarm or returns to normal.
ALM_PROG Character Program activation flag on alarm. {Y,N}
1 If set, the application action program N
Optional defined by AAP_NUM field will be None
activated whenever an alarm condition
occurs.
EVT_PROG Character Program activation flag on event. {Y,N}
1 If set, the application action program N
Optional defined by AAP_NUM field will be None
activated whenever an event (state
change) takes place.
9AKK101130D1382 119
Generic Scanner Output Parameters
Fields of this sub-section apply to both analog and digital tags. Refer to the
analogue sub-section of generic tag definition for details.
120 9AKK101130D1382
Table 25. Digital Tag - Symphony Input Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
SER_NUMBER Integer SER number. {0, 1, 2}
2 0
Optional [mxsedv]
SER_INDEX Integer SER index. {0, 1...512}
4 0
Optional [mxsept]
When the extended sequence of events (FC 241) is used, the blocks for
standard and summary sequence of events are allocated to the
addresses 5000 and 5001 and cannot be defined elsewhere.
The parameters listed in the following table are not included in the
Symphony Tab of the on-line configuration.
Table 26. Digital Tag - Symphony Input Parameters (cntd.).
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
SOELOG Integer Number of sequence of events log.
3 This field identifies the log of each SER 0
Optional device. None
SOETYPE Integer Type of sequence of events. {0, 1}
1 The value of this field can be 0
Optional 0 - Standard SOE, None
1 - Summary SOE.
9AKK101130D1382 121
Table 26. Digital Tag - Symphony Input Parameters (cntd.).
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
SOETIMEOUT Integer Sequence of events time-out.
3 This field defines the interval of time the 0
Optional sequence of events is kept opened ready None
to collect all changes following the first
event (the SOE event activating).
SOETUNITS Integer Time unit to qualify the SOE time-out. {0, 1}
1 The value can be 0
Optional 0 - Seconds, None
1 - Minutes.
SOEMAXEVT Integer Maximum number of allowed events.
5 The current sequence of event log is 0
Optional closed if it reaches the maximum number None
of events. A new SOE log is opened to
collect exceeding events.
SOEOUTLOG Integer Output log for SOE merging.
3 When multiple SER devices are in use, a 0
Optional single log can be generated merging None
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.
Command Parameters
The fields in Table 27 define the descriptive text strings associated with
each possible status of feedbacks from the process. All fields are optional.
They are meaningful only for those digital tags acquired from Symphony
modules that support feedback (DD and MSDD). See also Appendix A.
122 9AKK101130D1382
The on-line configuration includes the fields in the DI Feedback Tab.
.
Table 27. Digital Tag Command Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
FB1_0STATE Character Zero state descriptor for feedback 1. <string>
16 This field defines the text to be displayed <blank>
Optional for the state 0 of feedback 1. [sztags]
FB1_1STATE Character One state descriptor for feedback 1. <string>
16 This field defines the text to be displayed <blank>
Optional for the state 1 of feedback 1. [sztags]
FB2_0STATE Character Same as above for state 0 of feedback 2. <string>
16 <blank>
Optional [sztags]
FB2_1STATE Character Same as above for state 1 of feedback 2. <string>
16 <blank>
Optional [sztags]
FB3_0STATE Character Same as above for state 0 of feedback 3. <string>
16 <blank>
Optional [sztags]
FB3_1STATE Character Same as above for state 1 of feedback 3. <string>
16 <blank>
Optional [sztags]
FB4_0STATE Character Same as above for state 0 of feedback 4. <string>
16 <blank>
Optional [sztags]
FB4_1STATE Character Same as above for state 1 of feedback 4. <string>
16 <blank>
Optional [sztags]
9AKK101130D1382 123
Alarm Processing Parameters
The field in the Table 28 allows defining a specific priority to be associated
to a digital (status only) tag.
Refer to the analogue sub-sections of generic tag definition for additional
fields concerning the default alarm priority and other specific alarm priorities.
See the description of the AL_PRI field for details on the definition of alarm
priorities.
Table 28. Digital Tag - Alarm Processing Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ALPRI_STCH Integer Status change priority number. {0, 1 ... 16}
2 This is the priority assigned to the tag 0
Optional (defined as status only tag and not alarm [mxalpr] or [mxxapr]
tag) when a status change takes place
and the condition must be displayed. If
set to 0 then the default priority is
assigned.
124 9AKK101130D1382
alarm comment database in order to define all referenced alarm comments.
If the index is defined, the text type field (if any) is ignored.
If the text type field is used, it is added to the alarm comment database at
the first vacant index. This approach does not require the separate
configuration of an alarm comment database. If the text is defined, the index
type field must not be included in the tag database.
Table 29. Digital Tag - Alarm Comment Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ALRMCMNT12 Integer Alarm comment index for alarm condition. {1...100}
5 <blank>
Optional [mxalcm]
ALRMCTXT12 Character Alarm comment text for alarm condition. <string>
80 <blank>
Optional [szalcm]
Refer to the Alarm Comment definition chapter for more information about
the contents of these fields. Refer to the analogue sub-sections of the
generic tag definition for other alarm comment fields.
The on-line configuration allows selection of alarm comment either by index
(typing the number) or text (selecting from a list).
Network Parameters
Fields of this sub-section apply to both analog and digital tags. Refer to the
analogue sub-section of generic tag definition for details.
OPC Parameters
Fields of this sub-section apply to both analog and digital tags. Refer to the
analogue sub-section of generic tag definition for details.
9AKK101130D1382 125
Totalization Parameters
The fields in Table 30 allow defining totalizations associated to the digital
tag. They are meaningful only if the TOT_LOG field is defined as non zero
value (i.e. a totalization has been associated to the digital tag).
This kind of totalization collects maintenance information related to dual
state devices like motors, pumps, breakers, etc.
Basically, the totalization collects the number activations (i.e. the changes
from a steady to a operational condition), the operating time (sum of times in
the operational condition) and the total time elapsed from the last service of
the device the tag is associated to.
Those collected values are compared to maximum values defined by the
fields during processing.
Table 30. Digital Tag - Totalization Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
HRTRUNSTAT Integer Running status for digital totalization. {0, 1}
1 This field defines the status identifying 0
Optional the operational condition of the dual-state None
device.
HRTMAXCHGS Integer Maximum number of status changes.
5 This field defines the upper limit to the 0
Optional number of allowed transitions from the None
steady to the operational status of the
device.
HRTMAXRUN Integer Maximum running time.
3 This field defines the upper limit of the 0
Optional operational time (sum of times in None
operation) of the device. It is the
totalization of all single operational time
intervals.
126 9AKK101130D1382
Table 30. Digital Tag - Totalization Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
HRTMAXRUNU Integer Time unit for maximum running time.
1 See Appendix A for the allowed time 0
Optional units. None
HRTMAXSRV Integer Maximum time from service.
3 This field defines the upper limit to the 0
Optional service time (time elapsed from the date None
of the last service) of the device. It is the
difference between the current date and
the service date.
HRTMAXSRVU Integer Time unit for maximum time from service.
1 See Appendix A for the allowed time 0
Optional units. None
9AKK101130D1382 127
Table 31. Digital Tag - Device Status Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
DEV_NAME Character Device name. <string>
20 Depending on the type of device (see the <blank>
Optional field DEV_TYPE below), this field can None
define the name of a printer, a computer
or a disk.
See Note 1 at the end of the table.
DEV_NUMBER Integer Device number. <integer>
15 Allowed values are 0
Optional 1 - Printer, None
2 - Node,
3 - Disk.
DEV_TYPE Integer Device type. {Printer, Node, Disk}
15 The field qualifies the kind of device the 0
Optional tag applies to. It may define a printer, a None
node or a disk diagnostic tag.
See Note 2 at the end of the table.
DEVSUBTYPE Integer Device sub-type.
2 This field is not required for module 0
Optional diagnostic. None
128 9AKK101130D1382
Table 31. Digital Tag - Device Status Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
MODTYPE Character Module type. {MFP, OIS, MCS, ...}
20 This field defines the kind of hardware to <blank>
Optional be either: MFP, OIS, MCS, TNT, ... [sznam]
This field is not required for module
diagnostic. The field value is used, when
the ALMACKBC flag is set, to route the
alarm acknowledge through the Infinet.
MODREV Character Module revision. <string>
2 This field is not required for module <blank>
Optional diagnostic. None
Note 1:
The name of devices are the names as known by Windows operating
system. That is, a printer name is the name as defined during the printer
definition (e.g. LPT1 or \\SERVERNODE\LASERPRT1), a node name is the
computer name (e.g. PGPSERVER1) as defined in the Network tab (access
from Settings and Control Panel) and a disk name is the identifier of disk
(e.g. C or D).
Note 2:
The diagnostic function surveys the availability of printers, the existence (or
the operability) of nodes and the space allocation of disks.
Nodes are checked issuing a ping through the Ethernet. All nodes, and not
only PGP nodes, can be submited for diagnostic check.
Disks are checked for allocation and alarm messages are issued when a
high or a very high limit is reached. Two optional registries, the
DiskUsageHighLimit and the DiskUsageVeryHighLimit, define the high and
very high limits of the disk space allocation.
9AKK101130D1382 129
Documentation Parameters
The field in Table 32 allows linking tag conditions and documentation.
Currently, PGP does not manage the field, but it may be loaded in the tag
database for a future use.
Refer to the analogue sub-section of generic tag definition for additional
fields.
Table 32. Digital Tag Documentation Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ALMDST Integer Reference to status change
5 documentation 0
Optional None
Application Parameters
Fields of this sub-section apply to both analog and digital tags. Refer to the
analogue sub-section of generic tag definition for details.
General Parameters
The fields in Table 33 define the engineering unit index or text, the floating
point presentation format, the presentation scale and other parameters
typical of analog tags. All fields are optional.
130 9AKK101130D1382
Refer to engineering unit database chapter for more information about
different ways to configure engineering units.
The on-line configuration allows selection of engineering unit either by index
(typing the number) or text (selecting from a list).
Table 33. Analog Tag - General Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
EUDESC Character Engineering unit text. <string>
16 This text defines the engineering unit <blank>
Optional associated to the tag. [sztags]
NUMDECPL Integer Number of decimal places. {0...9}
1 The information is used when displaying 2
Optional the tag value. None
I4_DATA Character Integer/Real format flag. {Y,N}
1 If set, the value of the tag will be stored N
Optional into realtime database as a 32-bit signed None
integer.
PLAYBACKCM Character Playback compression flag. {Y,N}
1 If set, tag exception reports will be Y
Optional compressed in the playback archive None
according to compression rules.
INITVAL Real Initial value. {lowlim...higlim}
15 This value is loaded into realtime 0
Optional database at system start-up. None
See Note 1 at the end of the table.
9AKK101130D1382 131
Table 33. Analog Tag - General Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
SCA_VAL_0 Real 0% scale value. {lowlim...higlim}
15 Value (expressed in engineering units) 0
Optional representing the 0% scale to be used for None
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 Real 100% scale value. {lowlim...higlim}
15 Value (expressed in engineering units) 0
Optional representing the 100% scale to be used None
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 Real Playback dead-band. {lowlim...higlim}
10 This value (expressed in engineering 0
Optional units) defines the dead-band for dummy None
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 Integer Playback timer.
5 This field defines the timer (in seconds) 30
Optional for dummy packet checking. None
See PLAYBACKDB also and the Note 3
at the end of the table.
132 9AKK101130D1382
Table 33. Analog Tag - General Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
PLBCOMPRDB Integer Playback compression dead-band. {0...100}
15 This value (expressed in percentage) 0
Optional defines the dead-band for playback None
compression algorithm. If defined, must
be wider than the significative change the
tag value can take.
FILTER_TAU Integer Time constant for filter factor.
4 This field defines a time constant for 0
Optional filtering a tag value before updating the None
realtime database. A value of zero will
disable filtering. The value stored in the
realtime database is computed using new
input (raw) value and old realtime
database value.
See Note 2 at the end of the table.
INCDECPRC Real Increment/Decrement percentage for {0...100}
10 control station and RMSC device. 0.0
Optional None
Note 1:
In the range boxes, values of lowlim and higlim are defined by the
general formulas:
lowlim = VAL0
higlim = VAL0 + SPAN
Values of VAL0 and SPAN are defined in the alarm level definition sub-
section.
Note 2:
9AKK101130D1382 133
Filtering defined by the FILTER_TAU field plays a weighting role when a
new tag value must be stored in the realtime database. The stored value is
computed according to the following formula:
Vn = Vn-1 * (FILTER_TAU / (dt + FILTER_TAU)) +
Vr * (dt / (dt + FILTER_TAU))
Where:
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).
134 9AKK101130D1382
This mechanism must be used carefully and only when necessary, as it may
considerably decrease the playback archive capacity.
The parameters listed in the following table are not included in the Analog
General Tab of the on-line configuration.
Table 34. Analog Tag - General Parameters (cntd.).
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
EUINDEX Integer Engineering unit index. {-1, 0...127}
3 This field defines the index into the -1
Optional engineering unit database. A value of 1 [mxeutx]
forces automatic assignment of
engineering unit index and requires the
specification of the engineering unit text
(see next field).
CONSTDELTA Real Hourly constancy delta value. {lowlim...higlim}
10 This value (expressed in engineering 0
Optional units) defines the delta allowed as None
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.
9AKK101130D1382 135
Process Parameters
Fields of this sub-section apply to both analog and digital tags. Refer to the
analogue sub-section of generic tag definition for details.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
CONVCODE Character Conversion code to be performed on the <string>
20 input raw data. <blank>
Optional [sznam]
CONVMIN Integer Minimum value (in engineering unit) of
15 the input raw data. 0
Optional None
CONVMAX Integer Maximum value (in engineering unit) of
15 the input raw data. 0
Optional None
CONVOFFS Integer Offset value to add on converting input
15 raw data. 0
Optional None
136 9AKK101130D1382
Symphony Input Parameters
Fields of this sub-section apply to both analog and digital tags. Refer to the
analogue sub-section of generic tag definition for details.
Command Parameters
Fields of this sub-section apply to digital tags only.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ALPRI_3H Integer 3-High alarm priority number. {0, 1 ... 16}
2 This is the priority assigned to the tag 0
Optional when a 3-high alarm condition takes [mxalpr] or [mxxapr]
place. If set to 0 then the default priority is
assigned.
ALPRI_2H Integer 2-High alarm priority number. {0, 1 ... 16}
2 This is the priority assigned to the tag 0
Optional when a 2-high alarm condition takes [mxalpr] or [mxxapr]
place. If set to 0 then the default priority is
assigned.
9AKK101130D1382 137
Table 36. Analog Tag - Alarm Processing Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ALPRI_H Integer High alarm priority number. {0, 1 ... 16}
2 This is the priority assigned to the tag 0
Optional when a high alarm condition takes place. [mxalpr] or [mxxapr]
If set to 0 then the default priority is
assigned.
ALPRI_L Integer Low alarm priority number. {0, 1 ... 16}
2 This is the priority assigned to the tag 0
Optional when a low alarm condition takes place. If [mxalpr] or [mxxapr]
set to 0 then the default priority is
assigned.
ALPRI_2L Integer 2-Low alarm priority number. {0, 1 ... 16}
2 This is the priority assigned to the tag 0
Optional when a 2-low alarm condition takes [mxalpr] or [mxxapr]
place.
ALPRI_3L Integer 3-Low alarm priority number. {0, 1 ... 16}
2 This is the priority assigned to the tag 0
Optional when a 3-low alarm condition takes [mxalpr] or [mxxapr]
place. If set to 0 then the default priority is
assigned.
ALPRI_HROC Integer High rate of change priority number. {0, 1 ... 16}
2 This is the priority assigned to the tag 0
Optional when a high rate of change alarm [mxalpr] or [mxxapr]
condition takes place. If set to 0 then the
default priority is assigned.
ALPRI_LROC Integer Low rate of change priority number. {0, 1 ... 16}
2 This is the priority assigned to the tag 0
Optional when a low rate of change alarm [mxalpr] or [mxxapr]
condition takes place. If set to 0 then the
default priority is assigned.
138 9AKK101130D1382
Table 36. Analog Tag - Alarm Processing Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ALPRI_HDEV Integer High deviation priority number. {0, 1 ... 16}
2 This is the priority assigned to the tag 0
Optional when a high deviation alarm condition [mxalpr] or [mxxapr]
takes place. If set to 0 then the default
priority is assigned.
ALPRI_LDEV Integer Low deviation priority number. {0, 1 ... 16}
2 This is the priority assigned to the tag 0
Optional when a low deviation alarm condition [mxalpr] or [mxxapr]
takes place.
The on-line configuration includes the fields above in the Alarm Level Tab
and in the Alarm Option Tab.
9AKK101130D1382 139
Two further fields allow definition of dynamic high and low alarm thresholds.
A dynamic threshold is defined by the name of an analog tag. In such a
case, the value of the alarm threshold is not fixed and defined at
configuration time, it is retrieved from the realtime database when the alarm
processing is being performed for the current analog tag.
Raw and current threshold values are compared to decide if an alarm
condition must be notified. Of course, the dynamic threshold tags and the
current analog tag should represent the same physical entity to be
comparable.
Typically, dynamic thresholds are calculated tags.
Table 37. Analog Tag - Alarm Level Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
HINS_LIMIT Real High instrument limit.
15 This value (expressed in engineering 0
Optional units) defines the 100% scale of the tag. None
This parameter may be used instead of
SPAN.
SPAN Real Instrument span.
15 This value (expressed in engineering 0
Optional units) defines the range of the tag. None
When SPAN is used, the high instrument
limit is automatically calculated as the
result of VAL0 + SPAN.
HI_ACTIVE Character High instrument limit activation flag. {Y, N}
1 N
Optional None
140 9AKK101130D1382
Table 37. Analog Tag - Alarm Level Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
HI_PROG Character Program activation flag on high {Y, N}
1 instrument alarm. N
Optional If set, the application action program None
defined by AAP_NUM field will be
activated whenever a high instrument
alarm is generated.
H3ALARM Real 3-High alarm limit. {lowlim...higlim}
15 This value (expressed in engineering 0
Optional units) defines the third high alarm level. None
See Note 1 at the end of the table.
H3_ACTIVE Character 3-High alarm limit activation flag. {Y, N}
1 N
Optional None
H2ALARM Real 2-High alarm limit. {lowlim...higlim}
15 This value (expressed in engineering 0
Optional units) defines the second high alarm None
level.
See Note 1 at the end of the table.
H2_ACTIVE Character 2-High alarm limit activation flag. {Y, N}
1 N
Optional None
H23_PROG Character Program activation flag on 2 and 3-High {Y, N}
1 alarm. N
Optional If set, the application action program None
defined by AAP_NUM field will be
activated whenever a 2-High alarm or 3-
High alarm is generated.
9AKK101130D1382 141
Table 37. Analog Tag - Alarm Level Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
HALARM Real High alarm limit. {lowlim...higlim}
15 This value (expressed in engineering 0
Optional units) defines the first high alarm level. None
See Note 1 at the end of the table.
H_ACTIVE Character High alarm limit activation flag. {Y, N}
1 N
Optional None
H_PROG Character Program activation flag on high alarm. {Y, N}
1 If set, the application action program N
Optional defined by AAP_NUM field will be None
activated whenever a high alarm is
generated.
LALARM Real Low alarm limit. {lowlim...higlim}
15 This value (expressed in engineering 0
Optional units) defines the first low alarm level. None
See Note 1 at the end of the table.
L_ACTIVE Character Low alarm limit activation flag. {Y, N}
1 N
Optional None
L_PROG Character Program activation flag on low alarm. {Y, N}
1 If set, the application action program N
Optional defined by AAP_NUM field will be None
activated whenever a low alarm is
generated.
142 9AKK101130D1382
Table 37. Analog Tag - Alarm Level Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
L2ALARM Real 2-Low alarm limit. {lowlim...higlim}
15 This value (expressed in engineering 0
Optional units) defines the second low alarm level. None
See Note 1 at the end of the table.
L2_ACTIVE Character 2-Low alarm limit activation flag. {Y, N}
1 N
Optional None
L3ALARM Real 3-Low alarm limit. {lowlim...higlim}
15 This value (expressed in engineering 0
Optional units) defines the third low alarm level. None
See Note 1 at the end of the table.
L3_ACTIVE Character 3-Low alarm limit activation flag. {Y, N}
1 N
Optional None
L23_PROG Character Program activation flag on 2 and 3-Low {Y, N}
1 alarm. N
Optional If set, the application action program None
defined by AAP_NUM field will be
activated whenever a 2-Low alarm or 3-
Low alarm is generated.
VAL0 Real Low instrument limit.
15 This value (expressed in engineering 0
Optional units) represents the 0% scale of the tag. None
9AKK101130D1382 143
Table 37. Analog Tag - Alarm Level Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
LI_PROG Character Program activation flag on low instrument {Y, N}
1 alarm. N
Optional If set, the application action program None
defined by AAP_NUM field will be
activated whenever a low instrument
alarm is generated.
HVARALMTAG Character High variable alarm tag. <string>
20 Name of an analog tag whose value will <blank>
Optional be used as high alarm limit. If this field is [sznam]
defined, all values specified by fixed high
alarm limits will be ignored.
H2VARALMTG Character 2-High variable alarm tag. <string>
20 Name of an analog tag whose value will <blank>
Optional be used as 2-high alarm limit. If this field [sznam]
is defined, all values specified by fixed or
delta high alarm limits will be ignored.
H3VARALMTG Character 3-High variable alarm tag. <string>
20 Name of an analog tag whose value will <blank>
Optional be used as 3-high alarm limit. If this field [sznam]
is defined, all values specified by fixed or
delta high alarm limits will be ignored.
H2DELTA Real 2-High variable alarm delta. {lowlim...higlim}
15 This value (expressed in engineering 0
Optional units) will be added to the high variable None
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.
144 9AKK101130D1382
Table 37. Analog Tag - Alarm Level Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
H3DELTA Real 3-High variable alarm delta. {lowlim...higlim}
15 This value (expressed in engineering 0
Optional units) will be added to the high variable None
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 Character Low variable alarm tag. <string>
20 Name (or index) of an analog tag whose <blank>
Optional value will be used as low high alarm limit. [sznam]
If this field is defined, all values specified
by fixed low alarm limits will be ignored.
L2VARALMTG Character 2-Low variable alarm tag. <string>
20 Name (or index) of an analog tag whose <blank>
Optional value will be used as 2-low high alarm [sznam]
limit. If this field is defined, all values
specified by fixed or delta low alarm limits
will be ignored.
L3VARALMTG Character 3-Low variable alarm tag. <string>
20 Name (or index) of an analog tag whose <blank>
Optional value will be used as 3-low high alarm [sznam]
limit. If this field is defined, all values
specified by fixed or delta low alarm limits
will be ignored.
9AKK101130D1382 145
Table 37. Analog Tag - Alarm Level Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
L2DELTA Real 2-Low variable alarm delta. {lowlim...higlim}
15 This value (expressed in engineering 0
Optional units) will be subtracted from the low None
variable alarm tag value (if defined) to
determine the 2-Low variable alarm limit.
It is ignored if the L3VARALMTAG field is
defined.
See Note 1 at the end of the table.
L3DELTA Real 3-Low variable alarm delta. {lowlim...higlim}
15 This value (expressed in engineering 0
Optional units) will be subtracted from the low None
variable alarm tag value (if defined) to
determine the 3-Low variable alarm limit.
It is ignored if the L3VARALMTAG field is
defined.
See Note 1 at the end of the table.
Note 1:
In the range boxes, values of lowlim and higlim are defined by the
general formulas:
lowlim = VAL0
higlim = VAL0 + SPAN
Values of VAL0 and SPAN are defined in the alarm level definition sub-
section.
The SPAN field, defined in the database, is the full range of the tag (e.g.
the range of the instrument). The high instrument field, in the on-line
configuration, defines the high instrument limit and correspond to the
HINS_LIMIT field. They match only if the VAL0 field value is zero.
146 9AKK101130D1382
When defining fixed alarm levels be sure to have a correct sequence of
values for all active limits.
In other words fixed alarm limits must satisfy the following relation:
(VAL0+SPAN) >
H3ALARM > H2ALARM > HALARM >
LALARM > L2ALARM >L3ALARM >
VAL0
9AKK101130D1382 147
The alarm transition from a lower to a higher level alarm takes place
immediately when the raw value of tag exceeds the alarm limit threshold.
The alarm transition from a higher to a lower level alarm or from an alarm
level to a normal condition takes place when the raw value of tag is below
the alarm limit threshold minus the dead band.
Neither rate of change processing nor alarm dead-band definitions are
affected by instrument limits.
The last two fields in the table concern the instrument limit violation. They
allow defining actions to be performed on tag database value when an
instrument limit is exceeded.
Table 38. Analog Tag Alarm Option Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
HR_ACTIVE Character Increasing rate of change limit activation {Y, N}
1 flag. N
Optional None
HROC_LIMIT Real Increasing rate of change limit. {lowlim...higlim}
15 This value (expressed in engineering 0
Optional units) defines the maximum positive None
change allowed for the tag value during a
period of one minute. If the value is
exceeded, a increasing rate of change
alarm is generated.
See Note 1 at the end of the table.
HR_PROG Character Program activation flag on increasing rate {Y, N}
1 of change alarm. N
Optional If set, the application action program None
defined by AAP_NUM field will be
activated whenever an increasing rate of
change alarm is generated.
148 9AKK101130D1382
Table 38. Analog Tag Alarm Option Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
LR_ACTIVE Character Decreasing rate of change limit activation {Y, N}
1 flag. N
Optional None
LROC_LIMIT Real Decreasing rate of change limit. {lowlim...higlim}
15 This value (expressed in engineering 0
Optional units) defines the maximum negative None
change allowed for the tag value during a
period of one minute. If the value is
exceeded, a decreasing rate of change
alarm is generated.
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 Character Program activation flag on decreasing {Y, N}
1 rate of change alarm. N
Optional If set, the application action program None
defined by AAP_NUM field will be
activated whenever a decreasing rate of
change alarm is generated.
ALARMDB Real Alarm dead-band. {lowlim...higlim}
15 This value (expressed in engineering 0
Optional units) defines a dead-band below the None
high alarm limits and above the low alarm
limits. A high (low) alarm will return to
normal only when the value is below
(above) the high (low) alarm limit minus
(plus) the alarm dead-band.
See Note 1 at the end of the table.
9AKK101130D1382 149
Table 38. Analog Tag Alarm Option Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
LIMITDB Real Instrument dead-band.
15 This value (expressed in engineering 0
Optional units) defines a dead-band above the None
high instrument limit and below the low
instrument limit. A high (low) instrument
violation will be considered only when the
value is above (below) the high (low)
instrument limit plus (minus) the
instrument dead-band.
VIOL_CD Integer Instrument violation action code. {0, 1, 2}
1 This field determines the value to store 1
Optional into the realtime database when an None
instrument limit violation occurs. The
table below lists allowed codes and the
action on the realtime database:
0 - The current value is unchanged.
1 - The new value is stored.
2 - The instrument limit is stored.
The new value is ignored when code 0 or
2 is selected.
VIOL_SCAN Character Off scan flag for instrument limit violation. {Y, N}
1 If set, the tag will be put off scan upon the N
Optional second consecutive instrument limit None
violation.
Note 1:
In the range boxes, values of lowlim and higlim are defined by the
general formulas:
lowlim = VAL0
150 9AKK101130D1382
higlim = VAL0 + SPAN
Values of VAL0 and SPAN are defined in the alarm level definition sub-
section.
When defining the alarm dead-band be sure the value does not exceed
the absolute difference between two consecutive alarm levels.
9AKK101130D1382 151
Table 39. Analog Tag Alarm Comment Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ALRMCMNT3 Integer Low alarm comment index. {1...100}
5 0
Optional [mxalcm]
ALRMCTXT3 Character Low alarm comment text. <string>
80 <blank>
Optional [szalcm]
ALRMCMNT4 Integer 2-high alarm comment index. {1...100}
5 0
Optional [mxalcm]
ALRMCTXT4 Character 2-high alarm comment text. <string>
80 <blank>
Optional [szalcm]
ALRMCMNT5 Integer 2-low alarm comment index. {1...100}
5 0
Optional [mxalcm]
ALRMCTXT5 Character 2-low alarm comment text. <string>
80 <blank>
Optional [szalcm]
ALRMCMNT6 Integer 3-high alarm comment index. {1...100}
5 0
Optional [mxalcm]
ALRMCTXT6 Character 3-high alarm comment text. <string>
80 <blank>
Optional [szalcm]
152 9AKK101130D1382
Table 39. Analog Tag Alarm Comment Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ALRMCMNT7 Integer 3-low alarm comment index. {1...100}
5 0
Optional [mxalcm]
ALRMCTXT7 Character 3-low alarm comment text. <string>
80 <blank>
Optional [szalcm]
ALRMCMNT8 Integer High deviation alarm comment index. {1...100}
5 0
Optional [mxalcm]
ALRMCTXT8 Character High deviation alarm comment text. <string>
80 <blank>
Optional [szalcm]
ALRMCMNT9 Integer Low deviation alarm comment index. {1...100}
5 0
Optional [mxalcm]
ALRMCTXT9 Character Low deviation alarm comment text. <string>
80 <blank>
Optional [szalcm]
ALRMCMNT10 Integer Increasing rate of change comment {1...100}
5 index. 0
Optional [mxalcm]
ALRMCTXT10 Character Increasing rate of change comment text. <string>
80 <blank>
Optional [szalcm]
9AKK101130D1382 153
Table 39. Analog Tag Alarm Comment Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ALRMCMNT11 Integer Decreasing rate of change comment {1...100}
5 index. 0
Optional [mxalcm]
ALRMCTXT11 Character Decreasing rate of change comment text. <string>
80 <blank>
Optional [szalcm]
Network Parameters
Fields of this sub-section apply to both analog and digital tags. Refer to the
analogue sub-section of generic tag definition for details.
OPC Parameters
Fields of this sub-section apply to both analog and digital tags. Refer to the
analogue sub-section of generic tag definition for details.
Totalization Parameters
The fields in Table 40 allow definition of analog totalizations associated to
the analog tag. They are meaningful only if the TOT_LOG field is defined as
non zero value (i.e. a totalization has been associated to the tag).
154 9AKK101130D1382
Table 40. Analog Tag - Totalization Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ENELOST Integer Lost samples management code. {0, 1}
1 When 1 the lost samples management is 0
Optional active. None
ENEBAD Integer Bad samples management code. {0, 1}
1 When 1 the bad samples management is 0
Optional active. None
ENEEUINDEX Integer Engineering unit index. {-1, 0 ...127}
3 This is a reference to the coding of -1
Optional engineering units. [mxeutx]
ENELOSC1M Real Low scale value for 1 minute analog
15 totalization. 0
Optional None
ENELOSC10M Real Low scale value for 10 minute analog
15 totalization. 0
Optional None
ENELOSC30M Real Low scale value for 30 minute analog
15 totalization. 0
Optional None
ENELOSC1H Real Low scale value for 1 hour analog
15 totalization. 0
Optional None
ENELOSC8H Real Low scale value for 8 hours analog
15 totalization. 0
Optional None
9AKK101130D1382 155
Table 40. Analog Tag - Totalization Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ENELOSCDAY Real Low scale value for 1 day analog
15 totalization. 0
Optional None
ENELOSCMON Real Low scale value for 1 month analog
15 totalization. 0
Optional None
ENELOSCYEA Real Low scale value for 1 year analog
15 totalization. 0
Optional None
ENEHISC1M Real High scale value for 1 minute analog
15 totalization. 0
Optional None
ENEHISC10M Real High scale value for 10 minute analog
15 totalization. 0
Optional None
ENEHISC30M Real High scale value for 30 minute analog
15 totalization. 0
Optional None
ENEHISC1H Real High scale value for 1 hour analog
15 totalization. 0
Optional None
ENEHISC8H Real High scale value for 8 hours analog
15 totalization. 0
Optional None
156 9AKK101130D1382
Table 40. Analog Tag - Totalization Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ENEHISCDAY Real High scale value for 1 day analog
15 totalization. 0
Optional None
ENEHISCMON Real High scale value for 1 month analog
15 totalization. 0
Optional None
ENEHISCYEA Real High scale value for 1 year analog
15 totalization. 0
Optional None
ENERESC1M Real Rescale factor for 1 minute analog
15 totalization. 0
Optional None
ENERESC10M Real Rescale factor for 10 minute analog
15 totalization. 0
Optional None
ENERESC30M Real Rescale factor for 30 minute analog
15 totalization. 0
Optional None
ENERESC1H Real Rescale factor for 1 hour analog
15 totalization. 0
Optional None
ENERESC8H Real Rescale factor for 8 hours analog
15 totalization. 0
Optional None
9AKK101130D1382 157
Table 40. Analog Tag - Totalization Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ENERESCDAY Real Rescale factor for 1 day analog
15 totalization. 0
Optional None
ENERESCMON Real Rescale factor for 1 month analog
15 totalization. 0
Optional None
ENERESCYEA Real Rescale factor for 1 year analog
15 totalization. 0
Optional None
Documentation Parameters
The fields in Table 41 allow linking tag conditions and documentation.
Currently, PGP does not manage these fields, but they may be loaded in the
tag database for a future use.
Refer to the analogue sub-section of the generic tag definition for additional
fields.
158 9AKK101130D1382
Table 41. Analog Tag Documentation Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ALMDLA Integer Reference to low alarm documentation
5
Optional
ALMDHH Integer Reference to 2 high alarm documentation
5
Optional
ALMDLL Integer Reference 2 low alarm documentation
5 0
Optional None
ALMDSH Integer Reference to 3 high alarm documentation
5 0
Optional None
ALMDSL Integer Reference 3 low alarm documentation
5 0
Optional None
ALMDHD Integer Reference to high deviation alarm
5 documentation 0
Optional None
ALMDLD Integer Reference to low deviation alarm
5 documentation 0
Optional None
9AKK101130D1382 159
Table 41. Analog Tag Documentation Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ALMDHR Integer Reference to increasing rate of change
5 documentation 0
Optional None
ALMDLR Integer Reference to decreasing rate of change
5 documentation 0
Optional None
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
INSTR_TYPE Character Instrument type. <string>
8 This field describes the electrical range of <blank>
Optional the signal and the relevant E.U. None
conversion type. See Appendix A for the
valid instrument types.
160 9AKK101130D1382
Table 42. Analog Tag - Hardware Description Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
JBOX Character Thermocouple junction box <string>
6 <blank>
Optional None
RTD_COMP Character Identifier of the compensation thermo- <string>
14 resistance for thermocouple. <blank>
Optional None
Application Parameters
Fields of this sub-section apply to both analog and digital tags. Refer to the
analogue sub-section of generic tag definition for details.
Alarm Comments
Outline
Alarm comments are descriptive texts associated with all possible alarm
conditions of analog and digital tags.
These texts are collected into a dedicated file on a Personal Computer using
standard packages like DBase III/IV or EXCEL or the SLDG package
(provided by the Bailey Engineering Work Stations). Then, the file must be
copied to the computer running the PGP application (if it is a different one)
for final download. Tags will refer to alarm comments by index.
Alternatively, texts can be included in the tag database file. The alarm
comment database will be filled when the tag database is processed.
A non-existing text will be added in the first available location of the alarm
comment database and an index will be assigned to it. After a new text has
been added, all tags using the same text will point to the same location of
alarm comment database.
9AKK101130D1382 161
In this case, the ALRMCTXTn field will be filled, and the ALRMCMNTn will
be omitted in the tag database.
This section describes the structure of the Alarm Comment Database (the
first option is chosen).
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ALARMINDEX Integer Alarm comment index. {1...100}
5 0
Mandatory [mxalcm]
ALARMTEXT Character Alarm comment text. <string>
80 <blank>
Mandatory [szalcm]
Engineering Units
Outline
An engineering unit (E.U) may be associated with an analog tag. The
engineering unit is a descriptive text used to physically qualify values, and
give meaning to the scale of analog tags.
These texts are usually collected into a dedicated file on a Personal
Computer using standard packages like DBase III/IV or EXCEL or the SLDG
package (provided by the Bailey Engineering Work Stations).
Then, the file must be copied to the computer running the application PGP
(if it is a different one) for final download.
162 9AKK101130D1382
Analog tags will refer to engineering units by their index. In this case, analog
tags can directly point to this database by means of the field EUINDEX,
while the field EUDESC can be omitted.
Alternatively, texts can be included into the tag database file. The
engineering unit database will be filled when the tag database is processed.
A non-existing text will be added in the first available location of the
engineering unit database, and an index will be assigned to it.
After a new text has been added, all tags using the same text will point to the
same location of engineering unit database.
In this case, the EUDTEXT field will be filled and the EUDINDEX will be
omitted in the tag database.
This section describes the structure of Engineering Units Database (if first
option is chosen).
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
EUDINDEX Integer Engineering unit index. {1...127}
3 0
Mandatory [mxeutx]
EUDTEXT Character Engineering unit text. <string>
16 <blank>
Mandatory [sztags]
9AKK101130D1382 163
Logic State Descriptors
Outline
A logic state descriptor may be associated to a digital tag. The logic state
descriptor is a descriptive text used to clearly identify the status represented
by the value of digital tags.
Depending on the number of bits used to represent and store the digital tag
multiple logic state descriptors are used.
These texts are usually collected into a dedicated file on a Personal
Computer using standard packages like DBase III/IV or EXCEL or the SLDG
package (provided by the Bailey Engineering Work Stations).
Then, the file must be copied to the computer running the application PGP
(if it is a different one) for final download.
Digital tags will internally refer logic state descriptors by their index.
When defining the tag database, the text of logical state descriptors must be
defined. The logical state descriptor file will be filled when tag database is
processed to add missing elements.
A non-existing text will be added in the first free location of the logical state
descriptor database, and an index will be assigned to it. After a new text has
been added, all digital tags using the same text will point to the same
location of logical state description database.
This section describes the structure of Logic State Descriptors Database.
164 9AKK101130D1382
Table 45. Logic State Descriptor - Definition Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
LSDINDEX Integer Logic state descriptor index. {0...511}
3 0
Mandatory [mxlstx] and [n.tagt]
LSDTEXT Character Logic state descriptor text. <string>
16 <blank>
Mandatory [sztags]
Text Selector
Outline
Text selectors are descriptive texts that are associated to the values of a
particular type (TEXT) of analog tags.
These texts are usually collected into a dedicated file on a Personal
Computer using standard packages like Dbase III/IV or EXCEL or the SLDG
package (provided by the Bailey Engineering Work Stations).
Then, the file must be copied to the computer running the application PGP
(if it is a different one) for final download.
This section describes the structure of Text Selector Database.
9AKK101130D1382 165
Table 46. Text Selector - Definition Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
TEXTSINDEX Integer Text selector index. {0...9999}
5 0
Mandatory [mxtxts]
TEXTSTEXT Character Text selector string. <string>
80 <blank>
Mandatory [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.
Outline
The main goal of alarm subsystem is to process up to three types of events
(information events, return-to-normal events and alarm events) and to notify
operators by a wide range of peripheral devices, such as LADs (Latest
Alarm Displays), printers, OJ (Operations Journal) and audible alarms.
All these events may be queued by a scan subsystem (in the simplest
scheme) as well as by calculation package, configuration subsystem or user
programs.
The following section shows how to configure alarm groups requested by
alarm subsystem to process these events. The configuration of color/blink
override can be found in Color/Blink Override on page 367.
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.
General Parameters
The fields in Table 47 define the name and other additional parameters
used to identify the alarm group.
Table 47. Alarm Groups General Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ALMINDEX Integer Alarm group index. {0, 1...272}
3 This field identifies the alarm group by 0
Optional number. It must be unique for each [mxclbk]
alarm group in the database. If omitted
or zero (blank), the first vacant index
will be allocated.
168 9AKK101130D1382
Table 47. Alarm Groups General Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ALMNAME Integer Alarm group name. <string>
20 This must be a unique name within the <blank>
Mandatory alarm group database. [sznam]
ALMDESC Character Alarm group description. <string>
64 The description is used to identify the <blank>
Optional alarm group in the alarm group tree. [szdesc]
Grouping Parameters
The fields in Table 48 define the level of an alarm group within the tree
structure and the sub-groups belonging to the alarm group.
9AKK101130D1382 169
Table 48. Alarm Groups Grouping Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ALMLEVEL Integer Alarm sub-page level. {0,1...99}
3 It identifies the level of the sub-page 0
Mandatory hierarchy in the alarm sub-page being None
defined.
ALMLIST Character Alarm list. <string>
254 The alarm list includes the alarm <blank>
Mandatory attribute to check when displaying an None
alarm sub-page and the list of alarm
groups (sub-groups) belonging to the
group.
Legal alarm attributes are shown in
Table 49
Alarm attribute and group (sub-group)
numbers are separated by a comma. A
semicolon ends the alarm list.
See Note 1 below for an example of
alarm list definition.
FILENAME Character Specification of an ASCII file containing <string>
254 the alarm list. <blank>
Optional See Note 1 below for an example of None
alarm list file definition.
Attribute Description
UNACKD Unacknowledged alarms.
ALMTYP Alarm type.
ITMTYP Item type.
170 9AKK101130D1382
Table 49. Alarm Attributes.
Attribute Description
ALMGRP Alarm group.
ALMPRI Alarm priority.
Note 1:
Basically, there are two methods for specifying alarm lists. Either an external
file or a internal alarm list can be used.
Alarm list
The alarm list is directly included in the alarm group database file. A field
defines all sub-groups.
The alarm list is a sequence of group definitions (a comma is the separator
between alarm sub-groups) prefixed by the alarm attribute.
An example of alarm list is the following:
ALMGRP, 17,18,19,20,21,22,23,24,25;
This method can be used when the tag list does not exceed the maximum of
254 characters (upper limit for Dbase III/IV fields).
9AKK101130D1382 171
Below the definition of two alarm lists is shown.
$BEGIN_GROUP ALM 1
ALMGRP, 17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32;
$END_GROUP
$BEGIN_GROUP ALM 2
ALMGRP, 33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48;
$END_GROUP
Each alarm list is enclosed between the group identification keywords
$BEGIN_GROUP and $END_GROUP. The alarm group name qualifies the
tag list.
When un-building an alarm grouping, the output can be directed to the
database (DBF or XLS) file and to the alarm list file (TXT) or just to the
database (DBF or XLS) file depending on the current group configuration
of PGP .
If a alarm group configuration refers to a alarm list file, the un-build
process will update the database file and the alarm list file.
If an alarm group configuration defines sub-groups in the alarm list
(without any reference to an alarm list file), the un-build process will
update the database file only.
Security Parameters
The fields in Table 50 define the security parameters of the alarm group.
Security parameters control the access to alarm pages. Only authorized
users can gain access.
172 9AKK101130D1382
Table 50. Alarm Groups Security Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
SEC_LEVEL Integer Security level. {0, 1...16}
2 This field is checked whenever an user 0
Optional attempts to access the alarm group. None
Only users whose security level is
greater or equal to what's hereby
defined are enabled to access the
alarm group.
SEC_GROUP Integer Security group. {0, 1...32}
2 This field is checked whenever an user 0
Optional attempts to access the alarm group. None
Only users whose security group mask
includes what's hereby defined are
enabled to access the alarm group.
Additional Parameters
The fields in Table 51 define other additional parameters of the alarm group.
9AKK101130D1382 173
Table 51. Alarm Groups Additional Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ALMSUMMTYP Integer Alarm summary type.
3 This field specifies a processing option 0
Optional type for the digital output. none
ALMSUMMTAG Character Summary action tag name. <string>
20 This field specifies the name of a valid <blank>
Optional tag that is maintained updated with the [sznam]
current summary status. Typically, this
field is used to specify a digital output
tag that alarms external annunciators
or horns.
PRIMDISP Character Primary display name. <string>
80 This field specifies the name of a mimic <blank>
Optional display that can be associated to this None
alarm summary group and that can be
called by acting on the corresponding
alarm summary tile.
Audible Alarms
Outline
The audible alarm defines the tones PGP uses to notify alarms to the
operator. An audible can be played by the computer or played by horns
Symphony driven.
These audible tones are collected into a dedicated file on a Personal
Computer using standard packages like DBase III/IV or EXCEL.
Then, the file must be copied to the computer running the PGP application
(if it is a different one) for final download. Tags will refer to audible tones by
index.
174 9AKK101130D1382
Audible Alarms Definition
The on-line configuration does not provide data entry for audible tones.
Table 52. Audible Alarm - Definition Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
AUDINDEX Integer Audible index. {0...32}
3 0
Mandatory [mxaud]
AUDCODE Integer Audible code. {0...4}
1 Valid codes are 0
Mandatory 0 = No sound, None
1 = Beep sound,
2 = Wave file sound (continuous),
3 = Wave file sound (single shot),
4 = horn activation via RCM tag.
AUDFILE Character Audible wave file name. <string>
64 It is meaningful when AUDCODE is 2 or 3. <blank>
Optional The wave file must be located within the [szdesc]
\Config\Sound folder.
AUDRCM Character RCM tag name. <string>
20 It is meaningful when AUDCODE is 4. <blank>
Optional The RCM tag must be defined within the tag [sznam]
database and must refer to a physical horn.
9AKK101130D1382 175
Calculation Subsystem
Calculations
Outline
The PGP calculation package gives the user the functions of a scientific
calculator using data from the process and the customer database. It allows
complex calculations to be defined, documented and run by people who
know the most about the process.
Calculated tags (tag type CALCANG or CALCDIG) are driven by the
calculation package by defining calculation blocks.
A calculation block is a set of statements that are executed at a given period
(minimum is 1 second). These statements look like mathematical
expressions that consist of operands, arithmetic operators, functions,
relational and logic operators, and control structures (such as WHILE-DO
and IF-THEN-ELSE).
The package also provides functions to interact with the steam table. Input
operands may be either system tags or local variables.
The example in the following section shows the typical structure of a
calculation block.
Calculation example
As an example, let consider a user wishes to do a very rough leak detection
system on a section of an oil pipeline. This can be accomplished by
checking that the input flow is roughly equivalent to the output flow, setting
an alarm digital tag if the difference is greater than a fixed value stored in a
lab data entry tag.
Assume the following tags have been defined:
P100 - Accumulator input from flow station at beginning of pipeline.
P200 - Accumulator input from flow station at end of pipeline.
PDIF - Lab data entry tag containing the maximum allowed difference.
176 9AKK101130D1382
D001 -Calculated digital tag used for alarming purposes.
All tags involved in calculations must be defined by the tag database
configuration. See sections on tag database for details.
The code of the calculation is shown below.
/************************************************/
/* Compute the difference between input and output flow. */
/* Store the difference into a local variable. */
/************************************************/
9AKK101130D1382 177
The item Dif_Flow above is a local variable. Its value is meaningful within
the calculation and cannot be exported outside unless it is assigned to a
calculated analog tag.
Calculation Database
The calculation database is generated on a Personal Computer using
standard packages like DBase III/IV or EXCEL. Then, it must be copied to
the computer running the application PGP (if it is a different one) for final
import.
Calculation database is imported submitting the database file to the
database builder. During this phase, the field contents of the input file will be
used to compile PGP internal database structures following the directives
given by a field assignment cross-reference file, previously processed by
builder program DBXRF.
The database builder may also perform export operations, creating a target
database file (DBase III/IV format) containing all items as they are currently
defined in the PGP internal database.
If a target database does not exist, the builder processor creates it using the
whole PGP database structure.
Alternatively, a target database file may be specified as template. In this
case, the builder processor updates the target database file handling only
the fields specified in it.
The target database file may have just a single calculation or may be a full
or partial database file. It must contain all (and only) fields to be exported.
Calculation Definition
General Parameters
The fields in Table 54 define the name and other additional parameters
used to identify the calculation and to give an explicit reference to the
process.
The last four fields in Table 54 are not included within the Tab of general
parameters.
178 9AKK101130D1382
Table 53. Calculation General Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
CALCINDEX Integer Calculation block index. {0, 1...300}
6 This field identifies the calculation by 0
Optional number. It must be unique for each [mxclbk]
calculation in the database. If omitted
or zero (blank), the first vacant index
will be allocated.
CALCNAME Integer Calculation block name. <string>
20 This field is a unique identifier of the <blank>
Mandatory calculation. [sznam]
CALCDESC Character Calculation block description. <string>
64 <blank>
Optional [szdesc]
CALCINACT Character Deactivate flag. {Y, N}
1 If set, the calculation block will be N
Optional initially set to inactive. None
NOSLAVE Character Deactivate on secondary master flag. {N, Y}
1 If set, the calculation block will be only N
Optional executed on the primary master in a None
multi-master PGP architecture.
Log Parameters
The fields in Table 54 allow defining logs for operator actions and generic
information.
The on-line configuration does not provide a data entry Tab for such fields.
9AKK101130D1382 179
Table 54. Calculation Log Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
PR_OPACT Character Print flag for operator action messages. {Y, N}
1 If set, database modifications and all N
Optional other operator actions concerning this None
calculation will be printed on alarm
printer(s).
PR_INFO Character Print flag for information messages {Y, N}
1 If set, information concerning this N
Optional calculation will be printed. None
SV_OPACT Character Save flag for operator action {Y, N}
1 messages. N
Optional If set, information concerning this None
calculation will be logged to the
Operator Journal file.
SV_INFO Character Save flag for information messages {Y, N}
1 If set, information concerning this N
Optional calculation will be logged to the None
Operator Journal file.
Frequency Parameters
The fields in Table 55 define the basic information to perform the
calculation.
180 9AKK101130D1382
Table 55. Calculation - Frequency Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
CALCFRQ Integer Calculation period. {1...9999}
5 This field defines the timing of the 0
Mandatory calculation. See the CALCUNITS field None
also.
CALCUNITS Integer Calculation period unit. {0...3}
1 This field qualifies the CALCFREQ field 0
Mandatory assigning a time unit. None
See Appendix A for the allowed time
units.
OFFSET Integer Calculation offset. {1...9999}
5 This field defines a delay added to the 0
Optional execution time of the calculation. See the None
OFFSUNITS field also. Calculation offset
must always be less than calculation
period.
See Note 1 at the end of the table.
OFFSUNITS Integer Calculation offset unit. {0...3}
1 This field qualifies the OFFSET field 0
Optional assigning a time unit. None
See Appendix A for the allowed time
units.
9AKK101130D1382 181
Table 55. Calculation - Frequency Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
SAMPLFRQ Integer Sampling period. {0...99999}
5 Sampling period is used and must be 0
Optional defined when the calculation needs None
samples to produce the result. For
example: average, minimum, maximum
are calculation based on samples.
Sampling period must always be less
than calculation period.
SAMPLUNITS Integer Sampling period unit. {0...3}
1 See Appendix A for the allowed time 0
Optional units. None
Note 1:
The calculation offset is applied to the base time of the calculation block,
that is the greatest integer multiple of the calculation period less or equal
than calculation period itself (second zero if period is seconds, minute zero if
period is minutes, midnight if period is hours). For instance, to have a
calculation block running every 30 minutes at minute 5, the offset must be 5
minutes.
182 9AKK101130D1382
Table 56. Calculation Formula File Parameters.
Network Parameters
The fields in Table 57 refer to PGP network communication subsystem.
They are used when multiple PGP servers in a multi-master architecture
exchange data (values, alarm acknowledges, messages, configurations)
among them.
All fields are optional and they must be defined when servers (nodes) are
intended to cooperate in a multi-master architecture.
The fields reference the node definition. Refer to the Nodes database for
details.
9AKK101130D1382 183
Table 57. Calculation Network Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
CNFNODMSK Character Destination node mask for calculation Sequence {Y, N}
16 configurations. 16*N
Optional First bit refers to node 1 in the node None
definition, second bit refers to node 2,
and so on.
CNFNODMS2 Character Destination node mask for calculation Sequence {Y, N}
16 configurations. 16*N
Optional The mask applies to nodes from 17 to 32. None
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
NUMPAR Integer Number of parameters of the macro
3 function. 0
Optional This field is used in the macro function None
definition only.
184 9AKK101130D1382
Calculation Formula Syntax
A calculation block includes operands, arithmetic operators, functions,
relational and logic operators and control structures. The syntax for
calculations is like common mathematical expressions.
A calculation can use a maximum number of tags or constants (system
option MaxTagsPerCalculationBlock: it needs a system restart to be
changed).
Blank lines and comments may be used to make the expressions more
readable. Parentheses may be used anywhere to affect the order of
calculation.
Character Set
The character set of calculation package consists of all printable characters.
Blanks have no significance (unless used within a valid tag name). They
may be used to make the equation more readable.
Both upper case and lower case can be used.
TAB characters cannot precede and cannot be embedded within the
statements of a calculation. They can only be used beyond the end of a
statement to space a comment.
Operands
Operands are numbers, tag names, internal variables, constant names,
functions or macros.
Numbers
In the calculations, numeric values are processed as floating point numbers.
Expressions are calculated in double precision, but the inputs and the
results are single precision.
9AKK101130D1382 185
Tag Names
Tag names are used in the calculation blocks to represent values from the
realtime Database. Tag name may be up to 20 character long and must be
delimited by double quote characters.
In the calculation structure tag names represent a special kind of variables.
All the tags belonging to the calculation block are fetched from the realtime
Database at the same time, thus granting consistency to the data of the
block.
Functions
Functions are predefined names. Typically, they accept a number of input
parameters and produce a result. See the list of intrinsic functions for
capabilities and syntax.
Macros
Macros are predefined and reserved names. Typically, they accept a
number of input parameters and produce a number result. Refer to the
Calculation Macros manual for details on the syntax.
186 9AKK101130D1382
Comments
Comments may be placed anywhere to make the calculation block definition
more readable. The calculation processor recognizes the following
delimiters as comment:
C like comments
All characters delimited by /* (slash-asterisk) and */ (asterisk-slash) are
treated as a comment. The comment delimiters must be defined in the same
statement.
9AKK101130D1382 187
}
The statement continuation not necessarily must begin at column 1. It
can be indented to improve readability.
Expressions
An expression is a set of single items that, when evaluated, gives a result.
Operators act on variables (tag names, internal variables and constants) in
an expression.
In the syntax to exemplify expressions, the following symbols will be used:
<calc> - identifies an internal generic variable used as calculation result,
<ana_n> - identifies an generic analog value,
<dig_n> - identifies a generic digital value.
Constants, internal variables and tag names may represent analog and
digital values. For example, 5.6 may be a constant analog value; VAR may
be a variable analog value if VAR is an internal variable and PV-TAG may
be an analog value representing the current value of the tag PV-TAG in the
database.
Items related to expressions are listed in the following description.
188 9AKK101130D1382
Operator priorities
Operators are executed in order of priority, from highest priority to lowest.
Within the same priority, operators are executed from left-to-right or right-to-
left, according to the Table 59.
Table 59. Calculation - Operator Priorities.
Parentheses
Parentheses may be used anywhere to affect the order of calculations.
Regardless of operator priority, operations within parentheses are evaluated
before operations outside those parentheses. Operations within
parentheses are evaluated according to Table 59.
Arithmetic Operators
Except the prefix minus, arithmetic operators apply to a couple of operands
and give a result according to the rules of arithmetic. The prefix minus
applies to a single operand. The Table 60 lists the arithmetic operands.
Operands are numeric entities.
9AKK101130D1382 189
Table 60. Calculation - Arithmetic Operators.
Logical Operators
Except NOT, logical operators apply to a couple of operands and give a
result according to the rules of Boolean logic. The NOT operator applies to a
single operand. Table 61 lists the logic operands.
190 9AKK101130D1382
Table 61. Calculation - Logical Operators.
9AKK101130D1382 191
Relational operators
Relational operators compare two values. They return 1 if the relation is
true, 0 if the relation is false. Table 62 lists the relational operators.
Table 62. Calculation - Relational Operators.
192 9AKK101130D1382
Control Structures
Two control structures are available to calculation subsystem: IF-THEN-
ELSE and WHILE-DO.
IF-THEN-ELSE
The IF-THEN-ELSE structure is a compound operator. Its operands are one
logical expression (the IF clause) and several expressions (the THEN and
the ELSE clauses).
The processor evaluates the first (IF clause) expression. If that expression is
true (not equal to zero), the expressions comprised in the THEN branch are
evaluated and the expression comprised in the ELSE branch are skipped.
Otherwise the expressions comprised in the THEN branch are skipped and
the expressions comprised in the ELSE branch are evaluated.
The ELSE branch is optional and can be omitted. In such a case, if the IF
clause is false, no expressions of the IF-THEN-ELSE structure are
evaluated.
There are two formats allowed for the syntax of the IF-THEN-ELSE
structure: a C like structure and a Fortran like structure. The two structures
are shown in the following examples.
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
}
IF (expression_0)
THEN
expression_1_1
expression_2_1
....
expression_N_1
ELSE
expression_1_2
expression_2_2
....
expression_N_2
ENDIF
WHILE-DO
The WHILE-DO structure is a compound operator. Its operands are one
main expression (the WHILE clause) and several expressions which are
executed if the main expression is true (not equal to zero).
When all expressions have been executed, the main clause expression is
evaluated again; if its value continue to be true then all expressions are
executed again.
There are two formats allowed for the syntax of the WHILE-DO structure: a
C like structure and a Fortran like structure. The two structures are shown in
the following examples.
C like syntax
194 9AKK101130D1382
WHILE (expression_0)
{
expression_1
expression_2
....
expression_N
}
WHILE (expression_0) DO
expression_1
expression_2
....
expression_N
ENDWHILE
Using the WHILE-DO statement may cause never ending loops. In such
a case the main clause expression never become false and the
functionality of the calculation package will result compromised.
Be sure to avoid such cases carefully checking the main clause.
IF-THEN-ELSE and WHILE-DO structures can be nested. That is, the THEN
and the ELSE clause may include IF-THEN-ELSE and WHILE-DO
structures, the WHILE-DO body may include IF-THEN-ELSE and WHILE-
DO structures.
The Fortran like syntax of the IF-THEN-ELSE cannot be nested. Use the
C like syntax.
9AKK101130D1382 195
Intrinsic Functions
Functions are special operands, that return a value based on a set of input
parameters. Input parameters are enclosed between parentheses.
Functions follow the usual precedence rules of operands.
The following section gives a complete list and description of the intrinsic
functions available in the calculation subsystem.
For each function, the syntax lists the input parameters together the
engineering units (where applicable). The syntax of a generic function
having a total of n input parameters is shown below.
<calc> =
<function name>
(Input variables
[1] <parameter 1>,
[2] <parameter 2>,
......................
[n] <parameter n>,
End Variables)
196 9AKK101130D1382
<tag> - identifies a generic (analog or digital) tag name,
<pv_tag> - identifies a generic analog tag name,
<di_tag> - identifies a generic digital tag name.
Other internal variables will be used, where possible, to improve readability
of syntax. They are strictly related to the scope of the function.
Constants, internal variables and tag names may represent analog
(<analog_n>) and digital (<digital_n>) values. For example, 5.6 is a constant
analog value; VAR may be a variable analog value if VAR is an internal
variable and PV-TAG may be an analog value represented by the current
value of the tag PV-TAG in the database.
Execution Functions
These functions affect the algorithm execution of a calculation.
Table 63. Calculation - Execution Functions.
9AKK101130D1382 197
Logical Functions
These functions perform logical calculations. They are an optimization of the
basic logical operators AND and OR.
Table 64. Calculation - Logical Functions.
198 9AKK101130D1382
Mathematical Functions
These functions perform mathematical calculations. They are typical
mathematical functions.
Table 65. Calculation - Mathematical Functions.
9AKK101130D1382 199
Table 65. Calculation - Mathematical Functions.
200 9AKK101130D1382
Table 65. Calculation - Mathematical Functions.
9AKK101130D1382 201
Table 65. Calculation - Mathematical Functions.
202 9AKK101130D1382
Table 65. Calculation - Mathematical Functions.
9AKK101130D1382 203
Table 65. Calculation - Mathematical Functions.
204 9AKK101130D1382
Tag Functions
The functions allow operating on tags and interacting with the configuration
database and the realtime database.
Table 66. Calculation - Tag Functions.
9AKK101130D1382 205
Table 66. Calculation - Tag Functions.
206 9AKK101130D1382
Table 66. Calculation - Tag Functions.
9AKK101130D1382 207
Table 66. Calculation - Tag Functions.
208 9AKK101130D1382
Time Functions
The functions deal with the time and its components. They allow retrieving
information on time and date. Most of them do not require parameters at all.
Table 67. Calculation - Time Functions.
9AKK101130D1382 209
Table 67. Calculation - Time Functions.
210 9AKK101130D1382
Table 67. Calculation - Time Functions.
9AKK101130D1382 211
Steam Functions
The functions allow computing and retrieving data on steam and water
properties. They involve temperature, pressure, enthalpy, entropy and
specific volume of steam.
Table 68. Calculation - Steam Functions.
212 9AKK101130D1382
Table 68. Calculation - Steam Functions.
9AKK101130D1382 213
Table 68. Calculation - Steam Functions.
214 9AKK101130D1382
Gas Property Functions
The functions concern gas properties and apply to various kind of gasses.
They involve temperature, pressure, enthalpy, entropy, molecular weight,
volume and specific heat of gas.
Table 69. Calculation - Gas Property Functions.
9AKK101130D1382 215
Table 69. Calculation - Gas Property Functions.
216 9AKK101130D1382
Sea Water Functions
The functions concern sea water. They involve temperature, salt
concentration, enthalpy, density, conducibility, viscosity and specific heat of
sea water.
A single generic function named SEAW implements the various sea water
functions. An input parameter allows qualifying the generic function SEAW
to operate as a specific function.
Table 70. Calculation - Sea Water Functions.
9AKK101130D1382 217
Fuel Combustion Functions
The functions listed in Table 72 concern fuel combustion and flue gas, the
functions listed in Table 73 concern fuel combustion and fuel characteristics.
They involve temperature, enthalpy, entropy and composition of fuel and
flue gas.
The functions HFUMI, HFUMACHS, CPFUACHS, FAMAX, FARATIO,
CO2MAX and AIREXC, defined in previous manuals among the gas
property functions, have been removed from this manual because new
functions defined here replace them or they are not so general purpose to
be included.
However, they are still supported for compatibility with old versions of PGP.
Refer to the documentation of previous versions for details. The names are
reserved keywords and cannot be used within calculations to define internal
variables.
218 9AKK101130D1382
Table 72. Calculation - Fuel Combustion Functions Based on Flue Gas.
9AKK101130D1382 219
Table 72. Calculation - Fuel Combustion Functions Based on Flue Gas.
220 9AKK101130D1382
Table 72. Calculation - Fuel Combustion Functions Based on Flue Gas.
9AKK101130D1382 221
Table 73. Calculation - Combustion Functions Based on Fuel Characteristics.
222 9AKK101130D1382
Table 73. Calculation - Combustion Functions Based on Fuel Characteristics.
9AKK101130D1382 223
Table 73. Calculation - Combustion Functions Based on Fuel Characteristics.
224 9AKK101130D1382
Wet Air Functions
The functions concern wet air. They involve temperature, pressure, absolute
humidity, enthalpy, entropy and specific heat of wet air.
The functions HARIA, HHY, PVSAT and CPARIA, defined in previous
manuals among the gas property functions, have been removed from this
manual since the functions defined here replace them.
However, they are still supported for compatibility with old versions of PGP.
Refer to the documentation of previous versions for details. The names are
reserved keywords and cannot be used within calculations to define internal
variables.
9AKK101130D1382 225
Table 74. Calculation - Wet Air Functions.
226 9AKK101130D1382
Table 74. Calculation - Wet Air Functions.
9AKK101130D1382 227
Data File Functions
The two functions allow operations on PGP database data files. They
interfaces PGP standard data files and specific application data files.
Table 75. Calculation - Data File Functions.
Number Description
1 BYTE
2 USHORT
3 SHORT
228 9AKK101130D1382
Table 76. Read/Write File Formats.
Number Description
4 UINT
5 INT
6 FLOAT
7 DOUBLE
9AKK101130D1382 229
Historical Functions
Historical functions involve a single database tag. Samples are collected at
fixed time intervals and at calculation time they are processed to provide the
calculation result.
Table 77. Calculation - Historical Functions.
230 9AKK101130D1382
Table 77. Calculation - Historical Functions.
9AKK101130D1382 231
Table 77. Calculation - Historical Functions.
232 9AKK101130D1382
Table 77. Calculation - Historical Functions.
9AKK101130D1382 233
Table 77. Calculation - Historical Functions.
234 9AKK101130D1382
Table 77. Calculation - Historical Functions.
9AKK101130D1382 235
Table 77. Calculation - Historical Functions.
236 9AKK101130D1382
Table 77. Calculation - Historical Functions.
9AKK101130D1382 237
Trend Group Subsystem
Trend Groups
Outline
PGP provides an integrated trend group processor for both analog and
digital tags. The trend group package, like all PGP subsystems, can be
configured to meet specific application requirements without programming.
It maintains sets of input tags organized as trend groups and allows easy
data displaying.
Trend groups can be classed into three main classes: realtime, historical
and post trip groups.
Realtime groups allow quick data retrieving and presentation of tag values in
trend or table format. realtime data are main concern of realtime groups.
Playback is the data source for realtime group presentations. realtime
groups do not require any recording on file.
Tag values of historical groups are periodically retrieved from playback,
processed and stored in a set of circular files (Historic Database) or trip files
(Post Trip Database). Once stored, data can be retrieved to display trends
or tables on operator demand and are made available to Excel work-sheet
(via DDE service) for printing.
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.
9AKK101130D1382 239
There are both mandatory and optional parameters. A field (type of the trend
group) allows the identification of group and establishes which other fields
must be filled in to complete the configuration. Additional fields are listed in
the specific sections following this one.
General Parameters
The fields in Table 78 define the name and other additional parameters
used to identify and characterize the trend group.
Table 78. Generic Trend Group General Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
GROUPINDEX Integer Group index. {0, 1...100}
6 This field identifies the group by number. 0
Optional It must be unique for each trend group in [mxhgrp]
the database. If omitted or zero (blank),
the first vacant index will be allocated.
GROUPNAME Character Group name. <string>
20 This field identifies the group by name. It <blank>
Mandatory must be unique for each trend group in [sznam]
the database.
GROUPUID Character Trend group unique identification. <string>
36 This field provides a unique identification <blank>
Optional within the PGP life cycle. None
See Note 1 at the end of the table.
GROUPDESC Character Group description. <string>
64 <blank>
Optional [szdesc]
240 9AKK101130D1382
Table 78. Generic Trend Group General Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
EUINDEX Integer Engineering unit index. {-1, 0 ...127}
3 This field defines the index into the -1
Optional engineering unit database. It can be used [mxeutx]
to assign a unique engineering unit to the
group. It supersedes the engineering
units of the tags belonging to the group.
The field is not included within the fields
of the on-line configuration Tab.
EUDESC Character Engineering unit text. <string>
16 This text defines the engineering unit to <blank>
Optional be associated with the tags in the group. None
It can be used to assign a unique
engineering unit to the group. It
supersedes the engineering units of the
tags belonging to the group.
GROUPCLASS Integer Class of trend group.
3 Customer may class trend groups using 0
Optional this field. None
ARCHTYPE Character Type of archiving. <string>
7 This parameter qualifies the trend group. <blank>
Mandatory Depending on the type, the set of None
parameters required to fully configuring
the group changes.
See the Table 79 for the list of all
archiving types.
EXP_VAL Character Relational database update (tag values) {Y, N}
1 flag. N
Optional If set, tag values will be automatically None
sent to the relational database.
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.
As a general rule, perform a database export immediately after a build
operation in order to fill in a non-assigned GROUPUID field within a group
database file.
The Table 79 lists all types of trend groups. The third column is the key to
establish the additional parameters to fully configure the group. In the
following pages, specific sections exist to define each kind of group.
Depending on the type of trend group refer to the section corresponding to
the kind.
Table 79. Trend Group - Archiving Types.
242 9AKK101130D1382
Table 79. Trend Group - Archiving Types.
Display Parameters
The fields in Table 80 define some displaying parameters of the trend group.
Table 80. Generic Trend Group Display Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
TIMESPAN Integer Default time range for group displaying.
5 It applies to both realtime and historical 0
Optional trend groups. It applies to both curve None
(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.
SPANUNITS Integer Time units to qualify time span field. {0...5}
1 See Appendix A for allowed time units. 0
Optional None
9AKK101130D1382 243
Table 80. Generic Trend Group Display Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
DISPFRQ Integer Default list display frequency.
5 It is the time interval between two 0
Optional consecutive values when a trend group is None
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.
DISPUNITS Integer Time units to qualify display frequency {0...5}
1 field. 0
Optional See Appendix A for allowed time units. None
CURVETYPE Integer Kind of representation for the trend {0,1,2}
1 curves. 0
Optional Allowed values are: None
0 - default (interpolation),
1 - step,
2 - interpolation.
Link Parameters
The fields in Table 81 define links to displays or other trend groups for
exploring purposes.
244 9AKK101130D1382
Table 81. Generic Trend Group Link Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
PRIMDISP Character Primary display reference. <string>
80 Name of a graphic display associated to <blank>
Optional the group. None
FWDNAME Character Forward link among trend groups. <string>
20 This field defines the name of another <blank>
Optional group chained as following to the current [sznam]
one.
BWDNAME Character Backward link among trend groups. <string>
20 This field defines the name of another <blank>
Optional group chained as previous to the current [sznam]
one.
ESCNAME Character Escape page name. <string>
20 This field defines the name of an escape <blank>
Optional display to leave the trend group [sznam]
subsystem. Typically it is the name of a
plant or menu mimic.
ENTNAME Character Menu page name. <string>
20 This field defines the name of an menu <blank>
Optional display. [sznam]
9AKK101130D1382 245
Log Parameters
The fields in Table 82 allow defining logs for operator actions and generic
information.
Table 82. Generic Trend Group General Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
PR_OPACT Character Print flag for operator action messages. {Y, N}
1 If set, database modifications and all N
Optional other operator actions concerning this None
group will be printed on the alarm
printer(s).
PR_INFO Character Print flag for information messages {Y, N}
1 If set, information concerning this group N
Optional will be printed on the alarm printer(s). None
SV_OPACT Character Save flag for operator actions. {Y, N}
1 If set, database modifications and all N
Optional other operator actions concerning this None
group will be logged to Operator Journal.
SV_INFO Character Save flag for information messages {Y, N}
1 If set, information concerning this group N
Optional will be logged to Operator Journal. None
246 9AKK101130D1382
Tag List Parameters
The fields in Table 83 define the basic information to identify tags belonging
to the trend group.
Table 83. Generic Trend Group - Tag List Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
TAGFILE Character Specification of an ASCII file containing <string>
254 the tag list. <blank>
Optional See Note 1 at the end of the table for
details.
TAGLIST Character List of tags belonging to the trend group. <string>
254 See Note 1 at the end of the table for <blank>
Optional details. None
NUMTAGS Integer Number of tags defined in the trend {0...60}
3 group. 0
Optional If not specified, it is assumed to be the [grptag]
total number of tags in the group as found
in the tag list or tag file (see next fields). If
specified, it must be greater or equal to
the total number of defined tags. If
greater, it keeps space allocated to allow
adding tags later on without collected
historical data are lost (i.e. the group
initialization is not required).
The field is not included within the fileds
of the on-line configuration Tab.
Note 1:
Basically, there are two methods for specifying tags belonging to a trend
group. Either an external tag file or a internal tag list can be used.
9AKK101130D1382 247
Tag list.
The list of tags is directly included in the trend group database file. A field
defines all tags.
The tag list is a sequence of tag definitions (a semicolon is the separator
between tag definitions). Each definition concerns a tag and is a set of three
items: the tag name, the low and the high limits for trend format
presentations (a comma is the separator between items).
An example of tag list is the following:
TAG-1, 0, 100; TAG-2, -10, 10; TAG-3, 0, 200;
This method can be used when the tag list does not exceed the maximum of
254 characters (upper limit for Dbase III/IV fields).
The on-line configuration provides a dialog window to enter the tag list.
Select the entry in the tag list and then type the tag name and the display
limits in the fields of the dialog.
Tag file.
The list of tags is contained in an ASCII file. A field in the trend group
database file allows definition of the file name. The tag file must be located
in the same folder hosting the trend group database file: typically this folder
is PGP\Config\Group. Since the trend group name is referenced in a tag file,
a unique tag file for all groups or a tag file for each group may be used. The
syntax of the tag list is the same defined above.
This method must be used when the total number of characters for the tag
list definition is greater than 254.
Below the definition of two tag lists is shown.
$BEGIN_GROUP GROUP-01
PV-TAG-01, 0, 100; PV-TAG-02, 0, 110;
PV-TAG-03, 0, 120; PV-TAG-04, 0, 130;
PV-TAG-05, 0, 140; DI-TAG-01, 0, 1;
DI-TAG-02, 0, 2; DI-TAG-03, 0, 3;
$END_GROUP
248 9AKK101130D1382
$BEGIN_GROUP GROUP-02
PV-CAL-01, 0, 100;PV-CAL-02, 0, 100;
PV-CAL-03, 0, 6000; DI-CAL-01, 0, 1;
$END_GROUP
If a group configuration defines the tags in the tag list, a limit of 254
characters in the output field of the database file may cause truncation of
the tag list.
9AKK101130D1382 249
Network Parameters
The fields in Table 84 refer to PGP network communication subsystem.
They are used when multiple PGP in a multi master architecture exchange
data (values and configurations).
All fields are optional.
Table 84. Generic Trend Group - Network Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
CNFNODMSK Character Destination node mask for trend group Sequence {Y, N}
16 configurations. 16*N
Optional First bit refers to node 1 in the node None
definition, second bit refers to node 2,
and so on.
CNFNODMS2 Character Destination node mask for trend group Sequence {Y, N}
16 configurations. 16*N
Optional The mask applies to nodes from 17 to 32. None
CNFNODMS3 Character Destination node mask for trend group Sequence {Y, N}
16 configurations. 16*N
Optional The mask applies to nodes from 33 to 48. None
CNFNODMS4 Character Destination node mask for trend group Sequence {Y, N}
16 configurations. 16*N
Optional The mask applies to nodes from 49 to 64 None
DESTVALMSK Character Destination node mask for tag values of Sequence {Y, N}
16 trend group. 16*N
Optional Tag values of group are routed from the None
current node to the nodes set in the
destination mask. First bit refers to node
1 in the node definition, second bit refers
to node 2, and so on.
250 9AKK101130D1382
Table 84. Generic Trend Group - Network Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
DESTVALMS2 Character Destination node mask for tag values of Sequence {Y, N}
16 trend group. 16*N
Optional The mask applies to nodes from 17 to 32. None
DESTVALMS3 Character Destination node mask for tag values of Sequence {Y, N}
16 trend group. 16*N
Optional The mask applies to nodes from 33 to 48. None
DESTVALMS4 Character Destination node mask for tag values of Sequence {Y, N}
16 trend group. 16*N
Optional The mask applies to nodes from 49 to 64. None
9AKK101130D1382 251
History Parameters
The parameters listed in Table 85 allow defining archive and size of an
historical trend group.
Table 85. Historic Trend Group - History Parameters (Archiving).
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ARCHFRQ Integer Archiving frequency.
5 The value defines the time interval 0
Mandatory between two consecutive values stored in None
a historical group. Data are processed
and archived with the frequency defined
bu this field.
It applies to historical trend groups only.
ARCHUNITS Integer Time units to qualify archiving frequency {0...5}
1 field. 0
Mandatory See Appendix A for the allowed time None
units.
OFFSET Integer Archiving offset.
5 This field defines a delay added to 0
Optional processing time of the group. See the None
OFFSUNITS field also. Archiving offset
must always be less than archiving
period.
See Note 1 at the end of the table.
OFFSUNITS Integer Time units to qualify offset field. {0...5}
1 See the Appendix A for the allowed time 0
Optional units. None
252 9AKK101130D1382
Table 85. Historic Trend Group - History Parameters (Archiving).
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
TOTSAMPLES Integer Total number of elements kept archived.
9 The value defines the number of 0
Mandatory elements (that is, the size) of a trend None
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.
ARCHINHTAG Character Archiving inhibit tag name. <string>
20 If defined, this tag allows inhibiting data <blank>
Optional archiving when it leaves its normal state. [sznam]
Data archiving resumes when the
inhibiting tag returns to the normal state.
Note 1:
The archiving offset is applied to the base time of the trend group, that is the
greatest integer multiple of the archiving period less or equal than archiving
period itself (second zero if period is seconds, minute zero if period is
minutes, midnight if period is hours). For instance, to have a group archiving
every 30 minutes at minute 5, the offset must be 5 minutes.
The parameters listed in Table 86 must be defined only when the archive
type is TOTAL, AVERAGE, MIN or MAX. These type of archiving only
process a set of samples to archive a computed value. Samples are
collected within the archiving period.
9AKK101130D1382 253
Table 86. Historic Trend Group - History Parameters (Sampling).
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
SAMPLFRQ Integer Sampling frequency.
5 The value is the time interval between 0
Mandatory two consecutive samples gathered to None
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.
SAMPLUNITS Integer Time units to qualify sampling frequency {0...5}
1 field. 0
Mandatory See Appendix A for the allowed time None
units.
BADSAMPLES Integer Percent of allowed bad samples. {0...99}
2 If greater than 0, a datum to be archived 0
Optional is marked bad when the percentage of None
bad samples among collected samples is
greater than the defined percent value.
The two parameters in Table 87 allow retrieving data for archiving from
another historical group. Data archiving on the input group must grant data
availability in order the derived group can retrieve data.
254 9AKK101130D1382
Deriving a group from another allows producing long term historical
archives. For example, a daily archive may be derived from a hourly archive;
a yearly archive may be derived from a monthly archive.
Table 87. Historic Trend Group - History Parameters (Deriving).
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
DERIVED Character Derived group flag. {Y,N}
1 This flag states the current group is a N
Optional derived one. Another group defined by None
the field below is the source of
information.
INPGROUP Character Name of the input group. <string>
20 If the derived group flag is set, this field <blank>
Optional specifies the name of the source group. [sznam]
9AKK101130D1382 255
Time Function Parameters
The parameters in the Table 88 must be defined only when the archive type
is COUNT, MONITOR or RATIO.
Table 88. Historic Trend Group - Time Function Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
MONVALUE Character Monitor flag for value of tags. {Y, N}
1 If the flag is set, the value of each tag is N
Optional monitored and compared to threshold None
limits.
For a MONITOR or RATIO group, the
historical group subsystem archives the
absolute or relative time (within the
archive frequency) the tag assumes a
value within the threshold limits.
For a COUNT group, the number of times
the value of a tag enters within the
threshold limits is archived.
MONQUALITY Character Monitor flag for quality of tags. {Y, N}
1 If the flag is set, the quality of each tag is N
Optional monitored and compared to the quality None
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.
256 9AKK101130D1382
Table 88. Historic Trend Group - Time Function Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
MONREVERSE Character Reverse monitoring flag. {Y, N}
1 Reverse the counting or monitoring rules N
Optional defined by the couple of fields above. None
Values or qualities outside threshold
limits are considered.
MONUNITS Integer Time units for monitoring. {0...5}
1 This field defines the interval used as 0
Optional time basis for monitoring evaluation. None
See the Appendix A for the allowed time
units.
MONFACT Integer Monitor factor. {1, 10, 100, 1000}
2 This field applies to RATIO groups only. 1
Optional None
TARGETLOW Integer Low threshold limit for value monitoring.
10 0
Optional None
TARGETHIGH Integer High threshold limit for value monitoring.
10 0
Optional None
TARGETQUAL Character Bit mask for quality monitoring. Sequence {0, 1}
32 This bit mask must match the bit mask <blank>
Optional organization of quality bits (see Appendix None
A for the quality bit structure).
9AKK101130D1382 257
Trip Parameters
Post trip groups activation is set during the configuration of the tag
database. A field in the tag database allows defining the number of post trip
group to be activated. Refer to tag database configuration for details.
Table 89. Historic Trend Group - Trip Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
PRETIME Integer Pre trip time. {0...99999}
5 It defines the amount of time to be taken 0
Optional into account before trip. Exception reports None
found in this time interval are retrieved
from playback and archived as post trip
data.
PREUNITS Integer Time units to qualify pre trip time field. {0...5}
1 See Appendix A for the allowed time 0
Optional units. None
POSTTIME Integer Post trip time. {0...99999}
5 It defines the amount of time to be taken 0
Optional into account after trip. Exception reports None
incoming during this time interval are
gathered and archived as post trip data.
See Note 1 at the end of the table.
POSTUNITS Integer Time units to qualify post trip time field. {0...5}
1 See Appendix A for the allowed time 0
Optional units. None
258 9AKK101130D1382
Table 89. Historic Trend Group - Trip Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
TRIPCOUNT Character Trip counter tag name. <string>
20 The tag defined here keeps track of trips. <blank>
Optional Each time a trip takes place, the counter [sznam]
increments.
TRIPCLOS Character Close trip flag. {Y,N}
1 If set, trip archiving ends when triggering N
Optional tag returns to normal condition (before None
post trip time elapses). Otherwise, post
trip archiving ends when post trip time
elapses.
See Note 1 at the end of the table.
Note 1:
The post trip time defines the post trip duration also. In order to gather
incoming exception reports, the post trip archiving is kept active until the
post trip time elapses.
For example, a post trip archiving will last 5 minutes if post trip time is set to
5 minutes. If the close trip flag is set, the post trip archiving will last at least 5
minutes. It will last less than 5 minutes if the triggering tag will return to
normal before 5 minutes elapses.
9AKK101130D1382 259
Report Subsystem
Report
Outline
PGP provides a complete set of functionalities for generating and managing
reports.
Report logs are used to obtain data from the PGP database, either from the
realtime and the historical archives, and to load data into spreadsheets,
allowing the user to format, store and perform calculations using live and
historic process data.
The reports are generated and maintained on the PGP Server computer.
The report generation program produces files that may be printed and/or
archived on the hard disk. To control the disk allocation of the report archive,
the maximum number of files kept archived and the maximum latency time
can be defined for each report.
The report configuration is based on Microsoft Excel work-sheets.
PGP provides the features listed in the following items.
The reports can be generated upon user request or on a periodic basis,
triggered by an alarm (tag in alarm condition). The scheduling
parameters can be configured by using the standard Build utility.
The reports can be archived into dedicated directory folders and/or
printed. These features can be configured by using the standard Build
utility.
The reports provide the capability to include into the Excel work-sheet
data coming from the PGP realtime and historical databases by using
the Dynamic Data Exchange (DDE) functionality.
The user will have the possibility to view the archived reports, print
and/or delete them, using the PGP report interface.
This chapter does not deal with the structure of a report. Refer to Microsoft
Excel manuals for details about work-sheet implementation.
260 9AKK101130D1382
In the following sections the structure of the definition database and the set
of functions to access PGP data are described.
Report Database
The report definition database is generated on a Personal Computer using
standard packages like DBase III/IV or EXCEL. Then, it must be copied to
the computer running the application PGP (if it is a different one) for final
import.
The report is imported submitting the database file to the database builder.
During this phase, the field contents of the input file will be used to compile
PGP internal database structures following the directives given by a field
assignment cross-reference file, previously processed by builder program
DBXRF.
The database builder may also perform export operations, creating a target
database file (DBase III/IV format) containing all items as they are currently
defined in the PGP internal database. If PGPa target database does not
exist, the builder processor creates it using the whole PGP database
structure. Alternatively, a target database file may be specified as template.
In this case, the builder processor updates the target database file handling
only the fields specified in it. The target database file may have just a single
report or may be a full or partial database file. It must contain all (and only)
fields to be exported.
Report Definition
The following sub-sections defines the parameters required to configure
reports within PGP (i.e. to notify PGP a report exists), to schedule them at
specified time intervals, to link the report to the Excel work-sheet template
and to keep controlled the disk allocation (limiting the number or the age of
reports stored on the hard disk).
The following section introduces the functions to interface PGP databases
from Excel work-sheets.
9AKK101130D1382 261
General Parameters
The fields in Table 90 define the name and other additional parameters
used to identify the report. A field (report index) allows the report
identification within other databases (e.g. in the tag database to define the
report activated on event). Additional fields are listed in the specific sub-
sections following this one.
Table 90. Report - General Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
REPINDEX Integer Report index. {0...50}
6 This field identifies the report by number. 0
Optional It must be unique for each report in the [nmrpts]
database. If omitted or zero (blank), the
first vacant index will be allocated.
REPNAME Character Report name. <string>
20 This field identifies the report by name. It <blank>
Mandatory must be unique for each report in the [sznam]
database.
REPDESC Character Report description. <string>
64 <blank>
Mandatory [szdesc]
REPINHTAG Character Report inhibit tag name. <string>
20 Name of a tag that, while in alarm, will <blank>
Optional disable the generation of the report. If the [sznam]
field is blank, no report inhibit is defined.
262 9AKK101130D1382
Activation Parameters
The fields in Table 91 define scheduling or activation parameters used to
generate the report.
Table 91. Report - Activation Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
SCHDFRQ Integer Schedule frequency. {1...99999}
5 If greater than 0, the field allows 0
Optional automatically generating a report. None
The minimum allowed value is 1 minute
(SCHDFRQ=1 and SCHDUNITS=1).
A value of 1 second (SCHDFRQ=1 and
SCHDUNITS=0) means no automatic
scheduling and may be used when
defining a manually activated or a
scheduled on event report.
SCHDUNITS Integer Time unit to qualify scheduling frequency. {0...3}
1 See Appendix A for the allowed time 0
Optional units. None
OFFSET Integer Report offset. {0...99999}
5 This field defines a delay added to the 0
Optional scheduling time of report. See the None
OFFSUNITS field also. Report offset
must always be less than report period.
See Note 1 at the end of the table.
9AKK101130D1382 263
Table 91. Report - Activation Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
OFFSUNITS Integer Time unit to qualify report offset. {0...3}
1 See Appendix A for the allowed time 0
Optional units. None
ACTONEVENT Character Activate report flag on event. {Y,N}
1 The tag whose REP_NUM field refers to N
Optional this report will activate reporting. If set, None
the field makes the report eligible for
activation when the activating tag goes in
an alarm condition.
Note 1:
The report offset is applied to the base time of the report, that is the greatest
integer multiple of the scheduling period less or equal than scheduling
period itself (second zero if period is seconds, minute zero if period is
minutes, midnight if period is hours). For instance, to have a report
scheduled every 30 minutes at minute 5, the offset must be 5 minutes.
Archiving Parameters
The fields in Table 92 define the additional parameters used to archive
report on the hard disk and to control disk space allocation.
A parameter allows selecting to archive generated reports on the hard disk.
Two parameters, meaningful when archiving is selected, allow deleting from
the hard disk reports older than a latency time or exceeding a maximum
limit. Both latency time and maximum limit can be defined for the same
report. It is strongly suggested to define latency time and maximum number
of reports (at least one of them) when the disk archiving is selected.
264 9AKK101130D1382
Table 92. Report - Archiving Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ARCHIVE Character Disk archiving flag. {Y,N}
1 When a report is generated from its Y
Optional template, it is stored on the hard disk. None
Each report has a its own folder in the
\PGP\Reports folder.
MAXLATENCY Integer Maximum latency time (days).
5 Reports older than the latency days are 0
Optional deleted from the hard disk. None
MAXREPORTS Integer Maximum number of reports.
4 The oldest reports exceeding the allowed 0
Optional maximum are deleted from the hard disk. None
9AKK101130D1382 265
Printing Parameters
The fields in Table 93 define the parameters involved in printing the report.
Table 93. Report - Printing Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
PRINT Character Print flag. {Y,N}
1 When a report is generated from its N
Optional template, it is printed on the None
documentation printer.
PRINTER Character Printer name. <string>
20 Name of the documentation printer. <blank>
Optional [sznam]
266 9AKK101130D1382
Excel Parameters
The fields in Table 94 define the parameters used to reference the Excel
work-sheet. They allow linking the report definition and the report Excel
template.
Table 94. Report - Excel Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
XLSDATCELL Character Date cell reference. <string>
10 The field is a reference to a cell within the <blank>
Optional Excel template file. The syntax is n!Am None
where n is the sheet number and Am is
the cell reference (e.g. 1!M3 is a
reference to cell M3 of sheet 1).
The cell in the Excel file must be of type
General or Numeric and it will contain the
starting date used when the report is
manually requested. It can be referenced
using the GetSecFromDate routine (refer
to the next section) to provide a date in
the internal PGP format.
9AKK101130D1382 267
Table 94. Report - Excel Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
XLSFILE Character Excel work-sheet file name. <string>
64 The field refers to the Excel template file <blank>
Mandatory where the structure of the report is [szdesc]
implemented.
The Excel work-sheet must be located
within the \PGP\Config\Reports folder.
XLSSHEET Integer Excel sheet index. {1...99)
2 A Excel work-sheet (report template) may 0
Mandatory contain multiple sheets. From the None
reporting point of view each sheet must
be referenced as a report. In other words,
a report must exist for each sheet.
Instead, a multiple page work-sheet is
considered as a single report.
SOE Parameters
The fields in Table 95 define the additional parameters used to link the
report to a Sequence of Event. That is, these parameters allow defining
sequence of event reports based on Excel work-sheets.
268 9AKK101130D1382
Table 95. Report - SOE Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
SOETYPE Integer Type of sequence of events. {0, 1}
1 The value of this field can be 0
Optional 0 - Standard SOE None
1 - Summary SOE
SOEDEVICE Integer Sequence of event device. {0, 1, 2}
2 Number of the SER device generating the 0
Optional sequence of events. [mxsedv]
Excel Work-Sheet
A report is generated on demand or periodically based on scheduling
parameters as introduced in the previous section. A template work-sheet
created by Excel is the cell matrix used to generate the actual report.
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 Functions
The following sub-sections define the functions available with the PGP
software to provide an additional interface to the Microsoft Excel work-sheet
package. The libraries of functions can be included within each report or can
be added to Excel as Add-In. Refer to the Microsoft Excel manual for details
on Add-In and the inclusion of library modules within Excel.
The public library is named Tnt.xla and is located within the
\PGP\Config\Reports. It includes all the public functions listed in the
following description.
The thermodynamic library is named Steamlib.xla and is located within the
\PGP\Config\Calc. It includes steam functions, gas property functions, sea
water functions, wet air functions and fuel combustion functions as listed in
the following description.
Public functions
A set of public functions allow interacting PGP in order to retrieve data for
reporting. They include function to interface the tag configuration database,
the realtime database, the playback and the historic groups. Time
manipulation functions are included also.
270 9AKK101130D1382
Table 96. Reports - Public Functions.
9AKK101130D1382 271
Table 96. Reports - Public Functions.
272 9AKK101130D1382
Table 96. Reports - Public Functions.
9AKK101130D1382 273
Table 96. Reports - Public Functions.
274 9AKK101130D1382
Table 96. Reports - Public Functions.
9AKK101130D1382 275
Table 96. Reports - Public Functions.
Note 1:
276 9AKK101130D1382
The force recalculation parameter is a optional date field. If used, it must be
set to NOW() and forces recalculation of value each time the cell is
referenced.
Steam Functions
Steam functions of calculations can be used and referenced within Excel
work-sheets. They are listed in Table 97.
Table 97. Report - Steam Functions.
9AKK101130D1382 277
Table 97. Report - Steam Functions.
278 9AKK101130D1382
Table 97. Report - Steam Functions.
9AKK101130D1382 279
Gas Property Functions
Gas property functions of calculations can be used and referenced within
Excel work-sheets. They are listed in Table 98.
Table 98. Report - Gas Property Functions.
280 9AKK101130D1382
Sea Water Functions
Sea water functions of calculations can be used and referenced within Excel
work-sheets. They are listed in Table 99.
Table 99. Report - Sea Water Functions.
9AKK101130D1382 281
Fuel Combustion Functions
Fuel combustion functions of calculations can be used and referenced within
Excel work-sheets. They are listed in Table 100 and Table 101.
Table 100. Report - Fuel Combustion Functions Based on Flue Gas.
282 9AKK101130D1382
Table 100. Report - Fuel Combustion Functions Based on Flue Gas.
9AKK101130D1382 283
Table 100. Report - Fuel Combustion Functions Based on Flue Gas.
284 9AKK101130D1382
Table 101. Report - Combustion Functions Based on Fuel Characteristics.
9AKK101130D1382 285
Table 101. Report - Combustion Functions Based on Fuel Characteristics.
286 9AKK101130D1382
Table 101. Report - Combustion Functions Based on Fuel Characteristics.
9AKK101130D1382 287
Wet Air Functions
Wet air functions of calculations can be used and referenced within Excel
work-sheets. They are listed in Table 102.
Table 102. Report - Wet Air Functions.
288 9AKK101130D1382
Table 102. Report - Wet Air Functions.
9AKK101130D1382 289
Pegboard Subsystem
Outline
PGP provides an integrated pegboard subsystem for process control. The
pegboard package, like all PGP subsystems, can be configured to meet
specific application requirements without programming. It maintains sets of
control tags organized as special mimics.
Process control devices (stations, MSDD, RCM etc.) can be defined as
components of a pegboard. Also displaying devices for analog and digital
tags can be defined as pegboard components. A pegboard is a special
mimic where space is divided in 32 rectangles. Up to 32 process control
devices can be arranged within the space. Since control devices require
different space for allocation, the total number of devices depends on the
their type. For example, stations requires 4 unit rectangles and up to 8
stations may fit the pegboard space.
Each pegboard allows process control by interacting with the control devices
it hosts.
Pegboard Database
The pegboard database is generated on a Personal Computer using
standard packages like DBase III/IV or EXCEL. Then, it must be copied to
the computer running the application PGP (if it is a different one) for final
import.
Pegboard database is imported submitting the database file to the database
builder. During this phase, the field contents of the input file will be used to
compile PGP internal database structures following the directives given by a
field assignment cross-reference file, previously processed by builder
program DBXRF.
The database builder may also perform export operations, creating a target
database file (DBase III/IV format) containing all items as they are currently
defined in the PGP internal database. If a target database does not exist,
the builder processor creates it using the whole PGP database structure.
Alternatively, a target database file may be specified as template. In this
case, the builder processor updates the target database file handling only
290 9AKK101130D1382
the fields specified in it. The target database file may have just a single
pegboard or may be a full or partial database file. It must contain all (and
only) fields to be exported.
Pegboard Definition
The following sections list the parameters to characterize all kind of
pegboards. There are both mandatory and optional parameters.
General Parameters
The fields in Table 103 define the name and other parameters used to
identify the pegboard. Additional fields are listed in the specific sections
following this one.
Table 103. Pegboard - General Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
PAGEINDEX Integer Pegboard page index. {0, 1...100}
6 This field identifies the pegboard by 0
Optional number. It must be unique for each [nmopds]
pegboard in the database.
If omitted or zero (blank), the first vacant
index will be allocated.
PAGENAME Character Pegboard name. <string>
20 This field identifies the pegboard by <blank>
Mandatory name. It must be unique for each [sznam]
pegboard in the database.
PAGEDESC Character Pegboard description. <string>
64 <blank>
Optional [szdesc]
9AKK101130D1382 291
Link Parameters
The fields in Table 104 define links to displays or other pegboards. Those
links are used when exploring the pegboards as a continuous sequence.
Table 104. Pegboard - General Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
FWDNAME Character Forward link among pegboards. <string>
20 It is the name of another pegboard <blank>
Optional chained as next to the current one. [sznam]
BWDNAME Character Backward link among pegboards. <string>
20 It is the name of another pegboard <blank>
Optional chained as previous to the current one. [sznam]
ESCNAME Character Escape page name. <string>
20 It is the name of an escape display. <blank>
Optional Typically it is the name of a mimic. [sznam]
ENTNAME Character Menu page name. <string>
20 It is the name of an menu display. <blank>
Optional [sznam]
292 9AKK101130D1382
Popup Parameters
The fields in Table 105 define structure of the pegboard.
Two parameters: type of popup and tag name identify each popup within the
pegboard.
Table 105. Pegboard - Popup Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
POP01TYPE Integer Type of the first popup. {0...3}
1 See Table 106 for allowed popup types. 0
Optional See Notes 1 and 2 at the of the table. None
POP01TAG Character Tag name of the first popup. <string>
20 <blank>
Optional [sznam]
.................. ............... ................................................. .........
POP32TYPE Integer Type of the 32-nd popup. {0...3}
1 See Table 106 for allowed popup types. 0
Optional See Notes 1 and 2 at the of the table. None
POP32TAG Character Tag name of the 32-nd popup. <string>
20 <blank>
Optional [sznam]
9AKK101130D1382 293
Table 106. Pegboard - Popup Types.
Note 1:
Up to 32 popup may fit within a pegboard. The actual number of pop-ups
within a pegboard depends on the number of buckets required by each
single popup to fit and on the type of pop-ups included within a pegboard.
A control station, for example, has a size of 4 buckets and, consequently, 8
control stations may fit within a pegboard. A MSDD has a size of 2 buckets
and up to 16 MSDDs may fit within a pegboard. An analog or digital
visualization popup has a size of one bucket and up to 32 visualization
popup may fit within a pegboard. Be careful on configuring pegboards to
allocate pop-ups in the correct positions to avoid overlaps.
Note 2:
Other than control tags, lab data entry tags also can be defined in a
pegboard. Of course, they will only set a value in the realtime database.
294 9AKK101130D1382
Operator Station Subsystem
9AKK101130D1382 295
Identification Parameters
The fields in Table 109 define the name and other additional parameters
used to identify and qualify menu and tool-bar items. They define the type of
item to be a menu, a tool-bar (button) or a display tree element.
Additional fields allow characterizing the item depending on the type.
Additional fields are listed in the specific sections following this one.
Table 107. Menu and Tool-bar - Identification Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
MENUINDEX Integer Item number. {1...100}
5 This is a unique number to identify each
Optional menu and tool-bar item. [n.menu]
It must be unique for each item within
database. If omitted or zero (blank), the
first vacant index will be allocated.
MENULABEL Character Item description. <string>
64 If the item is a icon, this field is the tool-tip <blank>
Mandatory text. If the item is a menu element, this [szdesc]
field is the text of the element. If the item
is a leaf of a display tree, this field is the
text of the leaf.
BUTTONTYPE Character Item type. See Table 108
9 The field identifies the item to be an
Mandatory element of a menu, a tool-bar (button) or None
a display tree.
Allowed item types are listed in Table 108
296 9AKK101130D1382
Table 108. Menu and Tool-bar - Item Types.
Action Parameters
The fields in Table 109 define the additional parameters used to qualify
action related to menu and tool-bar items. They define the action to be
performed upon selection. Action can be display a mimic, execute a
program, activate a PGP function.
Table 109. Menu and Tool-bar - Action Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
BUTTONACT Character Associated kind of action. See Table 110
9 The field identifies the action to be
Mandatory performed upon item selection. None
Allowed values are listed in Table 110
9AKK101130D1382 297
Table 109. Menu and Tool-bar - Action Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
MENUPGM Character Program name. <string>
9 The field is the name of the program to <blank>
Optional activate when the menu or tool-bar item is None
selected. It is valid only if the action is
program activation.
MENUCMDLIN Character Program parameter. <string>
128 This field is a parameter (if any) to be <blank>
Optional passed to the program at activation time. None
Standard command lines are listed in
Table 111
298 9AKK101130D1382
Table 110. Menu and Tool-bar - Action Types.
9AKK101130D1382 299
Table 111. Menu and Tool-bar - Standard Command Lines.
300 9AKK101130D1382
Table 111. Menu and Tool-bar - Standard Command Lines.
9AKK101130D1382 301
Presentation Parameters
The fields in Table 112 and Table 116 define additional parameters used to
graphically qualify menu and tool-bar items. These fields defines the icon
names of buttons and optionally the functional key of the keyboard to be
used instead of the mouse (track-ball) to select.
Table 112. Menu and Tool-bar - Presentation Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
IMGNORMAL Character Icon name or tree element. <string>
10 If ButtonType is set to Button, the field is <blank>
Mandatory the icon name used to display a normal None
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
IMGALARM Character Icon name or tree element. <string>
10 If ButtonType is set to Button, the field is <blank>
Mandatory the icon name used to display an alarm None
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
302 9AKK101130D1382
Table 112. Menu and Tool-bar - Presentation Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
IMGBLINK Character Icon name. <string>
10 If ButtonType is set to Button, the field is <blank>
Mandatory the icon name used to display an None
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
MENUFKEY Integer Function key. {0, 1, ..., 90}
3 The field identifies a function key button 0
Optional of the keyboard to be associated to the None
menu or tool-bar item.
A value of 0 means that no functional key
button has been associated to the item.
MENULEVEL Integer Menu level. {0, ..., 9}
3 It applies to menu items only and 0
Optional identifies the level in the menu structure. None
The value 0 is the root level.
MENUSEP Character Item separator. {Y, N}
1 The field specifies if a separator must be N
Optional placed between the previous and the None
current items. If set, the item separator is
a space for tool-bars and a line for
menus.
Note 1:
The icons whose names are defined above must exist or must be included
within the \PGP\Icons folder.
9AKK101130D1382 303
Table 113. Menu and Tool-bar - Standard Normal Icons.
304 9AKK101130D1382
Table 114. Menu and Tool-bar - Standard Alarm Icons.
The parameters listed in Table 116 are not included in the on-line
configuration utility.
Table 116. Menu and Tool-bar - Presentation Parameters (cntd.).
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
MENUTAG Character Tag name. <string>
20 The field is the name of a tag associated <blank>
Optional to the menu item. [sznam]
9AKK101130D1382 305
Allowed Parameters
The fields in Table 117 define security parameters to grant access to
various menu and tool-bar items.
Table 117. Menu and Tool-bar - Allowed Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
MENUOPSTA Integer Number of operator station. {0, 1...32}
3 It allows assign the item to a single 0
Optional operator station. The code 0 means the [nmcrts]
item is assigned to all operator stations.
SECGROUP1 Character Privilege to access tags and displays {Y,N}
1 belonging to the security group 1. N
Optional None
.................. ............... ................................................. .........
SECGROUP32 Character Privilege to access tags and displays {Y,N}
1 belonging to the security group 32. N
Optional None
SECLEVEL Integer Security level. {0, 1, ..., 16}
2 The value is compared to the security 0
Optional level assigned to the user before to grant None
access. A value of 0 means no security
check.
306 9AKK101130D1382
Privilege Parameters
The fields in Table 118 define security parameters to grant access to
various menu and tool-bar items.
Table 118. Menu and Tool-bar - Privilege Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ALARMS Character Privilege for executing general alarm {Y,N}
1 management. N
Optional None
APPL1 Character Privilege for accessing specific {Y,N}
1 application functions. N
Optional None
APPL2 Character Privilege for accessing specific {Y,N}
1 application functions. N
Optional None
CALCUL Character Privilege for configuring calculations. {Y,N}
1 N
Optional None
CLSERVER Character Privilege for accessing the client/server {Y,N}
1 management functions. N
Optional None
CONFIG Character Privilege for configuring some {Y,N}
1 miscellaneous functions (e.g. engineering N
units, logic state descriptors).
Optional None
DIAGNOSTIC Character Privilege for executing diagnostic {Y,N}
1 functions. N
Optional None
9AKK101130D1382 307
Table 118. Menu and Tool-bar - Privilege Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
GRAPHICS Character Privilege for performing mimic {Y,N}
1 configuration. N
Optional None
GROUPS Character Privilege for configuring historical and {Y,N}
1 realtime groups. N
Optional None
HISTORY Character Privilege for performing general historical {Y,N}
1 functions (e.g. initialize historical N
counters).
Optional None
INFINET Character Privilege for executing functions related {Y,N}
1 to the C-NET modules. N
Optional None
LOGS Character Privilege for modifying the configuration {Y,N}
1 of the reports, for triggering and deleting N
archived reports.
Optional None
LTERMHIST Character Privilege for executing long term historical {Y,N}
1 functions. N
Optional None
NAVIGATE Character Privilege for WEB navigation. {Y,N}
1 N
Optional None
ODBC Character Privilege for configuring the ODBC {Y,N}
1 functions. N
Optional None
308 9AKK101130D1382
Table 118. Menu and Tool-bar - Privilege Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
REMWRITEF Character Privilege for writing a file in remote {Y,N}
1 access (e.g. using DDE functions). N
Optional None
SECURITY Character Privilege for accessing and modifying {Y,N}
1 security and users. N
Optional None
TIMEDATE Character Privilege for setting the time and date. {Y,N}
1 N
Optional None
TRENDS Character Privilege for accessing trend functions. {Y,N}
1 N
Optional None
UTILITY Character Privilege for executing general utility {Y,N}
1 functions. N
Optional None
VIEWCONFIG Character Privilege for displaying the configuration {Y,N}
1 databases. N
Optional None
VIEWDISP Character Privilege for viewing displays. {Y,N}
1 If set, display viewing is submitted to N
Optional security group check also. None
9AKK101130D1382 309
Table 118. Menu and Tool-bar - Privilege Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
VIEWHIST Character Privilege for viewing historical data. {Y,N}
1 N
Optional None
WINDOWSNT Character Privilege for accessing Windows {Y,N}
1 functions (e.g. window sizing, Windows N
desktop usage).
Optional None
310 9AKK101130D1382
Network Subsystem
Nodes
Outline
A network structure may involve two or more PGP. Data exchange can be,
in general, required to transfer process information or configuration data
from a node to the other(s).
As an example, the alarm acknowledge broadcasting from a PGP to the
other(s) can be required.
The node definition allows defining the structure of the cooperating PGPs
within a network.
Node Database
The node database is generated on a Personal Computer using standard
packages like DBase III/IV or EXCEL. Then, it must be copied to the
computer running the application PGP (if it is a different one) for final import.
Node database is imported submitting the database file to the database
builder. During this phase, the field contents of the input file will be used to
compile PGP internal database structures following the directives given by a
field assignment cross-reference file, previously processed by builder
program DBXRF.
The database builder may also perform export operations, creating a target
database file (DBase III/IV format) containing all items as they are currently
defined in the PGP internal database. If a target database does not exist,
the builder processor creates it using the whole PGP database structure.
Alternatively, a target database file may be specified as template. In this
case, the builder processor updates the target database file handling only
the fields specified in it. The target database file may have just a single node
or may be a full or partial database file. It must contain all (and only) fields to
be exported.
9AKK101130D1382 311
Node Definition
The following sections list parameters to characterize nodes within a
network. There are both mandatory and optional parameters.
A node item is configured as a pseudo-tag: it is not included within tags, but
has some of fields typical of tag configuration.
General Parameters
The fields in Table 119 define the name and other additional parameters
used to identify nodes in the network. Additional fields are listed in the
specific sections following this one.
Table 119. Node - General Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
NODEINDEX Integer Node index. {0...32}
5 This field identifies the node by number. It 0
Optional must be unique for each node in the [mxnode]
database. If omitted or zero (blank), the
first vacant index will be allocated.
NODENAME Character Node name. <string>
20 The node name must be the name <blank>
Mandatory assigned to the computer and can be [sznam]
retrieved by the Network function of the
Control Panel.
NODEDESC Character Node description. <string>
64 <blank>
Optional [szdesc]
PRIMDISP Character Primary display reference. <string>
9 Name of a graphic display associated to <blank>
Optional the node. For example, it could be the None
name of a diagnostic display showing the
network component.
312 9AKK101130D1382
Table 119. Node - General Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ZEROSTATE Character Zero state descriptor. <string>
6 This field defines the text to represent the <blank>
Optional failure state. [sztags]
ONESTATE Character One state descriptor. <string>
6 This field defines the text to represent the <blank>
Optional normal state. [sztags]
PLANTUNIT Integer Plant unit number.
2 This field identifies the plant unit 0
Optional (applicable only to multi-unit plants). None
WEIGHT Integer Node weight.
2 In a multi-master network configuration, 0
Optional the highest value (weight) defines the None
master node.
SNAPALGMSK Character Destination node mask for snapshot Sequence {Y, N}
16 alignment at PGP start-up. 16*N
Optional First bit refers to node 1 in the node None
definition, second bit refers to node 2,
and so on.
SNAPALGMS2 Character Destination node mask for snapshot Sequence {Y, N}
16 alignment at PGP start-up. 16*N
Optional The mask applies to nodes from 17 to 32. None
9AKK101130D1382 313
Table 119. Node - General Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
SNAPALGMS4 Character Destination node mask for snapshot Sequence {Y, N}
16 alignment at PGP start-up. 16*N
Optional The mask applies to nodes from 49 to 64 None
314 9AKK101130D1382
Table 119. Node - General Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
OJALGMS3 Character Destination node mask for chronological Sequence {Y, N}
16 alarm file alignment at PGP start-up. 16*N
Optional The mask applies to nodes from 33 to 48. None
HISTALGMSK Character Destination node mask for historical files Sequence {Y, N}
16 alignment at PGP start-up. 16*N
Optional First bit refers to node 1 in the node None
definition, second bit refers to node 2,
and so on.
9AKK101130D1382 315
Table 119. Node - General Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
HISTALGMS2 Character Destination node mask for historical filesk Sequence {Y, N}
16 alignment at PGP start-up. 16*N
Optional The mask applies to nodes from 17 to 32. None
HISTALGMS3 Character Destination node mask for historical files Sequence {Y, N}
16 alignment at PGP start-up. 16*N
Optional The mask applies to nodes from 33 to 48. None
HISTALGMS4 Character Destination node mask for historical files Sequence {Y, N}
16 alignment at PGP start-up. 16*N
Optional The mask applies to nodes from 49 to 64 None
316 9AKK101130D1382
Alarm Process Parameters
The fields in Table 120 define additional information for the alarm
processing of the node pseudo-tag.
Table 120. Node - Alarm Process Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
DS_ALARM Character Display alarm flag. {Y, N}
1 If set, an alarm message concerning this Y
Optional pseudo-tag will be displayed on alarm None
display page (LAD).
DS_RTN Character Display flag for return to normal. {Y, N}
1 If set, a RTN message concerning this Y
Optional pseudo-tag will be displayed on alarm None
display page (LAD).
The alarm acknowledge will remove the
message.
BOT_ALARM Character Display flag for unacknowledged on {Y, N}
1 bottom. Y
Optional If set, a unacknowledged alarm None
concerning this pseudo-tag will be
displayed on the bottom of screen
window.
REM_ONACK Character Remove flag on acknowledgment. {Y, N}
1 On alarm acknowledgment the message N
Optional concerning this pseudo-tag is removed None
from the alarm page.
INFO_ONACK Character Log flag on alarm acknowledgment. {Y, N}
1 When an alarm concerning this pseudo- N
Optional tag is acknowledged a info message is None
logged to the Operator Journal.
9AKK101130D1382 317
Table 120. Node - Alarm Process Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
PR_ALARM Character Print alarm flag. {Y, N}
1 If set, an alarm message concerning this N
Optional pseudo-tag will be printed on the alarm None
printer.
See the field ALMPRINTER also.
PR_OPACT Character Print flag for operator action message. {Y, N}
1 If set, database modifications and all N
Optional other operator actions concerning this None
pseudo-tag will be printed.
See the field ALMPRINTER also.
PR_RTN Character Print flag for return to normal message. {Y, N}
1 If set, a RTN massage concerning this N
Optional pseudo-tag will be printed. None
See the field ALMPRINTER also.
PR_INFO Character Print flag for information message. {Y, N}
1 If set, a information message concerning N
Optional this pseudo-tag will be printed. None
See the field ALMPRINTER also.
SV_ALARM Character Save alarm flag. {Y, N}
1 If set, an alarm message concerning this Y
Optional pseudo-tag will be logged to the Operator None
Journal.
SV_OPACT Character Save flag for operator action. {Y, N}
1 If set, database modifications and all Y
Optional other operator actions concerning this None
pseudo-tag will be logged to the Operator
Journal.
318 9AKK101130D1382
Table 120. Node - Alarm Process Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
SV_RTN Character Save flag for return to normal message. {Y, N}
1 If set, a RTN message concerning this Y
Optional pseudo-tag will be logged to the Operator None
Journal.
SV_INFO Character Save flag for information message. {Y, N}
1 If set, a information message concerning Y
Optional this pseudo-tag will be logged to the None
Operator Journal.
ALMPRINTER Integer Alarm printer index.
2 Reference index to the printer where 0
Optional messages concerning the tag are printed. None
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.
ALMGROUP Integer Alarm group. {0, 1...272}
3 Refer to the same field of the tag 0
Optional database for a complete description. [sladnm] and
[mxxagp]
AL_PRI Integer Alarm priority. {0, 1...15}
2 Refer to the same field of the tag 1
Optional database for a complete description. [mxalpr] and
[mxxapr]
AUD_ALARM Character Activate flag for audible signals on alarm {Y,N}
1 occurrences. Y
Optional None
9AKK101130D1382 319
Table 120. Node - Alarm Process Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
AUDINDEX Integer Audible alarm index. {0, 1...32}
3 This field defines the index into audible 0
Optional alarm database to determine which [mxaud]
audible is to be activated upon alarm
and/or return to normal.
AUD_RTN Character Print flag for audible signal on return to {Y, N}
1 normal. N
Optional None
APPL_ALA Character Application program activation flag. {Y,N}
1 If set, trigger an application program on N
Optional alarm occurrence. None
EXP_ALA Character Relational database update flag. {Y,N}
1 If set, alarm messages are automatically N
Optional sent to the external relational database. None
320 9AKK101130D1382
Security Subsystem
Security
Outline
PGP offers a security subsystem allowing definition of internal users. Each
user is identified by a name and a password.
A set of access rights and permissions can be assigned to each user. In
such a way access to PGP functions or operations (e.g. tag configuration)
can be denied.
In configuring PGP, various security level validity masks can be defined to
limit access to functions or items (e.g. tags). Those masks are used to
control operator actions on the following items.
Program Activation,
Display Retrieval,
Data Entry Field Selection,
Action Field Selection,
Tag Database Configuration,
Group Definition and Display,
Process Control.
The masks associated with the above items will be referred to as the
"validity masks" throughout this section.
PGP provides the following validity masks:
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 Database
The security database is generated on a Personal Computer using standard
packages like DBase III/IV or EXCEL. Then, it must be copied to the
computer running the application PGP (if it is a different one) for final import.
Security database is imported submitting the database file to the database
builder. During this phase, the field contents of the input file will be used to
compile PGP internal database structures following the directives given by a
field assignment cross-reference file, previously processed by builder
program DBXRF.
The database builder may also perform export operations, creating a target
database file (DBase III/IV format) containing all items as they are currently
defined in the PGP internal database. If a target database does not exist,
the builder processor creates it using the whole PGP database structure.
Alternatively, a target database file may be specified as template. In this
case, the builder processor updates the target database file handling only
the fields specified in it. The target database file may have just a single user
or may be a full or partial database file. It must contain all (and only) fields to
be exported.
Security Definition
The following sections list a set of parameters to define a PGP user. There
are both mandatory and optional parameters.
9AKK101130D1382 323
General Parameters
The fields in Table 121 define the name and other additional parameters
used to identify the PGP user.
Table 121. Security - General Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
USERINDEX Integer User index. {0...20}
3 This field identifies the PGP user by 0
Optional number. It must be unique for each user [n.pswd]
in the database. If omitted or zero (blank),
the first vacant index will be allocated.
USERNAME Character User name. <string>
18 This field identifies the PGP user by <blank>
Mandatory name. It must be unique for each user in [szunam]
the database.
PASSWORD Character User password. <string>
18 The export function does not fill in this <blank>
Mandatory field to prevent password decoding. [szunam]
A new created security database file does
not include the field.
See also the caution Note at the end of
the table.
CRYPTPWD1 Integer Encrypted user password.
18 The export function fills in this field.
Mandatory A new created security database file None
includes the field.
See also the caution Note at the end of
the table.
324 9AKK101130D1382
Table 121. Security - General Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
USERCODE Integer User code.
4 Numeric code, such as a payroll code, 0
Optional associated to the user. It is used only for None
display purposes.
LANGUAGE Integer Man machine interface language.
2 The value 0 defaults to the English 0
Optional language. Any other value set an None
alternate language. Of course, the
dictionary for such alternate language
must be defined.
ACTIVE USER Character Define if the inserted item refers to a real <string>
1 user or identify a Users group <blank>
Mandatory [szunam]
WINGROUP Character Define if the inserted item refers to a real <string>
64 user or identify a Users group <blank>
Optional [szunam]
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 Parameters
The fields in Table 122 define access control parameters used to restrict
user accesses and to prevent unauthorized accesses.
Table 122. Security - Access Control Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
LOGOFFTMO Character Log-off on time-out. {Y,N}
1 The log-off time-out is related to the N
Optional screen saver setting. It is required to set None
the screen sever time-out in order to
control the automatic user log-off.
Automatic log-off is forced when the
screen saver time-out expires.
LOGINDISP Character Log-in display. <string>
9 Name of a mimic displayed when the user <blank>
Optional logs in. None
LOGOFFDISP Character Log-off display. <string>
9 Name of a mimic displayed when the user <blank>
Optional logs out or the time-out forces a log out. None
9AKK101130D1382 327
Table 122. Security - Access Control Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
MAXLOGINFAIL Integer Maximum number of log-in trials. {0, 1...9999}
4 The user is no longer allowed to log-in 0
Optional after the maximum number of trials is None
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.
PWDAGING Integer Password aging (number of days). {0, 1...9999}
4 After that time has elapsed, the user is no 0
Optional longer allowed to log-in. The user must None
change the password before its expiration
or the system manager must set a new
password after expiration.
328 9AKK101130D1382
Access Security Parameters
The fields in Table 123 define security parameters to operate on single tags.
Table 123. Security - Tag Operation Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
TAGMONITOR Character Privilege to monitor tags. {Y,N}
1 N
Optional None
TAGCONFIG Character Privilege to configure tags. {Y,N}
1 N
Optional None
TAGCONTROL Character Privilege to execute process control on {Y,N}
1 tags. N
Optional None
TAGTUNE Character Privilege to tune the process tags. {Y,N}
1 N
Optional None
TAGDELETE Character Privilege to delete tags. {Y,N}
1 N
Optional None
TAGENTDATA Character Privilege to perform data entry on tags. {Y,N}
1 N
Optional None
TAGOFFSCAN Character Privilege to put tags off scan and on scan. {Y,N}
1 N
Optional None
9AKK101130D1382 329
Table 123. Security - Tag Operation Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
TAGOFFALM Character Privilege to put tags off alarm check and {Y,N}
1 on alarm check. N
Optional None
TAGLIMIT Character Privilege to change alarm limits of tags. {Y,N}
1 N
Optional None
TAGACK Character Privilege to acknowledge alarms. {Y,N}
1 N
Optional None
TAGMONALL Character Privilege to perform full tag monitoring. {Y,N}
1 Security level and security group check is N
Optional bypassed. None
TAGREMOTE Character Privilege for remote access on tags. {Y,N}
1 N
Optional None
TAGENTHIST Character Privilege to enter historical data on tags. {Y,N}
1 N
Optional None
330 9AKK101130D1382
Table 124. Security - Privilege Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ALARMS Character Privilege for executing general alarm {Y,N}
1 management. N
Optional None
APPL1 Character Privilege for accessing specific {Y,N}
1 application functions. N
Optional None
APPL2 Character Privilege for accessing specific {Y,N}
1 application functions. N
Optional None
CALCUL Character Privilege for configuring calculations. {Y,N}
1 N
Optional None
CLSERVER Character Privilege for accessing the client/server {Y,N}
1 functions. N
Optional None
CONFIG Character Privilege for configuring some {Y,N}
1 miscellaneous functions (such as N
engineering units and logic state
Optional None
descriptors).
DIAGNOSTIC Character Privilege for executing diagnostic {Y,N}
1 functions. N
Optional None
GRAPHICS Character Privilege for performing mimic {Y,N}
1 configuration. N
Optional None
9AKK101130D1382 331
Table 124. Security - Privilege Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
GROUPS Character Privilege for configuring historical and {Y,N}
1 realtime groups. N
Optional None
HISTORY Character Privilege for performing general historic {Y,N}
1 functions (such as initializing the N
historical counters).
Optional None
INFINET Character Privilege for executing functions related {Y,N}
1 to the C-NET modules. N
Optional None
LOGS Character Privilege for modifying the configuration {Y,N}
1 of the reports, for triggering and deleting N
archived reports.
Optional None
LTERMHIST Character Privilege for executing long term historical {Y,N}
1 functions. N
Optional None
NAVIGATE Character Privilege for navigating through WEB {Y,N}
1 pages. N
Optional None
ODBC Character Privilege for configuring the ODBC {Y,N}
1 functions. N
Optional None
REMWRITEF Character Privilege for writing a file in remote {Y,N}
1 access (such as using DDE functions). N
Optional None
332 9AKK101130D1382
Table 124. Security - Privilege Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
SECURITY Character Privilege for accessing and modifying {Y,N}
1 security and users. N
Optional None
TIMEDATE Character Privilege for setting the time and date. {Y,N}
1 N
Optional None
TRENDS Character Privilege for accessing trend functions. {Y,N}
1 N
Optional None
UTILITY Character Privilege for executing general utility {Y,N}
1 functions. N
Optional None
VIEWCONFIG Character Privilege for displaying the configuration {Y,N}
1 databases. N
Optional None
VIEWDISP Character Privilege for viewing displays. {Y,N}
1 If set, display viewing is submitted to N
Optional security group check also. None
VIEWHIST Character Privilege for viewing historical data. {Y,N}
1 N
Optional None
WINDOWSNT Character Privilege for accessing Windows {Y,N}
1 functions (such as window sizing, N
Windows desktop usage).
Optional None
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.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
SECGROUP1 Character Privilege to access tags and displays {Y,N}
1 belonging to the security group 1. N
Optional None
..................... ............. ..................................... ........................
SECGROUP32 Character Privilege to access tags and displays {Y,N}
1 belonging to the security group 32. N
Optional None
SEC_LEVEL Integer Security level. {0, 1...16}
2 This field is used for security checking 1
Optional whenever a user attempts to operate on None
PGP.
Only if the value is greater or equal the
security level of the requested function
the user gains access.
334 9AKK101130D1382
Client Parameters
The fields in Table 126 define the remote access parameters. They define
which clients are entitled to log in as privileged user. Each parameter is a bit
mask and each bit refers to a client. The clients must be defined in a client
list on the server.
Table 126. Security - Remote Access Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
CRTMASK1 Character Crt enable mask. Sequence {Y, N}
16 The bit mask allows enabling access or 16*Y
Optional preventing access to clients. None
The mask applies to clients from 1 to 16.
CRTMASK2 Character Crt enable mask. Sequence {Y, N}
16 Same as CRTMASK1 above. 16*Y
Optional The mask applies to clients from 17 to 32. None
PLANTUMSK1 Character Plant unit enable mask 1. Sequence {Y, N}
16 The current user can only access to the 16*N
Optional plant units enabled. None
..................... ............. ..................................... ........................
PLANTUMSK9 Character Plant unit enable mask 9. Sequence {Y, N}
16 Same as above. 16*N
Optional None
PLANTUMS10 Character Plant unit enable mask 10. Sequence {Y, N}
16 The current user can only access to the 16*N
Optional plant units enabled. None
9AKK101130D1382 335
Table 126. Security - Remote Access Parameters.
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
..................... ............. ..................................... ........................
PLANTUMS16 Character Plant unit enable mask 16. Sequence {Y, N}
16 Same as above. 16*N
Optional None
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 default user logon, which is performed whenever the Power Generation
Portal HMI interface (TntExplorer) is activated, also takes into consideration
the previously described feature. This gives the possibility to apply the
Power Generation Portal security that is related, via the group templates, to
the user logged in into the Operating System, eliminating or reducing the
need to login again into Power Generation Portal.
9AKK101130D1382 337
How to define Windows Users
The link between Power Generation Portal users and Windows users is
provided by means of group template records defined into the Power
Generation Portal User Database.
These records are exactly the same as the other user records, apart the
field ACTIVEUSER set to N. The default setting for this new field is Y,
defining a standard Power Generation Portal user.
The fields PASSWORD, PWDAGING and MAXLOGFAIL are ignored for
group template records.
338 9AKK101130D1382
Select each group (by double clicking on it) and add users to it. If you add
the user which is currently logged on you will have to logoff and logon again
before the modification takes effect.
The previously described procedures may also be applied on a domain
server, centralizing the user management
Some Hints
In case Power Generation Portal is started by an Interactive User (i.e. not
started as a Window Service), then the currently logged user has to have
Windows Administrator privileges,
and a Local Policy right named act as part of the Operating System. This
right is granted automatically when the Client/Server function from the
Power Generation Portal Setup is performed.
The Windows Group Database is checked by looking in the local groups (the
groups defined in the machine where the user logon) and then looking in the
domain server.
In case of multiple definitions the one in the local machine will be
considered.
The Windows user must belong only to one Power Generation Portal group.
In case of multiple assignments then the first in the alphabetical order will be
considered.
9AKK101130D1382 339
Security Defaults
PGP provides a default security configuration to grant its basic operation.
This section lists those default settings in Table 127 The table lists security
level, security groups, tag operation rights and privileges of each user.
The end user may want to change user names and/or passwords according
to his organization and his needs. Follow the general directions on
configuration and the previous security database description to change user
names or passwords.
Table 127. Security - Default Settings.
Sec. Sec.
User Name Password Tag Operation Rights Privileges
Level Groups
OPERATOR LEVEL0 1 All TagMonitor, ViewDisp
TagControl, TagAck
ENGINEER LEVEL1 1 All TagMonitor, Alarms, Graphics,
TagConfig, TagDelete, Logs, History, Security,
TagEntData, TimeDate, Trends,
TagOffScan, Infinet, Groups, Utility,
TagOffAlm, TagLimit. ViewConfig, ViewDisp,
LTermHist, ClServer,
Calcul, ViewHist,
Windows.
SYSMGR PRIV 16 All All rights. All privileges.
340 9AKK101130D1382
Foreign Database Support Subsystem
Foreign Database
Outline
PGP supports interaction with a wide range of commercial database
managers, by exporting its internal data structures via ODBC standard. In
this environment, PGP acts as a data provider for the foreign database, in
the following description indicated as target database. Once the target
database has been created and initialized, PGP connects and updates it
whenever a change occurs in its internal structures, either in case of
configuration changes or historical archiving. All the data exported to the
target database is then fully accessible by any tool supported by the target
database itself, although for some data structure the recommended access
is read-only.
PGP exports tag, trend group and alarm data structures, in form of:
Static data.
Dynamic data.
Static data contain configuration parameters, while dynamic data contain
historical process values.
For each kind of data structure, one or more tables are maintained on the
target database, according to whats described in the following sections. In
general, there is a table for tag static data, a table for trend group static data,
a table for tag dynamic data, a table for alarm dynamic data and n tables for
trend group dynamic data, where n is the maximum number of trend groups
in the system.
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 Tables
As mentioned, static tables contain configuration parameters for tags and
trend groups. The maximum number of tags and trend groups limits the size
of static tables in the system. Static tables reflect the current configuration of
the system, and they must be kept aligned by the system itself. Once PGP
exports the data to the target database, it has no kind of control over them.
That is, if the contents of static tables are changed, the only way to recover
the original situation is to realign the target database by the Data Export
Manager.
The structure of static tables may be changed to fit particular system
requirements. These changes must be set up on PGP by compiling a 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.
When exporting static data to a foreign database be sure the exported
strings (if any) do not contain any apostrophe () since it is a string
delimiter. For example, if the tag description is exported, it must not
contain any apostrophe. Check PGP database files to prevent such a
case.
The data type of the fields is function of the target DBMS. Table 128 and
Table 129 show a sample structure for tag and trend group static tables, in
case target DBMS is Oracle8.
Refer to tag and group configuration for details on fields.
Table 128. Foreign Database Support - Tag Static Table (TAGS).
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
TAGINDEX Decimal Tag index.
6
Optional None
TAGNAME Character2 Tag name.
20
Optional None
TAGDESC Character2 Tag description.
64
Optional None
9AKK101130D1382 343
Table 128. Foreign Database Support - Tag Static Table (TAGS).
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
TAGTYPE Character2 Tag type.
8
Optional None
EUDESC Character2 Engineering unit description.
16
Optional None
VAL0 Dbl. Prec. Value of 0% scale.
Optional None
SPAN Dbl. Prec. Instrument range.
Optional None
ZEROSTATE Character2 Descriptor for state 0.
16
Optional None
ONESTATE Character2 Descriptor for state 1.
16
Optional None
TWOSTATE Character2 Descriptor for state 2.
16
Optional None
344 9AKK101130D1382
Table 128. Foreign Database Support - Tag Static Table (TAGS).
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
THREESTATE Character2 Descriptor for state 3.
16
Optional None
FOURSTATE Character2 Descriptor for state 4.
16
Optional None
Table 129. Foreign Database Support - Trend Groups Static Table (GROUPS).
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
GROUPINDEX Decimal Group index.
6
Optional None
GROUPNAME Character2 Group name.
20
Optional None
GROUPDESC Character2 Group description.
64
Optional None
ARCHTYPE Character2 Archive type.
7
Optional None
9AKK101130D1382 345
Table 129. Foreign Database Support - Trend Groups Static Table (GROUPS).
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
EUDESC Character2 Engineering unit description.
16
Optional None
ARCHFRQ Decimal Archive frequency.
6
Optional None
ARCHUNITS Decimal Archive time units.
6
Optional None
OFFSET Decimal Archive time offset.
6
Optional None
OFFSUNITS Decimal Archive time offset units.
6
Optional None
SAMPLFRQ Decimal Sample frequency.
6
Optional None
SAMPLUNITS Decimal Sample time units.
6
Optional None
TOTSAMPLES Decimal Total number of samples.
6
Optional None
346 9AKK101130D1382
Table 129. Foreign Database Support - Trend Groups Static Table (GROUPS).
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
TAG1 Character2 Name of the 1st tag in the group.
20
Optional None
.................. ............... ................................................. .........
TAG60 Character2 Name of the 60th tag in the group.
20
Optional None
Dynamic tables
As mentioned, dynamic tables contain historical process values for tags,
alarms and trend groups. Since new values are always inserted into target
database in form of new records, the size of dynamic tables can indefinitely
grow up. That requires some kind of maintenance activity on target
database. On the other hand, since dynamic tables contain volatile
information, there is no need to keep any kind of alignment with PGP
database. That is, target databases administrator can manipulate dynamic
table contents as desired, for instance deleting or dumping to tape old
records.
Like static tables, the structure of dynamic tables may be changed to fit
specific application requirements. These changes must be set up on PGP
by compiling a deck-file for database cross reference builder DBXRF (see
Configuration Guide) before the tables are created on target database.
Once a table is created and initialized, its structure must never change,
unless another initialization is made.
At start-up time, PGP creates and initializes tag and alarm dynamic tables,
unless they already exist. Trend group dynamic tables are created at group
creation or when a change takes place.
9AKK101130D1382 347
The tag dynamic table is updated whenever PGP processes an exception
report for tags marked for foreign database export. Since a high exception
report rate for tags may cause both overhead and target database oversize,
it is strongly recommended that only a few slow-changing tags (i.e. minute
calculations or digital tags) are marked for export.
The alarm dynamic table is updated whenever the PGP processes an alarm
message marked for foreign database export (or concerning a tag marked
for foreign database export). Since a high alarm rate may cause both
overhead and target database oversize, it is strongly recommended that
only a few slow-changing tags (i.e. minute calculations or digital tags) are
marked for export.
A trend group dynamic table is updated whenever the PGP archives a trend
group defined as historical (archive type INST, AVERAGE, TOTAL, MIN,
MAX, COUNT, MONITOR, RATIO, TRIP) marked for foreign database
export. Since a high archiving rate for trend groups may cause both
overhead and target database oversize, it is strongly recommended that
only a few slow-archiving groups are marked for export.
The data type of the fields is function of the target DBMS. Table 130,
Table 131 and Table 132 give a sample structure for dynamic tables,
assuming the target DBMS is Oracle8.
Table 130. Foreign Database Support - Tag Dynamic Table (RTDB).
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
TAGTIME Date Tag time and date.
Optional None
TAGMILSEC Decimal Tag milliseconds.
3
Optional None
348 9AKK101130D1382
Table 130. Foreign Database Support - Tag Dynamic Table (RTDB).
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
TAGINDEX Decimal Tag index.
6
Optional None
TAGUID Character2 Tag unique identification.
36
Optional None
TAGVALUE Dbl. Prec. Tag value.
Optional None
TAGSTATE Character2 Tag state.
16
Optional [sztags]
TAGQUALITY Character2 Tag quality.
4
Optional None
9AKK101130D1382 349
Table 131. Foreign Database Support - Alarm Dynamic Table (ALARMS).
Format Range
Name Width Description Default
Opt/Mnd Parameter(s)
ALARMTIME Date Alarm message time and date.
Optional None
ALARMILSEC Decimal Alarm message milliseconds.
3,0
Optional None
TAGINDEX Decimal Tag index.
6
Optional None
TAGUID Character2 Tag unique identification.
36
Optional None
ALARMTYPE Character2 Alarm type.
6
Optional None
ALARMTEXT Character2 Alarm text.
132
Optional [s.aldb]
350 9AKK101130D1382
Table 132. Foreign Database Support - Group Dynamic Table (<group name>).
Optional None
TAGMILSEC Decimal Tag milliseconds.
3
Optional None
TAGINDEX Decimal Tag index.
6
None
TAGVALUE Dbl.Prec. Tag value.
None
TAGSTATE Character2 Tag state.
16
[sztags]
TAGQUALITY Character2 Tag quality.
2
None
TRIPTIME Date Trip time and date.
Optional None
9AKK101130D1382 351
Table 132. Foreign Database Support - Group Dynamic Table (<group name>).
This key displays the Windows standard ODBC setup wizard, listing all the
data sources already configured on the machine.
352 9AKK101130D1382
The first time the program is activated, it creates a new data source
specifically dedicated to PGP. To do it, press the New button, choose one
of the ODBC drivers available and provide all required information. Such
information depends on the selected driver, and may range from simple file
specification (i.e. desktop databases like MS Access) to network path and
security (i.e. distributed databases like Oracle or MS SQL Server).
Since it is not possible to give a standard procedure for all DBMS, please
refer to manufacturers documentation. After the data source has been
properly setup, the program will ask the operator to make the selection
permanent and to link all PGP internal fields to the newly selected DBMS
native data types. Next, after the automatically spawned build of DBXRF is
completed, all the tables actually configured on the target database are
listed.
If the PGP data source has been already set up, just select it to get the table
list described above. The table list may also be recalled at any time by the
List function, associated with the icon key:
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:
Setup Guidelines
The support to foreign database export may be added at any time to an
existing (and licensed) PGP version 1.2 or higher (even if it has been
generated without this feature), using the Data Export Manager. In any
case, it is suggested to setup this function just BEFORE the very first build
all (last step of post-installation procedure), by following the procedure
itemized below:
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 whats described in previous section. Exit the Data
Export Manager.
Add the proper fields to tag database (EXP_VAL and EXP_ALA) and
trend group database (EXP_VAL), and decide which tags and/or
groups must be exported.
After these steps, continue the post-installation procedure by generating
PGP database (Build All procedure).
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
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.
Format Range
Parameter Description
Opt/Mnd Default
action Character Action Code. {init, add, replace,
Mandatory Allowed action codes are: delete}
init - Initialize disk resident file directory, None
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.
name Character File name. <string>
Mandatory This field is defined the name of the file as <blank>
a 6 character string.
description Character File description. <string>
Optional Free format description of the data file, as a <blank>
32 character string.
type Character File type. {D,C,P}
Mandatory Allowed file types are: None
D - Disk file,
C - Core file,
P - Parallel file.
354 9AKK101130D1382
Table 133. Builder BFIL XML Format File System General Definition.
Format Range
Parameter Description
Opt/Mnd Default
key Character File key. {1...999}
Mandatory The file key is an integer numeric name of None
three digits, which refer to the file.
It must correspond with the number
assegned internally to the software for
accessing the files.
path Character Specifies the path of the file. None
Optional If a valid file path is not specified, the file is None
assumed to be: key.DAT (located in the
\Data folder) where key is specified in the
file key field on card
records Character Number of records in the file. {1...65535}
Mandatory The number of records is an integer None
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.
remote_write Character Remote file writing enabled. {Y,N}
Optional If set, a remote client can update the file via N
DDE service.
size Character Record size in words. {0, 1...65535}
Optional The size of records is an integer numeric 0
value.
If it is 0 the system supplies the size of the
internal structure which defines the record
of file.
save_snapshot Character Snapshot file. {Y,N}
Optional If set, the file will be created on multiple N
snapshot folders for simulation purposes.
save_initial Character Save Initial condition file. {Y,N}
Optional If set, the file will be saved as intial N
condition for simulation purposes.
9AKK101130D1382 355
Table 133. Builder BFIL XML Format File System General Definition.
Format Range
Parameter Description
Opt/Mnd Default
skip_initialization Character Skip Initialization. {Y,N}
Optional If set, the file will not be initilized when N
created.
Process Scheduling
Process scheduling allows management of timers in order to activate
system and possibly application programs.
These functions take typically place when timers expire.
The file BTIMDECK.XML, located in the \Deck folder, defines the PGP
timers for process scheduling and the file BFIL2DECK, located in the
\Config\Deck folder, may define the application specific timers. Both files
define the whole system timers. The format of the two files is the same.
The base PGP does not provide an empty BTIM2DECK file. It may be
derived from BTIMDECK when application specific timers must be added.
The processor BTIM performs the definition of timers. The XML format,
support the standard XMl syntax, and is defined in the following example:
356 9AKK101130D1382
Table 134. Builder BTIM - Timer Definition.
Format Range
Parameter Description
Opt/Mnd Default
action Character Action code. {init,add,replace}
Mandatory Allowed action codes are: None
init - Initialize timer definition file,
add - Add timer definition,
replace - Replace timer definition,
A maximum of [N.SCTM] timers can be added.
name Character Timer name., according to the internal software None
Mandatory definition None
frequency Integer Timer Period.
Optional A value of 0 means self scheduled process. 0
freq_unit Character Units for timer period. None}
Optional Allowed values are: sec, min, hour, day, None
month, year
offset Integer Timer offset.
Optional It specifies a time value added to the base time 0
before timer is executed. Base time depends on
timer period units. If timer period unit is
seconds: base time begins at last minute. If
timer period unit is minutes: base time begins at
last hour. If timer period unit is hours: base time
begins at last midnight. If timer period unit is
days: base time begins at last Mondays
midnight. Delay must be less than timer period.
offs_unit Character Units for timer offset.
1Optional Allowed values are: sec, min, hour, day, None
month, year.Timer offset must be less than
timer period.
delay Integer Initial delay.
Optional It specifies a delay to apply before to start the 0
timer.
9AKK101130D1382 357
Table 134. Builder BTIM - Timer Definition.
Format Range
Parameter Description
Opt/Mnd Default
delay_unit Character Units for initial delay.
Optional Allowed values are: sec, min, hour, day, None
month, year
active Character Active flag. {Y,N}
Mandatory Specifies if the timer is active or not. N
358 9AKK101130D1382
<DST_PERIOD start=xxx" end=xxx" />
...
...
</DST_PERIODS>
9AKK101130D1382 359
Operator Station Subsystem
Language
The Language definition file provides the system a dictionary to translate
texts used in the man machine interface. The default language is English.
Foreign languages are supported providing the dictionary.
The file BLANGDECK.XML, located in the \Deck folder, defines the PGP
default dictionary and the file BLANG2DECK.XML, located in the
\Config\Deck folder, may define an application specific dictionary. Both files
define the dictionary of the whole system. The format of the two files is the
same.
The base PGP provides an empty BLANG2DECK file. It may be completed
when an application specific dictionary must be added.
The processor BLANG is used to define the translation dictionary,
processing a free format, slightly different from the others, DECK file.
A set of strings, enclosed between double quotes, forms the dictionary. The
first string of the set must be the English text of the string and must be
preceded by the keyword ENGLISH.
Additional strings, which are translated into national languages, must be
preceded by the keyword related to the national language. For example
Italian strings must be preceded by the keyword ITALIAN.
The dictionary can be multi-language. Multiple translation lines may follow
the ENGLISH line to allow changing languages on an application.
To support non-ASCII languages, the files is Unicode compliant. For such
reason it must be edited using any unicode compliant editor.
Special characters, such as &, have to be defined according to the XML
syntax rules (in the previuous example as &). Avoid to use Microsoft
WORD since it manipulates those special characters
The processor BLANG performs the configuration of multilanguage texts.
The XML format, support the standard XMl syntax, and is defined in the
following example:
360 9AKK101130D1382
<?xml version="1.0" encoding="UTF-16" standalone="no"?>
<POWER GENERATION PORTAL_TEXTS>
<TEXT english=xxx" italian=yyyy" french=zzzz />
...
...
</POWER GENERATION PORTAL_TEXTS>
where yyyy and zzzz represent respectively the italian and the french
translation of the english text xxxx.
Of course other languages can be added.
Database Subsystem
Field Assignment Cross-Reference
The Field Assignment Cross-Reference definition file (DBXRFDECK.XML
located in the \Deck folder) contains all field definitions and all site-specific
changes to be used when processing a database file. Database files are the
tag database file, the trend group database file, the calculation database file,
the tag related (engineering units, alarm comments, logical state descriptors
and text selectors) database files, the node network database file, the
pegboard database file, the alarm grouping database file.
The file DBXRFDECK, located in the \Deck folder, defines the PGP field
assignment definition and the file BFIL2DECK.XML, located in the
\Config\Deck folder, may define the application specific field assignments.
Both files define the field assignment definition of the whole system. The
format of the two files is the same.
The base PGP does not provide an empty DBXRF2DECK file. It may be
derived from DBXRFDECK when application specific field assignments
must be added.
9AKK101130D1382 361
The processor DBXRF performs the definition of field assignments. The
XML format, support the standard XMl syntax, and is defined in the following
example:
362 9AKK101130D1382
Table 136. Builder DBXRF - Database Field Assignment Definition.
Format Range
Column Description
Opt/Mnd Default
action Character Action code. {init,add,replac
Mandatory Allowed action codes are: e}
init - Initialize DBXRF definition file, None
add - Add DBXRF definition,
replace - Replace DBXRF definition,
A maximum of 1200 definitions can be added.
DB_XREF
name Character The name of the database fileld. It correspond to <string>
Mandatory the name of the column in the DBF or XLS file. None
Notice that DBF limit the column names to 10
characters.
descr Character The description of the database field. <string>
Optional This filed is limited to 28 characters. None
code Character Reference of database field. <string>
Mandatory It uniquely identifies the field to allow handling None
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.
default Character Default value. <string>
Optional The default value is assigned when field is not None
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
callback Character Field assignment call-back name (case <string>
Optional sensitive). None
If no name is supplied, direct field assignment is
selected.
9AKK101130D1382 363
Table 136. Builder DBXRF - Database Field Assignment Definition.
Format Range
Column Description
Opt/Mnd Default
unbuild_callback Character Export call-back name (case sensitive). <string>
Optional None
dbfunbuild Character DBF Export inhibit flag. {Y, N}
Optional If set, the field is considered optional and will not N
be created upon database export. Otherwise it is
mandatory and it will be created.
This selection only applies to export operations
specifying a new target database. If a reference
database is specified, its structure will be used.
That is, all and only the fields thereby defined will
be exported, ignoring the export inhibit flag
setting.
This flag is duplicated by the DBF under the
UNBUILD section
xlsunbuild Character XLS Export inhibit flag. {Y, N}
Optional If set, the field is considered optional and will not N
be created upon database export. Otherwise it is
mandatory and it will be created.
This selection only applies to export operations
specifying a new target database. If a reference
database is specified, its structure will be used.
That is, all and only the fields thereby defined will
be exported, ignoring the export inhibit flag
setting.
This flag is duplicated by the XLS under the
UNBUILD section
ITEMTYPE
364 9AKK101130D1382
Table 136. Builder DBXRF - Database Field Assignment Definition.
Format Range
Column Description
Opt/Mnd Default
type Character Item type to which field assignment is applied. <string>
Mandatory Item type is an string value according to the None
parameter file SYSPRM.
A list of legal item types is shown in the Appendix
A.
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.
Color/Blink Override
The color/blink override table configures the attributes for displaying analog
and digital tags.
PGP supports the colored display of tags. The operator can easily
understand the status of a displayed variable.
Tag values are displayed using different foreground and background colors
and blink, depending on the status of the tag and its priority. In addition, one
or two trailing characters may be appended to a value to qualify the status.
This prevents problems resulting from color-blindness, monochromatic
visual display units, hard-copy, etc.
The table allows the user to have flexibility in what combinations of blink
colors and appended characters are displayed, given various status
conditions.
9AKK101130D1382 367
The file BATTDECK.XML, located in the \Deck folder, defines the PGP
color/blink override table and the file BATT2DECK.XML, located in the
\Config\Deck folder, may define the application specific overrides.
Both files define the override table of the whole system. The format of the
two files is the same. The base PGP does not provide an empty
BATT2DECK file. It may be derived from BATTDECK when application
specific overrides must be added or changed.
The processor BATT performs the configuration of the override table. The
XML format, support the standard XML syntax, and is defined in the
following example:
368 9AKK101130D1382
Table 137. Builder BATT Color/Blink Override Basic Definition.
Format Range
Parameter Description
Opt/Mnd Default
action Character Action code. {init, add, replace}
Mandatory Allowed action codes are: None
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.
PRIORITY
number Integer Priority number. {1...16}
Mandatory None
type Character Item type for which the priority definition is {PV,DI}
Mandatory applied. None
Allowed values are PV and Di.
copy_from_priority Integer Priority number to copy the definition from. {1...16}
Optional (this just to avoid to duplicate many None
statements, which very likely are the same)
ITEM
bit Character Bit of interest in quality status word . {0...31}
Mandatory A status word defines the quality of digital
tags, two status words define the quality of None
analog tags.
See the Appendix for quality bit definitions.
type Character Override type. {BL, BC, FG}
Mandatory Allowed override type are: None
BL - Blink,
BC - Background color,
FC - Foreground color.
9AKK101130D1382 369
Table 137. Builder BATT Color/Blink Override Basic Definition.
Format Range
Parameter Description
Opt/Mnd Default
color Characte Color. <string>
Mandatory The names refers an entry in the None
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.
symbol Character Quality symbol. <string>
Optional The symbol is appended to tag values to None
represent tag quality. (up to 4 characters
are allowed)
invert Character Invert code. {Y, N}
Optional I - Invert tag status before testing for N
override.
descr Character Description. (up to 28 characters are <string>
Optional allowed for describit this quality) None
PROCESSING
ds_alarm Character Display alarm. {Y, N}
Optional N
pr_alarm Character Print alarm. {Y, N}
Optional N
sv_alarm Character Archive alarm. {Y, N}
Optional N
aud_alarm Character Audible on alarm. {Y, N}
Optional N
bot_alarm Character Alarm at bottom of screen window. {Y, N}
Optional N
ds_rtn Character Display return to normal. {Y, N}
Optional N
370 9AKK101130D1382
Table 137. Builder BATT Color/Blink Override Basic Definition.
Format Range
Parameter Description
Opt/Mnd Default
pr_rtn Character Print return to normal. {Y, N}
Optional N
sv_rtn Character Archive return to normal. {Y, N}
1 N
ds_stchng Character Display event. {Y, N}
Optional N
pr_stchng Character Print event. {Y, N}
Optional N
sv_stchng Character Archive event. {Y, N}
Optional N
pr_opact Character Print operator action. {Y, N}
Optional N
sv_opact Character Archive operator action. {Y, N}
Optional N
pr_info Character Print info messages. {Y, N}
Optional N
sv_info Character Archive info messages. {Y, N}
Optional N
rem_onack Character Remove alarm on acknowledge. {Y, N}
Optional N
info_onack Character Log on acknowledge. {Y, N}
Optional N
app_ala Character Application specific action. {Y, N}
Optional N
exp_ala Character Export to external DBMS. {Y, N}
Optional N
opc_ala Character Export to OPC Server. {Y, N}
Optional N
audidx Integer Audible Alarm index {0,16}
Optional 0
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:
</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.
Format Range
Parameter Description
Opt/Mnd Default
action Character Action code. {init,add,replace}
Mandatory Allowed action codes are: None
Init - Initialize alarm messages definition file,
Add - Add an alarm message,
Replace- Replace an alarm message,
code Char or Int Alarm message code/number. <string> or
Mandatory The field specifies the alarm message being {1...999}
defined.
The alarm message number is an integer [mxamsg]
value and may be specified either by number
or by a symbol (the parameter file BALMPRM
includes the symbols).
value Character The text string, which correspond to the alarm <string>
Mandatory message. The definition correspond to a None
standared C Language format, where the
parameters are replaced by the parameters
defined below.
PARAMETERS
p1 Character Symbolic definition of the type of the first <string>
Optional parameter. Refer to table 3-15 for the list. None
9AKK101130D1382 373
Table 138. Builder BALM - Alarm Message Definition.
Format Range
Parameter Description
Opt/Mnd Default
pr_alarm Character Print alarm. {Y, N}
Optional N
sv_alarm Character Archive alarm. {Y, N}
Optional N
aud_alarm Character Audible on alarm. {Y, N}
Optional N
bot_alarm Character Alarm at bottom of screen window. {Y, N}
Optional N
ds_rtn Character Display return to normal. {Y, N}
Optional N
pr_rtn Character Print return to normal. {Y, N}
Optional N
sv_rtn Character Archive return to normal. {Y, N}
1 N
ds_stchng Character Display event. {Y, N}
Optional N
pr_stchng Character Print event. {Y, N}
Optional N
sv_stchng Character Archive event. {Y, N}
Optional N
pr_opact Character Print operator action. {Y, N}
Optional N
sv_opact Character Archive operator action. {Y, N}
Optional N
pr_info Character Print info messages. {Y, N}
Optional N
sv_info Character Archive info messages. {Y, N}
Optional N
rem_onack Character Remove alarm on acknowledge. {Y, N}
Optional N
374 9AKK101130D1382
Table 138. Builder BALM - Alarm Message Definition.
Format Range
Parameter Description
Opt/Mnd Default
info_onack Character Log on acknowledge. {Y, N}
Optional N
app_ala Character Application specific action. {Y, N}
Optional N
exp_ala Character Export to external DBMS. {Y, N}
Optional N
opc_ala Character Export to OPC Server. {Y, N}
Optional N
audidx Integer Audible Alarm index {0,16}
Optional 0
opstation Integer Operator station. {0...32}
Optional The field specifies the operator station where [nmcrts]
to output the message.
priority Integer Alarm priority. {0...8}
Optional The field specifies the alarm priority assigned 0
to the message.
group Integer Alarm group. {0...SLADNM}
Optional The field specifies the alarm group assigned to 0
the message.
translate Character Translation flag. {Y, N}
Optional If set, the message is submitted to translation N
at generation time. Otherwise, translation
takes place at run time.
prtiidx Integer Alarm printer Index. Number
Optional 0
The message text may contain symbols and ASCII text in a specific order.
These symbols represent variable text to be formatted at run time. The data
for these fields is supplied from the alarm queue header or the alarm queue
data buffer or the item description record when the message is requested for
displaying.
9AKK101130D1382 375
In the text, a dynamic is represented by symbol %. The symbol is replaced
by the data defined in the corresponding dynamic Table 139 lists possible
symbols.
Table 139. Message Subsystem - Dynamic Text Definition Symbols.
Symbol Field Type Description
%s String The field will be filled by a sequence of characters.
Error messages
This section describes the configuration of the message texts that are
presented to the PGP user.
Error messages are generated by validation processes and presented within
appropriate windows.
Messages and helps are provided with the basic system. Texts may be
customized and/or translated into national languages, before running the
appropriate builder processors.
The file BEMFDECK.XML, located in the \Deck folder, defines the PGP error
messages.
The file BEMF2DECK.XML, located in the \Config\Deck folder, may define
the application specific messages.
Both files define the error messages of the whole system. The format of the
two files is the same.
The base PGP does not provide an empty BEMF2DECK file. It may be
derived from BEMFDECK when application specific error messages must be
added.
The processor BEMF performs the configuration of error messages. The
XML format, support the standard XMl syntax, and is defined in the following
example:
376 9AKK101130D1382
...
...
</ERR_MESSAGES>
The syntax of error messages is not quite the same as the syntax used for
alarm messages. A dynamic is represented by the symbol %. The following
table lists possible symbols used in text definitions.
Table 141. Message Subsystem - Text Definition Symbols.
Symbol 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.
The message text includes the dynamic %s. That is, a string will be
embedded within the text and its length is 20 characters as defined by a20
at the end of the message.
Each message text is closed by a double quote.
378 9AKK101130D1382
Section 4 Off-line Utilities
Introduction
PGP off-line utilities can be classified in three main categories: start-up,
configuration and maintenance utilities.
PGP start-up, PGP Explorer start-up, People Finder start-up belong to the
first category.
System setup, database builder, display builder, display translator, display
compiler and data export manager belong to the second category.
Historian backup, Long Term Archiving, One Shot Backup and 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
Overview
PGP can be activated on demand or automatically. The Start PGP function
allows for on-demand activation.
Activating PGP
Select following menu:
> Start (on the desktop)
> Programs
> ABB Industrial IT
> Power Generation Portal
9AKK101130D1382 379
> Start Power Generation Portal
The PGP application will start-up in a few moments.
PGP Description
Refer to the InformIT Power Generation Portal User Manual.
PGP Explorer
Overview
PGP Explorer is the main interface window to the operator, it can be opened
on demand. The PGP Explorer function allows on demand activation.
When PGP starts up, PGP Explorer automatically opens the interface
window. If the interface window closes or is closed for any reason PGP
Explorer function re-opens it without to completely shutdown and restart
PGP.
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.
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.
382 9AKK101130D1382
Begin translating symbols: standard symbols before and then application
symbols. Complete the operation translating displays.
Defining in the PGP data base at index 1 the tagname %TAG%,
automatically the transaltor will solve the tag index 1 with this tagname.
%TAG% is the sintax used by PGP to load the page sending it the
tagname to use.
9AKK101130D1382 383
Figure 14. Display Translator - Translation Window
A data entry field allows definition of path to file(s) and file name(s) to
process. An echo area shows messages related to the translation. Three
selection areas allow selecting the translation options.
The path to file(s) and file name(s) to process can be specified typing a full
path in the data entry field or selecting the full path through the Open
function in the File menu or the Open folder icon.
Examples of full path specification are the following. Note that the default
installation directory is referred as <INSTALLDIR>
<INSTALLDIR>\Config\Sodg\Std_sym\*.dt
<INSTALLDIR>\Config\Sodg\Std_sym\<std_symbol_name>.dt
<INSTALLDIR>\Config\Sodg\Sym\*.dt
384 9AKK101130D1382
<INSTALLDIR>\Config\Sodg\Sym\<appl_symbol_name>.dt
<INSTALLDIR>\Config\Sodg\Display\*.dt
<INSTALLDIR>\Config\Sodg\Display\<display_name>.dt
The wild-card allows specifying all elements in the path. The file
specifications <std_symbol_name>, <appl_symbol_name> and
<display_name> identify a generic name.
This is the syntax to be used to process a single element.
The figure below shows the path identification and selection window.
9AKK101130D1382 385
<INSTALLDIR>\Display\Work (displays in Editable Format - *.UCBG,
*.UCBP, *.UCBD, *.UCBV)
<INSTALLDIR>\Display\Bin (displays in Executable Format - *.G,
*.PAGE, *.DIAG, *.VAR)
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.
9AKK101130D1382 387
Picture - This field is inserted in the symbol name only for the "graphic"
symbols (Advanced dynamic analog/digital) and is the name of the first
graphic object included to define the dynamic.
_XX - This field is automatically included when the symbol name file is
already existing but defines a different dynamic (could change a color, a
name of one graphic symbol, etc.); in this case is necessary to assign
another name to the new symbol in order to distinguish symbols similar but
not equal. You can verify the differences opening with a text editor the .DT
files.
At the end of the processing of the custom SODG .DT files (first standard
symbols, then symbols and then displays) in the SODGLIBSYM you can
found the new .DT files; processing these files, will be created global
dynamic symbols (in the eix_work folder the editable files, in the eix_bin
folder the executable files).
These global symbols will be displayed by the DisplayBuilder in the list of the
global symbols and could be selected to insert them in the displays.
These global symbols are "simple" because they include only a single
dynamic object without actions: therefore details (like parts of valves to
define the type), sensible areas, etc. are missing.
These global symbols can be customized with more details using the
DisplayBuilder.
In these global symbols the tags are defined normally as %TAG%, but,
where is required a specific tag type, you can found also %TAG_DIGITAL%,
%TAG_ANALOG%, %TAG_MSDD%, etc.
NOTES: in the displays generated with the SODG translator there aren't link
with these global symbols: the graphic pages are created like old releases.
DT Symbols Files
The SODG.EXE program manages the symbols pages (in the previous
release was skipped) to generate from them the PGP global symbols; these
symbols could be many complexes according to the commands included in
the .DT file.
388 9AKK101130D1382
Display Compiler (EIXCMP)
Overview
The second step preparing displays for PGP environment is the compilation
of displays imported from the SODG utility or implemented using the 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).
9AKK101130D1382 389
Double clicking EIXCMP in the right view, the interface window of the
display compiler will be opened.
Compiling Displays
The figure below shows the schematic of the compiler window.
A data entry field allows definition of path to file(s) and file name(s) to
process. An echo area lists messages related to the compilation.
The path to file(s) and file name(s) to process can be specified typing a full
path in the data entry field or selecting the full path through the Open
function in the File menu or the Open folder icon.
Examples of full path specification are the following:
390 9AKK101130D1382
<INSTALLDIR>\Display\Upg\*.g
<INSTALLDIR>\Display\Upg\<display_name>.g
The wild-card allows specifying all elements in the path. The file
specification <display_name> identifies a generic name. This is the syntax
to be used to process a single element.
The figure below shows the Path identification and selection window.
9AKK101130D1382 391
Display Builder
Overview
A built-in display builder allows you to edit application displays on board the
PGP. Translated displays or new displays can be edited. Edit of drawing is
based on an on-board editor.
Refer to the InformIT Power Generation Portal Display Builder Manual for
more information.
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.
Historical Backup
Overview
PGP gives the capability of historical backup archiving for most important
medium term archives.
9AKK101130D1382 393
The words historical backup classes a set of archives kept for a non 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.
Archives
Some of the medium term archives are eligible for historical backup
archiving. They can be saved and, in a later time, retrieved for analysis.
The archives listed below are eligible for historical backup archiving:
> Alarm Archive
> Trend Group Archive
> Playback Archive
> Post Trip Archive
> Totalization Archive
394 9AKK101130D1382
Once retrieved, an archive may be analyzed using the same functions
provided for the medium term archive. Refer to the user manual for a
description of analysis of data of historical backup archives. Archived data
cannot be directly analyzed, retrieval is always required.
Alarm Archive
The alarm archive, called Operator Journal or OJ also, stores the most
recent alarm messages, information messages, diagnostic messages, etc.
generated as result of the alarm processing.
Historical backup archiving copies the current contents of the archive to the
intermediate storage area.
Retrieving dumps data from the intermediate storage to the PGP internal
area. That area is parallel to the current alarm archive area. Retrieved
historical alarm archive does not overwrite current alarm archive.
The viewer of historical alarm archive allows switching between current and
retrieved archive.
Playback Archive
Playback archive keeps the history on the medium term for all tags
configured in the PGP database. Only tags whose playback flag is set within
the PGP database are kept on playback.
9AKK101130D1382 395
On playback tag data are stored in form of exception reports. A playback
archive has a size defined at configuration time. Basically, two size
parameters define playback: the maximum number of hours and the
maximum number of days.
The maximum number of hours (default 24 hours) defines the size of the
current playback. The maximum number of days defines the time interval
playback data are kept on the hard disk.
Archiving saves data of the current playback.
Retrieving restores data from a previously saved playback.
Totalization Archive
The value of a tag can be involved in a totalization archive at configuration
time. Totalizers periodically process playback data of tags involved and
store the result of processing.
Both analog and digital tags can be configured for totalization. Refer to the
tag database configuration for details.
Archiving saves both analog and digital totalizations.
Retrieving restores data from a previously saved totalization archive and
overwrites the current one.
396 9AKK101130D1382
> Programs
> ABB Industrial IT
> Power Generation Portal
> System Setup
In this way, the interface window of the System setup management is
opened. Open on the left the tree of the item Utility to show the list of
configured utilities: click on
Historian Backup Manager
Double clicking HISBACKUP in the right view, the interface window of the
historian backup manager will be opened.
Archiving Interface
After the historical backup archiving has been activated the main interface
window opens. The figure below shows the main interface window of the
historian backup manager. The archive save-set list is empty: any archive
has been saved before for historical backup keeping.
9AKK101130D1382 397
Figure 18. Historian Backup Manager
Five icons call the save functions (one for each kind of archive). Five icons
call the restore functions. Five icons call the delete functions. Three menus
also allow calling the functions above mentioned.
The save functions begin a dialog with the user in order to perform storaging
on the intermediate storage area. The restore functions begin a dialog with
the user to perform restoring archived data from the intermediate storage
area.
The delete functions allow deleting restored archives. After deletion restored
archives will be no longer available to the PGP for on-line viewing. Backup
files in the intermediate storage area are not involved in the delete
operation. Unless they are intentionally deleted, a restore operation may be
done again.
398 9AKK101130D1382
In the following description the generic save, restore and delete procedures
are outlined. Specific save procedures may differ a little depending on the
kind of archive involved. The examples refer to trend groups.
Saving Procedure
Click the save icon or the save item of the Save menu to initiate a save
procedure.
Since multiple archives may exist in a PGP application and may be involved
in a save operation, a dialog window opens to allow selection. Figure 20
shows such a window for trend groups. The selection dialog window does
not exist for alarm and totalization archives.
Select the archive to be saved and press the Next button.
The label and description identify the save-set where data will be saved.
The figure below shows the dialog window to enter name and description of
save-set.
9AKK101130D1382 399
Figure 20. Trend Group Archive - Save-set Dialog Window
Press Finish button to proceed. The dialog window to select the destination
of saved data is displayed. It displays the default destination folder
(hisbackup of PGP folder).
The file name is defaulted to the save-set label as shown below.
400 9AKK101130D1382
Figure 21. Trend Group Archive - Destination Dialog Window
Restoring Procedure
Click the Restore icon or select the Restore item of the Restore menu to
initiate a restore procedure.
The Restore dialog window opens. It lists all historical backup files located in
the default intermediate backup (hisbackup) folder. Navigate through folders
to locate the location folder if it differs from the default folder.
Select the archive to be restored. The figure below shows a dialog window
where a file has been selected for restoring.
9AKK101130D1382 401
Figure 22. Trend Group Archive - Restore Dialog Window
Deleting Procedure
Click the delete icon or select the delete item of the Delete menu to initiate a
delete operation.
402 9AKK101130D1382
Figure 24. Delete Dialog Window.
Select the archive to be deleted. Figure 24 shows the dialog window where
a file has been selected for deletion.
Press OK button to delete. Press YES button to confirm the operation.
The delete function deletes a retrieved archive only. It does not delete
backup files.
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.
404 9AKK101130D1382
One Shot Backup Description
Once the one shot backup has been activated, it schedules itself for
execution and runs based on registry definition. The user may interface the
utility, changing the registry setting.
The one shot backup can be activated providing one of three qualifying
options.
9AKK101130D1382 405
Save/Restore Configuration
Overview
A specific application PGP configuration is generically based on registry
values, configuration and displays files.
Registry values are located under the PGP folder of registry keys.
Configuration files are located under the <INSTALLDIR>\Config folder.
Displays files are located under the <INSTALLDIR>\display folder.
The Save/Restore Configuration utility allows you to save and to restore
registry and files of configuration and displays.
Save Config/Display/Data
When the Save item is selected, the right side of the dialog window
changes.
Check boxes, which select the elements of the configuration in order to save
them, are shown on the right side. Registry values are always saved as a
whole. The file configuration or displays can be either fully or partially saved.
406 9AKK101130D1382
The interface window of the utility is shown in below: the procedure shows
the interface to save the configuration files; the same procedure can be
followed to save the displays files.
All folders within the Config (or Display or, enabled only if the system is not
active, Data) directory are eligible for saving and are listed in the dialog
window.
The figure below shows a partial save selection.
9AKK101130D1382 407
Figure 26. Save Config Selection Window
Partial save selection can be used when some folders are left empty in the
specific application. In any case the full save selection (all boxes checked)
can be performed for all applications.
All sub-folders of the Config folder are listed in the selection area. Deck files
and License files under the Config folder also can be selected for backup.
408 9AKK101130D1382
At the bottom of the interface window a data entry field allows you to type
the destination folder. The path and file name can be typed within or a
browser can be opened clicking on the square button on the right side.
Since the save settings utility uses a DOS program, the file names must be
limited to 8 characters.
The figure below shows the browser window.
In the example the Temp folder of the installation disk has been selected.
The destination can also be the floppy disk driver. It is strongly discouraged
to save configuration under the PGP folder: if PGP is de-installed for any
reason, the configuration backup is lost.
The extension in the file name field is not required. It will be set to SVS.
Press the Save button to set path and file name in the destination field.
After all selections have been made press the Backup button to start saving.
The operation takes a while to complete. A small console window opens at
the top left of the window. Wait for the completion: the console window
closes.
The backup function creates a SVS file tracing the saved configuration, a
TXT file containing a list of all saved files, a set of nnn files (001, 002, ...)
9AKK101130D1382 409
containing the saved configuration. All files are named as defined in the file
name field.
Is possible also to send the backup files to the Long Term Archive function;
a specific question will be showed at the end of the save function: choosing
YES, the backup files will be saved in a compressed file (using the
command defined in the registry APPS\OneShotBckp\ZipCmdLine) that will
be archived in the Long Term Archive as Miscellaneous file.
Restore
A saved configuration can be restored in the same application or on another
application (another machine).
When the Restore icon is selected the right side of the dialog window
changes again. The figure below shows the selection to restore the
previously saved configuration.
410 9AKK101130D1382
Figure 28. Restore Window
The source path may only be selected by calling the browser (press the
square button on the right side of the path field.
Upon selection the backup information area is filled in. The figure below
shows the source browser.
9AKK101130D1382 411
Figure 29. Restore Config Browser Window
Press the Open button to return back to the restore window. The full path
browsed is copied to the path field.
Press the Restore button to start the operation.
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.
Archives
The archives listed below are eligible for LTA: they can be saved and, in a
later time, retrieved for analysis; the boldface text describes the suffix to
identify the file type:
> ALM - Alarm Archive (One Shot Backup)
> GRP - Trend Group Archive (One Shot Backup)
> PLB - Playback Archive (One Shot Backup)
> PTL - Post Trip Archive (One Shot Backup)
> REP - Report Archive (RPTPRN)
> MSC - Total Counter Archive (TENESM)
> MSC - Maintenance Archive (HRTLSM)
> MSC - Sequence of Events Archive (ALACSOE - RISPRN)
> MSC - SysSetup saved files (SYSSETUP)
Registry
In the PGP server(s) must be written in the registry
APPS\OneShotBck\LTAServer the name of the PGP where is activated
the LTA function (LTA server): can be itself or another server; defining this
registry with a valid server name, will be enabled the function to send the
medium term historical files to the LTA.
On the LTA server must be changed in Sizes following registry:
9AKK101130D1382 413
> N.DAYS - defines the number of days of the Circular Buffer (default 0;
insert a positive value to enable LTA function)
> N.LTAS - defines the number of record for file F_LTAS (default 0; set
to 1 to enable the LTA function because onle one record is necessary
for this file)
> N.SRVR - defines the number of servers configured to collect
historical files (default 0; set equal at the value assigned to the registry
Sizes\MXNODE to enable the LTA function)
In the LTA server must be defined the registry Directories\LTAHisBackup
defining the path where the medium term archives will be sent.
On the LTA server must be defined for Directories\LTA following registry:
> CircleBufferPath - defines the main path where will be saved the files
of the Circular Buffer.
> EmergencyPath - defines the path where will be saved the daily files
when some error will be found on search room in the Circular Buffer.
> InBufferPath - defines the path where are copied momentarily the
daily files received from PGP servers.
> ReportPath - defines the folder where will be saved the report
produced after the save of the daily files.
On the LTA server must be defined for APPS\LTA following registry:
> InitialWait - defines the number of milliseconds to delay the start of
the LTA manager (default 30000).
> PollingDeadLine - defines the end polling time (string - hour.minutes)
(default 08.15)
> PollingStartTime - defines the start polling time (string -
hour.minutes) (default 08.10)
> PollingTime - defines in milliseconds the timer used in the polling
phase to check the received daily files (default 30000).
> StatusTagName - defines the name of the tag defined on the linked
servers to notify the status of the LTA function; the tag must be
configured as:
414 9AKK101130D1382
- TAGNAME - Type EXTDIG - values:
0 = STOPPED
1 = GOOD
2 = PROBLEMS
- ATOM1 - Type DIGITAL - current LTA status
-1 = STOPPED - LTAExplorer program is not active
0 = Wait Polling Start Time (WAIT_START_TIME)
1 = Polling in progress (POLLING)
2 = Polling terminated ("POLLING_DEAD)
3 = Copy files from Server to local disk in progress
("SERVER_TO_IN)
4 = Update Circular Buffer in progress ("UPDATING_CB)
5 = Update LTA Drive in progress ("WRITING_DRIVE)
6 = Daily Polling executed - Wait tomorrow ("WAIT_TOMORROW)
- ATOM3 - Type STRING - description of the local CB disk
- ATOM4- Type ANALOG - value (%) of the free space of the local CB
disk
- ATOM5 - Type DIGITAL - status of the local CB disk
0 = ENABLED
1 = DISABLED
2 = UNFORMATTED
3 = READONLY
4 = FULL
5 = FUNCTION DISABLED
- ATOM6/7/8 - like 3/4/5 but for the LTA drive (if configured)
- ATOM9/10/11 - like 3/4/5 but for the Removable drive (if configured)
9AKK101130D1382 415
> Trace - enables the complete trace in the LTA log file of all messages
produced by LTA manager (default NO).
Additional APPS\LTA registry used to define the parameters to archive files
(LTADrive functionality) on specific path (LTADrivePath) organized by
servername/date/type without time limits (suspended only when the drive is
FULL):
> LTADriveIsToActivate - flag to enable LTADrive function
Additional Directories\LTA registry for LTADrive functionality:
> LTADrivePath - defines the path where will be saved the files by
servername/date/type.
Installing on the LTA server a program like NERO InCD (only for
rewritable disks) or Sonic DLA to format discs (CD/DVD) in such a way
that they can be used like hard disks, you can define in the LTADrivePath
registry directly the path of the CD/DVD to archive on it the files. Using
one of these tools you can archive your files to a removable drive without
use the LTADriveCmd program: in this case is necessary to
remove/rename the PGP registry trees named RemovableDrive
(APPS\LTA and Directories\LTA) following described.
Additional APPS\LTA\RemovableDrive registry used to activate specific
program to transfer files from LTADrivePath to a removable drive:
> CmdGetInfo- command string to send to the specified program to
have the info about the used removable drive; the activated program will
write following registry:
> SizeFree - free size of the removable drive
> SizeTotal - total size of the removable drive
> SizeUmCode - Number to indicate the E.U. used for the Size*
(0=GB, 1=MB, 2=Blocks)
> CmdPgmCode - resulting command code - defines the status of the
last requested command (-1=InProgress, 0=Good, Other=Error).
> CmdPgmName - Name of the program to active to write the archived
files on the removable drive.
416 9AKK101130D1382
> CmdWrite- command string to send to the specified program to write
archived files to the removable drive.
> CmdWriteEmpty- command string to send to the specified program
to write archived files to the removable drive when the drive is empty.
> StartDate - Registry used by the program to save the date of the
oldest file archived on the removable drive.
> EndDate - Registry used by the program to save the date of the most
recent file archived on the removable drive.
Additional Directories\LTA\RemovableDrive registry used to transfer files
from LTADrivePath to a removable drive:
> RemDrivePath - Removable drive path
The PGP is pre configured to activate the program named LTADriveCmd
following described.
Functionality
The managers of medium term archives send to the LTA server, in the folder
defined by the LTAHisBackup registry, a copy of the produced files, naming
servername+filename
servername can be the name of sending server, if is not defined the
PlantUnit, or PLANT_UNIT_n where n is the number of defined PlantUnit.
Following the main phases of LTAExplorer:
> Internal timer - with a specific delta time (5 seconds) are executed
following actions:
- all configured server are checked to get the status;
- to all connected server is updated the tag (named as defined in the
StatusTagName registry) with the current status of the LTA function
- all files written by the PGP servers to the folder defined by
LTAHisBackup are copied to the folder defined by InBufferPath,
removing from the file name the servername+; the files are ordered by
server name/archive type.
9AKK101130D1382 417
> Polling - When a start polling time is found, is activated a timer scheduled
as defined in the PollingTime registry; each time, are checked all received
files to send a message to the server when not all historical configured types
are found.
> Updating Circular Buffer- When the end polling time is found, all files in
the InBufferPath are copied to the circular buffer ordered by server
name/archive type.
> Writing to LTA drive - this phase is activated only if is enabled the
LTADrive function; the files archived in the CB are copied to the
LTADrivePath; the files will be saved on LTA drive by server
name/date/archive type. If is defined also the RemovableDrive program
management, in this phase will be executed also the transfer from the
LTADrivePath to the removable drive; all transferred files will be removed
from the LTADrivePath.
The phases in boldface can be also forced manually by operator using
specific dialog.
LTA Interface
After the LTA Explorer has been activated, the main interface window is
opened. The figure below shows the main interface window of the LTA
Explorer.
The window includes different areas to show LTA informations.
418 9AKK101130D1382
Figure 30. Long Term Archive Explorer
FileView
This area shows the folders of different intermediate storage used by LTA.
9AKK101130D1382 419
Figure 31. File View
> Circular Buffer - shows the folder/files of the folder defined by the
CircleBufferPath registry and are, ordered by server/archive type, the files of
the last configured days (defined by the registry
APPS\LTA\CircleBufferDays). The Circular Buffer will be called CB in the
following description.
> Today Input - shows the folder/files of the folder defined by the
InBufferPath registry; here are momentarily copied the files received from
the linked servers.
420 9AKK101130D1382
> Emergency - this folder is used by the LTA Explorer only to save the files
received by the servers when no place is found in the CB (for example when
is found a file too much old to be inserted in the CB).
> LTA Drive or Recording drive - LTA Drive is displayed only when the
LTADrive function is active; if an external drive manager is defined (used
LTADriveCmd), will be showed Recording Drive. Shows the folder/files of
Long Term Archive files ordered by server/date/type.
Configured Servers
This area shows the configured servers.
The configured servers are readed from the system files configured with the
SysSetup->Build Data Base -> Node Data Base Builder.
For each server are showed following informations:
> Server Name - shows the name of the configured server.
> Plant Unit - shows the Plant Unit number: if is 0, the folders for this server
will be named like the server; if is not 0, the folders will be named
PLANT_UNIT_n where n will be the Plant Unit number.
> Last Update - Date/Time of last server status change.
> Status - shows the current server status.
> XXX Req/Rec- for each managed archive, shows the flags for
Requested/Received daily files. Requested is forced to YES for all types.
9AKK101130D1382 421
LTA Status
This area shows informations about the status of the LTA manager.
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.
9AKK101130D1382 423
Figure 34. LTA Drive Status
Change Parameters
The figure below shows the LTA parameters management window.
424 9AKK101130D1382
Figure 35. LTA Change Parameters
> Time Parameters - includes the fields to configure the Polling parameters;
the changes will be accepted selecting Update Time Param. button.
> LTA status - includes the fields to show the current LTA status (Current
status) and to select manually a new phase (Change to); selectable phases
are following:
Waiting Start Time - wait daily polling start time
Polling - will be activated the polling to check all files received by the
linked servers.
Updating Circular Buffer - all files received from linked servers will be
written to the circular buffer
9AKK101130D1382 425
Writing to LTA Drive (if configured) - all new files will be written from CB
to archive disk
Waiting Tomorrow - wait tomorrow
The changes will be accepted selecting Update LTA Status button.
LTADriveCmd program
LTADriveCmd works using NERO 6 utilities and is necessary to install
NERO 6 on the LTA server to can use it; derives from NeroCmd and
manages the access to the defined removable drive. Is activated by
LTAExplorer using following PGP APPL\LTA\RemovableDrive registry:
> CmdGetInfo - this is the command line used to activate the program
when is necessary to have the informations about the drive: the
program will load these registry
> SizeFree - free size of the removable drive
> SizeTotal - total size of the removable drive
> SizeUmCode - Number to indicate the E.U. used for the Size*
(0=GB, 1=MB, 2=Blocks)
> CmdWrite - this is the command line used to activate the program
when is necessary to write archived files to the drive if is not empty.
> CmdWriteEmpty - cthis is the command line used to activate the
program when is necessary to write archived files to the drive if is
empty.
> CmdPgmCode - in this registry (initialized with -1 by LTAExplorer
before activate the program) will be written the resulting command
code:
> -1 - In Progress
> 0 - command executed
> Other values - Error on command execution
In the command lines you can use following specific keys:
426 9AKK101130D1382
> ?WRITE - this key will be replaced with the default command line to
write files to the drive
> ?WRITE_EMPTY - this key will be replaced with the default command
line to write files to the drive when is empty
9AKK101130D1382 427
People Finder
Overview
The People Finder application allows the notification to the assigned staff of
the occurrence of alarm situations by means of the dispatch of a SMS to a
mobile phone.
Following a user defined event, like any type of configurable alarms, the
OGP server, using a GSM modem (not included in the PGP supply, will send
a SMS to the shift operator defined in the shift book, and a warning call to
his/her mobile phone. The answer to the warning call will determine the
acknowledgement of the alarm.
If the shift operator does not answer the call (which is repeated for a
configurable number of times) the program repeats the dispatch of the
message and dials a call to the mobile phone defines as Recovery.
Following the list of GSM modems tested for People Finder function:
Digicom Pocket GSM
Falcon A2D-1
Siemens TC35t-AT
Database
In order to trigger the sending of a SMS in case of alarms, the corresponding
tags in the PGP database must be configured with a positive value (1-15) in
the SMS Index field. This index refers to the SMS to use in case of the
occurrence of an alarm for that tag (see section: Shift book configuration
file).
Registry
In the PGP server must be defined for APPS\Finder following registry:
Serial Port configuration parameters (name - default):
> Port - COM3
> BaudRate - 19200
428 9AKK101130D1382
> ByteLength - 8
> StopBits - 1
> Parity - NONE
Function customizing parameters (name - default - description):
> CPIN - 8629 - PIN code
> Repeat - 3 - Number of call attempts to the shift operator before
transferring to the recovery number
> Read_Timer - 11000 - Wait time (in milliseconds) for an answer from the
modem
> Drin-Timer - 20 - Wait time (in seconds) for an answer to the call
> CnfPhonesFile - <INSTALLDIR>\Config\PeopleFinderPhones.xml - Name
of the Finder configuration file
> CnfShiftsFile - <INSTALLDIR>\Config\PeopleFinderShifts.txt - Removed
since 4.1 release
> WebFile - data\eMaintenanceStatus.xml - Web file definition for log
recording
> SendTagDescription - NO - YES to send in the SMS message the tag
description rather then the alarm comment
> SendExTagDescription - NO - YES to send in the SMS message the
extented tag description rather then the description
> DataCall - NO - YES to make a data call to the mobile phone (a voice call
is otherwise made)
> DisableAckFromSms - NO - YES to acknowledge the alarms only
answering to the mobile phone call
> TraceLog - NO - YES to have more details in the log file about the
operations executed by the program
9AKK101130D1382 429
Defining in the registry CnfPhonesFile a file name with .XML extension,
the configuration of the Shifts and Phones for the Finder function is
managed by SYSSETUP; all configuration parameters will be included in
a single XML file. If you have already used an XML file created with
previous PGP releases, you have to change manually in the XML file
the format of the DATE like this new format: YYYY-MM-DD hh:mm:ss.
430 9AKK101130D1382
Figure 36. SysSetup - People Finder
If the configuration file is empty, you can only click on the items with the right
mouse button to show the configuration menu:
> New Sms Index
> New Phone
9AKK101130D1382 431
New Phone
Selecting New Phone will be showed following window
> 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.
432 9AKK101130D1382
Figure 38. SysSetup - People Finder - Configure New Sms Index
> SMS Index - Enter the number to identify the SMS index (1-15)
> Phone ID - Select a Phone ID to assigne to this SMS index (will be
automatically showed only the configured phones)
> From/To - Select Date/Time for shitf start and end
> Delay - Wait time (in minutes) for ack
Select OK to add the configured SMS Index.
Phones
When the Phones item is selected, the right side of the dialog window
changes.
9AKK101130D1382 433
Figure 39. SysSetup - Phones
434 9AKK101130D1382
Sms Index
Opening all items in the Index tree and selecting an item Index n, the right
side of the dialog window changes.
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.
436 9AKK101130D1382
Phone Book Configuration File
The phone book configuration file (not xml version) must have the following
structure:
CODGSM,PHONE_NO,MAXCALL,DESCRIPTION
Where:
> CODGSM - Identification code of the shift operator (0-9 A-Q), R identifies
the Recovery number
> PHONE_NO - Number of the mobile phone of the shift operator
> MAXCALL - Number of call attempts (> 1)
> DESCRIPTION - Description (name) of the assignee of the mobile phone
Example:
A,3331111111,2,JOHN SMITH
B,3351111111,2,TOM BROWN
R,3401111111,3,RECOVERY
Notes:
> The comment lines in the file are identified by the character !
> Dont use numbers or upper case letters after a space in comments
> Dont insert comments after the name of the assignee
> The identification code R is used to identify the Recovery number which
will be called when there is no answer from the shift operator
Functionality
Following the occurrence of an alarm for a tag where SMS Index field is
greater than zero, the People Finder program (Finder.exe) will use this index
combined with the current date and time to retrieve from the Shift Book
configuration the code of the shift operator to which the notification must be
sent.
With this code, it will access the Phone Book parameters to retrieve the
mobile phone number and send the SMS formatted as follow:
9AKK101130D1382 437
IDX HH:MM:SS DD-MM-YY DESC
where:
IDX - SMS Index
HH:MM:SS DD-MM-YY - alarm time stamp
DESC - Alarm comment or tag description or tag extended description
(like defines in the registry settings)
A timer is then started to wait for an acknowledge message formatted as
follows:
IDX HH:MM
where:
IDX - SMS Index
HH:MM - reply time stamp
If the shift operator does not send the answer message before the timer
expiration, the program dials the mobile phone to warn to receiver of the
incoming message.
The reception of acknowledge or the answer to the call will acknowledge all
SMS with index IDX and time stamp earlier than the reply time stamp.
If the shift operator does not answer, the program cyclically repeats the call
for the configured number of times and then it repeats the same sequence
(message+phone calls) with the recovery number.
All actions performed by the program and the results are registered in the
log file: if the TraceLog registry is YES, more informations are registered.
The same messages are registered in the file (if existing) defined in the
WebFile registry to be consulted with the WebServer from remote positions.
Master/Slave
In a PGP Master/Slave configuration, the Finder.exe program will be
activated on all machines but it will execute the functions only on the primary
server; on the slave, it will wait to be primary.
438 9AKK101130D1382
Real-time Utilities
By clicking with the right mouse button on the icon (a small phone) in the
System Tray showing the program activity, a menu containing the following
items are displayed:
Close - closes the menu
Open Log File - opens a window to access and display the log file
Function Status - presents the state of the function
Enable - enables the function suspended
Disable - disables the function if active
Update Shifts - after the modification of the shifts, loads the new
configuration
Acknowledge all Alarms - acknowledges all pending alarms
Stop - stops the program
9AKK101130D1382 439
440 9AKK101130D1382
Section 5 Distributed Architecture
Introduction
PGP is available for use on a wide range of PC platforms running the
Microsoft Windows operating system.
Each system architecture depends on the requirements of the specific
application. Figure 41 shows a general configuration where some servers
and clients are connected via a LAN cable. They are connected via Ethernet
TCP/IP protocol. Client PCs receive data from a Server and interact with the
user by displaying mimics, alarm list, trends, etc. The figure shows only the
main components.
PGP servers may operate as individual stations, each one independent from
any other, except for client interconnection, or they may operate in a
distributed architecture where all servers are interconnected from a
configuration and a operation point of view.
The distributed architecture is based on the inter-operability among different
PGP server nodes to accomplish a consistent configuration and operation
environment in the whole system.
9AKK101130D1382 439
Figure 41. Example of PGP Architecture
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.
Assumptions
The following assumptions apply to a distributed architecture.
The same release of PGP must be implemented in all Servers
belonging to the distributed architecture.
Servers are independent as far as concerning the database
configuration. They may have an identical database or share a portion
of the database or musttally different databases.
In order to accomplish the functions described below, especially those
related to the tags, there are no restrictions concerning the name of the
tags, the ordering and the size of the databases. Databases can be
completely different as stated above also. The only requirement is
related to the Tag Unique Identifier: it must be consistent throughout the
different databases.
Servers that cooperate to the distributed architecture must have a
consistent database of nodes. This database defines the names and
the characteristics of each node. Refer to Section 2, Database
Configuration of this manual for details.
9AKK101130D1382 441
Furthermore, propagation of data from a Server to other Servers
depend on the proper definition of the destination masks in the tag,
trend group and calculation databases.
Refer to Tag Database Subsystem on page 71, Trend Group
Subsystem on page 238 and Calculation Subsystem on page 176 for
details.
Server Functions
PGP maintains a consistent configuration and operational environment on
all nodes of the distributed architecture.
The Server nodes exchange information and data, either during the on-line
operation or in off-line mode. Some data exchange is performed
automatically by the system, while other exchanges are activated by a user
request, as described in the following description.
On-line Features
The main data exchanged among servers, during the normal on-line
operations, is related to the following functions.
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 Features
The 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 Functions
Similar to the standard Client/Server architecture, each Client participating
to a distributed architecture can be connected to one or more Servers at a
time.
Each Client, however, may connect every Server in the system, without any
restriction. Each Client maintains a list of known Servers, which is used by
the following functions; the first Server in the list is considered as the
referring Server.
Re-assigning the Client, upon user request, to another Server. This
function allows a user, with appropriate privileges, to locate a PGP
Server on the Network, either from the known node list or selecting it by
name.
Once the node has been located and the connection has been
established the user has the possibility to re-assign the Client functions
to the selected Server. This switch-over is transparent for the main PGP
Explorer application (the application which manages mimics, alarms,
trends), while other applications, such as configuration functions, are
terminated and must be restarted.
Re-assigning the Client, automatically, to another Server in case of the
current Server failure.
The previously described function is also automatically activated by the
system in case of failures in the connection between the Client and the
Server. If some communication function fails, the Client can scan the list
444 9AKK101130D1382
of known Servers, and try to connect to the Server until the connection
is successful. The same procedure is performed during the Client start-
up.
ALIGNSPECS Program
This program manages the alignment of the specs of the INFI stations to the
configured servers (parameters defined in the APPS\ALIGNSPECS
registries) when is defined a PGP architecture with PGP servers not directly
connected to INFINET via ICI.
Runs only at PGP startup and the initial delay must be enough to grant that
the servers connected to the ICI have their database updated.
9AKK101130D1382 445
446 9AKK101130D1382
Section 6 OLE for Process Control
Introduction
O.P.C. (Ole for Process Control) represents a standard mechanism based
on the Microsoft OLE/COM technology for communicating to numerous data
sources, in order to grant inter-operability between automation/control
applications, field systems/devices, and business/office applications in the
process control industry.
The OPC Foundation, a non-profit corporation (the OPC Foundation), has
established a set of standard OLE/COM interfaces to provide different
functionality (i.e. Data Access, Historical Data Access and Alarm/Events
Handling).
The PGP OPC server provides Data Access (name OPC.Power Generation
Portal.1) and Alarm&Event (name OPC.Power Generation PortalAE.1)
functionalities and it is implemented according to the 2.03 (DA) and 1.02
(AE) specifications.
It is designed to allow simultaneous connections by OPC clients developed
accordingly to the OPC specifications described above. See the following
sections for further explanations about OPC client connections.
This section provides a brief overview about OPC architecture, and explains
the PGP OPC server.
9AKK101130D1382 445
OPC Overview
The OPC specification describes the OPC COM Objects and their interfaces
implemented by OPC Servers. An OPC Client can connect to OPC Servers
provided by one or more vendors as shown in the figure below.
446 9AKK101130D1382
Multiple OPC Clients can be connected to multiple OPC Servers in a
completely free architecture as shown in the figure below.
9AKK101130D1382 447
There are two types of groups, public and local (or private). Public is for
sharing across multiple clients, local is local to a client.
The PGP OPC server does not support public groups, neither any
specific interfaces about such a groups. Only private groups are
supported.
Within each Group the client can define one or more OPC Items.
The OPC Items represent connections to data sources within the server. An
OPC Item, from the custom interface perspective, is not accessible as an
object by an OPC Client. Therefore, there is no external interface defined for
an OPC Item. All access to OPC Items is via an OPC Group object that
contains the OPC item, or simply where the OPC Item is defined.
Associated with each item is a Value, Quality and Time Stamp. Note that the
items are not the data sources: they are just connections to them. For
example, the tags in a DCS system exist regardless of whether an OPC
client is currently accessing them. The OPC Item should be thought of as
simply specifying the address of the data, not as the actual physical source
of the data that the address references.
The OPC specification dictates that OPC clients are allowed to specify that
some operations can be performed on CACHE or DEVICE by the OPC
448 9AKK101130D1382
server. Items read operation, for example, could be performed in such a
ways.
The implementation details of such a mechanism are server specific but
access to CACHE data is expected to be faster than DEVICE data.
The 1.02 AE specification details with entities commonly referred to as alarm
and event, having distinct meanings. A condition is a named state of the
OPC Event Server, or of one of its contained object, which is of interest to is
OPC clients.
An alarm is intended as an abnormal condition, that is a special case of
condition.
On the other hand, an event is a detectable occurrance which is of
significance to the OPC Event server, the device it represents, and its OPC
clients. An event may or may not be associated with a condition.
The AE specifications state that the expectation is to have the available
events and conditions organized within one or more process areas. An area
is a grouping of plant equipment configured by the user. If areas are
available, an OPC area browser object may be provided by an OPC server
in order to allow process area browsing by OPC clients. Event categories
define grouping of events supported by an OPC Event server. Examples of
event categories might include process events, system events etc and
categories may be defined for all event types, i.e. simple, tracking and
condition related.
In order to receive event notifications, OPC clients must subscribe to them
and, for each subscription, events may be selected (event filtering) using
event types (simple, condition, tracking), categories, priority, areas and
event sources.
See the OPC Data Access and Alarm Event Specification section for further
details and explanations.
9AKK101130D1382 449
PGP OPC Client
PGP may connect OPCservers DA and AE, in order to receive data from a
external device. To use an AE connection you must connect also the DA
server, i.e. connections using only a AE server will not work.
In the tag database, OPC source tags must be configured properly. Refer to
the section on tag database configuration for details on OPC tags.
450 9AKK101130D1382
OPC Data Acquisition
OPC Client Data Acquisition
For remote server connections, when network resources are involved, a
time delay could occur if the network cable is detached, or the server is
closed in an incorrect manner. System performance could be decreased.
The PGP OPC client is designed to have proper timeouts without being
affected by the above delays.
These timeouts can be set from the windows registry. Open the
KEY_LOCAL_MACHINE key, then the SOFTWARE key, then the ABB key,
then the PGP key, then the APPS key and finally the OPC key. The
following registry values can be set:
CacheTimeOut: used by synchronous read from Cache;
DeviceTimeOut: used by synchronous read from Device;
StatusTimeOut: used by exception read. The OPC Client is advised by
the server about item changes. No read requests are done by client,
therefore it checks the server status periodically.
All these entries are in seconds.
The OPC specification does not dictate anything about the number of items
that can be specified in a single read operation by the client. In order to
avoid any problems about managing of a large amount of items, the PGP
OPC client is able to pack the amount of item to be read in data packets
having a configurable size.
The read methods can be set from the windows registry. Open the
KEY_LOCAL_MACHINE key, then the SOFTWARE key, then the ABB key,
then the PGP key, then the APPS key and finally the OPC key. The
ItemPacketSize registry value can be set to the number of items contained
in a single data packet.
9AKK101130D1382 451
See Table 188 for the default values:
Table 142. OPC Server Registry default values
Note 1:
Generally the DeviceTimeOut value is greater than CacheTimeOut one.
Code Description
500 500 milliseconds.
1 1 second
4 4 seconds
10 10 seconds
30 30 seconds
60 60 seconds
Note 2:
Any other refresh rate configured by the user will be rounded towards one of
the above PGP supported rates.
452 9AKK101130D1382
OPC Server Data Acquisition
Once an OPC Client is connected to the server (and groups and items have
been configured) the PGP OPC Server updates and stores internally (in its
own CACHE) the values and qualities of the configured items.
This can be done by means of two different ways:
The server requires periodically to PGP the values of the active items
belonging to groups that are active and scheduled in that specific time.
The group refresh rate establishes when group must be managed (in
other words, whether it is scheduled) in that specific time. This is done
in order to avoid server overhead but read is done regardless item value
changes.
The server periodically checks the PGP queue for item changes. Items
not changed are not managed (because they are not contained in
queue) but it is possible to receive items not active or belonging to
inactive and/or not scheduled groups (the PGP ignores OPC
specifications).
These read methods can be set from the windows registry. Open the
KEY_LOCAL_MACHINE key, then the SOFTWARE key, then the ABB key,
then the PGP key, then the APPS key and finally the OPC key.
ReadFromQueue registry can be set to the following values:
1. NO : it corresponds to read items by polling (first way).
2. YES: it corresponds to read items from queue (second way).
The default value for the ReadFromQueue key is NO.
This two different read methods allow you to have two different solutions for
server updating (and for server overhead from a performance point of view).
An OPC client itself could set the best solution on the basis of both such a
server behavior and the different OPC read modes.
The DEVICE data is not obtained from a physical device but from the PGP
system. Therefore data values are subject to data updating by the system.
The CACHE data instead are obtained from an internal server buffer,
without any request to and values are subject to the group update rates.
9AKK101130D1382 453
In both cases, the data value could be slightly different from the value at the
time when the client requires data.
The PGP OPC server supports several group update rates. Refer to the
refresh rates in the description of OPC parameters of a database tag.
Client refresh rates less than 500 msec will be set to 500 msec.
Client refresh rates higher than 60 sec will be set to 60 sec.
Client refresh rates between two server supported rates will be set to
the higher one.
For example, a refresh rate of 15 sec will be set to 30.
The OPC Data Access server implements all the mandatory interfaces
related to the 2.03 OPC specifications and also the optional interface
IOPCBrowseServerAddressSpace.
454 9AKK101130D1382
Table 190, Table 191and Table 192 summarize .
Table 144. OPC Server Interfaces.
Interface Implemented
IOPCServer Yes
IOPCServerPublicGroups (optional) No
IOPCBrowseServerAddressSpace (optional) Yes
IOPCItemProperties (new 2.0) Yes
IConnectionPointContainer (new 2.0) Yes
IOPCCommon (new 2.0) Yes
IPersistFile (optional) No
Interface Implemented
IOPCGroupStateMgt Yes
IOPCPublicGroupStateMgt (optional) No
IOPCASyncIO2 (new 2.0) Yes
IOPCAsyncIO (obsolete - V1) No
IOPCItemMgt Yes
IConnectionPointContainer (new 2.0) Yes
IOPCSyncIO Yes
IDataObject (obsolete - V1) No
9AKK101130D1382 455
Table 146. Enum OPC Item Attributes.
Interface Implemented
IEnumOPCItemAttributes Yes
The 1.0a interfaces have not been implemented. However 1.0a registry
setting are still present. An OPC client 1.0 is able to connect to the PGP
OPC Server. For example reading items in the synchronous read mode
version 2.03 differs from the 1.0a in the exception and asynchronous read
mode.
456 9AKK101130D1382
The PGP OPC AE Client does not support any generic alarms from an OPC
Event server not related to a PGP tag. It is required that the Tag Name
configured in the PGP database corresponds to the OPC alarm source.
OPC Server AE
The OPC AE Server implements all the mandatory interfaces related to the
1.02 OPC specifications and also the optional interface
IOPCEventAreaBrowser.
Table 193, Table 194 and Table 195 summarize.
Table 147. OPC Event Server
Interface Implemented
IOPCEventServer Yes
IOPCCommon Yes
IConnectionPointContainer Yes
Interface Implemented
IOPCEventAreaBrowser (optional) Yes
Interface Implemented
IOPCEventSubscriptionMgt Yes
IConnectionPointContainer Yes
It is losely coupled (as the PGP DA OPC) to the PGP system. All the alarms
provided by the server are received from the PGP system and forwarded to
any connected client.
9AKK101130D1382 457
OPC Client Redundancy
The OPC client is able to connect to more than one opc server on different
machines at the same time and gets data from one server only. This is how
PGP implements opc redundancy. In case of error, the client switches to
another server. Note that the opc server must be the same, that is the same
ProgID must be used for all the machines.
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 :
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.
Note that the client does not "switch" among the servers actually. It is always
connected to them and it simply sets the opc groups inactive/active (in other
words, it is the data source that is different).
9AKK101130D1382 459
OPC Server Registration
The PGP OPC Server must be registered on the machine, typing the
following command:
OPCSERVER.EXE /REGSERVER
The OPC Server browser must be registered on the machine, typing the
following command:
OPCENUM.EXE /REGSERVER
Those registration are automatically performed when PGP is installed.
460 9AKK101130D1382
Default Launch Permissions:
9AKK101130D1382 461
Allow Access to Everyone:
Identity:
The interactive user
6. Click the Apply button.
7. Exit by clicking on the OK button.
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:
PGP OPC
5 1 - 200
4 201 - 400
3 401 - 600
2 601 - 800
1 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.
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).
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
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.
468 9AKK101130D1382
Appendix A Tables
Tag Types
Table 150. Tag Types.
Code Tag Type Description
1 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
Table 150. Tag Types.
Code Tag Type Description
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.
470 9AKK101130D1382
Tag Sources
Table 151. Tag Sources.
Code Tag Source Description
1 C-NET Infinet tag.
2 EXT Generic external communication.
3 CALC Internal calculated tag.
4 LAB Lab data entry tag.
5 USER User application tag
6 DEVSTA Device status tag.
7 TAGGEN Generated tag.
8 OPC OPC tag.
9 Reserved
10 AC800F AC800F tag.
11 AC800M AC800M tag.
12 MELODY MELODY tag.
13 AC870P AC870P tag.
14 PROP13 PRO Control P13 tag.
9AKK101130D1382 471
Table 152. Color Map.
Code Color
10 Hot Pink
11 Sea Green
12 Spring Green
13 Chocolate
14 Lavender
15 Sandy Brown
16 Tomato
17 Turquoise
18 Deep Pink
19 Dark Violet
For compatibility with older PGP versions, the first eight colors in the table
match the old color table.
The color table above is defined in the BattColors file. The default color
scheme defined in the BattColors file can be modified changing the RGB
pattern definition (e.g. RGB(80,80,80), RGB(FF,00,FF)) and typing the color
name (e.g. gray, fuchsia) as defined in the Internet Explorer color table.
When a Internet Explorer color name is used, the RGB definition can be left
undefined typing RGB(-1,-1,-1). The color name is always mandatory.
Since a Internet Explorer color may not have a name defined, a color name
must be associated to such color in order to use it in the BattColors file.
Valid color definitiona are the following:
RGB(-1,-1,-1) - fuchsia
RGB(FF,00,FF) - fuchsia // Same as previous
RGB(FF,99,FF) - lightfuchsia // New color name
RGB(-1,-1,-1) - gray
RGB(80,80,80) - gray // Same as previous
RGB(CC,CC,CC) - dust // New color name
RGB(-1,-1,-1) - lime
472 9AKK101130D1382
RGB(00,FF,00) - lime // Same as previous
RGB(00,CC,00) - darklime // New color name
The syntax of the default BattColors file is shown below.
// BattColors.ins
//
// Definition of color table associated to
// Alarm Attribute and Color Builder (BATTDECK.INS).
//
RGB( -1, -1, -1) - black // 0
RGB( -1, -1, -1) - red // 1
RGB( -1, -1, -1) - green // 2
RGB( -1, -1, -1) - yellow // 3
RGB( -1, -1, -1) - blue // 4
RGB( -1, -1, -1) - magenta // 5
RGB( -1, -1, -1) - cyan // 6
RGB( -1, -1, -1) - white // 7
RGB( -1, -1, -1) - orange // 8
RGB( -1, -1, -1) - slateblue // 9
RGB( -1, -1, -1) - hotpink // 10
RGB( -1, -1, -1) - seagreen // 11
RGB( -1, -1, -1) - springgreen // 12
RGB( -1, -1, -1) - chocolate // 13
RGB( -1, -1, -1) - lavender // 14
RGB( -1, -1, -1) - sandybrown // 15
RGB( -1, -1, -1) - tomato // 16
RGB( -1, -1, -1) - turquoise // 17
9AKK101130D1382 473
RGB( -1, -1, -1) - deeppink // 18
RGB( -1, -1, -1) - darkviolet // 19
474 9AKK101130D1382
ICI Point Types
Table 155. ICI Point Types.
Code Point Type
0 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
Table 155. ICI Point Types.
Code Point Type
34 SPDT.
35 to 52 Not Defined.
53 RMCB.
54 DDIG.
55 to 59 Not Defined.
60 Text Selector.
476 9AKK101130D1382
Time Units
Table 156. Time Units.
Code Time Unit Description
0 Sec. Seconds
1 Min. Minutes
2 Hours Hours
3 Days Days
4 Months Months
5 Years Years
Instrument Types
Table 157. Instrument Types.
Instrument Type Description
1-5 V High Level.
4-20 mA High Level.
TCK Type K thermocouple.
TCJ Type J thermocouple.
TCT Type T thermocouple.
RTD RTD 100 ohms.
9AKK101130D1382 477
Table 158. Analog and Digital Tag Quality Bits.
Code Description
3 Old data
4 Off scan
5 Reserved
6 Inserted value
7 Alarm check disabled
8 Alarm inhibited
9 Reserved
10 Bad calculated value
11 Application specific 3
12 Red tagged
13 Hardware channel failure
14 Application specific 1
15 Application specific 2
478 9AKK101130D1382
Table 159. Analog (Only) Tag Quality Bits.
Code Description
0 High instrument range
1 2-High alarm limit
2 High alarm limit
3 Low alarm limit
4 2-Low alarm limit
5 Low instrument range
6 Increasing ROC
7 Decreasing ROC
8 High deviation
9 Low deviation
10 Integer format
11 Tracking
12 3-High alarm limit
13 3-Low alarm limit
14 Auto/Manual
15 Dummy Packet (Playback only)
System Information
Table 160. Tag Configuration Retrieving Parameters.
Parameter Description
ProductName Name of the Product
ShortProductName Short name of the Product
FullProductName Full name of the Product
ProductFamily Family Name of the Product
ProductVersion Version of the product
ProductCompany Company Name of the Product
ProductCorporate Corporate Name of the Product
Version Release version
SubVersion Release sub-version
Build Build Version
9AKK101130D1382 479
Table 160. Tag Configuration Retrieving Parameters.
Parameter Description
HotFix Hot Fix
MaximumTags Number of tags
MaximumConfiguredTags Numer of Tags Configured
MaximumCrts Maximum number of Clients
MaximumPV Maximum number of PV
MaximumDI Maximum number of DI
MaximumPlaybacks Apms Parameter
MaximumPrinters Maximum number of Printers
MaximumICI Maximum number of ICIs
MaximumICIIndex Number of ICI index
MaximumCalculations Maximum number of Calculation Blocks
MaximumTrendGroups Maximum Number of Historical Groups
MaximumTagInfoType Maximum Tag Info Type
MaximumFileKey Maximum File Key
MaximumTotalizationLogs Maximum Number of Totalizations
MaximumSoeEvents Maximum Events for SOE
MaximumMaintenanceLogs Maximum Number of maintenance
MaximumPTLArchives Maximum Number of Post Trip Logs
MaximumDisplays Maximum Nuber of Displays
MaximumOpConfDisplays Maximum Nuber of Op Conf Displays
MaximumAlarmPriorities Maximum Numer of Alarm Priorities
MaximumAlarmGroups Maximum # of alarm groups
MaximumFiles Maximum number of Files
MaximumTagNameLenght Maximum Lenght of Tag Name in presentations
MaximumTagDescrlenght Maximum Lenght of Tag Description in presentations
MaximumTagsetLenght Maximum Lenght of Logic State Descr in presentations
RecordsInPtlFiles Apms Parameter
RecordsInPlaybackFiles Apms Parameter
EntriesInPlbQueue Apms Parameter
EntriesInPtlQueue Apms Parameter
EntriesInPlbmemory Apms Parameter
EntriesInCompressedPlbFiles Apms Parameter
480 9AKK101130D1382
Table 160. Tag Configuration Retrieving Parameters.
Parameter Description
HistDataRetrievalLimit Apms Parameter
MaxTagPerGroup Maximum tags per Historical Group
MaximumAlacPrograms Number of Alarm Action Programs
MaximumPlaybackDays Maximum Number of Days for Keeping Playback archive
MaximumIndexNo Maximum Tag Index
MaximumSoeDevices Maximum SOE Device
NumberOfPlaybackFiles Number of files reserved for Playback
MaximumPtlDays Maximum Number of Days for Keeping PTL archive
MaximumPlantUnits Apms Parameter
LicensedClients Number of Clients licensed
LicensedAPI API is Licensed
LicensedSpecificAPI Specific API is Licensed
LicensedODBC ODBC is Licensed
LicensedWeb WEB is Licensed
LicensedPrc_Infi Process Control for INFI is Licensed
LicensedDisplayBuilder Display Builder is Licensed
LicensedDaOpcServer Licensed DA Opc Server
LicensedAeOpcServer Licensed AE OPC Server
LicensedHdaOpcServer Licensed HDA OPC Server
LicensedDawOpcServer Licensed DA- write OPC Server
LicensedOPCTags Numer of tags licensed for OPC
LicensedDDE DDE is Licensed
LicensedTags Number of Tags licensed
LicensedHistTags Number of Tags Licensed
LicensedSimulation Simulation is Licensed
LicensedCalculation Calculation is Licensed
LicensedCalcSteam Steam Calculation is Licensed
LicensedCalcMacro Macro Calculation is Licensed
LicensedScanDrivers Scanner Drivers are Licensed
LicensedAPI_RT API RunTime is Licensed
LicensedPrc_Ac800f Process Control is Licensed
LicDrv_Infi Driver for INFI is Licensed
9AKK101130D1382 481
Table 160. Tag Configuration Retrieving Parameters.
Parameter Description
LicDrv_Dci Driver for DCI is Licensed
LicDrv_Odbc Driver for ODBC is Licensed
LicDrv_Modbus Driver for Modbus is Licensed
LicDrv_OpcClient Driver for is Licensed
LicDrv_Spabus Driver for Spabus is Licensed
LicDrv_Iec101 Driver for Iec101 is Licensed
LicDrv_Iec104 Driver for Iec104 is Licensed
LicDrv_Text Driver for Text is Licensed
LicDrv_Teleperm Driver for teleperm is Licensed
LicDrv_GsmMarkV Driver for GsmMarkV is Licensed
LicDrv_Iec103 Driver for Iec103 is Licensed
LicDrv_XX2 Driver for XX2 is Licensed
LicDrv_XX3 Driver for XX3 is Licensedr
LicDrv_XX4 Driver for XX4 is Licensed
LicDrv_XX5 Driver for XX5 is Licensed
LicDrv_App Application Driver is Licensed
LicAppl_MaintTrigger Maint Trigger Application is Licensed
LicAppl_XmlToCmms Xml To CMMS Application is Licensed
LicAppl_PPP PPP Application is Licensed
LicAppl_DPP DPP Application is Licensed
LicAppl_TSE TSE Application is Licensed
LicAppl_BSE BSE Application is Licensed
LicAppl_TPA TPA Application is Licensed
LicAppl_STP STP Application is Licensed
LicAppl_TSEOP TSEOP Application is Licensed
LicAppl_BSEOP BSEOP Application is Licensed
LicAppl_MSFDPP MSFDPP Application is Licensed
LicAppl_CPA CPA Application is Licensed
LicAppl_Harmony_Cfg Harmony Cfg Application is Licensed
LicAppl_XX2 XX2 Application is Licensed
LicAppl_XX3 XX3 Application is Licensed
LicAppl_XX4 XX 4Application is Licensed
482 9AKK101130D1382
Table 160. Tag Configuration Retrieving Parameters.
Parameter Description
LicAppl_XX5 XX5 Application is Licensed
LicAppl_PeopleFinder People Finder is Licensed
LicensedPrc_Ac870p Licensed Process Control for Ac870P
LicensedPrc_ProP13 Licensed Process Control for ProP13
LicenseExpiration License expiration
ServerName Server Name
IsServer Apms Parameter
IsSystemActive The system is active
IsRundownInProgress System shutdown in progress
IsSimulationActive Simulation is Active
IsSimulationFrozen Simulation is Frozen
ClientName Name of Client
CurrentTimeIM Current Time
CurrentTimeString Current Time (string)
CurrentExTimeX Current Time
ConvertedTime Converted Time
CurrentOSTimeX Current Time from OS
StartupTimeIM Time of Last Startup
PercentDiskUsed_A Percentage of use of Disk A
PercentDiskUsed_B Percentage of use of Disk B
PercentDiskUsed_C Percentage of use of Disk C
PercentDiskUsed_D Percentage of use of Disk D
PercentDiskUsed_E Percentage of use of Disk E
PercentDiskUsed_F Percentage of use of Disk F
PercentDiskUsed_G Percentage of use of Disk G
PercentDiskUsed_H Percentage of use of Disk H
PercentDiskUsed_I Percentage of use of Disk I
PercentDiskUsed_J Percentage of use of Disk J
PercentDiskUsed_K Percentage of use of Disk A
PercentDiskUsed_L Percentage of use of Disk L
PercentOJUsed Percentage of use of Operator Journal File
PercentPlaybackUsed Percentage of use of Playback Archive
9AKK101130D1382 483
Table 160. Tag Configuration Retrieving Parameters.
Parameter Description
PercentCpuLoad Percent of CPU Load
PercentMemoryUsed Apms Parameter
PhysicalMemory Size of Physical Memory
IsLowResources Low System Resources
LoggedUser Name of Logged User
LoginTime Time of Login
LogoffTimeout Timeout For Auto Logoff
LoggedUserRecord Record Index of Logged User
LoggedUserID ID of Logged User
LocalNode Local Node
IsSystemMaster The system is master
MasterNode Index of the Master Node
NodeWeight Node Weight
IsConfigAligned Configuration is Aligned
IsOjAligned Operator Journal file is Aligned
IsHistAligned Historical Files are aligned
IsPlbAligned Playback Archive is Aligned
IsPtlAligned Post Trip Log Archive is Aligned
IsNodeAligned Node is Aligned
IsAlignInProgress Node Alignment in Progress
NodeAligning Apms Parameter
NodeStatusMask Node Status Mask
NetWorkerLifeCycle Life Cycle for Networker
NodeConnected Nmber of nodes connected
ConnectionTime Connection time
ConnectionUpdate Connection Update
AlarmPrintMask Mask of Enabled Alarm Printers
IgnoreRio Ignore Remote IO Alarms
OisTimeSynch Time Synch INFI as OIS
DstOnInfi DST sent on INFI
FlagOldAlarms Apms Parameter
InfiTimeSynch Time Synch Infi
484 9AKK101130D1382
Table 160. Tag Configuration Retrieving Parameters.
Parameter Description
UnackAlarm New Alarms are Uncked
PercentSaveOJ Apms Parameter
LadValueUpdate Update tag value on Alarm Display
QueueSOEtoDip Queue Sequence of Events to Data Processor
QueueSOEtoLog Queue Sequence of Events to Log processor
ExceptionScreen Apms Parameter
DisableAudibleOnAck Apms Parameter
PlaybackCompress Compress Playback
MsddFeedbacksInverted Invert Feedbacks on MSDD popup
BadQualityAlarms Bad Quality marked as Alarms
RemoteClients Apms Parameter
AlarmsWithMillisec Alarm Time includes Milliseconds
AlarmsAckBroadcast Broadcast Alarm Acknowledgements
AlarmsSilBroadcast Broadcast Alarm Silencing
Language Human Machine Language
RedTagCommands Commands arfe enabled if Red Tag
EnableAlarmPrintouts Enable Printouts of all alarms
IncrementControls Rate for Control Increment
FastIncrementControls Rate for Control Fast Increment
DemoSystem Demo System
AlarmsPerLad Maximum Alarm Messages per Display
EUText Engineering Unit Text
LSDText Logic State Descriptor Tests
Qf1bad Mask of Quality Flag 1 for Bad
Qf2bad Mask of Quality Flag 2 for Bad
TimeUnitText Time Unit Text
TagTypeText Tag Type Text
HistArchText Historical Archive Text
HistArchHDB Historical Archive DB
TypeInfo Type Info
TagInfoType Tag Info Type
AlarmBitmap Alarm Bitmap
9AKK101130D1382 485
Table 160. Tag Configuration Retrieving Parameters.
Parameter Description
WeekTimeInfo Day Of the Week
DayLightSavingTimeInfo Day Light Saving Time is ON
SoeQueueEntries Entries in Sequence of Events Queue
CompositeTime TIme in Composite Format
StandaloneSystem System Standalone
AlacQueueEntries Entries in Alarm Action Queue
FirstPlaybackFile Key for First Playback File
FirstPTLFile Key of first Post Trip Log File
NumberOfPTLFiles Number of files reserved for PTL
FirstHistorianFile Key of first Historical File
FirstHistorianRetrievedFile Key of first Historical Retrieved File
FirstHistorianGhostFile Key of first Historical GhostFile
NumberOfHistorianGhostFiles Number of Historical Retrived Files
OpstationLayout Operator Station Layout
OpstationDisplay Operator Station Display
AlarmMimic Alarm Mimic
OdbcInterface ODBC Interface
OdbcTagHistory ODBC Tag History
RundownNotInProgress Rundown Not In Progress
DipQueueEntries Entries in Data Input Processor Queueu
OdbcQueueEntries Entries in ODBC queue
IciStatus Status of the ICI
TextSelector Text Selector
Tagset Tagset
AlarmComment Alarm Comment
NationalLanguage National language
UserPar1 User Application Parameter 1
UserPar2 User Application Parameter 2
UserPar3 User Application Parameter 3
UserPar4 User Application Parameter 4
UserPar5 User Application Parameter 5
UserPar6 User Application Parameter 6
486 9AKK101130D1382
Table 160. Tag Configuration Retrieving Parameters.
Parameter Description
UserPar7 User Application Parameter 7
UserPar8 User Application Parameter 8
LongTermPlayback Playback Saved for Long Term
PlbComprHorzBand Playback Compression Horizontal DeadBand
PlbComprSlopeBand Playback Compression Slope Band
TimeZone Time Zoner
IgnoreAlarmGroup0 Ignore Alarms belonging to Group Zero
NodesInNetwork Number of Nodes in Network
PopupTimeout Timeout for Popups
BlackPopups Popups with Black Background
RequestReport Trigger for requesting Reports
DSysUseUID Use tag UID in Network messages
NetQueEntries Entries in Network queue
PopupToBeSelected Popu to be selected to enable commands
CalculReload Trigger for Reloading Calculations
SecurityGroup Security Group
SecurityLevel Security Level
SecurityPrivileges Security Privileges
ConnectionCnt Nodes Connection Count
EnableEventPrint Enable Pinting of Event Messages
AlarmsWithStdDate Enable STD time format for alarms
ControlAcknowlegmentRequired Acknowledgement fo Control is Required
IncrementControlsRate Rate for Control Increment
OpcQueEntries Entriesd in OPC queue
GenDiagStatus General Diagnostic Status
NetWorkerStatus NetWorker Status
OpcClientStatus OPC Client Status
OpcServerStatus OPC Server Status
DipReload Trigger for Reloading the Data Input Processor
OpcReload Trigger for Reloading OPC
HistReload Trigger for Reloading History
SmsReload Trigger for Reloading People Finder
9AKK101130D1382 487
Table 160. Tag Configuration Retrieving Parameters.
Parameter Description
AudibleCode Code of Alarm Audible
AudibleFile File for Alarm Audible
AtomSeparator Character for Atom Sepatation
SmsEnabled People Finder is Enabld
SmsActive People Finder Error logging is Active
SmsErrors People Finder Error logging is Enabled
SmsAckAll People Finder Acknowlege All Alarms
SmsAck People Finder Acknowlege Alarms
BuildTagInProgress Tag Builder is in Progress
ScannerReload Trigger for Reloading the Scanner
SimulationState Simulation State
SimulationRate Simulation Reate
OpstaPlantUnit Apms Parameter
PlantUnitMatch Apms Parameter
UserReload Apms Parameter
OpcAERefresh OPC AE Refresh
FileInfoX File Info
FileVersion File Version
DisableAutoNetMasterSwitch Disable Auto-Switch from Master to Slave
LocalRemoteControlInhibitTagDX Tag for Local-Remote Control
V23Reload Trigger for Reloading V23 logic
V23Recalculate Recalculate Voting 2 of 3
NumMultipleOutputDrivers Number of Output Drivers
FreezeDIP Data Input Process is Frozen
PlbSwitch Playback Switch
488 9AKK101130D1382
Tag Configuration Retrieving Parameters
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_TAGINDEX Index
DB_TAGNAME Name
DB_TAGDESC Description
DB_TAGIDX Internal Tag Index
DB_TAGTYPE Tag Type
DB_TAGTYPEDESCR Tag Type Description
DB_TAGSRC Tag Source
DB_VALUE Current Value
DB_RAWVALUE Current Raw Value
DB_NUMVALUE Numeric Value
DB_NUMUVALUE Numeric Unsigned Value
DB_PERCENT_VALUE Percent Value
DB_QUALITY Current Quality
DB_TIMESTAMP Time Stamp
DB_TIMESTAMP_TEXT Time Stamp Text
DB_ISO_TIMESTAMP Time Stamp
DB_VALUE_QUALITY Current Value and Quality
DB_VALUE_QUALITY_RA Current Value and Quality
DB_EXTQUALITY Current Quality
DB_TAGVAL Current Value and Quality
DB_TAGVALEX Current Value and Quality
DB_TSTAMP_VALUE_QUALITY Timestamp
DB_TVQ_STRING Timestamp (string)
DB_CUSTTAGID Plant Tag Name
DB_AL_PRI Current Alarm Priority
DB_AL_CAT Alarm Processing Categorized
DB_ALMGROUP Alarm Group
DB_EUDESC Engineering Unit
DB_EUINDEX EU Index
DB_NUMDECPL Decimal Places
9AKK101130D1382 489
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_I4_DATA Integer Format
DB_FGCOLOR Foreground Color
DB_BGCOLOR Background Color
DB_FGCOLORREF Foreground Color Ref.
DB_BGCOLORREF Background Color Ref.
DB_FGCOLORSTRING Foreground Color String
DB_BGCOLORSTRING Background Color String
DB_ALRMCMNT1 RTN Comment
DB_ALRMCMNT2 Hi Alarm Comment
DB_ALRMCMNT3 Lo Alarm Comment
DB_ALRMCMNT4 2-Hi Alarm Comment
DB_ALRMCMNT5 2-Lo Alarm Comment
DB_ALRMCMNT6 3-Hi Alarm Comment
DB_ALRMCMNT7 3-Lo Alarm Comment
DB_ALRMCMNT8 Hi Deviation Comment
DB_ALRMCMNT9 Lo Deviation Comment
DB_ALRMCMNT10 Hi ROC Alarm Comment
DB_ALRMCMNT11 Lo ROC Alarm Comment
DB_ALRMCMNT12 Event Comment
DB_ALRMCMNT13 Channel Failure Comment
DB_PRIMDISP Primary Display
DB_PRIMGROUP Primary Trend Group
DB_SEC_LEVEL Security Level
DB_SEC_GROUP Security Group
DB_AAP_NUM Alarm Action Program
DB_ACK_PROG Activate on Ack
DB_RTN_PROG Activate on RTN
DB_ALM_PROG Activate on Alarm
DB_EVT_PROG Activate on Event
DB_HI_PROG Activate on HI
DB_H23_PROG Activate on H3-H2
DB_H_PROG Activate on H
490 9AKK101130D1382
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_L_PROG Activate on L
DB_L23_PROG Activate on L3-L2
DB_LI_PROG Activate on LI
DB_HR_PROG Activate on PROC
DB_LR_PROG Activate on NROC
DB_AL_REM Remote Alarm Processing
DB_TRIG_CALC Triggered Calculation
DB_ICI_NUM ICI Number
DB_ICI_NDX ICI Index
DB_LOOP Ring
DB_PCU Pcu
DB_MODULE Module
DB_BLOCK Block
DB_SER_NUMBER SER Number
DB_SER_INDEX SER Index
DB_ICISTA_CD ICI Action Code
DB_AUD_IDX Audible Alarm Index
DB_OIS_ALA OIS Alarm Proc.
DB_DS_ALARM Display Alarms
DB_PR_ALARM Print Alarms
DB_SV_ALARM Save Alarms
DB_AUD_ALARM Activate Audible
DB_AUD_RTN Audible on RTNs
DB_BOT_ALARM Bottom of Screen
DB_DS_RTN Display RTNs
DB_PR_RTN Print RTNs
DB_SV_RTN Save RTNs
DB_DS_STCHNG Display Events
DB_PR_STCHNG Print Events
DB_SV_STCHNG Save Events
DB_PR_OPACT Print Actions
DB_SV_OPACT Save Actions
9AKK101130D1382 491
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_PR_INFO Print Infos
DB_SV_INFO Save Infos
DB_REM_ONACK Remove on Ack
DB_INFO_ONACK Info on Ack
DB_NO_UNACK Do not set Unack
DB_ALARM_MIMIC Display Mimic when alarm
DB_ACK_BROAD Broadcast Ack to the field
DB_APPL_ALA Trigger Application Event
DB_EXP_ALA Export Alarms to Foreign DB
DB_OPC_ALARM Export Alarms to OPC Server
DB_SMSINDEX SMS index for Alarms
DB_ALMINHTAG Alarm Inhibit Tag
DB_CTRLINHTAG Control Inhibit Tag
DB_CONFIRM_COMMAND Need Confirm Command
DB_CTRLCMDTAG Control Commad Tag
DB_HVARALMTAG Hi Variable Alarm Tag
DB_H2VARALMTG 2-Hi Variable Alarm Tag
DB_H3VARALMTG 3-Hi Variable Alarm Tag
DB_LVARALMTAG Lo Variable Alarm Tag
DB_L2VARALMTG 2-Lo Variable Alarm Tag
DB_L3VARALMTG 3-Lo Variable Alarm Tag
DB_CTRLINH Control Inhibit
DB_REMOTE_CTRLINH Remote Control Inhibit
DB_LOCAL_CTRLINH Local Control Inhibit
DB_S_COORD Slave Module Coordinates
DB_S_TYPE Slave Module Type
DB_S_TTID Termination Unit Type
DB_S_TOBO Termination Unit Identifier
DB_S_TTCO Termination Unit Coordinates
DB_S_SMOD S-Slave Module
DB_S_SCHA S-Slave Channel
DB_S_FRBO Field Cabinet Identifier
492 9AKK101130D1382
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_S_MODULE Slave Module
DB_S_CHANNEL Slave Channel
DB_OFFSCINI Off Scan Initially
DB_OFFALINI Off Alarm Check Initially
DB_INITVAL Initial Value
DB_SCA_VAL_0 0% Presentation Scale
DB_SCA_VL_100 100% Presentation Scale
DB_VIOL_CD Violation Code
DB_VIOL_SCAN Off Scan on Violation
DB_UT_TEXT Text (10 characters)
DB_UT_TEXT1 Text (16 characters)
DB_UT_TEXT2 Text (32 characters)
DB_UT_IN1 Integer 1
DB_UT_IN2 Integer 2
DB_UT_IN3 Integer 3
DB_UT_IN4 Integer 4
DB_UT_RE1 Real 1
DB_UT_RE2 Real 2
DB_UT_RE3 Real 3
DB_UT_RE4 Real 4
DB_UT_RE5 Real 5
DB_UT_RE6 Real 6
DB_VAL100 High Instrument Limit
DB_VAL0 Low Instrument Limit
DB_LALARM Low Alarm Limit
DB_L2ALARM 2-Low Alarm Limit
DB_L3ALARM 3-Low Alarm Limit
DB_HALARM High Alarm Limit
DB_H2ALARM 2-High Alarm Limit
DB_H3ALARM 3-High Alarm Limit
DB_LROC_LIMIT Increasing Rate Of Change
DB_HROC_LIMIT Decreasing Rate Of Change
9AKK101130D1382 493
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_H3_DELTA 3-Hi Variable Alarm Delta
DB_H2_DELTA 2-Hi Variable Alarm Delta
DB_L2_DELTA 2-Lo Variable Alarm Delta
DB_L3_DELTA 3-Lo Variable Alarm Delta
DB_SPAN Span
DB_H_ACTIVE H-Limit Active
DB_H2_ACTIVE H2-Limit Active
DB_H3_ACTIVE H3-Limit Active
DB_L_ACTIVE L-Limit Active
DB_L2_ACTIVE L2-Limit Active
DB_L3_ACTIVE L3-Limit Active
DB_HR_ACTIVE HR Active
DB_LR_ACTIVE LR Active
DB_LI_ACTIVE LI Active
DB_HI_ACTIVE HI Active
DB_ALARMDB Alarm Deadband
DB_ALARMDB_PERC Alarm Deadband (percent)
DB_EVENTTAG Event Tag
DB_ISALARM0 State is Alarm
DB_ISALARM1 State is Alarm
DB_ISALARM2 State is Alarm
DB_ISALARM3 State is Alarm
DB_ISALARM4 State is Alarm
DB_ISALARM5 State is Alarm
DB_ISALARM6 State is Alarm
DB_ISALARM7 State is Alarm
DB_ISALARM8 State is Alarm
DB_ISALARM9 State is Alarm
DB_ISALARM10 State is Alarm
DB_ISALARM11 State is Alarm
DB_ISALARM12 State is Alarm
DB_ISALARM13 State is Alarm
494 9AKK101130D1382
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_ISALARM14 State is Alarm
DB_ISALARM15 State is Alarm
DB_ISALARM16 State is Alarm
DB_ISALARM17 State is Alarm
DB_ISALARM18 State is Alarm
DB_ISALARM19 State is Alarm
DB_ISALARM20 State is Alarm
DB_ISALARM21 State is Alarm
DB_ISALARM22 State is Alarm
DB_ISALARM23 State is Alarm
DB_ISALARM24 State is Alarm
DB_ISALARM25 State is Alarm
DB_ISALARM26 State is Alarm
DB_ISALARM27 State is Alarm
DB_ISALARM28 State is Alarm
DB_ISALARM29 State is Alarm
DB_ISALARM30 State is Alarm
DB_ISALARM31 State is Alarm
DB_ALARM_MASK Alarm BitMask
DB_MAX_ROC Maximum Rate of Change
DB_ALMACK_NET_MASK Dest. node mask for alarm ack
DB_NET_NODE_SOURCE Source node mask
DB_TAGVAL_NET_MASK Dest. node mask for values
DB_CONFIG_NET_MASK Dest. node mask for config
DB_TOTALIZER_NUM Totalization Log
DB_TRIP_NUM Trip Log
DB_RPT_NUM Report Number
DB_TOTALIZER_1_MIN Totalizer 1 min.
DB_TOTALIZER_10_MIN Totalizer 10 min.
DB_TOTALIZER_30_MIN Totalizer 30 min.
DB_TOTALIZER_1_HOUR Totalizer 1 hour
DB_TOTALIZER_8_HOUR Totalizer 8 hour
9AKK101130D1382 495
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_TOTALIZER_1_DAY Totalizer 1 day
DB_TOTALIZER_1_MONTH Totalizer 1 month
DB_TOTALIZER_1_YEAR Totalizer 1 year
DB_TOTALIZED_1_MIN Totalized 1 min.
DB_TOTALIZED_10_MIN Totalized 10 min.
DB_TOTALIZED_30_MIN Totalized 30 min.
DB_TOTALIZED_1_HOUR Totalized 1 hour
DB_TOTALIZED_8_HOUR Totalized 8 hour
DB_TOTALIZED_1_DAY Totalized 1 day
DB_TOTALIZED_1_MONTH Totalized 1 month
DB_TOTALIZED_1_YEAR Totalized 1 year.
DB_HRT_TOTSTA Totalized number of start
DB_HRT_TOTSTO Totalized number of stop
DB_HRT_TOTTON Totalized running time
DB_HRT_TOTTLR Totalized time from last reset
DB_HRT_TOTTOF Totalized stop time
DB_HRT_TOTTIN Totalized BAD quality time
DB_HRT_TOTDWN Totalized system shutdown time
DB_PLB_COMPR Playback Compression
DB_PLB_LTKEEP Long Term Playback Archive
DB_PLB_RECORD Playback Archive
DB_REL_DB Export Values to Foreign DB
DB_EXPFIL Export Values to File
DB_ZEROSTATE State 0
DB_ONESTATE State 1
DB_TWOSTATE State 2
DB_THREESTATE State 3
DB_FOURSTATE State 4
DB_FIVESTATE State 5
DB_SIXSTATE State 6
DB_SEVENSTATE State 7
DB_EIGTHSTATE State 8
496 9AKK101130D1382
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_NINESTATE State 9
DB_TENSTATE State 10
DB_ELEVNSTATE State 11
DB_TWELVSTATE State 12
DB_THTEESTATE State 13
DB_FRTEESTATE State 14
DB_FVTEESTATE State 15
DB_FB1_0STATE Feedback 1 State 0
DB_FB1_1STATE Feedback 1 State 1
DB_FB2_0STATE Feedback 2 State 0
DB_FB2_1STATE Feedback 2 State 1
DB_FB3_0STATE Feedback 3 State 0
DB_FB3_1STATE Feedback 3 State 1
DB_FB4_0STATE Feedback 4 State 0
DB_FB4_1STATE Feedback 4 State 1
DB_SET_POINT Set Point index
DB_CONTROL_POINT Control Point Index
DB_RATIO_INDEX Ratio Index
DB_STATION_STATUS Station Status Index
DB_CONSTDELTA Hourly Constancy Delta
DB_CONTROLINCDEC Increment/decrement %
DB_FASTCONTROLINCDEC Fast Inc./dec. %
DB_PLAYBACKDB Playback Deadband
DB_PLAYBACKTM Playback Timer
DB_PVCACT Alarm Active Mask
DB_INH_CHAIN Alarm Inhibition Chain
DB_CONTROL_TYPE Control Type
DB_LAST_UPDATE Last Data Base Update
DB_IS_DEFINED Tag Defined
DB_LAD_LEVEL Alarm Group Level
DB_LAD_HAS_SUBGROUP Alarm Group With Subgroups
DB_LAD_SUMMARY Alarm Group Summary
9AKK101130D1382 497
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_LOCALHOST Local Host
DB_NODEWEIGHT Node Weight
DB_QUALITYEX Current Decoded Quality
DB_COLOR_ATTRIBUTES Alarm Color Attributes
DB_ALARM_COMMENT Current Alarm Comment
DB_ANY_ALARM_COMMENT Any Alarm Comment
DB_PLANT_UNIT Plant Unit
DB_PLANT_UNIT_NAME Plant Unit Name
DB_ALMACKNL Alarm ack broad. node list
DB_OPCSRVVIS OPC Server visibility
DB_ALPRINUM Alarm printer number
DB_TAG_GUID Tag global UID
DB_TAG_GUID_SZ Tag global UID (formatted)
DB_SOE_NUM Triggered SOE number
DB_SOE_TYPE Triggered SOE type
DB_COMPRESSION_SPAN Plb compr. span (%)
DB_DEV_TYPE Device Type
DB_DEV_NUMBER Device Number
DB_DEV_NAME Device Name
DB_MODTYPE Module Type
DB_MODREV Module Rev.
DB_OTXIDX Output Transfer Tag Index
DB_OTXENB Output Transfer Enabled
DB_OPERPARAM Operating Parameter
DB_OPCPROGID OPC Program ID
DB_OPCCMPTR OPC Computer name
DB_OPCITEMID OPC Item ID
DB_OPCACCPATH OPC Access path
DB_OPCREFRESH OPC Refresh time
DB_OPCREADTYP OPC Read type
DB_OPCCLIENT Export to Client OPC
DB_OPCSERVER Export to Server OPC
498 9AKK101130D1382
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_OPCALARMSOURCE OPC Alarm Source
DB_EXTDESC Extended Description
DB_MAINT_TRIG Maintenance Trigger
DB_FIELD_AD1 Field Address 1
DB_FIELD_AD2 Field Address 2
DB_FIELD_AD3 Field Address 3
DB_FIELD_AD4 Field Address 4
DB_FIELD_AD5 Field Address 5
DB_FIELD_AD6 Field Address 6
DB_FIELD_AD7 Field Address 7
DB_FIELD_AD8 Field Address 8
DB_FIELD_AD9 Field Address 9
DB_FIELD_AD10 Field Address 10
DB_FIELD_DRV Field Driver Name
DB_FIELD_TX1 Field Drv Text 1
DB_FIELD_TX2 Field Drv Text 2
DB_FIELD_TX3 Field Drv Text 3
DB_FIELD_TX4 Field Drv Text 4
DB_FIELD_TX5 Field Drv Text 5
DB_FIELD_TX6 Field Drv Text 6
DB_FIELD_TX7 Field Drv Text 7
DB_FIELD_TX8 Field Drv Text 8
DB_FIELD_TX9 Field Drv Text 9
DB_FIELD_TX10 Field Drv Text 10
DB_DRV_INDEX Driver Index 1
DB_DRV_INDEX2 Driver Index 2
DB_DRV_INDEX3 Driver Index 3
DB_DRV_INDEX4 Driver Index 4
DB_DRV_INDEX5 Driver Index 5
DB_DRV_INDEXIN Driver Input Index
DB_DATA_PROCESSOR Data Processor Name
DB_OUT1_AD1 Output Address 1
9AKK101130D1382 499
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_OUT1_AD2 Output Address 2
DB_OUT1_AD3 Output Address 3
DB_OUT1_AD4 Output Address 4
DB_OUT1_AD5 Output Address 5
DB_OUT1_AD6 Output Address 6
DB_OUT1_AD7 Output Address 7
DB_OUT1_AD8 Output Address 8
DB_OUT1_AD9 Output Address 9
DB_OUT1_AD10 Output Address 10
DB_OUT1_DRV Output Driver Name
DB_OUT1_TX1 Output Drv Text 1
DB_OUT1_TX2 Output Drv 1 Text 2
DB_OUT1_TX3 Output Drv 1 Text 3
DB_OUT1_TX4 Output Drv 1 Text 4
DB_OUT1_TX5 Output Drv 1 Text 5
DB_OUT1_TX6 Output Drv 1 Text 6
DB_OUT1_TX7 Output Drv 1 Text 7
DB_OUT1_TX8 Output Drv 1 Text 8
DB_OUT1_TX9 Output Drv 1 Text 9
DB_OUT1_TX10 Output Drv 1 Text 10
DB_OUT2_AD1 Output 1 Address 1
DB_OUT2_AD2 Output 1 Address 2
DB_OUT2_AD3 Output 1 Address 3
DB_OUT2_AD4 Output 1 Address 4
DB_OUT2_AD5 Output 1 Address 5
DB_OUT2_AD6 Output 1 Address 6
DB_OUT2_AD7 Output 1 Address 7
DB_OUT2_AD8 Output 1 Address 8
DB_OUT2_AD9 Output 1 Address 9
DB_OUT2_AD10 Output 1 Address 10
DB_OUT2_DRV Output Driver Name
DB_OUT2_TX1 Output 2 Drv Text 1
500 9AKK101130D1382
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_OUT2_TX2 Output 2 Drv Text 2
DB_OUT2_TX3 Output 2 Drv Text 3
DB_OUT2_TX4 Output 2 Drv Text 4
DB_OUT2_TX5 Output 2 Drv Text 5
DB_OUT2_TX6 Output 2 Drv Text 6
DB_OUT2_TX7 Output 2 Drv Text 7
DB_OUT2_TX8 Output 2 Drv Text 8
DB_OUT2_TX9 Output 2 Drv Text 9
DB_OUT2_TX10 Output 2 Drv Text 10
DB_TAGGEN Generator Tag
DB_COMPONENT Component Tag
DB_FACEPLATE Faceplate
DB_FEEDBACK1 Feedback 1
DB_FEEDBACK2 Feedback 2
DB_FEEDBACK3 Feedback 3
DB_FEEDBACK4 Feedback 4
DB_AUTOMAN Auto/Manual
DB_GOODSTATE Good State
DB_REQSTATE Requested State
DB_REDTAG Red Tag
DB_PERMISSIVE1 Permissive 1
DB_PERMISSIVE2 Permissive 2
DB_ASPECT1NAM Name of Aspect #1
DB_ASPECT1CMD Command for Aspect #1
DB_ASPECT2NAM Name of Aspect #2
DB_ASPECT2CMD Command for Aspect #2
DB_ASPECT3NAM Name of Aspect #3
DB_ASPECT3CMD Command for Aspect #3
DB_ASPECT4NAM Name of Aspect #4
DB_ASPECT4CMD Command for Aspect #4
DB_ASPECT5NAM Name of Aspect #5
DB_ASPECT5CMD Command for Aspect #5
9AKK101130D1382 501
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_NUMATOMS Number of Atoms
DB_ATOM1NAM Name for Atom #1
DB_ATOM1VAL Value for Atom #1
DB_ATOM2NAM Name for Atom #2
DB_ATOM2VAL Value for Atom #2
DB_ATOM3NAM Name for Atom #3
DB_ATOM3VAL Value for Atom #3
DB_ATOM4NAM Name for Atom #4
DB_ATOM4VAL Value for Atom #4
DB_ATOM5NAM Name for Atom #5
DB_ATOM5VAL Value for Atom #5
DB_ATOM6NAM Name for Atom #6
DB_ATOM6VAL Value for Atom #6
DB_ATOM7NAM Name for Atom #7
DB_ATOM7VAL Value for Atom #7
DB_ATOM8NAM Name for Atom #8
DB_ATOM8VAL Value for Atom #8
DB_ATOM9NAM Name for Atom #9
DB_ATOM9VAL Value for Atom #9
DB_ATOM10NAM Name for Atom #10
DB_ATOM10VAL Value for Atom #10
DB_ATOM11NAM Name for Atom #11
DB_ATOM11VAL Value for Atom #11
DB_ATOM12NAM Name for Atom #12
DB_ATOM12VAL Value for Atom #12
DB_ATOM13NAM Name for Atom #13
DB_ATOM13VAL Value for Atom #13
DB_ATOM14NAM Name for Atom #14
DB_ATOM14VAL Value for Atom #14
DB_ATOM15NAM Name for Atom #15
DB_ATOM15VAL Value for Atom #15
DB_ATOM16NAM Name for Atom #16
502 9AKK101130D1382
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_ATOM16VAL Value for Atom #16
DB_ATOM17NAM Name for Atom #17
DB_ATOM17VAL Value for Atom #17
DB_ATOM18NAM Name for Atom #18
DB_ATOM18VAL Value for Atom #18
DB_ATOM19NAM Name for Atom #19
DB_ATOM19VAL Value for Atom #19
DB_ATOM20NAM Name for Atom #20
DB_ATOM20VAL Value for Atom #20
DB_ATOM21NAM Name for Atom #21
DB_ATOM21VAL Value for Atom #21
DB_ATOM22NAM Name for Atom #22
DB_ATOM22VAL Value for Atom #22
DB_ATOM23NAM Name for Atom #23
DB_ATOM23VAL Value for Atom #23
DB_ATOM24NAM Name for Atom #24
DB_ATOM24VAL Value for Atom #24
DB_ATOM25NAM Name for Atom #25
DB_ATOM25VAL Value for Atom #25
DB_ATOM26NAM Name for Atom #26
DB_ATOM26VAL Value for Atom #26
DB_ATOM27NAM Name for Atom #27
DB_ATOM27VAL Value for Atom #27
DB_ATOM28NAM Name for Atom #28
DB_ATOM28VAL Value for Atom #28
DB_ATOM29NAM Name for Atom #29
DB_ATOM29VAL Value for Atom #29
DB_ATOM30NAM Name for Atom #30
DB_ATOM30VAL Value for Atom #30
DB_ATOM31NAM Name for Atom #31
DB_ATOM31VAL Value for Atom #31
DB_ATOM32NAM Name for Atom #32
9AKK101130D1382 503
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_ATOM32VAL Value for Atom #32
DB_ATOM33NAM Name for Atom #33
DB_ATOM33VAL Value for Atom #33
DB_ATOM34NAM Name for Atom #34
DB_ATOM34VAL Value for Atom #34
DB_ATOM35NAM Name for Atom #35
DB_ATOM35VAL Value for Atom #35
DB_ATOM36NAM Name for Atom #36
DB_ATOM36VAL Value for Atom #36
DB_ATOM37NAM Name for Atom #37
DB_ATOM37VAL Value for Atom #37
DB_ATOM38NAM Name for Atom #38
DB_ATOM38VAL Value for Atom #38
DB_ATOM39NAM Name for Atom #39
DB_ATOM39VAL Value for Atom #39
DB_ATOM40NAM Name for Atom #40
DB_ATOM40VAL Value for Atom #40
DB_ATOM41NAM Name for Atom #41
DB_ATOM41VAL Value for Atom #41
DB_ATOM42NAM Name for Atom #42
DB_ATOM42VAL Value for Atom #42
DB_ATOM43NAM Name for Atom #43
DB_ATOM43VAL Value for Atom #43
DB_ATOM44NAM Name for Atom #44
DB_ATOM44VAL Value for Atom #44
DB_ATOM45NAM Name for Atom #45
DB_ATOM45VAL Value for Atom #45
DB_ATOM46NAM Name for Atom #46
DB_ATOM46VAL Value for Atom #46
DB_ATOM47NAM Name for Atom #47
DB_ATOM47VAL Value for Atom #47
DB_ATOM48NAM Name for Atom #48
504 9AKK101130D1382
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_ATOM48VAL Value for Atom #48
DB_ATOM49NAM Name for Atom #49
DB_ATOM49VAL Value for Atom #49
DB_ATOM50NAM Name for Atom #50
DB_ATOM50VAL Value for Atom #50
DB_ATOM51NAM Name for Atom #51
DB_ATOM51VAL Value for Atom #51
DB_ATOM52NAM Name for Atom #52
DB_ATOM52VAL Value for Atom #52
DB_ATOM53NAM Name for Atom #53
DB_ATOM53VAL Value for Atom #53
DB_ATOM54NAM Name for Atom #54
DB_ATOM54VAL Value for Atom #54
DB_ATOM55NAM Name for Atom #55
DB_ATOM55VAL Value for Atom #55
DB_ATOM56NAM Name for Atom #56
DB_ATOM56VAL Value for Atom #56
DB_ATOM57NAM Name for Atom #57
DB_ATOM57VAL Value for Atom #57
DB_ATOM58NAM Name for Atom #58
DB_ATOM58VAL Value for Atom #58
DB_ATOM59NAM Name for Atom #59
DB_ATOM59VAL Value for Atom #59
DB_ATOM60NAM Name for Atom #60
DB_ATOM60VAL Value for Atom #60
DB_ATOM61NAM Name for Atom #61
DB_ATOM61VAL Value for Atom #61
DB_ATOM62NAM Name for Atom #62
DB_ATOM62VAL Value for Atom #62
DB_ATOM63NAM Name for Atom #63
DB_ATOM63VAL Value for Atom #63
DB_ATOM64NAM Name for Atom #64
9AKK101130D1382 505
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_ATOM64VAL Value for Atom #64
DB_ATOM65NAM Name for Atom #65
DB_ATOM65VAL Value for Atom #65
DB_ATOM66NAM Name for Atom #66
DB_ATOM66VAL Value for Atom #66
DB_ATOM67NAM Name for Atom #67
DB_ATOM67VAL Value for Atom #67
DB_ATOM68NAM Name for Atom #68
DB_ATOM68VAL Value for Atom #68
DB_ATOM69NAM Name for Atom #69
DB_ATOM69VAL Value for Atom #69
DB_ATOM70NAM Name for Atom #70
DB_ATOM70VAL Value for Atom #70
DB_ATOM71NAM Name for Atom #71
DB_ATOM71VAL Value for Atom #71
DB_ATOM72NAM Name for Atom #72
DB_ATOM72VAL Value for Atom #72
DB_ATOM73NAM Name for Atom #73
DB_ATOM73VAL Value for Atom #73
DB_ATOM74NAM Name for Atom #74
DB_ATOM74VAL Value for Atom #74
DB_ATOM75NAM Name for Atom #75
DB_ATOM75VAL Value for Atom #75
DB_ATOM76NAM Name for Atom #76
DB_ATOM76VAL Value for Atom #76
DB_ATOM77NAM Name for Atom #77
DB_ATOM77VAL Value for Atom #77
DB_ATOM78NAM Name for Atom #78
DB_ATOM78VAL Value for Atom #78
DB_ATOM79NAM Name for Atom #79
DB_ATOM79VAL Value for Atom #79
DB_ATOM80NAM Name for Atom #80
506 9AKK101130D1382
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_ATOM80VAL Value for Atom #80
DB_ATOM81NAM Name for Atom #81
DB_ATOM81VAL Value for Atom #81
DB_ATOM82NAM Name for Atom #82
DB_ATOM82VAL Value for Atom #82
DB_ATOM83NAM Name for Atom #83
DB_ATOM83VAL Value for Atom #83
DB_ATOM84NAM Name for Atom #84
DB_ATOM84VAL Value for Atom #84
DB_ATOM85NAM Name for Atom #85
DB_ATOM85VAL Value for Atom #85
DB_ATOM86NAM Name for Atom #86
DB_ATOM86VAL Value for Atom #86
DB_ATOM87NAM Name for Atom #87
DB_ATOM87VAL Value for Atom #87
DB_ATOM88NAM Name for Atom #88
DB_ATOM88VAL Value for Atom #88
DB_ATOM89NAM Name for Atom #89
DB_ATOM89VAL Value for Atom #89
DB_ATOM90NAM Name for Atom #90
DB_ATOM90VAL Value for Atom #90
DB_ATOM91NAM Name for Atom #91
DB_ATOM91VAL Value for Atom #91
DB_ATOM92NAM Name for Atom #92
DB_ATOM92VAL Value for Atom #92
DB_ATOM93NAM Name for Atom #93
DB_ATOM93VAL Value for Atom #93
DB_ATOM94NAM Name for Atom #94
DB_ATOM94VAL Value for Atom #94
DB_ATOM95NAM Name for Atom #95
DB_ATOM95VAL Value for Atom #95
DB_ATOM96NAM Name for Atom #96
9AKK101130D1382 507
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_ATOM96VAL Value for Atom #96
DB_ATOM97NAM Name for Atom #97
DB_ATOM97VAL Value for Atom #97
DB_ATOM98NAM Name for Atom #98
DB_ATOM98VAL Value for Atom #98
DB_ATOM99NAM Name for Atom #99
DB_ATOM99VAL Value for Atom #99
DB_ATOM100NAM Name for Atom #100
DB_ATOM100VAL Value for Atom #100
DB_ATOM1TYP Type of Atom #1
DB_ATOM2TYP Type of Atom #2
DB_ATOM3TYP Type of Atom #3
DB_ATOM4TYP Type of Atom #4
DB_ATOM5TYP Type of Atom #5
DB_ATOM6TYP Type of Atom #6
DB_ATOM7TYP Type of Atom #7
DB_ATOM8TYP Type of Atom #8
DB_ATOM9TYP Type of Atom #9
DB_ATOM10TYP Type of Atom #10
DB_ATOM11TYP Type of Atom #11
DB_ATOM12TYP Type of Atom #12
DB_ATOM13TYP Type of Atom #13
DB_ATOM14TYP Type of Atom #14
DB_ATOM15TYP Type of Atom #15
DB_ATOM16TYP Type of Atom #16
DB_ATOM17TYP Type of Atom #17
DB_ATOM18TYP Type of Atom #18
DB_ATOM19TYP Type of Atom #19
DB_ATOM20TYP Type of Atom #20
DB_ATOM21TYP Type of Atom #21
DB_ATOM22TYP Type of Atom #22
DB_ATOM23TYP Type of Atom #23
508 9AKK101130D1382
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_ATOM24TYP Type of Atom #24
DB_ATOM25TYP Type of Atom #25
DB_ATOM26TYP Type of Atom #26
DB_ATOM27TYP Type of Atom #27
DB_ATOM28TYP Type of Atom #28
DB_ATOM29TYP Type of Atom #29
DB_ATOM30TYP Type of Atom #30
DB_ATOM31TYP Type of Atom #31
DB_ATOM32TYP Type of Atom #32
DB_ATOM33TYP Type of Atom #33
DB_ATOM34TYP Type of Atom #34
DB_ATOM35TYP Type of Atom #35
DB_ATOM36TYP Type of Atom #36
DB_ATOM37TYP Type of Atom #37
DB_ATOM38TYP Type of Atom #38
DB_ATOM39TYP Type of Atom #39
DB_ATOM40TYP Type of Atom #40
DB_ATOM41TYP Type of Atom #41
DB_ATOM42TYP Type of Atom #42
DB_ATOM43TYP Type of Atom #43
DB_ATOM44TYP Type of Atom #44
DB_ATOM45TYP Type of Atom #45
DB_ATOM46TYP Type of Atom #46
DB_ATOM47TYP Type of Atom #47
DB_ATOM48TYP Type of Atom #48
DB_ATOM49TYP Type of Atom #49
DB_ATOM50TYP Type of Atom #50
DB_ATOM51TYP Type of Atom #51
DB_ATOM52TYP Type of Atom #52
DB_ATOM53TYP Type of Atom #53
DB_ATOM54TYP Type of Atom #54
DB_ATOM55TYP Type of Atom #55
9AKK101130D1382 509
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_ATOM56TYP Type of Atom #56
DB_ATOM57TYP Type of Atom #57
DB_ATOM58TYP Type of Atom #58
DB_ATOM59TYP Type of Atom #59
DB_ATOM60TYP Type of Atom #60
DB_ATOM61TYP Type of Atom #61
DB_ATOM62TYP Type of Atom #62
DB_ATOM63TYP Type of Atom #63
DB_ATOM64TYP Type of Atom #64
DB_ATOM65TYP Type of Atom #65
DB_ATOM66TYP Type of Atom #66
DB_ATOM67TYP Type of Atom #67
DB_ATOM68TYP Type of Atom #68
DB_ATOM69TYP Type of Atom #69
DB_ATOM70TYP Type of Atom #70
DB_ATOM71TYP Type of Atom #71
DB_ATOM72TYP Type of Atom #72
DB_ATOM73TYP Type of Atom #73
DB_ATOM74TYP Type of Atom #74
DB_ATOM75TYP Type of Atom #75
DB_ATOM76TYP Type of Atom #76
DB_ATOM77TYP Type of Atom #77
DB_ATOM78TYP Type of Atom #78
DB_ATOM79TYP Type of Atom #79
DB_ATOM80TYP Type of Atom #80
DB_ATOM81TYP Type of Atom #81
DB_ATOM82TYP Type of Atom #82
DB_ATOM83TYP Type of Atom #83
DB_ATOM84TYP Type of Atom #84
DB_ATOM85TYP Type of Atom #85
DB_ATOM86TYP Type of Atom #86
DB_ATOM87TYP Type of Atom #87
510 9AKK101130D1382
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_ATOM88TYP Type of Atom #88
DB_ATOM89TYP Type of Atom #89
DB_ATOM90TYP Type of Atom #90
DB_ATOM91TYP Type of Atom #91
DB_ATOM92TYP Type of Atom #92
DB_ATOM93TYP Type of Atom #93
DB_ATOM94TYP Type of Atom #94
DB_ATOM95TYP Type of Atom #95
DB_ATOM96TYP Type of Atom #96
DB_ATOM97TYP Type of Atom #97
DB_ATOM98TYP Type of Atom #98
DB_ATOM99TYP Type of Atom #99
DB_ATOM100TYP Type of Atom #100
DB_ATOM1DESC Description for Atom #1
DB_ATOM2DESC Description for Atom #2
DB_ATOM3DESC Description for Atom #3
DB_ATOM4DESC Description for Atom #4
DB_ATOM5DESC Description for Atom #5
DB_ATOM6DESC Description for Atom #6
DB_ATOM7DESC Description for Atom #7
DB_ATOM8DESC Description for Atom #8
DB_ATOM9DESC Description for Atom #9
DB_ATOM10DESC Description for Atom #10
DB_ATOM11DESC Description for Atom #11
DB_ATOM12DESC Description for Atom #12
DB_ATOM13DESC Description for Atom #13
DB_ATOM14DESC Description for Atom #14
DB_ATOM15DESC Description for Atom #15
DB_ATOM16DESC Description for Atom #16
DB_ATOM17DESC Description for Atom #17
DB_ATOM18DESC Description for Atom #18
DB_ATOM19DESC Description for Atom #19
9AKK101130D1382 511
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_ATOM20DESC Description for Atom #20
DB_ATOM21DESC Description for Atom #21
DB_ATOM22DESC Description for Atom #22
DB_ATOM23DESC Description for Atom #23
DB_ATOM24DESC Description for Atom #24
DB_ATOM25DESC Description for Atom #25
DB_ATOM26DESC Description for Atom #26
DB_ATOM27DESC Description for Atom #27
DB_ATOM28DESC Description for Atom #28
DB_ATOM29DESC Description for Atom #29
DB_ATOM30DESC Description for Atom #30
DB_ATOM31DESC Description for Atom #31
DB_ATOM32DESC Description for Atom #32
DB_ATOM33DESC Description for Atom #33
DB_ATOM34DESC Description for Atom #34
DB_ATOM35DESC Description for Atom #35
DB_ATOM36DESC Description for Atom #36
DB_ATOM37DESC Description for Atom #37
DB_ATOM38DESC Description for Atom #38
DB_ATOM39DESC Description for Atom #39
DB_ATOM40DESC Description for Atom #40
DB_ATOM41DESC Description for Atom #41
DB_ATOM42DESC Description for Atom #42
DB_ATOM33DESC Description for Atom #43
DB_ATOM44DESC Description for Atom #44
DB_ATOM45DESC Description for Atom #45
DB_ATOM46DESC Description for Atom #46
DB_ATOM47DESC Description for Atom #47
DB_ATOM48DESC Description for Atom #48
DB_ATOM49DESC Description for Atom #49
DB_ATOM50DESC Description for Atom #50
DB_ATOM51DESC Description for Atom #51
512 9AKK101130D1382
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_ATOM52DESC Description for Atom #52
DB_ATOM53DESC Description for Atom #53
DB_ATOM54DESC Description for Atom #54
DB_ATOM55DESC Description for Atom #55
DB_ATOM56DESC Description for Atom #56
DB_ATOM57DESC Description for Atom #57
DB_ATOM58DESC Description for Atom #58
DB_ATOM59DESC Description for Atom #59
DB_ATOM60DESC Description for Atom #60
DB_ATOM31DESC Description for Atom #61
DB_ATOM62DESC Description for Atom #62
DB_ATOM63DESC Description for Atom #63
DB_ATOM64DESC Description for Atom #64
DB_ATOM65DESC Description for Atom #65
DB_ATOM66DESC Description for Atom #66
DB_ATOM67DESC Description for Atom #67
DB_ATOM68DESC Description for Atom #68
DB_ATOM69DESC Description for Atom #69
DB_ATOM70DESC Description for Atom #70
DB_ATOM71DESC Description for Atom #71
DB_ATOM72DESC Description for Atom #72
DB_ATOM73DESC Description for Atom #73
DB_ATOM74DESC Description for Atom #74
DB_ATOM75DESC Description for Atom #75
DB_ATOM76DESC Description for Atom #76
DB_ATOM77DESC Description for Atom #77
DB_ATOM78DESC Description for Atom #78
DB_ATOM79DESC Description for Atom #79
DB_ATOM80DESC Description for Atom #80
DB_ATOM81DESC Description for Atom #81
DB_ATOM82DESC Description for Atom #82
DB_ATOM83DESC Description for Atom #83
9AKK101130D1382 513
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_ATOM84DESC Description for Atom #84
DB_ATOM85DESC Description for Atom #85
DB_ATOM86DESC Description for Atom #86
DB_ATOM87DESC Description for Atom #87
DB_ATOM88DESC Description for Atom #88
DB_ATOM89DESC Description for Atom #89
DB_ATOM90DESC Description for Atom #90
DB_ATOM91DESC Description for Atom #91
DB_ATOM92DESC Description for Atom #92
DB_ATOM93DESC Description for Atom #93
DB_ATOM94DESC Description for Atom #94
DB_ATOM95DESC Description for Atom #95
DB_ATOM96DESC Description for Atom #96
DB_ATOM97DESC Description for Atom #97
DB_ATOM98DESC Description for Atom #98
DB_ATOM99DESC Description for Atom #99
DB_ATOM100DESC Description for Atom #100
DB_APP2 Quality Status: APP2
DB_APP1 Quality Status: APP1
DB_HCFV Quality Status: HCFV
DB_RTAG Quality Status: RTAG
DB_APP3 Quality Status: APP3
DB_BAD Quality Status: BAD
DB_B9 Quality Status: B9
DB_ALIA Quality Status: ALIA
DB_ALIN Quality Status: ALIN
DB_INSV Quality Status: INSV
DB_EVT Quality Status: EVT
DB_OFSC Quality Status: OFSC
DB_OLDD Quality Status: OLDD
DB_ALRM Quality Status: ALRM
DB_UNAK Quality Status: UNAK
514 9AKK101130D1382
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_IMP Quality Status: IMP
DB_DUMM Quality Status: DUMM
DB_AM Quality Status: AM
DB_SLAV Quality Status: SLAV
DB_SHAV Quality Status: SHAV
DB_TRAK Quality Status: TRAK
DB_I4 Quality Status: I4
DB_LDEV Quality Status: LDEV
DB_HDEV Quality Status: HDEV
DB_DROC Quality Status: DROC
DB_IROC Quality Status: IROC
DB_LIRV Quality Status: LIRV
DB_LLAV Quality Status: LLAV
DB_LAV Quality Status: LAV
DB_HAV Quality Status: HAV
DB_HHAV Quality Status: HHAV
DB_HIRV Quality Status: HIRV
DB_CONVCODE Conversion Code
DB_CONVCODESTR Conversion Code String
DB_CONVMIN Conversion Min
DB_CONVMAX Conversion Max
DB_CONVOFFS Conversion Offset
DB_ALRMCTXT1 RTN Alarm Comment
DB_ALRMCTXT2 High Alarm Comment
DB_ALRMCTXT3 Low Alarm Comment
DB_ALRMCTXT4 2-high Alarm Comment
DB_ALRMCTXT5 2-low Alarm Comment
DB_ALRMCTXT6 3-high Alarm Comment
DB_ALRMCTXT7 3-low Alarm Comment
DB_ALRMCTXT8 H dev Alarm Comment
DB_ALRMCTXT9 L dev Alarm Comment
DB_ALRMCTXT10 H roc Alarm Comment
9AKK101130D1382 515
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_ALRMCTXT11 L roc Alarm Comment
DB_ALRMCTXT12 Status Chg Alarm Comment
DB_ALRMCTXT13 HCF Alarm Comment
DB_ALPRI_DEF Default Alarm Priority
DB_ALPRI_RTN Alarm Priority: RTN
DB_ALPRI_H Alarm Priority: H
DB_ALPRI_L Alarm Priority: L
DB_ALPRI_2H Alarm Priority: 2H
DB_ALPRI_2L Alarm Priority: 2L
DB_ALPRI_3H Alarm Priority: 3H
DB_ALPRI_3L Alarm Priority: 3L
DB_ALPRI_HDEV Alarm Priority: HDEV
DB_ALPRI_LDEV Alarm Priority: LDEV
DB_ALPRI_HROC Alarm Priority: HROC
DB_ALPRI_LROC Alarm Priority: LROC
DB_ALPRI_STCH Alarm Priority: STCH
DB_ALPRI_HCF Alarm Priority: BAD
DB_SNAP_ALIGN Node mask for snap align.
DB_CNF_ALIGN Node mask for cnf align
DB_OJ_ALIGN Node mask for OJ align
DB_PLB_ALIGN Node mask for plb align
DB_HIST_ALIGN Node mask for hist align
DB_GRP_TYPE_ARCH Archive Type
DB_GRP_TIMESPAN Time Span
DB_GRP_HIST_TYPE Archive Hist. Type
DB_GRP_ARCHFREQ Archive Frequency
DB_GRP_ARCHOFFSET Archive Offset
DB_GRP_SAMPFREQ Sample Frequency
DB_GRP_DISPFREQ Display Frequency
DB_GRP_ISDERIVED Derived Group
DB_GRP_INPGROUP Input Group
DB_GRP_NUMTAGS # of Tags
516 9AKK101130D1382
Table 161. Tag Configuration Retrieving Parameters.
Parameter Description
DB_GRP_TOTSAMP # of Archive Samples
DB_GRP_PRE_TRIP Pre-trip Time
DB_GRP_POST_TRIP Post-trip Time
DB_GRP_ARCH_END_TIME Archive End Time
DB_GRP_ARCH_START_TIME Archive Start Time
DB_GRP_CLASS Group Class
DB_GRP_CLOSE_TRIP Close trip on return
DB_GRP_CURVE_TYPE Curve Type
DB_GRP_INITMODE Initial Presentation Mode
DB_GRP_FRAMECOL Trend Frame Color
DB_GRP_BORDERCOL Trend Border Color
DB_GRP_GRIDCOL Trend Grid Color
DB_GRP_TEXTCOL Trend Text Color
DB_GRP_DRAWMODE Trend Draw Mode
DB_GRP_LISTMODE Trend List Mode
DB_GRP_LISTMODE Trend List Mode
DB_GRP_XLSFILE Report file name
DB_GRP_VIEWER Group viewer program
DB_USR_PASSWEXPIRED User Password Expired
DB_USR_PASSWAGING User Password Aging
DB_USR_LANGUAGE User Language
DB_USR_LOGINDISPLAY User Login Display
DB_USR_LOGINPROG User Login Program
DB_USR_LOGOUTDISPLAY User Logout Display
DB_USR_LOGOUTPROG User Logout Program
DB_USR_CODE User Payroll Code
DB_USR_PASSWCHANGED User Password Changed
DB_USR_ACTIVE User Active
DB_USR_CRTMASK Mask of user allowed CRT
DB_RESERVED_BY_USER Reserved for Command by User
DB_IS_LOCAL_SOURCE This node is Local source for the tag
DB_ROWCOUNT Row Count for Alarm retrieval
9AKK101130D1382 517
Gas Index Table and Gas Molecular Weight
Table 162. Gas Index Table - Gas Molecular Weight.
Index Gas Chemical Formula Molecular Weight
1 Hydrogen H2 2.016
2 Carbon monoxide CO 28.010
3 Methane CH4 16.043
4 Acetylene (Ethyne) C2H2 26.038
5 Ethylene C2H4 28.054
6 Ethane C2H6 30.070
7 Propane C3H8 44.097
8 N-Butane C4H10-N 58.124
9 Iso-Butane C4H10-I 58.124
10 N-Pentane C5H12-N 72.151
11 Neohexane C6H14 86.178
12 Hydrogen sulfide H2S 34.080
13 Carbon dioxide CO2 44.010
14 Oxygen O2 31.999
15 Water H2O 18.015
16 Sulfur dioxide SO2 64.063
17 Nitrogen N2 28.016
18 Argon Ar 39.948
19 Air Air 28.959
518 9AKK101130D1382
Table 163. Item Types for Field Assignment.
Symbol Code Description
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.
9AKK101130D1382 519
Word Offset Prefixes
Table 164. Word Offset Prefixes.
Prefix Database
LA_ Audible tones database and alarm grouping database.
LC_ Calculation database.
Tag related databases (Engineering Units, Logic State Descriptors, Alarm
LG_
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.
Field Types
Table 165. Field Types.
Type Code
DT_CHAR 1
DT_VARCHAR 2
DT_LONGVARCHAR 3
DT_BIT 4
DT_TINYINT 5
DT_SMALLINT 6
DT_INTEGER 7
DT_BIGINT 8
DT_DECIMAL 9
DT_NUMERIC 10
DT_REAL 11
DT_DOUBLE 12
520 9AKK101130D1382
Table 165. Field Types.
Type Code
DT_FLOAT 13
DT_DATE 14
DT_TIME 15
DT_TIMESTAMP 16
DT_BINARY 17
DT_VARBINARY 18
DT_LONGVBINARY 19
9AKK101130D1382 521
Alarm Types
Table 166. Alarm Types.
Code Symbol Description
1 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 alarm
21 ALERCN Decreasing rate of change alarm
22 ALEHDV High deviation alarm.
23 ALELDV Low deviation alarm.
24 ALEHCF Hardware channel failure.
25 ALEALA Generic alarm.
40 ALEVOT Voting alarm (reserved).
41 ALEMUL
42 ALERTM
43 ALEOPR
44 ALELST
522 9AKK101130D1382
Dynamic Symbol Table
Table 167. Dynamic Symbol Table.
Code Symbol Description
1 A_NAME Tag name
2 A_DESC Tag description
3 A_INDX Tag index
4 A_CUST Customer tag id (plant tag name)
5 A_GROU Alarm group
6 A_PRIO Alarm priority
7 A_EU EU descriptor
8 A_CMNT Alarm comment (buffer, 2W value + 2W quality)
9 A_ITMT Item type
10 A_ITMN Item number
11 A_VAL Value (buffer, 2W value + 2W quality)
12 A_VALQ Value and quality (buffer, 2W value + 2W quality)
13 A_STAT Status (buffer, 2W value + 2W quality)
14 A_STAQ Status and quality (buffer, 2W value + 2W quality)
15 A_TIME Time
16 A_DATE Date
17 A_DATI Date and Time
18 A_HTIM Historical time (buffer, 2W)
19 A_HDAT Historical date (buffer, 2W)
20 A_HDTI Historical date and time (buffer, 2W)
21 A_OPER Operator name (buffer, 1W)
22 A_CANC Cancode parameter (buffer, n/3 W)
23 A_ASCI Ascii parameter (buffer, n/2 W)
24 A_REAL Real parameter (buffer, 2W)
25 A_LONG Long integer parameter (buffer, 2W)
26 A_INTE Short integer parameter (buffer, 1W)
27 A_HEXL Long integer (hex) parameter (buffer, 2W)
28 A_HEXA Short integer (hex) parameter (buffer, 1W)
29 A_YENO Yes (1) / Not (0) (buffer, 1W)
30 A_TUTS Timer units (buffer, 1W)
9AKK101130D1382 523
Table 167. Dynamic Symbol Table.
Code Symbol Description
31 A_NREF Item number referenced (buffer, 4W)
32 A_EDSC Extended description
33 A_NODE Local node name
34 A_QUAL Tag quality
35 A_PROD Product name
36 A_SKVL Skip value
37 A_BKVL Backward Skip value
38 A_DBXF Data Base Reference
39 A_UTX1 Text from OPC AE (1)
40 A_UTX2 Text from OPC AE (2)
41 A_UTX3 Text from OPC AE (3)
42 A_UTX4 Text from OPC AE (4)
43 A_UTX5 Text from OPC AE (5)
44 A_CHAR Plain ASCII text (non UNICODE Compliant)
524 9AKK101130D1382
Data Processor file
Following an example of a DataProcessor.XML file to define a specific macro with
atoms and a table to describe the syntax.
<?xml version="1.0" ?>
<AC450>
<!-- Comment -->
<MACRO name="CFG" separator=":" mainatom="VALUE_TREAT"
type="INTEGER">
<ATOM name="Alarm" descr="Status byte 1" type="BOOL" />
<ATOM name="ALARM_BLK" descr="Status byte 2" type="BOOL" />
<ATOM name="ALARM_PERIOD_BLK" descr="Status byte 2" type="BOOL" />
</MACRO>
</AC450>
9AKK101130D1382 525
Table 168. DataProcessor file - XML structure.
Element Item Description
Identifies the section of the xml file to specify the object
MACRO
type (including the list of the atoms of the type)
Name of the type specified in the DataProcessor field in
name the data base of the tag (for example
AC450.Block.XmlFileName.CFG)
separator Character separator of the OPC items
Used to identify the name of the atom that will be used by
mainatom
PGP as main
Tagtype used in the PGP database. Accepted values:
type
DIGITAL, ANALOG, INTEGER
Identifies the section to specify the name and the
ATOM
attributes of the atoms in the macro
name Atom name
descr Atom description
Canonical OPC item type (like distribuited by OPC
type server) Accepted values: BOOL, INTEGER, DINT, REAL,
STRn (where n is the number of characters in the string)
526 9AKK101130D1382
Appendix B AC800F Support
Overview
Traditionally, in order to connect the AC800F to third-party operator
interface systems, a PLC File (.plc extension) is exported from AC800F
configuration tools and converted by the third-party system.
The PLC file can be considered as a partial representation of the AC800F
configuration. Parsing of such file makes it possible to access the PLC
objects implemented by the AC800F software configuration tools.
Notice that formerly the AC800F was named Freelance; reference to the
former name is found in the PGP interface
The PGP PLC File Builder is able to parse the AC800F generated PLC file
and to automatically configure the PGP internal database by building a
temporary PGP database (.dbf extension) containing some of the AC800Fs
PLC objects (Function Blocks and Variables only).
The data communication between the PGP and AC800F is implemented
using the OPC (Ole for Process Control) industry standard.
During PLC File parsing, the PLC File Builder selects and builds ONLY
the above described PLC objects exported by AC800F via OPC.
Functionalities
The PLC File Builder is an application (the process name is
PlcFileBuilder.exe located in the PGP\Bin folder) that operates using the
following three main steps:
9AKK101130D1382 527
PARSING.
It parses the specified PLC File first, listing all the OPC gateway stations
found (See the AC800F manuals for information about gateway station
definition).
CREATE DB.
After parsing, a temporary database is created that corresponds to the
selected OPC gateway.
Selected, or checked OPC gateways are discussed in the following
sections.
The database name is created from the gateway name with the suffix
_tmp.
For example, if the gateway name is OPC1, then the database name
will be OPC1_tmp.dbf.
BUILDING.
After database creation, the database is imported in to the PGP system.
There is no need to close the database before importing.
The PGP PLC File Builder temporarily stores some needed information in an
XML format. It also uses some additional information permanantly stored in
the same format.
The PLC File Builder creates (and optionally removes) the temporary
database (.dbf extension) file and locates it in the usual PGP\Config\Tag
folder.
Be sure that a your own database file named <Gateway name>_tmp.dbf
does not already exist in the folder. If it does, then the PLC File Builder
will overwrite the existing file without checking. Any previously stored
information will be lost.
If a large amount of information is retrieved during parsing, the Builder can
store the information in more than one XML file. This reduces the size of
528 9AKK101130D1382
each XML file, which can improve performance during the processing of
these files. This feature is only available for one checked OPC gateway.
Selected, or checked OPC gateways are discussed in the following
sections.
The Builder stores and uses some informations stored in the following XML
format files:
Plc File parsing results xml file/s
FreelanceTemplate.xml
DBHeader.xml
Correspondences.xml
9AKK101130D1382 529
FreelanceTemplate.xml (Temporary File)
PGP needs some mandatory information and parameters to later get the
OPC data from the AC800F OPC server (e.g. the tag name, the OPC server
name, the computer name and so on) and some further specific information
and parameters retrieved from the PLC file and concerning the PLCs
objects (e.g. the tag description).
As an example, PGP identifies a tag by a tag name, a database field named
TAGNAME retains this information. The value to be assigned to this field will
be retrieved from the PLC file. Each tag is defined within the
FreelanceTemplate file by all required PGP database fields names and the
corresponding values retrieved from the PLC file. The Builder uses such file
to fill in a temporary PGP database file (Freelance_tmp.dbf is the default
name) containing all the Freelance OPC objects.
This file is stored in the directory designated as location for temporary files
(the complete path is listed in the Messages window at the bottom of the
Builder display). It is removed when the application is closed.
Before closing the application (i.e. before the file is destroyed), the XML file
can be explored to check PLC parsing result using any XML editor.
530 9AKK101130D1382
Correspondences.xml (Persistent File)
This file contains all the correspondences between the specific PGP field
name and the specific AC800F parameter. As an example, the AC800F tag
name IDF_1 is contained in the MSRNAME parameter of a AC800F
Function Block and it is assigned to the TAGNAME field of the PGP
database.
Hence, this file stores the link or correspondence between MSRNAME and
TAGNAME. In this way, the Builder is able to get the value (e.g. IDF_1 or
M_ANA) of the MSRNAME parameter and associate it to the TAGNAME
field of the previously described sample tag in order to finally compile the
temporary FreelanceTemplate.xml file.
This persistent file is stored in the PGP\Deck folder (the complete path is
listed in the Messages window at the bottom of the Builder display).
Any XML editor can be used to explore the file.
9AKK101130D1382 531
Starting-up the PLC File Builder
Running the application an interface window is opened as shown below.
At this time, all buttons are disabled except the OK and Open PLC File ones.
532 9AKK101130D1382
Open a PLC File
Clicking on the Open PLC File button a typical browsing window for
selecting the PLC file is opened as shown in Figure 46.
After the PLC file has been selected and opened, the PLC File Builder
immediately starts parsing the file.
In the AC800F OPC Gateways window, all the OPC gateways found are
listed (see Figure 47).
9AKK101130D1382 533
Figure 47. Create the PLC File
The PLC File Builder allows you to select multiple OPC gateways. Note
however, that in this case multiple temporary database files will be
created. The same information may be present in multiple files. You must
be careful when managing and building these files.
Since the PGP typically runs on the same machine as the OPC gateway, the
PLC File Builder automatically checks the gateway corresponding to the
local machine.
534 9AKK101130D1382
In this example, two opc gateways have been defined in the opened plc file
and, for some reason, the IP addresses have not been resolved
successfully with the corresponding host names.
9AKK101130D1382 535
As described previously, the PlcFileBuilder create as many databases as
the number of the OPC gateways defined in the .plc file. By double-clicking
on the listed gateway, the window below will appear:
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
9AKK101130D1382 537
"OPC1". We have repeated similar settings for gateway "OPC2" and
created the databases:
Note:
1.you are able to set a computer name (and the "Alias.xml" file will be
updated accordingly) and such name will be retrieved later by the opc client
and used for connection to server.
2.you can set the initial tag index for each gateway but the PlcFileBuilder
does not make any check or notification about common indexes among
different temporary databases. In the example above, let's suppose 1500
tags be defined for both the gateways. If the initial tag index has been set to
1000 and to 2000 for gateways "OPC1" and "OPC2" respectively, the
indexes range in "OPC1_tmp.dbf" will be [1000,2500] and in
"OPC2_tmp.dbf" will be [2000,3500]. This means that indexes from 2000 to
2500 will result common to both databases and you must take care yourself
538 9AKK101130D1382
about the appropriate initial index value to set in order to avoid having
common indexes.
3.The "Tagindex" column is included in the temporary database. If you don't
set any initial index, all indexes will be set to "0" the first time (CBF tags not
imported yet in PGP). After importing, the index value will be retrieved
directly from PGP (for all the tags already imported in PGP).
9AKK101130D1382 539
Build a PLC File
If an OPC gateway is checked, the following actions can be initiated
CREATE.
The temporary PGP database file containing the AC800F OPC objects is
created in the default PGP folder (PGP\Config\tag).
BUILD.
The temporary PGP database is processed. That means that all data
configured and associated to the OPC gateway will be automatically
configured on the PGP without having to close it.
The build operation doesnt initialize the PGP database, therefore any
other tags previously configured in the PGP (tags referring to other 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.
9AKK101130D1382 541
Then, after building, the Builder scans the PGP internal database and
checks if each AC800F tag in the PGP database is going to be re-built.
If a AC800F tag in the PGP database is not managed by the PLC File
Builder, such a tag is considered unused. That means, it is no longer in the
AC800F Configuration Project, but it is still configured in the PGP database.
Such a tag can manually be removed from the PGP database. It is NOT
automatically removed.
In order to find out the "Unused Tags", in the PGP database, the
PlcFileBuilder application "marks" optionally these tags by adding a "?"
character at the end of the string stored in the "User3" PGP database field.
This is done after the optional UnBuild operation and therefore the updated
field doesn't appear in the current exported database
(TAGS_19_06_2001_12_09.dbf in the above example).
The Builder displays all such unused tags in the Messages window at
runtime. See the Messages window and Log File sections for further
explanations about.
542 9AKK101130D1382
You can keep the temporary database files by clearing the Remove
Temporary databases option.
Figure 49.
9AKK101130D1382 543
Messages window
All the messages are trace/debug messages and/or error messages. Among
the other, the following messages could be found.
544 9AKK101130D1382
Log file
The PLC File Builder displays a few messages in the Messages window
during execution. All these messages are also logged in the
PlcParserLog.txt file located in the \PGP\Logs folder.
Add a new field (i.e. a new column) in the database template DBF file.
Since the PLC File Builder creates the temporary database on the basis of a
sample database (FreelanceTemplate.dbf) file located in the \PGP\Deck
9AKK101130D1382 545
folder, the new PGPfield (e.g. CUSTTAGID) must be added to the template
file.
In the Correspondences.xml file, a AC800F parameter cannot be
associated to multiple PGP fields.
AC800F Requirements
As described above, the client PGP retrieves data from the AC800F server
via OPC only.
The FreelanceAC800F software tools need to configure a gateway station
(GS) for each defined AC800F OPC Server. Since a GS can be of different
types, it must be defined as an OPC gateway (such gateways are the only
ones the PGP PLC File Builder must manage to get OPC data).
The PLC file doesnt have any information about the gateway type; therefore
the AC800F OPC gateway names MUST contain the OPC character
string. Valid OPC gateways names (no case-sensitive) are OPC1, Opc2,
OPCA, 1OPC, etc.
PGP Requirements
PGP needs the following DLLs.
PLCPARSER.DLL
Build # 1392, used to parse the PLC File for AC800F system version 6.1
FREELANCE.DLL
MSXML.DLL
The Microsoft XML parser version 2.5a, number 5.0.2919.6303, included
with Internet Explorer 5.0.1.
546 9AKK101130D1382
Alias.xml
The PlcFileBuilder creates the PGP database but hides both the opc
server's ProgID (both DA and AE) and the computer name by inserting in
the corresponding DB fields the same "alias" name and the key word
"MULTI_CMP" respectively. The mapping between the alias name and the
true ProgIDs (as well as the MULTI_CMP key word and the computer name)
is stored in the "Power Generation Portal\deck\alias.xml" file. Note that such
file is created automatically by the Builder, if missing.
The Builder opens the file and looks for the exact matching between both
the DA/AE ProgIDs being managed and the ones listed inside the file and
retrieves the stored alias name if search succeeds. If not, it updates the file
by choosing a default unique alias name ("Server1", "Server2"
"ServerN",
depending on the alias names inside the file). See the example below:
9AKK101130D1382 547
548 9AKK101130D1382
The PGP opc client will be in charge of resolving such mapping on the basis
of the configured alias in the database. If "Server2" is defined, the opc client
will connect to "Freelance
.30" DA/AE servers on the "PC2" machine.
The alias.xml file is also used to accomplish the PGP OPC Client
Redundancy by defining a list of computers instead of one only as in figure
above. Note that in order to set up redundancy, the configuration of the file
must be done manually. See the example below referring to the
"OPC.Iconics.1" DA server and the list of three different machines:Before
entering in details about the configuration above, it is important to highlight
that both the DA and AE ProgIDs are always common to the listed
computers, meaning that the same opc server and the same ProgID must
be installed on those machines. Therefore the configuration for client
redundancy cannot be applied in case of "Freelance" OPC Servers for
instance because the Freelance ProgID must be different on different
machines.
9AKK101130D1382 549
550 9AKK101130D1382