Proficy Historian 50 Excel Add in

Proficy* Historian
EXCEL ADD-IN
Version 5.0
October 2012
All rights reserved. No part of this publication may be reproduced in any form or by any electronic or mechanical means, including photocopying
and recording, without permission in writing from GE Intelligent Platforms, Inc..
Disclaimer of Warranties and Liability
The information contained in this manual is believed to be accurate and reliable. However, GE Intelligent Platforms, Inc. assumes no
responsibilities for any errors, omissions or inaccuracies whatsoever. Without limiting the foregoing, GE Intelligent Platforms, Inc. disclaims any
and all warranties, expressed or implied, including the warranty of merchantability and fitness for a particular purpose, with respect to the
information contained in this manual and the equipment or software described herein. The entire risk as to the quality and performance of such
information, equipment and software, is upon the buyer or user. GE Intelligent Platforms, Inc. shall not be liable for any damages, including
special or consequential damages, arising out of the use of such information, equipment and software, even if GE Intelligent Platforms, Inc. has
been advised in advance of the possibility of such damages. The use of the information contained in the manual and the software described herein
is subject to GE Intelligent Platforms, Inc. standard license agreement, which must be executed by the buyer or user before the use of such
information, equipment or software.
Trademarks
2012 GE Intelligent Platforms, Inc. All rights reserved. * Trademark of GE Intelligent Platforms, Inc. All other brands or names are property of
their respective holders. Any other trademarks referenced herein are used solely for purposes of identifying compatibility with the products of GE
Intelligent Platforms, Inc.
Notice
GE Intelligent Platforms, Inc. reserves the right to make improvements to the products described in this publication at any time and without
notice. We want to hear from you. If you have any comments, questions, or suggestions about our documentation, send them to the following
email address:
doc@ge.com
Table of Contents
Using the Historian Excel Add-In ..................................................................................................... 1
Reference Documents ................................................................................................................. 1
Understanding the Historian Excel Add-In ....................................................................................... 2
Understanding Excel Add-In Conventions ................................................................................... 2
Installing The Excel Add-in with Historian .................................................................................... 4
Using the Historian Excel Add-In ..................................................................................................... 7
Selecting Options ......................................................................................................................... 7
Searching Tags ............................................................................................................................ 9
Querying Alarm and Event Data ................................................................................................ 10
Querying Current Values............................................................................................................ 10
Querying Raw Data .................................................................................................................... 12
Querying Filtered Data ............................................................................................................... 13
Examples................................................................................................................................ 17
Querying Calculated Data .......................................................................................................... 18
Exporting Tags ........................................................................................................................... 20
Importing Tags ........................................................................................................................... 22
Exporting Enumerated Sets ....................................................................................................... 23
Importing Enumerated Sets ....................................................................................................... 24
Working with Enumerated Sets .................................................................................................. 24
Adding New Tags or Modifying Tag Parameters ....................................................................... 26
Deleting Tags ............................................................................................................................. 26
Exporting Data ........................................................................................................................... 26
Importing Data ............................................................................................................................ 28
Searching Messages.................................................................................................................. 28
Exporting Messages................................................................................................................... 29
iii
Proficy Historian Excel Add-In
Importing Messages ................................................................................................................... 30
Listing Archives .......................................................................................................................... 30
Listing Collectors ........................................................................................................................ 31
Working with Alarm and Event Data .......................................................................................... 32
Defining Reports ............................................................................................................................ 33
Building Dynamic Reports .......................................................................................................... 33
Sharing Excel Reports ............................................................................................................... 33
Using the Sample Reports ......................................................................................................... 33
Sample Report 1 Historian Statistical Analysis ................................................................. 34
Sample Report 2 Daily Report ........................................................................................... 36
Sample Report 3 Batch Report ......................................................................................... 39
Troubleshooting the Excel Add-In Sample Reports ................................................................... 41
Running a Report Using Visual Basic ........................................................................................ 42
Array Formulas for the Historian Excel Add-In........................................................................... 43
Description of Array Formula Parameters.............................................................................. 43
Editing an Array Formula in Microsoft Excel .......................................................................... 47
Troubleshooting the Excel Add-In .................................................................................................. 49
Troubleshooting General Imports .............................................................................................. 49
Troubleshooting Tag Imports ..................................................................................................... 49
iv
Using the Historian Excel Add-In
The Using the Historian Excel Add-In manual is intended for process control engineers, integrators, and
developers responsible for creating and maintaining Historian reports in Excel.
This manual provides descriptive material and specific operating procedures for performing all common tasks.
Reference Documents
For related information about Historian, refer to the following documents:
Getting Started with Historian

Using the Historian Administrator
Historian Data Collectors
Historian Alarms and Events
Migrating Advanced and Classic Historian Data
Using the Historian OLE DB Provider
Historian Software Development Kit (SDK) Online Help System
1
Understanding the Historian Excel Add-In

The Historian Excel Add-In greatly expands the power and benefits of using the Historian data archiving and
retrieval system. Using the Add-In, you can:
Retrieve selected data from any archive file.

Display it in a customized report.
Present the data in any of 12 standard chart formats.
Calculate derived variables from raw data values.
Perform mathematical functions to smooth or characterize data.
Import, export, and modify tags, data, and messages all with familiar Excel commands, macros, and
computational techniques.
Create dynamic reports that you can share among users.
A major benefit of using the Excel Add-In is the ability to add tags to Historian by generating a tag worksheet
using the standard Excel tools, editing the parameters, and then bulk importing the information directly into
Historian. Using similar techniques, you can export tag parameters to Excel, make bulk changes, and then
import the changes back into Historian in a simple, straightforward procedure.
Understanding Excel Add-In Conventions

The Excel Add-In uses several conventions in its dialog boxes. These conventions are important to take full
advantage of the features of the Historian Excel Add-In.
The selection of tags, times, and events should always be via cell references. Try not to type these
items directly into dialog boxes. Rather, select them in the worksheet.
Many dialog boxes support selecting multiple statistics or attributes. You can select multiple items in a
list using one of the following methods:
Dragging the mouse over multiple items.
Pressing the Shift key and clicking the ends of a contiguous range.
Pressing the Control key and clicking multiple individual items.
2
Defining Reports
Specifying an Output Cell is always optional. If you do not specify an output cell, the active cell is
used as the starting point for output. When you specify an output cell, that cell is used as the starting
point for output. If you select a range for an output cell, the top left cell in the range is used as the
starting point for output.
Specifying an Output Range determines how many data points are retrieved from a given query. It is
important for these functions to specify whether data points should be sorted in ascending or
descending order by selecting the appropriate option.
Ensure when you are specifying an Output Range or an Output Cell that the active cells are not the
same cells that you specified with tag name cell references. This will lead to circular cell referencing
and incorrect values.
Specifying data retrieval into Rows or Cols determines how multiple attributes or statistics are
displayed in the worksheet.
Specifying data retrieval into Rows or Cols only applies when the dialog box inserts a single function
into the worksheet. When you select a multi-cell output range, the orientation of that range determines
whether the requested data is returned into rows or columns.
Microsoft Excel imposes a 255 character limit on their formulas. If you attempt to create a formula
with more than 255 characters, you will receive an error message.
Excel does not support the use of the right and left arrow keys of the keyboard to move between
characters in text boxes and fields in the dialog boxes.
The maximum number of columns allowed in an Excel worksheet is 255. For example, if you are
trying to display a recordset returned from the Search Tags query that returns more than 255 records,
the query will not return any data.
The maximum number of rows returned by the Excel Add-In is 32,767.
If no parameters in an Excel formula change, the formula does not recalculate unless you edit (press
F2) the formula and force a change. For example, if you change a Hi Scale value from 100 to 50 and
then import a tag, the Hi Scale field will display 100 when looking at the tag information.
When retrieving data in the Excel Add-In, be sure to leave at least one blank line at the top of the
output display for the column header labels. If you do not, the header labels will not show.
In several of the fields, an underscore appears at the right side of the field. If you click the underscore,
the dialog box instantly changes to a minimized display. You can return to the original display by
clicking the box again. The purpose of this feature is to permit you immediately to see an unobstructed
view of your worksheet or other windows as you work your way through the dialog box and to allow
you to select a cell or range of cells in the worksheet.
3
Installing The Excel Add-in with Historian

Before you install the Excel Add-In with Historian, verify that Microsoft Excel is already installed on your
computer. Microsoft Excel is a prerequisite for the Add-In the Add-In will not function without it.
You install the Excel Add-In package as one of the standard installation options from the Historian Install DVD.
Run the Install DVD on the computer on which you want to use the Excel Add-In and select the Excel Add-In
option at the prompt. Refer to the Getting Started with Historian for the complete installation procedure. You
can also install the Excel Add-In by installing the Client tools on a machine that doesn't have the Historian
Administrator or archive installed.
After you install the Excel Add-In, use the following procedure to activate the Add-In:
For Microsoft Excel 2003:
1. Open a new worksheet, select Add-Ins from the Tools menu. The Add-Ins dialog box, shown in the
following figure, appears.
Excel Add-Ins Dialog Box
2. Select Historian Add-In and click OK.

The Add-In is now ready to use and the Historian menu is now available in the Excel Toolbar.
4
Defining Reports
For Microsoft Excel 2007:
1. Open a new Excel 2007 worksheet.
2. Click the Microsoft Office Button , and then click Excel Options.
3. Click the Add-Ins category.
4. In the Manage box, click Excel Add-ins, and then click Go. The Add-Ins dialog box, shown in the
following figure, appears.
5. Select Historian Add-In from the Add-Ins available box and click OK.
The Add-In is now ready to use and the Historian menu is now available in the Excel 2007 Toolbar
For Microsoft Excel 2010 (32-bit/64-bit):
1. Open a new Excel 2010 worksheet.

2. Click the File tab, click Options, and then click the Add-Ins category.
3. Click the Add-Ins category.
5
4. In the Manage box, click Excel Add-ins, and then click Go. The Add-Ins dialog box appears.
.
5. Select Historian Add-In from the Add-Ins available box and click OK.
The Add-In is now ready to use and the Historian menu is now available in the Excel 2010 Toolbar
TIP: If the Historian Add-In is not listed, click the Browse button to locate the Historian.xla file.
NOTE: If you install the Excel Add-In prior to installing Excel, the install program copies the Historian.xla file
to your Historian folder (typically C:\Program Files\Proficy\Proficy Historian). If you decide to add the Excel
Add-In after installing Excel, open Excel, select Add-Ins from the Tools menu, and click Browse to locate the
Historian.xla file.
If you uninstall Historian after installing the Excel Add-In as described, ensure that you clear the Historian
check box in the Excel Add-Ins dialog. If you do not clear this option, you will receive an error each time you
open Excel.
6
Defining Reports
Using the Historian Excel Add-In

This chapter describes recommended procedures for setting up the Excel Add-In and using the various options
and commands. Refer to the following for more information:
Selecting Options
Searching Tags
Querying Current Values
Querying Raw Data
Querying Calculated Data
Querying Filtered Data
Exporting Tags
Importing Tags
Adding New Tags or Modifying Tag Parameters
Deleting Tags
Exporting Data
Importing Data
Searching Messages
Exporting Messages
Importing Messages
Listing Archives
Listing Collectors
Working with Alarm and Event Data
Selecting Options
To select options for running the Excel Add-In, select Options from the Historian menu. The Historian Excel
Add-In dialog box appears. This dialog box allows you to select several options for running the Add-In. The
choices and the effects of each are listed in the following table.
7
Field Description
Internal vs. External Choosing Use External References allows your application to reference cells
References in other worksheets and workbooks in addition to the current one. If you
choose Use Internal References instead, you can only access cells in the
current worksheet. The default setting is Use External References.
Automatically Update Add-In functions are maintained as worksheet links. If users who share
Links to Add-In worksheets do not have Microsoft Office installed the same way, it is
(Yes/No) necessary to turn this feature on. When on, this feature automatically re-
establishes any formula links that may be broken due to differences among
users in Microsoft Office installation. The default setting enables this feature.
The Auto Update feature allows sharing of worksheets. You must, however,
install the Excel Add-In in the exact same Microsoft Office Library Path as
the other worksheets if you want to use the sharing feature.
When opening a worksheet with links to another worksheet, you may receive
a message prompting you to update all linked information in the workbook
(Yes) or keep the existing information (No). It is recommended that you select
No and keep the existing information. The links will be automatically updated
for your worksheet. Save your worksheet after the links have been updated.
Show/Hide Header This option lets you display or suppress the column header labels that are
Labels automatically placed in the worksheet when entering formulas throughout the
Historian Dialogs. The default setting is Show Labels.
Color Allows you to select the header name color from the drop-down list: black,
blue, red, green, magenta, cyan, or yellow.
Assign Default Server This dialog box shows the current server assignment. You can modify the
setting by clicking the Edit button and accessing the Historian Server
Managers dialog box. This dialog box allows you to save user connection
information, add or connect to a new server, delete a server, and modify the
default server.
8
Defining Reports
Adjust Column Widths This option lets you automatically adjust the width of columns in your
worksheet as formulas are inserted by Historian dialogs. Click Adjust Header
Column Width to modify the width of header labels; click Adjust Data
Column Width to modify the data column widths to accommodate the data
values. Enabling these options usually makes the worksheet much more
readable. However, doing so can sometimes make the worksheet calculate too
much when building a large report. In such cases, disable the automatic
feature and adjust individual columns manually.
Save/Default/Cancel These action buttons let you apply your choices of options. Click Save to
apply the settings you entered, click Default to select default settings for all
options, and click Cancel to close the dialog box.
Searching Tags
The Search Tags command lets you scan the tags on a specified server and then to perform actions on one or
more tags you select from that group. When you select the Search Tags command in the Historian menu, the
Historian Tag Search dialog box appears.
To search for tags:
1. Select Search Tags from the Historian menu. The Historian Tag Search dialog box appears.
2. In the Server field, select a server from the drop-down list. To add or connect to a new server click
the Browse button (...). If you do not specify a server, the Add-In searches the default server. To set
the selected server as default, ensure the Set Server to Default option is enabled.
3. Click the Search button. The Historian Tag Search dialog box is populated with a tag list.
4. Select Tags from the Search List:
a. Click a specific tagname to select it in the populated Historian Search Tags dialog box. To
select multiple individual tags, press the Control key and click the tagnames. To select a
sequence of tags, press the Shift key and click the first and last tagname of the sequence.
b. When you have selected the tags you want, click the right arrow (>) button in the center of
the screen. This moves the selected tags to the right hand window. The selected tags are the
tags for which the query obtains and displays data. If you click the double right (>>) arrow
instead of the single right arrow, you select and move all tags to the right hand window.
c. If you change your mind about a tag, you can deselect it by clicking on the tagname to
highlight it and then clicking the left arrow (<) button. This moves the tag back to the left
9
hand window, removing it from the list of selected tags. Similarly, you can deselect all tags,
by clicking the double left (<<) arrow.
d. The Search Display section lets you choose whether you want to display tagnames or tag
description. It also displays the number of tags returned. Select the display option you prefer.
e. The Output With section lets you choose whether the output presentation shows the names
of the selected tags or the cell computation formulas. Select the option you prefer.
NOTE: Using Output with Formula places a dynamic formula in the worksheet, versus just a
copy of the tagnames currently selected. Having a dynamic formula allows the list of tags
returned to be dynamic based on the tag mask criteria supplied. This is particularly useful
when selecting a cell reference for the tag mask as opposed to typing in a tag mask directly in
the dialog.
f. The Output Range field determines where in the worksheet the output data displays. Click
in the Output Range field and select a range of cells in a single row or column in the
worksheet. In most cases, you should choose Columns for a typical report. Selecting the
Rows option rotates the report presentation 90 degrees.
g. The Output Display section lets you select the type of data to be displayed. Select a name to
choose a single parameter for display. To select multiple individual parameters, press the
Control key and click the parameters. To select a sequence of parameters, press the Shift key
and click the first and last parameter of the sequence.
h. When you have selected all desired options, click OK to apply your choices and initiate the
query. Click Cancel to close the dialog box.
Querying Alarm and Event Data

For more information about querying alarm and event data in the Historian Excel Add-In, refer to the following
topics:
Alarms and Events and the Excel Add-in

Creating Alarms and Events Queries in the Excel Add-In
Querying Current Values

Querying Current Values retrieves the most recently updated value of one or more Tags or process variables.
NOTE: If you attempt to perform a Query Current Value with two worksheets open, the Excel Add-In
may become unstable and lock up. This is a known Microsoft Excel issue. To avoid locking up Excel
10
Defining Reports
while performing queries with the Excel Add-In, work with only one Excel document at a time.
To perform a Query Current Values operation:
1. Select Query Current Values from the Historian menu. The Historian Current Value Query dialog
box appears.
2. Select a server from the drop-down list. If you do not specify a server, the Add-In queries the default
server. To set the selected server as default, ensure the Set Server to Default option is enabled.
3. Select a tag on your worksheet and, while it is selected, click in the Tag Name field of the dialog box.
This enters the tagname for you automatically.
NOTE: Do not use wildcards in this field. The Query Current Value feature returns a single value for
a single tag at each query. If you attempt to use a wildcard in the Tag Name field, you will only get a
return value for the first tag.
4. In the Query Criteria String, enter the query criteria along with the # symbol.
For example, if the query criteria string is to retrieve only good data quality values, then you should
specify #ONLYGOOD as the Query Criteria String. For more information, refer to Query Modifiers
topic
5. In the Output Display field, select one or more parameters for the output. To select multiple
individual tags, press the Control key and click the tagnames. To select a sequence of tags, press the
Shift key and click the first and last tagname of the sequence.
6. Click in the Output Cell field and then click a cell in the worksheet to define the upper left corner of
the display. Be sure to leave at least one blank line at the top of the output display for the column
header labels. If you do not, the header labels will not show.
7. Select either Columns or Rows for the output display. Selecting Columns displays a table of values
with parameters arranged in columns with header labels at the top. Selecting Rows rotates the table 90
degrees.
NOTE: When selecting multiple tags, the orientation of the return data is based on the orientation of
the selected tags and the Row/Col selection is ignored.
8. Click OK to initiate the query. Click Cancel to abort the operation and close the dialog.
11
Querying Raw Data

Raw data values are the values actually stored in the archive, after applying collector and archive compression,
but before applying any interpolation, smoothing, or other signal processing calculations. Querying Raw Data
retrieves these values for selected tags.
The Raw Data Query returns a number of data points based on the number of rows or columns specified in the
output range. If you are not viewing all your data points, select enough rows or columns to display all the data.
To perform a raw data query:
1. Select Query Raw Data from the Historian menu. The Historian Raw Data Query dialog box appears.
3. Select a tag on your worksheet and, while it is selected, click in the Tag Name field of the dialog box.
This enters the tagname for you automatically.
NOTE: The selection of tags should always be via cell references. Try not to type them directly into the
dialog box. Rather, select them in the worksheet.
4. In the Query Type section, select the type of data search from three options:
By Time - Selecting the By Time option means that you search for data values between a start
time and an end time. You must enter values for starting and ending times in the fields
displayed at the right of the option.
By Number Forward - Selecting the By Number Forward means searching for a number of
values after a specified time. Enter values into the After Time and Number of Values fields.
By Number Backward - Selecting the By Number Backward means searching for a number
of values before a specified time. The display changes from start and end times to Values
Before Time and Number of Values. Enter appropriate parameters in these fields.
topic.
6. In the Output Display field, select one or more parameters for the output. To select multiple individual
tags, press the Control key and click the tagnames. To select a sequence of tags, press the Shift key
and click the first and last tagname of the sequence.
7. Click in the Output Range field and select a range of cells in a single row or column to determine
where the returned data is placed.
12
Defining Reports
degrees.
9. Select either Ascending or Descending to set the order of the retrieved data in either ascending or
descending order.
NOTE: The Raw Data Query returns a number of data points based on the number of rows or columns
specified in the output range. If you are not viewing all your data points, select enough rows or columns
to display all the data.
Querying Filtered Data

The Query Filtered Data function is similar to the calculated data query, with the addition of a search filter on
the data. The Search Filter allows you to filter the actual data retrieved with a filter condition. This is useful
when trying to retrieve all data for a specific Batch ID, Lot Number, or Product Code and for filtering data
where certain limits were exceeded, such as all data where this temperature exceeded a certain value.
NOTE: Do not use the Desc option for the Output Range in the Filtered Data Query dialog box. Using this
option may cause the Excel Add-In to become unstable. If you use this option and find that Excel is unstable, try
minimizing the Excel application window, expose the Filtered Data Query dialog box, and close the dialog box.
Excel should then function normally.
To perform a filtered data query:
1. Select Query Filtered Data from the Historian menu. The Historian Filtered Data Query dialog box
appears.
2. Select a server from the drop-down list. If you do not specify a server, the Add-In automatically uses
the default server. To set the selected server as default, ensure the Set Server to Default option is
enabled.
3. Select a tag or group of tags on your worksheet and, while they are selected, click in the Tag Name
field of the dialog box. This enters the tagnames for you automatically.
NOTE: Do not use wildcards in this field. If you use a tag mask instead of a tagname, Historian only
returns the first possible match.
4. In the Query Time section enter values of time in the Start Time and End Time fields.
13
topic.
6. In the Sampling Type section, select a type from the drop-down list. The following types are
available:
Interpolated Sampling - calculates values between two data points using a linear
interpolation algorithm.
Calculated Sampling - computes values using an algorithm selected in the Calculation field.
Lab Sampling - computes intermediate values between two data points by using the last
actual value. This type of sampling displays as a stair step type of curve.
Trend Sampling - determines the raw minimum and raw maximum value for each specified
interval. Use the Trend sampling mode to maximize performance when retrieving data points
for plotting.
InterpolatedtoRaw Sampling - provides raw data in place of interpolated data when the no.
of samples fall lesser than the available samples.
TrendtoRaw Sampling - fetches raw data between a selected raw minimum and raw
maximum value for a selected interval.
LabtoRaw Sampling - provides raw data for the selected calculated data over the plot, when
no. of samples fall lesser than the available samples.
7. The Calculation Field is active only after you select Calculated Sampling as the Sample Type. Select
a Calculation Algorithm type from the drop-down list. The following types are available:
Average - a time weighted arithmetic mean.
Minimum - the lowest value in the group.
Maximum - the highest value in the group.
Standard Deviation - the square root of the arithmetic mean of deviations from the time-
weighted arithmetic mean of all values in the group.
Total - the time-weighted total of all values in the group. Note that Engineering Units are
assumed to be in Units/Day. If your Engineering Units were not measured in Units/Day, you
must scale your total to the actual time units of the measurement. For example, if the
measurement were in Units/Minute (such as GPM), you would multiply the total number by
1440 (minutes in a day) to scale the value into the correct time units.
Count - the total number of values in the group.
Raw Average - the unweighted arithmetic mean of all values in the group.
14
Defining Reports
Raw Standard Deviation - the square root of the arithmetic mean of deviations from the
unweighted arithmetic mean of all values in the group.
Raw Total - the unweighted total of all values in the group.
Time of Minimum Value - the time at which the minimum value occurred.
Time of Maximum Value - the time at which the maximum value occurred.
TimeGood - the amount of time (in milliseconds) during the interval when the data quality is
good.
State Count.-. Displays the number of times a tag has transitioned to another state from a
previous state. A state transition is counted when the previous good sample is not equal to the
state value and the next good sample is equal to state value.
State Time.-. Displays the duration that a tag was in a given state within an interval.
8. In the Sampling Interval section, select either the By Interval or By Samples option.
The By Interval option displays two entry fields, Interval and Time Unit. Enter values in
both. For example, to sample at 10 minute intervals, enter 10 in the interval field and select
Minutes in the Time Unit field.
The By Samples option displays a Number of Samples field. To specify a number of samples
for the data query, enter a number in this field. For example, to query 100 samples, enter 100
in this field.
9. Enter the state value. The State Value is active only after you select Sampling Type as Calculated
and Calculation Field as Sate Count or State Time.
10. In the Output Display field, select one or more parameters for the output. Click a name to select it.
To select multiple individual tags, press the Control key and click the tagnames. To select a sequence
of tags, press the Shift key and click the first and last tagname of the sequence.
11. In the Filter Definition section, enter filter parameters in the fields for Filter Tag, Filter Comparison,
Include Date Where Value Is Equal To, and Include Times. These fields are optional. If you do not
enter any values, the query returns all values without filtering. See the following table for more
information.
1. Select a tag on your worksheet and, while it is selected, click in the Tag Name field of the
dialog box. This enters the tagname for you automatically.
2. In the optional Filter Comparison field, select a comparison operator from the drop-down
list (equal to, equalfirst, equallast, greater than, greater than or equal to, less than, less than
or equal to, not equal to, alarm condition, alarm subcondition).
3. In the optional Include Data Where Value Is Equal To field, enter a target reference value.
4. In the optional Include Times After field, select one of the time options (Time After, Time
Before, Time Before and After, Exact Time) from the drop-down list.
15
degrees.
NOTE: When selecting multiple tags, the orientation of the return data is based on the orientation of the
selected tags and the Row/Col selection is ignored.
descending order.
Filter Parameters for Data Queries
Parameter Description
Filter Tag The single tag name used when applying the filter criteria. Entering a tag for this
parameter indicates that you want to perform a filtered data query. The other filter fields
are disregarded unless you specify a filter tag.
Filter Mode The type of time filter:

ExactTime &endash; Retrieves data for the exact times that the filter condition is True
(only True)
BeforeTime &endash; Retrieves data from the time of the last False filter condition up
until the time of the True condition (False until True).
AfterTime &endash; Retrieves data from the time of the True filter condition up until
the time of next False condition (True until False).
BeforeAndAfterTime &endash; Retrieves data from the time of the last False filter
condition up until the time of next False condition (While True).
The Filter Mode defines how time periods before and after transitions in the filter
condition should be handled.
For example, AfterTime indicates that the filter condition should be True starting at the
timestamp of the archive value that triggered the True condition and leading up to the
timestamp of the archive value that triggered the False condition.
16
Defining Reports
Filter The type of comparison to be made on the filter comparison value:

Comparison
Equal &endash; Filter condition is True when the Filter Tag is equal to the comparison
Mode
value.
EqualFirst &endash; Filter condition is True when the Filter Tag is equal to the first
comparison value.
EqualLast &endash; Filter condition is True when the Filter Tag is equal to the last
comparison value.
NotEqual &endash; Filter condition is True when the Filter Tag is NOT equal to the
comparison value.
LessThan &endash; Filter condition is True when the Filter Tag is less than the
comparison value.
GreaterThan &endash; Filter condition is True when the Filter Tag is greater than the
comparison value.
LessThanEqual &endash; Filter condition is True when the Filter Tag is less than or
equal to the comparison value.
GreaterThanEqual &endash; Filter condition is True when the Filter Tag is greater
than or equal to the comparison value.
Alarm Condition &endash; Specifies an alarm condition to filter data by. For
example, Level.
Alarm SubCondition &endash; Specifies an alarm sub-condition to filter data by. For
example, HIHI.
The Filter Comparison Mode defines how archive values for the Filter Tag should be
compared to the Filter Value to establish the state of the filter condition. If a Filter Tag
and Filter Comparison Value are supplied, time periods are filtered from the results
where the filter condition is False.
Filter The value to compare the filter tag with when applying the appropriate filter to teh data
Comparison record set query (to dtermine the appropriate filter times).
Value
Examples
If you had a BatchID going into an Historian tag, that BatchID will either have a timestamp at the
beginning of the batch or at the end of the batch. Different batch systems report the BatchID as the
batch is started, and other systems do not report the BatchID until the batch is finished.
17
If your BatchID is reported at the beginning of a batch, you would need to use the AfterTime option
because you would want to include all data for a particular BatchID after the time the BatchID was
reported up until the next BatchID was reported.
If your BatchID was being reported at the end of the batch, you would want to use the BeforeTime
option because you would want to include all data for a particular Batch ID before the time the Batch
ID was reported back to the previous BatchID being reported.
Querying Calculated Data

Querying Calculated Data retrieves data that is the result of performing specified calculations on raw data
values in the archive.
NOTE: If you attempt to perform a calculated data query with two worksheets open, the Excel Add-In may
become unstable and lock up. This is a known Microsoft Excel issue. To avoid locking up Excel while
performing queries with the Excel Add-In, work with only one Excel document at a time.
To perform a query for calculated data:
1. Select Query Calculated Data from the Historian menu. The Historian Calculated Data Query
dialog box appears.
NOTE: The selection of tags should always be via cell references. Try not to type them directly into
the dialog box. Rather, select them in the worksheet.
3. In the Query Time section, enter values of time in the Start Time and End Time fields.
topic.
5. In the Sampling Type section, select a type from the drop-down list. The following types are
available:
Interpolated Sampling - calculates values between two data points using a linear
interpolation algorithm.
Calculated Sampling - computes values using an algorithm selected in the Calculation field.
18
Defining Reports
Lab Sampling - computes intermediate values between two data points by using the last
actual value. This type of sampling displays as a stair step type of curve.
Trend Sampling - determines the raw minimum and raw maximum value for each specified
interval. Use the Trend sampling mode to maximize performance when retrieving data points
for plotting.
InterpolatedtoRaw Sampling - provides raw data in place of interpolated data when the no.
of samples fall lesser than required.
TrendtoRaw Sampling - fetches raw data between a selected raw minimum and raw
maximum value for a selected interval.
LabtoRaw Sampling - provides raw data for the selected calculated data over the plot, when
no. of samples fall lesser than the available samples.
6. The Calculation Field is active only after you select Calculated Sampling as the Sample Type. Select
a Calculation Algorithm type from the drop-down list. The following types are available:
Average - a time weighted arithmetic mean.
Minimum - the lowest value in the group.
Maximum - the highest value in the group.
Standard Deviation - the square root of the arithmetic mean of deviations from the time-
weighted arithmetic mean of all values in the group.
Total - the time-weighted total of all values in the group. Note that Engineering Units are
assumed to be in Units/Day. If your Engineering Units were not measured in Units/Day, you
must scale your total to the actual time units of the measurement. For example, if the
measurement were in Units/Minute (such as GPM), you would multiply the total number by
1440 (minutes in a day) to scale the value into the correct time units.
Count - the total number of values in the group.
Raw Average - the unweighted arithmetic mean of all values in the group.
Raw Standard Deviation - the square root of the arithmetic mean of deviations from the
unweighted arithmetic mean of all values in the group.
Raw Total - the unweighted total of all values in the group.
Time of Minimum Value - the time at which the minimum value occurred.
Time of Maximum Value - the time at which the maximum value occurred.
TimeGood - the amount of time (in milliseconds) during the interval when the data quality is
good.
State Count.-. Displays the number of times a tag has transitioned to another state from a
previous state. A state transition is counted when the previous good sample is not equal to the
19
state value and the next good sample is equal to state value.
State Time.-. Displays the duration that a tag was in a given state within an interval.
7. Enter the state value. The State Value is active only after you select Sampling Type as Calculated
and Calculation Field as Sate Count or State Time.
The By Interval option displays two entry fields, Interval and Time Unit. Enter values in
both. For example, to sample at 10 minute intervals, enter 10 in the interval field and select
Minutes in the Time Unit field.
The By Samples option displays a Number of Samples field. To specify a number of samples
for the data query, enter a number in this field. For example, to query 100 samples, enter 100
in this field.
9. In the Output Display field, select one or more parameters for the output. Click a name to select it.
To select multiple individual tags, press the Control key and click the tagnames. To select a sequence
of tags, press the Shift key and click the first and last tagname of the sequence.
degrees.
descending time order.
Exporting Tags
The Export Tags function permits you to send tag information from the Historian Server to an Excel worksheet
or to another system, which may be either local or remote.
NOTE: Before importing or exporting tags, data, or messages, you should be aware of a convention used with
the Historian application. The Server is the reference point for all import and export functions, as illustrated in
the following figure. If you want to move tag information from the Server into your worksheet, you must use the
Export Tags command. Conversely, if you want to move data from your worksheet to the server, you must use
the Import Data command.
20
Defining Reports
It is recommended that you first export a tag and then import it, to become familiar with the procedure and what
the data looks like.
Import/Export Reference Convention
To export a tag or tags from the Historian:
1. Select Administration and then select Export Tags from the Historian menu. The Export Tags from
Historian dialog box appears.
2. Select a server from the drop-down list. If you do not select a server, the Add-In uses the default
server.
3. In the Filter Criteria section, enter the name of the tag you want to export or, as an alternative, enter a
mask for selecting a group of tags. If you do not enter a tagname, the filter uses other criteria for
selecting tags. If you do not enter any criteria, the filter returns all tags.
If you prefer, you can enter a tag description and/or a description mask instead of a tagname or tag mask.
NOTES:
You cannot export multiple tags when tagnames are read from multiple cells. If you specify a
range of tagnames to read from multiple cells in the Tag Mask or Tag Name(s) fields, only the
first tag in the range will be exported.
The selection of tags should always be via cell references. Try not to type them directly into the
4. Enter a collector name in the Collector field. This entry is optional.

5. Select a data type from the drop-down list in the Data Type field. If you do not select a data type, or if
you select a data type that does not match the other entries you have made, the filter uses other criteria.
21
6. Select one or more field names from the list in the right hand window. To select a single item, click
the name of the field. To select multiple individual tags, press the Control key and click the tagnames.
To select a sequence of tags, press the Shift key and click the first and last tagname of the sequence.
NOTE: Always include Tagnames in the list of fields to export.
7. In the Export Options section, select either the To New Worksheet, To CSV File, or To XML option.
If you select either the CSV or XML option, you must also enter a path and filename for the destination
file.
8. Click OK to execute the Export Tag function. Click Cancel to cancel and close the dialog box.
When the export function finishes, a dialog box appears within a display of the worksheet containing the
exported tags. Click OK to acknowledge the operation and close the dialog box.
Importing Tags
The Import Tags function permits you to move tag information into the Historian Server from an Excel
Worksheet or from another system, which may be either local or remote.
When used with the Excel Add-In, the Import Tags function moves selected information from your current
worksheet into the specified Historian Server.
There is no error checking when you import tags through the Excel Add-In. For example, with the Excel Add-In
you can successfully import unsolicited tags without a calculation dependency (trigger). The Historian
Administrator prevents you from performing this import, however. As another example, the Excel Add-In
allows you to import circular references, while the Historian Administrator does not.
To import a tag or tags:
1. Select Administration and then select Import Tags from the Historian menu. A message box
appears.
2. Click Yes to initiate the operation.
If successful, a dialog box appears confirming completion of the import function. Click OK to close the
dialog box. If errors on the import occur, a dialog box appears detailing the issues encountered during
the import. If any error occurred with any line of the import, the whole import is aborted.
NOTE: If you export all fields and attempt to import the read-only fields LastModified and LastModifiedUser,
you may receive an Import failed, Error with Import Header message. Try exporting the tags again (not
22
Defining Reports
selecting the read-only fields) and importing.
Exporting Enumerated Sets

The Export Enumerated Sets function enables you to display information about enumerated sets in an Excel
worksheet. Using this function, you can export sets data from Historian, add and edit the enumerated sets
information, and import it back into Historian. The advantage of using this feature is the capability to make
changes in bulk and send them to Historian in a simple procedure without using the Administration application.
Before importing or exporting enumerated sets, you should be aware of a convention used with the Historian
application. The Server is the reference point for all import and export functions. If you want to move tag
information from the Proficy Historian Server into your worksheet, you must use the Export Enumerated Sets
command. Conversely, if you want to move data from your worksheet to the server, you must use the Import
Enumerated Sets command. If you plan to import set information, it is recommended that you first export a set,
to become familiar with the format.
To export Enumerated Sets from the Historian:
1. Select Administration and then select Export Enumerated Sets... from the Historian menu. The
Proficy Historian Export Tags dialog box appears.
2. Select a server from the drop-down list. If you do not select a server, the Add-In uses the default
server.
3. In the Filter Criteria section, in the EnumeratedSet Mask/EnumeratedSet Name field, search for
the sets set you want to export. You can use one of the following options that are available:
Enter a * or do not enter any criteria. All the sets appear.
Enter a set name or name mask or description and a description mask (*) criteria. All the sets
matching the criteria appear.
4. In the Export Options section, select either the To New Worksheet, To CSV File, or To XML option. If
you select either the CSV or XML option, you must also enter a path and file name for the destination
file.
5. Click OK to execute the Export Enumerated Set function. Click Cancel to cancel and close the dialog
box.
When the export function finishes, a dialog box appears within a display of the worksheet containing
the exported sets and the message, Export Succeeded. Click OK to acknowledge the operation and
close the dialog box.
23
Importing Enumerated Sets

The Import Enumerated Sets function enables you to create or modify enumerated sets in the Historian Server.
You can also add and modify sets using the Historian Administrator. For more information, refer to Working
with Enumerated Sets.
To import Enumerated Sets to the Historian:
1. Select Administration and then select Import Enumerated Sets... from the Historian menu. A
message box appears asking you to confirm whether to import the sets.
2. Click Yes to initiate the operation.
If successful, a dialog box appears with the message, Import Enumerated Sets Succeeded confirming
completion of the import function. Click OK to close the dialog box.
If errors on the import occur, a dialog box appears detailing the issues encountered during the import.
Working with Enumerated Sets

Before importing enumerated sets into Proficy Historian from an Excel Worksheet, you can perform the
following actions:
Add sets
Delete sets
Modify set description
Add states
Modify states
Delete states
To add sets:
1. Enter details in the following columns in the excel worksheet.
NOTE: The columns are listed here according to the way they appear in the Excel worksheet. However,
it is recommended to fill the columns in the following sequence: SetName, SetDescription, StateName,
StateDescription, StateLowValue, StateHighValue, StateRawValueDataType, and
NumberOfStatesInThisSet.
24
Defining Reports
2. Click the Import Enumerated Sets... to import the sets.
To delete sets:
1. Select the row that has the state you want to delete.
2. Right-click the row and select Delete. Alternatively, you can also use the Delete key on your keyboard.
To modify the description of a set:
1. Click in the StateDescription cell and modify the description.

You cannot modify the name of the set. If you change the name of the set, it is considered as a new set.
To add states:
1. Select the set to which you wish to add a set.

2. Add the name of the set in the SetName column. The name should be same as the set selected by you.
3. Enter the details in the SetDescription, StateName, StateDescription, StateLowValue, StateHighValue,
StateRawValueDataType columns.
4. Enter the total number of states in the NumberOfStatesInThisSet column.
Ensure that this value is the same for the current state and existing states in the set. For example, if a
state has two states already and you are adding a third state, the number of states for all the three states
should be changed to three. A new state is added to the set.
To modify states:
1. Select the state you wish to modify by clicking the row in the Excel worksheet.
2. Modify the values by clicking in the respective columns. The state/states are modified.
To delete states:
1. Select the row that has the state you wish to delete.
2. Right-click the row and select Delete. Alternatively, you can also use the Delete key on your keyboard.
25
Adding New Tags or Modifying Tag Parameters

You can use the Excel Add-In to add tags to your Historian system or to modify parameters for existing tags.
For example, you can generate and define new tags either automatically or manually in an Excel worksheet and
then import them in bulk to the Historian system. This can be a very convenient mechanism when you are
working with large numbers of tags.
If any conflicting names or parameters occur, the system displays a warning message to alert you to the
problem. You can then eliminate the conflict and try again.
You can also modify tag parameters by editing them in the worksheet and then bulk importing them into
Historian.
To add tags using the Historian Excel Add-In:
1. Build a tag worksheet in Excel using macros or any other tools you are familiar with. Since Historian
requires information about each tag that varies with the type of tag selected, verify that you have
included all required information in the worksheet before attempting to import it into Historian. To
determine what specific tag information is required, refer to the documentation provided with your
SCADA application.
2. Use the Import Tags command to bulk import this information into your Historian application.
NOTE: If any errors on the import occur, a dialog appears detailing the issues encountered during the
import. If any error occurred with any line of the import, the whole import is aborted.
Deleting Tags
You cannot use the Excel Add-In to delete tags from your Historian system. For more information on deleting
tags, refer to the Deleting a Tag section of the Using the Historian Administrator manual.
Exporting Data
The Export Data function allows you to move values from the Historian Server to your Excel worksheet or to
another system in the same way you move tag information with Export Tags.
NOTE: Before importing or exporting tags, data, or messages, you should be aware of a convention used with
the Historian application. The Server is the reference point for all import and export functions. If you want to
move tag information from the Server into your worksheet, you must use the Export Tags command. Conversely,
if you want to move data from your worksheet to the server, you must use the Import Data command.
26
Defining Reports
To export data from the Server into your Worksheet:
1. Select Administration and then select Export Raw Data from the Historian menu. The Export Data
from Historian dialog box appears.
2. If you want to specify a server, select a server from the drop down list. If you do not specify a server,
the Add-In uses the default server.
NOTE: The selection of tags should always be via cell references. Try not to type them directly into the
topic
5. In the Query Time section enter values of time in the Start Time and End Time fields.
6. In the Sampling Type section, select a type from the drop-down list.
7. The Calculation field is active only after you select Calculated Sampling as the Sample Type. Select
a Calculation Algorithm type from the drop-down list.
The By Interval option displays two entry fields, Interval and Time Unit. Enter values in both. For
example, to sample at 10 minute intervals, enter 10 in the interval field and select Minutes in the Time
Unit field.
The By Samples option displays a Number of Samples field. To specify a number of samples for the
data query, enter a number in this field. For example, to query 100 samples, enter 100 in this field.
9. In the Filter Definition section, enter filter parameters in the fields for Filter Tag, Filter
Comparison, Include Date Where Value Is Equal To, and Include Times. These fields are
optional. If you do not enter any values, the query returns all values without filtering.
10. In the Fields To Export section, select one or more fields. To select multiple individual tags, press the
Control key and click the tagnames. To select a sequence of tags, press the Shift key and click the first
and last tagname of the sequence.
11. In the Export Options section, select one of three options: To New Worksheet, To CSV File, or To
XML File.
12. If you select To CSV File or To XML File, you must enter a file name and path for the new file in the
File Name field.
27
13. Click OK to initiate the export. Click Cancel to abort the operation and close the dialog.
Importing Data
The Import Data command is the converse of the Export Data command. It moves selected information from
your current worksheet into the specified Server in the same way the Import Tags command functions.
NOTE: If you use the Active Hours setting while importing data using the Excel Add-In, note that if the first
tags imported are not within the Active Hours settings, no subsequent tags will be returned on that import (even
if they are within the set active hours).
To import data to the Server from your worksheet:
1. Select Administration and then select Import Data from the Historian menu. A message box
appears.
2. Click Yes to initiate the operation. If successful, a dialog box appears confirming the completion of
the import function. Click OK to close the dialog box.
If errors occur on the import, a dialog box appears detailing the issues encountered in the import. If an
error occurs in any line of the import, the whole import is aborted.
Searching Messages
The Search Messages function lets you search the archives for selected types of messages generated during a
specific time period and to display selected fields from those messages. This puts a dynamic formula in the
worksheet. Dynamic formulas allow you to build a dynamic message report that you can build, save, and re-use.
To search for messages:
1. Select Administration and then select Search Messages from the Historian menu. The Historian
Message Search dialog appears.
2. Select a server from the drop-down list. If you do not specify a server, the Add-In uses the default
server.
3. In the Topic field, select one of seven types (Connections, Configuration, General, Services,
Performance, and Security) of messages from the drop-down list.
4. In the Query Times fields, enter values for start time and end time.
5. In the Search String section, enter a search string for scanning the text of messages. You do not need
to enter *s for wildcards.
28
Defining Reports
6. In the Output Display section, select one or more parameters for the output display. Click a name to
select it. To select multiple individual tags, press the Control key and click the tagnames. To select a
sequence of tags, press the Shift key and click the first and last tagname of the sequence.
8. Select Asc or Desc to sort the messages in ascending or descending order.
degrees.
10. Click OK to execute the search. Click Cancel to close the dialog box.
Exporting Messages
The Exporting Messages function lets you find messages and export them from the server to your worksheet or
to a CSV or XML file. You can specify the server and select the messages to be exported by specifying a start
time, an end time, or a text string, using standard wildcards, where applicable. You can also select which fields
of the messages are exported, such as time stamp, topic, message string, message number, substitutions, or
username.
To export a message:
1. Select Administration and then select Export Messages from the Historian menu. The Export
Messages From Historian dialog box appears.
server.
3. In the Topic field, select one of six types of messages from the drop-down list.
4. In the optional Filter Criteria fields, enter values for start time, end time, and search text string in the
appropriate fields.
5. In the Fields to Export section, select one or more field names from the displayed list. To select
multiple individual tags, press the Control key and click the tagnames. To select a sequence of tags,
press the Shift key and click the first and last tagname of the sequence.
6. In the Export Options section, select one of three options:
To New Worksheet
29
To CSV File
To XML File.
If you select To CSV File or To XML File, you must enter a file name and path for the new file in the
File Name field.
7. Click OK to initiate the export. Click Cancel to abort the operation.
Importing Messages
The Importing Messages command writes all messages from the worksheet into the server. When you initiate
the import function, a dialog box asks if you want to import messages from your worksheet into a specified
server. If you reply Yes, it scans your worksheet for messages, writes them to the server, and notifies you that
the operation succeeded or failed.
If you choose to export messages from Historian into Excel and then import the messages back into the
Historian, note that the Importing Messages function only allows you to add messages to the Historian Server. It
does not allow you to modify or remove any existing messages.
To import a message into the server from your worksheet:
1. Select Administration and then select Import Messages from the Historian menu. A message box
appears.
2. Click Yes to execute the import. A dialog box appears when the operation is complete. Click OK to
close the dialog box.
If errors occur in the import, a dialog box appears detailing the issues encountered in the import. If an
error occurs in any line of the import, the whole import is aborted.
Listing Archives
The List Archive function returns a list of selected statistics about an archive file. You can specify the server,
the archive file name, and the type of information displayed, such as start time, end time, file name, target file
size, current file size, current or read-only status, last backup time, and last backup users. You can also specify a
range of cells for the display.
To display a list of archives:
1. Select Administration and then select List Archives from the Historian menu. The Historian
Archive List dialog box appears.
30
Defining Reports
server.
3. In the Archive name field, enter an archive name. Do not use wild cards in this field.
4. In the Output Display section, select one or more parameters for the output display. To select
NOTE: The List Archives Query sorts by archive start time. The archive list will be sorted based on
start time whether this field is selected or not.
6. Select Asc or Desc to sort the archives in ascending or descending order.
degrees.
TIP: To return details for more than one item, specify a substring in the Archive Name field that exists in each
archive you want listed. For example, if you had archives Hero5_Archive0001 -010, you could specify the
substring Hero5_Archive to return the details for all those archives. Ensure that your selected output range
allows for all the archives to be listed or only the number rows/columns specified in the output range will be
filled in.
Listing Collectors
The List Collectors function returns a list of selected statistics about a collector. You can specify the server, the
collector name, and select the type of information displayed. You can also specify the range of cells for the
display.
To display a list of Collectors:
1. Select Administration and then select List Collectors from the Historian menu. The Historian
Collector List dialog box appears.
server.
31
3. In the Collector name field, enter a Collector name. Do not use wild cards in this field.
4. In the Output Display section, select one or more parameters for the output display. To select
6. Select Asc or Desc to sort the messages in ascending or descending order.
degrees.
TIP: To return details for more than one item, specify a substring in the Collector Name field that exists in each
collector you want listed. For example, if you had collectors Hero5_Collector0001 -010, you could specify the
substring "Hero5_Collector" to return the details for all those collectors. Ensure that your selected output
range allows for all the collectors to be listed or only the number rows/columns specified in the output range
will be filled in.
Working with Alarm and Event Data

For more information on working with alarm and event data in the Excel Add-In, refer to the Excel Add-In and
Historian Alarms and Events
32
Defining Reports
Defining Reports
The ability to generate a wide range of custom reports is a major benefit of using the Historian Excel Add-In.
Using this versatile tool, you can use all the standard, familiar Excel tools and techniques to access the Historian
archives and build reports and charts of all types to fit your specific needs.
If you want, you can use the sample reports included with Historian almost as is just change the tags to fit
your application. As an alternative, use the setup worksheets as a starting point and adapt them to your
particular situation.
Building Dynamic Reports

You can define a report so that Excel recalculates the worksheet whenever the contents of specific cells, such as
start times or dates, change. In this way, the report generates a dynamic snapshot of process performance,
updated regularly in real time. You can also, of course, manually initiate recalculation at any time.
The primary rule to follow in building a dynamic report is to use formulas with cell references that contain
variable information rather than fixed data, so that recalculation produces new data each time it occurs. You
then initiate recalculation by changing certain inputs manually or automatically.
Sharing Excel Reports

You can share any Excel reports you develop with the Historian Excel Add-In as you would any other Excel
workbook. Each client using the worksheets, however, must have the Historian Excel Add-In installed and
enabled inside Excel.
Using the Sample Reports

The Historian application includes three typical sample reports. These reports clearly demonstrate the power
and ease-of-use of the Excel Add-In. Use them directly in your application or modify them to fit your
requirements.
NOTE: This manual contains hypertext links that open the provided Historian Sample Reports directly in Excel.
If you did not install the Excel Add-In, moved the Sample Reports from the Sample directory, or moved the
Historian.chm file from its installed location, you will receive an error when you click on these links and will be
33
unable to take advantage of this functionality.
The three sample Excel reports are built using tags from the Simulation Collector. You must have the
Simulation Collector installed on a machine and collecting data to the Historian Server in order for these reports
to work. The Historian Batch Report Sample.xls file also uses Batch ID and Product ID tags from the
Simulation Collector. These are Simulation Collector points that are configured to store string data types. To
ensure that the sample reports work correctly, you must add the string tags. These are the last 5 tags in the tag
collector list. Add the string tags in the Historian Administrator by browsing the Simulation Collector and
adding all of the tags by selecting the Add All Tags check box. Alternatively, you can run the Add Tags to
Simulation Collector.bat batch file in the Historian\Server directory of the machine that has the Simulation
Collector.
In addition, when you first install the Simulation Collector it prompts you for the number of simulation tags it
should create (but you must still add the tags for collection using one of the two methods above). The default is
1000. Do not make this value less than 30.
When opening a Sample Excel report, you may receive a message prompting you to update all linked
information in the workbook (Yes) or keep the existing information (No). It is recommended that you select No
and keep the existing information. The links will be automatically updated for your worksheet. Save your
worksheet after the links have been updated.
Sample Report 1 Historian Statistical Analysis

This report, illustrated in the following figure, calculates, for a specified time period, a number of statistical
properties of a tag, such as average, maximum, minimum, standard deviation, 2 sigma and 3 sigma control
limits, and correlation coefficients for other tags. It displays charts of various types for several of these
variables.
Click to Open the Historian Statistical Analysis Sample Report in Excel.
34
Defining Reports
Sample Report 1 Historian Statistical Analysis
The chart at the lower left is a plot of the main variable vs. time with sigma control limits indicated by the
straight lines. The two charts to the right are scatter diagrams that show the correlation between the main
variable and two other variables. The chart at the top right is a histogram of data values of the main variable that
shows how the data points are distributed.
The following figure shows the worksheet associated with the sample report that contains the data used to
generate the report.
35
Sample Report 1 Data Values
Sample Report 2 Daily Report
This sample report, shown in the following figure, shows how the measured values and selected statistical
properties of specified tags have varied during the previous 24-hour period. This sample is an example of a
typical daily performance report in an industrial plant.
Click to Open the Historian Daily Report Values Sample Report in Excel.
36
Defining Reports
Sample Report 2 Daily Report Values
The report shown in the following figure is a collection of chart plots of the data displayed in the report of the
previous figure.
37
Sample Report 2 Daily Report Charts
The following figure shows the worksheet used to set up the Daily Sample Report. Edit the worksheet to adapt
this report to your application.
38
Defining Reports
Sample Report 2 Daily Report Setup Worksheet
Sample Report 3 Batch Report
The sample report shown in the following figure is an example of a report that might be used with a batch type
of industrial process. The table at the top of the report shows the batch identification, the start and end times,
product name, and computed statistics for several process variables. The charts show how selected process
parameters varied during the batch cycle.
Click to Open the Historian Batch Report Sample in Excel.
39
Sample Report 3 Batch Report
The following figure shows the configuration worksheet used to generate the report shown in the previous
figure. Edit this worksheet to adapt it to your requirements.
40
Defining Reports
Sample Report 3 Batch Report Setup Worksheet
Troubleshooting the Excel Add-In Sample Reports

If you follow the recommended installation procedures, you should not have any difficulty in running the
Sample Reports. If you do encounter any problems, they are likely to relate to the locations of files and the links
to those files.
When opening a Sample Excel report, you may receive a message prompting you to update all linked
information in the workbook (Yes) or keep the existing information (No). GE Intelligent Platforms recommends
that you select No and keep the existing information. The links will be automatically updated for your
worksheet. Save your worksheet after the links have been updated.
41
For problems in the worksheets themselves, refer to Excel online Help for assistance.
Running a Report Using Visual Basic

The following Visual Basic example shows you how to create a hidden instance of Microsoft Excel, open a
preconfigured Historian report in that instance, and then print the report to the default printer. If you want to use
the following example, you need to modify the path of the .XLA and .XLS files. The paths that you need to edit
are bolded in the following example.
To use this example, a user must have the privileges to run the collector as a Windows service in Windows and
a default printer must be installed. If Historian security is enabled, the user must have iH Readers membership.
Tag level security can override this privilege.
You can trigger this example to run on an event basis or on a polled basis. Most likely, you would run this
example on an event basis. However, you could run it on a polled basis through the Windows Task Scheduler.
Sub CreateExcelObjects()
Dim xlApp As Excel.Application
Dim wkbNewBook As Excel.Workbook
Dim wksSheet As Excel.Worksheet
Dim strBookName As String
' Create new hidden instance of Excel.
Set xlApp = New Excel.Application
' Open the preconfigured Historian Excel Add-in report.
Workbooks.Open "C:\Program Files\Microsoft Office\Office11\Library\iHistorian.xla"
Set wkbNewBook = Workbooks.Open("c:\testih.xls", 0, False)
'xlApp.Visible = True
With wkbNewBook
For Each wksSheet In .Worksheets
Select Case wksSheet.Name
Case "tag1"
wksSheet.Select
.RefreshAll
.PrintOut
End Select
Next wksSheet
.Close False
End With
Set wkbNewBook = Nothing
xlApp.Quit
Set xlApp = Nothing
End Sub
42
Defining Reports
Array Formulas for the Historian Excel Add-In

In Microsoft Excel, an array formula is a data request that inputs a set of parameters and returns a result or list
of results. The Historian Excel Add-In uses the following array formulas:
ihSearchTags(pServer,pTagMask,pDescriptionMask,pCollector,pArraySize,pSort,pRowCol,Parameters())
ihQueryData(pServer,pTagName,pStartTime,pEndTime,pSamplingMode,pCalculationMode,pSamplingIn
terval,pNumberOfSamples,pDirection,pFilterTag,pFilterMode,pFilterComparisonMode,pFilterComp
arisonValue,pArraySize,pSort,pRowCol,Parameters())
ihQueryData3(pServer,pTagName,pStartTime,pEndTime,pSamplingMode,pCalculationMode,pSamplingI
nterval,pNumberOfSamples,pDirection,pFilterTag,pFilterMode,pFilterComparisonMode,pFilterCom
parisonValue,pQueryModifiers,pStateValue,ppArraySize,pSort,pRowCol,Parameters())
ihQueryMessages(pServer,pTopic,pStartTime,pEndTime,pSearchText,pArraySize,pSort,pRowCol,Parame
ters())
ihListArchives(pServer,pArchiveNameMask,pArraySize,pSort,pRowCol,Parameters())
ihListCollectors(pServer,pCollectorNameMask,pArraySize,pSort,pRowCol,Parameters())
When inserting an array formula, you cannot overwrite part of the range of another array formula in your
worksheet. The range includes cells without data displayed. An error message appears if you try to do so.
Reselect a different output range to insert the formula.
Description of Array Formula Parameters

The following table describes the parameters for the array formulas for the Historian Excel Add-In.
Descriptions of Array Formula Parameters
Parameter Description
pArchiveNameMask A search mask you can use to browse the archivers. Use standard Windows
wildcard characters.
pArraySize The number of cells that the array spans.
43
pCalculationMode The type of calculation mode. See the Calculation Modes section in the
Getting Started with Historian guide for a complete list.
pCollector The collector or collector mask that you want to query.
pCollectorNameMask A search mask for browsing collectors. Use standard Windows wildcard
characters.
pDescriptionMask A search mask for browsing tag descriptions. Use standard Windows wildcard
characters.
pDirection The direction (forward or backward from the start time) of data sampling from
the archive.
pEndTime The end time used to refine your query.
44
Defining Reports
pFilterComparisonMode The type of comparison to be made on the filter comparison value:

Equal Filter condition is True when the FilterTag is equal to the
comparison value.
EqualFirst Filter condition is True when the FilterTag is equal to the
first comparison value.
EqualLast Filter condition is True when the FilterTag is equal to the
last comparison value.
NotEqual Filter condition is True when the FilterTag is NOT equal
to the comparison value.
LessThan Filter condition is True when the FilterTag is less than the
comparison value.
GreaterThan Filter condition is True when the FilterTag is greater
than the comparison value.
LessThanEqual Filter condition is True when the FilterTag is less
than or equal to the comparison value.
GreaterThanEqual Filter condition is True when the FilterTag is
greater than or equal to the comparison value.
The FilterComparisonMode defines how archive values for the FilterTag
should be compared to the FilterValue to establish the state of the filter
condition. If a FilterTag and FilterComparisonValue are supplied, time periods
are filtered from the results where the filter condition is False.
pFilterComparisonValue The value to compare the filter tag with when applying the appropriate filter to
the DataRecordset query (to determine the appropriate filter times).
45
pFilterMode The type of time filter:

ExactTime Retrieves data for the exact times that the filter condition
is True (only True).
BeforeTime Retrieves data from the time of the last False filter
condition up until the time of the True condition (False until True).
AfterTime Retrieves data from the time of the True filter condition
up until the time of next False condition (True until False).
BeforeAndAfterTime Retrieves data from the time of the last False
filter condition up until the time of next False condition (While True).
The FilterMode defines how time periods before and after transitions in the
filter condition should be handled.
For example, AfterTime indicates that the filter condition should be True
starting at the timestamp of the archive value that triggered the True condition
and leading up to the timestamp of the archive value that triggered the False
condition.
pFilterTag The single tagname used when applying the filter criteria. Entering a tag for
this parameter indicates that you want to perform a filtered data query. The
other filter fields are disregarded unless you specify a filter tag.
pNumberOfSamples Number of samples from the archive to retrieve.

Samples will be evenly spaced within the time range defined by start time and
end time for most sampling modes. For the RawByNumber sampling mode,
the NumberOfSamples column determines the maximum number of values to
retrieve. For the RawByTime sampling mode, the NumberOfSamples is
ignored.
pRowCol The sorting criteria used: 0 for Columns and 1 for Rows.
pSamplingInterval For non-raw sampled data, this column represents a positive integer for the
time interval (in milliseconds) between returned samples.
pSamplingMode The type of sampling mode used by the query. See the Sampling Modes
section in the Getting Started with Historian guide for a complete list.
46
Defining Reports
pSearchText The text or mask that you want to search for in the message.
pServer Name of the server on which you are retrieving data. If you are running Excel
on the same server that you are retrieving data from, you do not have to enter a
string, as the default server is used.
pSort The sorting criteria used for the rows or columns: 0 for Descending and 1 for
Ascending.
pStartTime The start time used to refine your query.
pTagMask A search mask for browsing tagnames. Use standard Windows wildcard
characters.
pTagName The tagname or tagname mask that you want to query.
pTopic The message topic:

Connections
Configuration
General
Services
Performance
Security
Parameters() Output display of the array formula. This field can include be one or more
parameters.
Editing an Array Formula in Microsoft Excel
To edit an array formula in Microsoft Excel:
1. Click on the cell in the spreadsheet that contains the array formula.
47
2. Click in the formula bar at the top of the screen.

3. Edit the formula that appears in this bar.
4. Press Ctrl+Shift+Enter.
5. Select Save from the File menu.
NOTE: To exit a formula array without editing it, press the Esc key.
48
Defining Reports
Troubleshooting the Excel Add-In

This chapter contains troubleshooting information for using the Excel Add-In with Historian. In particular, it
describes what to do if an error occurs with any of the following:
General imports
Tag imports
Data imports
Data or tag exports
Troubleshooting General Imports

If you experience problems with general imports and want to resolve them, check the following:
Review the HistorianSDKErrors.log in Notepad or another text editor. This file is usually located in
the LogFiles folder in your Historian program folder. Historian records additional information for
some errors in this file. Sometimes, by reviewing this file you can determine the cause of the error.
If using Historian security, verify that the user has the appropriate security rights. If the rights are
incorrect, log in as a user with the correct privileges or change the rights for the current user.
Verify that no empty rows appear between valid rows in your spreadsheet. These empty rows can
cause issues.
Note if any errors occur. If an error occurs with any line of the import, Historian aborts the whole
import.
Troubleshooting Tag Imports

If you experience problems with tag imports and want to resolve them, check the following:
If you remove or add Historian Servers and attempt to Search for tags, the Historian Excel Add-In may
not recognize the default server and may display a message stating that the default server has not been
set. To correct this, close and reopen the Search Tags dialog box.
Make sure that you are not trying to import the Calculation Execution Time, Last Modified, or Last
Modified User fields for each tag. These fields are read-only. As such, you can export them but can not
49
import them.
Check that your collector does not contain any duplicate tagnames. Duplicate tagnames will cause
errors to occur.
Verify that the number of tags that you want to import does not exceed the maximum licensed tag
count. If it does, you will not be able to import the tags.
Troubleshooting Data Imports

If you experience problems with a data import and want to resolve them, try the following steps:
Ensure that the time stamps of any online archives are not prior to the start time of the oldest online
archive.
Ensure that the time stamps are within the active hours setting in the Data Store Maintenance screen of
the Historian Administrator.
Ensure that the time stamps are not for a time greater than 15 minutes ahead of the system time on the
Historian Server.
Ensure that the tags are valid Historian tags. To do this, import your tags before importing their
associated data.
Troubleshooting Data or Tag Exports

You cannot export data or tags to a remote path using the Historian Excel Add-In.
You can export a 64 bit tag, include it in a report and perform calculations on it. However, there will be a minor
precision loss while retrieving the data due to a Visual Basic limitation.
50
Index
A troubleshooting .................................................... 41
add ........................................................................... 24 Export ...................................................................... 23
add sets .................................................................... 24 Export Enumerated Sets .......................................... 23
adding new tags ....................................................... 26 exporting data .......................................................... 26
C I
conventions ................................................................ 2 Import ...................................................................... 24
255 character limit ................................................. 2 Import Enumerated .................................................. 24
256 maximum number of columns ........................ 2 Import Enumerated Sets .......................................... 24
avoiding circular references ................................... 2 importing ................................................................. 22
no right and left arrow keys ................................... 2 messages .............................................................. 30
recalculation .......................................................... 2 tags....................................................................... 22
rows or columns..................................................... 2 importing enumerated sets ....................................... 24
selecting multiple attributes ................................... 2 installing the Excel add-in ......................................... 4
selection of tags, times, and events ........................ 2 L
specifying an output cell ........................................ 2 listing collectors....................................................... 31
specifying an output range ..................................... 2 M
understanding ........................................................ 2 modifying tag parameters ........................................ 26
D N
delete sets................................................................. 24 NumberOfStatesInThisSet ....................................... 24
description ............................................................... 24 O
E options ....................................................................... 7
Enumerated .............................................................. 23 adjust column widths ............................................. 7
Excel ........................................................................ 24 assign default server .............................................. 7
Excel 2007 ................................................................. 4 automatically update links ..................................... 7
Excel Add-In ........................................................... 41 internal vs. external references .............................. 7
51
selecting ................................................................. 7 searching messages .................................................. 28
show/don' t show header labels.............................. 7 searching tags ............................................................ 9
Q SetName .................................................................. 24
querying calculated data .......................................... 18 Sets .................................................................... 23, 24
querying raw data .................................................... 12 T
R tags
Reports..................................................................... 33 searching for .......................................................... 9
building dynamic reports ..................................... 33 selecting from tag list ............................................ 9
using the sample reports ...................................... 33 troubleshooting ........................................................ 41
S Excel Add-In ....................................................... 41
Sample reports ......................................................... 34 U
daily report........................................................... 36 understanding Excel add-in conventions ................... 2
statistical analysis ................................................ 34
52

Proficy Historian 50 Excel Add in

Загружено:

Сведения о документе

Оригинальное название

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

Proficy Historian 50 Excel Add in

Загружено:

Авторское право:

Доступные форматы

Proficy* Historian

Disclaimer of Warranties and Liability

Reference Documents ................................................................................................................. 1

Understanding the Historian Excel Add-In ....................................................................................... 2

Understanding Excel Add-In Conventions ................................................................................... 2

Installing The Excel Add-in with Historian .................................................................................... 4

Using the Historian Excel Add-In ..................................................................................................... 7

Selecting Options ......................................................................................................................... 7

Searching Tags ............................................................................................................................ 9

Querying Alarm and Event Data ................................................................................................ 10

Querying Current Values............................................................................................................ 10

Querying Raw Data .................................................................................................................... 12

Querying Filtered Data ............................................................................................................... 13

Querying Calculated Data .......................................................................................................... 18

Exporting Tags ........................................................................................................................... 20

Importing Tags ........................................................................................................................... 22

Exporting Enumerated Sets ....................................................................................................... 23

Importing Enumerated Sets ....................................................................................................... 24

Working with Enumerated Sets .................................................................................................. 24

Adding New Tags or Modifying Tag Parameters ....................................................................... 26

Deleting Tags ............................................................................................................................. 26

Exporting Data ........................................................................................................................... 26

Importing Data ............................................................................................................................ 28

Importing Messages ................................................................................................................... 30

Listing Archives .......................................................................................................................... 30

Listing Collectors ........................................................................................................................ 31

Working with Alarm and Event Data .......................................................................................... 32

Defining Reports ............................................................................................................................ 33

Building Dynamic Reports .......................................................................................................... 33

Sharing Excel Reports ............................................................................................................... 33

Using the Sample Reports ......................................................................................................... 33

Sample Report 1 Historian Statistical Analysis ................................................................. 34

Sample Report 2 Daily Report ........................................................................................... 36

Sample Report 3 Batch Report ......................................................................................... 39

Troubleshooting the Excel Add-In Sample Reports ................................................................... 41

Running a Report Using Visual Basic ........................................................................................ 42

Array Formulas for the Historian Excel Add-In........................................................................... 43

Description of Array Formula Parameters.............................................................................. 43

Editing an Array Formula in Microsoft Excel .......................................................................... 47

Troubleshooting the Excel Add-In .................................................................................................. 49

Troubleshooting General Imports .............................................................................................. 49

Troubleshooting Tag Imports ..................................................................................................... 49

Getting Started with Historian

Understanding the Historian Excel Add-In

Retrieve selected data from any archive file.

Understanding Excel Add-In Conventions

Installing The Excel Add-in with Historian

For Microsoft Excel 2003:

Excel Add-Ins Dialog Box

2. Select Historian Add-In and click OK.

For Microsoft Excel 2007:

1. Open a new Excel 2007 worksheet.

For Microsoft Excel 2010 (32-bit/64-bit):

1. Open a new Excel 2010 worksheet.

Using the Historian Excel Add-In

To search for tags:

Querying Alarm and Event Data

Alarms and Events and the Excel Add-in

Querying Current Values

To perform a Query Current Values operation:

Querying Raw Data

To perform a raw data query:

Querying Filtered Data