Instruction Exaquantum/Explorer User’s Manual

Manual Volume 3 – Excel Reports

IM 36J04A12-03E

IM 36J04A12-03E
th
© Yokogawa January 12 2021
nd
22 Edition Issue 1
Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports i

Copyright and Trademark Notices

© 2021 Yokogawa Electric Corporation
All Rights Reserved
The copyright of the programs and online manuals contained in the software medium of the
Software Product shall remain with YOKOGAWA.
You are allowed to print the required pages of the online manuals for the purposes of using
or operating the Product; however, reprinting or reproducing the entire document is strictly
prohibited by the Copyright Law.
Except as stated above, no part of the online manuals may be reproduced, transferred, sold,
or distributed to a third party in any manner (either in electronic or written form including,
without limitation, in the forms of paper documents, electronic media, and transmission via
the network).
Nor it may be registered or recorded in the media such as films without permission.
Trademark Acknowledgements
 CENTUM, ProSafe, Exaquantum, Vnet/IP, PRM, Exaopc, Exaplog, Exapilot, Exasmoc
and Exarqe are registered trademarks of Yokogawa Electric Corporation.
 Microsoft, Windows, Windows Server, SQL Server, Excel, Internet Explorer, SharePoint,
ActiveX, Visual Basic, Visual C++, and Visual Studio are either registered trademarks or
trademarks of Microsoft Corporation in the United States and other countries.
 Adobe and Acrobat are registered trademarks of Adobe Systems Incorporated, and
registered within particular jurisdictions.
 Ethernet is a registered trademark of XEROX Corporation.
 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 ® mark to indicate those trademarks or registered trademarks in this
manual.
 We do not use logos in this manual.

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

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 22nd Edition of this document.
Detail of Changes
The changes are as follows.

Chapter/Section/Page Change

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 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)

Exaquantum/Explorer User's Manual Volume 2

Custom Controls (IM 36J04A12-02E)

Exaquantum/Explorer User's Manual Volume 3

Microsoft Excel Reports (IM 36J04A12-03E)

Exaquantum/Explorer User's Manual Volume 4

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)

Exaquantum Engineering Guide Volume 2

Network Configuration (IM 36J04A15-02E)

Exaquantum Engineering Guide Volume 3

Support Tools (IM 36J04A15-03E)

Exaquantum Engineering Guide Volume 4

Web Authoring (IM 36J04A15-04E)

Exaquantum Engineering Guide Volume 5

PI Connection (IM 36J04A15-05E)

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

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 General ............................................................................................................................. 1-1
1.2 User’s Manual Content..................................................................................................... 1-1
Chapter 2 Excel Add-in........................................................................................................... 2-1
2.1 General ............................................................................................................................. 2-1
2.2 Upgrading from Older Versions of Exaquantum Excel AddIn ........................................ 2-2
2.3 Moving Excel Documents between Machines that have a Different Location for the
Exaquantum Explorer Excel AddIn ................................................................................. 2-3
2.4 Excel Add-In Menu and Toolbar ..................................................................................... 2-4
2.5 Data Selector .................................................................................................................... 2-5
2.6 Set Data Range/Update .................................................................................................... 2-7
2.7 QDATA Function........................................................................................................... 2-13
2.8 Setting of Report Times ................................................................................................. 2-31
2.9 Sample Program for Getting and Saving Excel Data ..................................................... 2-33
Chapter 3 Exaquantum Excel Report Templates ................................................................. 3-1
3.1 Report Templates ............................................................................................................. 3-1
3.2 Installing Report Template ............................................................................................... 3-2
3.3 Report Template Detail .................................................................................................... 3-4
3.4 Produce a Report ............................................................................................................ 3-14

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 1-1

Chapter 1 Introduction
1.1 General
This User’s Manual describes the configuration, administration and usage of
Exaquantum/Explorer, and is split into these volumes:
♦ General Information
♦ Custom Controls
♦ Excel Reports
♦ Advanced Configuration.
The chapters contained in these volumes are described below.
1.2 User’s Manual Content
Volume 1 – General Information
Chapter 1: Introduction – provides an overview of the Exaquantum system.
Chapter 2: Menus and Icons – describes the menus available from the desktop.
Chapter 3: Palette – describes the main features and explains how to customize the Palette.
The Palette is the source of all the controls that can be added to documents to form views,
reports and schematic diagrams or mimics etc. Intrinsic and ActiveX controls can be added
to the Palette if required.
Chapter 4: Application Launcher – describes the main features and how to use the
Application Launcher. It can be used to quickly open a frequently used application, such as
Microsoft Word, Excel, or Exaquantum/Explorer workbooks and documents. It can be
divided into groups to help organize applications.
Chapter 5: Data Selector – describes the main features and explains how to use the Data
Selector. The Data Selector shows the hierarchical structure that represents the available
Exaquantum process data.
Chapter 6: Workbook Viewer – describes the main features and explains how to use the
Workbook Viewer. The Workbook Viewer shows a hierarchical tree view of the contents of
a workbook, if one is open, and any libraries.
Chapter 7: Working with Documents – describes the main features and explains how to
create and format Exaquantum/Explorer documents.
Chapter 8: Workbooks – describes the main features and explains how to use the Workbook.
The Workbook stores the initial configuration of a user interface. Use workbooks to specify
the active document, and to control the startup and configuration options of the documents in
Run mode.
Chapter 9: Property Sheet – describes the main features and explains how to use the
Property Sheet. The Property Sheet allows you to view and/or change the properties of a
control. It is only available in Design mode.
Chapter 10: Property Binder – describes the main features and explains how to use the
Property Binding function. The Property Binder can be used to change the values of some of
the properties of controls.

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

1-2 Chapter 1 Introduction

Chapter 11: Exaquantum/Explorer Network Connections - describes how

Exaquantum/Explorer responds when the connection to the Exaquantum server is lost.
Volume 2 – Custom Controls
Chapter 1: Introduction – lists the chapters contained in the four volumes.
Chapter 2: Trends – describes the main features and explains how to use and configure the
Trending control. The Trending control is an ActiveX control that allows real-time (live) or
historical data to be displayed in graphical and/or tabular form.
Chapter 3: Trend Comparison – describes the main features and explains how to use and
configure the TrendComparison. The TrendComparison is an ActiveX control that allows
real-time (live) or historical data to be displayed in graphical and/or tabular form.
Chapter 4: Alarms and Events – describes the main features of the Event Summary and
Event Update controls. This chapter also explains how to configure the controls.
Chapter 5: Data Entry Grid – describes the main features and explains how to configure the
Data Entry Grid control. The Data Entry Grid allows manually entered data for the plant or
process to be shown in a tabular form. The Data Entry Grid also allows you to correct,
update and enter data values.
Chapter6: Controls - describes the controls available on the default Palette and additional
controls supplied with Exaquantum/Explorer. The supported properties and events for each
control are also listed.
Chapter 7: Trend Analyze – describes the main features and explains how to use and
configure the Trend Analyze. The Trend Analyze screen is a screen created with Explorer,
which allows Trend display or Alarm and Event display linking with Trend display only by
defining tag information. In Run mode, it is possible to display the trend or alarm & events
of a tag only by setting the tag definition information without creating a new document in
Explorer.
Chapter 8: Trend Template – describes the main features and explains how to use and
configure the Trend Template. With the goal of improving engineering efficiency, Trend
Templates are supplied beforehand in various formats as preparation in order to adapt to
various situations. Because these templates have been supplied in Exaquantum/Explorer
format, the explorer trend screen can be easily displayed using the explorer function.
Volume 3 – Excel Reports
Chapter 1:Introduction – lists the chapters contained in the four volumes.
Chapter 2:Excel Add-in – describes the main features and explains how to use and configure
the Excel Add-In and the report templates.
Chapter 3:Exaquantum Excel Report Templates – describes the main features and explains
how to use and configure the Exaquantum Excel report templates.

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 1-3

Volume 4 – Advanced Configuration

Chapter 1: Introduction – lists the chapters contained in the four volumes.
Chapter 2: Scripting – describes the scripting environment and explains how to use the
Scripting Facility. The scripting facility allows you advanced control of properties and event
handling.
Chapter 3: Data Parameterization – describes the main features and explains how to use the
Data Parameterization function. Data parameterization allows you to define the sources of
data variables so they can change dynamically in Run mode.
Chapter 4: Navigation - describes how to load documents into windows using the
Exaquantum/Explorer navigation functionality.
Chapter 5: Data Write Back - describes the main features and explains how to use the Data
Write Back function.
Chapter 6: OLE DB/ODBC Client Access - details the type of access to Exaquantum data
that is available to OLE DB/ODBC clients. The types of data that can be read and the
applications that can be used are described.

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

1-4 Chapter 1 Introduction

This page intentionally left blank

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 2-1

Chapter 2 Excel Add-in

This chapter describes the main features and explains how to use and configure the
Exaquantum/Explorer Excel Add-In.
This chapter assumes a basic knowledge of Microsoft Excel.
2.1 General
The Exaquantum/Explorer Excel Add-In (Figure 2-1):
♦ Makes live and historical Exaquantum data available within the Microsoft Excel
environment
♦ Provides simple drag and drop of Exaquantum data into spreadsheets.
Figure 2-1 Sample Excel Add-In Display

Note: Ensure that the Exaquantum/Explorer Excel Add-In (Excel Add-In) installation has
been completed before continuing. The instructions for this can be found in the
Exaquantum Installation Guide.
Do not use to share the following Excel AddIn files from the other environment.
- The spreadsheet which was created before the R2.80 release of Exaquantum.
- The spreadsheet which was created in the different OS architecture environment (ex. x86 to x64).
Note: There can be some issues when opening Excel worksheets. Please refer to Sections
2.2 and 2.3 for details.

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

2-2 Chapter 2 Excel Add-in

2.2 Upgrading from Older Versions of Exaquantum Excel AddIn

Caution
There may be a problem with opening of files created from previous versions of the Excel
AddIn.
When opening an Excel spreadsheet, using the Exaquantum Excel AddIn – if the spreadsheet
was originally created before the R2.80 release of Exaquantum or it was originally created in
a different OS architecture environment–Excel may display a dialog stating that links are
incorrect, and subsequently, will not display any data.
Procedure
1. Create a back-up of the excel file.
2. When opening the Excel file, the following two situations sometimes occur.

A. The following dialog is displayed :

"The workbook contains links to one or more external sources that could be unsafe"
i. Select "Don’t update".
ii. Confirm that the data displayed on Excel is correct and save the Excel file.

B. When message bar "SECURITY WARNING" is displayed

i. Select "Enable Content".
ii. When the following dialog is displayed:
"We can’t update some of the links in your workbook right now."

iii. Select "Continue". (This dialog is not displayed sometimes.)

iv. Confirm that the data displayed on Excel is correct and save the Excel file.

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 2-3

2.3 Moving Excel Documents between Machines that have a

Different Location for the Exaquantum Explorer Excel AddIn
Caution
There may be a problem with opening of files created on a machine where the Excel AddIn
was installed to a different windows folder.
When opening an Excel spreadsheet that uses the Exaquantum Excel AddIn – if the
spreadsheet was originally created on a machine with a different path to the Explorer Excel
AddIn – Excel may display a dialog stating that links are incorrect, and subsequently, will
not display any data.
Procedure
1. Create a back-up of the excel file.
2. When opening the Excel file, the following situation sometimes occurs.

A. When message bar "SECURITY WARNING" is displayed

i. Select "Enable Content".
ii. When the following dialog is displayed:
"We can’t update some of the links in your workbook right now."
iii. Select "Continue". (This dialog is not displayed sometimes.)
iv. Open the “Edit Links” dialog and select “Change Source”
v. Select the correct Excel AddIn path for the new environment
vi. Confirm that the data displayed on Excel is correct and save the Excel file.

B. When excel cells display “NAME?”

i. Open the “Edit Links” dialog from the “Data” menu and select “Change Source”
ii. Select the correct Excel AddIn path for the new environment
iii. Confirm that the data displayed on Excel is correct and save the Excel file.

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

2-4 Chapter 2 Excel Add-in

2.4 Excel Add-In Menu and Toolbar

When the Exaquantum/Explorer Excel Add-In is installed, an Exaquantum ribbon is added to
the Excel application. (Figure 2-2).
Figure 2-2 Excel Menu Bar with Additional Ribbon

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 2-5

2.5 Data Selector

The Exaquantum Data Selector is available from within the Excel environment from the
Exaquantum menu options; see section 2.3. As in Exaquantum/Explorer, the Data Selector
for Excel Add-ins can be used for dragging tags and items to cells on an Excel spreadsheet.
In fact any Exaquantum Data Selector can be used for this purpose. The correct QDATA
function will be created automatically and added to the cell.
Using the Data Selector.
Adding a single data item to an Excel sheet:
♦ Click on the item and drag it to the required cell in an Excel sheet.
Adding multiple data items to an Excel sheet:
♦ Consecutive items – To add a set of consecutive items, click on the first item and
while holding down the shift key, click on the last item. All the items in the set will
be highlighted. Continue to hold down the shift key while dragging the items to the
required set of cells in the Excel sheet. Release the shift key first, followed by the
mouse button, to drop the items on the sheet.
♦ Non-consecutive items – To add a set of non-consecutive items; hold down the
control key while clicking on each item to be selected. When all the items are
selected, continue to hold down the control key while dragging the items to the
required set of cell in the Excel sheet. Release the control key first, followed by the
mouse button, to drop the items on the sheet.

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

2-6 Chapter 2 Excel Add-in

Adding data items to the spreadsheet this way will result in the QDATA function being
pasted into the spreadsheet with the specified parameters set (see the QDATA Function
section for more information). The parameters are set using the Set Data Range/Update
dialog box. Refer to section 2.6.
Figure 2-3 Exaquantum Data Selector

For more information about the Data Selector, see the Exaquantum/Explorer User's Manual
Volume 1 – General Information (IM 36J04A12-01E).

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 2-7

2.6 Set Data Range/Update

Configuring data requests
Items selected using the data selector, are configured using the Set Data Range/Update
dialog box. The required parameters must be set in this dialog box before adding an item or
items to the Excel sheet.
To access the Set Data Range/Update dialog box:
1 In the Data Selector, right-click to display the context menu.
2 In the context menu, select Times…. The Excel Add-in version of the Set Data
Range/Update window is displayed.
Figure 2-4 Set Data Range/Update Dialog

The Set Data Range/Update dialog box available when using the Excel Add-in differs from
the equivalent dialog box in Exaquantum/Explorer. The additional features of the Excel Add-
in version are described below. For more information about the generic aspects, refer to the
Exaquantum/Explorer User's Manual Volume 1 – General Information (IM 36J04A12-01E).
Aggregations using the Excel Add-in
This section describes the extra settings that are related to the aggregation features. They are
only available in the Excel Add-in version of the Set Data Range/Update dialog box.
The Excel Add-in Aggregation feature gives access to a set of built in automatic calculations
for some of the common functions that might be used to exploit the original data.
Access to the Aggregations function is enabled in the Data Range section of the dialog box
by selecting Aggregation.
Data can be of two distinct types, analogue and digital. There are different aggregations
available for each type:

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

2-8 Chapter 2 Excel Add-in

Types of aggregations
Analogue aggregations
These aggregated values are calculated from original data that may have a wide range of
values:
♦ Minimum – the minimum value recorded during the calculation period.
♦ Maximum – the maximum value recorded during the calculation period.
♦ Mean – the running mean value calculated over the calculation period.
♦ Standard Deviation – the standard deviation over the calculation period.
♦ Summation – the sum of the values over the calculation period.
♦ Spot Value – the value at the start of the calculation period.
Digital Aggregations
These aggregated values are calculated from original data that can take only two values
(represented in the descriptions below by ‘on’ and ‘off’):
♦ On Count – the number of times the value changed from ‘off’ to ‘on’ during the
calculation period.
♦ On Time – the total amount of time the values was ‘on’ during the calculation period.
Aggregation parameters
The following parameters can be configured for the aggregations. The availability of
particular sections will depend on other settings:
♦ Interval – The duration between the monitoring periods.
♦ Update Rate – The rate at which the data is updated in real time. (Not available when
History is selected in the Data Type section.)
♦ Update Rate Increment – The time between successive values that will be used to
replay the original data. (Only available when History Replay is selected in the Data
Type section.)
♦ Aggregations – Select the type of aggregation required. The following boxes will be
available depending on the selection made.
♦ State Count – the state that is being monitored. Available when ‘On Time’ or
State Count’ is selected.
♦ Partial Aggregation Result – If checked, partial aggregations will be included in
the results. Always available (See Partial Aggregations below.)
♦ Summation Time Factor – The period over which the aggregation will be
calculated. Only available when ‘Summation’ is selected and ‘Differential
Summation’ is not selected.
♦ Differential Summation – If checked, differential aggregations will be included in
the results.
♦ Maximum Value – The period over which the aggregation will be calculated.
Only available when ‘Summation’ and ‘Differential Summation’ is selected

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 2-9

♦ Decimal Places – The period over which the aggregation will be calculated. Only
available when ‘Summation’ and ‘Differential Summation’ is selected.
♦ Percentage Difference – The period over which the aggregation will be
calculated. Only available when ‘Summation’ and ‘Differential Summation’ is
selected.
Values Type
Determines how initial and final values are treated if they fall between the times at which
values are recorded. In all cases, the first value returned will be the last value recorded
before the request was made. The Value Types setting determines the timestamp attached to
the value.
Edge (Timestamp as requested) – the first value will be given the timestamp of the time at
which it was requested.
Bounding (Timestamp of value change) – the first value will be given the timestamp of the
actual recorded time.
Quality Display
Determines the nature of the related quality value. The choices available are: Raw, Primary,
Secondary or Primary/Secondary.
Orientation
When selecting multiple objects for a drag and drop operation, this setting determines
whether the items will be stacked vertically or horizontally on the Excel sheet. The shape of
the positioning indicator shows where the items will be placed.
♦ Horizontal – When dropped, the items will occupy successive cells from left to right
♦ Vertical – When dropped, the items will occupy successive cells from top to bottom.
Data Order
Determines how the data is ordered, either older or newer first.
QDATA Formula
Determines how the data values are stored in the spreadsheet. If the ‘Replace QData
formulae with values’ box is checked, data values are saved into the spreadsheets cells rather
than saving the QDATA formula. In this mode the update rate is ignored and there is a one-
off fetch of the data.
When the ‘Replace QData formulae with values’ box is checked spreadsheets can be created
that can be shared with users who do not have a connection to the Exaquantum servers.

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

2-10 Chapter 2 Excel Add-in

Value Filter
A filter type drop down is provided which contains the following parameters:
♦ No Filters
♦ Filter1
♦ Filter1 AND Filter2
♦ Filter1 OR Filter2
Depending on the selection from this list up to a maximum of 2 data value filters are
displayed which can be configured.
Each filter rule contains an operation drop down which contains the following parameters
♦ = (Equal)
♦ <> (Not Equal)
♦ < (Less than)
♦ > (Greater than)
♦ <= (Less than or Equal)
♦ >= (Greater than or Equal)
And a value input box, which allows input of numerical characters.
NOTES:
1. Value Filter will not be applied to string tags
2. The Value Filter only applies to raw data (no interval)
Primary Quality Filter
Four check boxes are provided to choose which qualities of data should be returned from the
QData query. If no checkboxes are selected it is assumed that the filter is switched off and
data of any quality is returned.
NOTES
1. It is possible that Bad Quality, <No Value> can be displayed even if the quality filter is
set to exclude Bad qualities. This indicates that the time (start time, end time, or both) of
the query was outside the range of data stored for the item.
2. The Quality Filter only applies to raw data (no interval)
Constraints of the data buffer delay
In some cases, when you request data be updated for a period of time close to the current
time, for example NOW-4 Seconds to NOW, it is possible for the data to be incorrect.
Note: The server time is used for the value of NOW.
Running the above example for 4 seconds, from 09:00:04 to 09:00:08, the results could be as
shown in Table 2-1 below.

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 2-11

Table 2-1

View at 09:00:04 View at 09:00:05 View at 09:00:06 View at 09:00:07 View at 09:00:08

Timestamp Value Timestamp Value Timestamp Value Timestamp Value Timestamp Value

09:00:00 10 09:00:01 10 09:00:02 10 09:00:03 10 09:00:04 14

09:00:01 10 09:00:02 10 09:00:03 10 09:00:04 10 09:00:05 15

09:00:02 10 09:00:03 10 09:00:04 10 09:00:05 10 09:00:06 16

09:00:03 10 09:00:04 10 09:00:05 10 09:00:06 10 09:00:07 17

09:00:04 10 09:00:05 10 09:00:06 10 09:00:07 10 09:00:08 18

In reality, the data actually changed every second as shown in Table 2-2.
Table 2-2

Timestamp Value

09:00:00 10

09:00:01 11

09:00:02 12

09:00:03 13

09:00:04 14

09:00:05 15

09:00:06 16

09:00:07 17

09:00:08 18

This effect is due to buffered data not reaching the Exaquantum Historian in time, so the
Exaquantum Excel Add-in inserts data points at the requested update rate. The effect is more
pronounced for rapidly updating data, such as 1 second updates.
In the above example, the incorrect data points, shown in red in Table 2-1, were inserted
during the updates from 09:00:04 to 09:00:07 because the real data being held in the
historian buffer. Finally at 09:00:08 the buffered data reached the Historian and was
correctly displayed in the Exaquantum Excel Add-in.
If the Exaquantum Excel Add-In query is executed again for historical data, then the values
will be correct. The effect only occurs with updating queries.

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

2-12 Chapter 2 Excel Add-in

Partial Aggregations
When an aggregation period cannot be divided into an exact number of sample periods, there
will be a period at the end for which the aggregation would not normally be created. To
overcome this situation, you can select to use Partial Aggregations. This will create an
additional aggregation covering the period from the last normal aggregation to the end of the
aggregation period. This effect is demonstrated by the following example:
Example of Partial Aggregation
♦ Aggregation period = 02:34 to 06:10
♦ Aggregation type = Mean
♦ Sample Period = 1 Hour

End Time
Start Time 6:10
2:34 3:34 4:34 5:34 6:34

Interval Period

With Partial Aggregation enabled, the results are shown in the table below. The point to
note is that without Partial Aggregations the data shown in the last line would not be
available.

Data returned at Period covered

03:34:00 02:34:01 – 03:34:00

04:34:00 03:34:01 – 04:34:00

05:34:00 04:34:01 – 05:34:00

06:10:00 05:34:01 – 06:10:00

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 2-13

2.7 QDATA Function

The Excel Add-In is based on the QDATA function.
The function can be used in the same way as the Excel built-in functions.
It can be inserted into a spreadsheet by typing it into a cell or under the ‘User Defined’
category of the function wizard.
The QDATA function works in an asynchronous manner. This is to ensure that the Excel
session is not locked up when potentially large amounts of process data are to be retrieved.
On making a request for data the QDATA function will immediately return with the string
‘#REGISTER’. A request is made to the Exaquantum/PIMS server for the data. When this
has been retrieved the Excel cells will be updated with the values.
Note: A limitation in Excel means that the maximum number of data values that can be
returned from one request to QDATA is 1048576. This means about 2 years-worth
of information can be displayed for a value with an update rate of 1 minute. If the
number of values to be returned exceeds the limit, then the function will return the
first 1048576 values available. In versions of Excel earlier than Office 2016, the
maximum number is 65536 which means about 1080 hours-worth of information
can be displayed for a value with an update rate of 1 minute.
Note: The data retrieved for a time range will always be the oldest data first. The data
ordering will take place on this block of data, which could be restricted according to
the 1048576 data values limit (or 65536 limit in versions of Excel earlier than
Office 2016). Therefore, specifying data ordering as Most Recent first will not
necessarily display the most recent values of the time range selected, if the data is
limited to the Excel data values limit.
Note: All data requests using the QDATA function will be re-queried when the
spreadsheet is opened. Therefore, if no access is available to the data server, or the
data is not available, no values will be retrieved. For static reports, values should be
copied and pasted as ‘Values Only’ to avoid this.
Note: During spreadsheet engineering, the data update function should be turned off, as
any selected part of a cell string will be deselected when a data update takes place.
Note: In QDATA function’s parameter, avoid use of the following Excel Functions. This
is because; Excel performance will be slowed significantly.
• RAND()
• NOW()
• OFFSET()
• CELL()
• INDIRECT()
• INFO()
• Today()

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

2-14 Chapter 2 Excel Add-in

Note: When requiring on-demand aggregation with bulk data access more than 50MB,
"#Value#" will be shown in the spreadsheet. Should this occur, data is not displayed,
and, the following message is logged in the application eventlog:
Error in QAggregateData : Query too large : Max size=50000000 Query size=504603600
Period Count=105119 Tag Count=15 ObjectSize=216 Interval Period=600 : R2.50
Note: If the QDATA() function is used as a direct parameter of the EXCEL IF() function,
the performance of EXCEL may be affected (slow). The following formula
illustrates this:
=IF(A2>1, QDATA(<parameters>), “”)
To avoid this situation, locate the QDATA function in a different cell, and refer to
this cell from the IF() function.
If a request is made for a time stamp an attempt to format the cell containing the request is
made. The rule is that if the cell is formatted to “General” then the cell will be formatted to a
date in the format:
yyyy-mm-dd HH:MM:SS.
For requests of trend data the top cell is used to determine whether to format the column of
cells.
The QDATA function definition is as follows:
=QDATA( <access string>
[,[<start time>]]
[,[<end time>]]
[,[<Sample Period>]]
[,[<Update Rate>]]
[,[<Update Rate Increment>]]
[,[<Orientation>]]
[,[<Data Order>]]
[,[<Values Type>]]
[,[<Quality Display>]]
[,[<Aggregation>]]
[,[<Partial Aggregation>]]
[,[<Summation Time Factor>]]
[,[<State Count>]]
[,[<differential summation>]]
[,[<summation reset value >]]
[,[<number of decimal places >]]
[,[<valid percent difference >]]
[,[<Replace QDATA Formulae>]]

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 2-15

[,[<Value Filter>]]
[,[<Quality Filter>]])
A combination of the parameters is required for the desired data to be returned. These are
explained in detail. The parameters to the QDATA function are:
Display of Data
There are cases when data cannot be displayed in Excel. In these cases, a message in one or
more cells will be displayed, which identifies the reason for the failure to display the data.
These are described in the following table:

Message Description

#VALUE! An error has occurred, for example an invalid access

string has been specified.

#REGISTER Data is currently being retrieved from Exaquantum

<No Value> Indicates that there is no value at the associated

timestamp. The secondary quality may give further
information. For history trend queries, a display of
<No Value> can indicate:
• The start time of the query is before the start of
history data for the item;
• The end time of the query is later than the current
time

Access String
The access string is a unique identifier for an item in the Exaquantum database.
Type: String (Mandatory)
Examples: Root.CDU1.Reboiler.01FIC101.PV.Value:Value
Root.CDU1.Reboiler.01FIC101.PV.Value:Quality
Start Time
Specifies that start time for a trend of the time for a spot value.
Type: Variant (Optional)
Examples: NOW-12 HOURS
12/12/1999 10:00:00
End Time
The end time for a request for trend data.
Type: Variant (Optional)
Examples: NOW-12 HOURS
12/12/99 10:00:00

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

2-16 Chapter 2 Excel Add-in

Sample Period
The sample period must be in a date/time format. The default setting for the sample period
will return all of the values stored between the start and end times. An explicit setting will
guarantee a fixed number of values being returned. “Sample Period” is synonymous with
“interval”. If aggregation is selected then the default interval of 00:00:00 will calculate the
aggregation for the whole period, from the start time to end time.
Type: Variant (Optional)
Examples: 00:00:00 - default
00:10:00 - 10 minutes
Update Rate
For an updating query the update rate of the data.
Type: Variant (Optional)
The update rate must be in a date/time format.
Examples: 00:00:00 – default (The default setting for the update rate will update when
the values actually change.)
00:10:00 - 10 minutes.
Update Rate Increment
When making an historical replay query the update rate increment parameter is used to
specify in one update rate how far to move on in history. This allows a large amount of
history data to be replayed in a shorter period of time.
Type: Variant (Optional)
The update rate increment must be in a date/time format. The default setting for the
update rate increment will set it to the same as the update rate.
Examples: 00:00:00 – default. (This is taken to be the same as the specified update rate.)
00:10:00 - 10 minutes.
Orientation
Returns data in columns or rows.
Type: Variant (Optional)
Examples: 0 – Vertical (default). (The data is returned in columns.)
1 – Horizontal. (The data is returned in rows.)
All other variables will be regarded as 0 (default).

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 2-17

Data Order
Data values at the top of the column or start of the row may start at either the oldest or most
recent first.
Type: Variant (Optional)
Examples: 0 – Oldest First (default). (The data values at the top of the column or start
of the row are the oldest.)
1 – Most Recent First. (The data values at the top of the column or start of
the row are the most recent for the specified request.)
All other variables will be regarded as 0 (default).
Values Type
If the start of the Aggregation period is not aligned with a timestamp of a value, this setting
determines what timestamp will be used. In either case the previous value will be used. The
choice is between using the actual timestamp of the previous value (Bounding value), or the
timestamp when values was requested and returned (Actual (Edge) value)
Type: Variant (Optional)
Examples: 0 – Include Edge values (default)
1 – Include Bounding values.
Quality Display
Determines the format of the quality display. Can be one of four types.
Type: Variant (Optional)
Examples: 0 - Raw
1- Primary (default)
2 – Secondary
3 – Primary/Secondary
Aggregation
Which type of aggregation is to be used.
Type: Variant (Optional)
Examples: Note: Either the text or numeric values can be used.
2 - Mean
3 – Summation
4 – Maximum
5 – Minimum
6 – Standard Deviation
7 – Spot
8 – On Count
9 – On Time

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

2-18 Chapter 2 Excel Add-in

Partial Aggregation
Determines if Partial Aggregations will be included in results. (See the section about Partial
Aggregations, above.)
Type: Variant (Optional)
Examples: 1 - Include Partial Aggregation
0 - Exclude Partial Aggregation
Summation Time Factor
The period over which to calculate the aggregation regardless of the update rate of the tag.
This parameter is only required if the Aggregation Type is Summation. The format is
YYYY-MM-DD HH:MM:SS (Year-Month-Day Hours:Minutes:Seconds ) Where the time is
less than 1 day this can be shortened to HH:MM:SS.
Type: Variant (Optional)
Example 1: 01:00:00 (1 Hour)
Example 2: 1899-12-30 01: 01:30 (1 Day, 1 Hour and 30 minutes)
Note: The base time, or ‘zero’ time in VB is 1899-12-30 00:00:00. All periods
used for the Summation Time Factor must be added onto this base time.
For example 1 day 3 hours would be 1899-12-31 03:00:00.
State Count
This is used in conjunction with either On Time or On Count. It determines which state is
being measured. The states are user defined.
Type: Variant (Optional)
Examples: The actual values are user defined.
Differential Summation
Determines if Differential Summation will be included in results.
Type: Variant (Optional)
Examples: 1 - Include Differential Summation
0 - Exclude Differential Summation
Summation Reset Value
Summation Reset value is the reset value of the summation counter used in differential
summation. This parameter is only required if the Aggregation Type is Differential
Summation. The value is user defined.
This data can only be used for Differential Summation. For more information, see the
Exaquantum/PIMS User's Manual (IM36J04A11-01E) 7. TagTemplate Aggregation
Calculations and the Exaquantum Engineering Guide Volume 1-
Administration(IM36J04A15-01E) 2.6 Differential Summation Function
Type: Variant (Optional)

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 2-19

Number of decimal places

The number of decimal places to round the differential summation value to. This parameter
is only required if the Aggregation Type is Differential Summation. The value is user
defined.
This data can only be used for Differential Summation. For more information, see the
Exaquantum/PIMS User's Manual (IM36J04A11-01E) 7. TagTemplate Aggregation
Calculations and the Exaquantum Engineering Guide Volume 1-
Administration(IM36J04A15-01E) 2.6 Differential Summation Function
Type: Variant (Optional)
Valid Percent Difference
The percentage value between the last and current values with respect to the summation reset
value. This parameter is only required if the Aggregation Type is Differential Summation.
The value is user defined.
This data can only be used for Differential Summation. For more information, see the
Exaquantum/PIMS User's Manual (IM36J04A11-01E) 7. TagTemplate Aggregation
Calculations and the Exaquantum Engineering Guide Volume 1- Administration
(IM36J04A15-01E) 2.6 Differential Summation Function
Type: Variant (Optional)
Replace QDATA Formulae
Determines if data values or the QDATA formulae are inserted into cells.
Type: Variant (Optional)
Examples: 0 – QDATA (default). (The QDATA formula is inserted into the cell.)
1 – Values. (Data values are inserted into the cells.)
Value Filter
Contains the value filter rules to apply to the data before it is returned. Multiple filter rules
are separated by the logical operator e.g. “&” or “|”
Type: Variant (Optional)
Examples: One filter rule = “>=500”,
Two filter rules = “>=900&<1000”,
Default = “”
NOTE. The Value Filter only applies to raw data (no interval)

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

2-20 Chapter 2 Excel Add-in

Quality Filter
The QData parameter for primary quality filter is a bit mask of the qualities of data to be
returned, with the values specified below.
Type: Variant (Optional)
Examples: 8 – Good
4 - Uncertain
2 - Bad
1 - Assumed
0 – (Default) Filter Not Applied
12 – Good and Uncertain
NOTE. The Quality Filter only applies to raw data (no interval)
Specifying of Parameters
The setting of parameters for the QDATA function can be specified in the standard Excel
manners. Parameters can be literal strings, another Excel function or a cell reference.
For Example:
A function that uses literal strings as parameters.
=QDATA("Root.CDU1.001FC001.PV.Value:Value", “NOW”)
Using another Excel function, where the TODAY() function is used to specify the date and
time for a spot value request.
=QDATA("Root.CDU1.001FC001.PV.Value:Value", =TODAY())
Using another cell reference where the cell A1 contains the date and time for a spot value
request.
=QDATA("Root.CDU1.001FC001.PV.Value:Value", A1)
Specifying Requests for Data
Spot value at a specific point in time
The access string and start time parameters must be specified. If a time in the future is
specified the latest known value will be returned. This will not update.
Examples:
=QDATA("Root.CDU1.001FC001.PV.Value:Value", “01/01/2000
10:00:00”)
=QDATA("Root.CDU1.001FC001.PV.Value:Value", “NOW-10
MINUTES”)

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 2-21

Spot Value, at the time of the request

The access string parameter must be specified.
Note: This combination cannot be dragged and dropped from the data selector. Therefore
it must be typed in.
Example:
=QDATA("Root.CDU1.001FC001.PV.Value:Value")
Live Spot Value
The access string update rate parameters must be specified. The start time parameter is
optional.
Examples:
A live value updating when the value changes. The update rate is set to use the default value.
=QDATA(“Root.CDU1.001FC001.PV.Value","NOW",,,"00:00:00”,
0,0)
A live value updating every 10 seconds.
=QDATA("Root.CDU1.001FC001.PV.Value","NOW",,,"00:00:10”,
0,0)
Spot Value History Replay
The access string, start time, update rate and update rate increment parameters must be
specified.
History replay will not stop updating when the current time is reached, the value will
continue to update and display data into the future.
Example:
For a spot value to update every ten seconds and in that ten seconds move forward one hour.
=QDATA("Root.CDU1.001FC001.PV.Value",
"NOW-24 HOURS",,,“00:00:10",”01:00:00”,0,0)
Historical Trend
The access string, start time, end time and sample period parameters must be specified.
The start time must be before the end time.
Examples:
For a trend between two and one hours ago, returning the values as they are stored in the
Exaquantum/PIMS historian.
=QDATA("Root.CDU1.001FC001.PV.Value",
"NOW-2 HOURS","NOW-1 HOURS","00:00:00",,0,0)
For a trend between two and one hours ago, returning the values at regularly spaced ten
second intervals.
=QDATA("Root.CDU1.001FC001.PV.Value",
"NOW-2 HOURS","NOW-1 HOURS","00:00:10",,0,0)

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

2-22 Chapter 2 Excel Add-in

Live Trend
The access string, start time, end time, sample period and update rate parameters must be specified.
The start time must be before the end time.
The end time must be “NOW” or a report time set to be “NOW” (see using report times).
Example:
For a live trend for the last hour updating every time a value changes.
=QDATA("Root.CDU1.001FC001.PV.Value",
"NOW-1 HOURS ","NOW","00:00:00",”00:00:00”,0,0)
The example specified above will only update the trend data when a new value at the end
time is available. To obtain a live trend that is updated on a regular basis the update rate
parameter must be set to an explicit value (not the default) and the update rate increment
parameter must be specified as the default value (00:00:00). For a live trend for the last hour
to update at a frequency of 10 seconds:
=QDATA("Root.CDU1.001FC001.PV.Value","NOW-1
HOURS","NOW","00:00:00",”00:00:10”,”00:00:00”,0,0)
Trend History Replay
All parameters (access string, start time, end time, sample period, update rate and update rate
increment must be specified).
The start time must be before the end time.
If data update is stopped and restarted then the request will start from the specified start time.
History replay trends will not stop updating when the current time is reached, the trend will
continue to update and display data into the future.
Examples:
For a replay of 1 hour of history data starting 24 hours ago updating every 10 seconds and in
that 10 seconds move on 1 hour in history.
=QDATA("Root.CDU1.001FC001.PV.Value","NOW-24 HOURS
","NOW-23 HOURS","00:00:00",”00:00:10”,”10:00:00”,0,0)
Note: All data requests using the QDATA function will be re-queried when the
spreadsheet is opened. Therefore, if no access is available to the data server, or the
data is not available, no values will be retrieved. For static reports, values should be
copied and pasted as ‘Values Only’ to avoid this.
Returning Data in Rows and Oldest Data First
The example shown below is based on the Live Trend example described previously.
The access string, start time, end time, sample period, update rate, orientation and data order
parameters must be specified.
The start time must be before the end time.
The end time must be “NOW” or a report time set to be “NOW” (see using report times).
The orientation value must be 1 (Horizontal) to return data in rows.
The data order value must be 0 (Oldest First) to return the oldest data first.

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 2-23

Example:
For a live trend for the last hour updating every time a value changes and returning the oldest
data first in rows.
=QDATA("Root.CDU1.001FC001.PV.Value",
"NOW-1 HOURS ","NOW","00:00:00",”00:00:00”,,1,0)
Returning Data in Columns and Most Recent Data First
The example shown below is based on the Live Trend example described previously.
The access string, start time, end time, sample period, update rate, orientation and data order
parameters must be specified.
The start time must be before the end time.
The end time must be “NOW” or a report time set to be “NOW” (see using report times).
The orientation value must be 0 (Vertical) to return data in columns.
The data order value must be 1 (Most Recent First) to return the most recent data first.
Example:
For a live trend for the last hour updating every time a value changes and returning the most
recent data first in columns.
=QDATA("Root.CDU1.001FC001.PV.Value",
"NOW-1 HOURS ","NOW","00:00:00",”00:00:00”,,0,1)
Aggregations
Example:
Hourly Mean Aggregation based upon Raw data for the whole of the period specified.
= QData(“Root.Tag.Value”, “01/01/2004 00:00:00”,
“01/01/2004 01:00:00”, “00:00:00”, , , , , , “2”, , ,)
Example:
Hourly Mean Aggregation based upon Raw data for 1 day.
= QData(“Root.Tag.Value”, “01/01/2004 00:00:00”,
“02/01/2004 00:00:00”, “01:00:00”, , , , , , “2”, , ,)
Example:
Differential Summation Aggregation based upon Raw data for the whole of the period
specified.
=QDATA("Root.SUM.Value:Value","01/01/2005
00:00:00","01/01/2005 01:00:00","12/30/1899
00:00:00",,0,0,0,1,3,0,"12/30/1899
00:01:00","",1,1000000000,2,100)

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

2-24 Chapter 2 Excel Add-in

Filter Examples
The following section contains worked examples of the filter functions.
The data stored in the historian can be retrieved using the following QData function with no
filters applied:
=QDATA("Root.SinTag.Value:Value","2010-05-20 10:30:00","2010-05-20
10:35:00","1899-12-30 00:00:00",,,0,0,0,1,,,,,,,,,0,,0)
And returns the data shown in Figure 2-5. The area of the graph in red represents data with
uncertain quality.
Figure 2-5 Data with no filters applied

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 2-25

Value Filtering
The following examples show the effect of applying various value filters to the example data set.
Example 1
If the following filters are applied

Filter 1 > 100

Filter 2 n/a

The data can be retrieved using the following QData function with the specified filters applied:
=QDATA("Root.SinTag.Value:Value","2010-05-20 10:30:00","2010-05-20
10:35:00","1899-12-30 00:00:00",,,0,0,0,1,,,,,,,,,0,”>100”,0)
And returns the data shown in Figure 2-6, no values below 100 are returned.
Figure 2-6 >100 Filter Applied

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

2-26 Chapter 2 Excel Add-in

Example 2
If the following filters are applied

Filter 1 <= 100

Filter 2 n/a

The data can be retrieved using the following QData function with the specified filters applied:
=QDATA("Root.SinTag.Value:Value","2010-05-20 10:30:00","2010-05-20
10:35:00","1899-12-30 00:00:00",,,0,0,0,1,,,,,,,,,0,”<=100”,0)
And returns the data shown in Figure 2-7, no values above 100 are returned.
Figure 2-7 <= 100 Filter Applied

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 2-27

Example 3
If the following filters are applied

Filter 1 > 50

Filter 2 <= 150

Logical Filter1 AND Filter2

Operator

The data can be retrieved using the following QData function with the specified filters
applied:
=QDATA("Root.SinTag.Value:Value","2010-05-20 10:30:00","2010-05-20
10:35:00","1899-12-30 00:00:00",,,0,0,0,1,,,,,,,,,0,”>50&<=150”,0)
And returns the data shown in Figure 2-8, only values between 50 and 150 are returned.
Figure 2-8 >50 & <=150 Filters Applied

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

2-28 Chapter 2 Excel Add-in

Example 4
If the following rules are applied

Rule 1 < 50

Rule 2 >= 150

Logical Filter1 OR Filter2

Operator

The data can be retrieved using the following QData function with the specified filters
applied:
=QDATA("Root.SinTag.Value:Value","2010-05-20 10:30:00","2010-05-20
10:35:00","1899-12-30 00:00:00",,,0,0,0,1,,,,,,,,,0,”<50|>=150”,0)
And returns the data shown in Figure 2-9, only values less than 50 and greater 150 are
returned.
Figure 2-9 <50 | >=150 Filters Applied

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 2-29

Quality Filtering
The following example shows the effect of applying quality filters to the example data set.
Example 1
If the following quality rules are applied

Quality Checked

Good Yes

Uncertain No

Bad No

Assumed No

The data can be retrieved using the following QData function with the specified filters
applied:
=QDATA("Root.SinTag.Value:Value","2010-05-20 10:30:00","2010-05-20
10:35:00","1899-12-30 00:00:00",,,0,0,0,1,,,,,,,,,0,,8)
And returns the data shown in Figure 2-10 , none of the uncertain quality values are returned.
Figure 2-10 Quality Filter Applied

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

2-30 Chapter 2 Excel Add-in

Combined Filtering
The following example shows the effect of applying both quality filters and value filters to
the example data set.
Example 1
If the following rules are applied

Rule 1 <= 150

Rule 2 n/a

Quality Checked

Good Yes

Uncertain No

Bad No

Assumed No

The data can be retrieved using the following QData function with the specified filters applied:
=QDATA("Root.SinTag.Value:Value","2010-05-20 10:30:00","2010-05-20
10:35:00","1899-12-30 00:00:00",,,0,0,0,1,,,,,,,,,0,”<=150”,8)
And returns the data shown in Figure 2-11, none of the uncertain quality values are returned
and no data values above 150 are returned.
Figure 2-11 Quality and Value Filters Applied

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 2-31

2.8 Setting of Report Times

Report times can be used in an Excel spreadsheet as in Exaquantum/Explorer. Global report
times are not avaliable in the Excel Add-In. Report times are set up and saved on a per
workbook basis.
The Start Time and End Time parameters in the QDATA function can be set to use report
times, for Example “REPORTSTART”, “REPORTEND”, “SPOTTIME”,
“REPORTSTART- 10 MINUTES, etc.

To set the report times for a workbook, click on the button. The Set Report Times
window will be displayed.
Figure 2-12 Set Report Times Dialog

For more information, see the Exaquantum/Explorer User's Manual Volume 1 – General
Information (IM 36J04A12-01E).
On setting data requests that use report times will be automatically updated. Columns of
trend data can shrink and grow depending on the time criteria and so could overwrite other
data in the same column. The example in Figure 2-6 illustrates how report times can be used.
Figure 2-13 Using Report Times
=QDATA(“Root.Tag1.Value:Value”, “REPORTSTART”, “REPORTEND”, “01:00:00”)

1. Initial setting of Report and Report

End to 2000-01-01 10:00:00 and 2000-
01-01 19:00:00 respectively

2000-01-01 10:00:00 10.00 2000-01-01 10:00:00 10.00

2000-01-01 11:00:00 20.00 2000-01-01 11:00:00 20.00

2000-01-01 12:00:00 30.00 2000-01-01 12:00:00 30.00

2000-01-01 13:00:00 40.00 2000-01-01 13:00:00 40.00

2000-01-01 14:00:00 50.00 2000-01-01 14:00:00 50.00

2000-01-01 15:00:00 60.00 2000-01-01 15:00:00 60.00

2. Set Report and Report End to
2000-01-01 16:00:00 70.00 2000-01-01 10:00:00 and 2000- 2000-01-01 16:00:00 70.00
01-01 16:00:00 respectively
2000-01-01 17:00:00 80.00

2000-01-01 18:00:00 90.00

2000-01-01 19:00:00 100.00

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

2-32 Chapter 2 Excel Add-in

Stopping and Starting Data Fetch and Update

Fetching and updating of data from Exaquantum can be started and stopped as desired.
When configuring a spreadsheet using Exaquantum data, it is advisable to stop data update
(as cutting and pasting becomes difficult) if large amounts of data is being retrieved or data
is being updated at a frequent rate.

♦ Data fetch and update from Exaquantum can be started by clicking on the button.

♦ Data fetch and update from Exaquantum can be stopped by clicking on the button.
Connecting To Exaquantum
When a spreadsheet is opened in Microsoft Excel that contains requests for Exaquantum data
it will automatically try to connect to the Exaquantum server. If a connection is establish to
“Connect to Exaquantum” toolbar and menu button will not be visible. It for any reason a
connection cannot be made, for example a network connection could not be established the
button will become visible. This button will also be made visible if the Exaquantum
server is shutdown or the network connection is lost while a spreadsheet is running.
Updating requests made to the server before the connection was lost will stop updating and
any new requests made, for example dragging from the data selector will display
“#CONNECT!”.
Click on the “Connect to Exaquantum” button to re-establish a connection to the server. If
the server and network are ok then the connection will be made else and error message will
be displayed. In the case where the network cannot be established Excel will lock up for a
period approximately 5 to 6 minutes after which the connection request will time out.

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 2-33

2.9 Sample Program for Getting and Saving Excel Data

The program shows how to retrieve and save Exaquantum data using the QDATA function
available in the Exaquantum Excel Add-In into a new Excel file. All data retrieved using the
QDATA function will be updated when the sample program is run. The retrieved data will
be saved in a new Excel file in a temporary directory.
The sample program resides in the following directory.
<Exaquantum Installation folder>\Documentation\SampleCode\ExcelAddIn\GetAndSave

To use the sample program a supported release of Microsoft Excel must be installed on the
machine where the program will be executed.
Operating Procedure
To use the sample program follow the steps below:
1 Copy the sample application to a new folder.
2 Save any Excel files to be updated using the program to the folder specified in step 1. At
least one Excel file is required for the application to work.
3 Launching the program, GetAndSave.exe, will create a sub-folder named “results”. The
newly created Excel files containing the updated Exaquantum data will be saved to this
folder.
Figure 2-14 Getting and Saving Excel Data

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

2-34 Chapter 2 Excel Add-in

This page intentionally left blank

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 3-1

Chapter 3 Exaquantum Excel Report Templates

3.1 Report Templates
The report templates provide a pre-defined set of reports that can be easily configured to
meet the many reporting requirements in a process plant. The templates are in the form of
Excel worksheet templates (.xltx files). The report templates supplied include:
♦ Basic reports that simply take a ‘snapshot’ of the desired values and present them as
Excel spreadsheets
♦ Valuable end-of-production-period summary reports that present pertinent information
such as the average values during the period, totalized (sum) values, and minimum and
maximum values/times
♦ Reports that provide graphical views of production trends over the day (e.g. the twenty-
four hour averages of selected tags for the day).
The templates are intended to be both a quick-start into meaningful reporting, as well as a
starting point for engineers and end-users to create their own special, customized reports.
There are a total of 11 report templates.
Snapshot Report.xlt Daily Report(graph).xlt
Snapshot Report (Detail).xlt Weekly Report.xlt
Hourly Report.xlt Weekly Report(graph).xlt
Shift Report.xlt Monthly Report.xlt
Daily Report.xlt Yearly Report.xlt.
Daily Report (column).xlt
Note: The report templates use the Exaquantum/Explorer Excel Add-In therefore the Add-
In must be installed.
A description of each report is given in 3.2 Installing Report Template.

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

3-2 Chapter 3 Exaquantum Excel Report Templates

3.2 Installing Report Template

The following procedure defines how to locate the report templates correctly from the
Exaquantum Installation folder. NOTE, if the "Templates" folder does not exist, create the
folder.
• Copy Source:
<Exaquantum installation folder>\Exaquantum PIMS\Explorer\CS1000 Reports
Right-click on the "CS1000 Reports" folder, from the pop-up menu, select Copy.
• Copy Destination:
<OS installation drive>:\Users\<logon user folder>\AppData\Roaming\Microsoft\Templates
Open the "Templates" folder, Right-click in the "Templates" folder, from the pop-up menu
select Paste.

Note that in Excel the Report Templates won’t automatically appear as Personal templates
on the New page (File > New), unless you make that folder your default personal templates
location.

To set the default templates location, click Options on the File tab. On the Save tab, in the
Default personal templates location box, enter the path to the templates folder you created.

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 3-3

Now all report templates automatically appear under Personal on the New page (File > New).

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

3-4 Chapter 3 Exaquantum Excel Report Templates

3.3 Report Template Detail

Snapshot Report.xltx
This report is a summary of a number of tags and their values for a specified spot time.
An example of a Snapshot Report is shown in Figure 3-1.
Figure 3-1 Snapshot Report
Date: 05-Jan-99
Time: 0:12:0

21FI102B 21FIC110 21TIC207

49.58 43.31 13.5
21FC113 21AI112 22PIC204
247.9 3.891 115.3

Snapshot Report (Detail).xlt

This report displays the Description, Units and Value for a set of tags for a specified spot
time. When the tag name is entered in the Name cell, the Description, Units and Value fields
are completed automatically.
An example of a Snapshot Report (Detail) is shown in Figure 3-2.
Figure 3-2 Snapshot Report Detail
Date: 05-Jan-99
Time: 0:12:00

Name 21FI102B 21FIC110

Description NET FEED GAS AIR TO 21R101

TO 21H101

Units kg/h kg/h

Value 45.58 43.00

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 3-5

Hourly Report.xltx
This report displays summary information for a number of tags for an hourly period. It is
initially set up to use tags that have an “Hour” aggregation period.
Definitions for some of the terms used are:
♦ Value - the value at the specified spot time
♦ Maximum and Minimum - refer to peak spot values
♦ Time(Max) and Time(Min) - the time that the maximum and minimum spot values
occurred.
An example of an Hourly Report is shown in Figure 3-3.
Figure 3-3 Hourly Report
Date: 11-Feb-99
Time: 16:00:00

Tag Name 21FIC140 21FIC102

Description PS TO 21H101 AIR/FG RATIO
START-UP CONTROL
Units kg/h kg/h
Value 34.5 202.1
Mean 33.4 196
Sum 33.4 199.2
Maximum 35.7 209.3
Minimum 31.1 189.2
Time (max) 15:35:09 15:55:34
Time (min) 15:12:55 15:55:12

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

3-6 Chapter 3 Exaquantum Excel Report Templates

Shift Report.xltx
This report displays summary information for a number of tags for a shift period. The shift
period in this report is eight hours. It is initially set up to use tags that have a “Shift”
aggregation period.
The values shown against each hour are the ‘means’ for that hour.
Definitions for some of the terms used are:
♦ Mean - the average of all the shift aggregations
♦ Maximum and Minimum - refer to peak spot values
♦ Time(Max) and Time(Min) - the time that the maximum and minimum spot values
occurred.
An example of a Shift Report is shown in Figure 3-4.
Figure 3-4 Shift Report
Date: 11-Feb-99
Time: 16:00:00

Tag Name 21FIC140 21FIC102

Description PS TO 21H101 AIR/FG RATIO
START-UP CONTROL
Units kg/h kg/h
09:00
10:00
11:00
12:00
13:00
14:00
15:00
16:00
Mean 33.1 196.6
Sum
Maximum
Minimum
Time (max)
Time (min)

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 3-7

Daily Report.xltx
This report displays summary information for a number of tags for a twelve-hour period. It
is initially set up to use tags that have a “Day” aggregation period.
An example of a Daily Report is shown in Figure 3-5.
Figure 3-5 Daily Report
Date: 12-Feb-99
Time: 08:00:00

Tag Name 21FIC140 21FIC102

Description PS TO 21H101 AIR/FG RATIO
START-UP CONTROL
Units kg/h kg/h
17:00
18:00
19:00
20:00
21:00
22:00
23:00
24:00
01:00
02:00
Mean 33.1 196.6
Maximum
Minimum
Time (max)
Time (min)

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

3-8 Chapter 3 Exaquantum Excel Report Templates

Daily Report (column).xltx

This report displays summary information for a number of tags for a twenty four hour period.
It is initially set up to use tags that have a “Day” aggregation period.
An example of a Daily Report (column) is shown in Figure 3-6.
Figure 3-6 Daily Report (Column)

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 3-9

Daily Report (graph).xltx

This report displays summary information for a number of tags for a twenty four hour period.
It is initially set up to use tags that have a “Day” aggregation period.
This report is identical in format to that of the Daily Report with the addition of a trend of
the specified tags for the twenty four hour period.
An example of part of a Daily Report (graph) is shown in Figure 3-7.
Figure 3-7 Graph Section of DailyReport(graph)

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

3-10 Chapter 3 Exaquantum Excel Report Templates

Weekly Report.xltx
This report displays summary information for a number of tags for a seven day period. It is
initially set up to use tags that have a “Day” aggregation period.
An example of a Weekly Report is shown in Figure 3-8.
Figure 3-8 Weekly Report

Name FHTag1
Description Desc. for
FHTag1
Units units
May 1, 1999
May 2, 1999
May 3, 1999
May 4, 1999
May 5, 1999
May 6, 1999
May 7, 1999
Mean 33.4
Sum 33.4
Maximum 35.7
Minimum 31.1
Time (max) 15:35:09
Time (min) 15:12:55

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 3-11

Weekly Report(graph).xltx
This report displays summary information for a number of tags for a seven day period. It is
initially set up to use tags that have a “Day” aggregation period.
This report is identical in format to that of the Weekly Report with the addition of a pie
indicating the breakdown of daily values for a selected tag.
This example shows the sum of each daily aggregation in the week.
An example of part of a Weekly Report (graph) is shown in Figure 3-9.
Figure 3-9 Graph Section of Weekly Report(graph)

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

3-12 Chapter 3 Exaquantum Excel Report Templates

Monthly Report.xltx
This report contains standard details and statistical information for a period of one month. It
can only be used with tags that have a “Day” aggregation period. An example of a Monthly
Report is shown in Figure 3-10.
Figure 3-10 Monthly Report

Name FHTag1 abc

Description Desc. for Desc. for
FHTag1 abc
Units units
5/1/99
5/2/99
…..
5/29/99
5/30/99
5/31/99
Mean 33.4
Sum 33.4
Maximum 35.7
Minimum 31.1
Time 15:35:09
(max)
Time (min) 15:12:55

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

Exaquantum/Explorer User’s Manual – Volume 3 Microsoft Excel Reports 3-13

Yearly Report.xltx
This report contains standard details and statistical information for a period of one year. It
can only be used with tags that have a defined a “Day” aggregation period.
Due to the limitation of the Exaquantum server not to support aggregation periods longer
than twenty four hours the monthly daily means for each tag are retrieved and calculated
within the spreadsheet itself.
An example of a Yearly Report is shown in Figure 3-11.
Figure 3-11 Yearly Report

Name FHTag1
Description Desc. for
FHTag1
Units units
January 98
February 98
March 98
April 98
May 98
June 98
July 98
August 98
September 98
October 98
November 98
December 98
Mean
Sum
Maximum
Minimum

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021

3-14 Chapter 3 Exaquantum Excel Report Templates

3.4 Produce a Report

To produce a report you first need to access the report templates, set the report date and time,
and finally configure the report template. This process is described in the following sections.
Note: After defining a tag, when you open a report template, it may take some time until
the values are displayed correctly. After confirming that the values have displayed
correctly, close the screen.
Access The Report Templates
1 Open Microsoft Excel.
2 In the File menu select New.
3 In the Personal Templates CS1000 Reports tab, select one of the report templates.
Set the Report Date and Time
To set the report start date and time:
1 Open the required report.
2 In the report, click on the date/time cell.

3 Type the report start date and time.

Configure Report Templates
1 Drag the tag name from the Data Selector tree and drop it into the ‘Name’ cell.
Note: The report sets up the other data references. Once the ‘source’ tag name is known,
the report (using the Exaquantum Excel Add-In) requests the appropriate data from
the Exaquantum server. The associated data fields (description, engineering units,
aggregation types,) are then automatically filled in.

IM 36J04A12-03E 22nd Edition Issue 1 January 12th 2021