Exaquantum PIMS Users Manual

Instruction Exaquantum/PIMS
Manual Users Manual

IM 36J04A11-01E
IM 36J04A11-01E
Yokogawa February 21st 2014
14th Edition Issue 1
Exaquantum/PIMS Users Manual i
Copyright and Trademark Notices

2013 Yokogawa Electric Corporation
All Rights Reserved
All rights are reserved in this document, which is the property of Yokogawa Electric
Corporation. Information contained herein is the property of Yokogawa Electric Corporation.
Unless agreed in writing by Yokogawa Electric Corporation, the licensee shall not remove,
release, disclose, reveal, copy, extract all or part of the documentation.
Trademark Acknowledgements
Exaquantum, Exaopc and CENTUM are trademarks of Yokogawa.
Microsoft, Windows, Windows Vista, Windows Server 2008, Windows Server 2008 R2,
Windows Server 2012, Windows 7 Professional, Windows 8 Pro, Microsoft Word, Microsoft
Excel, Microsoft Office 2010, Microsoft Office 2013, Visual Basic, Visual C++, SQL Server,
MDAC, Microsoft .NET and ActiveX are either registered trademarks or trademarks of
Microsoft Corporation in the United States and/or other countries.
Exaquantum uses Microsoft SQL Server as part of an Integrated Value Added Solution.
Adobe and Acrobat are registered trademarks of Adobe Systems Incorporated, and registered
within particular jurisdictions.
Ethernet is a registered trademark of XEROX Corporation.
Basic Scripting Engine provided by Cypress Software Inc., Copyright 1993 2000, all rights
reserved.
All other company and product names mentioned in this manual are trademarks or registered
trademarks of their respective companies.
We do not use TM or to indicate trademarks or registered trademarks in this manual.
IM 36J04A11-01E 14th Edition Issue 1 February 21st 2014

ii Contents
Highlights
The Highlights section gives details of the changes made since the previous issue of this
document.
Summary of Changes
This is the 14th Edition of this document.
Detail of Changes
The changes are as follows.
Chapter/Section/Page Change
Section 1.3 New chapter added. Minor text updates.
Section 1.10 Section added
Section 2.2 Added Exaopc-CAMS. Versions of Exaopc for logon
security.
Section 5.6 Minor text updates
Section 7.1 Minor text updates, relating to Operating System
support.
Section 14.3 Restoring archives backed up at SQL Server 2000
Chapter 15 New Chapter Rearchive Tool.
Section 17.1 Minor text updates

Exaquantum/PIMS Users Manual iii
Exaquantum Document Set

The documents available for Exaquantum are:
Exaquantum General Specification (GS 36J04A10-01E)
Exaquantum Technical Information (TI 36J04A10-01E)
Exaquantum/PIMS User's Manual (IM 36J04A11-01E)
Exaquantum/Explorer User's Manual Volume 1

General Information (IM 36J04A12-01E)

Custom Controls (IM 36J04A12-02E)

Microsoft Excel Reports (IM 36J04A12-03E)

Advanced Configuration (IM 36J04A12-04E)
Exaquantum Installation Guide (IM 36J04A13-01E)
Exaquantum API Reference Manual (IM 36J04A14-01E)
Exaquantum Engineering Guide Volume 1

Administration (IM 36J04A15-01E)

Network Configuration (IM 36J04A15-02E)

Support Tools (IM 36J04A15-03E)

Web Authoring (IM 36J04A15-04E)

PI Connection (IM 36J04A15-05E)

iv Contents
Table of Contents
Copyright and Trademark Notices .....................................................................................i

Highlights ......................................................................................................................... ii
Exaquantum Document Set ............................................................................................. iii
Table of Contents .............................................................................................................iv
Chapter 1 Introduction ............................................................................................................. 1-1
1.1 Exaquantum Overview ....................................................................................................... 1-1
1.2 Exaquantum System ........................................................................................................... 1-2
1.3 About this Manual .............................................................................................................. 1-4
1.4 Configuring an Exaquantum PIMS Server ......................................................................... 1-8
1.5 Administration Tools Server .............................................................................................. 1-9
1.6 Concepts ............................................................................................................................. 1-9
1.7 Native Language Support Compatible ............................................................................. 1-10
1.8 Common Rules ................................................................................................................. 1-11
1.9 Access to Exaquantum/PIMS Administration Tools........................................................ 1-12
1.10 Data Timestamps. ............................................................................................................. 1-12
Chapter 2 OPC Gateway Configuration ................................................................................. 2-1
2.1 General ............................................................................................................................... 2-1
2.2 Concepts ............................................................................................................................. 2-1
2.3 Associated Screen .............................................................................................................. 2-2
2.4 Scenarios ............................................................................................................................ 2-6
Chapter 3 Production Calendar ............................................................................................... 3-1
3.1 General ............................................................................................................................... 3-1
3.2 Concepts ............................................................................................................................. 3-1
3.3 Scenarios ............................................................................................................................ 3-3
Chapter 4 Server Management ................................................................................................ 4-1
4.1 General ............................................................................................................................... 4-1
4.2 Concepts ............................................................................................................................. 4-1
4.3 Scenarios ............................................................................................................................ 4-2
Chapter 5 Role Based Namespace Configuration .................................................................. 5-1
5.1 General ............................................................................................................................... 5-1
5.2 Creating views .................................................................................................................... 5-1
5.3 Publishing views across multiple servers ........................................................................... 5-1
5.4 User access to data ............................................................................................................. 5-2
5.5 Making views available to users ........................................................................................ 5-2
5.6 RBNS Builder .................................................................................................................... 5-5

Exaquantum/PIMS Users Manual v
5.7 Namespace selection and display ....................................................................................... 5-5

5.8 Adding and deleting objects from the namespace hierarchy .............................................. 5-7
5.9 Properties and settings........................................................................................................ 5-7
5.10 Scenarios ............................................................................................................................ 5-9
Chapter 6 License Management ............................................................................................... 6-1
6.1 General ............................................................................................................................... 6-1
6.2 Concepts ............................................................................................................................. 6-1
6.3 Scenarios ............................................................................................................................ 6-2
Chapter 7 User Monitor ............................................................................................................ 7-1
7.1 General ............................................................................................................................... 7-1
7.2 Viewing a list of users who are currently logged in ........................................................... 7-2
7.3 Viewing a list of users who were logged in at a specific date/time ................................... 7-3
7.4 Viewing a list of users who were logged in at some point between two date/times .......... 7-4
7.5 Viewing a list of users who were logged in for the whole period spanning two date/times .... 7-5
7.6 Turning User Logging On/Off ........................................................................................... 7-6
Chapter 8 Tag Template ........................................................................................................... 8-1
8.1 General ............................................................................................................................... 8-1
8.2 Concepts ............................................................................................................................. 8-1
8.3 Associated Screen .............................................................................................................. 8-7
8.4 Scenarios ............................................................................................................................ 8-8
Chapter 9 Function Block Template ........................................................................................ 9-1
9.1 General ............................................................................................................................... 9-1
9.2 Concepts ............................................................................................................................. 9-1
9.3 User Interface and Associated Screens .............................................................................. 9-2
9.4 Scenarios ............................................................................................................................ 9-3
Chapter 10 Tag Generation ...................................................................................................... 10-1
10.1 General ............................................................................................................................. 10-1
10.2 Concepts ........................................................................................................................... 10-1
10.3 User Interface ................................................................................................................... 10-3
10.4 Scenarios .......................................................................................................................... 10-5
10.5 File Formats ..................................................................................................................... 10-6
Chapter 11 Tag Editor .............................................................................................................. 11-1
11.1 General ............................................................................................................................. 11-1
11.2 Concepts ........................................................................................................................... 11-1
11.3 User Interface and Associated Screens ............................................................................ 11-2
11.4 OPC Reference update tool .............................................................................................. 11-6

vi Contents
11.5 Scenarios .......................................................................................................................... 11-7

Chapter 12 Cross-server Calculations ..................................................................................... 12-1
12.1 General ............................................................................................................................. 12-1
12.2 Concepts ........................................................................................................................... 12-1
12.3 Operational implications and limitations ......................................................................... 12-4
12.4 Tag Template configuration for Cross-server Calculations ............................................. 12-6
12.5 Tag Configuration for Cross-server Calculaton ............................................................... 12-7
12.6 OPC Gateways Configuration .......................................................................................... 12-8
Chapter 13 Expressions............................................................................................................. 13-1
13.1 General ............................................................................................................................. 13-1
13.2 Concepts ........................................................................................................................... 13-1
13.3 User Interface ................................................................................................................... 13-6
13.4 Scenarios .......................................................................................................................... 13-7
Chapter 14 Archiving ................................................................................................................ 14-1
14.1 General ............................................................................................................................. 14-1
14.2 Concepts ........................................................................................................................... 14-1
14.3 User Interface and Associated Screens ............................................................................ 14-7
14.4 Scenarios ........................................................................................................................ 14-11
Chapter 15 Rearchive Tool ....................................................................................................... 15-1
15.1 General ............................................................................................................................. 15-1
15.2 Concepts ........................................................................................................................... 15-1
15.3 Security ............................................................................................................................ 15-1
15.4 Check Mode ..................................................................................................................... 15-1
15.5 Rearchive Mode ............................................................................................................... 15-2
15.6 Output Codes .................................................................................................................... 15-3
15.7 Install Mode ..................................................................................................................... 15-4
15.8 Help Mode ........................................................................................................................ 15-4
Chapter 16 Event Generator .................................................................................................... 16-1
16.1 General ............................................................................................................................. 16-1
16.2 Concepts ........................................................................................................................... 16-1
16.3 User Interface ................................................................................................................... 16-3
Chapter 17 HIS Tag Generation .............................................................................................. 17-1
17.1 Tag Creation ..................................................................................................................... 17-1

Exaquantum/PIMS Users Manual 1-1
Chapter 1 Introduction
1.1 Exaquantum Overview
Exaquantum (Figure 1-1) is a Plant Information Management System (PIMS) combined with
a powerful user interface.
Figure 1-1 Exaquantum Functional Overview
Exaquantum/Web Exaquantum/Explorer
Web client Web client User PC User PC
Intranet Local Area Network
Role Based View

Long-term
OLE DB, Archive
ODBC, etc
Administration Tools
Real Time Database Historian

External Data:
ERP,
LIMS, etc
PCS Interface
Exaquantum/PIMS
(Server)
Exaquantum/PIMS
(Server)
Exaquantum/PIMS
(Server)
OPC Servers
PCS, DCS, PLCs etc
TIC1-2
The primary functions of Exaquantum/PIMS are to gather, store and aggregate process and
other business data. This data can then be accessed using Exaquantum/Explorer,
Exaquantum/Web and other tools such as Microsoft Excel. The data flow can be summarized
as follows:
Raw process data is gathered from the PCS, via OPC servers, into a proprietary Real-time
Database. Here, the raw data can be combined in real-time calculations to produce
derived, higher value information.
Both derived and raw values are historized so that their data can be accessed over long time
periods by the Historian.
In addition to normal historization, the Exaquantum/PIMS Historian calculates aggregation
values. This is a process of data reduction (such as mean value calculation,
minimum/maximum tracking, standard deviation, summation) over user-defined periods.
The aggregations are themselves stored; this allows them to be retrieved over long time
periods.
Real-time, historized and aggregation information are made available to users desktops via
Exaquantum/Explorer; this software is able to present the data in a wide variety of formats.

1-2 Chapter 1 Introduction
Exaquantum/PIMS is event-driven. When new data arrives, any calculations that use the new
data values are triggered and the Historian is informed by an event. Any user applications
(such as Exaquantum/Explorer displays) which have a registered interest in the data are
informed of the change.
1.2 Exaquantum System
The components of the Exaquantum system are shown in Figure 1-2.
Figure 1-2 Exaquantum System
Third Party
Clients
Exaquantum
Client Client
Exaquantum/Explorer OLE DB and Exaquantum/Web
Viewing, Analysis and

Open
Web Services and
Reporting Interfaces Components
Server
Exaquantum/PIMS
Server
Role Based View Server
Configuration Real-time
Historian
Tools Database
PCS Interface
OPC Server
TIC1-3
The system forms a multi-tier architecture, with OPC servers providing the raw process data.
This data is first managed and accumulated within the Exaquantum/PIMS server. It then
becomes available to Exaquantum/Explorer (a powerful analysis and reporting facility). The
data can also be accessed by other third party clients via the OLE DB interface or open
interfaces (application programming).
The main components of Exaquantum are described below.
Exaquantum/PIMS
The Exaquantum/PIMS server has three main functions, which are outlined below.
Real-time Database
The Real-time Database is a high performance real-time store for process and plant data that
also provides flexible, user-defined calculations, and aggregations (mean, max, min etc.) over
multiple user-defined time periods.

Historian
An optimized, long-term Historian provides efficient storage and fast retrieval of vast
amounts of plant data, over very long time periods.
Configuration Tools
A suite of easy-to-use tools is provided to build, deploy and manage the Exaquantum/PIMS
environment.
Exaquantum/Explorer
Exaquantum/Explorer is a data utilization client that can be run on user PCs. It is a powerful,
flexible analysis and reporting environment through which business information may be
presented in graphical displays and reports. For further information, see the Technical
Information (Ref. TI 36J04A10-01E) and Exaquantum/Explorer Users Manual (Ref IM
36J04A12-01E).
Exaquantum/Web
Exaquantum/Web enables users to deploy thin clients over the Internet/Intranet. The scope of
supply is similar to that provided by Exaquantum/Explorer. Exaquantum/Web components
can handle multiple Exaquantum servers transparently.
Interfaces
OLE DB Interface
The industry-standard OLE DB interface (which includes ODBC) allows Exaquantum/PIMS
to present PIMS information to other third party clients. Since many of these tools provide
users with non-programming access (making use of such techniques as drag and drop), this
interface is suitable for users who have a requirement for the data, but may not have in-depth
programming skills.
Automation Interfaces
Exaquantum also provides a set of open interfaces by which application programs can browse,
read and write configuration and/or data. These interfaces are COM interfaces and therefore
suitable for application programmers.
OPC Interface
With the addition of the OPC server software, an Exaquantum/PIMS server can make
available its data as an OPC server. The Exaquantum OPC client1 is available for installing on
suitable equipment from other manufacturers, to allow them to access an OPC interface on an
Exaquantum/PIMS server. Once installed there is no configuration required for the OPC
server. Refer to Chapter 12-Cross-server Calculations to see how it can is used by the
Exaquantum system. For technical details of the interface, see the Exaquantum API Reference
Manual.
1
As an MSI package distributed with Exaquantum.

1.3 About this Manual

This manual describes the configuration and administration of, and concepts behind
Exaquantum/PIMS.
Note: The detailed information about how to use the various tools described in this manual
can be found in the Exaquantum/PIMS help files (an integral part of the product).
Introduction
Chapter 1: Introduction provides an overview of Exaquantums functions, a description of
the Management Console, and a summary of how to configure an Exaquantum/PIMS server.
System Configuration
Chapter 2: OPC Gateway Configuration describes the list of OPC gateways that provide
PCS connectivity to Exaquantum/PIMS.
Chapter 3: Production Calendar describes how the Production Calendar affects other
configuration activities.
Chapter 4: Server Management describes how Server Management is achieved by using the
Server Management Tool in association with the License Information screen.
Chapter 5: Role Based Namespace Configuration describes the concept of Role Based
Namespace, the scenarios likely to be encountered during configuration, and the associated
tool.
Chapter 6: License Management describes how licenses information can be added.
Chapter 7: User Monitor describes how user monitor can be used.
Tag Configuration
Chapter 8: Tag Template describes the elements of a tags definition, and also typical
scenarios for changing an existing tags definition.
Chapter 9: Function Block Template describes the elements of a function blocks definition,
and also typical scenarios for changing an existing function block.
Chapter 10: Tag Generation describes four methods of creating and updating tags and/or
function blocks. It also recommends which method to use in certain circumstances.
Chapter 11: Tag Editor describes the frequently used configuration and monitoring tool that
allows the user to create and/or edit folders, function blocks, and various types of tags.
Chapter 12: Cross-server Calculations describe how tags and function blocks on one server
to be available on another.
Chapter 13: Expressions describes expressions, and the expression builder tool.
Archiving
Chapter 14: Archiving describes the concept of creating and managing archives.
Chapter 15: Rearchive Tool - how to restore archives backed up with SQL Server 2000 into
Exaquantum
Advanced
Chapter 16: Event Generator describes the advanced and optional feature of generating
events for custom-tailored applications.

Chapter 17: HIS Tag Generation describes the HIS tags and the groups they belong to can
be imported into Exaquantum using this tag generation function.
Management Console
A Management Console is a user interface that provides an environment for running system
management and administration applications. It provides a common environment for all user
interface applications, and is used to view management and administration tools. The
Microsoft Management Console has been customized for use with Exaquantum.
Console Components
There are four main components of the Management Console (Figure 1-3 ):
Console Tree
Configuration Screen
Management Console Menu Bar
Configuration Screen Menu Bar
These are described below.
Console Tree
The console tree shows a hierarchical structure that represents the available objects in the
Management Console. The console tree is always in the left pane of the window. It can be
fully expanded to allow the selection of the objects within it.
Note: When changes to a configuration are made using the MMC they must be saved using
the controls available on that page before you change to another page, or close the
MMC, otherwise the changes will be lost.
Note: Although the Management Console allows the use of multiple configuration tools in
a single tree, for example Exaquantum Configuration Tools and SQL Server
Management Studio, experience has shown that this can adversely affect the behavior
of DCOM. As this usually leads to an intermittent OPC communication failure, it is
strongly recommended that only one tools set be used at a time.
Configuration Screen
The screen is used to configure and administer the Exaquantum/PIMS system. The
administrator specifies which ordinary users have access to the various screens.

Management Console Menu Bar

This menu bar has the three standard functions (each of which has further sub-divisions):
Console
Window
Help.
Figure 1-3 Typical Management Console
Management Console Configuration Screen

Menu Bar Menu Bar
Console Tree Configuration

Screen
User Name Machine Name
Configuration Screen Menu Bar

This menu bar has two functions Action and View (each of which has further sub-divisions).
User and Machine Identification
The name of the currently logged on user, and the name of the Exaquantum server are
displayed in the status bar area at the bottom of the MMC window.

View the Management Console

1 Run the Exaquantum Administration Tools. The Management Console is displayed.
2 In the console tree select the option you require.
Note: Exaquantum is a licensed product. When you accidentally breach the licensed
conditions, a warning dialog will be displayed whenever you access a tool within the
MMC tree. You can still use functions of the system; however you are advised to
upgrade the Exaquantum license. See the Installation Guide (ref: IM 36J04A13-01E)
for more information of upgrading the Exaquantum license.
File Download Dialog
In some instances, selecting an option on the console tree will open a file download dialog.
This is due to an operating system configuration conflict and may be resolved as follows:
1 In the Control Panel select Folder Options.
2 Select the File Types tab.
3 Scroll through the available file extensions and find VBD. If it appears in the list, go to
step 5. Otherwise continue with step 4.
4 Click on the New button and in the Create New Extension dialog type VBD into the File
Extension entry field.
5 Click on the Advanced button and uncheck the Confirm Open After Download check
box.

1.4 Configuring an Exaquantum PIMS Server

Configuration Activities
The process of configuring an Exaquantum PIMS server is intended to be a simple, low
engineering task.
Figure 1-4 shows an overview of the configuration task.
Figure 1-4 Exaquantum/PIMS Server Configuration Process
Start
Define
OPC Gateways
Define
Production
Calendar
Set up
Multi-server
Environment
Define Tag
Templates
Define Function
Block Templates
Tag
Generation
Function
OPC OPC File Tag File
Block
Equalisation Import Import
Generation
Configure
RBNS Views
Finish
History Catch-up
History catch-up is a process that allows Exaquantum to recover data for the period between a
system shutdown and a restart. There are several options available. For a full description of
History Catch-up see the Exaquantum Engineering Guide Volume 1 (ref IM 36J04A15-01E),
Chapter 4, Section 4.10.

1.5 Administration Tools Server

To access this tool, select the Administration Tools Server option from the Exaquantum
menu. The key points of the tool are:
It is used to change the server that is being used by Administration Tools.
It provides a drop down list of available servers. Pressing the Apply button confirms the
change. Pressing OK accepts the change and closes the program.
You must be an Exaquantum Administrator to use this tool.
1.6 Concepts
There are a number of key concepts that users have to understand before they can make use of
the Exaquantum tools. These concepts are described in the following sections.
Note 1: A description of Exaquantum configuration concepts is also available in Technical
Information (Ref. TI 36J04A10-01E). Users are strongly recommended to look
through this document.
Note 2: Some of the sections might be better understood if they are revisited after having
read the following chapters.
Templates
Although the number of tags that users want to access tends to be large, there are a limited
number of typical patterns by which such large numbers of tags can be categorized. In
Exaquantum these typical patterns are called templates. The first task of the configuration
work is to create templates to apply to the tags in question. There are two different types of
templates within Exaquantum:
Tag Template, which defines the properties of a tag and consists of:
Data Type Long Integer, Single Floating Point, Double Floating Point, String
Aggregation Type Continuous or Discrete
Data Source OPC, Manual or Calculated
Historian Update Policy none, on change or periodic
Aggregation selection
Others
Function Block Template, which defines the structure and parameters of an Exaquantum
function block (see below). The definition consists of member tag definitions that are:
Name, type, tag template of a tag
Default values of a tag.
Function Blocks
An Exaquantum function block is a structure consisting of tags that together comprise a
functioning set of information as a whole (refer to the Technical Information document for
some examples of typical function block usage). From a configuration work viewpoint, a
function block is a combination of OPC, Manual and/or Calculated tags. Therefore, before
defining a function block, tag templates must have been defined correctly.

Template Versioning
Once a template (tag or function block) is created and then later changed, any occurrence of
template definition is maintained in Exaquantum as different versions. Version control is
important when you understand that tags and/or function blocks are created by copying the
definition of templates; they do not refer to templates, but keep a copy as a definition. This
mechanism allows templates to be changed without affecting running tags and/or function
blocks. Changing tags and/or function blocks is done by firstly changing the associated
templates, and then applying such changes to existing tags and/or function blocks. In this way,
any changes that may take place can be analyzed and reported by the user before the user
actually performs such changes. The analysis is made by comparing the original template
with an updated template, not comparing templates and tags/function blocks. This is why the
performance of the analysis is good.
1.7 Native Language Support Compatible
All of the configuration tools are Native Language Support (NLS) compatible; they are thus
capable of:
Showing all the captions and messages in the native language.
Allowing input variables to be in the native language, whenever applicable. In this manual,
all of the NLS fields are clearly indicated.
Supported native languages are:
English for the English environment and any other languages not listed below
Japanese for the Japanese environment.

1.8 Common Rules

This section describes some of the commonly applied rules:
Name matching is made case-insensitive, width-insensitive, and Kana-sensitive. Most of the
names (e.g. Template names, Tag names) are matched in the following manner:
Case-insensitive: lowercase and uppercase match the same.
Width-insensitive: full size (zen-kaku in Japanese) and half-size (han-kaku in
Japanese) match the same.
Kana-sensitive: Hira-kana and Kata-kana do not match the same. Full size Kata-kana
(zen-kaku kana in Japanese) and half-size Kata-kana (han-kaku kana in Japanese) do
not match the same.
Note: There are some exceptional cases where zen-kaku kana and han-kaku kana are
treated the same. These cases will be described in the following chapters
whenever applicable.
Note: Do not prefix or suffix the Tag Template or Function Block Template names with
blank spaces.
OPC item ID is case-sensitive
OPC item ID is a value that identifies OPC source information within the OPC server.
The match is made by OPC server, and case sensitivity is a matter of the OPC server.
Exaquantum treats it as case-sensitive.
The punctuation items dot (.), comma (,) or colon (:) are used as separators or delimiters
within the system, therefore they must not be used in the following names:
Folder names
Tag names
Function Block names
Aggregation names
OPC gateway names
Server names

1.9 Access to Exaquantum/PIMS Administration Tools.

To access the Exaquantum/PIMS Administration Tools, a user must be a member of:
The Exaquantum user group and The Exaquantum administrators group
The Exaquantum user group is one of the following:

QUserGroup (Legacy Security Model)
QTM_DATA_READ (Standard Security Model)
The Exaquantum administrators group is one of the following:

QAdministratorsGroup (Legacy Security Model)
QTM_MAINTENANCE (Standard Security Model)
QTM_MAINTENANCE_LCL (Standard Security Model, DOMAIN only)
1.10 Data Timestamps.
All Data Points and Alarm and Event records on the Exaquantum system are stored with a
timestamp. This timestamp is stored as UTC.
When data is displayed in any of the Exaquantum Applications, the data is displayed in the
Local Time of the Computer where the Application is running.

Chapter 2 OPC Gateway Configuration

2.1 General
The OPC Gateway Configuration tool is used to define the OPC gateways that Exaquantum
connects to. The user interface allows OPC gateways to be added, deleted and viewed, and
their details modified.
2.2 Concepts
Exaquantum is shipped with the type definitions of commonly used OPC servers. These
are:
Yokogawa Exaopc-STN (CS cassette)
Yokogawa HIS-OPC cassette
Yokogawa Exaopc-XL cassette
Yokogawa Exaopc-XL cassette
Yokogawa Exaopc-STN-RD (Redundant) cassette
Yokogawa Stardom cassette
Yokogawa Exaquantum OPC server
Yokogawa Exaopc Interface Package (PRM field communication cassette)
Yokogawa Exaopc Interface Package (CENTUM SOE cassette)
Yokogawa Exaopc Interface Package (SCS SOE cassette)
Yokogawa FAST/TOOLS OPC server
Yokogawa Exaopc-CAMS cassette
If the system requires connections to any other types of OPC servers (or even configuration of
commonly used OPC servers in a non-standard way), users are required to configure types
before using this tool. For information about configuring OPC server type, refer to the
Exaquantum Engineering Guide, Volume 3 (IM 36J04A15-03E).
Note: Exaquantum is tested and supported with Matrikon OPC servers for Honeywell
TDCS3000, Foxboro IA series and MODBUS. The necessary OPC type
configuration for these OPC servers should also be made with the tool mentioned
above.
There is an option for the OPC gateway to be subject to Alarm and Events (A&E) gathering.
This can be selected through a check box on the OPC Gateway Configuration screen. The
box can only be checked when the selected OPC gateway type allows A&E access.
There is an option for the OPC Gateway to automatically recover OPC data after a loss of
connection. The Enable Automatic OPC Data Recovery checkbox allows this option. The
box can only be checked when the selected OPC Gateway allows Historical Data or Historical
A&E access.
There is an option to recalculate aggregations and calculations, following a change to their
dependent data. The Enable Automatic Recalculation checkbox allows this option, the
Enable Automatic OPC Data Recovery option must already be enabled to allow this option.

2-2 Chapter 2 OPC Gateway Configuration
The R3.70 and later releases of ExaOPC support enhanced connection security. The optional
Logon Check configuration allows a User and Password to be specified to connect to the
ExaOPC server.
Once configured, the connection credentials for the selected OPC Gateway can be tested by
clicking on the Test button.
If a user defines an OPC gateway that uses an OPC gateway computer, then the detail is
populated with the settings already defined for this OPC gateway computer:
Automatic OPC Recovery (enabled / disabled)
Automatic Recalculation (enabled / disabled)
OPC gateway security (enabled / disabled, user and password)
If there are multiple OPC Gateways configured for the same OPC Server, the logon
credentials, Enable Automatic OPC Data Recovery and Enable Automatic Recalculation for
each affected OPC Gateway are updated after user confirmation.
It is possible to apply filtering to Alarm and Events collected from the OPC gateway, in order
to reduce the quantity of data being stored in Exaquantum. To define one or more of these
filters, click on the Alarm and Event Filter button.
For Exaopc security details, refer to "10.Setting the Exaopc Product Security function" in
"NTPF100 Exaopc OPC Interface Package Installation Manual (IM36J02A12-01E)
2.3 Associated Screen
Advanced Screen
This screen is displayed when the Advanced button on the OPC Gateway Configuration
screen is pressed. Part of this screen is a read-only table that lists Property and Value for
the OPC server selected in the OPC Gateway Type field. The values displayed change
depending on the server selected. In the Advanced Option part, a check box Use
Exaquantum Time allows the user to allocate an Exaquantum timestamp to any OPC data
received.
Note: This screen is for information only. The information is an advanced topic and only
trained developers may ever need it.
If you do have to configure the values, use a separate tool (see section 2.2).
Alarm and Event Filter Screen
Filter Settings
The Filter Settings screen is displayed by clicking on the Alarm and Event Filter button.
This screen is used to specify the alarm and event filters. These settings define exclusive
filters; that is the events that a user wishes to exclude from saving to the QHistorianData
database. The maximum number of definable filter conditions is 20.
The Alarm and Event Filter settings can be specified after defining the OPC Gateway type.

Figure 2-1 Filter Settings Screen
OPC Gateway Name

Displays the gateway name for the filters being defined.
Filter Table
Displays all the filter conditions that have been currently defined for the OPC gateway.
Description shows User-supplied description of the defined filter, NLS compatible,
maximum 254 characters The Enabled/Disabled column shows the active state of each
filter.
New
Click here to define a new filter. For more information refer to the topic of Detail
Settings.
Edit
Click here to edit the selected filter conditions. For more information refer to the topic of
Detail Settings.
Delete
Click to delete the selected filter. A dialog box is displayed to confirm whether to delete
it. .
OK
Saves changes in filter conditions on the Filter Settings window and returns to the OPC
Gateway screen.
Cancel
Cancels changes and exits from the window.

Detail Settings
In the Detail Settings window it is possible to define new filter conditions and edit existing
filter condition parameters. Filters that are defined are exclusive filters; that is they define
alarm and event conditions that are not to be saved to the Exaquantum database.
One or more filters can be defined in the Condition Definition filter table: A maximum of 100
conditions can be specified.
Attribute select the alarm and event message field to filter on
OPE. define the operator
Value specify the value to exclude (this can include wildcards)
And/Or - Link fields to exclude with And/Or logical operators. (NOTE And has higher
priority over Or).
Select the Disabled check box to temporarily disable the filter conditions.
Figure 2-2 Detail Settings Screen
OPC Gateway Name

Displays the OPC gateway for which the filter is being defined.
Disabled
Select the Disabled check box to temporarily disable the filter conditions.
Description
Used to enter the description of a relevant filter condition. The maximum number of
characters to be entered is 254.
Attribute
Used to select an event attribute. Each attribute is listed with its data type.
To edit a condition parameter, click in the relevant cell.

The attributes available to specify depend on the OPC gateway type

Source
Message
Event Category
Severity
Condition Name
(CENTUM Message ID)
(Station Name)
Others
OPE.
Used to select a logical operator. Available options are, depending on data type:
= (equal to)
< (less than)
<= (equal to or less than)
>= (equal to or more than)
!= (not equal to).
The relationship between data type and OPE type is as follows.
Logical type - =, !=
Numerical type - =, <, <=, >, >= , !=
Character type - = , <, <=, >, >= , !=
Note: for a single-precision floating-point value or a double precision floating-point type,
value = may not be evaluated correctly. As such, it is not recommended to use a
floating point type value for an equal to expression.
An FCS generation time (GMT cumulative second) can be compared as a date type
value.
Character type can be defined using a wild card:
?: A single character (including a number)
*: Null or one or more characters (including numbers)
#: A single number (0 to 9)
[charlist]: A single character included in charlist.
[!charlist]: A single character not included in charlist.
[start-end]: A single character between the start and end characters including each
of them.

Value
Define a value consistent with the data type, up to a maximum of 256 characters.
Wildcards can be specified for character data types.
AND/OR
Use And/Or to link filters. At the end of conditions specify a period (.).
New
Defines a new filter condition.
Delete
Deletes the selected attribute condition.
OK
Saves the filter conditions, and closes the window.
Cancel
Cancels the changes to filter conditions and closes the window.
2.4 Scenarios
The OPC Gateway Configuration tool is primarily used:
During initial system installation and set-up
Whenever OPC gateways are added
Whenever OPC server details change, for example, change the OPC server type from Exaopc-
HIS to Exaopc-STN
To enable/disable OPC Alarms and Events for the Exaquantum server.
To reduce the number of alarms and events stored by Exaquantum.

Chapter 3 Production Calendar

3.1 General
The Production Calendar is used to define the period over which customer production and/or
information management is conducted. The primary usage of the production calendar in the
Exaquantum server is to define the aggregation timing and period.
Note: In Exaquantum/Explorer, the production calendar is also used as a reporting period.
There are no other screens associated with the Production Calendar.
3.2 Concepts
There are two types of production calendar periods:
System-defined production calendar periods (Hour, Day, Month)
Custom production calendar periods (defined by the user).
Each production calendar period is defined by its length and offset of start time:
Table 3-1 Production Calendar Periods
Period Length Offset (Start)

Hour 60 minutes Minutes from hour (0-59)
(Fixed)
Day 24 hours (Fixed) Hours from midnight (0-23)
Month 28 - 31 days Day of the month (1-28) or last day of the
(Fixed) month
Custom Limited to 1 day Up to Length minus 1 minute
(24 hours)
When any new custom periods are created, they are added to the Name/Dependency list. The
dependency is the data on which the production calendar period is based, e.g. a production
calendar period of a day can be derived from hour data.
Production calendar periods will always follow each other immediately. For example, a
period cannot be defined as 8 am to 5 pm each day, i.e. 9 hours followed by a 15-hour gap.
They will also be for an unvarying time period; it is not possible to define 3 shifts of 8, 10 and
6 hours in a day (00:00 to 08:00, 08:00 to 18:00, 18:00 to 24:00).
The duration of system periods is fixed. The user can select the duration of custom
periods from a drop-down list. The default value is 8 hours.
Day period and custom period over one hour in length support Daylight Saving Time (DST).
For example, the Day period and a Shift period (i.e. a Custom period of 8 hours), get 1 hour
shorter when DST begins, and 1 hour longer when DST ends. DST adjustment takes place
when the Windows Date/Time property setting is made so that the time zone assumes DST,
and a check is made to automatically adjust DST.

3-2 Chapter 3 Production Calendar
Production calendar has a concept of dependency that determines a production period from
which another aggregation calculation (statistical calculation for the production period of time
such as mean, maximum, summation etc.) should be made. For example, an hour may be
derived from (be dependent on) raw, a day derived from an hour, and a month derived from a
day. This allows aggregation calculations for longer periods to be more consistent with
shorter ones.
The dependencies that can be selected for a particular production calendar period change
depending on which period is displayed in the Name field. The options are as follows:
Table 3-2 Production Calendar Period Dependencies
Period Possible Selection (Dependency)
(Name)
Hour Raw (default) or one of the Custom aggregations
Day Hour (default), Raw or one of the Custom aggregations
Month Day (default), Raw, Hour or one of the Custom aggregations
Custom Raw (fixed)
The periods that are set in the Production Calendar are also used in the Tag Template (see
Chapter 5). However, in the Tag Template, the production calendar periods are listed under
the heading Aggregation Periods.

3.3 Scenarios
Some typical scenarios associated with the Production Calendar are:
Initially set up the production calendar and dependency
Add an additional production calendar
Adjust the start of the production calendar
Change the dependency (to change the calculation of the aggregations for the dependent
period(s)).
The permitted operations for the two types of production calendar period are summarized
below:
Table 3-3 Production Calendar permitted operations
Operation System Custom

Create a new production calendar No Yes
period
Change the dependency Yes No
Set the length of a production No Yes (up to a limit
calendar period of 24 hours)
Set the production calendar period Yes (default Yes (default
offset available) available)

3-4 Chapter 3 Production Calendar
This page intentionally left blank

Chapter 4 Server Management

4.1 General
Server Management is achieved by using the Servers tool. This tool is mainly used when first
installing and setting up an Exaquantum system. It is used to register single or groups of
Exaquantum servers. Once registered, the server(s) contents (Folders, Function Blocks and
Tags) can be configured in Role Based Namespace (RBNS) views that reflect the specific
requirements of individual or groups of users.
There are no other screens associated with the Servers tool.
4.2 Concepts
For single server Exaquantum configurations, registration occurs during the installation of
Exaquantum. Unless there is a need to view or change the server details, the Servers tool does
not need to be used.
In a multi-server environment it is the Servers tool that is used to make Exaquantum servers
available to the RBNS. Before creating a multi-server environment, these factors must be
considered:
Which server is to be the Master Server
Publication of the RBNS to another server or servers.
Multiple Server Environment and the Master Server
In a multi-server environment, users need to be able to access items on multiple servers. The
RBNS view allows users to achieve this. However, in order for the RBNS to be configured,
all referenced servers must be registered using the Servers tool. For consistency and ease of
control, it is recommended that one server in the group is designated as the Master Server, and
is used to make all server and RBNS configuration changes. For example:
1 Server 1 (Master) and Server 2 are both Exaquantum servers, installed, licensed and set up
independently. (All multi-server configurations start in this manner).
2 On Server 1, the Servers tool is used to add Server 2 to the configuration.
3 Once Server 2 is registered, the RBNS views configured on Server 1 can reference items
on Server 2.
4 On Server 2, however, Server 1 is not known and will remain unknown until the RBNS
from Server 1 is published.
Note: The Master Server does not necessarily have to be fixed. It can be Server 1 at one
time and Server 2 another time. There must, however, only be one single server at
any one time that is the source of the RBNS changes.
Publication of the RBNS
Publishing the RBNS replicates the RBNS of the master (source) server on one or more target
servers. This means that, provided the RBNS of the target server has not been changed, the
RBNS of the master server simply replaces the current RBNS.
The servers that are configured in the RBNS of the master server are then consistent in each
of the target servers. The RBNS views created on the master server are available to the
associated users of the view.

4-2 Chapter 4 Server Management
For a more detailed explanation of the RBNS refer to Chapter 5 (Role Based Namespace
Configuration).
Caution: When a change is made to the RBNS on a server other than the master server, that
server may be selected for publication of the Master Servers RBNS, but there is some risk
involved.
4.3 Scenarios
The Servers tool can be used to modify Server details such as Server Name, Server
Description and Server Computer. These changes are reflected in the RBNS immediately,
without needing to reconfigure the RBNS contents.
In very exceptional circumstances a server may be deleted. This operation will not be
permitted if any RBNS references the server that is to be deleted.

Chapter 5 Role Based Namespace Configuration

5.1 General
Role Based Name Space (RBNS) is used to create views of Exaquantum data that are
customized for individual groups of users.
There are two key aspects to RBNS:
Creating views from a variety of data sources, including across multiple Exaquantum
servers.
Making views available to different groups of users
5.2 Creating views
The RBNS views are created and modified using the RBNS Builder (section 5.6). Views can
be created that contain diverse sets of plant data from the local or other Exaquantum servers.
Each view can be associated directly with up to two Windows user groups, one with read
access and one with both read and write access (see 5.5).
Objects that are available for use in the construction of views are:
Virtual folder A container that has a context only within the view. It can be used to
create a structure for grouping diverse sources of data.
Reference Folder A direct reference to an actual folder within the namespace of an
Exaquantum server. The contents of a reference folder are determined by the source
and cannot be changed on the local or a remote server.
Function Block A reference to a function block on the local or a remote server.
Tag (including tag items and aggregation items) A reference to a tag on the local or a
remote server.
Some of the properties of each object in a view can be configured:
Name to create a unique identifier in order to avoid a clash of names when objects on
different servers use the same name.
Security to give fine control over write access.
Filters to eliminate some objects from the view.
The RBNS views are stored in the database on each server. In a multi-server environment it is
important that all the RBNS databases share identical data and that it is synchronized
whenever changes are made (section 5.3).
5.3 Publishing views across multiple servers
The RBNS Builder provides the facility to publish its configuration to other servers in the
system. A locking mechanism ensures that changes made on one server do not conflict with
changes being made on another.
NOTE. When publishing views, there must be user and password equivalence across servers.
If users A and B are both running RBNS builder and editing the RBNS content at the same
time:

5-2 Chapter 5 Role Based Namespace Configuration
1 When user A changes the content by creating, editing or removing a namespace, user B
cannot make any changes to the affected namespace until he refreshes the content; which
will apply the changes made by user A.
2 Until the content is refreshed, attempts to make changes by user B may be invalid. For
example, user B cannot add an element to a namespace if user A has already removed
that namespace. Changes can be made by user B to a different namespace, but the
content should be refreshed anyway to apply all changes.
If user A wants to publish a servers RBNS content to other Exaquantum servers and user B
is currently updating the RBNS contents on another server, user B is presented with a dialog
stating that the RBNS content has been updated and that a refresh is required before making
any changes. Once the refresh has been completed, user B may continue the updates;
although the new content may have changed considerably. For this reason, frequent refreshing
by concurrent users is encouraged.
To keep concurrent updates to a minimum it is recommended that, for RBNS purposes, one
server be designated as a Master. All changes should be made to the Master and then
published to all the other servers.
5.4 User access to data
There are two types of access to views, and the data they represent:
Read access users with read access can only view the data.
Write access users with write access can change some data values.
Allocating access to users takes place at several levels:
Access to individual data source, such as Tag, Function Block, etc. can be configured
using RBNS Builder (see Security in section 5.9)
Access to Folders and their contents can be configured using RBNS Builder.
Views are assigned to Windows user groups using RBNS Builder.
The allocation of users to Windows user groups can be managed within the Windows
system.
Note: Some objects can also be hidden from view by using the facilities available in the
Filters page (see Filters in section 5.9 ).
5.5 Making views available to users
Role Based Namespace employs the Windows user group feature to manage users with
common workplace roles, and to distribute the views accordingly. Each view can be
associated with two Windows user groups.
RBNS views - A RBNS view will be created for each role, or specific part of a role.
View groups - Each RBNS view will be allocated to either one or two Windows user
groups; one for read only, and one for read and write, depending on requirements.
Role groups - A Windows user group will be created for each workplace role or in
some cases just a specific part of a role.
Users - Users will be added to a group, or groups, consistent with their role.

Thus everyone performing a particular role can be given access to the appropriate view, by
making their role group a member of a suitable view group. See Figure 5-1 Simple RBNS
Example.
As users and groups can be members of more than one group:
A view may be shared across more than one role by making other role groups
members.
A role group can have access to more than one view by adding it to more view groups
Users can have access to more than one role's views by adding them to other roles.
Using different combinations of groups provides a flexible and configurable access control
system.
Group access rules
In situations where everyone will have read or write access it is possible to not allocate
specific group access by leaving either or both of the read and write groups blank. The
following table shows how the access in affected in the different combinations.
Table 5-1 Group access rules
Read Read access Write Write access basis

Group Group
Not Everyone Not Security rules only

allocated allocated
Allocated Based on read Not Read group membership and

group allocated security rules
membership
Allocated Based on read Allocated Write group membership and

group security rules
membership
Not Everyone Allocated Write group membership and

allocated security rules

A simple example of using group access is shown in Figure 5-1.

Figure 5-1 Simple RBNS Example
Role 1 Group Role 2 Group
User 1 User 4
User 2 User 5
User 3 User 6
View 1
View 1
Read and Write
Read only Group
Group
Read only access Read and Write access
View 1
In this example there are two sets of users in different role specific work groups.
There is a single view, View 1, which provides two types of access by being associated with
two view groups; the Read Only Group and the Read and Write Group.
To give users in the Role 1 Group read only access to View 1, using the facilities provided by
the Windows operating system, their role group it is added to the View 1 Read only Group.
To give users in Role 2 Group both read and write access to View 1, using the facilities
provided by the Windows operating system, Role 2 Group is added to the View 1 Read
and Write Group.
A more complicated example that builds upon this scenario is demonstrated in Figure 5-2.
Figure 5-2 More Complicated RBNS Example
Role 4 Group
User 9
User 10
User 11
Role 1 Group Role 2 Group Role 3 Group
User 1 User 4 User 7

User 2 User 5 User 8
User 3 User 6
View 1 View 2
View 1 View 2
Read and Write Read and Write
Read only Group Read only Group
Group Group
Read only access Read and Write access Read only access Read and Write access
View 1 View 2

In this case there are two additional workplace roles with their associated users and Windows
user groups.
The Role 3 Group users have read only access to View 2, but both read and write access to
View 1.
Role 4 users have read and write access to View 2, but only read access to View 1.
Thus allocating users to Role Groups and Role Groups to View groups allows a very flexible,
convenient and precise way of administering users access to various sets of data. When role
responsibilities change or users change roles, the system is easy to manage.
5.6 RBNS Builder
The RBNS Builder is available as part of the Exaquantum Administration Tools.
To open the RBNS Builder:
1 Run the Exaquantum Administration Tools.
2 When the main Administration Tools window opens on the left-hand side select the Tree
tab.
3 In the hierarchy, open the System Configuration branch.
4 Select the Role Based Namespace icon.
The RBNS Builder window has two areas:
Namespace selection and display on the left-hand side (section 5.7)
Properties and settings - on the right hand side (section 5.9)
Note: If Role Based Name Space is used, the following must be consistent on all
referenced Exaquantum Servers (as defined in the Exaquantum Server Window in
Administration Tools).
- Windows Group Name and Windows User Name
- Same name Windows User Password
- Windows Group belong to same name Windows User
5.7 Namespace selection and display
The namespace selection on the left-hand side of the RBNS Builder window comprises two
parts:
Current namespace the drop down list at the top left-hand side allows you to select
the namespace to be displayed in both the hierarchy below, and the properties and
settings section on the right. It can be changed by opening the dropdown list and
selecting a new one. If there are no currently defined namespaces then it will be blank.
Namespace hierarchy a hierarchical list of the namespace selected in the current
namespace box above. Highlighting an item in the list will populate the properties and
settings tabs on the right-hand side of the window.
The following controls are available at the bottom of the window:

Refresh
Can be used at any time to refresh the current status of the local RBNS database. In a multi-
server environment, making changes has implications for maintaining the concurrency of the
RBNS across the different servers. Refer to section 5.3 Publishing views across multiple
servers.
Publish
Opens the Publish dialog box for controlling how the changes are made across the available
servers. The dialog displays a list of available servers. Their status is indicated by the color of
the text and icon.
Icon color green The server is available, and changes can be published to it.
Icon color red The server is not available so changes cannot be published to it.
Text color grey There are no changes that need to be published to the server.
Text color black A change has been made locally that needs to be published to the
server
Text color red - A change has been made on that server that needs to be updated on the
local server.
Note: If any of the servers have changes that need to be updated locally, then the Refresh
dialog box will be automatically displayed. This informs you that a refresh operation must be
performed before you can continue.
To publish changes to the servers, highlight them in the list and click on the OK button. Refer
to section 5.3 Publishing views across multiple servers.
New
Opens the Role Based Namespace New dialog box for creating a new namespace view.
The following features are available.
New Enter a unique name for the view. Use up to 32 characters (but avoid some
punctuation such as full stop, comma and colon).
Read Group This defines the Windows user group that will have only read access to
the view. Either type in a valid path, or use the browse button on the right to open a
network browser to locate and select the appropriate Windows user group. Paths are
limited to 512 characters. .Leaving the Read Group not allocated has security
implications; refer to section 5.4.
Write Group This defines the Windows user group that will have read and write
access to the view. Either type in a valid path, or use the browse button on the right to
open a network browser to locate and select the appropriate Windows user group.
Paths are limited to 512 characters. .Leaving the Write Group not allocated has
security implications; refer to section 5.4.
Apply Click on this button to create the new view.
Cancel Click on this button to close the dialog box. Any changes will be lost.
The root of a new namespace view will be added to the hierarchy on the left-hand side of the
window.

Remove
Only available when a namespace is selected in the list. When clicked, opens a confirmation
dialog box before you can remove the view from the list.
Help
Opens the help system.
5.8 Adding and deleting objects from the namespace hierarchy
To add, remove or modify objects in the namespace:
1 In the current namespace dropdown list, choose the namespace to work on.
2 In the hierarchy, identify the object to be modified.
All functionality within the hierarchy is available from the context menu. This is revealed by
right-clicking on an existing object. The choices available will depend on the nature of the
original object. For a list of objects refer to section 5.2 Creating views.
To add an object to the new namespace, right click on it in the hierarchy. From the context
menu that appears, select the type of object you want to add. Fill in the appropriate
information in the tabbed pages to the right and click on the apply button to finish.
In the case of a folder, you must enter a name in the General tab. In other cases, enough basic
information will automatically be provided. The information can be changed, and other
information can be added, at a later stage. When finished, click on the Apply button to add
the new entry to the list.
Add -> Reference Folder Opens the Intrinsic Data selector for choosing a folder that
resides on another server.
Add -> Folder Adds a virtual folder
Add -> Function Block In the General tab on the right, either type in a Path or use the
browse button to locate the required function block.
Add -> Tag In the General tab on the right, either type in a Path or use the browse button
to locate the required function block.
Remove Opens a confirmation box before you can remove the object from the list.
5.9 Properties and settings
This area to the right-hand side of the RBNS Builder window comprises a set of tabbed pages.
The contents are associated with the object currently highlighted in the hierarchy. The number
of tabs shown will depend on the type of the object. The following sections describe the
features of each tab.
General
These are the basic configuration items. The details shown will depend on the type of object
highlighted in the namespace list on the left.
Name A unique name for the object. Use up to 32 characters (but avoid some
punctuation such as full stop, comma and colon).
Item Type Displays the type of object. This field is automatically generated and
cannot be changed.

Server Shows the server from which the object originates. This field is automatically
generated from the path below, and cannot be changed.
Path Configure the location of the object. Either type in the path, up to 512
characters, or use the browse button on the right to open the Intrinsic Data Selector.
Use this to locate the required item from the available sources.
Filters
Allows you to configure the filters that can be used to restrict the number of objects users will
see in the data browser. The type of filtering available will depend on the type of object
highlighted in the namespace list on the left. However in most cases they follow a similar
pattern.
The filter will compare the set of characters you provide, against all the contents of the object
that is being filtered.
The ones that match will either be the only ones shown, or not shown, depending on the
choice you make:
Include ... that match will only display objects that match the characters provided.
Include ... that do not match will display only objects that do not match the characters
provided.
A box is provided where you can enter up to 32 characters you want to match. The usual
wildcards can be used:
? matches any single unknown character
* - matches zero or more unknown characters
For virtual folders, you can choose to include sub-folders.
For Tags and Function Blocks you can choose to show aggregations they contain.
Security
This page is for setting the type of write access allowed. The options will vary with the type
of object highlighted in the namespace list on the left. Write access is also controlled by the
users group membership. Refer to section 5.5 Making views available to users.
The first two options provide blanket coverage:
All The selected object and everything within, will be write enabled.
None The selected object and everything within can be viewed but cannot be written
to.
All except The selection, and all the objects in the Security list (see below), will be
write enabled.
None except - Except for the objects in the Security list (see below), the selection, and
everything within, will be write enabled.
Selecting either of the last two options opens two additional panes in the window:
Security hierarchy A tree like representation of the contents of the selected object.
Security list A list of all the objects, selected from the security hierarchy, which are
to be specially treated for write access.

Objects are added to the Security list by clicking on them in the security hierarchy and
dragging them into the list.
Objects are removed from the list by selection them and clicking on the Remove button.
Note: Only the top level objects in the security hierarchy can be selected.
5.10 Scenarios
The following scenarios are likely to be encountered during the configuration of a namespace:
1 Server selection. From the multiple servers, select one Exaquantum server to be the
master for the RBNS configuration.
2 Configure Windows groups. Where to configure groups, i.e. the domain controller or
local Exaquantum server, depends on the network policy. For information on Exaquantum
network configuration, refer to the Engineering Guide Volume 2 (ref: IM 36J04A15-02E).
3 Assign users to groups. A user may belong to more than one group. This, however can
lead to confusion as to what namespace to use, hence it should be avoided if possible.
4 Create Role Based Namespaces. The name of the namespace is independent of the group,
but it is a good practice to name it in such a way that the group and its role are obvious.
This scenario is expanded below.
Note 1: It is possible to re-assign a group to a namespace. However, this can result in
confusion where some users may no longer have access to resources that used to
be accessible.
Note 2: The Namespace name appears at the beginning of the access path, e.g.
Namespace 1.Folder 1.tag.value. It is possible to change it later; however this
should be avoided wherever possible, as performance may be affected.
5 Publication of Namespaces. Use the Publish option of the RBNS Builder to copy
configured namespaces to multiple servers. If the RBNS contents (and also Exaquantum
server information) have been updated in several servers, there may be some risk involved
in distributing changes to other servers. This is why one server should be selected as the
master server.
Detailed Scenarios
RBNS Creation
1 Design the RBNS Views:
Define roles such as Operator Area 1, Maintenance Area 1, Site Manager, etc.
Allocate WINDOWS groups for these roles.
Roughly decide what information each group should have access to.
2 Create the namespace:
a Use the RBNS builder tool to create a new namespace.
b Select a user group.
c Allocate a name to the view.
Note: The name appears at the top of the path name.

3 Fill in the content.

Add the resources that the group users should have access to.
4 Specify the appropriate properties for each resource in the General, Filters and Security
tabs.
5 Access Control General Policy
There are two distinct types of approach:
Inclusive approach this explicitly specifies which resources to grant access to
Exclusive approach this initially admits access to all, but with the option to disable
access to any information that is too sensitive.
Both approaches are supported for tags/FBs.
6 Write Security Control
Write access is granted or denied on a folder basis, or an individual tag/FB basis.
Create Other RBNS Views for Other Groups
Repeat the above steps for each group.
Changes or Re-configurations
Changing the name of the RBNS view is not recommended as the path name has been stored;
attempts to access it are likely to fail if the path has changed.
If a tag/FB is used anywhere, but is later removed from a RBNS view, read access (and
obviously the write access) will be denied for the group users.

Chapter 6 License Management

6.1 General
The License Management tool is used to enter a new license key code when Exaquantum is
already operational.
6.2 Concepts
License Management
Under normal circumstances, the license key code is entered during the installation procedure
of an Exaquantum server. The License Management screen within the Exaquantum
Administration Tool displays the following license information:
Existing Key Code
The key code currently in use is displayed. It serves here only as a reference.
License Type
The license type corresponding to the key code.
Installation of Expiry Date
The installation expiration date corresponding to the current key code. The key code
cannot be entered after this date. The Exaquantum system will continue to function.
Tags
Licensed
The number of licensed tags that can be created for the entered key code.
Used
The number of tags currently in use. This does not included non historized tags.
Remaining
The number of tags that are still available for use ([Number of licenses] [Number of
used tags]).
Users
Licensed
The number of user licenses corresponding to the current key code.
Features
Web Server
GUI Conversion
Open Interface (OPC Server function).
Batch
21 CFR Part 11
Custom Batch Data Collection
Maximum Active Recipes

6-2 Chapter 6 License Management
New Key Code

Field allowing a new key code to be entered. Once the new code has been entered the
Apply button will be active, which should be pressed. If the key code is valid then the
screen will be updated with the new key code parameters.
Whenever one or more of the above features are added, changed or removed, a new license
key will need to be obtained. The License Management tool is provided for changing the
license key for occasions other than at installation time.
A unique license key is issued on a per-server PC basis. To prevent license keys being reused,
a license will expire at a certain time if the software has not been installed.
The license holds encoded information to identify a customer. Any customers that have
multiple servers configured are also issued with license serial numbers.
License Checking
Periodic License Checking
A license check is performed periodically to ensure that the license is not being breached. If
any breach of the license is found on any of the servers, an entry is written to the Event Log.
A warning dialog is also displayed to users of all servers until the license breach is resolved.
The periodic license checks are:
Whether the licensed number of users has been exceeded
Whether the Historized Tag count has been exceeded
For the existence of duplicate license keys.
Graphics Conversion License Check
Conversion of CS 1000/CS 3000 graphics is a feature of both Exaquantum/Explorer and the
Graphics Editor. The license check of this tool is made when the user starts the package. If
the license key code does not enable graphics conversion, the option is suppressed from the
menu. The user can continue to use Exaquantum/Explorer or the Graphics Editor to construct
screens containing graphics from scratch.
6.3 Scenarios
A typical scenario would be where a customer who has been using Exaquantum/Explorer
clients to visualize Exaquantum data decides to add the Exaquantum/Web option, as part of a
transition to web-based technology.
When such a customer purchases the Exaquantum/Web option, a new license key will be
allocated. A number of web user licenses, and the Graphics Editor package to enable the
drawing of process mimics for the web, will also have been purchased. The new license key
(when added using the License Management tool) will enable the Web server software and
other features to be installed or added to the system. Refer to the installation guide for some
information on upgrading the system.

Chapter 7 User Monitor

7.1 General
The User Monitor tool is used to view a list of user logon/logoff events for the local
Exaquantum server. To this end the administrator can:
View users who are currently logged on remotely to the Exaquantum server.
View a historical record of remote users who were logged onto the Exaquantum server at a
specific time.
View a historical record of remote users who were logged onto the Exaquantum server at
some point between two times.
View a historical record of remote users who were logged onto the Exaquantum server for the
whole period spanning two times.
Turn user logging on/off
Notes:
- Only logins to the Exaquantum server from remote client machines are recorded in the
user log. Logins which take place on the local machine (i.e. on the Exaquantum server)
do so through a resident process which stays logged in whilst Exaquantum is running.
- In some circumstances a user who has disconnected may continue to appear in the list of
current logged in users for a short period, usually no more than 3 minutes. This is
normally caused by a delay in closing the client connection. In addition, on recovery from
a network failure a user who reconnects to Exaquantum may appear more than once in the
list of users logged in - old connection details will be removed within a few minutes. If a
client appears incorrectly as logged in for a longer period of time the client may be
forcibly removed by ending the processes Quantum.exe and QClient.exe running on the
client machine using Windows Task Manager. Where the client is connected through
Terminal Server, the relevant client processes may be viewed and identified by adding the
User Name column to the Task Manager Processes view on the Terminal Server machine.
- An asterisk will be added after the User Name (i.e. Quantumuser*) if the user has been
granted elevated privileges as part of Windows User Account Control (UAC). This occurs
when certain programs require administrative privileges to run (such as Microsoft
Management Console which is required by the Exaquantum Administration Tools).
NOTE - User Account Control applies to all Windows Operating systems supported by
Exaquantum.
-
The same user may also appear as logged in twice if they are running both the
Exaquantum Administration Tools and another Exaquantum client application, for
example, Exaquantum Explorer, on a client PC.

7-2 Chapter 7 User Monitor
7.2 Viewing a list of users who are currently logged in

Note: Login details are not available for pre-R2.02.50 clients: they will be shown as n
Unknown Users where n is the number of pre-R2.02.50 clients registered with the
server.
To view a list of users who are currently logged in: -
1. Click on the button labeled Show users logged in now.
2. Select the number of users to show in the data grid by altering the Max Events field or
accept the default of 1000.
Note: If the set of matching records is greater than the MaxEvents field then the
newest logon events are displayed.
3. Click the Refresh button.
Note: The results can be sorted by clicking on the appropriate column header in the data
grid.

7.3 Viewing a list of users who were logged in at a specific date/time

Figure 7-1 describes which login records are returned by this function (the blue bar denotes a
record where a user was logged in at the specified time; the red bar denotes user login records
not returned by the function).
Figure 7-1 Example login records which correspond to users logged in at a specific time
May 2009 Jun 2009
ID Start User User
19 20 21 22 23 24 25 26 27 28 29 30 31 1 2 3
1 25/05/2009 3d Fred
Login Record
2 24/05/2009
Returned by 2d Daphne
Function
3 27/05/2009 2d Wilma
4 Login26/05/2009
Record Not 1d Wayne
Returned by
5 Function
22/05/20099 10d Chris
6 24/05/2009 2d Justin
7 28/05/2009 2d Barrie
Time
To view a list of users who were logged in at a specific date/time: -

1. Click on the button labeled Show users logged in at.
2. Specify the date/time in the date/time field.
3. Select the number of login records to show in the data grid by altering the Max Events
field or accept the default of 1000.
Note: If the set of matching records is greater than the MaxEvents field then the oldest
records are omitted.
grid.

7.4 Viewing a list of users who were logged in at some point between
two date/times
record where a user was logged in at some point during the specified time period; the red bar
denotes user login records not returned by the function).
Figure 7-2 Example login records which correspond to users who were logged in at some
point between two date/times
May 2009 Jun 2009
ID Start User User
19 20 21 22 23 24 25 26 27 28 29 30 31 1 2 3
1 25/05/2009 3d Fred
Login Record
2 24/05/2009
Function
3 27/05/2009 2d Wilma
4 Login26/05/2009
Record Not 1d Wayne
Returned by
5 Function
22/05/2009 10d Chris
6 22/05/2009 2d Justin
7 29/05/2009 2d Barrie
Start Time End Time
To view a list of users who were logged in at some point between two date/times: -
1. Click on the button labeled Show users logged in between.
2. Specify the start of the period in the first date/time field.
3. Specify the end of the period in the second date/time field.
4. Uncheck the box marked For whole duration.
Note: If the set of matching records greater than the MaxEvents field then the oldest
grid.

7.5 Viewing a list of users who were logged in for the whole period
spanning two date/times
record where a user was logged in for the whole time period specified; the red bar denotes
user login records not returned by the function).
Figure 7-3 Example login records which correspond to users who were logged in for the
whole period spanning two date/times
May 2009 Jun 2009
ID Start User User
19 20 21 22 23 24 25 26 27 28 29 30 31 1 2 3
1 25/05/2009 3d Fred
Login Record
2 24/05/2009
Function
3 27/05/2009 2d Wilma
4 Login26/05/2009
Record Not 1d Wayne
Returned by
5 Function
22/05/2009 10d Chris
6 24/05/2009 4d Justin
7 25/05/2009 4d Barrie
Start Time End Time
To view a list of users who were logged in for the whole period spanning two date/times: -
1. Click on the button labeled Show users logged in between.
2. Specify the start in the first date/time field.
3. Specify the end in the second date/time field.
4. Check the box marked For whole duration.
Note: If the set of matching records is greater than the MaxEvents field then the oldest
grid.

7.6 Turning User Logging On/Off

When user logging is turned on, any logon/logoff events are recorded on the Exaquantum
server.
To turn user logging on: -
Check the box marked Logging enabled.
To turn user logging off: -
Uncheck the box marked Logging enabled.

Chapter 8 Tag Template

8.1 General
Tag Template is used to define the structure and properties of a tag. It can be used as a base
to create, and subsequently modify, many tags that have similar characteristics.
If a Tag Template is changed after tags have been created based on it, the structure and
properties of these tags are not automatically updated; that is, the changes are not applied
retrospectively. However, these tags can be updated to reflect the changes by carrying out the
generation process again. In order for existing tags to reflect changes, it is necessary to run
the appropriate tag generation operation for such tags. Any tags that are created subsequent to
a change to a Tag Template take on the properties of the new version of that Tag Template.
Tag Template Version
Tag templates are maintained by versions. When a template is created, a version label is
automatically assigned as an incremental number, starting from 1 (this number is displayed in
the Tag Template Version field). When any version of a template (either the latest version or
an earlier one) is modified, a new version is created and becomes the latest one at that point.
If a version other than the latest one is modified, it is always automatically assigned the next
incremental number. If the latest version is modified it is automatically assigned the next
incremental number unless no tags have yet been built to the current version and no Tag
Generation activities are currently in progress. A version label can be amended to include
descriptive text.
See Chapter 1, Section 1.6 for more information on the purpose and version control of tag
templates.
8.2 Concepts
A tag template can be assigned one of two basic aggregation types:
Continuous (analogue values)
Discrete (digital values).
The subsequent template options change depending on which type is selected.
The frequency at which raw values are sent to the historian can also be set through the tag
template; the options are:
None (do not write values to the Historian)
On Change (write a value to the historian only when the value changes, irrespective of how
long after the previous write); the default
Specific frequencies. Tag values are written to the Historian at the selected frequency, only if
the value has changed. Intermediate values are ignored. If there are no changes within the
specified time, the value is not written.

8-2 Chapter 8 Tag Template
Data Types
When tag templates are created, the data type must be specified in accordance with the
expected data and the potential range of values that will need to be stored. The available
options are:
Table 8-1 Tag Template Data Types
Data Type Range of Values

Integer -32768 to 32767
Long Integer -2147483648 to 2147483647
Single-Precision Floating-Point -3.4E+38 to 3.4E+38
Double-Precision Floating-Point 1.7E+308 to 1.7E+308
String Max length 256 characters
Reference Data
Tags may be created with additional reference data items, as well as the main value item.
These reference data items are:
Table 8-2 Reference Data Items
Name Description
Descripti Descriptive text for the tag
on
LowEng Lower limit of engineering range for the tag
HighEng Upper limit of engineering range for the tag
Units Engineering units for the tag
For OPC tags the reference data information is read from the PCS when tags are first created,
unless the associated OPC server does not support property access. For manual and
calculated tags the reference data information is entered via the Tag Editor (Chapter 11), and
Tag Generation (Chapter 10).
OPC Communication
This comprises the Update Rate and the Percent Deadband, and is only pertinent to OPC tags.
The Update Rate is used to specify the OPC update rate. The Percent Deadband is used to
specify the OPC Deadband as a percentage of the engineering range. OPC items can be
written to the OPC server, if the user has the authority. The OPC server uses the Update Rate
and Percent Deadband values to determine, for each tag scanned, if Exaquantum needs to be
notified of any change.
The value in the Update Rate field specifies the minimum time interval between OPC
notifications, i.e. the fastest rate at which data changes may be sent to Exaquantum. If the
value changes many times within the update period, only one value scanned by the OPC
server at an appropriate time is sent to Exaquantum.

Note: When the update rate of an OPC Tag is changed from Low Scan (more than 10
seconds) to High Scan (less than 5 seconds), please monitor the QHistorianData
database space used (before and after the update rate change). This is because the
rate at which database space is used may increase after changing the update rate. An
alternative is to delete the OPC tag, change the update rate, and then re-add the tag.
The disadvantage of this alternative is that the tag history will be lost, after it is
deleted.
The Percent Deadband is an upper and lower threshold pair, expressed as a percentage of the
tags engineering range. A value is only notified to Exaquantum if its value at the end of the
update period has changed by more than the Deadband.
A value can be selected from the Update Rate list by the user, but this may be modified by the
OPC Server when data is acquired using the OPC Communication setting. Such a
modification may occur if the OPC Server cannot support the value selected or the additional
sampling load. This behavior may vary from one OPC server to another. For Yokogawa
Exaopc, see the Yokogawa document NTPF100 Exaopc OPC Interface Package Guide
Manual, ref. IM 36J02A11-01E.
When a tag is configured to write to an OPC server, the Deadband value is automatically set
to 100, meaning that the default is then set to not read the value back from the OPC server.
This setting is made because it is strongly recommended to separate reading from writing due
to a potential problem taking place when:
Exaquantum application writes more frequently than the update rate
OPC server notifies data with a timestamp of an earlier update timing (which is the case of
Yokogawa Exaopc) that result in an error of receiving obsolete data.
Users can manually change the Deadband value under their responsibility.
Note: Setting the Deadband 100% to OPC server may not necessarily mean that the OPC
server does not notify data to Exaquantum, if the OPC server does not fully support
the Deadband feature.
Aggregations
Aggregation Calculated Tags
A template can be created for Aggregation Calculated Tags. This allows the base
aggregation results to be generated by the tags calculation script, rather than the aggregation.
For example, in order for the user to calculate the hour average as half the numerical
average of the hourly mean for Tag 1 multiplied by a manual entry value ManTag , a new
aggregation calculated tag (CalcTag) is required with the following script:
If ([Root.Tag1.Aggregations.Hour.Mean.Value].Changed)
Then
[Result.Aggregations.Hour.Mean.Value]=
[Root.Tag1.Aggregations.Hour.Mean.Value]/2 *
[Root.ManTag.Value]
End if

Note 1: This script is special because it contains a result that refers to the calculated tags
own aggregation result [Result.Aggregations.Hour.Mean.Value].
Note 2: The if statement is required to ensure that the result of the calculation is only
calculated on the hour boundary. If this were not included then the script would fire
and generate the aggregation result at any arbitrary time as defined by ManTag
changing.
To use this option, specify the aggregation data creation method during each aggregation
period on the Aggregation tab sheet. If the creation method is Auto (default), aggregation
data is automatically calculated and created. If the creation method is Calculation, data
during the relevant aggregation period is created from the script. The creation method can be
changed to Calculation only if the selected Tag type is Calculation and the relevant
aggregation period has been selected.
The calculating formula of aggregation calculations needs to calculate and create all the
selected basic summation result data. For example, if a tag template has a following
definition:
Generate From Calculation is selected
Hour, Day and Month production calendar selected
Mean and Summation aggregations selected
The correct script would be:
If [Root.Tag1.Aggregations.Hour.Mean.Value].Changed then
[Result.Aggregations.Hour.Mean.Value] = (some value)
[Result.Aggregations.Hour.Summation.Value] = (some value)
End if
In the above example, if only Mean is written (i.e. without second [Result.] line defined),
the Mean aggregation result of Day (and Month) would be 0, Bad quality.
Aggregation Calculations
The options vary depending on which Aggregation type is selected.
Table 8-3 Aggregation Types
Type of data Types of Aggregation calculations
Continuous data Sum, Mean, Minimum, Maximum, StdDev, Spot
Discrete data Status count, OnTime
These aggregation values are calculated and stored for each Aggregation period.
Note: A PercentTimeGood aggregation is always created if any aggregation calculation is
selected.

Continuous
There are six aggregation calculations associated with Continuous:
Minimum calculates and stores the minimum value achieved during each aggregation period
selected. The timestamp indicates when the minimum value was recorded.
Maximum calculates and stores the maximum value achieved during each aggregation
period selected. The timestamp indicates when the maximum value was recorded.
Mean calculates and stores the arithmetic mean achieved during each aggregation period
selected
The calculation of the Mean is based on the difference between the timestamp of the
current input notification and the equivalent timestamp form the previous input
notification as follows:
Mean = ( ( Mean * Ttotal ) + (( Vn-1 ) * ( Tn Tn-1 )) )/ ( Ttotal + ( Tn Tn-1 ) )
Where:
Mean Is the accumulating mean.
Ttotal Is the accumulating time for the input being valid i.e. its data quality was either
GOOD or Uncertain.
Vn-1 Is the value of the input at the last time notification.
Tn-1 Is the timestamp of the input at the last time notification.
Tn Is the timestamp of the input at this time notification.
Standard Deviation calculates and stores the standard deviation achieved during each
aggregation period selected
Note: Mean must also have been selected for Standard Deviation to work.
The standard deviation builds upon the Mean calculation shown above:
SumOfXSquared = SumOfXSquared + ( ( Vn-1 )2 * ( Tn Tn-1 ) )
StdDev = Sqrt((( SumOfXSquared ) ( Ttotal * Mean2 )) / Ttotal 1)
Spot Value reads the value at the end of the period and stores it at the end of each
aggregation period selected. The value at the beginning of the period may be selected by
setting the following registry value to 1 (the default value is 0)
HKLM\Software\Quantum\Server\AggSpotValueAtPeriodStart = 1
The Exaquantum server must be restarted for a change in this value to take effect.

Summation calculates and stores the value totalized over each aggregation period selected
There are two ways used to calculate the Summation that depend on the Summation
TimeFactor configured for the aggregation calculation:
When Summation TimeFactor > 0, Integration summation is used.
When Summation TimeFactor = 0 , Simple summation is used.
These two methods are explained below.
Summation TimeFactor > 0 (Integration Summation)
The Summation Time Factor (STF) option is used to correct the units of measurement in a
summation calculation. For example, if a flow rate is measured in Tonnes per hour, and
the raw value represents this summation value, then the Hour option should be selected in
the STF list to get the correct values (in Tonnes) for the aggregations. The sum of the
values over the aggregation period is divided by the STF to correct the final value. The
STF may be set to 1 Day for rates measured per day this is a fixed 24 hour period.
Setting the STF to 0 gives a simple summation of individual new values over the period.
The time difference between the timestamp of the current input notification from the
timestamp of the previous input notification is used to calculate the contribution towards
the summation.
Sum = Sum + ( Vn-1 ) * ( Tn Tn-1 )
Where:
Sum Is the accumulating summation.
Vn-1 Is the value of the input at the final requirement time.
Tn-1 Is the timestamp of the input at the final requirement time or the
timestamp of the start of the current aggregation period if no notifications have
been received during the current period. T is measured in units of 100
nanoseconds.
Tn Is the timestamp of the input at this data.
At the end of the aggregation period, the summation is calculated as:
o Summation = Sum / (10,000,000 * TimeFactor)
o Summation TimeFactor = 0 (Simple Summation)
At the beginning of the aggregation period the internal summation is reset to zero. As
each input notification arrives, it is added to the summation. The summation result is the
accumulated summation at the end of the aggregation period.
Differential summation A difference (current value last value) during each selected
aggregation period is calculated and saved taking into consideration the counter reset
value.

A summation reset value is a reset value on a summation counter used for calculation in
differential summation. In the case where the current value is less than the previous value,
then the result (of the aggregation) would be negative. In this instance, the aggregation value
is calculated by adding the summation reset value to the negative result.
Depending on the data type, the value is checked as follows: (In the case of out of range data,
an error message is stored in the Application Event log.)
Integer : 1 - 32767
Long : 1 - 2147483647
Float : 1 - 1000000
Double : 1 - 10000000000000
Some special instruments may collect values that differ from normal values with a certain
range of deviation. This data deviation can be ignored by setting a valid percent difference.
If a data deviation larger than the valid percent difference occurs during periodic data
collection Exaquantum judges the data as an invalid and will not perform the differential
summation process. The valid percent difference default value is 100 (%). Set a valid percent
difference between 0 and 100.00. The differential summation data may be rounded to a
number of decimal places. The default number of decimal places is 0.
Depending on the data type the number of decimal places is checked as follows:
Integer - 0
Float - between 0 and 6
Double between 0 and 13
Discrete
There are three options associated with Discrete:
On State this field must contain a numeric value or text; this is used in the aggregation
calculations for State Count and State on Time.
State Count when checked the aggregation calculation will count the number of times
during the period that the tag changes from a value not equal to the On State value, to a
value equal to the On State value.
State On Time when checked, the cumulative time (in seconds) that the tag spent during
the period at the value (or state) specified in the On State field is calculated.
Aggregation Periods
The aggregation periods related to the Tag Template are those that were set in the Production
Calendar (see Chapter 3).
8.3 Associated Screen
Version Labeling Dialog
This pop-up dialog is displayed when the Label Version button is pressed and contains a two-
column table. It allows the user to add more information to the Tag Template Version field
on the Tag Template.

8.4 Scenarios
The Tag Template is used to define the structure and property of a tag. The left section of the
Tag Template contains the list of templates that are available for viewing and/or selection.
Note1: Any invalid tag templates are shown in red. (If changes are made to the Production
Calendar, for example, after tag templates have been created, some of the tag
templates may become invalid.)
Note2: The tag template names starting with C3TC:: are used with the HIS Trend Tag
Generation function. Therefore, do not use any of them for a newly-created tag
template name.
For detailed information about the tag templates starting with C3TC::, refer to
Chapter 17 HIS Tag Generation.
These are some of the scenarios in which the Tag Template could be used:
Create a Tag Template, initially filling all of the fields.
Copy an existing Tag Template.
Change an existing template when:
The OPC data update rate needs to be tuned, for example there is a need for finer
monitoring; change the default rate of 1 minute to 5 seconds.
The Raw historian interval needs to be adjusted; for example On Change was
originally selected, but it consumes more disc space than is practical; change the rate
to 5 minutes.
Other aggregation calculation(s) and/or period(s) are required.
Note: Occasionally, when a tag modification to add an aggregation calculation (e.g.
mean, min, max) to an existing aggregation period is made, the following error
message will be reported in the Event Log:
Event ID = 62101 The timestamp of the triplets are out of range
This is a timing issue and does not cause any operational problems. The message
can be ignored.
Derive a new template based on an existing template when:
The Data Type was improperly defined, for example a typical numeric type is used to
get MODE data (string type).

Chapter 9 Function Block Template

9.1 General
The Function Block is a mechanism by which information system orientated users can build
their own functioning units in the form of collections of tags. The purpose of the Function
Block Template is to define members of a function block. The members details (most
importantly the calculation) can also be defined here. Most function blocks essentially consist
of a mapping to inputs (OPC tags) and the way in which they are processed (calculated tags).
The input can take one of two forms:
Direct OPC specification
To define the OPC server and OPC item ID from which the data is assigned.
Shortcut to Exaquantum Tags
Since functioning units can be created or changed whenever new requirements come out,
it is wise to set up a separate set of OPC tags to keep gathering Historian data, and make
use of these tags without affecting Historian gathering. For this purpose, a function block
OPC tag can use a shortcut to share the information that is ready for use. A function block
tag can be a shortcut to other input tags (OPC, Man or Calc), so that expressions of
function blocks tags can be independent of the paths of referencing tags. This allows the
expression to remain intact, even if the path of the referencing tag is changed.
Note: In a function block that defines a shortcut tag, if a calculated tag that uses a shortcut
inside of another shortcut is registered, an error will occur in the tag editor calculation
formula display. However, the calculations will still be performed as normal. When it's
necessary to edit a calculation formula, edit from the calculated tag of the reference source.
Associated with the Function Block Template are the Function Block Detail screens that are
used to define member tag(s).
9.2 Concepts
The settings that are saved in a Function Block template will determine which tags are created
when a Function Block is generated. Numerous function blocks can be created based on a
single Function Block template. As a result of this, using Function Block templates allows for
easy configuration and update of many function blocks at one time. Through the Function
Block Template the user can:
Create a new Function Block Template
View defined Function Block Templates and their settings
Modify a Function Block Template
Delete a Function Block Template.
Copy a Function Block Template.
If a calculated tag makes reference to other member tag(s) within the same template, the
referenced tag(s) should appear before the calculated tag. The order can be adjusted by a pair
of optional buttons that are enabled only when a calculated tag is selected. When a template
contains more than one calculated tag, the order must be similarly set.
Note 1: Two calculated tags cannot reference each other; this situation is recursive and
results in an infinite loop of firing each other forever.

9-2 Chapter 9 Function Block Template
Note 2: Altering the order alone does not create a new version of a template.
Function Block Template Version
Function Block templates are maintained by versions. When a template is created, a version
label is automatically assigned as an incremental number, starting from 1. This number is
displayed in the Function Block Template Version field (which is a drop-down list). When
any version of a template (either the latest version or an earlier one) is modified, a new
version is created and becomes the latest one at that point. If a version other than the latest is
modified then it is always automatically assigned the next incremental number. If the latest
version is modified it is automatically assigned the next incremental number unless no tags
have yet been built to the current version and no Tag Generation activities are currently in
progress.
9.3 User Interface and Associated Screens
User Interface
A list of the currently defined Function Block templates is displayed on the screen. Any new
Function Block templates that are created are added to this list. The screen contains various
control buttons. It also contains a table that shows the tags that are associated with the
currently selected function block template. New tags can be added, and existing tags can be
deleted or modified. Tags are identified by an internal number called the Tag ID. When a
new tag is created, Exaquantum automatically allocates the number, starting from one.
Associated Screens
Function Block Detail Screens
There are three Function Block Detail screens associated with the Function Block Template
tool; they allow the user to specify additional information about a tag. These three screens are
for OPC, Manual and Calculated tag types.
There are two types of values:
Initial values copied and used only when function blocks are being created. They are:
Description
Units
Engineering High/Low
Value (for Manual tag type only).
Controlled values can affect function blocks both when they are being created and later in
relevant function blocks, when any changes made should be reflected. The category
includes calculation expression (calculated tag).
Tag details are defined in accordance with the associated tag templates; units and engineering
ranges are editable only when the template has these values selected.
The reference data of OPC tags is handled differently from that of other tag types. When you
define the OPC tag detail, the tag is not yet associated with a particular OPC gateway. An
OPC gateway, hence the OPC tags accessed through it, may or may not support the reference
data access (or property access). If it does, whatever is defined as the tag detail will be
overwritten by the OPC values when a tag is created. If it does not, the values defined here
will be used as the initial values.

Version Labeling Dialog

This pop-up dialog is displayed when the Label Version button (on the Function Block
Template) is pressed; it contains a two-column table. This table enables the user to add more
information to the Function Block Template Version field on the Function Block Template.
9.4 Scenarios
The Function Block Template is used to define the Function Block template specification.
Some typical scenarios associated with the Function Block Template are:
Initially create a Function Block Template.
Change the expression of a calculated tag
A calculated tags expression is a controlled field; when changed, such changes can be
deployed to existing function blocks by rerunning the relevant tag generation job (see
Chapter 10).
Change a member tag name.
Change the data type of a tag.
Note: When one or more function blocks have been created based on a template, the
data type of a tag cannot be changed; changing only the data type is not a
compatible change to existing tags. In this case the tag must be deleted and a
new one created with the same name. Even though the name looks the same,
they are recognized as being different; the older tag will be removed and the new
one created.
Any changes to the Function Block template are implemented when new Function Blocks are
created, or the Tag Generation job is re-run explicitly for existing ones.

9-4 Chapter 9 Function Block Template

Chapter 10 Tag Generation

10.1 General
Tag Generation is the tool that enables the user to create or update a large number of tags
and/or function blocks at one time. There are four different programs available. Three are for
the generation of function blocks, and the fourth is for the generation of tags:
deleted.
OPC Equalization (for the generation of function blocks OPC browse based)
OPC File Import (for the generation of function blocks file based)
Function Block Generation (for the generation of function blocks file based)
Tag File Import (for the generation of tags file based).
These programs are described in Section 10.2.
10.2 Concepts
Tag Generation Programs
The four Tag Generation programs are described in more detail below.
OPC Equalization
This is OPC browse based, function block generation. It allows a large number of function
blocks to be easily built within an Exaquantum system as long as these conditions are met:
OPC servers should be set up properly
OPC servers are Exaopc-CS cassette
PCS tag naming convention meets the Exaquantum filter requirements.
Note: When a function block contains a calculation tag, during an equalization that does not
create the tag, the analysis may show the tag as being upgraded, even if there is no change to
the tag.
OPC File Import
This is File-based, function block generation. This process generates Exaquantum function
blocks from a file containing a list of OPC tags. It does not need any of the conditions
required for OPC Equalization.

10-2 Chapter 10 Tag Generation
Function Block Generation

This is file-based, function block generation. It allows the user to generate function blocks
with additional features such as the logical function block name or the use of a shortcut.
This program gives the user two advantages that the two other function block generation
programs do not provide:
It can assign a logical function block name (the two others have to use PCS tag names)
It provides a way to assign a shortcut.
Tag File Import
This is file-based, tag generation. It is the only method available to create flat tags based on
files.
Job Names
Each Tag Generation job has a name assigned to identify the job created, and is effective for
applying changes to subject function blocks/tags. The Job name should be unique within a
program scope (OPC Equalization, OPC File Import etc.), but can duplicate across the scope.
This is because the Tag Generation program adds a short identifier at the beginning of the job
name:
OPC : job_name OPC Equalization
Ofile : job_name OPC File import
FB : job_name Function block generation
Tag : job_name Tag file import
Definition File Syntax Rules in General
Three of the four programs are file-based, and a set of common rules apply to the syntax in
general:
The first line is always a comment. A user may place a comment line in other places within a
file, but it must be preceded by a # (hash) character at the beginning.
Note: In-line comment is not available.
Case-insensitive is the rule. This applies both to keywords of the file and to contents of
definition. No case conversion takes place, and the inputs are fed to programs just as they
are.
Note: OPC item ID may be case-sensitive on the OPC server. This is true for Exaopc
and Yokogawa CENTUM systems, where any OPC item ID should be upper case.
Delimitation of keywords is a comma (,) so they should not be used in strings, for example a
template name. A new-line code (carriage return) has a similar effect of delimiting
keywords. If a content string contains new-line characters (which is a common case of the
scripted calculation expression), the string should be enclosed with double quotes. If the
string itself has to contain a double quote character, one escaping double quote preceding
another will allow this, for example:
SCRIPT="[Result]=""00""+Cstr(Day(Now))"
Whenever contents can be in the native language, e.g. the template name, the user can specify
values in the native language.

In a single file, tags/function blocks must be unique. If a name is made up of full size (zen-
kaku in Japanese) kata-kana characters and another name half-size (han-kaku in Japanese)
kata-kana characters, they are regarded as an identical name. Such a file is therefore
invalid, although those names are differently treated once they have been created
separately.
There is also an individual set of keywords that are applicable to each of the files; these are
described in Section 8.5. The file format associated with OPC File Import, Function Block
Generation and Tag File Import are also described in Section 10.5.
10.3 User Interface
Associated with each Tag Generation program is a wizard that guides the user through the
various stages of the process.
Common Screens
Three screens are common to all four programs: the Job Viewer, Analysis Report and
Summary screens.
Whichever program is selected, the first screen displayed is a Job Viewer screen. This allows
the user to choose whether to rerun an existing job, or start a new job. There is a separate Job
Viewer screen for each process. If a job is cancelled part way through the wizard, the user is
returned to the appropriate Job Viewer screen.
Before generation actually takes place, an Analysis Report is displayed. This shows the
settings selected, providing a summary of what the outcome of the operation would be, if the
user chose to proceed. A table of detailed actions and reasons is also available. This is
important because it gives the user a chance to make a detailed check of what will take place
and, if required, change the operation or even cancel it.
When the job has finished, a Summary of the operation is displayed. This information is
retained for future reference.

Specific Screens
In addition to the common screens described above, each of the tag generation wizards
contains some specific screens:
OPC OPC File Function Block Tag File

Equalization Import Generation Import
Job Definition Job Job Definition Job

Definition Definition
View View View Recursion View

Recursion Recursion Recursion
Inclusion Definition
Filters File
Exclusion
Filters
Some of these screens are described below.

OPC Equalization Inclusion Filters
This allows source PCS tags to be picked up by way of naming filters. A filter consists of a
number of elements:
Instrument Type
This gives the user the option to work with a reduced subset of PCS tags. The field
contains a selectable list of instrument types, derived from the source OPC server. The
default is *.
Inclusion Name Filter
A string that is composed of any alphanumeric characters and matching operators, such as:
? Any single character (including digits).
* - Zero or more characters (including digits).
# - Any single digit (09).
[charlist] any single character in charlist.
[!charlist] any single character not in charlist.
[start-end] any single character inclusively between start and end.
Target Folder
The full path name of a folder in which function blocks should reside.

Function Block Template

Select a function block template on which the function blocks should be created.
Tag Details
When a function block template is selected, a list of OPC tags associated with the selected
function block is displayed. There are two columns:
Tag name: shows OPC tag names
PCS Item Name: specifies the item name part of OPC item ID (PV, SV or MODE are
typical examples). When a value is entered and it is correct, the value will be recorded
and will become a selectable entry in the drop-down list in successive operations.
OPC Equalization Exclusion Filters
This screen provides the option to exclude any of candidates that have been selected by the
Inclusion filter, but should not be built at this time.
Tag File Import Definition File
This screen allows the user to select the import file to be used with the job. For users who are
not familiar with the file format, the View File Template button is useful as a starting point to
define the file.
All View Recursion
After the generation process has occurred, the Summary window is displayed. If any
instances of recursive Tag references were identified during generation, the View Recursion
button will be enabled. Clicking on the button will display a separate dialog box containing a
list of all the Tags affected. A printout of the list can be obtained by clicking on the Print
button.
Tags that are recursive will not be enabled. To cure any of the problems of recursion
identified in the list, go back and edit the Tag Import file. After eliminating any recursive
references, re-import the file.
10.4 Scenarios
There are two situations in which the four tag generation programs can be used:
To initially create function blocks/tags
To apply changes to existing function blocks/tags.
Note: If QHistorianData free space is less than 10% or 500MB whichever is the less, no folder,
tag, and function block can newly be created.
In both cases, similar functionality is also available through the Tag Editor program. The
differences between the two are described in more detail in Chapter 11 (Tag Editor); a
summary of the differences is given here:
Tag generation programs are suitable for creating and modifying a large number of function
blocks and tags, while the Tag Editor can create or modify one function block or tag at a
time.
Tag generation operation can be saved in the form of a job, which allows re-run of the job to
apply changes later; the Tag Editor is an interactive method that does not record
operations.

When the Tag Editor is used to delete a tag, users are prompted to check for any existing
references (the Cross Reference feature). However, the tag generation programs don't provide
this feature and users should check the references in advance. The practical way to perform
this check is to carefully look at the analysis report that will be presented whenever tag
generation is attempted. When a broken shortcut is being restored, the analyzer puts two
actions to recreate the calculation. For example:
FB1
!shortcut
!calc : [Result] = [Parent.shortcut.value]
Assign FB1.shortcut to Root.Tag1, then remove Root.Tag1, and restore it by assigning it to
Root.Tag2.
10.5 File Formats
The format of the files differs for each of the file-based generation programs. These three
formats are described below.
OPC File Import File format
The file consists of two parts; common definition and candidates list.
Note: In this file format, each of keywords should appear in a separate line.
Common Definition
There are a number of keywords that define how to generate:
Template
To specify the function block template from which function block(s) should be generated.
Item
To assign OPC tags of the function block with the data item part of the OPC item ID. See the
figure below.
This keyword should appear as many times as the number of OPC tags in the function block.
Note: An item delimiter character should precede the data item string; in the case of
Exaopc a dot (.) character. Also, make sure the case matches the OPC servers
specification.
For example: Exaopc requires a keyword like Item = tag 1, .PV
OPC Server
To select one of the OPC gateways defined in the OPC Gateway screen.
OPCitemIDPrefix
To put a string before the PCS tag name. See Figure 10-1 below.
Note: This is an optional keyword, unlike other mandatory keywords.
TargetPath
To specify the folder where the function blocks are to be created.

Candidates List
Place a keyword Candidates, followed by a list of PCS tags for which the function blocks
will be created.
Note: The list should not contain any duplicating PCS tag names.
To summarize, Figure 10-1 below shows how a function block name is assigned, and how an
OPC item ID is constructed.
Figure 10-1 Function block name assignment and OPC item ID construction
Template =
Item = tag 1, .PV Function block name OPC item ID
Item = tag 2, .SV
OPCServer = Folder_path . TEST001 . tag 1

TargetPath = folter_path
OPCitemIDPrefix = area1/ Area1/TEST001.PV
Candidates
TEST001 Folder_path . TEST001 . tag 2
TEST002
Area1/TEST001.SV
Function Block Generation File Format

A file can have definitions of as many function blocks as required. A definition of a function
block consists of two parts; Function Block specification and OPC items specifications.
Function Block Specification
This is a single line with a set of keywords as follows:
FBname
To specify the logical function block name. By logical it is meant to be able to use
Exaquantum function block name, not bound to PCS tag name as in other function block
generation programs.
FullPath
To specify where to create the function block
FBTemplate
To designate the function block template from which the function is to be created.
OPC Items Specifications
This is an optional specification that is required for every OPC tag of a function block
template. If the function block template has no OPC tags, none is required. One line of
specification should appear for each OPC tag.

FBItem
To specify an OPC tag name of a function block.
FBItemID
To specify an OPC item ID, including the data item name.
Note: Make sure the case matches the OPC gateway expectation.
Or
Shortcut
To specify an Exaquantum OPC, Manual or Calculated tag full path name to which a shortcut
is assigned.
OPCGateway
To specify an OPC gateway to which the OPC item ID is allocated.
Note 1: This is the required syntax, even when you use Shortcut.
Note 2: You cannot specify a shortcut that references another tag within the same file that is
going to be created together. The shortcut target must exist before running the
generation job.
Tag File Import File Format
A file can have definitions of as many tags as required. One definition of a tag consists of a
set of keywords, each of which is delimited by a comma (,) and may split across multiple lines
with placing a delimiter at the end of a continued line. Keywords can be placed in any order.
Note: When a definition spreads across lines, do not place a comment line, which begins
with a hash (#) character, between continued lines.
Tag
To specify the name of a tag to be created. A maximum of 32 characters, and NLS
compatible.
TagType
To select the type of a tag out of; MAN for manual tag, CALC for calculated tag, or OPC for
OPC tag.
TagTempl
To specify a tag template based on which a tag will be created.
Description
To supply a description of a tag. A maximum of 256 characters, and NLS compatible.
<Optional>
FullPath
To specify where to create the tag. A maximum of 256 characters, and NLS compatible.
<Optional>
Note: If FullPath is not specified then the tag will be stored in the folder selected from the
Job Definition screen.

HighEng
To supply a high engineering range. <Optional>
LowEng
To supply a low engineering range. <Optional>
Units
To supply an engineering units. A maximum of 256 characters, and NLS compatible.
<Optional>
Value
To specify the initial value of a Manual tag. <MAN only>
Script
To specify the calculation expression. If the expression must spread across lines, enclose the
expression by a pair of double quotes. <CALC only>
ItemID
To specify OPC item ID. Make sure that the case is in line with the OPC expectation. <OPC
only>
OPCGateway
To specify the OPC gateway. <OPC only>
Note 1: Description, HighEng, LowEng, and Units (often called reference data) may or may
not be specified regardless of the tag template option selection. If the template does
not select some of this reference data, corresponding keywords will be ignored. If
the associated OPC gateway supports the reference data access, values specified in
the file will be ignored, and values read from the OPC gateway will be used.
Note 2: When reference data is selected in the tag template and the file does not supply
values for reference data, created reference items will have the quality code BAD-
Offline until values will be explicitly set with Tag Editor or any other way.
Note 3: Some values are classified as initial values and used only when tags are firstly
created. Therefore the Tag File Import program will report no action when these
values are changed in a file and a job is re-run. Such values are:
Description, HighEng, LowEng, Units
Value (MAN only)
Note 4: Calculations must have all their dependent tags created before them inside the
equalization file. If not, errors are generated, stating that some of the calculations
inputs cannot be found. An example of this is:
TAG A (MAN)
TAG B (MAN)
TAG C (CALC) = TAG D + TAG B
TAG D (CALC) = TAG A + 1
The order of the tags in the file must be: Tag A, Tag B, Tag D, and then Tag C.


Chapter 11 Tag Editor

11.1 General
The main function of the Tag Editor is to enable users to view tag and function block
information for the Exaquantum system. The Tag Editor can also be used to add, edit and
remove:
Folders and sub-folders
Function blocks
OPC tags
Manual tags
Calculated tags.
11.2 Concepts
OPC, Manual and Calculated tags can be either function block tags or flat tags. Function
Block tags are those that are associated with a function block (and located under a function
block in the Data Browser). Flat tags have no relation to any other tags when created, edited
or removed (and are located directly under a folder, rather than a function block). In the
subsequent text, if neither function block nor flat are specified, tags refers to both types.
Most of the features of adding, editing and removing objects are also available with the Tag
Generation tool. The major differences between the two are summarized in the table below.
Table 11-1 Tag Generation and Tag Editor Differences
Action Available in
Tag Tag
Generation Editor
Create/modify a large number of function
blocks/tags
Create/modify one function block/tag at a time
Save job information to keep track of an
operation, and therefore be able to re-run a job *
Remove folders/function blocks/tags **
Move folders/function blocks/tags
Rename folders/function blocks/tags
Lock/unlock function blocks/tags
* Tag Editor is an interactive method and does not record the operation.
** Tag Editor does not provide a way to directly delete a function block tag. It is always
done through applying a modified function block template.

11-2 Chapter 11 Tag Editor
Offline Flag
There are situations when the input source(s) of OPC tags may be unstable (e.g. during
calibration), and the user needs to disconnect the input from Exaquantum to prevent the
unstable data being stored and affecting calculations. The Offline flag allows this to be done.
Through the Tag Editor the user can set both OPC and calculated tags offline. Manual tags
and shortcut tags cannot be set offline. Shortcut tags automatically reflect the offline status of
the original tag, as they simply point to it. Tags may be set offline at Function Block level as
well as at individual Tag level, and their status is displayed through the Tag Editor.
When a tag is offline aggregations for that tag continue to run. Unless the user overrides the
tag quality, the Assumed data quality is treated as Uncertain by aggregations. There is no
check to prevent Aggregation Calculated Tags being set offline. The user should be aware
that if an Aggregation Calculated Tag is set offline, dependent aggregations will be calculated
based on the previous values written to the base aggregation results.
Setting tags offline and online is a one-phase operation (the user does not have to confirm the
Offline or Online operation after selecting it). When an OPC tag is set offline, both raw data
and reference data items for the tag are set offline. Changing the configuration of a tag whilst
it is offline is allowed. Any changes made take effect when the tag is set online.
When created, an offline tag has a default quality code value of Assumed, which will persist
until it is explicitly changed. When the primary quality code is overwritten, the value of the
sub quality code becomes Replaced. The value of the sub quality code cannot be
overwritten.
When Exaquantum is shut down, the offline status of tags is preserved.
User Interface
The Tag Editor consists of two main sections:
Data Browser
Information pane.
Data Browser
The Data Browser displays a hierarchical structure that represents the Exaquantum process
data available. The user can navigate through the structure and display details of existing tags
and function blocks in the Information Pane.
Duplicate names are not permitted at the same level in the structure. Duplicate tag names
cannot be used in the same folder, nor duplicate subfolder names in the same folder. A tag
and a subfolder within a folder cannot have the same name either (e.g. if a tag and a subfolder
are added to a folder, they cannot both be called Calc1).
A pop-up menu is displayed if you right-click in the Data Browser. The options available to
the user depend on which node was selected.

Information Pane
The Information Pane displays the details related to the function block or tag selected in the
Data Browser. When the user selects either function block or tag in the Data Browser, certain
details are displayed in the Information Pane:
When a Function Block is selected, the Function Block Information and the Summary of
Function Block Tags are displayed in the information pane. The Summary of Function
Block Tags is a list of all the tags associated with the selected Function Block.
When a Tag is selected, the Tag Information and Function Block Information are displayed in
the Information Pane. (In this case the Tag Information is detailed.)
If a folder (or sub-folder) is selected, nothing will be shown in the Information Pane.
Associated Screens
The associated screens are:
Add Exaquantum Object displays the objects that can be added using the Tag Editor
Add Folder
Add Function Block
Add Manual Tag
Add Calculated Tag
Expression Editor
Expression Tester
Add OPC Tag
Edit Exaquantum Object (no corresponding screen for this activity)
Edit Function Block
Impact Preview
Edit Manual Tag
Edit Calculated Tag
Edit OPC Tag
Remove
Upgrade To Latest
Update Reference Data.
Some of these screens and processes are described below.

Add Function Block

This screen contains several fields, including one for FB Tag Definition.
FB Tag Definition is a three-column table that contains a list of tags which have been
previously configured for the selected Function Block template. All the OPC tags shown in
the list have to be set with a source definition.
Note 1: A shortcut can be made to any type of tag (OPC, Man or Calc).
Note 2: When a shortcut is used, the tag is identical to the target tag.
Note 3: You cannot change the type from a shortcut to an instance. If this change is really
necessary, first delete a tag by changing the function block template (and
consequently apply the change to a function block). Then re-create the tag and
define the tag as an instance.
Note 4: If QHistorianData database free space is less than 10% or 500MB whichever the
fewer is, no folder, tag, and function block can newly be created.
Reasons for Editing an Object
deleted.
There are two reasons for editing an object:
To update an objects properties; there are two different types of changes in this category:
Update values such as reference data, value (manual tag), expression (calculated tag),
or OPC gateway and/or OPC item ID (OPC tag). In this case, the impact of updating a
tag is limited to applying new values to an existing tag.
Change the template to another compatible template. Depending on the definition of
the new template, the impact may include adding and/or removing aggregations and
adding and/or removing reference data.
Note: The second operation is not recommended, although available, as changing a
template makes keeping track of changes quite difficult.
To apply template changes to an object, when the template on which it is based has been
modified. This operation upgrades the definition of the object. When it is a flat tag that is
to be upgraded, the tag will have properties and associated items (aggregation and
reference data) as defined in the tag template. When a function block is to be upgraded,
similar changes will take place to the tag. However, when a function block is to be
upgraded, both the function block and the member tags will be changed at the same time.
In this case the user is prompted with a summary of changes called an Impact Preview
report, to confirm the changes.
Note: When a template has been changed and an upgrade is prompted, most of the other
fields are disabled; they will become enabled again only after the template
upgrade has been applied.

Impact Preview Screen

The Impact Preview screen is displayed when a user is going to change a Function Block by
applying a new function block template version (or even a new template), before the changes
are actually incorporated. The screen is a table that comprises four columns. It displays the
objects (tags and function blocks) that would be affected if the user applies the changes made,
and lists what the effects would be. Using the control buttons on this screen, the user has the
option to apply the changes or cancel.
Remove
When you try to remove objects (e.g. folders and all their associated sub-folders, function
blocks and tags), you will be prompted to do a cross-reference check. The cross-reference
check searches for any calculated tags that will be affected by the remove operation. When a
tag is removed that is referenced by a calculated tag that will not be removed at the same time,
the calculated tag will be invalidated, as it has lost one of its inputs. To avoid this, you can
choose from two options:
Use the Check Cross-reference button on the Remove dialog to see if there are any calculated
tags.
Start the Remove operation with the Do not remove if cross-reference exists option selected.
When a cross-reference is found, the remove operation will fail without removing
anything.
Note 1: Deselecting the option Do not remove if cross-reference exists should not be done
unless you are very sure that there are no cross-referenced tags.
Note 2: The cross-reference operation can take a considerable amount of time, depending on
the number of objects that you are trying to remove.
Note 3: The Remove operation cannot be cancelled.
Expression Builder Screens

For further information about the Expression Editor and Expression Tester, see Chapter 13
(Expressions).
Upgrade To Latest
The Upgrade To Latest form allows the user to upgrade multiple Tags and Function Blocks to
use the latest version of their configured template.
When first loaded the form displays (for the selected Folder), all Tags and Function Blocks, in
alphabetical order, that are not configured to use the latest version of their template. By
default, all Tags and Function Blocks that can be upgraded using this form and are not locked,
are shown as selected. The user has to explicitly select any Tag or Function Block that is
currently Locked to be upgraded. The user can deselect any of these Tags or Function Blocks
using the checkbox on each row.
Any Function Blocks which cannot be upgraded using this form are shown in grey and the
user cannot select them.
Once the Tags or Function Blocks required for upgrade are selected, clicking on the Upgrade
button will upgrade each selected object. During the upgrade process, a Progress Viewer will
be displayed showing the current progress as a percentage of the entire task.

The Upgrade status of each object will be displayed; all successfully upgrading objects will be
highlighted in grey and will no longer be selectable. Update Reference Data Screen.
OPC tags can be supplied with reference data (description, units and engineering ranges) by
the OPC gateway either when tags are initially created, or when the OPC gateway and/or OPC
item ID are changed after being created.
Note: This feature is available only when the OPC gateway supports the property access
feature, which is the case of most of the servers except PLC or other simple devices.
Filling reference data with OPC values could be useful at first. As the user continues to use
Exaquantum, however, it is likely that users will set their own reference data to meet their
information utilization purposes. Assuming this scenario, the ability to update reference data
is provided as an advanced function. The screen will allow you to select an OPC gateway
from which reference data is to be read, and set all of the OPC tags that are associated with
the OPC server. A command line version of this facility is available with the OPC Reference
update tool. See section 11.4.
Note: All OPC tags of the selected OPC server are updated. Any changes that have been
made locally in Exaquantum will be overwritten.
11.4 OPC Reference update tool
The OPC Reference update is a command line tool for updating the Exaquantum OPC tag
reference data with the current values from one or more OPC Gateways. It is the same as the
functionality provided by the Update Reference Data Screen, described above. The advantage
of the functionality available as a command line version is that it can be scripted. This enables
it to be conveniently run to a schedule that ensures the OPC tag reference data is kept
concurrent.
If the command is issued alone, with no following names, then all the gateways that support
OPC Property Access will be updated.
The command line invocation is:
QOPCReferenceUpdate.EXE
The command should be followed by a white space delimited list of the gateway names of all
the OPC gateways that should be updated, as in the following example:
QOPCReferenceUpdate.EXE [OPC Server1] [OPC Server2] [OPC Servern]
Note: The actual OPC Gateway Name should be specified, not the OPC Gateway computer
name. The Names of currently configured OPC Gateways can be established by
using the OPC Gateways Configuration tool, see Chapter 2 - OPC Gateway
Configuration.

11.5 Scenarios
The Tag Editor is used to view, create and edit; folders, function blocks and tags. This
section gives some typical scenarios associated with the Tag Editor.
Folders
The folder mechanism can be used to group tags, for ease of reference. For example, manual
tags based on a particular user criterion can be placed in one folder, and OPC tags in another.
A user can add, rename and remove a folder.
Function Blocks
A user can add, rename, edit and remove a function block.
Tags
A user can add, edit and remove manual, calculated and OPC tags.
Note: Certain actions can only be carried out on flat tags (not on function block tags).
Caution
If an OPC tag is created for an OPC Gateway machine that does not exist on the network, and
this tag is then deleted, it will take up to 3 minutes for the Delete operation to complete. This
is much longer than normal.
Offline Flag
Tags may be set Offline at both Function Block level and individual Tag level. From the
Function Block edit screen, if Offline is selected all OPC and Calculated Tags within it are set
Offline. If Online is selected, all OPC and Calculated Tags within the Function Block are set
Online. The Online/Offline status is associated with each Tag. If a Function Block template
is updated and a new tag is added, the tag will be added Online, even if all other Tags in the
Function Block have been set Offline.
Note: The concept of the Offline Flag is described in Section 11.2.


Exaquantum/PIMS User's Manual 12-1
Chapter 12 Cross-server Calculations

12.1 General
Cross server calculations is an optional feature for Exaquantum/PIMS servers that allows tags
and function blocks on one server to be available on another.
This feature is enabled by installing the Open Interface component on an Exaquantum/PIMS
server that will make its tags available to other servers.
No additional components need to be installed on the server accessing the tags.
12.2 Concepts
The primary purpose of this feature is to enable tags and function blocks on one server to be
used in calculations on another. As in the case of an OPC server, in the right configuration the
values can also be written back to the originating server.
The Exaquantum/PIMS server that is making its tags and function blocks available has extra
software installed that makes it appear like another OPC server. For the server accessing them,
the tags on the exporting server appear as if they are on a normal OPC server.
There are several ways the Cross-server calculation feature can be employed in an
Exaquantum system.
Cross-server Calculations installed on one server
This simple deployment will allow any other Exaquantum/PIMS servers to access the tags and
function blocks on the one that has the Cross-server Calculation module installed.
Conceptually, the data flows could look like this:
Figure 12-1Cross-Server functionality on one server
Exaquantum/PIMS Server 1
OPC Server 1
Read Calculated
operation tag
Read
Tag A
operation
Tag 1A + Tag 1B = Tag 1C
OPC Server 2 with Cross-server Calculations
Read
Tag B Tag 2B
operation

12-2 Chapter 12 Cross-server Calculations
Cross-server Calculations installed on multiple servers

A more complex example has the Cross-server Calculation module on two or more servers,
which can then effectively share all their tags and function blocks.
Figure 12-2 Cross-server functionality on two servers
Read
Tag A
operation
Tag 1A + Tag 1B = Tag C
Read Calculated
operation tag
Read
operation
with Cross-server Calculations
OPC Server 2
Read
Tag B Tag 2B Calculated
operation
tag
Read
Tag D
operation
Tag 2D + Tag 2A = Tag E
This feature provided an extremely versatile and powerful way of exploiting tag and function
block data across the system.
Writing back values
When the ability to write back values to the originating server is added to the above scenarios
then the usefulness and flexibility increases, but so does the complexity. In this sort of
environment it is important to be able to keep track of the data flows to avoid the
administrative task getting out of control.
The following two diagrams illustrate the point:
Figure 12-3 Example using read operation
OPC Server 1
Calculated tag
Read
Tag A
operation
Tag 1A + Tag 1B = Tag X
Read Read
operation operation
OPC Server 2
Read
Tag B Tag 2B
operation
Calculated tag
Read
Tag D
operation
Tag 2D + Tag Y = Tag E
In the example above, the Tag Y on Server 2 is read from Tag X on Server 1.

Figure 12-4 Example using write operation

Calculated tag
Read
Tag A
operation
Tag 1A + Tag 1B = Tag X
Tag Y
Read Write
operation operation
Read
Tag B Tag 2B
operation
Calculated tag
Read
Tag D
operation
Tag 2D + Tag Z = Tag E
In the example above, the Tag Z on Server 2 is written to by Tag Y on Server 1.

Architectural considerations
In a system where there are many Exaquantum/PIMS servers sharing tag data, it is important
to be able to keep track of the data flows. One useful method is to organize the data flow in a
hierarchical system rather than a grid. Figure 12-5 below shows a conceptual representation of
how the systems differ.
In the Hierarchy example, Server A does most of the processing of tag data by collecting the
various values and performing the calculations. Whether it writes back the calculated values
or the other servers read them will depend on the other factors mentioned above.
In the Grid example, each server obtains data and performs its own calculations as required.
Figure 12-5 Different data architectures
Server A Server 1 Server 4
Grid
architecture
Hierarchy
architecture
Server B Server C Server D Server 2 Server 3
As shown above, in terms of the flow of data, the complexity of the Grid architecture is far
greater and more difficult to track and manage. However, the best choice in any given
situation will depend on many other factors as well, such as network topology, geographical
location, operational responsibilities, etc.

12.3 Operational implications and limitations

Using a tag from another Exaquantum/PIMS server with Cross-server Calculations is very
similar to accessing a tag on an OPC server. Apart from the first two items below, the main
differences are really only important when considering multiple, Cross-server Calculation
enabled, servers.
As a system gets larger, the architecture and flow of data needs careful consideration in order
to achieve the objective. In many cases there will be a tradeoff between different
considerations that need to be balanced.
Cross-server Calculation issues
The following points provide a brief description of some issues that may affect the way Cross-
server calculations is implemented in different situations.
Alarms and Events
The OPC server used to enable Cross-server Calculation module does not support Alarms and
events.
Time stamp
A value written back from one Exaquantum/PIMS server to another will always be time-
stamped with the current time, that is, the time at which it was written. A read value will
carry the time stamp generated by the Exaopc client.
Quality values
A value written back from one Exaquantum server to another will have a Primary quality,
which will always be Good. In situations where it is important to transfer the Quality values
intact, the data should be transferred using a read operation. Secondary qualities are not
available through the OPC DA interface
Exaquantum has an application specific quality value of Assumed, which indicates when an
OPC tag is offline. Due to internal implementation the receiving server cannot recognize this
value; it will be shown as Uncertain.
Number of tags
Calculated tags cannot be used to write back the value they create, thus, when writing back
calculated values, an extra tag has to be create on the source server for that specific purpose.
This can lead to a large increase in the number of tags required. As only the tags that are
Historized count towards the number of licensed tags, careful planning can reduce the
licensing costs implications. However this may not reduce the overall administrative load in
keeping track of a large number of tags.
Update frequency / polling
The value of some tags does not change very often, but the OPC client still has to poll the
Exaquantum server check. In a situation where there are a lot of such tags and the server or
the network is heavily loaded, this could cause a significant overhead. In such cases, where
the value of tags is fairly constant, then writing back the data should be considered. If the
value is not polled frequently enough, important changes may not be seen immediately. This
effect can be particularly evident for aggregations which are not calculated until after the end
of the period.

History catch up
As in the case of other OPC servers supporting Historical Data Access, when data is missed
because of a scheduled or unscheduled shutdown, if History Catch up is enabled it will
automatically recover as much data as possible. This involves the computer that has missed
data actively fetching the missing items from the source. However, the server has no
knowledge of what data would have been transferred to it using data write back, consequently
that form of missing data will not be recovered using History Catch Up. For a full description
of History Catch-up see the Exaquantum Engineering Guide Volume 1 (ref IM 36J04A15-
01E).

12.4 Tag Template configuration for Cross-server Calculations

When using Cross-server Calculation, suitable Tag Templates should be used. The following
table shows the constraints:
Table 12-1 Tag Template Constraints
Group Parameter Value
General Name User defined.
Template Version System derived version number.
Tag Type OPC
Data Type User defined. Should match the type of

the source tag.
Raw Historian User defined.

Interval
Aggregation Continuous or User defined.

Type Discrete
Reference Data Include User defined.

Engineering Units
Include User defined.

Engineering
Range
OPC Write to OPC User defined.

Communication Gateway (Quality value will always be Good on
writing)
Period 1 second; this will ensure that the value

is notified as it changes.
Percent Deadband User defined.

Note: Deadband is supported for server
tags with a datatype of single or double
floating point and that have Engineering
Range specified. For other cases the
Deadband is ignored.
Aggregations All User defined.

12.5 Tag Configuration for Cross-server Calculaton

When using Cross-server Calculation, the following table shows the constraints when
configuring tags:
Table 12-2 Tag Configuration Constraints
Parameter Value
Name User specified
Description Set by system; derived from the OPC Server
Tag Template As defined in Tag template administration screen. This must be

an OPC tag.
OPC Item ID Fully qualified path of the tag on the remote Exaquantum server.
For example: Root.FunctionBlock.Tag.Value,
Root.FunctionBlock.Tag.Aggregations.Hour.Maximum.Value.
NOTE: This is not case sensitive.
OPC Gateway As defined in the OPC Gateway administration screen.
Engineering Units Set by system; derived from the OPC Server if specified by the
Tag Template.
Engineering Set by system; derived from the OPC Server if specified by the
Range Low Tag Template.
Engineering Set by system; derived from the OPC Server if specified by the
Range High Tag Template.

12.6 OPC Gateways Configuration

To add an Exaquantum OPC server gateway from the OPC Gateways Administration tools the
parameters should be:
Table 12-3 OPC Gateways Administration tool parameters
Parameter Value
Name As User specified
Description As User specified
Type Exaquantum
Computer As User specified, name of the remote Exaquantum server
Enable Exaquantum Not available as Exaquantum does not support Alarm and
Alarm and Events Events.

Chapter 13 Expressions
13.1 General
The Expression Builder provides a means to create, edit and test expressions for Exaquantum
calculated tags. The building of an expression utilizes two screens:
Expression Editor, for creating or editing an expression
Expression Tester, for testing an expression.
These screens are used in conjunction with the Tag Editor and the Function Block Template.
Note: See the API Reference Manual (ref: IM 36J04A14-01E) for further details of some of
the functions referenced in this manual.
13.2 Concepts
Defining Expressions
Expressions are defined using Microsofts Visual Basic (VB) script, a good knowledge of VB
script is therefore required to carry out these procedures. Refer to Microsoft documentation
for details of VB script, and to the API Reference Manual (ref: IM 36J04A14-01E).
Expressions in Exaquantum must conform to the following rules:
Expressions should contain at least one source tag. Tags are identified in the script by their
fully qualified path enclosed in square brackets:
[Root.Folder1.Foldern.FBName.Tagname.Value]
Note: Paths used in calculations must refer to an Item and not a Tag. This is typically
Value, but other possible identifiers are references items Description,
Units, High_eng or Low_eng. Another possible set is .Quality and
.Timestamp. The Tag Editor will add .Value when Tags are dragged from the
Data Selector for use in expressions.
Expressions can use a relative addressing besides an absolute addressing. This is useful to
configure a function block that contains an expression that can be located anywhere in the
folder hierarchy.
Expressions should return a single value, and this should be assigned to the special keyword
[result]. Additionally, expressions can write to tags other than the one they are associated
with, assuming such tags are either an OPC tag or a Manual tag.
Long lines in expressions may be broken up and continued on the next line. To do this, end a
line with an underscore character.
Expressions cannot be recursive. In some cases such calculations are easily recognized,
however the outcome of a long reference chain in other cases may not be easy to identify.
Expressions can contain references to aggregation results.
Expression can have a self-reference; a typical example is [Result] = [Result] + 1. More
complex referencing is also available.
Expressions can send user-defined events to the Event Management program so that particular
application programs are run to perform tasks.

13-2 Chapter 13 Expressions
When defining expressions, the user can make use of time functions and user library functions.
It is also possible for the user to create an aggregation calculated tag. This has an expression
that enables it to generate aggregation values rather than default aggregation logics (see
Chapter 6 for further information).
Event-driven
Calculated tags are event-driven; when any of the inputs change, the expression is evaluated.
At that point, inputs other than the firing one are evaluated as the latest one.
Note 1: When an aggregation value is used in an expression, the expression is evaluated
when the aggregation period is due and the value has been just updated. Meanwhile,
if the other input fires the expression, the aggregation within the expression returns
the last calculated value.
Note 2: When any one of the inputs is invalidated (which happens typically when a tag is
removed from Exaquantum), the expression will never be fired until an expression is
edited and the reference is resolved. Invalidating expression also takes place when
the expression is detected as recursive.
For the expression to identify the firing input, a statement such as this is allowed in the
expression:
If [Root.Tag1.value].Changed

End if
As in these circumstances the not [].Changed always returns true, if you want to check for
the negative, the following form should be used:
If Not Cbool([Root.Tag.Value].Changed)
Data Quality
The expression is re-evaluated when any input value (or quality) changes; the rules for setting
the quality are:
The default quality is determined as follows:
If all source item values are Good then the result is Good
If one or more source item value is Bad then the result is Bad
In all other cases the result is Uncertain.
Unless the expression explicitly overrides this default, and no error takes place during
execution, the default value is used as a Quality Code.
Note: If an error occurs during executing the expression (e.g. zero division), the quality
is always Bad Bad calculation.
The expression can explicitly specify the Quality code. To set the quality code, the
expression should make use of available helper functions, such as:
[Result].Quality = RawQuality (qdaQualityGood)
[Result.[Parent.tag 1.value]].Quality = RawQuality (qdaQualityBad,
qdaSecondaryQualityBadCalc)

Data Timestamp
Result tags (or tag) are assigned a timestamp from the source tag that caused the expression to
be evaluated.
Under certain circumstances the result tag or tags may be updated based on the current system
clock. This may happen:
If the expression has no source tags, e.g. it is a constant value
When the calculated tag is initially created.
In the Expression Tester (where the timestamp of the source tags may be adjusted by the user)
the result tag or tags are assigned the most recent timestamp of the source tags. If the
expression has no source tags, for example it is a constant value, then the result tag or tags are
assigned a default timestamp of 4th May 1957.
Event Generator
Event Generator is a mechanism by which user application programs are triggered by various
source events. Expressions allow users to explicitly generate such events, possibly depending
on the condition. In order to generate events, call a function within expressions as follows:
Qcalc.SendEvent BSTR_parameter, optional_parameters
Where BSTR_parameter is a required string parameter and optional_parameters are
any type of parameters up to 8.
Typical examples are:
If [root.tag1.value] > 10 then
Qcalc.SendEvent State on, [root.tag2.value], comment
Else
Qcalc.SendEvent State off, [root.tag2.value], comment
End if
Note: In this example, the second parameter is resolved into the item ID (numeric).
For more information about Event Generator, refer to Chapter 15 Event Generator.
Timer Functions
Types of Timer
There are two types of timer available for use within scripting. Only one timer can be active
at a time.
Simple Timer
This requests that the calculation be notified once only after the specified time has elapsed.
Any existing timer is cancelled before a new one is started.
For example:
QCalc.StartTimer 60
This will result in the calculation being fired one minute after the current time.

Periodic Timer
This requests that the calculation be notified periodically at each period boundary. It takes
two parameters (Interval and optional Offset) that are specified in minutes; intervals greater
than 60 minutes are DST-aware.
For example:
QCalc.StartPeriodicTimer 60, 30
This will start notifications every hour on the half-hour.
QCalc.StartPeriodicTimer 480
This will start notifications at 08:00, 16:00 and 24:00, local time.
Cancelling Timer Requests

This script cancels any outstanding request for notification, whether the simple or periodic
timer is in use:
QCalc.CancelTimer
If no timer exists, it does nothing.
Timer Fired Property
Using the following script, this allows the user to check whether a script is being executed as
a result of a timer notification:
If QCalc.TimerFired Then

End If

User Library Functions

Users may configure custom COM objects for integrated use within calculation scripts.
The CalcLibrary table contains one row for each external library component for use within
calculations.
Table 13-1 CalcLibrary table columns
Column Comments
Name
ObjectName Name to be used for the instance of this object, e.g.

QQualityHelper
ProgId ProgId of the component, e.g. QdatAccess,QualityHelper.1
IsGlobal Indicates if the object should be global (shared by all Calcs)
IsNamed Indicates if the object should be named
For each object configured within the CalcLibrary table, ScriptedCalcs load type library
details to pass to the Script Engine, and add each object as a named item.
If the IsGlobal flag is set, a single instance is created that is shared by all calculations.
Otherwise each calculation has its own instance created when the calculation is started, and
released when the calculation is shut down.
If the IsNamed flag is set, the ObjectName must be used to reference the object from script,
e.g. QQualityHelper.IsGood( 1qual). Otherwise object properties and methods may be
referenced like intrinsic functions. However, care must be taken to avoid namespace conflicts,
e.g. IsGood(1qual). In the case of namespace conflicts, the behavior is undefined.
Note: It is recommended that IsNamed should be set to TRUE to avoid namespace conflicts.
After registering library(s) in the CalcLibrary table, the Exaquantum server must be restarted
for the changes to be accepted.
The library function should be carefully set up as any function failures may cause serious
damage to the Exaquantum server. In some cases, a function might take a significant amount
of time to execute, which could cause the script to time out for example a complex history
query. When employing a library function of this nature consideration should be given to
executing the function asynchronously, for example by using Event Generator.

13.3 User Interface

The Expression Builder comprises the Expression Editor and Expression Tester; these are
described below.
Expression Editor
This screen contains two panes, and a data selector. The expression pane is used to enter the
expression. The information pane displays information after the expression has been
validated. The data selector displays the hierarchical structure of folders, function blocks and
tags that comprise the Exaquantum data. It provides easy access to the tags that are available
for use in expressions. A tag name can be dragged from here and dropped into the expression
pane.
The Expression Editor is used in the Tag Editor and the Function Block Template editor. In
both of these tools, when the calculated tag is part of a Function Block (i.e. not a flat
calculated tag), the normal Exaquantum data selector is replaced by a specialized data selector.
In addition to the tags and function blocks in the server, this data selector also lists the tags
inside the current Function Block template. The tags may be dragged and dropped into the
expression as normal.
Expression Tester
This screen is used to allow some static testing of the expression prior to deploying it in the
real-time database. This may involve:
Verification that the expression is producing the expected results (i.e. that it has been correctly
entered).
Testing the expression for all possible boundary conditions, e.g. division by (zero) small
number overflows, negative values as inputs to logarithmic functions/square root functions,
etc. Common errors that should be trapped by conditional execution statements are
division by zero, negative values or zero passed into logarithmic functions, square root of
negative values, recursive expression, etc.
The following code segment illustrates this type of defensive coding:
Dim dTestValue
:
:
If dTestValue > 0.0 Then
dTestValue = Sqr(dTestValue)
End If
To test an expression, manually enter values for each of the input values, and then execute the
expression once using the Test button. The Value field displays the result.

13.4 Scenarios
Using Aggregation Results in Expressions
Expressions can use aggregations to update their own value. For example, if a raw OPC tag
value is shown in L/hour, the expression shown below can be used to convert it into kg/hour
by multiplying by a density value. Use the following syntax:
[Result] = [Root.Folder1.Tag1.Aggregations.Hour.Mean.Value]
* [Root.Folder1.Tag2.Value]
Root.Folder1.Tag2.Value is the constant, non-changing, density value by which the Tag1
aggregation is multiplied.
The expression will be updated each time the value of the Tag1 aggregation result is updated.
Note: If a calculated tag is configured to generate its own aggregation values, such as a
summation, then the aggregation may not be calculated properly. This is because of a
potential for mismatches in the timing of aggregation calculations which could result
in a new aggregation being available for a calculated tag, just after its own
aggregation calculation has been performed. To generate a calculated tags
aggregation(s) properly, you can use the Aggregation Calculated Tag mechanism.
See Chapter 8.2 Concepts, Aggregations, Aggregation Calculated Tags.
Using the QualityHelper in Expressions
The QualityHelper library provides functions to allow simple, clear checking of the quality
values of items that can be used directly in expressions. The API reference Manual ()
provides details of these methods. See the example below for an illustration.
Using Quality and Timestamp in Expressions
Expressions can use the quality or timestamp attributes of an item, instead of, or as well as the
value. This can be for both raw and aggregation items, as illustrated in the following examples.
If IsBad([Root.Folder1.Tag1.value].Quality) then
[Result] = [Root.Folder1.Tag1.Value]
else
[Result] = [Root.Folder2.Tag2.Value]
End if
[Result] = [Root.Folder1.Tag2.Value].Timestamp

Using Relative Paths in Expressions

Expressions are allowed paths to tags that are specified as relative to the tags parent. This is
primarily meant to define a function block that contains one or more calculated tags, and can
be located anywhere in the folder hierarchy. To specify the relative path, use the following
syntax:
[Parent.<Path-from-parent>]
Where <Path-from-parent> specifies the path to an existing tag in the namespace relative
to the tags parent.
This feature is mainly for use with function blocks tags, but it can also be used for flat tags.
For Example:
+Root
+Folder1
OPCTag
CalcTag
+Function
Block1
FBOPCTag
FBManTag
FBCalcTag
When CalcTag is defined as a calculated tag, it may contain the following expression:
[Result] = [Parent.OPCTag.Value]
When FBCalcTag is defined as a calculated tag, it may contain the following expression:
[Result] = [Parent.FBOPCTag.Value]
If you move the parent folder or function block to a new location, expressions containing the
relative path expression will remain valid.
When you write to another tag within the same function block, the expression will look like:
[Result.[Parent.FBManTag.Value]] = [Parent.FBOPCTag.Value]
Note: In function blocks, all referenced tags within a calculated tag of the same function
block should appear before the calculated tag. In order to adjust the order properly,
the Function Block Template program provides an Evaluation Order button.

Self-referencing Expressions
Expression allows a self-reference calculation to be used. Initially this looks like a recursive
calculation, which is not allowed, but the difference is that an output designation is used on
the right-hand side of the expression as well.
One of the simplest self-reference expressions is:
[Result] = [Result] + 1
Another example is to calculate the differential summation, where a raw value represents an
accumulated value and, by keeping a previous value in Exaquantum Manual tag, the
expression should calculate the difference between the previous value and the current one.
Dim temp
Dim diff
Temp = [Parent.Source.Value] If you use
Diff = temp - [Result.[Parent.Previous.Value]] [Parent.Previous.Value]
instead, it is a recursive
If diff >= 0 then calculation.
[Result] = diff
Else
[Result] = diff + [Parent.Previous.Higheng]
End if
[Result.[Parent.Previous.Value]] = Temp
Updating Other Tags
Expressions can update their own value and send a result to other tags. This is most useful in
these two cases:
To write a value to the control system via writing to an OPC tag
To store a temporary value in a Manual tag.
To specify the result tags in other tags, use:
[Result.[<Path>]]
Where <Path> specifies the path to an existing tag.
For Example:
If [Root.Folder1.Tag1.Value] > 100 then
[Result.[Root.Folder1.Tag2.Value]] = 1
Else
[Result.[Root.Folder1.Tag2.Value]] = 0
End if
[Result] = [Root.Folder1.Tag1.Value] / 100

Removed or Renamed Tags in Expressions

If an expression contains tags (or paths to tags) that have been removed, renamed, or removed
and recreated with the same name, this will be highlighted in red in the Expression pane. A
message will also be shown in the Information pane. The expression continues to calculate
unless a tag has been removed. To resolve this situation:
If the tag has been removed or renamed, open the Expression Editor and update the expression
as necessary.
If the tag has been recreated:
Open the Expression Editor, remove the tag from the expression; click on OK from the
Expression Editor, and OK from the Tag Editor. Now use the Tag Editor to re-add the
recreated tag to the expression.
Erroneous Expressions
Apart from syntax errors, there are cases where expressions are detected as erroneous, and
thus invalidated. These expressions will not be evaluated until the expression editor is used to
correct the problems. Such cases include if infinite looping is detected. An expression is
expected to complete in a short time. If it runs for more than a pre-defined period (the default
is 5 seconds), it is considered that infinite looping has been detected, and the expression is
invalidated.
Expressions that Cannot be Saved
There are cases when you cannot save an expression because of problems in it:
Referenced tag does not exist
This typically happens when you use [Parent. ] within the expression and the specified
tag is not a member of the function block. You must also consider the order of evaluation
if the path seems correct.
Calculation is recursive
This happens if you try to register two calculated tags that reference each other:
CalcTag1 : [Result] = [Root.Folder.CalcTag2.Value]
CalcTag2 : [Result] = [Root.Folder.CalcTag1.Value]
Another less obvious case is the long firing chain:
CalcTag3 : [Result.[Root.Folder.Tag4.Value]] =
[Root.Folder.ManTag1.Value]
CalcTag4 : [Result.[Root.Folder.Tag5.Value]] =
[Root.Folder.Tag4.Value]
CalcTag5 : [Result.[Root.Folder.ManTag1.Value]] =
[Root.Folder.Tag5.Value]

Chapter 14 Archiving
14.1 General
History Archiving in Exaquantum allows users to manage the way that their systems history
is accumulated, and then stored on backup devices. This is done through the History
Archiving tool. This tool is used to free up disk space by allowing historical data, which may
be tag trend data or Alarm and Event history data, to be transferred to a backup device. This
backed up data may later be restored to the system, so making it available again to be viewed
by clients.
Functionality is also provided to permanently delete data from the system.
14.2 Concepts
The Archiving tool also allows the user to control which portions of historical data should be
backed up or restored. Each type of data that may be archived is allocated to a particular
Archive Group as follows:
Table 14-1 Archive Groups
Archive Group Description
Raw Data : Tag Raw value history data (the value of a manual, calculated or
Raw Fast OPC tag). The OPC update rate is used to determine which group a
Raw Slow particular item will belong to. The threshold is set by a Registry
key; if the OPC update rate is less than or equal to the Registry key
value, the item belongs to the Raw Fast group (the default is 5
seconds)
Reference Data Tag reference value history data e.g. the units, description, low or
high engineering range for tags.
Alarm & Events OPC Alarm and Event history data.
System Events Exaquantum Event history data.
Hourly and Custom Tag aggregation history data for Hourly or other user-defined
Aggregations periods, e.g. 10 minute mean history.
Daily Aggregations Tag aggregation history data for Daily aggregations.
Monthly Tag aggregation history data for Monthly aggregations.

Aggregations
System Audit Trails Exaquantum audit trail data.
Annotations Annotation for trend history data.
The user can create an archive, create a backup, restore archived data and obtain information
about previously archived data. No modifications can be made to data held in an archive;
archives are read-only.

14-2 Chapter 14 Archiving
Basic Archiving Operation

Initially, before any archive operations have been performed, historical data is created as a set
of Archive Candidates, each covering a specific period of the available history. The period
covered by Archive candidates can be configured via the Archiving Tool. This splits the
available history into Archive candidates covering the entire available history. The maximum
size of an Archive candidate can also be configured, for example to limit the size of a
candidate to the size of the backup device available. The maximum size of an Archive
candidate can be configured using the Advanced Configuration dialog.
Archive candidates are always composed of multiples of smaller, regular period chunks based
on an Archive Group as follows:
Table 14-2 Archive Candidates
Archive Group Composition of Candidates
Raw Fast/Raw Slow Archive candidates composed of Daily chunks starting at midnight.
Reference Data Archive candidates composed of Monthly chunks starting at

midnight on the first of the month.
Alarm & Events Archive candidates composed of Daily chunks starting at midnight.
System Events Archive candidates composed of Daily chunks starting at midnight.
Hourly and Custom Archive candidates composed of Daily chunks starting at midnight.
Aggregations
Daily Aggregations Archive candidates composed of Daily chunks starting at midnight.
Monthly Archive candidates composed of Monthly chunks starting at

Aggregations midnight on the first of the month.
System Audit Trails Archive candidates composed of Daily chunks starting at midnight.
Annotations Archive candidates composed of Annotations for trend group

chunks starting at midnight.

When Archive candidates have been configured they may be turned into actual Archives.
Archiving activities are driven by first selecting an Archive Group, after which a reverse time
ordered list of Archives is displayed in the Archive List. Each archive covers a specific
period of history data. For users of Exaquantum history data, each of these Archives is in
either of the following basic states:
Online indicating that the history data for the specified period is available for use by clients,
e.g. it may be trended or queried.
Offline indicating that the history data for the specified period is not available for use by
clients.
Note: For the Alarm & Event Archive Group, the Maximum number of online archives is 63.
Note: The Exaquantum Installation sets the default maximum archive size to be 640Mb, and
defines the maximum number of online archives to be 30. If a user attempts to create an
archive greater than the maximum size, or that there are already the maximum number of
archives online, they will be presented with a warning dialog. It is recommended that users
accept this warning and continue with the create archive operation the archive will get
created, if there is sufficient disk space. If the maximum number of online archives need to be
increased, please run the System Configuration Tool, and change the number of online
archive in Historian Tab. For details, please refer to Chapter 13 System Configuration Tool
in Engineering Guide Vol.3 Support Tools.
An Archive can exist in one of the following states:
Table 14-3 Archive States
State Description
Candidate Basic State: Online.

Candidates have never had any archiving operation applied to them.
Available operations:
Save Only applies to the oldest candidate for an Archive Group. The
contents of this archive are written to the Archive device. The resultant
status may be 'Online, backed up' or 'Offline' depending on the
Advanced option selected.
Online, backed up Basic State: Online.

These archives have been successfully backed up but are still
consuming disk space since they are online.
Save Create another backup for this archive. This is a rarely used
option; it enables the user to create additional backups for added
security of data.
Unrestore Take the Archive offline. The resultant state will be
Offline.

State Description
Offline Basic State: Offline

These archives have been successfully backed up and are now offline
so the space they consumed has been freed up.
Restore Put the Archive back online by reading the backup device.
Online, not Basic State: Online

backed-up These archives have been successfully created, but the backup failed.
Save Retry the backup operation. The resultant status may be
'Online, backed up' or 'Offline' depending on the Advanced option
selected.
Online, needs Basic State: Online

Rebackup These archives have been successfully created, but they need backing
up again.
Save Do the backup operation again. The resultant status may be
'Online, backed up' or 'Offline' depending on the Advanced option
selected.
Removed Basic State: Offline

These archives cannot be located. The data is permanently destroyed
and can never be restored. This can happen when:
The archive was deleted (manually by the user or via auto-
deletion).
The archive was in the state 'Online, not backed-up' and the
Historian detected that the Archive database is no longer present.
This is an abnormal situation that will not happen in normal
operation.
The archives have been permanently removed from the system by
the Historian maintenance utility (see Volume 3 of the Engineering
Guide (ref: IM 36J04A15-03E) for details).

Auto Archiving and Auto Deletion

Two automatic functions can be selected:
Auto archiving
Auto deletion.
The purpose of these functions is to reduce the amount of administration (manual archiving)
work and to ensure that there is adequate free space available in the Historian. Archive
groups can be marked for auto archiving, thus allowing a certain degree of unattended
archiving or removal of data. Automatic backup to external media can also take place if auto
archiving has been selected.
Auto archiving and auto deletion are associated with a retention period. This is on a per
archive group basis, and determines how long Historian information is kept online. If auto
archiving (or deletion) is selected, the system automatically archives or deletes from the
Historian database any Historian data older than the retention period.
Auto archiving removes the exceeding portion from the online Historian database, and makes
an archive database. Auto deletion removes the exceeding portion from the online Historian
database, but does not create an archive database; hence it is permanently removed from the
Historian.
Auto archiving and auto deletion are mutually exclusive. The user can de-select both, or
select only one of them. Both operations are logged as an audit log when they take place.
The user also has the option to manually delete an archive candidate, and hence permanently
remove it from the Historian. This operation can be performed through the Archiving screen,
on an Archive Group basis. The deletion operation removes the specified archive candidate
directly from the source database. The data is therefore lost permanently and can only be
recovered from a previous backup of the source database.
Auto Offline
Following the automatic creation of archive databases, two possibilities can additionally be
configured:
A backed up archive can be moved automatically offline, after a defined interval, following its
creation. A restored archive is not considered for auto offline.
A non-backed up archive can be automatically deleted, after a defined interval, following its
creation. This is a second form of auto-deletion; however, the advantage of this technique
is that improved read performance is gained when reading from online archives, when
compared with reading from just the QHistorianData database.
An example is shown below.
The Syncrow in the examples are operations performed at 12:05 AM.

Operation Example
Example 1: Indicated below are the time intervals for the auto archiving, auto backup,
and auto offline features.
Archive Period: 30 days
Retention Period: 90 days
Time interval until auto offline: 30 days
Figure 14-1 Archiving time intervals
90 Days 30 Days
Actual time interval
30 Days
Syncrow (1) (2) (3)
Syncrow(1) Candidate creation

Syncrow(2) The candidate created in (1) is automatically archived. The set time for automatic backup. (Time elapsed: 90 days)
Syncrow(3) The set time for automatically moving the archives offline. (Time elapsed from the automatic backup: 30 days)


User Interface
The Archiving screen comprises several sections and controls; some are described below.
Screen Sections
The Archive Groups drop-down list shows the archive groups defined for the Exaquantum
server. Archive groups are groupings of related historical data (data that has similar update
rate). Selecting an archive group will populate the archive list with the candidates and
existing archives in that group.
Device/File
It is possible to archive to either:
A SQL Server device.
A user specified file.
The file option is only available for manual archives.
Device
Select this radio button when archiving to a device.
Available devices that have been defined as backup devices on SQL server are listed on a
dropdown list. Select an SQL backup device to save and restore data. New SQL backup
device is defined using SQL Server Management Studio. For the details, refer to Exaquantum
Engineering Guide Volume 1 Administration (IM 36J04A15-01E).
IMPORTANT
When creating the SQL Backup Device, do not use the name Temporary Device. This is
because this name is used internally in the Archive Tool.
File (manual archive only)

Select this radio button when creating an archive file on the Exaquantum/PIMS server.
The Save File dialog is displayed.
The Archive period is the time interval that the tool will use when configuring archive
candidates. The units of time for the Archive period will vary depending on the archive group
selected.
The Archive period will be overridden if the archive produced would exceed the maximum
archive size defined in the Advanced dialog. After changing the Archive period, the Refresh
button should be clicked.

Contents button
When clicking this button, the Contents dialog box is displayed if Device is selected.
This dialog can be used to see the list of archives in the selected device. For the details, refer
to Contents dialog box. Server File Path dialog box is displayed if File is selected. For
the details, refer to the section Define a file when archiving manually dialog box.
IMPORTANT
An error message is displayed in the following situation when Defining a file when archiving
manually is selected.
No file exists on the defined file path on the Exaquantum/PIMS server.
For each archive group selected from the Archive Groups list, a six-column, read-only table
shows information for the:
Candidates available for archiving
Existing archives.
An entry must first be selected from this table before archiving operations can be performed.
Operations
The save operation can be performed on both archive candidates and On-line archives. In the
case of archive candidates an archive will be created before the backup takes place.
Note 1: If the 'Automatic unrestore after save option is checked on the Advanced
Configuration dialog, then the resultant status will become offline.
Note 2: Only the oldest Archive candidate is available for backing up.
The Restore operation may be performed on Off-line archive archives. The restore operation
will read the archive data from the currently selected device and create an on-line archive. See
NOTE 1 below.
The Unrestore operation may only be performed on On-line archives that have been backed-
up. The operation removes the archive from disk, freeing up disk space.
The Delete button is used to remove the selected candidate from the archive. When the user
selects an archive candidate and clicks on Delete, a prompt to confirm the deletion is
displayed. Once confirmed, the candidate will be deleted from the archive.
The user can find archives that store data within a selected time range by using the controls in
the Search section.
NOTES.
1. If the restore is attempted for an archive that was backed-up in SQL Server 2000 or before,
then it cannot be restored directly to Exaquantum. If such an operation is attempted, then
the user will be presented with an error dialog - The Database is incompatible with the
current version of SQL Server. This is due to the database format being incompatible
with SQL Server 2012. Restore of these archives firs requires use of the Rearchive Tool
see Chapter 15

Associated Screens
Advanced Dialog
When the Advanced button on the Archiving screen is clicked, the Advanced dialog is
displayed. This dialog contains settings that are infrequently changed in the archiving tool,
and are for the system as a whole (not specific to a particular archive group).
Maximum archive size
The Maximum archive size field defines the maximum archive size in megabytes. Default is
640 MB.
Automatic unrestore after backup
When Automatic unrestore after backup is checked, an archive is offlined after being saved.
Default Folder for Manual Archive
The Default Folder for Manual Archive allows specification of the default folder where
manual archive files are saved.
Contents Dialog
When the Contents button on the Archiving screen is clicked, the Contents dialog is
displayed. It contains a list of archives available on the currently selected device (by reading
the backup media).
Group Advanced Settings Dialog
When the Group Advanced button on the Archiving screen is clicked, the Group Advanced
Settings dialog is displayed. It is used to configure the auto archiving functionality on a per
Archive Group basis.
The Retention Period is a multiple of the archive period; it is used to determine the amount
of time that data will be maintained online, before it can be considered as a candidate for
auto-archiving or auto-deletion.
The Automatic offline period is the delay following the retention period. This allows:
Backed up archives to be automatically offlined. (Auto-Backup set)
OR
Non-backed up archives to be automatically deleted. (Auto-Backup not set)

Server File Path Dialog box

This dialog box is used when an archive is saved to a file rather than a SQL Server device. It
is used in 3 modes:
To save an archive candidate to a file (Save mode)
To restore (online) a saved and offline archive (Restore mode)
To display the contents of an archive backup. (Contents mode)
Save mode
Save folder
This specifies the destination folder to save the manual archived file. This is initially set to the
Default folder for manual archive, as set in the Advanced dialog
The save folder can be modified by either:
Direct entry into the field, or
Using the browse button []
IMPORTANT
Do not specify any writing medium such as DVD-R, DVD-RW as a destination folder.
Save File
If "Archive ID" is unchecked, a default save filename will be presented for manual archives.
The default is to use the archive ID to identify the file; the filename format being <archive
ID>.bak. If the Use archive ID is unchecked, then the user can specify their own file.
Use of Archive ID setting
This allows the archive backup file to be named using the archive ID.
Use Archive ID is the default.
If Archive ID is unchecked, a default save filename will be presented for manual archives.
Restore mode
Save folder
This specifies the folder to locate the backup of the archive file (for restore). This is initially
set to the Default folder for manual archive, as set in the Advanced dialog
Save File
The save file is the name of the archive file to restore. The default is to use the archive ID to
identify the file; the filename format being <archive ID>.bak. The user can specify their own
file, by direct entry into the Save File field.

Contents mode
Save folder
This specifies the folder to locate the backup of the archive file (for contents display). This is
initially set to the Default folder for manual archive, as set in the Advanced dialog
Save File
The save file is the name of the archive file for contents display. The default is to use the
archive ID to identify the file; the filename format being <archive ID>.bak. The user can
specify their own file, by direct entry into the Save File field.
14.4 Scenarios
The following are situations in which the Archiving tool would need to be used.
Back up a Section of History and Take it Offline
In order to free up disk space, the historian should be regularly administered by backing up
and taking old history data offline. This backed up data may subsequently be restored to the
system, if it is necessary to make the data available again.
Restore a Backed-up Section of History
When data has been backed up and taken offline and backed up, it can be restored to the
system.
Remove a Restored Section of History
A section of previously restored history can be removed, so taking it offline.
Make an extra Backup of a Section of History
An archive that has been backed up can be backed up further times for added data integrity.
Back up an Archive that Failed to Back up
If the initial backup of an archive failed when it was being written to the backup device, then
an Archive will remain online with the status Online, not backed up. To back up these
Archives must be backed up again, to take the history offline.


Chapter 15 Rearchive Tool

15.1 General
Exaquantum archives are stored as database backups on SQL Server backup devices. With the
introduction of Microsoft SQL Server 2012, database backups created on SQL Server 2000
become incompatible with SQL Server 2012; SQL Server prevents such databases backups
being restored. For offline archives backed up on Exaquantum versions R2.20 and before, this
means that these cannot be made online in Exaquantum, using the Archive UI in the
Administration Tools. In order to handle this restriction, and to make these older archives
compatible with SQL Server 2012, the Rearchive Tool is provided.
15.2 Concepts
The Rearchive Tool is a console application with two modes, defined in Table 15-1.
Table 15-1 Rearchive Tool - modes
Mode Description
Check The check mode either displays or outputs to a CSV file the list of archives
within a backup device along with the compatibility with SQL Server 2012.
Rearchive This mode reads one archive from a SQL Server backup device, updates the
compatibility to SQL Server the currently supported (by Exaquantum)
version of SQL Server, and then backs up the modified archive database to
second backup device.
15.3 Security
The user must be a member of the local Administrators group, .and one of the following:
QAdministratorsGroup (Legacy Security mode)
QTM_MAINTENANCE (Standard Security mode)
15.4 Check Mode

Command line
Rearchive /check /source:<source> /outputDir:<outputDir>
Arguments
Table 15-2 Rearchive Tool check mode arguments
Name Mandatory Description

Check Yes Specifies check mode
Source Yes Specifies the name of the backup device to use.
outputDir No Specifies the path to write the CSV file containing
the results of the check. If not specified, then the
list will be displayed within the console
application. The directory must already exist.

15-2 Chapter 15 Rearchive Tool
NOTES:
1. If an argument contains a space then it must be enclosed in double quotes.
2. If an output directory is specified, then a CSV file with the name of the source device is
written. If the filename already exists then it will be overwritten.
Output
The output of the check command consists of tabular data. The output consists of the following
columns:
ID the ID of the archive
Compatible with SQL Server 2012 indicates whether the archive is compatible with SQL
Server 2012
The output can be displayed on screen as shown in Figure 15-1 or to CSV file as shown in Figure
15-2. In this example, archive 1 is incompatible with SQL Server 2012.
Figure 15-1 Rearchive console output
REARCHIVE /check Device A
ID | Compatible with SQL Server 2012

------------------------------------------------------------------
1 | No
14 | Yes
25 | Yes
27 | Yes
Figure 15-2 Rearchive output file format
ID,Compatible with SQL Server 2012
1,No
14,Yes
25,Yes
27,Yes
15.5 Rearchive Mode
Command line
Rearchive /rearchive /source:<source>
/destination:<destination> /archiveid:<archiveid>

Arguments
Table 15-3 Rearchive Tool rearchive mode arguments
Name Mandatory Description

source Yes The name of the source backup device
containing the existing archives.
destination Yes The name of the destination device to back
up the archive to.
archiveid Yes The ID of the archive to re-archive.
NOTES:
1. If an argument contains a space then it must be enclosed in double quotes.
2. The source and destination devices must already exist in SQL Server Express.
Output
The application will return messages to the console window indicating success or failure (Section
15.6).
15.6 Output Codes
The output codes are bitwise to allow for multiple messages in a single return code. They are
defined in Table 15-4.
Table 15-4 Rearchive Tool output codes
Message Code
No Error (Success) 0
Exception (Unhandled error) 1
Source archive not found 2
Destination archive not found 4
Archive ID does not exist 8
Output directory does not exist 16
No archives found 64
Archive ID Invalid 128
Cannot start SqlExpress 256
Stored procedures not created 512
Access Denied 1024

15-4 Chapter 15 Rearchive Tool
15.7 Install Mode

Command line
Rearchive /installsql
Installs SQL Server Express 2008 R2 on the local machine.
15.8 Help Mode

Command line
Rearchive /?
Outputs help information to the console.

Chapter 16 Event Generator

Note: This is an advanced and optional feature of the Exaquantum system. Users do not
have to refer to this chapter unless they are developing application software on top of
the Exaquantum system.
16.1 General
The Event Generator is a mechanism by which application programs are triggered upon
events and allowed to perform their expected functions. Examples of applications that may
make use of this mechanism include e-mail generation, shift or daily report generation, or
even batch applications. It is clear how valuable Event Generator can be to the user, with
regard to such applications.
The Event Generator consists of a number of components:
Event Utility
This is the user interface part of the function that allows the user to define filter conditions
that the Event Handler uses to screen events from various sources and, when matched,
send to application programs. See Section 16.3 for further information.
Event Handler
This is the server program that accepts events from sources and, after filtering, generates
events for applications. This is a hidden process; it runs in the background in accordance
with what has been defined for the filter conditions. This component is not described
further here.
Microsoft Message Queue
The Microsoft Message Queue (MSMQ) option software that manages messages and
delivers them to applications. See Section 16.2 for further information.
Application Programs
Target application programs that run upon events. Applications should run on an
Exaquantum server PC since MSMQ is used to create queues only on the Exaquantum
server. As it is beyond the scope of this Users Manual, this component is not described
further here.
16.2 Concepts
Microsoft Message Queue
In order that the Event Generator operates as it was designed, MSMQ must be installed on the
Exaquantum server. MSMQ is an optional component of the Exaquantum server, and is
required only when users want to run the Event Generator and application programs. For
information about installing MSMQ, refer to the Installation Guide (ref: IM36J04A13-01E).
If there is no particular application planned, it is not necessary to install MSMQ on the server.
In this case the Event Utility will partially function; the ability to define filter conditions will
be available, but the filter conditions will not actually be processed. (A warning message to
this effect is displayed, if the Event Utility is run without MSMQ installed.)

16-2 Chapter 16 Event Generator
Event Sources and Events

There are two types of event sources, each with a predefined set of event categories. The user
can select any of the categories from this set to define filter conditions that can be transferred
to application programs. The event sources are:
OPC Gateways
Any OPC gateways that have been defined in the OPC Gateway Configuration screen to
enable Alarm and Events. The Event Handler reads Alarm and Events messages after
those filtered by the A&E filter from these OPC gateways. The event categories are the
types of Alarms and Events that are defined by the OPC specification. Exaquantum is
shipped with the Exaopc event categories for Yokogawa CS/CS3000/CS1000. For more
detailed information of these categories, refer to the Exaopc Interface Package Guide
Manual (ref: IM36J02A11-01E NTPF100).
Exaquantum
Two types of Exaquantum internal events are available: Aggregation and Calculation.
Aggregation is a category of events that are automatically generated on completion of an
aggregation period and aggregation calculations. Calculation is a category of events
generated explicitly by users; an explicit function call is written within a calculation
expression.
Each event has its own parameters; for example Aggregation event has Aggregation type and
Aggregation Time. Details of the parameters of each event type are not described here, as
parameters are discussed with application programs. Chapter 13 (Expressions) describes the
function and parameters of calculation events.
Matching
It is useful to understand the order and scope of matching. When a message of a particular
event category is received from an event source, the Event Handler goes through the filter
conditions that have been defined for the event category, to find out the matching conditions.
Using the Event Filter Condition Definition screen (one of the Event Utility screens), users
can control the order of matching by assigning a specific order (through the Order field).
The evaluation is made in ascending order; whenever a condition matches a message it is sent
to an application, resulting in any further searches at this point being halted. If an event is
expected to match further, and to generate more than one event, the Continue check box must
be checked. This means that the search will go on until the next match is found, or the end of
the conditions is reached.
Note: Order numbers are allocated across event categories. The number in the Order field
is therefore unique to each filter condition. The total number is limited to 500; this
means that the Exaquantum system can define up to 500 filter conditions.

16.3 User Interface

The Event Utility user interface comprises four screens. The Filter Condition Summary
screen is displayed initially, and the three other screens are used for carrying out further
functions. The screens are:
Filter Condition Summary screen
This screen is displayed initially. It allows users to view the currently defined filters of
each event category, and to edit them using the other screens.
Application Definition screen
This screen allows the user to define the application programs that will receive the
messages.
Event Filter Condition Definition screen
This screen is used either to create a filter condition, or to change the parameters of a filter
condition.
Simulation screen
This screen allows users to manually set values for an event, and send it to an application
program to test what has been defined.

Filter Condition Summary

This is the main screen accessed from the Management Console (Event Generator under the
Advanced tree folder); a screen layout is shown in Figure 16-1 . It displays a list of currently
configured event filter conditions and provides the facility to delete, edit or add new
conditions using other screens.
Figure 16-1 Event Handler, Filter Condition Summary Screen

Screen Components
The Filter Condition Summary screen comprises two fields and a list, and several control
buttons.
Fields and Lists
Event Source
This drop-down list allows the user to select an OPC Gateway that has alarm & events
enabled or the Exaquantum Server.
Event Category
This field displays the available event categories for the selected event source. It allows the
user to select one of the event categories, to see the currently defined event conditions
(displayed in the event conditions table).
Event Conditions Table
This multi-column table displays all the currently defined event conditions for the currently
selected event category under the following columns:
Order: A number indicating the order in which the event conditions were created.
Application Name: Name of the application that is monitoring a message queue that the
condition will send messages to.
Description: A user-supplied description of the event condition, NLS compatible, maximum
256 characters.
Run mode: 'Enabled is displayed when the event filter condition is checked for matching.
Disabled is displayed when the event filter condition has been registered but is not checked
for matching.
The entry in this column depends on whether or not the Disabled box has been checked in the
Conditions section of the Event Filter Condition Definition screen. The default is to display
Enabled.
To input information in any of these columns, the Event Filter Condition Definition screen
must be used (where these column headings are fields, lists or check boxes). Where no filter
conditions are displayed, click on the New button to input details; to change any details, click
on the Edit button.

Control Buttons
The control buttons that appear within the main list box, and apply to a single event filter
conditions, are:
New
When clicked, displays the Event Filter Condition Definition screen. This allows the user to
specify a new event filter condition. New is enabled only after an Event Category has been
selected and highlighted.
Edit
When clicked, displays the Event Filter Condition Definition screen. This allows the user to
edit the configuration of a selected event filter. Edit is enabled only when an event filter has
been selected.
Delete
Allows a selected event filter to be deleted. A pop-up is displayed to prompt for confirmation.
Delete is enabled only when an event filter has been selected.
Re-load
Requests that event filter conditions be sent to the running Event Handler program and starts
screening alarm and event messages with the new event filter conditions.
Note: This is disabled when MSMQ is either not installed or not running.
Trace On or Trace Off
Toggles the message trace feature on and off. When Trace On is clicked, a pop-up is
displayed that allows a log file name and path to be specified. Event filter alarm & event
messages are then copied to this log.
The log file is also useful for test purposes. When the 'Send' button is selected in the
Simulation Screen, a test message is sent to the log file.
Note: This is disabled when MSMQ is either not installed or not running.

Application Definition Screen

The Application Definition Screen (Figure 16-2) allows the definition of an application,
together with the MSMQ name on which to receive events.
Figure 16-2 Application Definition Screen
Screen Components
The Filter Condition Summary screen comprises a list, and several control buttons.
Fields and Lists
Application Definition Table
This multi-column table displays all the currently defined Applications under the following
columns:
Application Name: The name to be used for the defined application
Queue Name: The name of the MSMQ private queue that the application will be monitoring
for new event messages
Application Path: The path to the application executable to be used to monitor messages.
Control Buttons
The control buttons associated with the Application Definition section:
New
Creates a new application.
Delete
Allows the selected application to be deleted.

OK
Accepts any changes and closes the screen.
Cancel
Cancels any changes and closes the screen.
Apply
Accepts any changes.
Event Filter Condition Definition
This screen (Figure 16-3) is displayed when either the New button or the Edit button on the
Filter Condition Summary screen is clicked. It is used to either create a new event filter
condition or, to edit an existing one
Figure 16-3 Event Filter Condition Definition Screen
Screen Components
Control Buttons
OK
Accepts any changes and closes the screen.
Cancel
Cancels any changes and closes the screen.
Simulation
Click on this button to display the Simulation screen.
Note: This button is enabled only when MSMQ is installed and running properly.

Disabled
Selecting the 'Disabled' option means that the event condition will not be active and reports
will not be generated. This feature is useful when the event condition configuration cannot be
completed in one session.
Note: The text displayed in the Run Mode column of the Event Condition Summary screen is
determined by whether or not the Disabled box is checked. If it is not checked, the default
is to display Enabled.
Continue
If an event is expected to match further, and to generate more than one event, the Continue
check box must be checked. This means that the search will go on until the next match is
found, or the end of the conditions is reached.
Fields and Lists
Order, Event Source & Event Category
These fields display the Event Filter Order Number and the Event Source and Event Category.
Application Name
Select the application to receive notification when the defined event is matched.
Description
This field should contain a meaningful description of the event condition
Condition Definition Table
This multi-column table displays and allows the definition of the event filter condition.
Opening Parenthesis (Column header is blank): The user can group conditions using
parentheses to form complex logical expressions. This field can contain zero or more
opening parentheses.
Attribute: This allows an event attribute or an Exaquantum Tag against which a match
condition is defined to be selected. When an attribute has been selected, a data type will
be shown adjacent to the name so that user can properly enter the matching value.
OPE: An operator for comparison can be selected from: equal to (=), less than (<), less than
or equal to (<=), greater than (>), greater than or equal to (>=), not equal to (!=).
Note: A value of particular data type allows only a limited set of operators; e.g. the
Boolean type allows only equal to or not equal to.
Value: This specifies the matching value against the attribute. The value must be entered
properly in terms of the data type. A maximum of 32 characters is allowed; the field is
NLS compatible. If the value is a string then the wildcards * (to match zero or more
characters) and ? (to match any single character) may be used.
Note: A logical comparison is executed on a binary basis. A lowercase character is
considered to be different from its uppercase counterpart, a wide character alphanumeric
(full size, or zen-kaku in Japanese) is different from a narrow character alphanumeric
(half-size, or han-kaku in Japanese), and so on.

Closing Parenthesis (Column header is blank): The user can group conditions using
parentheses to form complex logical expressions. This field can contain zero or more
closing parentheses.
And/Or: This specifies the logical concatenation with a following condition, if required, of
either And, Or or a full stop (.) to signify that there are no further conditions. The order
of evaluation is always the order of appearance, unless specified with parentheses.
Control Buttons: The control buttons associated with the Conditions section:
New: Creates a new condition.
Delete: Allows the selected condition to be deleted.
Add Opening Parenthesis: Adds an opening parenthesis to the currently selected

condition.
Remove Opening Parenthesis: Removes an opening parenthesis from the

currently selected condition.
Add Closing Parenthesis: Adds a closing parenthesis to the currently selected

condition.
Remove Closing Parenthesis: Removes a closing parenthesis from the currently

selected condition.
Parameters
Define what parameters are sent to the application, as part of the event notification.
Attribute: This allows an event attribute or an Exaquantum Tag to send additional
information to the application when the event condition is matched.
Control Buttons: The control buttons associated with the Parameters section:
New: Creates a new parameter.
Delete: Allows the selected parameter to be deleted.

Specifying Attribute/Tag Name

When an OPC Event condition is defined it is possible to use Exaquantum tags as conditions
or parameters in an event condition.
Note: The use of tags in calculation and aggregation events is not supported.
Clicking on the down arrow button of the Attribute column displays a pull down menu shown
in Figure 16-4.
Figure 16-4 Pull down Attribute/Tag menu
If an Attribute is selected, then it is entered into the selected condition, if the <Select Tag>
option is selected, the Tag Selector as shown in Figure 16-5 is displayed
Figure 16-5 Tag Selector Panel
From this form, the user can select an Exaquantum tag which is then configured for the
current condition after OK is clicked
Note: An event condition must also include one or more Alarm and Event fields.

Simulation Screen
The Simulation screen (Figure 16-6) is displayed when the Simulation button is clicked on
the Event Condition Definition screen. It allows users to manually set values for attributes of
an event condition report to test the process by sending a test message to the log specified in
the Event Summary screen, provided the Trace On option has been selected.
Figure 16-6 Simulation Data Screen
Fields
Attributes
This field displays a list of parameters associated with an event report when its condition has
matched.
Value
This field allows users to set values for the parameters to be included in the test message.
Control Buttons
Send
Sends the specified event with values to the MSMQ.
Close
Closes this screen.

Chapter 17 HIS Tag Generation

The HIS tags and the groups they belong to can be imported into Exaquantum using this tag
generation function. The following conditions must be true:
The HIS must be a control PC using the Yokogawa DCS.
The HIS-OPC has to be registered as a data collection source and the Exaopc as the OPC
gateway.
The tags generated from the HIS are in the form HIS Name.Block Name.Group Name. Tag
Name Item. Care should be taken when creating tags that they do not overlap with
existing tags.
Note: Even if a CENTUM-side tag corresponding to a tag created with this function has
already been collected as a different tag on the Exaquantum side, the function will
register it as a new tag onto the Exaquantum side.
Even if only one tag at the collection source is defined to be collected with multiple
tags on the Exaquantum side, the resources for that number of tags (along with the
number of tags) will be consumed.
Carefully use this function so as not to exceed the number of tags limited under the
Exaquantum license.
17.1 Tag Creation
Overview
If a tag is created based on information about trend collection pen allocation in HIS, it will be
possible to reference the same information as that of the HIS trend group.
Once tags have been created, it is possible, in the same way as for the HIS, to display trends
on the basis of a trend group or by mixing with trend collection pens of multiple trend groups.
The trends of trend groups with different collection periods can be displayed while being
mixed with each other.
Creating tags based on information about the HIS trend collection pen allocation will
eliminate the necessity of redoing engineering such as definition of tags (corresponding to
trend collection pens) and allocation of trend collection pens in Exaquantum. If a tag is
created, the Exaquantum server will collect trend data via the HIS-OPC or directly from the
FCS in Exaopc. The created tags will not directly be affected even if a trend collection pen is
modified in the HIS because no data is collected from the HIS trend file.

17-2 Chapter 17 HIS Tag Generation
Mapping between HIS and Exaquantum Tags

It is possible to create Exaquantum tags corresponding to multiple tags defined in the HIS.
Individual tags are named as follows:
Root.<HIS Name>.Block<Block Number>.Group<Group Number>.Tag Name
Example: Root.HIS0101.Block01.Group01.01F001_PV
A tag is formatted as: <CENTUM tag name>_<Item name>. For example, a HIS tag named,
01F001.PV, becomes 01F001_PV in Exaquantum.
Setting the Scan Period
Each OPC tag in Exaquantum has an update period which defines how often data is received
from the OPC gateways. The tag collection period when the tag is generated from the HIS is
automatically assigned based on the collection period of the HIS tag block. By default the
following relationships exist between the HIS and Exaquantum tag collection periods:
Table 17-1 Tag collections periods
HIS block Exaquantum tag collection

Template Name
collection period period
C3TC::AI1SEC 1 second 1 second
C3TC::AI10SEC 10 seconds 10 seconds
C3TC::AI1MIN 1 minute 1 minute
C3TC::AI2MIN 2 minutes 2 minutes

Modifying the value of collection period can change these relationships.

Table 17-2 Modifying Tag Collection Periods
Period Relationships
Collection Periods
HIS Exaquantum
1 second (default) Same as the table above
1 second 10 seconds
10 seconds 10 seconds 10 seconds
The remaining are the same as the table above.
1 second 1 minute
1 minute 10 seconds 1minute
The remaining are the same as the table above.
High- frequency update period tag restrictions

If the HIS-OPC is used for data collection from CENTUM, the collection throughput is
limited to 500 data items/second.
The recommended ratios of update rates to generated tags are as follows:
1 second: Less than 64 tags
1 second and 10 second: Less than 128 tags
Note: Tags can be generated that exceed the above guidelines, but there is a possibility that
some tags may not be updated at the specified update periods.
Note: If the Exaopc is used for data collection from CENTUM, the collection throughput
will be 2000 items of data/second.
Startup
To access the HIS tag generation window use the following procedure:
1 Start the Exaquantum Administration Tools. This will start the Exaquantum
Management Console.
2 Within the Administration Tools click on the Advanced folder in the tree view or icon in
the main view.
3 Beneath the Advanced folder or in the main view click the HIS Tag Creation icon.

Setup
Figure 17-1 HIS Tag Generation window
The HIS Tag Generation window comprises of following components:

OPC Gateway
Displays a dropdown list of OPC gateways. Choose the gateway relating to the selected
tags to be generated.
A red warning message will appear above the HIS tag list box if no OPC Gateways have
been configured. A gateway must exist before the Generate button is enabled.
The OPC Gateway needs to be registered as an OPC gateway type of:
Exaopc-HIS
Exaopc-STN
Exaopc-STN-RD.

Tags
The following tag details are displayed in the Tags section:
Licensed tags: The number of licenses corresponding to the current key code
Current tags: The number of licensed tags currently defined
Details
The following numeric values are displayed.
Number of current tags
The number of tags already generated for each collection period (update rate), for the
selected OPC gateway.
Number of tags to be generated
The number of CENTUM trend pens at each collection period.
(The tags to generate are checked in the tree structure showing tag candidates.)
Total
Total number of current tags and tags to generate
HIS Station
Enter the HIS computer name that holds the tag information. The HIS name can be typed
in or click on the [...] button to select a computer from the dialog.
Advanced button
Clicking the Advanced button will display the Minimum Collection Period window.
Please see the section, Collection Period for further details.
Browse HIS button
Reads tag information from the specified HIS and generates a list of candidates in a tree
view structure.
Generate button
Generates the selected HIS tags in Exaquantum.

Operation
This section lists the steps to generate Exaquantum tags from HIS tags.
1 Enter the HIS computer name.
2 Click the Browse HIS button. This will retrieve the list of HIS tags.
3 Select the HIS block, group and tags to be generated.
4 In the Tags section of the display the Tags to be generated value reflects the number of
tags selected in step 3. If this amount and the number of Current tags exceed the licensed
tags a warning message will be displayed. This will not stop the Tag generation operation
but tags should be deselected until the total generated tags fall within the licensed tag
count.
5 If required, the Collection period can be adjusted.
6 Select the OPC Gateway which the tags to be generated will collect data from.
7 Click the Generate button to complete the tag generation process.
Note1: Tags with 1-second or 10-second collection periods will be collected at a 1 minute
period, if the Minimum Collection Period is set to 1 minute.
Note2 If QHistorianData free space is less than 10% or 500MB, whichever is the greater, no
new folders, tags, or function blocks can be created.
Information about how many tags are generated at collection periods is displayed in the To
Generate column on the Details display fields for each OPC gateway. Note that this number
includes the number of existing tags (For example, if the number of existing tags is 5, and the
number of non-generated tags is 6, then the number of tags to generate is 11.
How changes to tags on the HIS are reflected in Exaquantum
The following points describe how HIS tag changes will be reflected in the Exaquantum tags:
The HIS tag tree does not differentiate between generated tags and those that have not been
generated. The selection for either option is identical. Tags that remain deselected will not
be deleted from Exaquantum.
If the selected HIS tag already exists in Exaquantum no changes will occur during the tag
generation process.
Note: Changes to the HIS tag attributes (such as display range) or CENTUM tag attributes
(such as engineering unit, range and tag comments) will not be reflected in the
Exaquantum tags during generation. To reflect these changes, please carry out on
Tag Editor from Administration Tools.

Changes to the Minimum Collection Period

Use the following steps to change the collection period of the tags to be generated:
1 Click the Advanced button.
2 Select a value from the Scan Rate Threshold drop-down list (1 second, 10 seconds, and 1
minute) to change the collection period.
3 Click the OK button to commit the change.
Figure 17-2 Minimum Collection Period window
Note: Care should be exercised when changing the collection period value. It will only
affect database space if the collection period is increased in frequency


Exaquantum PIMS Users Manual

Caricato da

Informazioni sul documento

Copyright

Formati disponibili

Condividi questo documento

Condividi o incorpora il documento

Opzioni di condivisione

Hai trovato utile questo documento?

Questo contenuto è inappropriato?

Copyright:

Formati disponibili

Exaquantum PIMS Users Manual

Caricato da

Copyright:

Formati disponibili

Instruction Exaquantum/PIMS

Manual Users Manual

Copyright and Trademark Notices

IM 36J04A11-01E 14th Edition Issue 1 February 21st 2014

IM 36J04A11-01E 14th Edition Issue 1 February 21st 2014

Exaquantum Document Set

Exaquantum General Specification (GS 36J04A10-01E)

Exaquantum Technical Information (TI 36J04A10-01E)