Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
Guide
Published by:
Activplant Corporation
140 Fullarton Street
London
Ontario
N6A 5P2
Canada
Tel: (1) (519) 668-7336; Toll-free (North America): (877) 809-6444
Fax: (1) (519) 668-3227
E-mail: info@activplant.com
www.activplant.com
Copyright 2005-2009. Activplant Corporation
The content of this document is for informational use only and is subject to change without notice. Activplant
Corporation assumes no responsibility or liability for any errors or inaccuracies that may appear in this docu-
ment. The software described in this document is furnished under a license agreement and may be used or
copied only in accordance with the terms of that agreement.
No part of this document may be reproduced in any form or by any means, electronic or mechanical, for any
purpose, without the express written permission of Activplant Corporation.
Companies, names, and data used in this document are fictitious unless otherwise noted. Activplant,
ActivEssentials, and the Activplant logo are registered trademarks of Activplant Corporation, and ActivApplica-
tions, AppCenter, Insight for Excel, MI Admin, Root Cause Analysis, Real-Time Logic Engine, Throughput Ana-
lyzer, VPCollector, VPFoundation, VPQManager, and VPWeb are trademarks of Activplant Corporation. PLC is
a registered trademark of the Allen-Bradley Company. Microsoft and Windows are registered trademarks of
Microsoft Corporation in the United States and other countries, and Windows 2000, Windows Server 2003,
Windows XP, Windows Vista, Excel and Internet Explorer are registered trademarks of the Microsoft Corpora-
tion. Intel, Pentium, and Xeon are registered trademarks of Intel Corporation. All other trademarks are the
property of their respective holders and are hereby acknowledged.
The information in this document applies to Insight for Excel in ActivEssentials
TM
(6.0).
Document ID: 15551109
Published: December 15, 2009
Part Number: 12468380
i
Contents
Chapter 1. Overview and Administrator Tasks 1
Introduction 3
Installation and Set-up 4
Connecting to an ActivEssentials Applications server 9
Exporting and importing server information 17
Changing configuration 18
Chapter 2. Using Insight for Excel 21
Overview 23
Insight for Excel Features 24
Using the Function Editor 29
Setting Portability and Saving 40
Functions and reports 43
Refreshing data 50
Chapter 1
Overview and Administrator Tasks
3
Introduction
Introduction
ActivEssentials provides you with the means of creating different types of reports using
specific parameters within VPWeb. While this functionality meets basic reporting
requirements, it does not allow for the creation of complex, multi-level reports and
reporting strategies. Used in conjunction with the ActivEssentials software, Insight for
Excel provides connectivity between ActivEssentials and Excel to enable you to create
customized formulas and reports on the fly using ActivEssentials data in Microsoft
Excel. This data can be saved in a portable format and/or shared with other
ActivEssentials users.
This chapter covers the following topics:
Prerequisites (page 5)
Licensing (page 6)
Security (page 7)
Microsoft Excel 2002 (that is, XP) or 2003. For Excel 2003, ensure that the Interop
Assembly is installed (it is normally included in the client installation process). To
check for this file:
6
Chapter 1 Overview and Administrator Tasks
Windows 2000 (SP4), 2003 SP1 or higher, XP (SP1, SP2) operating system.
Server distribution options
There are three options for server installation of Insight for Excel:
All server components on the VPFoundation server. This is the default installation
that will install all server components on the ActivEssentials Applications server.
Server components installed on another server. This installation will install all of the
server components on a server other than the ActivEssentials Applications server.
Licensing (page 6)
Client installation
The client installation process for Insight for Excel is described in the System Configu-
ration Guide, in the ActivEssentials installation package. Software prerequisites for cli-
ent machines are given in Prerequisites on page 5.
Licensing
To use Insight for Excel on client machines, you must obtain a license file from Activ-
plant Corporation. When requesting the license file, Activplant Support will issue a
license file that covers you for the products you have purchased. When you apply the
7
Security
license file, the Security Service within ActivEssentials manages access to the
ActivEssentials data.
Before licensing, clients can still access the Insight for Excel functions, but they will not
be able to access ActivEssentials data. After you have finished licensing, you will need to
start the Activplant Security Service. This application monitors user access to Insight for
Excel and ActivEssentials data.
Security
As an administrator, you can grant access to ActivEssentials data by adding users to the
Insight for Excel application role. This security setting is enabled by default. However, if
you have installed ActivEssentials 5, then you will also need to provide the users Read
data access so that they can view that data. If you want to allow all users to access
ActivEssentials data, refer to Changing configuration on page 18.
Note
Before you add end users to the role in MI Admin, be sure to start the Activplant
Security Service.
Adding users to Insight for Excel role
Use the instructions below to add users to the Insight for Excel role.
Tip
As a matter of best practice, only add the people who will need to use Insight for
Excel. This will assist in optimum data retrieval from the ActivEssentials serv-
ers.
Procedure
1. In MI Admin, select the Security Configuration module.
2. Ensure that the Object Library is selected, and then click the Users button in
the Security Configuration frame.
3. In the grid, locate the user that you want to add to the role. Click in the Roles
Assigned column, then click the ellipsis button that appears.
The Roles dialog box opens.
8
Chapter 1 Overview and Administrator Tasks
Figure 1.2 Roles dialog box
4. Select the Insight for Excel role on the left side of the dialog box, then click Add to
add the role to the user.
5. Click OK.
6. In the Plant Hierarchy frame, navigate to and select the plant, group, or asset to
which you need to add the Insight for Excel role.
7. Right-click on any row in the grid, and select Assign Role.
8. Click Next to move past the welcome page.
9. Click the down-arrow by the Roles field and select a role from the list, then click the
Privileges button.
10. In the Granted column, select the Read Data checkbox, and then click OK.
11. Click Next.
The final page of the wizard opens.
12. Click Finish.
9
Connecting to an ActivEssentials Applications server
Connecting to an ActivEssentials Applications
server
Once Insight for Excel is enabled, you have to establish connections to an ActivEssentials
Applications (VPFoundation) server so that you can retrieve ActivEssentials data for
your Excel report. You can create connections to as many servers as you wish; one server
is designated as the default server. These connections only need to be set up once, and
must be done on each computer that will use Insight for Excel. If you use another com-
puter, you can export the server configuration data to that computer; otherwise, you will
have to set up the configuration on the other separate computer as well. See Exporting
and importing server information on page 17 for more information.
This section covers the following topics:
The server alias. This is the unique assigned configuration name for the server. If the
server name or IP address changes, then the server alias enables identification of the
correct server. The server alias is used in identifying the server for a function; this
name can be shorter than the network name, and allows for easier creation of a
function.
Note
Ensure that the server alias for a specific server is applied consistently for all In-
sight for Excel users.
READ_LIST. Calculates a value based on the asset, aggregation, filter, and time
frame, and displays it across rows and columns that you select. This data is aggre-
gated by a time frame or identifier that you specify in the grouping parameter.
READ_MATRIX. Returns raw data based on the asset, time frame, filter, and one or
more identifiers that you select. The resulting data displays in a table format; each
row represents a single raw data record within the database.
Insight For Excel
Help
Opens Insight for Excel Help.
Icon and Name Used for
26
Chapter 2 Using Insight for Excel
Other functions that are very specific to one or two parameters such as time frame,
aggregation, asset, or data item are also available. These functions are also known as sup-
porting functions. Although they are used to build primary functions, they can also be
used individually to change or modify pre-existing data.
Average. Returns the average of the data that you have specified.
Count. Counts the number of records within the group and time frame that you
have selected.
Minimum. Returns the smallest value in the records that are returned.
Maximum. Returns the largest value in the records that are returned.
First. Returns the value of the first record in the database for the time frame you
have selected.
Last. Returns the value of the last record in the database for the time frame that you
have selected.
Standard Deviation. Calculates the standard deviation for the range of data.
Variance. Analyzes the data values and calculates the variance within the grouping
that is returned.
When using the Excel Insert Function button to aggregate data, refer to the following
table for acceptable aggregation formats that you can type. Note that these formats are
not case sensitive.
Table 2.2 Acceptable aggregation formats
Aggregation Acceptable format
SUM Sum, Total
AVERAGE Avg, Average
MINIMUM Min, Minimum
MAXIMUM Max, Maximum
27
Accessing the functions
Accessing the functions
Insight for Excel functions can be accessed in one of two ways:
Through the Activplant Function Editor on the Activplant toolbar or the Activ-
plant menu.
Note
If you can access the Function Editor but it does not work properly, verify your
security settings with your administrator.
Server1: server alias. The server is always identified and displayed by its server
alias.
Group By 8 hours: grouping. The selection of one item (for example, day, week,
month, quarter) etc. must be plural.
READ_LIST. Calculates a value based on the asset, aggregation, filter, and time
frame, and displays it across rows and columns that you select. This data is aggre-
gated by a time frame or identifier that you specify in the grouping parameter.
READ_MATRIX. Returns raw data based on the asset, time frame, filter, and one or
more identifiers that you select. The resulting data displays data in a table format;
each row represents a single raw data record within the database.
Note
When one of these three functions is selected, you will see only the relevant tabs
in the Function Editor.
Procedure
1. Select an empty cell and click the Function Editor icon on the Activplant tool-
bar.
The Function Editor appears.
32
Chapter 2 Using Insight for Excel
Figure 2.8 Function Editor, functions tab
2. Select the function that you want to use for your data query. You have two options
for choosing a function:
a. If you are creating a new query: use one of the three primary functions listed
above.
b. If you are changing a report parameter: use one of the Supporting functions. See
Changing report parameters on page 39.
The number of tabs you see changes based on the function you have selected.
3. Select another tab to proceed with creating the function.
Selecting a server
Use the instructions below to select an ActivEssentials server that contains the data that
you want to view. If you do not have the server in your server list, you can add it and
select it in this tab. If you do have servers configured, the default server will display in
this tab. This tab is enabled for the following functions:
READ_SUMMARY
READ_LIST
READ_MATRIX
SPECIFY_REL_TIMEFRAME
SPECIFY_ASSET
SPECIFY_ITEM
SPECIFY_GROUPING
SPECIFY_FILTER
33
Selecting a time frame
Procedure
1. Select the Server tab.
2. Choose one of the following radio buttons:
a. Use a server from my server list: choose a server from the Available Servers
drop-down list.
b. Use a server specified in another cell: type the sheet/cell reference item in the
box.
c. If you have not defined the server that you want to use, then click the New
Server... button and fill in the details of the new server in the dialog box that
opens.
3. Select another tab to proceed with creating the function.
Selecting a time frame
Use the instructions below to select a time frame for the report you want to create. You
can choose a relative time period, a time period in relation to an identifier, or an abso-
lute time frame. Note that by default, the maximum time span is 3 months. If you
require data that exceeds this time span, contact your administrator.
This tab is enabled for the following functions:
READ_SUMMARY
READ_LIST
READ_MATRIX
SPECIFY_REL_TIMEFRAME
SPECIFY_ABS_TIMEFRAME
Note
If you are requesting data from a server in a different time zone, the time shown
will reflect that local time, and the data will be returned to you in that local
time. Any time adjustments can then be made in Excel.
Procedure
1. Select the Time Frame tab.
2. Choose one of the following radio buttons:
a. Use a relative time frame: choose a number and unit (days, hours, or minutes),
or select a number and identifier, such as production shifts. You can include the
current unit in your time frame.
34
Chapter 2 Using Insight for Excel
Note
Only two levels of identifiers appear in the drop-down list. Further identifier
definition is only available in the Browse tab.
b. Use an absolute time frame: specify the start time and end time by date, hour,
minute, and second (if applicable). Note that you can only select historical dates,
and not future dates.
c. Use a time frame specified in a cell reference: type the sheet/cell reference in the
box.
3. If you have finished selecting the parameters that you want, click and drag the Drag
to Cell icon to a cell in the worksheet.
Selecting a grouping
Use the instructions below to group ActivEssentials data by time frame or identifier. This
tab is enabled for the following functions:
READ_LIST
SPECIFY_GROUPING
Procedure
1. Select the Grouping tab to group data.
2. Choose one of the following radio buttons:
a. Group by time frame: choose a number and unit (days, hours, or minutes).
b. Group by Identifier/Identifier value: select an identifier from the drop-down
list. If you want to group data by identifier value, check the Group by identifier
value checkbox. If you want to use the identifier value to request data for the last
three Shift 1 occurrences (for example), then enable filtering by identifier value
Shift 1.
Note
Only two levels of identifiers appear in the drop-down list. Further identifier
definition is only available in the Browse tab.
c. Group by cell reference: type the sheet/cell reference in the box.
3. If you have finished selecting the parameters that you want, click and drag the Drag
to Cell icon to a cell in the worksheet.
35
Aggregating your data
Aggregating your data
Use the instructions below to select the way in which you want your data to appear. This
tab is enabled for the following functions:
READ_SUMMARY
READ_LIST
SPECIFY_AGGREGATION
Procedure
1. Select the Aggregation tab to choose a way to return data.
Note
The Aggregation tab has two primary options: Select an aggregation method,
and Use an aggregation method from a cell reference. You must choose the
method that best suits your needs.
2. Do one of the following:
a. Select the Select an aggregation method radio button, and go to Step 3..
b. Select the Use an aggregation method from a cell reference, and go to Step 4..
3. Select an aggregation method from those offered, and go to Step 5..
See the following for explanations of each:
a. Sum. Adds all of the numbers in the range.
b. Average. Returns the average of the data that you have specified.
c. Count. Counts the number of records within the group and time frame that you
have selected.
d. Minimum. Returns the smallest value in the records that are returned.
e. Maximum. Returns the largest value in the records that are returned.
f. First. Returns the value of the first record in the database for the time frame you
have selected.
Tip
If you have selected an accumulator data item, remember that it refreshes every
five minutes, so you will only see the first occurrence of the item within the first
five-minute time interval.
g. Last. Returns the value of the last record in the database for the time frame that
you have selected.
h. Standard Deviation. Calculates the standard deviation for the range of data.
i. Variance. Analyzes the data values and calculates the variance within the group-
ing that is returned.
36
Chapter 2 Using Insight for Excel
4. Choose the Use an aggregation method from a cell reference radio button and type
the sheet/cell reference in the box.
5. If you have finished selecting the parameters that you want, click and drag the Drag
to Cell icon to a cell in the worksheet.
Filtering your data
Use the instructions below to choose a filtering option for the time frame of data you are
requesting; this is especially important if you have selected the Sum aggregation type in
the previous tab. Otherwise, this is an optional tab. This tab is enabled for the following
functions:
READ_SUMMARY
READ_LIST
READ_MATRIX
SPECIFY_FILTER
Procedure
1. Select the Filtering tab.
2. Check Enable filtering if you want to filter data.
3. Choose one of the following filtering options:
a. Filter by Identifier: Select the identifier and value that you want to use for filter-
ing. You can choose Equals or Not equal to to either select or eliminate the iden-
tifier value.
Note
If you choose to filter incident duration by productive time, then make sure that
the filter incident by duration only system setting is on. See the AppCenter Ad-
ministration manual, System Settings chapter for more information.
b. Use a filter specified in a separate cell: type the sheet/cell reference in the box.
Note
This Sheet/Cell Reference option will not be available if you have selected one
of the SPECIFY functions. You can use the Drag to Cell icon to drag the filter
onto the required cell.
Choosing the placement for your data
Use the instructions below to choose the location and amount of data that you want to
display. This tab is enabled for the following functions:
37
Selecting Identifiers for the READ_MATRIX function
READ_LIST
READ_MATRIX
Procedure
1. Select the Placement tab to define where the function you are building will be
located in the Excel sheet.
2. If you have selected the READ_LIST function, check the Show Headers checkbox to
view headers for the data that is retrieved (optional). Then choose one of the follow-
ing options:
a. Choose a radio button to place the returned data along columns (vertically) or
rows (horizontally), or
b. Choose a radio button to display all data, or display only a certain number of
rows or columns, regardless of the amount of data that is retrieved.
3. If you have selected the READ_MATRIX function, check the Show Headers check-
box to view headers for the data that is retrieved (optional). Then choose one of the
following options:
a. Choose a radio button to use as many rows or columns as needed, or
b. Choose to limit the data to a certain number of rows and columns, regardless of
the amount of data that is retrieved.
4. If you have finished selecting the parameters that you want, click and drag the Drag
to Cell icon to a cell in the worksheet.
Selecting Identifiers for the READ_MATRIX function
Use the instructions below to select identifiers for the READ_MATRIX function only.
This allows you to add an identifier to a record at the time at which the data was col-
lected.
Note
Make sure that the identifier is valid for the group/asset you select. If the iden-
tifier is not valid for the group/asset, the identifier will not be applied.
Procedure
1. If you have selected the READ_MATRIX function, select the Identifiers tab to
choose identifiers to filter your data.
2. From the Available Identifiers box, select one or more identifiers (up to four) and
click Add to move them to the Selected Identifiers box.
38
Chapter 2 Using Insight for Excel
Tip
Press Shift+click or Ctrl+click to select multiple identifiers to add to the Selected
Identifiers list.
3. If you have finished selecting the parameters that you want, click and drag the Drag
to Cell icon to a cell in the worksheet.
Selecting a group or asset and a data item
Use the instructions below to select a group/asset and data items that will apply to the
function that you are creating. This tab is enabled for the following functions:
READ_SUMMARY
READ_LIST
READ_MATRIX
SPECIFY_ASSET
SPECIFY_ITEM
Procedure
1. Select the Browse tab to select the groups, assets, and data items that you want to
include.
Figure 2.9 Function Editor, Browse tab
2. In the Asset Selection group-box, choose to select a group or asset from the hierar-
chy, or select an asset/group from a cell reference.
39
Changing report parameters
3. In the Item Selection group-box, choose to select a data item from the browser, or
select a data item from a cell reference. Note the following restriction for the items
you are viewing:
4. If you select a group, the Item Browser refreshes and you will see the data items that
belong to that group only, not any of the items that belong to assets within that
group.
Tip
If you are using the SPECIFY_ASSET or SPECIFY_ITEM function and you use
the Asset or Item Browser to select an asset or data item, you can click and drag
the asset or item onto the spreadsheet.
5. In the Preview pane, select the Drag to Cell icon to drag the complete function
to a cell.
A zero displays in the Excel cell. The data that you have requested will be populated in
the spreadsheet according to the update time that you have set. Refer to Manual
updateon page 51 for more information.
Changing report parameters
Use the instructions below to filter by additional parameters, modify parameters, etc.
Procedure
1. Select the function that you want to change in the Excel sheet.
Note
Even though the results of the function may span many columns and rows,
make sure you select the cell in which the function resides.
2. Do one of the following:
a. Open the Function Editor, or
b. Click Insert Function.
3. Change the parameters using the Function Editor or the Function
Arguments, and then drag the Drag to Cell icon onto the cell that you want to
change.
The new information should update in the cell automatically.
40
Chapter 2 Using Insight for Excel
Setting Portability and Saving
The data and reports that you create in Insight for Excel can be saved with connected
data and shared with other Insight for Excel users. Reports can also be saved as static
HTML files, for people who only need to view static data, or for people who are not
Insight for Excel users.
This section covers the following topics:
Press Ctrl+Shift+Alt+F9. This will recalculate all ActivEssentials and Excel func-
tions on the active sheet.
A zero will display in the cell in which you have created or dropped the function, as
shown in Figure 2.19.
Figure 2.19 Finished function
Setting auto refresh frequency
Use the instructions below to set the time (in minutes) in which you want the worksheet
to refresh. Each request sent to the ActivEssentials server is added to a queue, and is
51
Manual update
updated within the auto refresh time. This option updates the items in the queue at the
refresh rate that you specify, regardless of Excel refresh capabilities.
Note
If you are creating a function or report, we recommend that you deselect the
Auto Update button; otherwise you may experience slower performance.
Procedure
1. On the Activplant menu, choose Add-In Options.
Insight for Excel User Options dialog box appears.
Figure 2.20 Add-In options box
2. Type a new refresh rate in the box, or use the up- or down-arrows to increase or
decrease the auto refresh rate.
3. Click OK.
Any new or existing function will update at the new refresh rate time.
Manual update
Any function that you create will automatically be added to an update queue, so you may
not see your report immediately in Excel. If you have created complex functions and
parameters for your report, you can keep your function in a report queue since it may
take a few minutes to generate the report. However, if you do need to view your report
immediately, you click the Update button on the Activplant toolbar.
52
Chapter 2 Using Insight for Excel
53
Index
Index
Symbols
#VALUE! error 27
A
Accessing server on other computer 17
ActivEssentials server connection 9
Activplant
toolbar 24
toolbar, accessing in Excel 2007 25
Aggregation
formats 26
methods 26
Asset, selecting for function 38
Auto refresh
in Excel 50
set update frequency 50
C
Cancel Update List, update spreadsheet 51
Cancel update requests 24
Cell reference
#VALUE! error 27
using in Function Editor 27
Changing a function parameter 39
Changing the database access password 14
Client installation 6
Configuration
changing the time span 19
disabling security 19
using the configuration tool 18
Connection
deleting server 13
editing server 12
error message 14
setting default server 11
Copying, server connection 12
D
Database access password 14
Database access password, changing 14
Default server connection
deleting 13
setting 11
Drag and drop functions 39
E
Editing server connection 12
Error messages
#VALUE! error 27
Interop Assemblies not found 5
Excel 2003, error message 5
Excel 2007
accessing the Activplant menu 25
viewing portability 41
F
F9, manual sheet update 50
Filter data by identifier 26
Function Editor
accessing 27
not working 27
Preview pane 30
primary functions 32
tabs displayed 31
using cell reference 27
Functions
about 25
aggregation formats 26
changing 39
drag and drop 31, 39
READ_LIST 25, 31
READ_MATRIX 25, 31
READ_SUMMARY 25, 31
SPECIFY_ABS_TIMEFRAME 26
SPECIFY_ASSET 25
SPECIFY_FILTER 26
SPECIFY_GROUPING 26
SPECIFY_ITEM 26
SPECIFY_REL_TIMEFRAME 26
G
Group, selecting for function 38
H
Help, using online help 4
I
Identifier
filtering data by 26
grouping by 26
using as a time period 33
Insert Function, accessing Activplant functions 27
Insight for Excel, update and refresh options 51
Installation
applying security 7
client installation 6
database upgrade 4
Insight for Excel installation 4
prerequisites 5
server installation 6
Invalid username/password message 14
M
Manual refresh 51
54
Index
N
No data when using Function Editor 27
P
Parameters, changing 39
Portability, viewing in Excel 2007 41
Prerequisites
installation 5
software 5
Preview pane 30
R
READ_LIST 25, 31
READ_LIST, report example 45
READ_MATRIX 25, 31
READ_SUMMARY 25, 31
Refresh
auto 50
manual 51
Report example
asset and machine states 44
READ_LIST function 45
Reports, sharing 40
Role, Insight for Excel 7
S
Security, disabling 19
Security, Insight for Excel role 7
Selecting
absolute time frame 26, 33
data items 38
groups and assets 25, 26, 38
identifier to group by 26
relative time frame 26, 33
server for function 32
Server
connecting to ActivEssentials servers 9
copying connection 12
default, setting 11
deleting connection 13
details incorrect 14
editing connection 12
exporting server information 17
importing server information 17
installation 6
selecting 25, 26
setting default 11
Set portability
properties and modification 41
sharing reports 40
Software prerequisites 5
SPECIFY_ABS_TIMEFRAME 26
SPECIFY_ASSET 25
SPECIFY_FILTER 26
SPECIFY_GROUPING 26
SPECIFY_ITEM 26
SPECIFY_REL_TIMEFRAME 26
T
Time frame
changing the default (admin) 19
in different time zone 33
selecting absolute 26
selecting relative 26
specifying as identifier 33
Time zone, selecting time frame in different zone 33
Toolbar, Activplant 24
U
Update spreadsheet
Auto refresh 50
cancel update requests 24
F9 50
manual update 51