PI Coresight 2012

Administrator Guide
OSIsoft, LLC
777 Davis St., Suite 250
San Leandro, CA 94577 USA
Tel: (01) 510-297-5800
Fax: (01) 510-357-8136
Web: http://www.osisoft.com

OSIsoft Australia • Perth, Australia

OSIsoft Europe GmbH • Frankfurt, Germany
OSIsoft Asia Pte Ltd. • Singapore
OSIsoft Canada ULC • Montreal & Calgary, Canada
OSIsoft, LLC Representative Office • Shanghai, People’s Republic of China
OSIsoft Japan KK • Tokyo, Japan
OSIsoft Mexico S. De R.L. De C.V. • Mexico City, Mexico
OSIsoft do Brasil Sistemas Ltda. • Sao Paulo, Brazil
OSIsoft France EURL • Paris, France

PI Coresight 2012 Administrator Guide

Copyright: © 2011-2012 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 Manual Logger, PI ProfileView, 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 227.7202, DFARS 252.227-7013, FAR 12.212, FAR 52.227, as applicable. OSIsoft, LLC.
Version: 1.1
Published: 4/11/2012
Table of Contents
Chapter 1 Installation and Configuration ....................................................................................1
System Requirements ........................................................................................................1
Before Installation...............................................................................................................3
Install PI Coresight .............................................................................................................5
Upgrade PI Coresight.........................................................................................................6
After Installation..................................................................................................................6

Chapter 2 Administration............................................................................................................13
Administration Website.....................................................................................................13
Check PI Coresight Status ...............................................................................................13
PI System Configuration ..................................................................................................14
Reassign the Owner of a Display.....................................................................................16
Generate Reports.............................................................................................................16
Regionalization.................................................................................................................17
Time Zone Settings ..........................................................................................................17
Kiosk Mode.......................................................................................................................20
Changing the Owner of the PI Coresight Database.........................................................20

Appendix A Logging and Instrumentation................................................................................23

About PI Data Services ....................................................................................................23
Initial Settings ...................................................................................................................23
Modify Configuration ........................................................................................................27
Message Throttling...........................................................................................................29

Appendix B Technical Support ..................................................................................................31

PI Coresight 2012 Administrator Guide iii

Chapter 1

Installation and Configuration

This section provides instructions on how to install and configure PI Coresight.

System Requirements

PI Coresight Application Server

Operating System
• Microsoft Windows Server 2008 R2 SP1 64-bit
Software
• Microsoft SQL Server 2008 R2
ο Standard, Enterprise, or Express

Note: The PI System, PI Coresight application server and PI Coresight database

must belong to the same domain.

• Microsoft .NET Framework 4

(http://www.microsoft.com/downloads/en/details.aspx?displaylang=en&FamilyID=0a39
1abd-25c1-4fc0-919f-b21f31ab88b7)
• Microsoft Internet Information Services (IIS) 7.5
PI Coresight Application Server Hardware Recommendation
The following recommendations are based on the Microsoft SQL Server residing on the same
machine as the PI Coresight application server.
# of Users 1 to 50 50 to 250 250-500
CPU (Cores) 2 4 8
CPU Speed (GHz) 2 2.5 3
Memory (GB) 4 8 16
Disk (GB)* .5 1.5 2.5
*Disk requirements are estimated at approximately 250MB + 5 MB per user

PI Coresight 2012 Administrator Guide 1

Installation and Configuration

Microsoft SQL Server Express 2008 R2 should be sufficient for the server loads above. Full
versions of Microsoft SQL Server located on dedicated servers will have a positive impact on
scaling, but should only be required for loads greater than 500 users.
The PI Coresight SQL Server database requires approximately 3MB of storage plus 5MB per
user (assuming 200 average-sized displays per user).

PI System
This release supports PI Server 3.3 and later. We recommend that you employ the Microsoft
Windows authentication model with PI Identities for enhanced security.
This release supports PI Asset Framework 2010, but we recommend that you use PI AF 2010
R2 or later. We also recommend that PI SQL for AF 2.3.1.0 is installed on the PI AF Server
to optimize PI AF searches from PI Coresight. This version of PI SQL for AF is not needed
for PI AF 2010 R3 since PI AF 2010 R3 already includes these performance enhancements.

Note: The PI System server(s) must be in the same domain as the PI Coresight
application server and Microsoft SQL Server hosting the PI Coresight database.

Clients
This release has been tested with the following Microsoft Silverlight 5-supported browsers:
ο Microsoft Internet Explorer 6
ο Microsoft Internet Explorer 8
ο Microsoft Internet Explorer 9
ο Google Chrome 15.0.874.106
ο Firefox 7.0.1

Note: Both Chrome and Firefox require explicit URIs to be configured before
Microsoft Windows-specific security authentication can be performed.

To configure Firefox’s trusted sites, open Firefox and type about:config

into the address bar (confirm any warning dialogs that may appear). Enter
auth into the filter field and find both the network.negotiate-
auth.trusted-uris and network.negotiate-auth.delegation-
uris preference fields. Double-click each field and enter the name/URL of the
PI Coresight application server.

To configure Chrome’s trusted sites, create the following registry key:

HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Google\Chrome. Under this
key create a string (REG_SZ) value named
AuthNegotiateDelegateWhitelist. Set this value to the name/URL of
the PI Coresight application server. Chrome also supports setting this whitelist
via the command line (--auth-negotiate-delegate-whitelist) or via
Windows Group Policies. For more information see Use Chrome policy
templates
(http://support.google.com/a/bin/answer.py?hl=en&answer=187945).

2
 Before Installation

Before Installation

Server Manager Roles and Features

This table provides recommendations for Microsoft Windows 2008 R2 Server.

The following are minimum server manager Web Server
roles: ƒ Common HTTP Features
ƒ Static Content
ƒ Default Document
ƒ HTTP Errors
ƒ Application Development
ƒ .NET Extensibility
ƒ Security
ƒ Windows Authentication
ƒ Request Filtering
ƒ Performance
ƒ Static Content Compression
Management Tools
ƒ IIS Management Console
The following are minimum server features: Windows Process Activation Service
ƒ Process Model
ƒ .NET Environment
ƒ Configuration APIs
.NET Framework 3.5.1 Features
ƒ .NET Framework 3.5.1
ƒ WCF Activation
ƒ HTTP Activation

PI Coresight 2012 Administrator Guide 3

Installation and Configuration

The following are recommended server Application Server

manager roles: ƒ .NET Framework 3.5.1
ƒ Web Server (IIS) Support
ƒ Windows Process Activation Service Support
ƒ HTTP Activation
Web Server
ƒ Common HTTP Features (all but WebDAV
Publishing)
ƒ Application Development
ƒ ASP.NET
ƒ .NET Extensibility
ƒ ISAPI Extensions
ƒ ISAPI Filters
ƒ Health and Diagnostics
ƒ HTTP Logging
ƒ Logging Tools
ƒ Request monitor
ƒ Tracing
ƒ Security (all)
ƒ Performance (all)
Management Tools
ƒ IIS Management Console
ƒ IIS Management Scripts and Tools
ƒ Management Service

Service Account

You should create a dedicated Windows Active Directory custom service account for the PI
Coresight application server. The account should already be created (and its name and
password should be on-hand) prior to installing PI Coresight. The PI Coresight application
pools are executed under this identity and are used to connect to the PI System.
This custom service account requires the following rights:
• Login access to the SQL Server used by PI Coresight and limited access to the PI
Coresight database (access to other databases on this SQL Server is not needed).
• Access to all PI Server and PI AF Servers.
In this document this account is referred to as the CoresightService account. We recommend
that the account actually be named this, but is not required. These installation instructions
assume you are using this literal name. When configuring PI Coresight with this identity it is
typically prefixed by its Active Directory Domain.
The convention in the following sections is as follows:
YourDomain\CoresightService
• YourDomain—the name of your Active Directory domain
• CoresightService—the name of the service account created for PI Coresight

4
 Install PI Coresight

Installing on an Existing PI WebParts or PI WebServices Application Server

PI Coresight must be installed to a website with no other Web applications. Therefore, prior
to installing on an existing PI WebParts or PI Web Services application server you must
create a separate website with a unique port number. This website must then be entered in the
IIS website dialog box. You cannot install PI Coresight under an existing Web application.

Install PI Coresight
Follow these steps to install PI Coresight:
1. Log onto the application server as a System Administrator, using a domain user account
that belongs to the local Administrators group.
2. Right-click the PI Coresight setup executable and select Run as Administrator to launch
the installation wizard.
The installer displays a list of software components that are required by PI Coresight.
Some components may already be present on your computer, and are upgraded if
necessary.
3. Review the list of software components and click OK to proceed with the installation.
The installation kit installs the required components including PI AF client, PI OLEDB
Enterprise, and PI SDK.

Note: If a PI AF Server is not available during installation, leave the server field
blank and click Next. You can add a PI AF Server later using PI System
Explorer.

4. At the prompt, enter a directory location for PI Coresight. We highly recommend that all
OSIsoft components are installed in the same root folder, for example, <Program
Files>\PIPC.
5. Click Next, then select a Web Site Name where PI Coresight will be installed. This must
be a separate Web application.
6. Click Next to begin the installation. The installation process does the following:
ο Creates pre-populated Windows groups PI Coresight Admins and PI
Coresight Users on the application server
ο Creates the PI Coresight Administration website
ο Creates the PI Coresight website along with the following application pools:
CoresightServiceAppPool and CoresightAdminAppPool (these
application pool IDs are defaulted to NT Authority\Network Service)
7. When the installation is complete, you will have the option to launch the PI Coresight
Administration web site.

PI Coresight 2012 Administrator Guide 5

Installation and Configuration

Upgrade PI Coresight
Release PI Coresight 2012 upgrades PI Coresight 1.0.0.6b by saving Allowed PI Servers and
AF Databases and preserving the PI Coresight database.
To ensure that PI Coresight display data is not lost, a copy of the database is saved as a
backup file during the upgrade process. This backup file is overwritten each time an upgrade
is run.
This backup file is called CoresightDatabase.backup and is located in the default
Microsoft SQL Server backup directory, which is typically:
<Program Files>\Microsoft SQL
Server\MSSQL10_50.SQLEXPRESS\MSSQL\Backup
Copies of upgraded web.config files are also created and are located in:
<Program Data>\.OSIsoft\Coresight\PIDSTemp

After Installation

PI Coresight Application Pool Identities

If using a custom service account, you must configure the two Application Pools used by PI
Coresight to use this identity. By default, these application pools are defaulted to NT
Authority\Network Service.
• CoresightAdminAppPool runs the Administration site, located at http://<web
server>/Coresight/Admin
• CoresghtServiceAppPool runs the main PI Coresight application services located
at http://<web server>/Coresight

PI Coresight User Groups

Access to the PI Coresight Administration website and the PI Coresight website are restricted
through separate Microsoft Windows groups. The PI Coresight setup program creates two
local user groups on the PI Coresight application server:
• PI Coresight Admins
This group is used to control access to the PI Coresight Administration website located
at:
http://<web server>/Coresight/Admin
The group is initialized once you run the PI Coresight setup kit. By default, only the user
running the installation is added to this group.
• PI Coresight Users
This group is used to control access to the PI Coresight main application located at:
http://<web server>/Coresight

6
 After Installation

The group is initialized with Authenticated Users as a member so that anyone

that can access the application server can also access PI Coresight. You can limit access
to PI Coresight by removing this group and adding only authorized users to the PI
Coresight Users group.

PI Coresight Database

PI Coresight uses Microsoft SQL Server to store user settings and displays. The database for
PI Coresight storage is not created as part of the installation kit and must be generated before
using the application. If the Microsoft SQL Server is running on the same machine as the PI
Coresight application server, then the database can be generated by using the Administration
Web site. If the Microsoft SQL Server is running on a remote machine, the database is
generated by following the instructions specified in Create a Remote PI Coresight Database
(page 8).
Before creating the PI Coresight database you must first obtain the following information
from your organization’s SQL Server administrator:
• The name of the Microsoft SQL Server (or SQL Express) to host the PI Coresight
database, for example, MyDBserver\MyInstance.
• An appropriate database name for the PI Coresight database, for example, Coresight.
• Verification that the CoresightService account has access to the Microsoft SQL Server. If
the PI Coresight application pool identities are left as the default value (NT
Authority\Network Service), the machine hosting the application server must
have access to the Microsoft SQL Server, e.g. <machine name>$.

Configure a Microsoft SQL Server

Follow these steps to configure your connection to a local or remote Microsoft SQL Server.
We recommend that you leverage the Microsoft SQL Server used for PI AF to host your PI
Coresight database.

Note: If the browser used to access the PI Coresight Administration website is run locally
on the PI Coresight application server, it must be run as an administrator for any
changes to take effect. This is not necessary when accessing the administration
website remotely. To set your browser to run as administrator, right-click the
browser's shortcut icon and select Run as administrator. The PI Coresight
Administrator(s) needs read and write access to all PI Coresight web.config files
installed in the IIS virtual directories.

1. In your Web browser, navigate to the PI Coresight Administration website. By default

this site is located at:
http://<web server>/Coresight/Admin
2. Click the PI Coresight Configuration tab.
3. Click the change link in the table row for SQL Server.

PI Coresight 2012 Administrator Guide 7

Installation and Configuration

4. Enter the name of the Microsoft SQL Server you want to use, or click the ellipsis button
to search for an existing one.

5. Click Set.

Create a Local PI Coresight Database

The following steps will create and/or configure a PI Coresight database to the local
Microsoft SQL Server. If you are using a remote SQL Server, refer to the topic "Create a
Remote PI Coresight Database."
1. Click the change link in the table row for PI Coresight database.

2. Enter the name of the PI Coresight database you want to use, or click the ellipsis button
to search for an existing one. If you enter a new database name, and the user running the
Administration website has permissions to create a database on the Microsoft SQL
Server, a new database is created. If you select an existing database, PI Coresight
connects to it.
3. Click Set. A green check mark appears in the Status column next to the Microsoft SQL
Server and database names to verify successful configuration.

Note: If you are having issues creating the PI Coresight database on a remote Microsoft
SQL Server, please see the steps below to manually create the PI Coresight
database.

Create a Remote PI Coresight Database

The following steps create and configure a PI Coresight database that is remote from the PI
Coresight application server, usually hosting the PI AF database(s).
1. On the application server find the SQL directory and copy it. This directory is typically
located here:
<Program Files>/PIPC/Coresight/Admin/SQL
2. Go to the machine running the remote Microsoft SQL Server and paste the folder and all
its contents to a local directory.

8
 After Installation

3. On the machine running Microsoft SQL Server, open a command prompt as

Administrator, navigate to the local directory used in step 2, and enter the command:
Go.bat <DBServer> <DBName> <CoresightService account>

Note: If spaces appear in any DBServer or the CoresightService account, as

explained in the Service Account section above, enclose the parameter in
double quotes. Also, if the CoresightService account is Network Service,
append a $ to the name, for example, <domain>\<machine name>$.

4. After the command has completed, return to the PI Coresight Configuration page.
5. Click the change link in the table row for the PI Coresight database.
6. Enter the name of the PI Coresight database you created, or click the ellipsis button to
search for it.
7. Click Set.
8. When prompted to confirm your entry, click Yes. A green check mark appears in the
Status column next to the Microsoft SQL Server and database names to verify successful
configuration.

Upgrade a PI Coresight Database

When you install a newer version of PI Coresight, the installation program attempts to
automatically update the database. Confirm this after installation.
1. Browse to the PI Coresight Database Configuration page of the PI Coresight
Administration website.
If the database was not upgraded during installation, usually due to permission problems,
the following page is shown:

2. Click the Upgrade button to upgrade the existing database.

Note: The user running the PI Coresight Administration website must have the
appropriate privileges to the PI Coresight database on the Microsoft SQL Server.

PI Coresight 2012 Administrator Guide 9

Installation and Configuration

If the upgrade fails you need to manually run Go.Bat on the machine running Microsoft
SQL Server hosting the PI Coresight database, as explained in Manually Create a PI
Coresight Database (Optional) (page 10).

Manually Create a PI Coresight Database (Optional)

You can use the following steps to create, upgrade, and configure a PI Coresight database
without using the PI Coresight Administration website on a Microsoft SQL Server.
1. On the application server find the SQL directory and copy it. This directory is typically
located here:
<Program Files>/PIPC/Coresight/Admin/SQL
2. Go to the machine running the remote Microsoft SQL Server and paste the folder and all
its contents to a local directory.
3. On the machine running Microsoft SQL Server, open a command prompt as
Administrator, navigate to the local directory used in step 2, and enter the command:
Go.bat <DBServer> <DBName> <CoresightService account>

Note: If spaces appear in any DBServer or the CoresightService account, as

explained in the Service Account section above, enclose the parameter in
double quotes. Also, if the CoresightService account is Network Service,
append a $ to the name, for example, <domain>\<machine name>$.

4. After the command has completed, return to the PI Coresight Configuration page.
5. Click the change link in the table row for the PI Coresight database.

6. Enter the name of the PI Coresight database you created, or click the ellipsis button to
search for it.
7. Click Set.
8. When prompted to confirm your entry, click Yes. A green check mark appears in the
Status column next to the Microsoft SQL Server and database names to verify successful
configuration.

PI System Security

Configure PI Server Security

You must establish a security mapping for the CoresightService account on all PI Servers that
will be accessed by PI Coresight. This Windows account must be mapped to a PI identity (or
PI user or PI group) that has read access to all PI points that are accessed by PI Coresight.
Security is enforced for each user’s access to a PI point on a display or a search result using
the individual’s user account mappings.

10
 After Installation

For information on how to create a PI identity, see Configuring PI Server Security available
at:
http://techsupport.osisoft.com

Configure Kerberos Security

We recommend that you use Microsoft Windows Integrated Security for authentication to the
PI Server. To enable users to connect to the PI Server using Windows Integrated Security,
configure Kerberos delegation for the PI Coresight application server. This allows users to
connect to PI Coresight and use their corresponding Windows mappings on the PI Server.
The PI Coresight application server must be allowed to delegate credentials on its host
domain using the following steps:
1. On your domain controller, open Active Directory Users and Computers.
2. Select Computers under the domain of the PI Coresight application server.
3. Right-click the PI Coresight application server and click Properties.
4. Specify a trust setting for the computer.
For a Windows Server 2003 or 2008 domain controller: on the Delegation tab, select
either Trust this computer for delegation to any service (Kerberos only) or Trust this
computer for delegation to specified services only.

Note: If you are using a Custom Host name instead of the NetBIOS name, please refer
to Service Principal Name (SPN) checklist for Kerberos authentication with IIS
7.0/7.5 http://blogs.msdn.com/b/webtopics/archive/2009/01/19/service-principal-
name-spn-checklist-for-kerberos-authentication-with-iis-7-0.aspx for additional
configuration information.

Using PI Coresight from a website using Secure Sockets Layer (SSL)

To run PI Coresight from a website that is using SSL, you must manually edit the Web.config
file that is found in the Services folder <Program
Files>/PIPC/Coresight/Services/web.config.
• In Web.config, change httpTransport to httpsTransport

Using SSL to communicate with Microsoft SQL Server

To enable SSL communication between the PI Coresight services and Microsoft SQL Server,
the ConnectionString in the Services\Web.config file needs to be modified.
1. Append encrypt=true;trustServerCertificate=false to the element.
The entire element should appear as follows:
connectionString="Data Source=.\SQLEXPRESS; Initial
Catalog=Coresight; Integrated Security=True; Application
Name=Coresight Web Service; encrypt=true;
trustServerCertificate=false;"

PI Coresight 2012 Administrator Guide 11

Installation and Configuration

2. If the server certificate is self-signed or was not issued by a trusted certificate authority,
the trustServerCertificate setting should be changed to true.

PI AF Security
To give PI Coresight users the ability to search and view data from PI AF, you must grant
read access to the following accounts:
• The PI Coresight user’s account
• The CoresightService account
• The PI AF Service account on the PI AF Server (if Network Service, use the machine
account of the PI AF Server)

Note: The PI AF Server service account is a requirement for PI AF Server 2.3 and
earlier, this is not required for later versions of PI AF.

12
Chapter 2

Administration

Administration Website
All users that have been added to the PI Coresight Admins group on the application
server have access to the PI Coresight Administration website.
You can perform certain administration tasks at this website, which is located at:
http://<web server>/Coresight/Admin
The site enables you to:
• Add or remove PI Servers and PI AF databases from searches and data retrieval
• Create a PI Coresight database
• Configure the location of the PI Coresight database
• Reassign displays from one user to another
• Produce reports
• Verify the versions of required PI Coresight assemblies

Note: If the browser used to access the PI Coresight Administration website is run locally
on the PI Coresight application server, it must be run as an administrator for any
changes to take effect. This is not necessary when accessing the administration
website remotely. To set your browser to run as administrator, right-click the
browser's shortcut icon and select Run as administrator. The PI Coresight
Administrator(s) needs read and write access to all PI Coresight web.config files
installed in the IIS virtual directories.

Check PI Coresight Status

Use the PI Coresight Administration website to check the status of your PI Coresight
application server. By default this site is located at:
http://<web server>/Coresight/Admin
Both the Home and Version Information tabs contain PI Coresight status information.
• Home tab

PI Coresight 2012 Administrator Guide 13

Administration

Shows a list of your configured PI Servers and PI AF databases. Click the appropriate
change link to modify this list. This table also shows the domain account used to connect
to each type of server/database and the PI user for PI Servers.
This tab also shows the status of PI OLEDB Enterprise connecting to the allowed PI AF
system and if all the file versions meet the required minimum version.
• Version Information tab
Provides a list of installed PI Coresight files and their required minimum file and version
information. The Status column indicates that a file exists and whether it meets the
required minimum version requirements.

PI System Configuration
One of the main features of PI Coresight is the ability to search a PI System without
specifying PI Servers or PI AF databases. This is accomplished by configuring the PI
Coresight application server to use the appropriate PI System servers and databases.

Test Connection to the PI System

Before configuring PI Coresight, you must connect to the PI Server(s) and PI AF database(s)
you intend to use with PI Coresight.
• To connect to a PI Server, use PISDKUtility
• To connect to a PI AF database, use PI System Explorer

Note: PISDKUtility and PI System Explorer are installed as part of the PI Coresight
installation. Help for these applications is available in the
<Program Files>\PIPC\Help directory.

Configure PI Servers

To connect to PI Servers use the PISDKUtility application that is installed with PI Coresight.
Once you have established connection with PI Servers, follow these steps to configure which
PI Servers are used by the PI Coresight application.
1. In your Web browser, navigate to the PI Coresight Administration website. By default
this site is located at:
http://<web server>/Coresight/Admin
2. Click the PI Servers Configuration tab.

14
 PI System Configuration

3. In the PI Servers group box, click the Allowed check box next to the PI Servers you want
to use with PI Coresight search and data retrieval services. The Connection Status
columns indicate the availability of each registered server.

Note: The Test Connection button tests whether you can connect to the
appropriate PI Server using the CoresightService account. This is the identity
used by the PI Coresight application pools.

4. Click Submit changes to update the PI Coresight application server with your PI Server
selections.

Configure PI AF Databases

You must first connect to your PI AF databases using PI System Explorer on the PI
Coresight application server before they can be configured for use in PI Coresight. Once you
have established this connection, follow these steps to configure which PI AF databases users
can search and retrieve data from in the PI Coresight application.
1. In your Web browser, navigate to the PI Coresight Administration website. By default
this site is located at:
http://<web server>/Coresight/Admin
2. Click the PI AF Servers/Databases Configuration tab. The Registered PI AF
Servers and Databases page appears. This page presents the PI AF Servers
recognized by PI Coresight, and indicates whether you have an active connection to
them. The Status column indicates the availability of each registered server. If the status
is set to questionable, click the Test Connection button to establish a connection with a

PI Coresight 2012 Administrator Guide 15

Administration

PI AF Server. If the AF Server status is marked with a green check, a list of the PI AF
databases available appears in the Databases column next to their corresponding PI
AF Server name.
3. Click the Allowed check box next to the PI AF databases you want to connect to with PI
Coresight, and then click OK.
4. Click Submit Changes to update the PI Coresight application server with your PI AF
database selections.

Reassign the Owner of a Display

You can reassign ownership of a display from one user to another.
1. In your Web browser, navigate to the PI Coresight Administration website. By default
this site is located at:
http://<web server>/Coresight/Admin
2. Click the Reassign PI Coresight Displays tab.
3. In both the From and To lists, select a user name.
4. Click Displays will be reassigned when Submit is clicked.
5. Click Submit.

Generate Reports
PI Coresight administrators can generate reports for the following information about their
users:
• active users within a specified time period (summary information for users with access to
PI Coresight and detailed usage information for each active user, which can be included
in custom reports)
• the number of users and the number of displays owned by each user
To generate reports:
1. In your Web browser, navigate to the PI Coresight Administration website. By default
this site is located at:
http://<web server>/Coresight/Admin
2. Click the PI Coresight Reports tab.
3. Click View to see the report in your browser. Click Save to open or save the report to a
.csv file.
4. Click Details to generate a .csv file containing detailed information for custom reports.
The Details option is only available for the usage report.

16
 Regionalization

Regionalization
Each connected browser can support different regionalization settings (used for number, time,
and date formatting) by setting fields in Control Panel > Region and Language > Formats
tab.
To support one regionalization format for all users browsing to a PI Coresight website, add
the following line to the default.aspx file in the root PI Coresight installation folder:
<param name="Culture" value="<site wide region>" />
Specify the appropriate region in the value, for example, for French Canadian:
<param name="Culture" value="fr-CA" />
This line should be added after the following line:
<param name="UICulture"

Time Zone Settings

By default, PI Coresight uses the browser's time zone to display time information. To set the
same time zone for every user browsing to the PI Coresight website, add the following line to
the web.config file located at the PI Coresight root installation folder:
<appSettings>
<add key="PISymbols_SystemTimeZoneId" value="Eastern Standard
Time"/>
The value must be set to a one of the values specified in the following table:
System Timezone Id Display Name
Dateline Standard Time (GMT-12:00) International Date Line West
UTC-11 (GMT-11:00) Coordinated Universal Time-11
Samoa Standard Time (GMT-11:00) Samoa
Hawaiian Standard Time (GMT-10:00) Hawaii
Alaskan Standard Time (GMT-09:00) Alaska
Pacific Standard Time (Mexico) (GMT-08:00) Baja California
Pacific Standard Time (GMT-08:00) Pacific Time (US & Canada)
US Mountain Standard Time (GMT-07:00) Arizona
Mountain Standard Time (Mexico) (GMT-07:00) Chihuahua, La Paz, Mazatlan
Mountain Standard Time (GMT-07:00) Mountain Time (US & Canada)
Central America Standard Time (GMT-06:00) Central America
Central Standard Time (GMT-06:00) Central Time (US & Canada)
Central Standard Time (Mexico) (GMT-06:00) Guadalajara, Mexico City, Monterrey
Canada Central Standard Time (GMT-06:00) Saskatchewan
SA Pacific Standard Time (GMT-05:00) Bogota, Lima, Quito
Eastern Standard Time (GMT-05:00) Eastern Time (US & Canada)

PI Coresight 2012 Administrator Guide 17

Administration

US Eastern Standard Time (GMT-05:00) Indiana (East)

Venezuela Standard Time (GMT-04:30) Caracas
Paraguay Standard Time (GMT-04:00) Asuncion
Atlantic Standard Time (GMT-04:00) Atlantic Time (Canada)
Central Brazilian Standard Time (GMT-04:00) Cuiaba
SA Western Standard Time (GMT-04:00) Georgetown, La Paz, Manaus, San Juan
Pacific SA Standard Time (GMT-04:00) Santiago
Newfoundland Standard Time (GMT-03:30) Newfoundland
E. South America Standard Time (GMT-03:00) Brasilia
Argentina Standard Time (GMT-03:00) Buenos Aires
SA Eastern Standard Time (GMT-03:00) Cayenne, Fortaleza
Greenland Standard Time (GMT-03:00) Greenland
Montevideo Standard Time (GMT-03:00) Montevideo
UTC-02 (GMT-02:00) Coordinated Universal Time-02
Mid-Atlantic Standard Time (GMT-02:00) Mid-Atlantic
Azores Standard Time (GMT-01:00) Azores
Cape Verde Standard Time (GMT-01:00) Cape Verde Is.
Morocco Standard Time (GMT) Casablanca
UTC (GMT) Coordinated Universal Time
GMT Standard Time (GMT) Greenwich Mean Time : Dublin, Edinburgh,
Lisbon, London
Greenwich Standard Time (GMT) Monrovia, Reykjavik
W. Europe Standard Time (GMT+01:00) Amsterdam, Berlin, Bern, Rome,
Stockholm, Vienna
Central Europe Standard Time (GMT+01:00) Belgrade, Bratislava, Budapest,
Ljubljana, Prague
Romance Standard Time (GMT+01:00) Brussels, Copenhagen, Madrid, Paris
Central European Standard Time (GMT+01:00) Sarajevo, Skopje, Warsaw, Zagreb
W. Central Africa Standard Time (GMT+01:00) West Central Africa
Jordan Standard Time (GMT+02:00) Amman
GTB Standard Time (GMT+02:00) Athens, Bucharest, Istanbul
Middle East Standard Time (GMT+02:00) Beirut
Egypt Standard Time (GMT+02:00) Cairo
Syria Standard Time (GMT+02:00) Damascus
South Africa Standard Time (GMT+02:00) Harare, Pretoria
FLE Standard Time (GMT+02:00) Helsinki, Kyiv, Riga, Sofia, Tallinn,
Vilnius
Israel Standard Time (GMT+02:00) Jerusalem
E. Europe Standard Time (GMT+02:00) Minsk

18
 Time Zone Settings

Namibia Standard Time (GMT+02:00) Windhoek

Arabic Standard Time (GMT+03:00) Baghdad
Arab Standard Time (GMT+03:00) Kuwait, Riyadh
Russian Standard Time (GMT+03:00) Moscow, St. Petersburg, Volgograd
E. Africa Standard Time (GMT+03:00) Nairobi
Iran Standard Time (GMT+03:30) Tehran
Arabian Standard Time (GMT+04:00) Abu Dhabi, Muscat
Azerbaijan Standard Time (GMT+04:00) Baku
Mauritius Standard Time (GMT+04:00) Port Louis
Georgian Standard Time (GMT+04:00) Tbilisi
Caucasus Standard Time (GMT+04:00) Yerevan
Afghanistan Standard Time (GMT+04:30) Kabul
Ekaterinburg Standard Time (GMT+05:00) Ekaterinburg
Pakistan Standard Time (GMT+05:00) Islamabad, Karachi
West Asia Standard Time (GMT+05:00) Tashkent
India Standard Time (GMT+05:30) Chennai, Kolkata, Mumbai, New Delhi
Sri Lanka Standard Time (GMT+05:30) Sri Jayawardenepura
Nepal Standard Time (GMT+05:45) Kathmandu
Central Asia Standard Time (GMT+06:00) Astana
Bangladesh Standard Time (GMT+06:00) Dhaka
N. Central Asia Standard Time (GMT+06:00) Novosibirsk
Myanmar Standard Time (GMT+06:30) Yangon (Rangoon)
SE Asia Standard Time (GMT+07:00) Bangkok, Hanoi, Jakarta
North Asia Standard Time (GMT+07:00) Krasnoyarsk
China Standard Time (GMT+08:00) Beijing, Chongqing, Hong Kong, Urumqi
North Asia East Standard Time (GMT+08:00) Irkutsk
Singapore Standard Time (GMT+08:00) Kuala Lumpur, Singapore
W. Australia Standard Time (GMT+08:00) Perth
Taipei Standard Time (GMT+08:00) Taipei
Ulaanbaatar Standard Time (GMT+08:00) Ulaanbaatar
Tokyo Standard Time (GMT+09:00) Osaka, Sapporo, Tokyo
Korea Standard Time (GMT+09:00) Seoul
Yakutsk Standard Time (GMT+09:00) Yakutsk
Cen. Australia Standard Time (GMT+09:30) Adelaide
AUS Central Standard Time (GMT+09:30) Darwin
E. Australia Standard Time (GMT+10:00) Brisbane
AUS Eastern Standard Time (GMT+10:00) Canberra, Melbourne, Sydney

PI Coresight 2012 Administrator Guide 19

Administration

West Pacific Standard Time (GMT+10:00) Guam, Port Moresby

Tasmania Standard Time (GMT+10:00) Hobart
Vladivostok Standard Time (GMT+10:00) Vladivostok
Central Pacific Standard Time (GMT+11:00) Magadan, Solomon Is., New Caledonia
New Zealand Standard Time (GMT+12:00) Auckland, Wellington
UTC+12 (GMT+12:00) Coordinated Universal Time+12
Fiji Standard Time (GMT+12:00) Fiji
Kamchatka Standard Time (GMT+12:00) Petropavlovsk-Kamchatsky - Old
Tonga Standard Time (GMT+13:00) Nuku'alofa

Kiosk Mode
Kiosk mode makes it possible to provide a read-only PI Coresight display with limited
interactivity. Users of a Microsoft SharePoint portal, for example, can view and interact with
the timebar and symbols in an existing display without making any changes that will be
saved.
Kiosk mode only shows the display area. The Search and Cart panes are not accessible. In
addition, navigation is restricted (that is, no Help or Homepage links are displayed).
Refreshing the browser displays the original view of the display.

Enable Kiosk Mode

• To place a display into kiosk mode, append this text to the URL for the display:
?mode=kiosk
For example:
https://<webserver>/PICoresight/#/Displays/3/PowerAnalysis?mode
=kiosk
• To restore the display to normal function, remove the text from the URL.

Changing the Owner of the PI Coresight Database

If the PI Coresight Application Pool ID is changed after the PI Coresight Database has been
created, the account used to access the PI Coresight database needs to be modified by running
the following SQL commands:
ALTER USER "DVService" with

LOGIN="<domain>\<Application Pool ID>"

ALTER USER "<domain>\<Application Pool ID>"with

NAME="DVService"

20
 Changing the Owner of the PI Coresight Database

PI Coresight 2012 Administrator Guide 21

Appendix A

Logging and Instrumentation

PI Coresight includes an instrumentation framework that manages performance counters and
message logging. This framework allows you to run various levels of traces that monitor
execution of your application without disturbing your operating environment. It generates
logs of errors and events that can be easily read with any of three supported listener
applications:
• Windows Event log
• PI Message log
• standard debug window
By default, the instrumentation framework is configured to log error messages to the
Windows Event log on the Web server.

Note: At installation, the instrumentation framework is configured to report both warnings

and errors. To help troubleshoot, you may need to increase the level of reporting
to include messages that trace the details of operations. To do this, edit the
PIInstrumentation.config file and look for the string:

<logFilter logMode="Warnings"

Change the logMode (page 28) from Warnings to All to enable trace messages.

About PI Data Services

PI Data Services is a server-side data access layer that provides simple, secure interfaces for
OSIsoft client applications to retrieve data from PI Systems, and relational, and Internet data
sources. PI Data Services is installed and used by various OSIsoft products, including PI
Coresight.
PI Data Services is not visible as a separate component when you install PI Coresight. It
operates in the background, and requires no administration.

Initial Settings
Parameters for log settings are preconfigured in the PIInstrumentation.config file,
which is located in the PIPC\DAT directory. This file is automatically created when you
install a product that includes the instrumentation framework.

PI Coresight 2012 Administrator Guide 23

Logging and Instrumentation

To adjust logging and trace settings, modify PIInstrumentation.config. You do not

need to restart your application after you modify PIInstrumentation.config
The PIInstrumentation.config file contains separate sections where you can find
settings for the following:
• <EventSources> (page 24)
• <Listeners> (page 25)
• <LogFilters> (page 26)
• <Formatters> (page 26)
Most modifications are completed in the <LogFilters> section.

Note: In the event that your PIInstrumentation.config file become corrupted,

deleted, or needs to be replaced for any reason, simply re-run the
InstallUtil.exe application to regenerate the file. InstallUtil.exe is
included as part of the Microsoft .NET Framework utilities.

<EventSources>

Event sources are message sources predefined by each client using the PI Instrumentation
Framework.
The <EventSources> section in PIInstrumentation.config (page 23) includes
application-specific event sources listed by type. Associated filter bindings sections act as
channels to deliver messages to appropriate listeners. For example:
<EventSource
name="PIWebServices.PIDataService.PIWebServicesInstrumentation.PIW
ebServicesTraceSourceTypes.PIWebServicesSearch" descriptions="PI
Web Services Search source" client="PI Web Services">
<eventSourceParamList>
<EventSourceParameter name="FilterBindings"
value="defaultFilterBindings" />
<EventSourceParameter name="DebugInfo" value="false" />
</eventSourceParamList>
</EventSource>
<EventSource
name="PIWebServices.PIDataService.PIWebServicesInstrumentation.PIW
ebServicesTraceSourceTypes.PIWebServicesTimeSeries"
descriptions="PI Web Services time series source" client="PI Web
Services">
<eventSourceParamList>
<EventSourceParameter name="FilterBindings"
value="defaultFilterBindings" />
<EventSourceParameter name="DebugInfo" value="false" />
</eventSourceParamList>
</EventSource>
• FilterBindings—contains the name of the LogFilter (page 26) set to be used by this
client source for logging messages.

24
 Initial Settings

• DebugInfo—option that enables logging of more detailed information such as stack

traces and process identity information. By default it is set to FALSE. Change this value
to TRUE to enable it.

<listeners>

The PI Instrumentation Framework currently supports three listeners that enable you to view
logs and errors:
• Windows Event Log—recommended tool that comes with Microsoft Windows. By
default PI Instrumentation is set for this listener.
• PI Message Log (in PI SMT)—for PI System admins who want to read logs while
working with PI System tools.
• DebugView for Windows—enables more detailed logging and debugging information.
This listener also enables you to save error messages in a text file that can then be sent to
the OSIsoft Technical Support team for additional troubleshooting. You must download
this application from the Microsoft Web site (http://technet.microsoft.com/en-
us/sysinternals/bb896647.aspx).

Note: By default only the Windows Event Log listener is configured to receive logging
and error information. You can add the other listeners by modifying the
PIInstrumentation.config file, however, keep in mind that additional
listeners may result in some performance loss on your server.

<listeners>
<listener xsi:type="WMIListener" name="WmiTraceListener"
descriptions="Windows Event Log"
type="OSIsoft.PIInstrumentation.Listener.WmiTraceListener"
listenerDataType="OSIsoft.PIInstrumentation.Listener.WmiTraceListe
ner, OSIsoft.PIInstrumentation.Listeners, Version=3.0.0.0,
Culture=neutral, PublicKeyToken=53b77d1d3d7a979b"
formatter="General" machineName="." />
</listeners>

<listener xsi:type="PISDKListener" name="PISDKLogEventListener"

descriptions="PISDK Message Log
"type="OSIsoft.PIInstrumentation.Listener.PISDKLogEventListener"li
stenerDataType="OSIsoft.PIInstrumentation.Listener.PISDKLogEventLi
stener OSIsoft.PIInstrumentation.Listeners, Version=3.0.0.0,
Culture=neutral, PublicKeyToken=53b77d1d3d7a979b"
formatter="General" PIServer="trenton" />

<listener xsi:type="ConfigTraceListener" name="TraceEventListener"

descriptions="Trace message Log"
type="OSIsoft.PIInstrumentation.Listener.TraceEventListener"
listenerDataType="OSIsoft.PIInstrumentation.Listener.TraceEventLis
tener,OSIsoft.PIInstrumentation.Listeners, Version=3.0.0.0,
Culture=neutral, PublicKeyToken=53b77d1d3d7a979b"
formatter="General" />
Each listener has the following parameters:

PI Coresight 2012 Administrator Guide 25

Logging and Instrumentation

• Name—used to configure filter bindings

• Descriptions—used to describe the listener
• Type—used to instantiate the listener object and send messages
• Formatter—name used by the listener to format the message before logging

Note: Some listeners may have a few additional parameters. For example, the PI SDK
message listener configuration requires a PI Server named with the PIServer
parameter.

<LogFilters>

LogFilters are the main drivers of configuration for all message logging, and are frequently
referenced by event source configuration entries. The default LogFilter configuration enables
you to log all the warnings and errors from all client sources to the Windows Event log.
Most modifications to PIInstallation.config are completed in the <LogFilters>
section. See Modify Configuration (page 27) for more details.

<formatters>

This section contains all the formatters and their associated templates. Listeners format
messages according to a specified template before logging them. For example:
<formatters>
<formatter name="TextFormatter" descriptions="Text Formatter"
type="OSIsoft.PIInstrumentation.Listener.Formatter.TextFormatter,
OSIsoft.PIInstrumentation.Listeners, Version=3.0.0.0,
Culture=neutral, PublicKeyToken=53b77d1d3d7a979b"
template="Message: {message}{newline}Category:
{category}{newline}Priority: {priority}Extended Properties:
{dictionary({key} - {value}{newline})}" />
<formatter name="XMLFormatter" descriptions="XML Formatter"
type="OSIsoft.PIInstrumentation.Listener.Formatter.XmlLogFormatter
, OSIsoft.PIInstrumentation.Listeners, Version=3.0.0.0,
Culture=neutral, PublicKeyToken=53b77d1d3d7a979b" template="" />
</formatters>
Each formatter configuration has the following parameters:
• Name—referenced by listener configuration to select the correct formatter
• Descriptions—used to describe the formatter
• Type—used to instantiate the formatter object and format the message
• Template—references a key-value pair template collection used to specify a label for
the message and how it should appear when logged. For example:
Timestamp: {timestamp}{newline}
where {timestamp} is the value substituted from the LogEntry
object. The output format appears as

26
 Modify Configuration

Timestamp: 8/24/2008 2:10:54 pm

followed by a new line.

Note: For the formatter name value XMLFormatter, the actual LogEntry object is an
XML document and requires no template specification.

Modify Configuration
Most manual changes to instrumentation settings are made in the <logFilters> (page 26)
section of the PIInstrumentation.config (page 23) file. Under <logFilters>, you
may adjust the following:
• Add/Remove Listeners (page 27)— provide destinations for messages to be sent
• Filter Messages (page 27)—configure what messages appear in your logs

Add/Remove Listeners

Use the <listeners> (page 25) section of PIInstallation.config to configure one or

more trace listeners for a single message source. For example, if you want to send critical
error messages to the Windows Event Log and the PI Message Log, simply add both listeners
in order to send the message to each:
<listeners>
<listener>PISDKLogEventListener</listener>
<listener>WmiTraceListener</listener>
</listeners>
The following table describes the listener names and details. The PI Instrumentation
framework currently supports three listeners.
Name in PIInstrumentation.config Listener Application
WmiTraceListener Windows Event Log
PISDKLogEventListener PI Message Log (in PI SMT)
TraceEventListener DebugView for Windows
(http://technet.microsoft.com/en-
us/sysinternals/bb896647.aspx)

Filter Messages

PIInstrumentation.config (page 23) contains four levels of filtering that enable you
to parse the messages that get logged to your active listeners (page 25). When an event is
traced it must satisfy the conditions for each filter in order to be logged as a message. You
can modify the requirements for each filter in the <logFilters> section of
PIInstrumentation.config. The order of filtering is as follows:
• LogMode Filter (page 28)—determines what kind of messages should be logged

PI Coresight 2012 Administrator Guide 27

Logging and Instrumentation

• Category Source Filter (page 28)—conditions to log messages within specific categories
• Priority Filter (page 29)—to specify logging a message only when it falls within a certain
range of priority levels
• Keyword Filter (page 29)—to log messages containing certain keywords

LogMode Filter
The LogMode setting determines what kind of message should be logged. There are three
possible settings:
• Errors—logs only the error messages
• Warnings— logs error and warning messages
• All—logs all the messages, including informational messages

Category Source Filter

Categories correspond to the clients from which you receive messages. Filter these categories
by setting one of the two categoryFilterMode settings listed below, followed by a list
of Names to define which categories to explicitly deny or allow:
• DenyAllExceptAllowed—denies all categories except those explicitly allowed in the
names list
• AllowAllExceptDenied—allows all categories except those explicitly denied in the
names list
For example, if you want to log all messages from event source DataAccess and ignore the
remainder, you can use the following:
<categorySources>
<categorySource categoryFilterMode="DenyAllExceptAllowed"
type="OSIsoft.PIInstrumentation.Configuration.CategorySource"
name="default" >
<names>DataAccess</names>
</categorySource>
</categorySources>
In contrast, the following configuration logs all messages from all sources:
<logFilter logMode="All" name="defaultFilterBindings"
enabled="true">
<categorySources>
<categorySource categoryFilterMode="AllowAllExceptDenied"
type="OSIsoft.PIInstrumentation.Configuration.CategorySource"
name="default" description="Allow all Category except those
explicitly specified as denied">
<names/>
</categorySource>
</categorySources>
If the LogFilter is not enabled, it does not load formatters or listeners. The framework loads
only the necessary filters and listeners based on <LogFilter> settings.

28
 Message Throttling

Priority Filter
Each message object has a priority setting. If the priority meets the range between the
minimum and maximum priority filter levels, then the message is logged.
In the priorityFilter section you can set the following parameters:
• name
• type
• minimumPriority
• maximumPriority

Keyword Filter
This setting logs the message if the message has any specific keyword which you would like
to monitor.
In the keywordFilter section you can set the following parameters:
• name
• keyword

Message Throttling
The PI Instrumentation Framework includes a message throttling component that prevents
client applications from flooding logs with duplicate messages when there is a recurring
problem. The default value is 5 minutes, meaning that if the same message repeats within 5
minutes, logging applications will not log that message.
To modify this setting edit the web.config file located on your client machine. Edit the
following entry under <appSettings> to adjust throttling settings.
<add key="ErrorSuppressionTime" value="" />

PI Coresight 2012 Administrator Guide 29

Appendix B

Technical Support
OSIsoft provides dedicated technical support internationally, 24 hours a day, 7 days a week to
customers with a current SRP contract. To locate local access numbers and current contact
options, please visit our Contact Methods page on the Technical Support web site at
http://techsupport.osisoft.com. The main contact information is also listed below:
Telephone: +1 510 297-5828
Email: [email protected]
Web Portal: My Calls
When you open a case using any of the above methods, you will receive a response from a
Technical Support Engineer within four hours. Be sure to provide:
• Product name, version, and/or build numbers
• Computer platform (CPU type, operating system, and version number)
• The time that the difficulty started
• The message log(s) at that time
You can also take advantage of the Self-service Search page on our Technical Support Web
Site to look for answers to your technical questions and issues. The search tool searches our
online library of documentation, knowledge base articles, technical announcements and
bulletins, known product issues, and documented product enhancement requests, as well as a
collection of resources for system managers.

PI Coresight 2012 Administrator Guide 31