Process Data Add in

Process Data Add-in Contents
Introduction/Overview
Process Data Add-in Introduction: Contents
Copyright Information
Related Documentation
Intended Audience
Technical Support
Using Help
Introduction to Process Data Add-in
Add-in Help Organization
Getting Started
Getting Started
Loading the Add-In
Migrating from Excel 2003 Add-in to Excel 2007 Add-in
Using Add-in Dialog Box Features
Entering Data for the Add-in
Using Excel RefEdit controls
Formatting the Date and Time
Calculating a Function in Excel
Using Process Explorer Tools
Making Changes to a Function After Entry
Using the Process Data Add-in
Using the Process Data Add-In
Defining Options for the Process Data Add-In
Defining Settings for the Current Function
Defining Map Information for Tags
Performing Trend and Aggregate Calculations
Understanding Trend and Aggregate Methods
Understanding Periods
Understanding Steps
Retrieving Attribute Values
Selecting an Attribute List
Retrieving Current Values
Retrieving Filtered Trend Data
Retrieving Values at Specified Times
Performing Data Entry
Starting/Stopping the Timer
Using the Aspen Timeline Control
Creating and Executing Calculations
Process Data Add-in Dialog Boxes
Process Data Add-In Dialog Boxes
Attribute Values Dialog Box
Current Values Dialog Box
Data Entry Setup Dialog Box
Start Timer Dialog Box
Trend/Aggregate Data Dialog Box
Filter Tab, Trend/Aggregate Data Dialog Box
Values at Times Dialog Box
Options Dialog Box
General Tab, Options Dialog Box
Data Source Tab, Options Dialog Box
Output Tab, Options Dialog Box
Format Tab, Options Dialog Box
Settings Dialog Box
Data Source Tab, Settings Dialog Box
Output Tab, Settings Dialog Box
Format Tab, Settings Dialog Box
Aggregate Tab, Settings Dialog Box
Set Time Range Dialog Box
Aspen Timeline Control
Process Data Add-in Functions
Process Data Add-In Functions
Using Process Data Add-in Functions in Visual Basic
ATGetCurrVal
ATGetTimeVal
1 / 79
ATGetAttrVal
ATGetTrend
nDSetting
ATGetAgg
ATGetFltData
ATUserEntry
ATEntryRead
ATEntryW rite
RunTagBrow ser
RunTimeLine
Relative Time Strings
Error Messages
Error Messages
Output Location Mismatch Dialog Box
Overw rite Warning Dialog Box
Overw rite Error Dialog Box
Worksheet Error Messages
2 / 79
Process Data Add-in Introduction: Contents
Intended Audience
Technical Support
Using Help
3 / 79
Version: V7.2
July 2010
Copyright (c) 2010 by Aspen Technology, Inc. All rights reserved.
Aspen Data Source Architecture Directory Server, Aspen InfoPlus.21, InfoPlus.21 Administrator, Definition Editor, Aspen Local
Security Server, Aspen Framew ork Server, Aspen License Manager, Business Process Explorer, Event.21, Aspen Process Explorer,
SQLplus, Aspen Tag Brow ser, Aspen Real-Time SPC Analyzer, the aspen leaf logo, and Plantelligence & Enterprise Optimization
Solutions are trademarks or registered trademarks of Aspen Technology, Inc., Burlington, MA.
All other brand and product names are trademarks or registered trademarks of their respective companies.
This document is intended as a guide to using AspenTech's softw are. This documentation contains AspenTech proprietary and
confidential information and may not be disclosed, used, or copied w ithout the prior consent of AspenTech or as set forth in the
applicable license agreement. Users are solely responsible for the proper use of the softw are and the application of the results
obtained.
Although AspenTech has tested the softw are and review ed the documentation, the sole w arranty for the softw are may be found
in the applicable license agreement betw een AspenTech and the user. ASPENTECH MAKES NO W ARRANTY OR REPRESENTATION,
EITHER EXPRESSED OR IMPLIED, W ITH RESPECT TO THIS DOCUMENTATION, ITS QUALITY, PERFORMANCE, MERCHANTABILITY, OR
FITNESS FOR A PARTICULAR PURPOSE.
Corporate
Aspen Technology, Inc.
200 W heeler Road
Burlington, MA 01803-5501
USA
Phone: (781) 221-6400
Fax: (888) 996-7100
URL: https://w w w .aspentech.com
4 / 79
Help Files
Aspen Process Explorer Help
Aspen Production Record Manager Batch Plots Help
Aspen Process Explorer Automation Interfaces Help
Aspen Process Graphics Editor Help
Aspen Real-Time SPC for Process Explorer Help
Manuals
Aspen InfoPlus.21 Product Family Installation Guide
Aspen InfoPlus.21 Product Family Configuration Guide
Aspen InfoPlus.21 Product Family Release Notes
5 / 79
Intended Audience
The Process Data Add-in Help provides detailed descriptions and procedures for users of the Process Data Add-in.
6 / 79
T echnical Support
AspenTech customers w ith a valid license and softw are maintenance agreement can register to access the online AspenTech
Support Center at:
https://support.aspentech.com
This Web support site allow s you to:
Access current product documentation
Search for tech tips, solutions, and frequently asked questions (FAQs)
Search for and dow nload service packs and product updates
Submit and track technical issues
Send suggestions
Report product defects
Review lists of know n deficiencies and defects
Registered users can also subscribe to our Technical Support e-Bulletins. These are used to alert users to important technical
support information such as:
Technical advisories
Product updates and releases
Customer support is also available by phone, fax, and email. The most up-to-date contact information is available at the
AspenTech Support Center at https://support.aspentech.com.
7 / 79
Using Help
Here are some tips about using Help in your application.
Opening Help
You have the follow ing options to open the online Help:
From the application w indow , click the Help menu, and then select Contents and Index.
From a dialog box, press F1 for dialog level Help.
Adjusting the Window

You can drag the outside edge of the Help w indow to adjust the size. Inside the Help w indow , you can drag the divider to adjust
the size.
Scrolling through a Topic

W hen a Help topic extends beyond w hat you can see in the Help w indow , you can use the vertical and horizontal scroll bars to
move through the topic.
Hiding the Table of Contents

To hide the Table of Contents, click the Help Topics button. To view the Table of Contents, click the Help Topics button.
Finding a Help Topic

In the Table of Contents, you can click one of the follow ing tabs to find a help topic:
Contents A list of the topics included in Help. You can double-click a book icon to open a list of topics. You can
double-click a page icon to open a topic.
Index An alphabetical list of the keyw ords attached to the topics. Type a keyw ord to search the list. Selecting a
keyw ord takes you to the topic.
Search A complete list of the w ords in the document.
Annotating a Topic
You can type and save notes w ithin a topic. A paperclip icon appears at the beginning of an annotated topic. You cannot print an
annotation.
Caution: W hen you upgrade your application, all annotations are lost.
To Annotate a Topic:
1. On the menu bar, click Edit and then click Annotate.
2. In the Annotate dialog box, type the information that you w ant to save w ith the topic, and then click Save.
To View or Edit an Annotation:

In the Help w indow , click the paperclip icon.
Printing a Topic
From the File menu, select Print Topic.
Click the Print button.
Right-click a topic and select Print Topic from the shortcut menu.
Changing the Font Size

From the Options menu, select Font, then click a font size.
Linking to Topic
W hen a w ord is linked to a topic, the w ord appears in green, underlined text. You can click the w ord to move to the related topic.
To go back to the topic you jumped from, click the Back button on the Help toolbar.
Viewing the Previous Topic

You can use the Back button to move to the previously view ed topic.
Viewing a Pop-up
W hen a w ord is linked to the pop-up feature, the w ord appears in green, dotted underlined text. You can click the w ord to bring
up the pop-up that gives you information related to the w ord.
Help Graphics
If you pass the cursor over a graphic in the help file, and the cursor changes to a pointing hand icon , then you can click the
area to display information related to the graphic.
8 / 79
Introduction to Process Data Add-In
The Aspen Process Data Add-in allow s you to retrieve and compute data using Aspen-provided formulas, and to provide the
results in a Microsoft Excel 2003 or 2007 w orksheet. The Process Data Add-in can use data from the InfoPlus.21, CIM/21, and
Setcim databases. Each function is an Aspen-provided formula that can be set up using the Process Data Add-in dialog boxes or
directly using the Excel w orksheet. The Process Data Add-in also offers you full Excel functionality and takes advantage of many of
the unique capabilities of the Excel application.
The Process Data Add-in provides the follow ing data functions:
Retrieve a trend or aggregate calculation for selected tags (data points) over a specified time period and to return results
to a predefined output location.
Retrieve data based on a filter condition.
Retrieve current values for the specified tags.
Retrieve attributes for the specified tags.
Copy a list of attribute names to the w orksheet.
Retrieve tag values at the selected times.
Define a data entry header on the w orksheet to read data to, or to w rite data from, the database. Define w hich data
values are used for read and w rite operations.
Set the timer to timeout for a specified time interval. Set an action to be executed w hen the timeout occurs.
Note: Some of the dialog boxes you can access using the Process Data Add-in actually use tools from other Aspen applications,
usually Process Explorer. One such example is the Aspen Tag Brow ser. You can obtain help after you open the dialog box for the
tool by clicking the Help button located on the dialog box, or by selecting the Help menu in the originating application.
See Also
Add-in Help Organization
Customer Support
Aspen Tag Brow ser
9 / 79
Add-In Help Organization
Online Help for the Process Data Add-in contains the follow ing sections:
Introduction Provides a brief overview of the Process Data Add-in.
Getting Started Describes how to start using the Process Data Add-in w ith Microsoft Excel.
Using the Process Data Add-in Contains procedures that describe how to perform various tasks in the Process Data Add-
in.
Process Data Add-in Dialog Boxes Provides a detailed description of each dialog box in the Process Data Add-in.
Process Data Add-in Functions Describes each of the data functions used in the Process Data Add-in.
Error Messages Contains a list of error messages, including Worksheet Error Messages.
For specific and detailed information, refer to the Microsoft Excel application Help. You can access Excel Help from the Excel menu
bar.
See Also
Introduction
Customer Support
10 / 79
Getting Started
Getting Started describes how to start using the Process Data Add-in w ith Microsoft Excel:
Loading the Add-In
Using Add-in Dialog Box Features
Using Excel RefEdit Controls
Making Changes to a Function After Entry
For specific and detailed information, refer to the Microsoft Excel application Help. You can access Excel Help from the Excel menu
bar.
11 / 79
Loading the Add-In
The Process Data Add-in is installed w hen you install Aspen Process Explorer. In order to use the add-in, how ever, you must load
it using Microsoft Excel 2003 or 2007.
To load the add-in using Excel 2003:

1. Launch Excel 2003.
2. Click Tools | Add-ins.
3. Select the Aspen Process Data Add-In (2003) check box.
4. Click OK. The Aspen menu appears. You w ill use the Aspen menu to access the Aspen Process Data options.
To load the add-in using Excel 2007:

1. Launch Excel 2007.
2. Click the Office button in the upper left corner.
3. Click Excel Options.
4. Click Add-Ins.
5. Be sure that Excel Add-ins is selected in the Manage box and then click Go.
6. Select the Aspen Process Data Add-In (2007) check box.
7. Click OK.
8. Use the Aspen menu to access the Aspen Process Data options.
See Also
12 / 79
Migrating from Excel 2003 Add-In to Excel 2007 Add-In
The follow ing Process Data add-in files are installed w hen you install Process Explorer:
AtData.xla - Aspen Process Data Add-In (2003)
AtData.xlam - Aspen Process Data Add-In (2007)
Add-in File Locations

Both add-ins are installed to Program Files\AspenTech\APEx\Pe\Addin. This is the recommended location from w hich to load
the add-in.
If you have Microsoft Office 2003 installed, the add-in (AtData.xla) is also installed to Program Files\Microsoft
Office\OFFICE11\Library.
If you have Office 2007 installed, the add-in (AtData.xlam) is also installed to Program Files\Microsoft Office\Office12\Library.
Using 2003 Spreadsheets with Office 2007

If you use the AtData.xla from Program Files\AspenTech\APEx\Pe\Addin on both machines, the add-in w ill already be in the
location expected by the spreadsheet. AtData.xla needs to be loaded in Excel 2007.
If you used the AtData.xla from Program Files\Microsoft Office\OFFICE11\Library on the Office 2003 machine, AtData.xla also
needs to be in the Program Files\Microsoft Office\Office12\Library directory on the Office 2007 machine (along w ith
AtData.xlam) and loaded in Excel 2007.
See Also
Loading the Add-In
13 / 79
Using Add-In Dialog Box Features
The Process Data Add-in dialog boxes can contain a number of features. W hen a feature is available on a dialog box, you can
access the feature by clicking a button. To access the main features of the Process Data Add-in you can:
Click to open the Aspen Tag Browser to drag a tag name to the w orksheet.
Click to go to a related dialog box for additional settings and selections. Refer to the related dialog box description for
specific information.
Click and to change the data orientation for output that is returned to the w orksheet. The feature button you see
indicates the data orientation that is currently selected for the output.
Note: You can set the data orientation for the Process Data Add-in using the Output tab of the Options dialog box. Refer to
the related dialog box description for specific information.
Click to move items to the Selected list. Click to move items back to the Available list.
Click or to move items up or dow n in the Selected list.
Click to set the date and time parameters for the related dialog box.
See Also
Aspen Tag Brow ser
14 / 79
Entering Data for the Add-In
The Process Data Add-in allow s you to set up data functions to retrieve data from the InfoPlus.21, CIM/21 and Setcim databases,
and to provide the results in an Excel w orksheet.
To enter a single data item using the Current Values dialog box:
Enter a single data item, for example, a tag name, into the Tags field, as show n in the Current Values dialog box.
Note: If the tag name uses the same format as an Excel cell reference location, the tag name must be enclosed in double
quotes, for example, "AT114."
OR
Drag a single data item to a field from another source. For example, you can drag a tag name from the Tag Browser directly
to the Tags field.
To enter a single cell reference location in the dialog box:

Enter a cell reference location, for example A1, into the data entry field in the dialog box.
To enter a single cell reference location in the worksheet:

1. Enter the data item you w ant to use for data entry, such as a Tag name, directly into an appropriate cell in the w orksheet.
2. Open the dialog box for the function you w ant to use and position the cursor in the data entry field. You can use Excel
RefEdit to define the cell reference location.
3. Select the cell w here the data item you entered is located (the cells become Active.) The cell reference location appears in
the data entry field.
To define a number of data cell references:

1. Type the data items you w ant to use as data, such as a list of tags, directly into an appropriate w orksheet location.
2. Open the dialog box for the function you w ant to use and position the cursor in the data entry field. You can use Excel
RefEdit to define the cell range.
3. Select the area (cells) on the w orksheet w here the items you typed are located (the cells become Active.) The cell range
appears in the data entry field.
To define output location on the worksheet:

The output location allow s you to specify the starting cell location or range, w here the results of the function are to be w ritten to
the w orksheet. W hen you first open the dialog box, the Output location initially displays the cell reference location or range of
the cells that are currently selected in the w orksheet.
1. To edit the cell reference location, open the dialog box for the function you w ant to use and position the cursor in the
Output location field. You can use Excel RefEdit to define Output location.
2. Select the cell or area (cells) you w ant to use as the Output location on the w orksheet (the cells become Active.) The cell
reference location or range appears in the data entry field.
3. You can change the data orientation for the data that is returned from the w orksheet by clicking and .
See Also
Aspen Tag Brow ser
15 / 79
Using Excel RefEdit Controls
Excels RefEdit control allow s you to select a cell or range of cells on the w orksheet and to define these cells by the cell reference
location. Refer to the Microsoft Excel applications documentation for more information.
To use RefEdit to select a cell reference location on the worksheet:

1. Position the cursor in the data entry field as show n.
2. Select a cell or range of cells from the w orksheet (the cells become Active.) The cell reference location appears in the data
entry field.
To use RefEdit Minimize button:

1. Position the cursor in the data entry field.
2. Click to minimize the dialog box using RefEdit. W hen in RefEdit control, a minimized dialog box appears on the w orksheet
as show n.
3. Select a cell or range of cells from the w orksheet (the cells become Active.) The cell reference location appears in the RefEdit
field.
Note: By default, the RefEdit control gives absolute cell references. Each time you press F4, Excel changes the reference
among all combinations of absolute and relative referencing.
4. Click to maximize the dialog box using RefEdit. The dialog box is displayed w ith the cell reference location show n in the
data entry field.
Important: Do not click the to close RefEdit. Because of problems related to Microsoft Excel , using the RefEdit close box
could cause serious problems w ith your application.
16 / 79
Formatting the Date and T ime
In the Process Data Add-in w ithin the Options dialog box, the Format tab allow s you to specify w hether the date and time values
on the w orksheet are formatted using:
W indow s system date and time settings
Current Excel w orksheet settings
The Excel w orksheet settings can be show n as numeric values, for example, 36226.35416.
As you prepare your w orksheets using the Process Data Add-in, you can change the date and time format in W indow s. You can
also change the date and time format in the Excel application.
To change the date and time format in Windows:

1. On the W indow s desktop, click Start Settings Control Panel.
2. On the Control Panel, double-click Regional Settings.
3. On the Regional Settings Properties dialog box, click the Time tab and change the time format.
4. On the Regional Settings Properties dialog box, click the Date tab and change the date format.
5. Complete the procedure, return to the W indow s desktop and continue.
For detailed instructions on formatting time, dates and other items, refer to the Microsoft W indow s Help.
To change the date and time format in Excel:

1. On an open Excel w orksheet, select the cell or cell range you w ant to format.
2. Select Format from the menu bar, and then select Cells.
3. Go to the Numbers Page.
4. From the Category list, select Date or Time.
5. From the Enter list, select the desired format such as to 12:47:00 (hh:mm:ss).
For detailed instructions on formatting dates, times, and other items, refer to the Microsoft Excel application Help.
17 / 79
Microsoft Excel calculates a function in the w orksheet on the follow ing basis:
W hen the w orksheet is opened
W hen the function is entered into a cell
W hen one of the dependencies of the function changes
W hen the cell is calculated during a macro
In contrast, there are certain functions, such as NOW() or some of the Process Data Add-in functions, that are "volatile." On the
Process Data Add-in, the Attribute Values and the Current Values functions are considered volatile. This means, the function
is calculated each time the w orksheet recalculates.
Calculation for volatile functions can be triggered:

By pressing F9.
Each time a cell value changes in the w orksheet w hen Excel is in Automatic Calculation mode.
Using the Timer feature of the Process Data Add-in.
For specific and detailed information, refer to the Microsoft Excel application Help.
18 / 79
Using Process Explorer T ools
The Process Data Add-in allow s you to use the Aspen Tag Brow ser, available in Process Explorer, to enter a tag in the dialog
boxes or on the w orksheet.
The Aspen Tag Browser allow s you to:
See tags, maps, and definition records in a list view .
Drag tags into other tools.
Search the database server you selected for one or more tags that meet certain conditions.
If you need more information, see the Aspen Tag Brow ser Help.
To open the AspenTag Browser:

Click on related dialog boxes.
OR
Select the Aspen menu from the Excel toolbar, select Process Data, then select Tag Browser menu.
See Also
Drag the data
19 / 79
Making Changes to a Function after Entry
You can make changes to an existing function using the Process Data Add-in dialog boxes or directly in the Excel w orksheet.
You can make changes to the Process Data Add-in function in any of the follow ing w ays:
Double-click on any of the cells in the output array to display the dialog box w here the function w as created. You can then
modify the data in the dialog box to change or correct your settings and selections.
Click in any of the cell(s) in the function and invoke the dialog box from the appropriate menu item. You can then modify the
data in the dialog box to change or correct your settings and selections. If you invoke the w rong dialog box, the Process
Data Add-in asks if you w ish to invoke the correct one instead.
Modify the function directly. Select any of the cells that contain the function and edit the equation displayed in the Formula
Bar above the w orksheet. After making changes to the function, press Ctrl + Shift + Enter to apply the changes to all of the
cells.
Note: If you are modifying a formula in this manner, you must modify the entire function array.
Modify the function using the Excel Formula Palette. You can click to display the Excel Formula Palette, w hich displays the
name and value of each function argument and allow s you to edit the argument values.
Note: Each time you make any changes to the value of an argument in the Formula Palette, the function results are
recalculated. This can be a lengthy operation for some of the functions. For this reason w e recommend against using the
Edit Formula feature.
20 / 79
Using the Process Data Add-in
The Process Data Add-in allows you to perform the following procedures:
Configure Options for the Process Data Add-in
Configure Settings for the Current Function
Configure Map Information for Tags
Perform Trend and Aggregate Calculations
Retrieve Filtered Trend Data
Retrieve Attribute Values
Select an Attribute List
Retrieve Current Values
Retrieve Values at the Selected Times
Perform Data Entry
Start/Stop the Timer
Use the Aspen Timeline Control
21 / 79
Configuring Options for the Process Data Add-in
The Options dialog box allow s you to customize many of the standard features of the Process Data Add-in.
Note: The options are global features that update the standard options for all of the Aspen Add-ins installed on your system.
For example, w hen you change a standard option w ithin the Process Data Add-in, you are actually changing that option for all of
the Aspen Add-ins that are in use.
For a detailed definition of the standard options for the Process Data Add-in, see Options dialog box.
To display the Options dialog box from the Excel menu bar, select Aspen | Process Data | Options.
The Options dialog box contains four tabs:
General Allow s you to set the controls for sizing output data on the w orksheet
Data Source Allow s you to select the data source (server) for the Process Data Add-in.
Output Allow s you to define the options for w riting the output data to the w orksheet:
The direction the output data flow s on the w orksheet
W hich output values are show n on the w orksheet
W hich quality values are show n on the w orksheet
Format Allow s you to specify w hether the date and time values that are returned to the w orksheet are formatted using
the W indow s system date and time settings or the current Excel w orksheet settings. It also allow s you to display asterisks
(*****) in cells containing non-existent data.
22 / 79
Configuring Settings for the Current Function
The Settings dialog box, activated by the Settings button on some dialog boxes, allow s you to define the settings for the current
Process Data Add-in function. Once defined, these settings are stored w ithin the function you are performing.
For a detailed definition of the current settings for the Process Data Add-in, see Settings dialog box.
The Settings dialog box contains up to four tabs:
Data Source Allow s you to define the data source (server) for the current function, and in w hich direction the information
for each tag is read from the w orksheet.
Output Allow s you to define the standard options for w riting output data to the w orksheet for the current function:
Format Allow s you to alter the appearance of data placed in the w orksheet.
Aggregation (where applicable) Allow s you to define the aggregate method and start option for the Trend/Aggregate
Data function. The Aggregation tab is available only w hen you select Settings from the Trend/Aggregate Data dialog box.
23 / 79
Configuring Map Information for T ags
A tag is defined as tag name, server and Map set. The tag name describes a record name in a real-time database. The server
indicates the location of this record. The map is a translation table that allow s having multiple data streams for a single tag name.
The standard w ay of defining tags (tag name, server, map) for the Process Data Add-in functions is by entering them in the
w orksheet and by using the cell range as the tag argument. In most cases server and map are optional.
The data orientation (row or column) for a tag is dependent on the Tag information setting selected. For example, if you w ant to
read the tag information in row s, specify:
One column range assumes only tag name is defined. The server and map default to the Server and Map specified in the
arguments.
Tw o-column range assumes tag name and server are defined. The map defaults to the Map specified in the arguments.
Three-column range assumes tag name, server and map are defined. Cells left blank default to the Server and Map
specified in the arguments.
For instance:
A B C
1 Tag name
Tag name2
or 2 Tag name Server

Tag name 2
or 3 Tag name Server Map

Tag name 2 Map
Tag name 3 Server
To define the default Map argument double-click the Tags: field and choose from the list that pops up. Note that, if you are
selecting multiple tags, the list contains the list of maps common to all the tags. The "Fixed" map is the database default map if
no map is specified.
24 / 79
Performing T rend and Aggregate Calculations
The Trend/Aggregate Data dialog box allow s you to retrieve a trend or aggregate calculation for selected tags over a specified
time period and to return the results to a predefined output location.
To display the Trend/Aggregate Data dialog box, click Aspen Process Data Get Data Trend/Aggregate Data.
For detailed information, see Trend/Aggregate Data dialog box and Understanding Trend and Aggregate Methods.
To set up and perform a trend or aggregate calculation:

1. Enter the Tag(s) for this function:
Enter the Tag name.
Click to open the Aspen Tag Brow ser to drag a tag name.
Enter a cell reference location or range from the w orksheet. See Entering Data for the Add-in for more information.
2. Enter a cell reference location or range from the w orksheet to indicate the Output location for the resulting values. See
Entering Data for the Add-in for more information.
3. Select the direction in w hich the resulting data is to flow into the w orksheet.
4. Select the Type of data trend or aggregate calculation you w ant to perform:
Interpolated data
Actual data
Not Good aggregate
Good aggregate
Average aggregate
Maximum aggregate
Minimum aggregate
Range aggregate
Sum aggregate
Standard Deviation aggregate
Variance aggregate
5. Enter the Period and the associated Unit value to define the period for calculating values time w ithin the Start time/End
time timespan. For example, every seven minutes.
Note: For each calculation Type, except Actual, the Period/Unit and Start time/End time are required. The Actual calculation
type does not use Period/Unit values. Instead, it uses Max number of points.
6. Enter the Start time and the End time to define the interval w ithin w hich you w ant to trend data or calculate aggregate
values.
For example, if Start time is 1:00 PM and End time 2:00 PM, and the Period/Unit is 7 Minutes, types other than Actual w ill
return data or aggregate values at 1:00 PM, 1:07 PM, 1:14 PM, 1:21 PM, 1:28 PM, 1:35 PM, 1:42 PM, 1:49 PM, 1:56 PM Data
is not provided past 2:00 PM
Note: The Period/Units cannot be longer than the Start time/End time interval you select.
7. Select the Enable Filtering check box to open the Filter tab from w hich you can retrieve data that satisfies a filter condition.
This option is unavailable for aggregate calculations and S95 Tag Aliases. Filtering is not supported for on-demand
calculations.
8. Select the Stepped display type from the pull dow n menu. There are three choices available:
On Stepped data display
Off Interpolated data display
Database Use the stepped setting defined in the data source
9. If you select Actual data as the Type, specify the maximum number of data points you w ant to return to the w orksheet. If
you specify a larger number of data points, more time may be required to retrieve the values from the data source (Blanks
are returned to any extra cells).
10. Click Settings to define settings for the current Process Data Add-in function at the Settings dialog box. Once defined,
these settings are stored w ithin the function you are performing.
Data Source
Output
Settings Dialog Box Format Tab
Aggregate
25 / 79
Understanding T rend and Aggregate Methods
The purpose of aggregate statistics, w hich underlies much of how the Aspen Process Data Add-in measures and analyzes
quantitative data, is to calculate and display attributes for individual periods. To create an aggregate calculation, one must
quantify data in periods over a time span. Thus, trend and aggregate methods used by aggregate statistics w ould allow you to
make comparisons of tags betw een periods.
For example, a request for aggregate statistics seeks one value for each period for each statistical attribute, such as measuring
average gallons of crude oil used per second in a plant recorded from 2:00 to 2:30 versus 3:00 to 3:30. Another example w ould
be measuring the range in kilow att hours of electricity needed by an automobile assembly line during each eight-hour shift
throughout July.
Process Data Add-In uses six data aggregate methods:

Value - The value aggregate method uses the actual values in history betw een a specified start time and end time. If there
is no data in history for the specified time span, the aggregated data is zero, and all of the statistics calculated from that
data is zero. The value method is used for data that is not time-sensitive, such as lab data. Because the data is not time-
sensitive, each value is given equal w eight in determining the aggregate.
For example, the follow ing figure show s the actual data points in history: 4 at 10:00, and 9 at 15:00.
The aggregated data betw een 10:00 and 18:00 is 4 and 9. Statistics are calculated on this aggregated data. For example,
the average w ould be 6.5 for the time period betw een 10:00:00 and 18:00:00.
The value aggregate method is based on a Value Aggregate calculation.
Time for CIM/21 - For CIM/21, the time aggregate method uses interpolated values at evenly spaced time steps betw een
the start time and end time. The step determines the frequency of data sampling. If there is no actual data in history for the
specified time range, the values are interpolated from data before the start time and after the end time
The shaded area represents the aggregate data. Statistics are calculated based on this area. For example, the average
w ould be 6.375 for the time period betw een 10:00:00 and 18:00:00 in the figure below .
The time aggregate method is based on a Time Aggregate calculation.

Note: For InfoPlus.21, the Time Aggregate method is identical to Integral Aggregate method.
Time for InfoPlus.21 - In InfoPlus.21, the Time Aggregate method used is the Integral Method.
Integral - The Integral Aggregate method uses the integral of the plotted trend line of data points over time (in seconds)
betw een a specified start time and end time. If there is no actual data in history for the specified time range, the values are
interpolated from data before the start time and after the end time.
For example, the actual data points in history equal 4 at 10:00 and 9 at 15:00. If the data is compressed, you can assume
that the actual values betw een these times w ere on or near the line betw een the points: 6 at 12:00, 8 at 14:00, and so on.
A line is plotted betw een the actual points, using an actual point before and/or after the period if necessary, and the area
under the curve is calculated for the time range betw een 10:00 and 18:00, as represented by the shaded area in the
follow ing figure.
The shaded area represents the aggregate data. Statistics are calculated based on this aggregate. For example, the
average w ould be 6.875 for the time period betw een 10:00:00 and 18:00:00.
The integral aggregate method is based on an Integral Aggregate calculation.
Value - Incomplete - The value - incomplete aggregation method uses actual values in history betw een a specified start
time and end time, calculating an interpolated value for an incomplete period according to InfoPlus.21 rules.
26 / 79
Integral - Incomplete - The integral - incomplete aggregation method uses the integral of the plotted trend line betw een
a specified start time and end time, calculating an interpolated value for an incomplete period according to InfoPlus.21 rules.
Note: A data table of an Integral - Incomplete aggregate w ill display a status of BAD until enough data values have been
accumulated to compute the interpolated value.
For example, the follow ing figure show s the actual data points in history: 4 at 10:00, and 9 at 15:00. If the data is
compressed, you can assume that the actual value is on or near the line or is 6 at 12:00 and 8 at 14:00, and so on. A line is
plotted betw een the actual points, and the area under the curve is calculated for the time span betw een 10:00 and 18:00,
represented by the shaded area in the follow ing figure.
The shaded area represents the aggregated data. Statistics are calculated based on this aggregation. For example, the
average w ould be 6.875 for the time period betw een 10:00:00 and 18:00:00.
Note: The aggregate data passed back from the server and displayed in Process Explorer differs only in the timestamp from
the data retrieved in SQLplus. The timestamp differs by a period betw een the tw o applications. Process Explorer returns
timestamps only at the start of the period.
See Also
Understanding Steps
27 / 79
In statistical calculations, you must specify a period. In each period, the data is aggregated based on the specified method, the
statistical calculation is made on the aggregated data, and a single value is returned.
For example, the follow ing figure show s the actual data points in history: 4 at 10:00, and 5 at 11:00, and 6 at 12:00, and so on.
The aggregate period is 60 minutes.
The statistical calculations for 10:00:00 to 18:00:00 w ould return eight values (one for each 60-minute period). In this example,
the average returned for period 1 w ould be 4.5, for period 2 w ould be 5.5, and so on. W hen the data is plotted, it must be
assigned a timestamp. The anchor specifies the timestamp of the value. The anchor can be the beginning, middle, or end of each
aggregation period. For example, if you request the one-hour averages of data and the anchor is beginning, w hen the data is
plotted, the data point for each one-hour average is plotted at the beginning of the hour. The anchor is set by default to the
beginning of the time period.
See Also
Understanding Steps
28 / 79
Understanding Steps
The time aggregate method for CIM/21 requires a step. This method should be used w ith uncompressed data, and the step
should correspond to the frequency of data sampling. For example, if data is sampled every minute and the data has not been
compressed, you know that every minute a new value is added to history, and the value remains constant for one minute.
The follow ing figure show s the actual data points in history: 4 at 10:00, 5 at 11:00, 6 at 12:00, and so on. In this example, the
step for both the aggregate method and the trending method should be 1 hour. The shaded area represents the aggregated
data.
Note: A period must be equal to or greater than a step.

The follow ing figure show s the actual data points in history: 4 at 10:00, 5 at 11:00, 6 at 12:00, and so on. In this example, the
step is 1 hour and the period is 2 hours; in each period, a single statistical calculation is made, and Process Explorer plots four
values.
See Also
29 / 79
The Attribute Values dialog box creates a function that retrieves attribute values for the specified tags.
To display the Attribute Values dialog box, select the Aspen menu from the Excel menu bar. Select Process Data, select Get
Data, then select Attribute Values.
For detailed information, see Attribute Values dialog box.
To retrieve attribute values:

1. Enter the Tag(s) for the function:
Enter the Tag name.
2. Enter a cell reference location or range from the w orksheet to indicate the output location for the resulting values. See
4. Enter the Attributes you w ant to retrieve:
Enter the tag attribute.
Enter a cell reference location or range from the w orksheet. The range must be either one row only or one column only
(tw o-dimensional arrays are not supported). Click to select Attributes from the Select Attribute List dialog box and
place them in the w orksheet.
See Also
30 / 79
The Select Attributes List dialog box allow s you to copy a list of attribute names to the w orksheet. The attribute location is
returned to the Attribute Values dialog box.
To display the Select Attributes List dialog box, click on the Attribute Values dialog box.
For detailed information, see Select Attribute List dialog box.
To select tag attributes:

1. Enter a cell reference location or range from the w orksheet to indicate the Attribute location for the resulting values. See
3. Select the tag attributes you w ant to copy to the w orksheet from the Available list and move these to the Selected list.
Note: The Tag selected displays the tag name for w hich you are retrieving attributes, or the cell reference location or range,
as show n in the Attribute Values dialog box.
31 / 79
The Current Values dialog box allow s you to retrieve current values for the specified tags.
To display the Current Values dialog box, select the Aspen menu from the Excel menu bar. Select Process Data, select Get Data,
then select Current Values.
For detailed information, see Current Values dialog box.
To retrieve current values:

Enter the Tag name.
2. Enter a cell reference location or range from the w orksheet to indicate the output location for the resulting values.
32 / 79
Retrieving Filtered T rend Data
The Filter tab allow s you to set specific criteria for the data that is retrieved. You can use the filter feature only w ith interpolated
and actual calculation types on trend data. The Filter tab is unavailable for aggregate data. Filtering is not supported for on-
demand calculations.
To retrieve filtered trend data

1. Check Enable Filtering on the Trend/Aggregate Data dialog box.
2. Click the Filter tab on the Trend/Aggregate Data dialog box. The Filter tab is displayed.
3. Enter a tag name in the Tag textbox:
Type the tag name. Only one tag can be entered in the Tag text box at a time.
To enter multiple tags, enter a cell reference location from the w orksheet. For more information, see Entering Data for the
Add-in and Using Excel RefEdit controls.
4. Select a mathematical operator from the Operator list.
5. Enter an appropriate tag value in the Value textbox:
Type the tag value. Only one tag value can be entered in the Value text box at a time.
To enter multiple tag values, enter a cell reference location from the w orksheet. For more information, see Entering Data
for the Add-in and Using Excel RefEdit controls.
Note: The condition is displayed in the format Tagname Operator Value. You cannot manually enter conditions. To
manually enter filter conditions see, ATGetFltData function.
6. For additional filters: if additional Tag-Operator-Value filters are needed, select an entry cell from the grid. Each row is a
logical AND comparison that is subsequently compared to all additional row s using the OR comparison. For example, a tw o-
by-tw o grid of cells, AB and CD corresponds to the expression: (A AND B) OR (C AND D). The cells automatically expand
to leave a blank row and column at the end for future comparisons.
7. Click OK.
Note: Filter conditions are saved as strings. It is not possible to have a cell reference that triggers a formula w hen
changed.
See Also
Trend/Aggregate dialog box Filter Tab
AtGetFltData function
33 / 79
Retrieving Values at the Selected T imes
The Values at Times dialog box allow s you to retrieve tag values at the selected times.
To display the Values at Times dialog box, click Aspen Process Data Get Data Values at Times.
For detailed information, see Values at Times dialog box.
To retrieve values at the given times:

Enter the Tag name.
Click to open the Aspen Tag Brow ser, from w hich you can drag a tag name.
Enter a cell reference location or range from the w orksheet, see Entering Data for the Add-in for more information.
2. Enter a cell reference location or range from the w orksheet to indicate the Output location for the resulting values. See
4. Set the Times (or time) at w hich to retrieve the tag values:
Enter the time
Note: You can also use the Relative Time format to define the time.
Click to select a time using the Set Time dialog box.
Enter a cell reference location or range containing times from the w orksheet. The range must be either one row only or
one column only (tw o-dimensional arrays are not supported). See Entering Data for the Add-in for more information.
5. Select the Type of tag values you w ant to retrieve from the database to return to the w orksheet:
Interpolated
Actual
See Also
Aspen Tag Brow ser
Relative Time
Set Time dialog box
34 / 79
The Data Entry Setup dialog box allow s you to:

Define a data entry header on the w orksheet to read data to, or w rite data from, the database.
Define w hich data values are used for read and w rite operations.
Note: Your system configuration may not allow you to w rite to the database. See your System Administrator for details.
To display the Data Entry Setup dialog box, select Aspen Process Data Data Entry Setup from the Excel menu bar.
To setup the data entry header:

1. Select the database server from w hich you w ant to select data. If a server is not specified, the Default server is used as
the data source.
2. Enter a cell reference location or range from the w orksheet to indicate the Output location for the data entry header values.
See Entering Data for the Add-in for more information.
4. Select the items you w ant to include on the w orksheet.
The function creates a data entry header on the w orksheet. A heading is created for each checked item under Select items.
To read data from the database:

1. Complete the first procedure, "To setup the data entry header."
2. Enter one or more tag names under the Tag heading. (You can define a tag more precisely by entering the Server name and
Map name only if these w ere selected on the header).
3. Select Aspen Process Data Data Entry Read Data.
For each heading in the data entry header, current values are displayed. If there is no data for one of the headings, a blank
is returned. The Result area displays a return code indicating the success or failure of a read or w rite operation.
To write data to the database:

1. Setup the data entry header as described in this topic.
2. Enter one or more tag names under the Tag heading. (You can define a tag more precisely by entering the Server name and
Map name only if these w ere selected on the header).
3. For each heading in the data entry header, type the value that you w ant to w rite to the database.
Note: The Level is determined from the quality quality status, you cannot enter a Level directly into the database.
4. Select Aspen Process Data Data Entry Write Data.
5. The Result area displays a return code indicating the success or failure of a read or w rite operation.
For System Administrators: Security restrictions may require you to belong to a specific security role to allow w rite
privileges.
See Also
Data Entry Setup dialog box
35 / 79
Starting/Stopping the T imer
The Start Timer dialog box allow s you to:

Set a timer to time out at a specified time interval.
Set an action to execute w hen the timeout occurs.
Choose to preserve the timer settings in the w orkbook and automatically activate the timer w hen the w orkbook is
reopened.
Remove the timer settings from the w orkbook if they w ere previously recorded there.
Note: You can also call Start Timer or Stop Timer from the w orksheet by selecting Start Timer or Stop Timer from the
context menu.
To start the timer:
1. Display the Start Timer dialog box by selecting Aspen Process Data Start Timer.
2. Enter the time interval to w ait betw een actions in hh:mm:ss format.
3. Select the Action to perform w hen the timeout occurs:
Recalculate sheets.
Display current time in cell. You can edit the cell reference location.
Call macro. If you w ant to run an Excel macro, enter the name of the Excel macro you w ant to execute.
To stop the timer:

1. Select the Aspen menu from the Excel menu bar.
2. Click Process Data Stop Timer.
Notes:
It may take one time interval for the timer to stop.
The Timer does not maintain its settings w hen you close Excel. Once you close Excel, the Timer settings return to their
defaults.
To preserve the timer settings:

1. To display the Start Timer dialog box, click Aspen Process Data Start Timer.
2. Enter the time interval to w ait betw een actions in hh:mm:ss format.
3. Select the Action to perform w hen the timeout occurs:
Recalculate sheets.
Display current time in cell. You can edit the cell reference location.
Call macro. If you w ant to run an Excel macro, enter the name of the Excel macro you w ant to execute.
4. Check the Automatically start Timer when workbook is reopened. Timer information is recorded in the workbook box.
Note: This w ill w rite the timer information to the w orkbook. Save your w orkbook before you close it.
To remove previously saved timer settings:
1. To display the Start Timer dialog box, click Aspen Process Data Start Timer.
2. Check the Remove timer information from this workbook. Timer will not automatically start when workbook is
reopened box.
Note: This only w orks if you have preserved the timer settings previously.
See Also
Start Timer Dialog Box
36 / 79
Using the Aspen T imeline Control
The Aspen Timeline control allow s you to w rite a start time and end time to the w orksheet. W hen you retrieve data, you can
change or update the Start time and End time using the Aspen Timeline control. The start time and end time values can be
referenced by the functions that are accessible from the Get Data selection on the Process Data menu.
To display the Aspen TimeLine dialog box, select the Aspen menu from the Excel menu bar. Click Process Data Show Timeline.
Note: You can click the right mouse w hile on the w orksheet to select the Aspen Timeline from the context menu.
To set the start and end times:
1. Click in a blank cell or a cell that contains a timestamp. The Aspen Timeline control inserts the Start time in the cell that you
select, and the End time in the cell to the right.
2. Display the Aspen Timeline control.
3. Select the Update mode:
Click Manual to update the data manually. Each time you click Apply, the Start time and End time are updated on the
w orksheet.
Click Automatic to automatically update the Start time and End time on the w orksheet based on the selected Timeline
update frequency. The updates stop w hen you close the Aspen Timeline control.
Note: Automatic update is not recommended for large array sizes, w here the amount of time required to update the
w orksheet matches or exceeds the Automatic update frequency.
See Also
Aspen Timeline Control
37 / 79
Creating and Executing Calculations
Process Data Add-in allow s you to create and execute "on the fly" calculations in a feature called "On-Demand Calculations." This
feature consists of the Ad-Hoc Calculations and Stored Calculations components of Aspen Calc.
Note: See On-Demand Calculations for more information.
38 / 79
Use the Attribute Values dialog box to create a function that retrieves attribute values for the specified tags.
Settings Click Settings to:
Define the Process Data database server you w ant to use as the data source or the Tag direction for the current function
using the Data Source tab of the Settings Dialog Box.
OR
Indicate w hich values you w ant to return to the w orksheet for the current function using the Output tab of the Settings
dialog box
Tags Enter the Tag name.
Enter a cell reference location or range from the w orksheet.
Use the elements under Tags to select tags for the w orksheet. You can enter the Tag name in the Tags field or you can click
to open the Aspen Tag Brow ser to drag a tag name.
Output location Enter a cell reference location or range from the w orksheet to indicate the output location for the resulting
values. This field initially displays the cell reference location or range of the cells that are currently selected in the w orksheet.
The range must be either one row only or one column only (tw o-dimensional arrays are not supported).
Select the direction in w hich the resulting data is to flow into the w orksheet:
displays tag data in columns.
displays tag data in row s.
Attributes Use the elements under Attributes to select attributes for the selected tags.
Enter the tag Attribute in the Attributes field or click to select attributes from the Select Attribute List dialog box and
place them in the w orksheet.
Use S95 Tag Aliases Check this box to use S95 Tag Aliases, rather than tags
See Also
Select Attribute List Dialog Box
Settings Dialog Box Data Source Tab
Settings Dialog Box Output Tab
39 / 79
Select Attribute List Dialog Box
The Select Attributes List dialog box allow s you to copy a list of attribute names to the w orksheet. The cell reference to the
attributes is then returned to the Attribute Values dialog box.
Tag selected Displays the tag name for w hich you are retrieving attributes, or the cell reference location or range from
the Attribute Values dialog box for your convenience.
Attribute location Enter a cell reference location from the w orksheet to indicate the Output location for the resulting
values.
fills the cells dow n. The attributes are placed in one column.
fills the cells to the right. The attributes are placed in one row .
Attributes Select the tag attributes you w ant to copy to the w orksheet from the Available list and move these to the
Selected list.
Available Lists all of the attributes Available for selection.
Selected Lists the attributes you have selected to copy to the w orksheet.
Click to move items to the Selected list. Click to move items back to the Available list.
Click or to move items up or dow n in the Selected list.
See Also
40 / 79
Current Values Dialog Box
The Current Values dialog box allow s you to retrieve current values for the specified tags.
Define the Process Data database server you w ant to use as the data source or the tag direction for the current function
using the Data Source tab of the Settings dialog box.
OR
dialog box.
Output location Enter a cell reference location or range from the w orksheet to indicate the Output location for the resulting
fills the cells dow n. Each tag creates a new column of data.
fills the cells to the right. Each tag creates a new row of data.
See Also
41 / 79
Data Entry Setup Dialog Box
The Data Entry Setup dialog box allow s you to:

Define a data entry header on the w orksheet to read data to, or w rite data from, the database.
Define w hich data values are used for read and w rite operations.
Note: Your system configuration may not allow you to w rite to the database.
Select the data source from w hich you w ant to access data in the Default server drop-dow n list. If you do not specify a
server, the data source <Any> is used. <Any> searches the list of data sources for the first instance of the specified tag. If
you specify a new Default server, then data is accessed from a new data source.
Select an output location. Enter a cell reference location or range from the w orksheet to indicate the Output location for the
resulting values. W hen you first open the dialog box, the Output location box initially displays the cell reference location or
range of the cells that are currently selected in the w orksheet.
Select the check boxes representing the items you w ant to appear in the data entry header on the w orksheet. Your choices
include:
Tag The tag name. This is required.
Server Allow s data from a number of data sources to be accessed. Used in place of the default server.
Map Select a map to access custom fields.
Time Specifies the time for the Value. The default time is the current time.
Value Specifies the data value.
Status The quality status.
Level (read only) The quality level.
Result Displays a result return code indicating the success or failure of a read or w rite operation.
See Also
42 / 79
Start T imer Dialog Box
The Start Timer dialog box allow s you to:

Set a timer to time out at a specified time interval.
Set an action to execute w hen the timeout occurs.
Choose to preserve the timer settings in the w orkbook and automatically activate the timer w hen the w orkbook is
reopened.
Remove the timer settings from the w orkbook if they w ere previously saved there.
Note: To start the timer, click Aspen Process Data Start Timer. W hen the Start Timer dialog box is displayed, the
status of the timer either active (running) or inactive (not running) is also displayed in the title of the dialog box. For
instance, an active timer means that the title of the dialog box is Start Timer Active; an inactive timer means the dialog
box title is Start Timer Inactive.
Dialog Box Elements:
Interval Enter the time Interval betw een actions in hh:mm:ss format.
Action An Action is a user-selected event that is regularly performed w hen the specified time Interval is reached. You can
select any of the three available actions:
Recalculate sheets Recalculates all cells in the w orksheet.
Note: Standard (non-volatile) functions, such as the trend or aggregate data functions, do not recalculate unless a
reference to the function has changed.
Display current time in cell Displays the current time in the cell specified in the text box. You can edit the cell reference
location.
Call macro Run the Excel macro you specify. Enter the name of the Excel macro you w ant to execute in the Call Macro box.
Set Startup [Workbook Filename] Select one of tw o checkboxes to either automatically activate the timer and save the
timer settings to the w orkbook w here the timer information is recorded or to not automatically activate the timer and delete
the settings from the w orkbook w hen you close Excel:
Automatically start Timer when workbook is reopened. Timer information is recorded in the workbook –
Automatically activate the timer w hen the w orkbook is opened. Timer settings are saved to the w orkbook and the settings
are available w hen the w orkbook is reopened.
Remove timer information from this workbook. Timer will not automatically start when workbook is reopened –
Delete timer settings w hen you close the w orkbook and do not automatically activate the timer.
Notes:
The Remove timer information from this workbook. Timer will not automatically start when workbook is reopened check
box is unavailable if no timer information is added to the w orkbook.
Selecting one of the tw o check boxes is optional, but if you choose to select one check box, it makes the other check box
unavailable. If you choose neither check box, then you do not w ant to either automatically activate the timer and save the
timer settings or to not automatically activate the timer and delete the settings.
See Also
Starting/Stopping the Timer
43 / 79
T rend/Aggregate Data Dialog Box
The Trend/Aggregate Data dialog box allow s you to retrieve a trend or aggregate calculation for selected tags (data points) over
a specified time period and to return the results to a predefined output location.
For procedural information, see Performing Trend and Aggregate Calculations.
Tags Enter a Tag name using one of the follow ing methods:
Type the desired tag name.
values. By default, the Output location uses the cell reference location or range of the cells that are currently selected in the
w orksheet.
To select the direction in w hich the resulting data is to flow into the w orksheet:
fills the cells dow n. Each tag creates a new column of data based on time, from oldest time on top to most recent time on
bottom.
fills the cells to the right. Each tag creates a new row of data based on time, from oldest time on the left to most recent
time on the right.
Calculations
Type Select the type of data trend or aggregate calculation you w ant to perform:
Interpolated
Actual
Not Good
Good
Average
Maximum
Minimum
Range
Sum
Standard Deviation
Variance
Note: For each calculation type, except Actual, the Period/Unit and Start time/End time is required. The calculation type
Actual uses Max number of points instead.
Period Select the Period (number of Units) you w ant to use to calculate interpolated data or aggregate values.
The Period and the associated Unit value define the period w ithin the Start time/End time, during w hich you w ant to
retrieve data. For example, if Start time is 1:00 PM and End time 2:00 PM, and the Period/Unit is 21 minutes, types other
than Actual w ill return data or aggregate values at 1:00 PM, 1:21 PM, and 1:42 PM Data is not provided past 2:00 PM
Note: The Period/Units cannot be longer than the Start time/End time interval you select.
Units Select the Units (of measure) you w ant to associate w ith the Period:
Seconds
Minutes
Hours
Days
Start time The Start time and the End time define the interval w ithin w hich you w ant to retrieve data values.
Enter the Start time to indicate at w hat time you w ant to begin the query.
Click to set Start time and End time using the Set Time Range dialog box.
End time Enter the End time to indicate at w hat time you w ant to end the query.
Click to set Start time and End time using the Set Time Range dialog box.
Stepped Select this option to choose w hether data is displayed as steps or as an interpolated slope:
On Stepped data display
Off Interpolated data display
Database Use the stepped setting defined in the data source
Note: If the data source has no stepped setting defined, data w ill be displayed as interpolated.
Enable Filtering Opens the Filter tab from w hich you can retrieve data that satisfies a filter condition. This option is unavailable
for aggregate calculations or S95 Tag Aliases. Filtering is not supported for on-demand calculations.
Note: Filter conditions are saved as strings. It is not possible to have a cell reference that triggers a formula w hen changed.
Max. number of points For the Actual Type selection only, specify the maximum number of data points you w ant to return to
the w orksheet. If you specify a larger number of points, more time may be required to retrieve the values from the database
server. (Blanks are returned to any extra cells).
44 / 79
Settings Click to open the Settings dialog box, w here you can define settings for the current Process Data Add-in function. Once
defined, these settings are stored w ithin the function you are performing.
Data Source
Output
Settings Dialog Box Format Tab
Aggregate
Note: The Aggregate tab appears only w hen you select Settings from the Trend/Aggregate Data dialog box.
See Also
Relative Time
Trend/Aggregate Data Dialog Box Filter Tab
45 / 79
T rend/Aggregate Data Dialog Box Filter T ab
The Filter tab allow s you to set specific criteria for the data that is retrieved. The Filter tab is available w hen Enable filtering is
checked on the Trend/Aggregate Data dialog box. You can only use the filter feature w ith interpolated and actual calculation
types on trend data. The Filter tab is unavailable for aggregate data. Filtering is not supported for on-demand calculations.
Tag Enter a tag name or click to use the Refedit control to select a tag name directly from an Excel w orksheet. The
function w ill use the tag name as the tags value in conditions.
Note: For actual calculation types a tag name cannot be selected from the w orksheet. The tag name used in the Filter tab
must be the same as the tag name in the Trend/Aggregate Data dialog box. The Actual type does not support filtering for
multiple tags.
Operator Enter a mathematical operator or click the Operator box to select from a list of operators.
Value Enter an appropriate value for the tag or click to use the Refedit control to select a tag value directly from an
Excel w orksheet.
Notes:
The condition is displayed in the format Tagname Operator Value. You cannot manually enter conditions. To manually enter
filter conditions see, ATGetFltData function.
Filter conditions are saved as strings. It is not possible to have a cell reference that triggers a formula w hen changed.
Localized decimal separators are not supported in the Add-In; you must use the "." character.
See Also
Retrieving Filtered Trend Data
ATGetFltData
46 / 79
Values at T imes Dialog Box
The Values at Times dialog box allow s you to retrieve tag values at the selected times.
Define the Process Data database server you w ant to use as the data source or the Tag direction for the current function
using the Data Source tab of the Settings dialog box.
Note: If the data source (or server) name includes a hyphen (-), enclose the data source (or server) name in braces. For
example, {server-name}.
dialog box.
fills the cells dow n. Each tag creates a new column of data.
fills the cells to the right. Each tag creates a new row of data.
Times Set the times (or time) at w hich to retrieve the tag values:
Enter the time.
Click to select a time using the Set Time dialog box.
Enter a cell reference location or range containing times from the w orksheet. The range must be either one row only or one
column only (tw o-dimensional arrays are not supported).
W hen using the Values at Times function to retrieve a value for a tag in a specific point in time in Process Data Add-in, you
now have tw o choices of values w hen using Process Data Add-in: Interpolated or Actual.
Type Select the Type of tag values you w ant to retrieve from the database to return to the w orksheet. You can choose one of
tw o types of values:
Interpolated
Actual
See Also
Entering Data for the Add-In
Set Time Range Dialog Box
47 / 79
Options Dialog Box
The Options dialog box allow s you to customize many of the standard features of the Process Data Add-in.
Note: The options are global features that update the standard options for all of the Aspen Add-ins installed on your system.
For example, w hen you change a standard option w ithin the Process Data Add-in, you are actually changing that option for all of
the Aspen Add-ins that are in use.
The Options dialog box contains four tabs:
General
Data Source
Output
Format
48 / 79
Options Dialog Box General T ab
The General tab allow s you to set controls for sizing the output data on the w orksheet
Formula Creation:
Automatically size output if one cell is selected Check this box to allow the dialog to expand the output range on the
w orksheet to accommodate the output. The direction of the output is defined according to the Fill cells option in the Output
tab.
If this setting is checked, enter the top left cell location of the desired output range in the Output location in a related dialog
box and the range is expanded automatically.
Warn if selected range is too small to fit data area Check this box if you w ant to receive a w arning w hen the required
output range is different in size or shape from the Output Location you selected in a related dialog box.
If the box is blank or if you check Don't ask me again on the Output Location Mismatch dialog box, your output is placed in
the output range you selected.
Warn before overwriting sheet contents Check this box if you w ant to receive a w arning w hen you select an output
range on the w orksheet and text or formulas, either partially or fully, already fill the output range.
If the box is blank or if you check Don't ask me again on the Overwrite Warning dialog box, you do not receive a w arning
and your output data immediately overw rites the existing data.
See Also
Options Dialog Box Output Tab
Output Location Mismatch Dialog Box
Overw rite Warning Dialog Box
49 / 79
Options Dialog Box Data Source T ab
The Data Source tab allow s you to select the data source (server) for the Process Data Add-in.
Server Select the database server you w ant to use as a data source from the list of available servers. The Process Data Add-in
can use data from the InfoPlus.21, CIM/21, Setcim, PI, PHD, and RDBMS databases. The default value for the server is <Any>,
w hich searches the list of data sources for the first instance of the specified tag.
Use IP.21 Process Browser Server If you are using the Process Data Add-In on an Aspen IP.21 Process Brow ser client, check
this box to retrieve data via the IP.21 Process Brow ser server.
WebServer Specify the HTTP address of the Aspen IP.21 Process Brow ser server (as HTTP:https://<Server> ) and click Set.
S95 WebServer Specify the HTTP address of the S95 Web Server (as HTTP:https://<Server> ) and click Set.
Tip: The S95 WebServer can exist independently of the IP.21 Process Brow ser server. If you do not need to resolve S95 tag
aliases, you do not have to specify an S95 WebServer.
Notes:
You can click the Settings button on related dialog boxes to change these options for the current function using the Data
Source tab of the Settings dialog box.
The Process Data Add-In on a Aspen IP.21 Process Brow ser-only client cannot w rite to InfoPlus.21 v2.5.1 or SetCim
databases.
W hen used w ith a BPC data source, Aspen Process Explorer supports only the BPC default class and the BPC Tag Alias class.
Custom and other classes w ill not resolve.
See Also
50 / 79
Options Dialog Box Output T ab
The Output tab allow s you to define the options for w riting output data to the w orksheet:
W hich direction the output data flow s on the w orksheet
These options apply to all of the Process Data Add-in functions, w ith the exception of the Attribute Values function, w hich does
not use the Show quality options.
Note: You can click the Settings button on related dialog boxes to change the Fill Cells, Show , and Show Quality options for the
current function using the Data Source tab of the Settings dialog box.
Field Definitions
Fill cells Select the standard direction (data orientation) in w hich the resulting data is to flow into the w orksheet for all
new functions:
Down Click to w rite data dow n in columns, from the starting cell of the Output location specified in the function. The
button is displayed.
For example, if cell A3 is entered as the starting Output location on the w orksheet, the first value is returned to cell A3 and
subsequent values for that tag for later times are returned to cells A4, A5 and so on. Refer to the related dialog box
description for specific information that describes how the data orientation performs in the function.
Right Click to w rite data in across in row s, from the starting cell of the Output location specified in the function. The
button is displayed.
For example, if cell A3 is entered as the starting Output location on the w orksheet, the first value is returned to cell A3 and
subsequent values for that tag for later times are returned to cells B3, C3 and so on. Refer to the related dialog box
description for specific information that describes how the data orientation performs in the function.
Note: You can click and to change the data orientation for the output of the current function.
Show Check w hich values you w ant to display on the w orksheet. For example, check Server to show the server name on
the w orksheet, or check Time to show the time value on the report, and so on.
Tag Name Displays the tag name.
Server Displays the name of the data source.
Map Displays the map used.
Time Displays the time.
Value Displays value.
Note: For Aggregate values, the Value column header in the w orksheet displays the aggregate period. For example,
the column header for a fifteen-minute aggregate period is displayed as 15m.
Show quality Define w hich quality values you w ant to display on the w orksheet:
Note: The Show quality settings do not apply to the Attribute Values function.
Level Check to display the quality Level. A quality Level is a value inferred from the quality Status. Based on the quality
status of a data value, the quality level indicates w hether the data is good, bad or suspect. This allow s you to determine
w hich values you can use in the w orksheet or in the calculations.
If you check Level, select the format in w hich you w ant this value listed:
As a number This returns a number that corresponds to the Level values; good, bad and suspect. For more
information, see your System Administrator.
As text In this case, the Level value displays: "Good", "Bad" and "Suspect."
Status Check to display the quality Status. The Status acts as a qualifier on a data value and is recorded in the database.
For example, w hen a value reaches its Low_Low_Limit , the value receives a status qualifier of bad. A value w ithin its
acceptable limit range receives a status value of good. The quality Status is a helpful tool for troubleshooting purposes
since it allow s you to know the reason a process value is considered good, bad or suspect.
If you check Status, select the format in w hich you w ant this value listed:
As a number See your System Administrator for numerical Status values.
As text See your system administrator for text Status values.
See Also
51 / 79
Options Dialog Box Format T ab
The Format tab allow s you to specify w hether the date and time values that are returned to the w orksheet are formatted using
the W indow s system date and time settings or the current Excel w orksheet settings.
Format cells that contain date-time values with Windows date and time settings Check to format the date and time values
that are returned to the w orksheet using the W indow s system date and time settings. Format other values using general Excel
format.
For example, if you select date and time to be returned as a result in the w orksheet and this option is checked, the column or row
of cells containing the date and time result are formatted using the W indow s system date and time settings.
If checked, all other cell formatting in the range of cells occupied by the function is removed.
If unchecked, the current formatting on the w orksheet is not changed. If you do not select this option, date and time values
are returned as a number that you can format using Excel. For example, 36167.4583 for 11:00 AM on January 7, 1999.
Show ***** instead of blank for non-existent data Select this check box to show asterisks (*****) in cells containing no
returned data. Clear this check box to show nothing in cells containing no returned data.
Values As Strings W hen this check box is selected, values are returned to the w orksheet as strings. This is the default setting.
Clear this check box to return raw values.
Note: Clear this checkbox to view data using localized (non-US English) formats.
See Also
52 / 79
Settings Dialog Box
The Settings dialog box, activated by the Settings button on some dialog boxes, allow s you to define settings for the current
Process Data Add-in function. Once defined, these settings are stored w ithin the function you are performing.
Data Source
Output
Format
Aggregation
Note: The Aggregate tab appears only w hen you select Settings from the Trend/Aggregate Data dialog box.
53 / 79
Settings Dialog Box Data Source T ab
The Data Source tab allow s you to define the follow ing settings for the current function:
Data source (server) settings.
The direction in w hich the output data is to flow into the w orksheet
Dialog Box Elements

Set as Default Click to save the current settings as the standard option for the Process Data Add-in. Set as Default
changes the value set up in the Data Source tab of the Options Dialog box.
Server Select the data source you w ant to use from the list of available servers. The Process Data Add-in can use data
from the InfoPlus.21, CIM/21, Setcim, PI, PHD, and RDBMS databases. The default value for the server is <Any>, w hich
searches the list of data sources for the first instance of the specified tag.
Note: W hen used w ith a BPC data source, Aspen Process Explorer supports only the BPC default class and the BPC Tag
Alias class. Custom and other classes w ill not resolve.
Tag information Select the direction (data orientation) for reading Tag, Server, Map information (Server and Map are
optional) from the w orksheet:
Read the information for each tag in rows, across Click to read the data from left to right.
Read the information for each tag in columns, down Click to read the data from top to bottom.
See Also
Options Dialog Box Data Source Tab
54 / 79
Settings Dialog Box Output T ab
The Output tab allow s you to configure settings for w riting the current function output data to the w orksheet. The settings you
configure here determine w hich values are show n on the w orksheet for output and quality.
Note: These options apply to all of the Process Data Add-in functions, w ith the exception of the Attribute Values function, w hich
does not use the Show quality options.
Dialog Box Elements
Set as Default Click to save the current settings as the standard option for the Process Data Add-in. Set as Default
changes the value set up in the Output tab of the Settings dialog box.
Show Check w hich values you w ant to display on the w orksheet. For example, check Server to show the data source
name on the w orksheet, check Time to show the time value on the report, and so on.
Tag Name Displays the tag name.
Server Displays the name of the data source.
Map Displays the map used.
Time Displays the time.
Value Displays value.
Note: For Aggregate values, the Value column header in the w orksheet displays the aggregate period. For example,
the column header for a fifteen-minute aggregate period is displayed as 15m.
Show quality Define w hich quality values you w ant to display on the w orksheet:
Note: The Show quality settings do not apply to the Attribute Values function.
Level Check to list the quality Level. A quality Level is a value inferred from the quality status. Based on the quality
status of a data value, the quality level indicates w hether the data is good, bad or suspect. This allow s you to determine
w hich values you can use in the w orksheet or in the calculations.
If you check Level, select the format in w hich you w ant this value listed:
As a number This returns a number that corresponds to the Level values; good, bad and suspect. For more
information, see your System Administrator.
As text In this case, the Level value displays: "Good", "Bad," and "Suspect."
Status Check to list the quality Status. The Status acts as a qualifier on a data value and is recorded in the database. For
example, w hen a value reaches its Low Limit, the value receives a status qualifier of bad. A value w ithin its acceptable limit
range receives a status value of good. The quality Status is a helpful tool for troubleshooting purposes since it allow s you
to know the reason a process value is considered good, bad or suspect.
If you check Status, select the format in w hich you w ant this value listed:
As a number See your System Administrator for numerical Status values.
As text your system administrator for text Status values.
See Also
Options Dialog Box Output Tab
55 / 79
Settings Dialog Box Format T ab
Use the Format tab to alter the appearance of data placed in the w orksheet.
Show single times row/column show s only one row or column of times for all tags in the w orksheet. Clear the checkbox
to show a row or column of times for each tag in the w orksheet.
Paste data only provides data w ithout formula.
Show data in descending time order arranges Trend/Aggregate data in descending time order. Clear the check box to
arrange retrieved data in ascending time order.
Retrieve data in descending time order applies only to actual data. Select the check box to retrieve data w ithin the
specified time range in descending time order. Clear the check box to retrieve data in ascending time order. For example,
selecting a start time of 4:00, an end time of 5:00 and 10 max. number of points from the Trend Data dialog box w ill
retrieve the last 10 values in the range.
56 / 79
Settings Dialog Box Aggregation T ab
The Aggregation Tab allow s you to define the aggregation calculation method and start option for the current function.
Note: The Aggregation tab is available only w hen you select Settings from the Trend/Aggregate Data dialog box.
Aggregation
Method Select the calculation Method you w ant to use:
Integral The Integral method calculates aggregate values from the integral of a plotted trend line w hich connects data
points betw een the start time and end time of each period. If Actual data for the specified time span is not available in
history, the trend is interpolated from data before the start time and after the end time.
Time For InfoPlus.21, the Time aggregate method is ignored and the Integral method is used.
For CIM/21, the Time method calculates aggregate values from tag values interpolated at evenly spaced steps in time.
The time interval betw een interpolated tag values is selected by the Step value in this dialog. The time span of each
period must be evenly divisible by the step interval betw een interpolated tag values. For example, a 7 minute
interpolation step is incompatible w ith 1 hour periods because one hour does not contain a w hole number of 7 minute
steps. If no actual data is available for the requested time span, interpolation is based on data before the start time and
after the end time.
Value The Value method calculates aggregate statistics from the Actual values in history betw een the start time and end
time of each period. If history contains no data for a period, all of the statistics for that period are zero.
Step CIM/21 requires a Step w hich specifies the frequency of data sampling used w ith the Time aggregate method. For
example, if you sample data every minute, the trend of that data has a "stepped" appearance, because the value changes every
minute, but remains flat betw een values.
Note: This value does not apply to InfoPlus.21 databases.

Units For CIM/21 Time method, select one of the follow ing Units to use in conjunction w ith the Step value.
Seconds
Minutes
Hours
Days
Note: This value does not apply to InfoPlus.21 databases.
Start option In statistical calculations you must specify w hether you w ant the period to be based on the start of day or the
start time:
Start of day Click to align the first period w ith the start of day specified in the database (for example, 00:00:00). For
example, suppose you specify a period of 10 minutes in the Trend/Aggregate Data dialog box and the Start time is
08:12:00. In this case, the first period for w hich data is calculated begins at 08:10:00 and ends at 08:20:00.
Start of time Click to have the first period begin w ith the Start time and end after the specified period in the
Trend/Aggregate Data dialog box. For example, if you specify a period of 10 minutes, the period starts at the Start time
and ends 10 minutes later.
Daylight Saving Time Check this box to automatically adjust the data display for Daylight Saving Time.
Set as Default Click to save the current settings as the standard option for the Process Data Add-in.
See Also
57 / 79
Set T ime Range Dialog Box
The Set Time Range dialog box allow s you to define the time range w ithin w hich you w ant to query.
Caution: If you do not specify a time range, Process Data w ill retrieve data using the current time on the computer.
Start time - Enter or edit the Start time (date and time).
The date can be set using the drop-dow n calendar:
Click the dow n arrow to set the date using the calendar. W hen the calendar is displayed:
Month - Click the arrow s pointing to the left or right to set the month. The name of the month is displayed in the center-
top.
Day - Click the date on the calendar to select the day. The day is highlighted w hen selected. The current date is circled in
red.
Click to set the Start time to the current time.
End time - Enter or edit the End time (date and time).
The date can be set using the drop-dow n calendar as described above.
Click to set the End time value to the current time.
(Time span) - Enter or edit the Time span to set a standard interval betw een the Start time and the End time. The
Start time or End time is adjusted according to the Time span.
Lock span - Click the checkbox to lock the Time span.
W hen the Time span is locked and the Start time or End time is changed, the other time is automatically adjusted to
conform to the specified Time span. For example, if the Time span is set to 0 2:00:00 (2 hours) and the End time of the time
range is set to 6:50:00 AM, the Start time automatically adjusts tw o hours to 4:50:00 AM
Click the marked checkbox to unlock the Time span. You cannot edit the Time span w hen locked.
Notes:
You can also use the Relative Time format to define Start and End times.
You can click the right mouse button to use the context menu to enter Start time and End time.
W hen a tw o digit year is entered, the century assumed is determined by the user's regional settings set in the Regional and
Language Option applet in the W indow s Control Panel.
See Also
58 / 79
Aspen T imeline Control
The Aspen Timeline control allow s you to set start and end times for data show n on the w orksheet. For additional, detailed
information, click Help on the Aspen Timeline control.
Note: You can click the right mouse w hile on the w orksheet to select the Aspen Timeline from the context menu.
For procedural information, see Using the Aspen Timeline.
Features:
Apply Click to apply the current timeline settings.
Field Definitions:
Start time/End time Type or edit the Start time and/or the End time.
Notes:
You can click the right mouse button to use the context menu to edit the relative time, set the time to the current time, or
zero the time values.
You can also use the Relative Time format to define the time.
Set time Click to set the start and end times using the Set Time Range dialog box.
Click or to change the End time:
W hen the clock is yellow , click to change the End time to the current time.
W hen the clock is w hite, click to freeze the End time.
(Span) Enter or edit the Span (time span) to define an interval (5 minutes, 2 hours) that is subtracted from the End time
to determine the Start time. For example, if the Span is set to 0 2:00:00 (2 hours) and the End time of the time range is
6:50:00 AM then the Start time w ill automatically adjust tw o hours to 4:50:00 AM
If you increase or decrease the Span, equal time increments are added or subtracted from both the Start time and End time.
indicates the Span is locked and the span cannot be changed. Click to unlock the span.
indicates the span is unlocked and the span can be changed. Click to lock the span.
Time slider scroll bar Click to the right or left of the Time slider to move the Time slider forw ard or backw ard in time.
Time slider Drag the Time slider to the right or left. This allow s you to stop at a particular point in time. The Span does not
change.
Update mode Use this option to update the Start time and End time on the w orksheets.
Manual Click to update the Start time and End time on the w orksheet manually w hen you click Apply.
Automatic Click to automatically update Start time and End time on the w orksheet based on the selected Timeline update
frequency. The updates stop w hen you close the Aspen Timeline control.
To modify the timeline update frequency, you can click on the right mouse button on the Time slider. Then select Properties
and select the desired update frequency.
Note: The Automatic update is not recommended for large array sizes, w here the amount of time required to update the
w orksheet matches or exceeds the Automatic update frequency.
See Also
Using the Aspen Timeline Control
59 / 79
Process Data Add-in Functions
The Process Data Add-in allow s you to construct data functions that retrieve and compute data using Aspen-provided formulas
and provide the results in an Excel w orksheet. The Process Data Add-in can use data from the InfoPlus.21, CIM/21, and Setcim
databases.
The Process Data Add-in contains the following data functions:

ATGetCurrVal
ATGetTimeVal
ATGetAttrVal
ATGetTrend
ATGetAgg
ATGetFltData
ATUserEntry
ATEntryRead
ATEntryW rite
RunTagBrow ser
RunTimeLine
You can set up each of the Process Data Add-in functions using dialog boxes. The Process Data Add-in dialog boxes allow you to
set up the data functions in steps, eliminating the need for you to apply the functions directly.
Note: The Process Data Add-in functions can be used w ith Visual Basic for Applications (VBA).
60 / 79
Using Process Data Add-in Functions in Visual Basic
You can use the Process Data Add-in data functions w ith Visual Basic for Applications (VBA), instead of the Excel w orksheet. See
the Process Data Add-in Functions.
To load the Process Data Add-in into VBA:

1. Load the Process Data Add-in into Excel.
2. Using the Visual Basic Editor in Excel, select References on the Tools menu. Then select AspenProcessDataAddin.
3. At this point, you can use the Process Data Add-in functions.
Example:
Sub ProcessDataExample()
Dim vServer As Variant
Dim vTag As Variant
Dim iDisplaySettings As long
Dim vResult As Variant
vServer = "IP21Server" ' server name

vTag = "ATCAI" ' tag name
iDisplaySettings = 24 ' request for timestamp and value
' Get current value

vResult = ATGetCurrVal(vTag, vServer, "", iDisplaySettings, 0, 0)
End Sub
Note: Refer to the related Excel application documentation and to the Visual Basic for Applications (VBA) programming language
documentation for additional, detailed information.
61 / 79
AT GetCurrVal
ATGetCurrVal(sTag, sServer, sMap, nDSetting, nOrientation, nTagDirection)

The ATGetCurrVal function returns an array containing the current values for the tag(s) specified. ATGetCurrVal is a "volatile"
function.
Arguments
Note: Each of the arguments for AtGetCurrVal is listed below w ith its data type (in parenthesis), definition, and usage:
sTag - (variant) An expression that represents a valid tag name or an Excel reference defining one or more tags. Enclose a
tag name that could be interpreted as a cell reference in double quotes.
sServer - (variant) An expression that represents a valid configured server name. An empty string indicates any server
configured in the server list. This argument is ignored if Server is defined in the w orksheet together w ith the tag. (see
below .)
sMap - (variant) An expression that represents a valid map. An empty string or "fixed" indicates the default map. This
argument is ignored if Map is defined in the w orksheet together w ith the tag.
(see below .)
nDSetting - (long) Numeric expression that controls the elements to be returned in the array. Sum of the constant values
(see below )
nOrientation - (integer) Numeric expression that defines the orientation of the output of the tag data in the array. Zero (0)
= vertical; 1 = horizontal
nTagDirection - (integer) Numeric expression that defines the direction to read tag information from a cell reference. Zero
(0) = tag information is read on the w orksheet horizontally, one tag per row .
One (1) = tag information is read on the w orksheet vertically, one tag per column.
(see below )
nDSetting
The values for the nDSetting argument are the sum of the follow ing constant values.
Note: Each constant name is listed w ith its numeric value (in parenthesis) and description.
atTagName - (1) Specify the tag name.
atServerName - (2) Specify/display the server name for the tag.
atMap - (4) Specify/display the map for the tag.
atTime - (8) Specify the time/read the time.
atValue - (16) Read/w rite the value.
atQLevel - (32) Display the quality level (as a number).
atQLevelText - (64) Display the quality level as text (requires atQLevel to be selected).
atQStatus - (128) Read/W rite the quality status (as a number).
atQStatusText - (256) Read/W rite the quality status as text (requires at Qstatus to be selected).
nTagDirection
You can define tags by entering them in the w orksheet and by passing the cell range as the tag argument. In this case, a tag is
defined as one or more sets of "tag name, server and map," w here server and map are optional.
The data orientation (row or column) for a tag is dependent on the nTagDirection selected. For example, if you w ant to read the
tag information in row s, specify:
One column range assumes only tag name is defined. The server and map default to the Server and Map specified in the
arguments.
Tw o column range assumes tag name and server are defined.
Three column range assumes tag name, server and map are defined. Cells left blank are considered to be the default.
For instance:
A B C
1 Tag name
or 2 Tag name Server
or 3 Tag name Server Map
or 4 Tag name Map
If you specify the nTagDirection in columns (vertically,) the tags are read as follow s:
or or or
A B C D
1 Tag name Tag name Tag name Tag name
2 Server Server
3 Map Map
The nDSetting argument is the sum of values that specify the data to be displayed. For example, to display the Tag, Server, and
Status as text:
Assign nDSetting = atTagName + atServerName + atQStatus + atQStatusText
nDSetting = 1 + 8 + 128 + 256
nDSetting = 393
62 / 79
63 / 79
AT GetT imeVal
ATGetTimeVal(sTag, sServer, sMap, sTime, nDSetting, nOrientation, nTagDirection, nType, sAlias)

The ATGetTimeVal function returns an array containing the value(s) at the given time(s) for the tag(s) specified.
Arguments
Note: Each argument for ATGetTimeVal is listed w ith its data type (in parenthesis), definition and usage.
sTag - (variant) An expression that represents a valid tag name or an Excel reference that defines one or more tags.
Enclose a tag name that may be interpreted as a cell reference in double quotes.
sServer - (variant) An expression that represents a valid configured server name. An empty string indicates any server
configured in the server list. This argument is ignored if Server is defined in the w orksheet together w ith the tag (see
below .)
sMap - (variant) An expression that represents a valid map. An empty string or "fixed" indicates the default map. This
sTime - (variant) An expression that represents a valid date/time or an Excel reference that defines one or more date/time
entries. Times can be represented as either absolute or Relative Time, (*-2h) (see below .)
nDSetting - (integer) Numeric expression that controls the elements to be returned in the array. Sum of the constant
values. See ATGetCurrVal for the values of the nDSetting argument.
nOrientation - (integer) Numeric expression that defines the orientation of the output of the tag data in the array. Zero (0)
nTagDirection - (integer) Numeric expression that defines the direction to read tag information from a cell reference. Zero
(0) = tag information is read on the w orksheet horizontally, one tag per row . One (1) = tag information is read on the
w orksheet vertically, one tag per column.
See ATGetCurrVal for more information about the nTagDirection argument.
nType - (integer) Numeric expression how the data is to be retrieved. If TRUE (1) then if there is NO value at the exact time
requested, then the first value before the time is returned. If FALSE (0) and there is NO value at the exact time requested,
then the value returned is interpolated betw een the value before and the value after the requested time. 0 is stepped =
FALSE and 1 is stepped = TRUE.
sAlias - (variant) Treat the entered Tag name as an S95 Tag Alias.
sTime
The values for sTime must be either one row only or one column only (tw o-dimensional arrays are not supported).
nDSetting
The nDSetting argument is the sum of the follow ing contant values.
Note: Each nDSetting constant is listed below w ith its numeric value(in parenthesis) and description.
For example, to display the Tag, Server, Map and Result:
Assign nDSetting = atTagName + atServerName + atMap
nDSetting = 1 + 2 + 4
nDSetting = 7
64 / 79
AT GetAttrVal
ATGetAttrVal(sTag, sServer, sMap, sAttribute, nDSetting, nOrientation, nTagDirection)

The ATGetAttrVal function returns an array containing the value(s) of the selected attribute(s) for the tag(s) specified.
ATGetAttrVal is a "volatile" function.
Note: This function does not return the Quality status or Quality level.
Arguments:
Note: Each argument for ATGetAttrVal is listed w ith its data type (in parenthesis), definition and usage.
sTag (variant) An expression representing a valid tag name or an Excel reference that defines one or more tags. Enclose
a tag name that could be interpreted as a cell reference in double quotes.
sServer (variant) An expression that represents a valid configured server name. An empty string indicates any server
below .)
sMap (variant) An expression that represents a valid map. An empty string or "fixed" indicates the default map. This
sAttribute (variant) An expression that represents a valid tag attribute or an Excel reference that defines one or more tag
attributes. Enclose an attribute name that may be interpreted as a cell reference in double quotes (see below ).
nDSetting (integer) Numeric expression that controls the elements to be returned in the array. Sum of the constant
values (see below ).
nOrientation (integer) Numeric expression that defines the orientation of the output of the tag data in the array. Zero (0)
= vertical; 1 = horizontal.
nTagDirection (integer) Numeric expression that defines the direction to read tag information from a cell reference. Zero
(0) = tag information is read on the w orksheet horizontally, one tag per row . One (1) = tag information is read on the
w orksheet vertically, one tag per column.
sAttribute
The values for sAttribute must be either one row only or one column only (tw o-dimensional arrays are not supported).
nDSetting
The nDSetting argument is the sum of the follow ing contant values.
Note: Each nDSetting constant is listed below w ith its numeric value (in parenthesis) and description.
atTagName (1) Specify the tag name.
atServerName (2) Specify/display the server name for the tag.
atMap (4) Specify/display the map for the tag.
atTime (8) Specify the time/read the time.
atValue (16) Read/w rite the value.
For example, to display the Tag, Server, Map and Result:
Assign nDSetting = atTagName + atServerName + atMap
nDSetting = 1 + 2 + 4
nDSetting = 7
65 / 79
AT GetT rend
ATGetTrend(sTag, sServer, sMap, startTime, endTime, nPoints, period, calculation, nDSetting, nOrientation, nTagDirection)
The ATGetTrend function returns an array containing data over a time span based on the given type of calculation for the tag(s)
specified.
Arguments
Note: Each argument for ATGetTrend is listed below w ith its data type (in parenthesis), definition and usage.
sTag (variant) An expression that represents a valid tag name or an Excel reference that defines one or more tags.
below .)
argument is ignored if Map is defined in the w orksheet together w ith the tag (see below .)
startTime (variant) An expression that represents a valid date/time for the beginning of the time span of interest. Times
can be represented as either absolute or Relative Time, (*-2h), or a cell reference containing a time.
endTime (variant) An expression that represents a valid date/ time for the end of the time span of interest. Times can be
represented as either absolute or Relative Time, (*-2h), or a cell reference containing a time.
nPoints (long) Maximum number of points to be returned in the array. This argument is ignored for all types of calculation
but Actual.
period (string) An expression that represents a valid time period for the calculation. Represented as a Relative Time in the
follow ing format:
day = ##d; hour = ##h; minute = ##m; seconds = ##s,
w here ## is a number
calculation (integer) Numeric expression that represents the type of calculation to be performed in the period. (see
below )
values. For more information, see nDSetting
nTagDirection (integer) Numeric expression that defines the direction to read tags from a cell reference. Zero (0) = tag
information is read from the w orksheet horizontally, one tag per row . One (1) = tag information is read from the w orksheet
vertically, one tag per column.
calculation
The values for the calculation argument are listed below by constant name, numeric value (in parenthesis) and description:
atInterpolated (0) The returned array contains values interpolated at evenly spaced time intervals (specified by the
period parameter) for the tag(s).
atActual (1) the returned array contains Actual for the tag(s).
66 / 79
nDSetting
The values for the nDSetting argument are the sum of the following constant values.
Note: Each constant is listed w ith its value (in parenthesis) and description.
atQLevel - (32) Display the quality level (as a number).
atQLevelText - (64) Display the quality level as text (requires atQLevel to be selected).
atQStatus - (128) Read/W rite the quality status (as a number).
atQStatusText - (256) Read/W rite the quality status as text (requires at Qstatus to be selected).
atSingleTime - (1024) Display a single time for multiple tags. AtSingleTime Does not apply to Actual data.
atFillEmpty - (2048) Display asterisks if data is not found for a given cell.
AtReverseTime - (4096) Display data from most current to oldest.
AtBackRetrieve - (16384) Retrieve data from the most recent date to oldest date.
AtHeadings - (32768) Display headings in the formula.
AtValueAsString - (65536) Display all the values as strings.
67 / 79
AT GetAgg
ATGetAgg(sTag, sServer, sMap, startTime, endTime, period, calculation, aggMethod, aggStep, aggStart, nDSetting, nOrientation,
nTagDirection)
The ATGetAgg function returns an array containing data over a time span based on the given type of calculation for the tag(s)
specified.
Arguments
Note: Each argument for ATGetAgg is listed below w ith its data type (in parenthesis), definition and usage.
below .)
argument is ignored if Map is defined in the w orksheet together w ith the tag (see below .)
can be represented as either absolute or Relative time, (*-2h), or a cell reference containing a time.
represented as either absolute or Relative Time (*-2h), or a cell reference containing a time.
follow ing format:
w here ## is a number.
A blank indicates using the span.
calculation (integer) Numeric expression that represents the type of calculation to be performed in the period(s). Single
constant value
(see below )
aggMethod (integer) Numeric expression that represents the method used to calculate aggregate values. Zero (0) =
Integral method. One (1) = Time method. Tw o (2) = Value method. (see below )
aggStep (string) An expression that specifies the frequency of data sampling for the Time method. Represented as a
Relative time in the follow ing format:
aggStart (integer) Numeric expression that defines the alignment of periods. Zero (0) = Start of day. One (1) = Start time.
(see below )
nOrientation (integer) Numeric expression that defines the orientation of the output of the tag data w ithin the array.
Zero (0) = vertical; 1 = horizontal.
information is read on the w orksheet horizontally, one tag per row . One (1) = tag information is read on the w orksheet
calculation
The constant values for the calculation argument are listed below .
Note: Each constant is listed w ith its numeric value (in parenthesis) and description.
atNotGood (8) Calculate the number of seconds for the period minus the number of seconds of good data for Integral or
Time methods, or the number of data points in the period minus the good data points for Actual method.
atGood (9) Calculate the number of seconds of good data for Integral or Time methods, or the number of data points of
good data for Actual method.
atAverage (10) Calculate the sum of good values divided by the number of good values.
atMaximum (11) Find the highest good value for the period.
atMinimum (12) Find the low est good value for the period.
atRange (13) Calculate the maximum good value minus the minimum good value.
atSum (14) Calculate the sum of good values for Actual method. For Integral method, calculate the area under the trend
formed from good values. For Time method, calculate the sum of the good interpolated values multiplied by the interpolation
step.
Note: Both Integral and Time methods calculate a value w ith units that are the product of the tag's units and seconds. The
value may need to be scaled to change seconds to some other time unit.
atStdDev (15) Calculate the square root of the variance.
atVariance (16) Calculate the variance of values for the good values.
aggMethod
The values for the AggMethod argument are listed below .
atIntegralMethod (0) Calculations are based on the integral trend line of data points for each period.
68 / 79
atTimeMethod (1) Calculations are based on interpolated values at evenly spaced time steps (as defined by the aggStep
parameter) for each period. For InfoPlus.21, this method is ignored and the atIntegralMethod is used.
atValueMethod (2) Use the actual values in history for each period.
aggStart
The values for the aggStart argument are listed below .
atStartOfDay (0) Align the start of the first period so that it is a shole number of periods from the StartOfDay value in the
database.
atStartTime (1) Align the start of the first period to the StartTime argument.
69 / 79
AT GetFltData
ATGetFltData(sTag, sServer, sMap, startTime, endTime, nPoints, period, calculation, nDSetting, nOrientation, nTagDirection)
The ATGetFltData function returns an array containing data over a time span based on the given type of calculation and the filter
condition for the tag(s) specified.
Arguments
Each argument for ATGetFltData is listed below w ith its data type (in parenthesis), definition and usage.
ATGetTrend.)
argument is ignored if Map is defined in the w orksheet together w ith the tag (see ATGetTrend.)
can be represented as either absolute or Relative Time, (*-2h), or a cell reference containing a time.
represented as either absolute or Relative Time, (*-2h), or a cell reference containing a time.
nPoints (long) Maximum number of points to be returned in the array. This argument is ignored for all types of calculation
but Actual.
follow ing format:
calculation (integer) Numeric expression that represents the type of calculation to be performed in the period. (see
below )
condition (string) An expression that represents a valid SQL condition to be used as filter. The format for the condition
includes a space betw een the tag name and operator and betw een the operator and the value. For example, Tagname
Operator Value.
= vertical; 1 = horizontal.
information is read from the w orksheet horizontally, one tag per row . One (1) = tag information is read from the w orksheet
calculation
The values for the calculation argument are listed below by constant name, numeric value (in parenthesis) and description:
atInterpolated (0) The returned array contains values interpolated at evenly spaced time intervals (specified by the
period parameter) for the tag(s).
atActual (1) The returned array contains Actual values for the tag(s).
70 / 79
AT UserEntry
ATUserEntry(sServer, nDSetting, nOrientation, [Row/Column headers])

The ATUserEntry function returns an array containing the headers for the information to be read from or w ritten to the database.
Arguments
Note: Each argument for ATUserEntry is listed below w ith its data type (in parenthesis), definition and usage.
configured in the server list. This argument is ignored, w hen reading from or w riting to the database, if Server is defined in
the w orksheet together w ith the tag.
nDsetting (integer) Numeric expression that controls the elements to be handled by the read/w rite operations. Sum of
the constant values (see below ).
nOrientation (integer) Numeric expression that defines the orientation of the UserEntry header. Zero (0) = vertical; 1 =
horizontal.
Row/Column headers (integer) List of strings, separated by commas, of headings to be displayed on the array. This
argument is optional. This list replaces the default headings.
nDSetting
The values for the nDSetting argument are listed below .
atTagName (1) Specify the tag name.
atServerName (2) Specify/display the server name for the tag.
atMap (4) Specify/display the map for the tag.
atTime (8) Specify the time/read the time.
atValue (16) Read/w rite the value.
atResult (512) Display the result of the operation.
The nDSetting argument is the sum of values that specify the data to be displayed. For example, to display the Tag, Server,
Map and Result:
Assign nDSetting = atTagName + atServerName + atMap + atResult
nDSetting = 1 + 2 + 4 + 512
nDSetting = 519
71 / 79
AT EntryRead
The ATEntryRead function reads from the database the information defined by the ATUserEntry setup.
72 / 79
AT EntryWrite
The ATEntryWrite function w rites to the database the information specified by the ATUserEntry setup.
73 / 79
RunT agBrowser
The RunTagBrowser function launches the Aspen Tag Brow ser.
74 / 79
RunT imeLine
The RunTimeLine function launches the Aspen Timeline Control.
75 / 79
Relative T ime Strings
A Relative Time String can contain single characters or other short mnemonics. A Relative Time String can represent a point in time
or relative offsets. Once defined, the system can translate this fixed set of characters appropriately.
Definition
A Relative Time String is composed of an anchor and any number of deltas, or simply any number of deltas. A Relative Time String
has the follow ing syntax:
[Anchor] [+/-] [n] [Unit]
(Anchor) (Delta)
Anchor
An Anchor is any fixed point in time. A Relative Time String does not alw ays contain an Anchor. If an Anchor is not supplied, a
"default anchor" is assumed. The default anchor is often defined by the context of the hosting control or defaults to the current
time.
Anchors can be defined w ith absolute dates, for example, 01-Jan-98, 10/Sep, or Feb-98 12:00. Any string that the operating
system can interpret as a date/time is a valid anchor. Anchors can be a time of day, such as 08:, 10:00, 00:00, w ith the default
day being assumed.
Note: Absolute date strings are interpreted differently among different locale settings. For example, 01/11/98 can be
interpreted as January-11, 1998 on one machine and November 01, 1998 on another machine, depending on the Control Panels
Regional Settings. Do not allow room for ambiguity w hen using absolute date strings as Anchors.
A "special case" Anchor is an integer value in the first position of the string that is less than the number of days in the current
month. For example, 25 is interpreted as the 25 th day of the current month at midnight.
An Anchor can also be one of several anchor "keyw ords" that have special meaning. The keyw ords for an anchor are listed below :
* Current date and time
T Today current day at 12:00 AM
SUN The previous Sunday at 12:00 AM
MON The previous Monday at 12:00 AM
TUE The previous Tuesday at 12:00 AM
WED The previous Wednesday at 12:00 AM
THU The previous Thursday at 12:00 AM
FRI The previous Friday at 12:00 AM
SAT The previous Saturday at 12:00 AM
nDY The nth day of the year at 12:00 AM
nWY The nth Sunday of the year at 12:00 AM
For example:
10/10 4am = October 10 th of the current year at 4:00 AM
Oct 10 4: = October 10 th of the current year at 4:00 AM
T 8:30:45.32 = Today at 8:30:45.32
31W Y/Mon:45 = The Monday prior to the 31 st Sunday of the year at 12:45 AM
18 = The 18 th of the current month at 12:00 AM
18 6: = The 18 th of the current month at 6:00 AM
Although any valid date/time string is acceptable as an anchor, w hat constitutes a valid string changes across different locale
settings. To resolve this, the follow ing month keyw ord names are also provided. These names w ork regardless of the locale
settings selected:
JAN January
FEB February
MAR March
APR April
MAY May
JUN June
JUL July
AUG August
SEP September
OCT October
NOV November
DEC December
Delta
The Delta is an offset that is applied to the anchor. Any number of deltas can be used together in a relative time string. A delta
has the follow ing syntax:
[+/-] [n] [Unit]
[+/-] Denotes w hether to add or subtract the delta. The sign of the delta is optional and defaults to + (plus sign).
[n] The integer number of units in the delta, for example, 3 hours. The number is optional and defaults to 1.
[Unit] The unit keyw ord of the delta. Valid units are listed below :
76 / 79
Y Years
MO Months
D Days
H Hours
M Minutes
S Seconds
U Sub-seconds
The behavior of the Sub-seconds unit (u) changes depending on the precision of the time control. If the time control is set to
millisecond precision, typing -2u subtracts 2 milliseconds, and -200u subtracts 2 tenths of a second. If the control is set to one-
tenth of a second precision, -2u subtracts 2 tenths of a second.
Valid Delimiters
The examples have used different delimiters. A delimiter provides separation betw een the anchor and delta components, and
betw een deltas. In some cases numerals can be used as a means for separation. For instance, 20W YFri does not provide a
means of separation betw een the mnemonic for WeekOfYear (W Y) and Friday (Fri).
In addition, specifying the same string, but in the reverse order, Fri20W Y does allow the various parts of the anchor to be
interpreted using the numeral 20 to separate the mnemonics Fri and W Y.
Valid separators are listed below :
, Comma
; Semi-colon
\ Backslash
/ Forw ard slash
Space
Any integer value
Note: If any of the above delimiter symbols are defined as the time separator in the locale settings or as the sub-second
separator by the application, then that symbol is no longer available as a delimiter.
Examples of Relative Time Strings
The string and its result are listed below :
-2h = Default anchor minus 2 hours
*-2h = Current Time minus 2 hours
T/8h/m = Today at 12am, plus 8 hours, plus 1 minute
25 16h20m = The 25 th of the current month at 12 AM, plus 16 hours, plus 20 minutes
t-1d 16:00 = Today, minus 1 day, at 4:00 PM
MON 8:43 = Last Monday at 8:43 AM
T2d6h-30m = Today at 12 AM, plus 2 days, plus 6 hours, minus 30 minutes
77 / 79
Error Messages
The Process Data Add-in displays the follow ing error messages:
Output Location Mismatch Message Box
Overw rite Warning Message Box
Overw rite Error Message Box
78 / 79
The follow ing error messages appear in the w orksheet w hen an error occurs w hile w riting data to, or receiving data from, the
database. For example, if the database server is dow n w hen you try to retrieve data, the error message, "50003 No connect to
server servername" is displayed in the cell of the w orksheet w here the result w ould be contained.

Note: Each error message is listed w ith its error number (in parenthesis), definition and solution.
Out of Memory (50001) There is not enough memory to allocate space for the result. Enter a smaller array size or close
other applications.
Bad argument (50002) A function argument is null or has an inconsistent map, tag or server array length. Verify that all
arguments in the function are consistent in array length.
No connect to server servername (50003) The server name is invalid or the server is dow n. Verify the server name.
Bad start time (50004) The start time given is invalid. Verify the time format or re-enter a different start time.
Bad end time (50005) The end time given is invalid. Verify the time format or re-enter a different end time.
Bad time range (50006) The time range given is invalid. The start time may be greater than the end time, or one of the
times, Start time or End time, is missing.
No write privilege (50007) The user does not have w rite privileges for that server. See your System Administrator.
Write to tagname failed (50008) Unable to w rite to the tag specified. Verify the time range.
No tag (50101) No tag name w as specified. Specify one or more tag names.
Bad tag tagname (50102) The tag name is w rong or not on the specified server. Verify the spelling of the tag name. Check
that the tag is on the specified server.
Bad attribute attributename (50103) The attribute name is w rong. Verify the spelling of the attribute name. Check the
map name.
No data tagname (50104) There w as no data for the tag specified. Enter a different time range or a different tag name.
79 / 79

Process Data Add in

Uploaded by

Copyright:

Available Formats

Process Data Add in

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Process Data Add in

Uploaded by

Copyright:

Available Formats

What are the main features of the Process Data Add-in?

What are the main features of the Process Data Add-in?

What are some examples of relative time strings used in the add-in?

What are some examples of relative time strings used in the add-in?

Process Data Add-in Contents

Here are some tips about using Help in your application.

Adjusting the Window

Scrolling through a Topic

Hiding the Table of Contents

Finding a Help Topic

To View or Edit an Annotation:

Changing the Font Size

Viewing the Previous Topic

To load the add-in using Excel 2003:

To load the add-in using Excel 2007:

Add-in File Locations

Using 2003 Spreadsheets with Office 2007

To enter a single cell reference location in the dialog box:

To enter a single cell reference location in the worksheet:

To define a number of data cell references:

To define output location on the worksheet:

To use RefEdit to select a cell reference location on the worksheet:

To use RefEdit Minimize button:

To change the date and time format in Windows:

To change the date and time format in Excel:

Calculation for volatile functions can be triggered:

To open the AspenTag Browser:

or 2 Tag name Server

or 3 Tag name Server Map

To set up and perform a trend or aggregate calculation:

Process Data Add-In uses six data aggregate methods:

The time aggregate method is based on a Time Aggregate calculation.

Note: A period must be equal to or greater than a step.

To retrieve attribute values:

To select tag attributes:

To retrieve current values:

To retrieve filtered trend data

To retrieve values at the given times:

The Data Entry Setup dialog box allow s you to:

To setup the data entry header:

To read data from the database:

To write data to the database:

The Start Timer dialog box allow s you to:

To stop the timer:

To preserve the timer settings:

Note: See On-Demand Calculations for more information.

The Data Entry Setup dialog box allow s you to:

The Start Timer dialog box allow s you to:

Dialog Box Elements

Note: This value does not apply to InfoPlus.21 databases.

The Process Data Add-in contains the following data functions:

To load the Process Data Add-in into VBA:

vServer = "IP21Server" ' server name

' Get current value

ATGetCurrVal(sTag, sServer, sMap, nDSetting, nOrientation, nTagDirection)

ATGetTimeVal(sTag, sServer, sMap, sTime, nDSetting, nOrientation, nTagDirection, nType, sAlias)

ATGetAttrVal(sTag, sServer, sMap, sAttribute, nDSetting, nOrientation, nTagDirection)

ATUserEntry(sServer, nDSetting, nOrientation, [Row/Column headers])

The RunTagBrowser function launches the Aspen Tag Brow ser.