PI Integrator for Business Analytics User Guide

Transcription

1 PI Integrator for Business Analytics 2015 User Guide

2 OSIsoft, LLC 777 Davis St., Suite 250 San Leandro, CA USA Tel: (01) Fax: (01) Web: PI Integrator for Business Analytics 2015 User Guide: Patent pending 2015 by OSIsoft, LLC. All rights reserved. No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, mechanical, photocopying, recording, or otherwise, without the prior written permission of OSIsoft, LLC. OSIsoft, the OSIsoft logo and logotype, PI Analytics, PI ProcessBook, PI DataLink, ProcessPoint, PI Asset Framework (PI AF), IT Monitor, MCN Health Monitor, PI System, PI ActiveView, PI ACE, PI AlarmView, PI BatchView, PI Coresight, PI Data Services, PI Event Frames, PI Integrator for Business Analytics, PI Manual Logger, PI ProfileView, PI Web API, PI WebParts, ProTRAQ, RLINK, RtAnalytics, RtBaseline, RtPortal, RtPM, RtReports and RtWebParts are all trademarks of OSIsoft, LLC. All other trademarks or trade names used herein are the property of their respective owners. U.S. GOVERNMENT RIGHTS Use, duplication or disclosure by the U.S. Government is subject to restrictions set forth in the OSIsoft, LLC license agreement and as provided in DFARS , DFARS , FAR , FAR , as applicable. OSIsoft, LLC. Version: 1.0 Published: 04 December 2015

3 Contents What is PI Integrator for Business Analytics?...1 Advantages of PI Integrator for Business Analytics... 3 System architecture and considerations... 5 System requirements... 7 How to install the PI Integrator for Business Analytics Windows service...9 Phase 1: Prepare for installation... 9 Phase 2: Install the PI Integrator for Business Analytics Windows service Phase 3: Verify Installation Verify that PI Integrator for Business Analytics Windows service is running...13 Phase 4: Install PI ODBC Supported SQL Query Parameters Administration tasks Add and remove PI AF Servers and databases Add and configure users Configure publish targets Licensing and Output Streams Remove views to increase available license streams Secure views...36 Secure an individual view Kerberos constrained delegation...40 Task 1: Configure Service Principal Names (SPN) for the domain Task 2: Enable Service account for Kerberos Constrained Delegation Task 3: Add PI Data Archive Servers with the PIServer Service Type Task 4: Add PI Asset Framework Servers with the AFServer Service Type...48 How to use PI Integrator for Business Analytics Overview of features and use of PI Integrator for Business Analytics...51 The My Views page...52 What is a shape? What is a PI View?...54 Create an asset view Modify a view Adjust how values are interpolated...59 Add a column Filter a view Technical support and other resources PI Integrator for Business Analytics 2015 User Guide iii

4 Contents iv PI Integrator for Business Analytics 2015 User Guide

5 What is PI Integrator for Business Analytics? PI Integrator for Business Analytics presents PI System data perfectly suited to business intelligence tools including but not limited to Tableau, Tibco Spotfire, QlikView, and Microsoft Power BI for reporting and analytics. Business Intelligence (BI) client tools offer the ability to run retrospective analyses on a much larger set of your real-time PI System data. BI helps you learn from operational behaviors and patterns, identifying dependencies and correlations of various factors within your operations. Native time series data, asset context, and event context are exposed through web-configured PI Views and can be accessed using a standard ODBC connection. Data are perfectly dimensionally modeled, cleansed, and presented with appropriate metadata so that BI tools can properly browse, query, and consume PI System data seamlessly. Data can also be directly integrated and loaded into data warehouse platforms. PI Integrator for Business Analytics eliminates the need for programming or SQL expertise and manages the complete data lifecycle, including access, updates, and data provenance. PI Integrator for Business Analytics requires a PI Asset Framework (PI AF) model to select PI System data to produce decision-ready data. The data can be cleansed using a variety of filters and enhanced with asset, event, and time context from the PI System. The resultant PI Views are immediately usable in BI tools without further modification. PI Integrator for Business Analytics 2015 User Guide 1

6 What is PI Integrator for Business Analytics? 2 PI Integrator for Business Analytics 2015 User Guide

7 Advantages of PI Integrator for Business Analytics The advantages of using PI Integrator for Business Analytics instead of manually importing data into BI clients are: Ease in selecting and importing large data sets, without the need for coding to prepare the data, and without having to be knowledgeable about the source data Ability to scale up the size of the data set, without the need to customize data importing procedures Ability to merge PI System data with other master data sets for aggregate-level analysis Ability to publish data for a variety of BI tools to consume An easy to use, web-based user interface that requires no separate installation by end users PI Integrator for Business Analytics 2015 User Guide 3

8 Advantages of PI Integrator for Business Analytics 4 PI Integrator for Business Analytics 2015 User Guide

9 System architecture and considerations The PI Integrator for Business Analytics Windows service interacts with the following components to integrate PI data with Business Intelligence analysis tools: PI Asset Framework (PI AF) The PI Integrator for Business Analytics Windows service retrieves and updates PI View definitions stored in the PI AF configuration database. These PI View definitions are used to construct PI Views sent to the BA client. PI Integrator for Business Analytics Windows service component uses Windows Integrated Authentication to access the PI AF server and uses Kerberos delegation to retrieve PI View definitions from the PI AF database. For information about Kerberos delegation, see Kerberos constrained delegation. SQL Server The PI Integrator for Business Analytics Windows service stores PI View data in the SQL database. Install the PI Integrator for Business Analytics Windows service component on a self-hosted web server that has access to a Microsoft SQL Server. You can select either Windows Integrated Authentication or SQL Server authentication to connect to the SQL Server database. With Windows Authentication, the PI Integrator for Business Analytics Windows service component uses your Windows service account user name and password. Using SQL Server authentication, enter a username and password of an account configured on the SQL Server with access to the server. During the installation, you will have the opportunity to validate the connection and authentication. PI SQL Data Access Server (PI SQL DAS) The PI SQL DAS is the intermediary between the PI ODBC Driver and the PI AF database and the SQL database. The PI SQL DAS gathers the PI View definition from the PI AF configuration database and the optimized PI View data from the SQL database to construct the PI View to send to the remote client application. PI ODBC Driver The PI ODBC driver on the client side serves as the point of contact for the remote client application, requesting and sending PI Views on behalf of the client through interaction with the PI SQL DAS on the server side. Figure 1 represents a typical architecture using the PI Integrator for Business Analytics Windows service with other components to provide the remote client application with the data for analysis: 1. The remote client application requests a data set for analysis. The request is relayed to the ODBC driver. 2. The ODBC driver handles the request from the remote client application and relays the request to the PI SQL DAS. 3. The PI SQL DAS acts as the mediator between the client and the PI System. The PI SQL DAS queries the AF configuration database for the PI View definition. 4. The PI AF configuration database sends the PI View definition to the PI SQL DAS. PI Integrator for Business Analytics 2015 User Guide 5

10 System architecture and considerations 5. The PI SQL DAS queries the SQL database for the PI View data. This data is gathered from the PI System and prepared by the PI Integrator for Business Analytics Windows service component. The data to be used for the PI View is sent to the SQL database. 6. The SQL database sends the PI View data to the PI SQL DAS. 7. The PI SQL DAS sends the PI View constructed from the gathered PI View definition and the PI View data to the ODBC driver. 8. The ODBC driver sends the PI View to the remote client application for analysis. Integration data flow 6 PI Integrator for Business Analytics 2015 User Guide

11 System requirements System minimum requirements Certain capabilities of PI Integrator for Business Analytics rely on the latest versions of several OSIsoft PI system components. While not necessarily required, it is strongly recommended that customers be on the following production release: PI Server 2010 or later PI Asset Framework 2010 or later PI Data Archive 2010 or later PI Integrator for Business Analytics Windows service 16GB of memory and two modern CPU cores Microsoft Windows Server 2008 R2 SP1 Microsoft SQL Server 2008 R2 or later (Installed locally or on the network) Other For browsers, use Microsoft Internet Explorer version 10 or later, or the latest version of Google Chrome (recommended). PI Integrator for Business Analytics 2015 User Guide 7

12 System requirements 8 PI Integrator for Business Analytics 2015 User Guide

13 How to install the PI Integrator for Business Analytics Windows service Consider the PI Integrator for Business Analytics as comprised of four installation phases, each consisting of specific steps for that phase of the install. The four installation phases are, as follows: High-level view of the installation process 1. Phase 1: Prepare for installation - This phase involves ensuring appropriate access and permissions to the other components that interact with the PI Integrator for Business Analytics Windows service. PI AF server, PI Data Archive, and Microsoft SQL Server. These prerequisites must be in place before launching the installation kit for PI Integrator for Business Analytics Windows service. 2. Phase 2: Install the PI Integrator for Business Analytics Windows service - This phase involves installation of the PI Integrator for Business Analytics Windows service, specifying the PI AF and Microsoft SQL Server for the PI Integrator for Business Analytics. A new PI Integrator database is created on the Microsoft SQL Server for the PI Integrator for Business Analytics Windows service as a part of this installation phase. 3. Phase 3: Finish installation - This phase verifies that the PI Integrator for Business Analytics Windows service has started and is running. 4. Phase 4: Install ODBC driver - This phase involves installing and configuring the PI ODBC driver on the client side, as well as specifying the data source name (DSN) for the ODBC driver to gather PI Views. The following sections of this guide describe each phase of the installation in greater detail. Phase 1: Prepare for installation Before installing the PI Integrator for Business Analytics software, there are a few prerequisites that must be met to ensure a successful installation. A number of components interact and depend upon each other to achieve successful integration functionality. These components are the PI Server (which contains the PI Asset Framework server and PI Data PI Integrator for Business Analytics 2015 User Guide 9

14 How to install the PI Integrator for Business Analytics Windows service Archive), Microsoft SQL Server and databases that store the PI View data, and the PI Integrator for Business Analytics Windows service. Phase 1 involves obtaining proper access and permissions to the related components so that they may interact with the PI Integrator for Business Analytics Windows service software properly. This installation phase is useful because you will be able to gather all pre-installation access and permission requirements before submitting a request to your IT department and/or Microsoft SQL Server administrator. Procedure 1. Log into your system with the Windows service account configured with sysadmin role. Note: If your Windows server account does not have the sysadmin server role, you must run post-installation SQL configuration scripts found at the Tech Support ( techsupport.osisoft.com/) Download Center. 2. Ensure that the minimum requirements and required software are installed for PI Integrator for Business Analytics implementation, as described in System requirements. 3. Ensure that you have Administrator privileges on the Microsoft Windows Server where PI Integrator for Business Analytics will be installed. This is usually required to install all OSIsoft software. 4. Create a Windows service account for PI Integrator for Business Analytics Windows service, and ensure that your service accounts have access to a local or remote Microsoft SQL Server 2008 R2 or later. To configure access for the Microsoft SQL Server, use either Windows Integrated Service authentication for your Windows service account, or obtain a Microsoft SQL Server account. If you require assistance from your IT administrator, request a Windows service account initially with elevated permissions to use for running the PI Integrator for Business Analytics Windows service setup kit through installation only. 5. Configure the sysadmin server role for your Windows service account for the Microsoft SQL Server to enable your Windows service account to create a database automatically through the installation process. Or request a Microsoft SQL Server account with the sysadmin role. Note: If your Windows server account does not have the sysadmin server role, you must run post-installation SQL configuration scripts found at the Tech Support ( techsupport.osisoft.com/) Download Center. Note: The sysadmin role is only during installation. After installation is complete, disable the sysadmin permissions and configure more targeted permission levels for your Windows service account, as described in Verifying PI Integrator Service. 6. Configure access to the PI AF server for your Windows service account. a. For PI AF Server 2015 (2.7) and later, add a new mapping to the Administrators Identity. This assigns admin-level privileges for the PI AF Configuration database. Refer to the PI 10 PI Integrator for Business Analytics 2015 User Guide

15 How to install the PI Integrator for Business Analytics Windows service System Explorer User Guide for more detailed information about configuring permissions for PI Identities. b. For PI AF 2.6 and earlier, configure admin-level privileges for your Windows service account. 7. (Optional) Contact your IT administrator to request Kerberos constrained delegation between the machine that hosts the PI Integrator for Business Analytics Windows service and the machines that host PI AF and PI Data Archive. This enables delegation and limits access to only the appropriate data within the PI System (PI Data Archive and PI AF). For details on configuring Kerberos delegation, refer to Kerberos constrained delegation. Phase 2: Install the PI Integrator for Business Analytics Windows service Phase 2 involves installing the PI Integrator for Business Analytics Windows service component of the PI Integrator for Business Analytics solution, and specifying the PI AF and Microsoft SQL Server to use. Before you start Before starting the installation for PI Integrator for Business Analytics Windows service: Ensure that you have met all of the prerequisites listed in: Phase 1: Prepare for installation. Ensure that you have local-admin privileges on that computer. The service account needs to be in the local administrators group for the installation process. Procedure 1. Log into your system with the Windows service account configured with the sysadmin role. Note: If your Windows server account does not have the sysadmin server role, you must run post-installation SQL configuration scripts found at the Tech Support ( techsupport.osisoft.com/) Download Center. 2. Download the latest version of the PI Integrator for Business Analytics Windows service setup kit from the Tech Support ( Download Center. 3. Right-click the setup executable and select Run as Administrator to launch the installation wizard. The Self-Extracting Executable screen appears. 4. Specify the extraction path for the installer. Click OK. The installer extracts and the PI Integrator for Business Analytics Setup screen appears, listing the separate modules included with the installation. The installation wizard will install every module automatically, or check to ensure each module already exists on your system. 5. Click OK. The Welcome to the PI Integrator for Business Analytics Installation screen displays. PI Integrator for Business Analytics 2015 User Guide 11

16 How to install the PI Integrator for Business Analytics Windows service 6. Click Next. The Logon Information screen displays. 7. Specify the Username (including domain) and Password for the Windows service account that will run the PI Integrator for Business Analytics Windows service. Click Next. The AF Server Connection screen displays. 8. Specify the PI AF Server on which the PI Integrator for Business Analytics Windows service will store PI View definitions. In the AF Server field, enter the name and location of the PI AF Server. Use "." to indicate localhost. 9. Click Next. The SQL Server Connection screen displays. Note: If you encounter an error, ensure that your Windows service account has local admin privileges for the PI AF Configuration database. The service account needs to be in the local administrators group. 10. Specify the Microsoft SQL Server on which the PI Integrator for Business Analytics Windows service will store PI View data. Specify both the server and instance name as: server\instance. For example: mysqlserverba1\sqlexpress. 11. Select an authentication method to connect to the specified Microsoft SQL Server database: Windows Integrated Service or SQL Server Authentication. If you choose to use Windows Authentication, proceed to Step 15. Windows Authentication uses the Windows logon account on the local machine specified previously as the credentials for the Microsoft SQL Server. Note: Specify the Windows service account credentials, and not the credentials for the local account that launched the setup kit. Ensure that your Windows service account is configured with the sysadmin role on the Microsoft SQL Server, allowing the Windows service account to create a new database for the PI Integrator for Business Analytics Windows service. If your service account does not have the sysadmin role, run the post-installation SQL configuration scripts found at the Tech Support ( Download Center. If you choose to use SQL Server Authentication, proceed to Step Select the SQL Server Authentication checkbox to use SQL Server Authentication to connect to the specified Microsoft SQL Server database, instead of Windows Authentication. The Username and Password fields are accessible. 13. Enter the Username and Password for a Microsoft SQL Server that has access and can connect to the Microsoft SQL Server database. Note that these credentials will be stored in clear text in the web application's configuration. Note: The use of SQL Server Authentication is not recommended. If SQL Server Authentication is desired, you should first create a dedicated Microsoft SQL Server account with minimum server privileges as detailed in the prerequisites above. The login should be created specifically for use by the PI Integrator for Business Analytics Windows service. 14. Click Next. The Port Configuration screen displays. 12 PI Integrator for Business Analytics 2015 User Guide

17 How to install the PI Integrator for Business Analytics Windows service 15. Enter a valid unused port number in the Enter a valid port number field. This port is used by the PI Integrator for Business Analytics user interface to connect with the PI Integrator for Business Analytics Windows service component. 16. Click Next. The Ready to Install the Application screen displays. You are now ready to begin the software installation. 17. Click Install. Note: If you encounter an error, ensure that the port is unused and open. Phase 3: Verify Installation After installing the PI Integrator for Business Analytics Windows service software on your domain, it is important to do some post-installation tasks to verify that the install was successful and the service is running. Verify that PI Integrator for Business Analytics Windows service is running Procedure 1. Change or request a change in the permissions level of your Windows service account for the Microsoft SQL server from the sysadmin role used during installation to datareader and datawriter permissions to the corresponding SQL service. For more information about server roles, see Database-Level Roles ( ms189121(v=sql.90).aspx). 2. Log into the machine hosting the PI Integrator for Business Analytics Windows service running PI Integrator for Business Analytics Windows service. 3. Open Services on the machine hosting the PI Integrator for Business Analytics Windows service. 4. Verify that PI Integrator for Business Analytics is listed and running. 5. Open up a Web browser. 6. Enter the URL for the web UI for the PI Integrator for Business Analytics Windows service. The URL points to the host machine and port for the PI Integrator for Business Analytics Windows service. The URL is where FQDN is the fully-qualified domain name. The URL is if the browser is opened on the same machine as the service. PI Integrator for Business Analytics 2015 User Guide 13

18 How to install the PI Integrator for Business Analytics Windows service For example, if you installed the PI Integrator for Business Analytics Windows service on a host named lab5 in the domain prod.onet.com and configured a port 7777 during the installation, you enter: Phase 4: Install PI ODBC The PI ODBC driver on the client side serves as the point of contact for the client, requesting and sending PI Views on behalf of the client through interaction with the PI SQL Data Access Server (PI SQL DAS) on the server side. Phase 3 involves installing the PI ODBC driver on the client side to interact with the PI Integrator for Business Analytics Windows service on the server side, and specifying thepi Integrator for Business Analytics Windows service as the data source. Procedure 1. Right-click the PI ODBC setup executable and select Run as Administrator to launch the installation wizard. The PI ODBC setup executable is found within the self-extracted executable folder described in Phase 2. The ODBC driver and tools are installed on the machine. 2. Search and launch the odbcad32.exe application. Note: Use the version compatible with your client application. There are two versions of ODBCAD32, a 32-bit version and 64-bit version. Launching the 32-bit version of the application (odbcad32.exe) loads the 32-bit version of the ODBC driver. Similarly, launching the 64-bit version of the application (odbcad64.exe) loads the 64-bit version of the ODBC driver. ODBC Data Source Administrator opens. 14 PI Integrator for Business Analytics 2015 User Guide

19 How to install the PI Integrator for Business Analytics Windows service 3. Click Add to configure a new data source for the ODBC driver. The Create New Data Source dialog box appears. 4. Select PI Integrator for Business Analytics as the data source driver. This specifies the new data source as the PI Integrator for Business Analytics Windows service. PI Integrator for Business Analytics 2015 User Guide 15

20 How to install the PI Integrator for Business Analytics Windows service 5. Click Finish. The PI ODBC DSN Configuration dialog box appears. 6. Enter a name for the new data source in the ODBC Data Source Name field, and a brief description in the Description field. 7. Enter the name of the machine hosting the PI Integrator for Business Analytics Windows service in the PI Integrator for Business Analytics Server Name field and click Test Connection to validate the hostname. This specifies the data source. Note: The test connection should succeed after a PI View has been created. You must first create a PI View to test the connection. For more information about creating PI Views, refer to Details about PI Views. 8. Click OK. PI ODBC on the client side is ready for PI Integrator for Business Analytics. 9. Validate successful installation and configuration of PI ODBC driver by openingthe PI SQL Commander Lite (or other SQL Query application) and verifying the hostname appears under the ODBC Data Sources panel. Supported SQL Query Parameters PI Integrator for Business Analytics supports the following SQL query parameters. Supported SQL data types Data Type The following table lists the supported data types for PI Integrator for Business Analytics: AF Data Type Boolean Byte DateTime Double Guid Int16 16 PI Integrator for Business Analytics 2015 User Guide

21 How to install the PI Integrator for Business Analytics Windows service AF Data Type Int32 Int64 Single String Supported SELECT statement syntax SELECT PI Integrator for Business Analytics supports the following SELECT statement syntax: Note: In general, ensure proper consideration for sizing of the data sets involved, and be sure to have these sizing considerations for your data set requirements match your system resources. <select_statement> ::= <query> [UNION ALL <query> [UNION ALL ]] [ORDER BY <expression> [ASC DESC] [, ]] <query> ::= SELECT [ALL DISTINCT] [TOP integer_value] <select_list> [FROM table_source [, ] [WHERE <condition>] [GROUP BY [ALL] <expression> [, ]] [HAVING <condition>] <select_list> ::= {* {table_name view_name table_alias}.* <expression> [[AS] column_alias] column_alias = <expression>} [, ] <table_source> ::= table_name [[AS] table_alias] view_name [[AS] table_alias] <select_statement> [[AS] table_alias] <joined_table> [[AS] table_alias] <joined_table> ::= <table_source> [INNER LEFT [OUTER] RIGHT [OUTER] FULL [OUTER]] JOIN <table_source> ON <condition> <condition> ::= {[NOT] <predicate> (<condition>)} [{AND OR} <condition>] [, ] PI Integrator for Business Analytics 2015 User Guide 17

22 How to install the PI Integrator for Business Analytics Windows service <predicate> ::= <expression> {= > < >= <= <>!=} <expression> <expression> [NOT] IN ({<expression> [, ]) <expression> [NOT] BETWEEN <expression> AND <expression> <expression> [NOT] LIKE <expression> [ESCAPE <expression>] <expression> IS [NOT] NULL <expression> ::= <expression_factor> <expression > {+ - * / %} <expression> <expression_factor> ::= integer_value float_value string_value True False NULL? column_name CAST (<expression> AS data_type_name) COUNT (*) aggr_function_name ([ALL DISTINCT] <expression>) nonaggr_function_name ([<expression> [, ]]) [+ -] <expression_factor> (<expression>) NULLIF (<expression>, <expression>) COALESCE (<expression>, ) CASE <expression> WHEN <expression> THEN <expression> [WHEN ] [ELSE <expression>] END CASE WHEN <condition> THEN <expression> [WHEN ] [ELSE <expression>] END Note: Brackets ("[]") denote optional parts of the statement, braces ("{}") with vertical bars (" ") denote mutually exclusive parts. Supported operators and functions Operators and functions PI Integrator for Business Analytics supports the following arithmetic operators: +, -, *, /, % PI Integrator for Business Analytics supports arithmetic operators for all numeric data types. In addition, it supports the following operator overloads: AnsiString Operator+(x AnsiString, y AnsiString) String Operator+(x String, y String) PI Integrator for Business Analytics supports the following mathematical functions: 18 PI Integrator for Business Analytics 2015 User Guide

23 How to install the PI Integrator for Business Analytics Windows service ABS ACOS ASIN ATAN ATN2 CEILING COS EXP FLOOR LOG LOG10 PI POWER ROUND SIN SQRT Int32 ABS(x Int32) Int64 ABS(x Int64) Single ABS(x Single) Double ABS(x Double) Single ACOS(x Single) Double ACOS(x Double) Single ASIN(x Single) Double ASIN(x Double) Single ATAN(x Single) Double ATAN(x Double) Single ATN2(x Single, y Single) Double ATN2(x Double, y Single) Single CEILING(x Single) Double CEILING(x Double) Single COS(x Single) Double COS(x Double) Single EXP(x Single) Double EXP(x Double) Single FLOOR(x Single) Double FLOOR(x Double) Single LOG(x Single) Double LOG(x Double) Single LOG10(x Single) Double LOG10(x Double) Double PI() Single POWER(x Single, y Single) Double POWER(x Double, y Double) Single ROUND(x Single) Single ROUND(x Single, y Int32) Double ROUND(x Double) Double ROUND(x Double, y Int32) Single SIN(x Single) Double SIN(x Double) Single SQRT(x Single) Double SQRT(x Double) PI Integrator for Business Analytics 2015 User Guide 19

24 How to install the PI Integrator for Business Analytics Windows service TAN Single TAN(x Single) Double TAN(x Double) PI Integrator for Business Analytics supports the following string functions: CHARINDEX LEFT LEN LOWER LTRIM REPLACE REVERSE RIGHT RTRIM SUBSTRING UPPER Int32 CHARINDEX(toFind AnsiString, s AnsiString) Int32 CHARINDEX(toFind AnsiString, s AnsiString, start Int32) Int32 CHARINDEX(toFind String, s String) Int32 CHARINDEX(toFind String, s String, start Int32) AnsiString LEFT(s AnsiString, n Int32) String LEFT(s String, n Int32) Int32 LEN(s AnsiString) Int32 LEN(s String) AnsiString LOWER(s AnsiString) String LOWER(s String) AnsiString LTRIM(s AnsiString) String LTRIM(s String) AnsiString REPLACE( s AnsiString, findwhat AnsiString, replacewith AnsiString) String REPLACE(s String, findwhat String, replacewith String) AnsiString REVERSE(s AnsiString) String REVERSE(s String) AnsiString RIGHT(s AnsiString, n Int32) String RIGHT(s String, n Int32) AnsiString RTRIM(s AnsiString) String RTRIM(s String) AnsiString SUBSTRING(s AnsiString, start Int32, count Int32) String SUBSTR(s String, start Int32, count Int32) AnsiString UPPER(s AnsiString) String UPPER(s String) PI Integrator for Business Analytics supports the following aggregate function: 20 PI Integrator for Business Analytics 2015 User Guide

25 How to install the PI Integrator for Business Analytics Windows service AVG, COUNT, MAX, MIN, SUM Aggregate functions are implemented in compliance with ANSI SQL. PI Integrator for Business Analytics supports ODBC-defined scalar functions except for: Char_Length, Character_Length, Database, Difference, SoundEx, and User. Refer to the following link for detailed description of scalar functions ( msdn.microsoft.com/en-us/library/ms711813(v=vs.85).aspx). PI Integrator for Business Analytics 2015 User Guide 21

26 How to install the PI Integrator for Business Analytics Windows service 22 PI Integrator for Business Analytics 2015 User Guide

27 Administration tasks There are a list of administration tasks that you can perform on your PI Integrator for Business Analytics system. The topics found within this section of the guide include how to add and remove users on your PI Integrator for Business Analytics system, secure PI views for specific users, and specifying PI AF Servers as data sources. Add and remove PI AF Servers and databases During installation, you specified a PI AF Server for PI Integrator for Business Analytics Windows service to use to store configuration information. One of the administrative tasks you can perform is to add (and remove) PI AF Servers and databases to store data for use with PI Views. Procedure 1. Open up a browser window. 2. Enter the URL for the web UI for the PI Integrator for Business Analytics Windows service. The URL points to the host machine and port for the PI Integrator for Business Analytics Windows service. 3. Click the navigation tab. The navigation panel appears. 4. Click Administration from the navigation panel. PI Integrator for Business Analytics 2015 User Guide 23

28 Administration tasks The Administration page appears. 5. Click on the AF Databases tab. The AF Servers and Databases list appears. Underneath that list, the Add a New AF Server panel appears. 6. WIthin the Add a New AF Server panel, enter the name and location of the PI AF Server in the AF Server field and the port to use for the desired PI AF Server in the Port field. 24 PI Integrator for Business Analytics 2015 User Guide

29 Administration tasks Note: Ensure your Windows service account has Administrator-level access to the desired PI AF Server before performing this step, as described earlier in this guide. 7. Click Add AF Server. The new PI AF Server appears within the AF Servers list. PI Integrator for Business Analytics 2015 User Guide 25

30 Administration tasks 8. Select an PI AF Server to remove from the AF Servers list. The databases within the selected PI AF Server are displayed next to the AF Servers list. 9. Click Remove AF Server to remove the selected PI AF Server from the PI Integrator for Business Analytics Windows service. The PI AF Server no longer appears in the AF Servers list. Add and configure users The following section describes how to add a new user and configure the user's access to specific asset views, determining which PI Views are visible to the user. Procedure 1. Open up a browser window. 2. Enter the URL for the web UI for the PI Integrator for Business Analytics Windows service. The URL points to the host machine and port for the PI Integrator for Business Analytics Windows service. 3. Click the navigation tab. 26 PI Integrator for Business Analytics 2015 User Guide

31 Administration tasks The navigation panel appears. 4. Click Administration from the navigation panel. The Administration page appears. 5. Click on the Users tab. The Users and Groups list appears. 6. Click Add. PI Integrator for Business Analytics 2015 User Guide 27

32 Administration tasks The Add Users and Groups dialog box appears. 7. Select Users and enter the domain and username formatted as domain\user in the domain \user field. Optionally, you can enter the full name of the new user in the full name field. 8. Click Search. A list of Active Directory users appear matching the entered criteria. 9. Select a new user from the list and Click OK. The new user appears in the Users and Groups list. 10. Select a user from the Users and Groups list. The user parameters and permissions dialog box appears. 11. Edit the user parameter and permissions for the new user. Setting the user as an Administrator allows the user to modify existing user configurations and perform other administration tasks. 12. Click Save Changes. The setting for the new user is applied. 28 PI Integrator for Business Analytics 2015 User Guide

33 Administration tasks Configure publish targets The following section describes how to add, remove and edit Publish Target outputs of the PI Integrator for Business Analytics Windows service to be used by the client. Note: The target configuration options available to the user depends upon the software edition and/or license type. Procedure 1. Open up a browser window. 2. Enter the URL for the web UI for the PI Integrator for Business Analytics Windows service. The URL points to the host machine and port for the PI Integrator for Business Analytics Windows service. 3. Click the navigation tab. The navigation panel appears. 4. Click Administration from the navigation panel. PI Integrator for Business Analytics 2015 User Guide 29

34 Administration tasks The Administration page appears. 5. Click on the Targets tab. The Publish Target Configuration and the Publish Targets list appear. 6. Click Add Publish Target. 30 PI Integrator for Business Analytics 2015 User Guide

35 Administration tasks The Create New Publish Target dialog box appears. 7. Enter the name of the new Publish target in the Target Name field and select the type of output in the Target Type drop down list. 8. Edit the parameters found within the Target Configuration panel to configure the selected Publish Target. PI Integrator for Business Analytics 2015 User Guide 31

36 Administration tasks Note: Each type of Publish Target has different set of configuration parameters available for editing. 9. Click Create New Target. The new Publish Target appears in the Publish Targets list. 10. Select a Publish Target from the Publish Targets list to remove from PI Integrator for Business Analytics Windows service. 11. Click Remove Publish Target. 12. Verify the selected Publish Target is removed from the Publish Targets list. 32 PI Integrator for Business Analytics 2015 User Guide

37 Administration tasks 13. Select a Publish Target from the Publish Targets list. The Target Configuration panel appears displaying the configurable parameters for the selected Publish Target. 14. Edit the parameters found within the Target Configuration panel to configure the selected Publish Target. Note: Each type of Publish Target has different set of configuration parameters available for editing. 15. View the list of user/group and accounts that has access to the selected Publish Target in the Target Access panel. 16. Click Add User to add a new user/group to grant access to the selected Publish Target. PI Integrator for Business Analytics 2015 User Guide 33

38 Administration tasks 17. Enter the domain\user and full name of the new user to add for the Publish Target and click OK. The new user appears in the Target Access panel. 18. Click Save Changes. The setting for the Publish Target is applied. Licensing and Output Streams The License tab found under the Administration section of the PI Integrator for Business Analytics user interface provides information about the number of output streams utilized for your PI Integrator for Business Analytics implementation, as well which PI Views utilize the output streams. An output stream is a PI tag (data point) referenced within a PI View and published by the PI Integrator for Business Analytics Windows service. A unique output stream is a distinct PI tag utilized and published in one or more PI Views. The total output stream includes all of the instances of the unique output stream published in one or more PI Views. Depending upon your specific software package and licensing agreement, a maximum number of unique output streams will be allowed for your PI Integrator for Business Analytics implementation. For example, say that your PI Integrator for Business Analytics Windows service is configured with three PI Views: ProcLab1, TestPrd, and Fieldoutput.. ProcLab1 utilizes 20 output streams (15 unique output streams, 5 non-unique output streams), TestPrd utilizes two (2) unique output streams, and Fieldoutput utilizes 22 output streams (2 unique output streams, 20 nonunique output streams). The Total Output Streams panel will show 44 used. The Unique Output Streams Consumed panel will show 19 used. The Output Streams by View list displays all three PI Views, with how many output streams are utlized by each PI View. Remove views to increase available license streams Removing older PI Views frees up the corresponding unique output streams utilized by that PI View, and thus frees up the number of unique output streams available with your licensing agreement for new PI Views. 34 PI Integrator for Business Analytics 2015 User Guide

39 Administration tasks Note: It is important to understand that removing a PI View in the My Views window of the PI Integrator for Business Analytics user interface does not decrease the amount of unique output streams utilized in reference to your licensing agreement limit. You must remove PI Views and free up unique output streams by following the steps below. Note: You can only remove a PI View that is 90 days and older. Procedure 1. Open up a browser window. 2. Enter the URL for the web UI for the PI Integrator for Business Analytics Windows service. The URL points to the host machine and port for the PI Integrator for Business Analytics Windows service. 3. Click the navigation tab. The navigation panel appears. 4. Click Administration from the navigation panel. PI Integrator for Business Analytics 2015 User Guide 35

40 Administration tasks The Administration page appears. 5. Click on the Licensing tab. The Output Streams by View list appears. 6. Select a PI View that is appropriate to remove, perhaps an older PI View that is no longer actively being published. 7. Click Remove View. The selected PI View no longer appears in the Output Streams by View list. Consequently, the total number displayed in the Unique Output Stream Consumed panel increases. Secure views Each PI View configured and published through the PI Integrator for Business Analytics Windows service contains valuable information. Ensuring that only the appropriate user(s) are able to access each PI View may be important for maintaining proper oversight and security. Additionally, you can specify whether a user can access data (Reader) or access data, change permissions, and grant access for the PI View (Owner). 36 PI Integrator for Business Analytics 2015 User Guide

41 Administration tasks There are two ways of securing PI Views through the PI Integrator for Business Analytics user interface. Procedure 1. Open up a browser window. 2. Enter the URL for the web UI for the PI Integrator for Business Analytics Windows service. The URL points to the host machine and port for the PI Integrator for Business Analytics Windows service. 3. Click the navigation tab. The navigation panel appears. 4. Click Administration from the navigation panel. The Administration page appears. 5. Click on the Users tab. PI Integrator for Business Analytics 2015 User Guide 37

42 Administration tasks The Users and Groups list appears. 6. Select the user or group to configure permissions. The View Permissions panel displays all accessible PI Views for the specified user or group. 7. Select a PI View to configure permissions. A drop down list appears. 8. Select either Owner or Reader permission level for the PI View to allow for the user or group. The Reader level grants user access to data through the ODBC/JDBC driver. The Owner level grants access to data, ability to change permissions, and ability to grant access for the PI View to other users. 9. Click Save Changes. Secure an individual view You can secure an individual view through the My Views page. 38 PI Integrator for Business Analytics 2015 User Guide

43 Administration tasks Procedure 1. Open up a browser window. 2. Enter the URL for the web UI for the PI Integrator for Business Analytics Windows service. The URL points to the host machine and port for the PI Integrator for Business Analytics Windows service. 3. Click the navigation tab. The navigation panel appears. 4. Click My Views from the navigation panel. The My View page appears. 5. Select a PI View from the list. 6. Click the Security tab. PI Integrator for Business Analytics 2015 User Guide 39

44 Administration tasks 7. Click on a user or group. A drop down list appears. 8. Select either Owner or Reader permission level for the PI View to allow for the user or group. The Reader level grants user access to data through the ODBC/JDBC driver. The Owner level grants access to data, ability to change permissions, and ability to grant access for the PI View to other users. 9. Click Add to add a user or group with permissions to view or modify the PI View. 10. Click Remove to remove the selected user or group from being able to access or modify the PI View. Kerberos constrained delegation Kerberos delegation enables users to access remote data sources through Windows authentication. Kerberos is the preferred solution to manage user access among different servers. For PI Integrator for Business Analytics, with Kerberos, the PI Integrator for Business Analytics Windows service can accept and relay user login credentials to the remote server that provides data, in this case the PI Data Archive and the PI AF server. It is recommended that you enable and configure Kerberos constrained delegation for the service account that runs the PI Integrator for Business Analytics Windows service so that only the appropriate resources within the PI system (PI AF and Data Archive) are available to the end user. 40 PI Integrator for Business Analytics 2015 User Guide

45 Administration tasks Note: PI Integrator for Business Analytics supports constrained delegation only. Unconstrained delegation is not supported. Before you can enable and configure Kerberos constrained delegation, you must have the following prerequisites: The PI Integrator for Business Analytics Windows service running under a managed service account. A managed service accounts provide applications such as SQL Server or Exchange with automatic password management and support for simplified service provider name. For detailed information about managed service accounts, see Introducing Managed Service Accounts ( The machine name where the PI Integrator for Business Analytics Windows service is installed The name of the managed service account that runs the PI Integrator for Business Analytics Windows service Access to the domain controller and domain admin rights Task 1: Configure Service Principal Names (SPN) for the domain To configure constrained delegation for the PI Integrator for Business Analytics Windows service account, service principal names (SPNs) need to exist for all PI Data Archive and PI AF Servers that PI Integrator for Business Analytics needs to access. Configure a separate SPN for each and every PI AF and Data Archive server included in your PI Integrator for Business Analytics implementation. To verify that SPNs exist refer to the note at the end of this section. Then you can associate your Windows service account for constrained delegation on the domain. The setspn command adds the SPN to the domain and associates the SPN with your service account. Procedure 1. Remote desktop and log on to a domain controller as a domain administrator. 2. Open a console window on the domain controller. 3. Enter the following commands to add the SPN to the domain. Specify both a fully qualified and non-qualified machine name in the console. a. setspn -S http/<hostname> domain\service-account b. setspn -S http/<fqdn> domain\service-account Note: You must add and configure an SPN for the PI AF server and the PI Data Archive server. If they do not reside on the same host, you must execute the commands twice, once for the host with the AF server, and again for the host with the Data Archive. Sample SPN configuration The hostname is the name of the machine that is hosting PI AF and/or PI Data Archive. The fully qualified domain name (FQDN) is the hostname plus the domain running either PI AF and/or PI Data Archive. PI Integrator for Business Analytics 2015 User Guide 41

46 Administration tasks For example, say that you have the PI Integrator for Business Analytics Windows service on a domain with PI AF hosted on a machine named lab1 and PI Data Archive server on a machine named lab2. The service account for the PI AF is joshuak. Before you add a new SPN for PI AF, verify there is no existing SPN for that service by entering: setspn -Q AFServer/lab1 setspn -Q AFServer/lab1.prod.opsmain.com Similarly, before you add a new SPN for your Data Archive, verify there is no existing SPN for that service by entering: setspn -Q PIServer/lab2 setspn -Q PIServer/lab2.prod.opsmain.com After verifying there are no existing SPNs, add a new SPN for lab1 running PI AF service, located within the prod.opsmain.com domain. You configure the SPN for your PI AF service within your domain by entering the following commands in the console on the domain controller: setspn -s AFServer/lab1 prod\joshuak setspn -s AFServer/lab1.prod.opsmain.com prod\joshuak You must also add a new SPN for lab2 running PI Data Archive service, located within the prod.opsmain.com domain. You configure the SPN for your PI Data Archive service within your domain by entering the following commands in the console on the domain controller: setspn -s PIServer/lab2 setspn -s PIServer/lab2.prod.opsmain.com Task 2: Enable Service account for Kerberos Constrained Delegation The second task is to enable your Windows service account for Kerberos constrained delegation. Procedure 1. Log onto the machine hosting the PI Integrator for Business Analytics Windows service. 2. Stop the PI Integrator for Business Analytics Windows service. 3. Locate the PI Integrator for Business Analytics configuration file: CAST.UI.WindowsService.exe.config. 4. Open the configuration file with a text editor and locate the following configuration: <add key="impersonate" value="false" />. 5. Change"false"to"true", as follows: <add key="impersonate" value="true" />. 6. Log onto the domain controller as a domain administrator (or any computer with Active Directory Users and Computers installed). You can log in locally or through Remote Desktop. 7. Open the Active Directory Users and Computers window. 8. In the navigation panel Active Directory Users and Computers window, select Managed Service Accounts. 42 PI Integrator for Business Analytics 2015 User Guide

47 Administration tasks A list of service accounts is displayed. 9. Find and double click on your service account for PI Integrator for Business Analytics Windows service. The Account Properties dialog box appears. 10. Click on the Delegation tab. PI Integrator for Business Analytics 2015 User Guide 43

48 Administration tasks 11. Select Trust this user for delegation to specified services only and click on the Add button. This selection enables constrained delegation. Note: Ensure you do not select Trust this user for delegation to any service (Kerberos only). This selection enables non-constrained delegation, which is not supported for PI Integrator for Business Analytics. The Add Services dialog box appears. 44 PI Integrator for Business Analytics 2015 User Guide

49 Administration tasks 12. Click the Users or Computers button. The Select Users or Computers dialog box appears. 13. Enter the name of your Windows service account. 14. Click on the Check Names button to verify the service account name. The object name appears verified. 15. Click OK. Your service account is enabled for Kerberos constrained delegation. PI Integrator for Business Analytics 2015 User Guide 45

50 Administration tasks Task 3: Add PI Data Archive Servers with the PIServer Service Type The third task is to specify the PI Data Archive servers for Kerberos constrained delegation for the PI Integrator for Business Analytics Windows service. Procedure 1. With the Add Services dialog box still open from Task 2: Enable Service account for Kerberos Constrained Delegation, click Users or Computers. The Select Users or Computers dialog box appears. 2. Enter the machine name of the server where PI Data Archive is located within object name field. 3. Click on the Check Names button to verify the server name. The server name appears verified. 4. Click OK. 46 PI Integrator for Business Analytics 2015 User Guide

51 Administration tasks The Add Services dialog box appears. 5. Select the PIServer Service Type within the list of available services. 6. Click OK. The selected PI Data Archive is assigned the PIServer Service Type. 7. Verify that the selected PI Data Archive server was assigned the PIServer Service Type by opening the Delegation tab of the Account Properties dialog box. PI Integrator for Business Analytics 2015 User Guide 47

52 Administration tasks For more information about navigating to the Account Properties dialog box, see steps 2 through 5 in Task 2: Enable Service account for Kerberos Constrained Delegation. 8. Repeat steps 2 through 7 for any additional PI Data Archive servers for the PI Integrator for Business Analytics Windows service. Task 4: Add PI Asset Framework Servers with the AFServer Service Type The final task is to specify the PI AF server for Kerberos constrained delegation for the PI Integrator for Business Analytics Windows service. Procedure 1. With the Add Services dialog box still open from Task 2: Enable Service account for Kerberos Constrained Delegation, click Users or Computers. 48 PI Integrator for Business Analytics 2015 User Guide

53 Administration tasks The Select Users or Computers dialog box appears. 2. Enter the name of the server with the PI AF Server installed. Note: Do not enter the machine hosting the PI AF database, which may or may not be located in a different machine than the PI AF Server. Enter the PI AF Server. 3. Click on the Check Names button to verify the server name. The server name appears verified. 4. Click OK. PI Integrator for Business Analytics 2015 User Guide 49

54 Administration tasks The Add Services dialog box appears. 5. Select the AFServer Service Type within the list of available services. 6. Click OK. The selected PI AF server is assigned the AFServer Service Type. 7. Verify that the selected PI AF server was assigned the AFServer Service Type by opening the Delegation tab of the Account Properties dialog box. For more information about navigating to the Account Properties dialog box, see steps 2 through 5 in Task 2: Enable Service account for Kerberos Constrained Delegation. 8. Repeat steps 2 through 7 for any additional PI AF servers for the PI Integrator for Business Analytics Windows service. 50 PI Integrator for Business Analytics 2015 User Guide

55 How to use PI Integrator for Business Analytics PI Integrator for Business Analytics provides an easy to use, web-based user interface. The following sections describe its main features. Overview of features and use of PI Integrator for Business Analytics This outline describes how to use PI Integrator for Business Analytics to produce decisionready data for utilization in your BI tool. Detailed procedures follow that show how to create an asset view and how to modify that view. 1. PI Integrator for Business Analytics opens at the My Views page, which provides a dashboard showing the details and status for all views you have permission to work with. For more information, see The My Views page. To start using PI Integrator for Business Analytics, direct your web browser to the PI Integrator for Business Analytics website set up by your administrator. The web site URL should follow the format: 2. The most important concept for gathering data to prepare for your BI analysis is creating a view and defining the shape it uses. A view is a row and column representation of data that BI tools can consume. A shape is a pattern for searching for data within the PI System. The shape contains the elements, attributes, and their relationships, that you want to find matches for in your AF database. It provides the unique ability to search for matching relationships between elements and attributes, as well as the elements and attributes themselves. Previously in the PI System, you could use only templates, names, and categories as parameters for search. With PI Integrator for Business Analytics you can define parents, children, and their relationship as part of the shape, and use all of them to find more refined target-information in the PI System. For more information, see What is a shape?. 3. Generalize your shape to find similar assets. You can start by creating a simple shape, for example, to find a single asset. Then you can generalize the shape to find all similar assets. The Matches pane keeps track of assets, and attributes (or combinations thereof) your shape has found. Up to the first one hundred matches from the AF database are shown. Every match is directly comparable and "swappable", which enables you to explore relationships within your PI System data in new and unique ways. 4. View a preview of your data set. The preview shows a representative subset of information to give you an idea of how the data will look. The preview is built from the first ten matches found and uses the first 100 records for each match, so even for large queries it is produced relatively quickly. 5. Add any data columns and time duration columns that help you organize and provide context for the data for analysis. PI Integrator for Business Analytics 2015 User Guide 51

56 How to use PI Integrator for Business Analytics The preview shows a number of default columns. A value from each level in the shape is automatically added to the default columns. For elements, this is the element name. For attributes, this is the value, which can be time series data or descriptive information. In addition to the default columns, you can add any data columns and time duration columns that you need to include in your analysis. 6. Apply filters to further drill down into your data. 7. Where required, set up calculations on values in a data column. 8. Publish the data to a PI View. You can schedule the data to be published one time only, or periodically. After being published, the data is accessible using the PI ODBC Driver by any ODBCcompatible BI tool, using a high-throughput connection. To create your first view, follow the steps shown in Create an asset view. The My Views page The My Views page shows details about your views. 1. All the views to which you have access are listed in the table. 2. Click the control at the right side of the list, to customize the table columns displayed. Select and deselect columns to change those displayed and then click Apply. 3. If a view is shown as locked (padlock symbol) this means you cannot make changes to it, because it has already been published. If desired, you can make a copy of the view and then make changes to the copy. 52 PI Integrator for Business Analytics 2015 User Guide

57 How to use PI Integrator for Business Analytics 4. To modify a view, select it in the table and click Modify View. To delete it, click Remove View. Deleting a view removes data from the buffer, therefore saving space. But does not free output streams in regard to licensing. 5. For the selected view, the Overview, Log and Security tabs below the table provide details about that view: Overview indicates whether the view has been published yet. This tab also summarizes information about the view, such the AF database it uses, when the view was last run, and the shape that it uses. If the view is currently being published, the run status bar indicates progress and you have the option to stop the publishing process. Log shows information from the Windows Event Viewer. You can adjust the start and end times, and filter to see messages of a certain severity only, such as Critical errors. Security shows who has access to the view, and if you have sufficient privilege, allows you to change their kind of access. 6. To create a new view, click the Create Asset View button. 7. The red message counter icon at top right shows the number of warning and error messages recorded by PI Integrator for Business Analytics. Click the icon to open the message list. 8. Click the information icon at top right to see the version of PI Integrator for Business Analytics and of PI AF that you are using. What is a shape? You can set up sophisticated pattern matching by defining the shape. The shape represents assets, and attributes in your AF database plus relationships between them. PI Integrator for Business Analytics combines the matches found by the shape with those found by filters you apply. The result is the subset that matches both sets of criteria. You might define a shape that fulfills a description similar to these examples: Find all heat exchangers in Houston that have inlet and outlet temperatures, and were made by Keystone. Find all assets that produce kwh and are in the renewable category. Generalize a single asset to find all assets derived from the same template After you have dragged and dropped a particular asset to the shape and found its matches, you can adjust the shape to find matches for all assets derived from the same template. As described in Create an asset view, click the Edit Filters icon next to the asset, uncheck the Asset Name filter, and check the Asset Template filter (which contains the name of the asset template). PI Integrator for Business Analytics 2015 User Guide 53

58 How to use PI Integrator for Business Analytics Find matches for similar assets with different attributes Use optional matching if you need to find matches for similar assets that have a different set of attributes. For example, Pump A might have attributes Temp1 and Temp2, whereas Pump B has attributes Temp1, Temp2, and Temp3. In this case, check the Optional Attribute box to make the attribute Temp3 on Pump B not required in a match. What is a PI View? PI Views are a row and column representation of data that your BI tools can consume. Format the data in one of the following ways: Evenly-spaced in time (also known as interpolated) Based on a reference attribute time (also known as compressed) Timestamps are taken from the reference attribute, all others are interpolated. Create an asset view To configure a PI View for use with PI Integrator for Business Analytics, direct your web browser to the PI Integrator for Business Analytics website set up by your administrator. The web site URL should follow the format: IntegratorComputerName:IntegratorPort. Procedure 1. Click Create Asset View and enter a name for the new PI View. 2. Add the data you're interested in analyzing. 54 PI Integrator for Business Analytics 2015 User Guide

59 How to use PI Integrator for Business Analytics Use the Server and Database fields to browse to the desired AF server and database. 3. Drag and drop elements and attributes from the AF tree view onto the Asset Shape. According to the location of your cursor on the shape, there are different drop zones that enable you to add an item at the top level or as a parent, child, or sibling entity. A shape is a pattern for searching for data within the PI System. PI Integrator for Business Analytics automatically builds the PI System data into a table format, which your BI tools can read. Drill down to find the asset you want to analyze and drag it onto the Asset Shape. When you select an element, the Attributes pane opens so that you can drag attributes to include. Note that you can sort the attributes, group them by category, or filter which attributes are displayed, to more easily find the ones you want. 4. To gather data for all assets that share the same AF base template, click the Edit Filters icon next to the asset, uncheck the Asset Name filter, and check the Asset Template filter. PI Integrator for Business Analytics will include data from all assets that share this template, as shown in the Matches pane. PI Integrator for Business Analytics 2015 User Guide 55

60 How to use PI Integrator for Business Analytics 5. Use optional matching if you need to find matches for similar assets that have a different set of attributes. For example, your newer equipment might have a wider or different range of attributes. In this case, click the Edit Filters icon next to the attribute that you do not require in every match, and check the Optional Attribute box. 6. Click Next to see a subset of your data as a preview. 56 PI Integrator for Business Analytics 2015 User Guide

61 How to use PI Integrator for Business Analytics 7. If you want to add further data columns or time slices to your PI View, click Add Column. For example, you might pick Day and Hour, or show the Day of the Week. 8. To apply a filter to your data set, click Edit Row Filters. A variety of filters are available. For example, to include rows where specific event frames are active, apply a filter of type Event Frame. For more information, see Filter a view. 9. To modify a column, click it to open the Column Details blade. Here, you can rename a column, set a calculation such as an average on the values in the column, adjust the data type, or remove the column. Note: The Last Recorded Value function in the Data Content field is for use with data that should not be interpolated, for example, a status attribute that is either on or off. Last Recorded Value looks back in time and returns the most recent value of the switch. PI Integrator for Business Analytics 2015 User Guide 57

62 How to use PI Integrator for Business Analytics 10. Click Next to move on to publishing your PI View. 11. Choose PI View for the Target Configuration. 12. Click Run Once to set the PI View to be created one time, or click Run on a Schedule to periodically append new data to the PI View. 13. Click Publish. After being published, the data is accessible using the PI ODBC Driver by any ODBCcompatible BI tool, using a high-throughput connection. 58 PI Integrator for Business Analytics 2015 User Guide

63 How to use PI Integrator for Business Analytics Modify a view Note: You cannot change a view if it has already been published (in MyViews, it will have a padlock symbol next to it). If desired, you can make a copy of the view and then make changes to the copy. Before publishing a view, you can make adjustments to it, including: Handle interpolated values You can adjust the sampling interval or you can choose to use a key column to organize the data in the view. For more information, see Adjust how values are interpolated. Add a column, either a data column based on an attribute or a time slice. For more information, see Add a column. Filter the data in a view. For more information, see Filter a view. Adjust how values are interpolated You can control how data is interpolated within your view by adjusting the sampling interval or organizing the data based on an attribute as a key column. Procedure 1. On the My Views page, select the PI View that you want to modify and click Modify View. 2. Click Next to go to the Modify View page. 3. Click the Edit Value Mode button. In the Edit Value Mode window, you have options to set sampling to a specific time interval or to choose a key column to organize the data. 4. Select either Sample values or Use Key Column. To change the sampling interval so that a value is interpolated at the time interval you specify, for example every 15 minutes, click Sample values every and set the value and unit for the time interval you want. To use one of your attributes to organize how data is interpolated, click Use Key Column and choose the appropriate column for the attribute from the dropdown list. Other PI Integrator for Business Analytics 2015 User Guide 59

64 How to use PI Integrator for Business Analytics attributes will be interpolated to produce values at the same timestamps as the actual timestamps of this attribute. Add a column You can add columns to your view. Perhaps you need to slice your data by a variety of time intervals, or you might want to add a data column based on an attribute. Procedure 1. On the My Views page, select the PI View that you want to modify and click Modify View. 2. Click Next to go to the Modify View page. 3. Click the Add Column button. To add a data column, on the Data Column tab select the attribute to be the data source. Give the column a unique name, and use the Column Data Content field if you want to set a calculation, such as an average, on the values in the column. If necessary, adjust the data type using the Data Type field. When you are finished, click Add Column. Note: The Last Recorded Value function in the Column Data Content field is for use with data that should not be interpolated, for example, a status attribute that is either on or off. Last Recorded Value looks back in time and returns the most recent value of the switch. To add a time slice column, on the Time Column tab select the required time interval. For example, you might pick Day and Hour, or show the Day of the Week. When you are finished, click Add Column. 60 PI Integrator for Business Analytics 2015 User Guide

65 How to use PI Integrator for Business Analytics Filter a view You can filter the data in a view using various parameters. For example, you can specify to include rows if the contents of a column have particular numeric values, or text. When you apply a filter, PI Integrator for Business Analytics takes the data set that matches your asset shape, joins it to the data set that matches your filter, and produces the subset of data that satisfies both. Procedure 1. On the My Views page, select the PI View that you want to filter and click Modify View. 2. To apply a filter, click the Edit Row Filters button and choose the type of filter you need. Most often, this is likely to be a numeric filter, or maybe a string filter. PI Integrator for Business Analytics 2015 User Guide 61

66 How to use PI Integrator for Business Analytics For information about applying an Event Frame filter, see Filter by event frames. 3. When you have finished defining the filter, click Save Event Frame Row Filter. Filter by event frames The following procedure shows how to apply an event frame row filter to an asset view. When you define an asset shape, you create a collection of matches that all have the same criteria. When you apply an event frame filter to this view, you define an event shape that creates a collection of matches for a set of event frames. PI Integrator for Business Analytics then joins these two collections based on a common asset, to obtain the subset of data that matches both. For example, assume you have a number of wells where a certain piece of equipment is run one-by-one at each well, and event frames are used to record the data collected by this equipment. Each event frame has a different start and end time, and applies to a different well. You can use the event frame row filter to align the correct event frame with the correct well, in your asset view. Procedure 1. On the My Views page, select the PI View that you want to filter and click Modify View. 2. Use the Start Time and End Time fields to adjust the time range to include the times when the event frames of interest were recorded. 3. Click Edit Row Filters and choose Event Frame for the type of filter. PI Integrator for Business Analytics now searches for event frames on your AF server for this PI View and displays a subset of the ones it finds. 62 PI Integrator for Business Analytics 2015 User Guide

67 How to use PI Integrator for Business Analytics 4. Click in the Event Frames field. In the filtering fields, specify parameters to narrow down the event frames to find the ones you are looking for. For example, enter a pattern-matching string in the Event Name field or select a template in Event Template. PI Integrator for Business Analytics 2015 User Guide 63

68 How to use PI Integrator for Business Analytics 5. Click Apply Filters. 6. From the event frames found, drag and drop an event frame that you want to include in your view to the center panel (labelled Drag an Event Frame from the Event Frames Palette here). The filter now includes rows for which this event frame is active. 7. Optionally, you can broaden the row filter search criteria to include all event frames with the same template, or category. To do this, use the dropdown field to change the search from Event Name to Event Template or Category. 8. Click the apply icon next to the event condition. PI Integrator for Business Analytics fetches matching event frames and shows them in the preview pane at the bottom of the window. 9. To align the event frames with the correct asset, drag the asset or attribute from the Shape Tree onto the filter criteria. This step defines the relationship between the two data sets (the event frame data set and the asset and attributes data set). This is similar to the clause in a relational table join that equates an attribute in one table (or dataset) to an attribute in the other table (dataset). Here, we are equating the asset "owning" the event frame to the asset from your Shape Tree. PI Integrator for Business Analytics updates the display of matching event frames in the preview, accordingly. 10. When you have finished defining the filter, click Save Event Frame Row Filter. 64 PI Integrator for Business Analytics 2015 User Guide