PI Coresight 2015 Installation and Administration Guide

PI Coresight 2015
Installation and Administration 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
PI Coresight 2015 Installation and Administration Guide

2011-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 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 227.7202, DFARS 252.227-7013, FAR 12.212, FAR
52.227, as applicable. OSIsoft, LLC.
Version: 2.1.0.2
Published: 19 June 2015
Contents
PI Coresight architecture and system requirements...................................................... 1

PI Coresight architecture................................................................................................................................. 1
About the PI Coresight web server...............................................................................................................2
PI Coresight application pools and service accounts.................................................................................... 2
PI Coresight access groups...........................................................................................................................3
Software and hardware requirements............................................................................................................. 4
Hardware requirements for PI Coresight application server......................................................................... 4
PI Coresight application server software requirements................................................................................ 5
Microsoft SQL Server requirements.............................................................................................................5
PI System requirements for PI Coresight......................................................................................................5
PI ProcessBook display version.................................................................................................................... 6
Client requirements.....................................................................................................................................6
PI Coresight upgrades................................................................................................ 9
Upgrade a PI Coresight installation................................................................................................................. 9
Automatic PI Coresight upgrade backups...................................................................................................... 11
Preparation for a new PI Coresight installation........................................................... 13

Create a domain user account for PI Coresight...............................................................................................13
Required PI Coresight service account access permissions......................................................................... 13
Prepare the PI Coresight application server computer................................................................................... 14
Server Manager roles and features.............................................................................................................15
PI Coresight installation........................................................................................... 19
Pre-Install recommendations........................................................................................................................ 20
Pre-install checklist........................................................................................................................................21
Install PI Coresight.........................................................................................................................................23
Silent installation...........................................................................................................................................25
Multilingual UI available to install.................................................................................................................. 25
Configure PI Coresight after installation.....................................................................27

Configure PI Coresight service accounts........................................................................................................ 27
PI Coresight database creation...................................................................................................................... 28
Configure the Microsoft SQL Server connection........................................................................................ 29
Create the PI Coresight database...............................................................................................................29
Manually create the PI Coresight database................................................................................................ 30
Disable SSL Version 2 and earlier...................................................................................................................32
Configure Secure Sockets Layer (SSL) access................................................................................................ 32
Enable HTTP compression on the PI Coresight application server.................................................................. 33
Configure PI Coresight access to PI Data Archive server data....................................... 37

Configure PI Data Archive server access permissions..................................................................................... 37
Create the PI identity................................................................................................................................. 37
Grant the PI identity the required access permissions................................................................................ 38
Configure PI Data Archive server authentication............................................................................................38
Configure WIS authentication....................................................................................................................39
PI Data Archive server authentication on mobile devices........................................................................... 44
PI Coresight 2015 Installation and Administration Guide iii

Contents
Configure PI Coresight access to PI AF databases........................................................47

Configure PI AF authentication and permissions............................................................................................47
Configure access to a PI AF server.............................................................................................................. 47
Configure access to a PI AF database.........................................................................................................48
Configure read access for PI AF objects..................................................................................................... 48
PI Coresight administration tasks.............................................................................. 49

Configure user access to the PI Coresight application.................................................................................... 50
Configure Firefox and Chrome browsers for PI Coresight clients....................................................................50
Add PI Coresight application server as a Google Chrome trusted site and authenticate using Kerberos..... 50
Add the PI Coresight application server as a Firefox trusted site................................................................ 50
The PI Coresight Administration website and Administrator users.................................................................51
Check PI Coresight status...........................................................................................................................51
Access to PI Data Archive and PI AF data................................................................................................... 52
Configure folders for import...................................................................................................................... 54
Update the SQL Server instance and PI Coresight database.......................................................................55
Update display ownership and reset user settings......................................................................................56
Generate reports........................................................................................................................................57
Backup strategy for the PI Coresight database...............................................................................................57
Change the account of the PI Coresight database..........................................................................................58
Reassign a display from the Homepage......................................................................................................... 59
Time zone and regionalization settings......................................................................................................... 59
Change time-zone settings........................................................................................................................ 59
Change regionalization settings................................................................................................................ 62
Uninstall PI Coresight.................................................................................................................................... 63
URL parameters for controlling the presentation of displays....................................... 65

Creating a new temporary display with particular data items.........................................................................65
Opening an existing saved display................................................................................................................. 66
Applying kiosk mode to a display...................................................................................................................67
Reuse displays for assets built from the same AF template............................................................................68
Specify the element for PI ProcessBook element relative displays ................................................................ 69
Set the time zone for a display...................................................................................................................... 69
Hide the toolbar or timebar ...........................................................................................................................70
Prevent automatic redirection to PI Coresight mobile website.......................................................................70
High availability options for PI Coresight....................................................................73
Appendix A View and configure PI Coresight message logs..........................................77

View the message logs...................................................................................................................................77
Collect analytic and debug events using Windows Performance Monitor.......................................................78
Suppress duplicate messages (message throttling)........................................................................................78
Technical support and other resources....................................................................... 79
iv PI Coresight 2015 Installation and Administration Guide

PI Coresight architecture and system requirements
PI Coresight architecture
The main components of a PI Coresight installation are:
One or more PI Data Archive servers
One or more PI AF databases
A PI Coresight application server
Microsoft SQL Server, to hold the PI Coresight database
Clients
Clients where you plan to create or update displays must run Microsoft Silverlight
compatible web browsers.
PI Coresight is supported by most modern browsers on a wide variety of computers,
including tablets and phones running iOS or Android operating systems.
OSIsoft recommends that PI Coresight use the same SQL Server that PI AF uses. Otherwise, you
can either install a SQL Server on the same computer as the PI Coresight application server or
you can use a dedicated SQL Server installation.
Note:
OSIsoft strongly recommends that the PI Data Archive servers and PI AF servers be in the
same domain as the PI Coresight application server and Microsoft SQL Server hosting the
PI Coresight database.
The following diagram illustrates a typical configuration. Here, the PI Coresight database
resides on the same MS SQL Server that PI AF uses. In this diagram, the MS SQL Server and the
PI AF Server are installed on the same computer, although that is not a requirement.
PI Coresight 2015 Installation and Administration Guide 1

About the PI Coresight web server

PI Coresight uses two websites:
The administration website: https://webServer/Coresight/Admin
The main application website: https://webServer/Coresight/
Where webServer is the name of the PI Coresight web server. PI Coresight uses the Microsoft
Internet Information Services (IIS) web server.
PI Coresight application pools and service accounts

The PI Coresight installation creates two application pools and two Windows services.
The application pools run under Windows service accounts that have appropriate access
permissions across the PI System:
CoresightAdminAppPool runs the Administration website, located at: https://
webServer/Coresight/Admin
CoresightServiceAppPool runs the main PI Coresight application website, located at
https://webServer/Coresight
The Windows services that the installation program creates are:
PI Web API: a RESTful API to the PI System
PI Web API Crawler: crawls PI System data sources to provide metadata to indexed search
2 PI Coresight 2015 Installation and Administration Guide

Note:
The PI Indexed Search Crawler requires read access to PIUsers, PIDBSEC, PIMappings
and PIPOINT databases. Access to these databases can be set in the Database Security
plugin in PI SMT. Note that by default, the PIWorld identity has read access to PIUsers
and PIDBSEC. Therefore, explicit access for these two groups is not required, unless
you have disabled PIWorld.
The PI Coresight application pools and service accounts run under the PI Coresight service
account. This is the account that PI Coresight uses to connect to the PI Data Archive and PI AF
servers. For client users to see PI data, the PI Coresight service account needs appropriate
access to these servers.
When you install PI Coresight, the installation kit by default sets the service accounts to the
machine account of the application server itself and sets the accounts for each service as
follows:
Service Account
CoresightAdminAppPool NT Authority\Network Service
CoresightServiceAppPool NT Authority\Network Service
PI Web API NT Service\piwebapi
PI Web API Crawler NT Service\picrawler
The PI Coresight service account in this configuration is the server machine Active Directory
account. Typically, this account is named domain\server-name$. For example,
MyEnterprise\CoresightServer$.
For security reasons, OSIsoft recommends that you instead create a domain account for the PI
Coresight services:
1. Change the PI Coresight service account to a dedicated domain account. See Create a
domain user account for PI Coresight.
2. Configure the application pools and services to run under this account. See Configure PI
Coresight service accounts.
Caution:
OSIsoft strongly recommends that you create a domain account for the PI Coresight
services. If you use the machine account, all the applications running on the application
server computer have access permissions on the SQL server, PI Data Archive server, and
PI AF server machines. This is a security risk. At a minimum, consider removing some or
all of the other applications running on this computer.
PI Coresight access groups

Access to the PI Coresight administration website and the PI Coresight website are controlled
through separate Microsoft Windows groups. The PI Coresight setup program creates these
local user groups on the PI Coresight application server:
PI Coresight Admins
PI Coresight Users
PI Web API Admins

For more information, see Configure user access to the PI Coresight application and The PI
Coresight Administration website and Administrator users.
Software and hardware requirements
Hardware requirements for PI Coresight application server

Microsoft SQL Server database requirements
The following requirements are based on the Microsoft SQL Server residing on the PI Coresight
application server. The Microsoft SQL Server database requires approximately 200MB of
storage plus 5MB per user (assuming 200 average-sized displays per user). If you plan to
import PI ProcessBook displays, allow a minimum of 500KB per display (assuming average-
sized displays) on the SQL Server.
By default, the database will automatically grow by 200MB each time the current size limit is
reached.
Index files requirements

The index files can be large, especially if you have many PI Data Archive servers or complex
databases. They are located in your ProgramData folder.
As an approximate guideline to estimate the size of the index files:
For 1000 PI points, allow about 4MB
For 1000 AF elements (assuming 10 attributes each) allow about 14MB
Summary of hardware requirements

# of Users 1 to 50 50 to 250 250 to 500
CPU (Cores) 4 4 8
CPU Speed (GHz) 2 2.5 3
Memory (GB) 6 12 24
You can estimate the total disk space required in MB using the expression:
DiskSpace = 250 + 5*Users + 0.004*PIPoints + 0.014*AFElements
Where the parameters are:

DiskSpace: required disk space (MB)
Users: the number of users creating displays
PIPoints: the total number of PI points on all allowed servers
AFElements: the total number of elements on all allowed AF databases (assumes an average
of 10 attributes per element)
Note:
If your elements, attributes, and points have many unique descriptions, the index file size
can be significantly larger.

PI Coresight application server software requirements

The requirements for the software on the machine hosting the PI Coresight application server
are as listed:
Microsoft Windows Server 2008 R2 SP1 64-bit, or later

Microsoft Internet Information Services (IIS) 7.5, or later
Microsoft .NET Framework 4
Server Manager roles and features. See Preparation for a new PI Coresight installation for
details on which roles and features are required for PI Coresight.
Microsoft SQL Server requirements

PI Coresight requires Microsoft SQL Server 2008 R2 or above. Standard, Enterprise, and
Express versions are all supported.
To leverage the same backup procedures used for PIFD with the PI Coresight database, OSIsoft
recommends that you host your PI Coresight database on the same SQL Server that PI AF uses.
Ensure the SQL Server configuration setting Allow Triggers to Fire Others is set to True. To
verify this setting:
1. In SQL Server Management Studio, right-click your instance and choose Properties.
2. Select the Advanced page.
3. Allow Triggers to Fire Others is the first setting in the Miscellaneous section.
Note:
For heavier loads (over 500 users) a full version of SQL Server running on a dedicated
server is required.
PI System requirements for PI Coresight

PI Coresight is supported with the following versions of PI Data Archive and PI AF:
PI Data Archive version 3.4.380, and later.

PI Asset Framework 2010, and later. PI AF 2010 R2, or later, is recommended.

PI ProcessBook display version

Starting with PI Coresight 2014, you can configure your application server so that users can
view PI ProcessBook displays. PDI and SVG files produced by PI ProcessBook, version 2.35 or
later, are automatically imported from the folders you configure.
For best results, use PI ProcessBook displays saved using Version 3.3.2 or later. This is
particularly important for graphics and regional number format support.
For more information about importing PI ProcessBook displays, see Configure folders for
import.
Client requirements
PI Coresight clients need to use web browsers that are HTML5 compatible. To create or update
displays, client browsers must also be Silverlight compatible
Note:
To create or update displays, client machines must have the required version of
Microsoft Silverlight installed (5.1.20125.0, or later).
Silverlight components are supported only in configurations where Silverlight is
supported. Note that on Mac OS, Safari and Firefox are the only two browsers supported
by Silverlight.
To install Microsoft Silverlight, go to the Microsoft installation page at: http://
www.microsoft.com/getsilverlight/get-started/install/default.aspx.
Supported browsers for PI Coresight

PI Coresight 2014, and later, is compatible with the following browsers:
On Windows with Microsoft Internet Explorer versions 10 and 11, Mozilla Firefox version
30.0, Google Chrome version 35.0
On Apple Macintosh with Safari version 5.1
On the iPad and iPhone with iOS version 7
On Android devices with Android version 4.1, 4.2.2, and 4.3.1
To use PI Coresight with Google Chrome and Firefox, you must specify the PI Coresight
application server as a trusted site. See Configure Firefox and Chrome browsers for PI
Coresight clients.
Note:
For online Help to open successfully when you click the Help button (?), you might need
to disable popup blocking in your browser.
Ensure Silverlight is at the required version

PI Coresight 2014, and later, requires Microsoft Silverlight Version 5.1.20125.0, or later, based
on the Security Update for Microsoft Silverlight (http://support.microsoft.com/kb/2814124).

You will be prompted to upgrade, if you have not already done so.
Mobile devices as clients

When a user of a smaller device or browser goes to the application website: https://
webServer/Coresight/ they are redirected to the PI Coresight mobile web site: https://
webServer/Coresight/m by default. (You can override this redirect for specific displays, such as
in a dashboard, if required. For more information, see Prevent automatic redirection to PI
Coresight mobile website.) On the mobile web site, value symbols are shown along with a
trend for displays that are not imported. All symbols are displayed for imported ProcessBook
displays similar to behavior of the main Coresight application.
Support of iOS-based devices started with PI Coresight 2012 R2 for the iPad, and with PI
Coresight 2013 for the iPhone.
For PI Coresight 2014, and later, it is recommended that instead of using the native iOS apps
from the App Store, users navigate to the mobile web site.


PI Coresight upgrades
When you upgrade to a new version of PI Coresight, your existing settings are carried over to
the upgraded PI Coresight installation. This includes settings for allowed PI Data Archive
servers, PI AF databases, and the PI Coresight database.
Upgrade a PI Coresight installation

Follow the steps in this procedure to upgrade an existing installation of PI Coresight.
Note:
During installation, you will see setup screens for the following software:
1. PI Web API
2. PI Indexed Search Crawler
3. PI Coresight
If the domain membership of the computer where you installed PI Coresight is changed
after installation, you must uninstall and reinstall PI Web API and the PI Indexed Search
Crawler. If you used a self- signed certificate, you will need to generate a new certificate
when you reinstall.
Before you start

Caution:
New for PI Coresight 2014, and later:
You must have a digital certificate to complete installation (the installation program
allows you to create and use a self-signed certificate, if required).
You must specify your AF server during installation. Minimum AF server and PI Data
Archive server versions have changed, see PI System requirements for PI Coresight.
You need to know the PI Coresight service account name in current use for PI
Coresight. For more information on how to retrieve this account, see PI Coresight
application pools and service accounts.
If you plan to import PI ProcessBook displays, allow extra disk space (approximately
500KB per display).
PI mappings are required for all client users to search PI Data Archive servers and AF
servers (a PI trust is not sufficient for search, but can still be used for viewing data). A
PI mapping associates a Windows Active Directory user or group with a PI Identity.
PI Coresight administrators must be members of the PI Web API Admins group in
order to allow PI Data Archive servers and AF databases properly.
See Pre-install checklist for more information about install requirements.

Note:
To upgrade the PI Coresight database, the user performing the upgrade (by using the
installation program, the administration web site, or the go.bat script) must have the
following minimum database role memberships, or be a member of the db_owner
database role.
db_datareader
db_datawriter
db_ddladmin
Procedure
1. Log on to the application server as a System Administrator, using a domain user account
that belongs to the local Administrators group.
2. Verify that all required roles and features are installed. Required roles and features are
listed in the section Prepare the Coresight application server computer.
3. Download the new PI Coresight installation kit from the OSIsoft Technical Support website.
4. Right-click the PI Coresight setup executable and select Run as Administrator to launch the
installation wizard.
5. For the PI Web API installation, choose the Custom setup type.
6. When prompted during the PI Web API installation for an account, choose the Active
Directory account currently in use by the previous version of the PI Coresight web site
application pools. One exception is, if PI Coresight was previously using the Network
Service account, choose the option to run PI Web API as the virtual userNT Service
\piwebapi.
7. When prompted during the PI Web API installation for a trusted certificate, either select an
existing SSL certificate or choose the option to create a self-signed certificate and then
select it. For more information see Configure Secure Sockets Layer (SSL) access.
8. After the upgrade completes, reboot your machine, and then follow the directions in
Configure PI Coresight service accounts to ensure all services are running under the correct
accounts.
9. If you have Basic authentication enabled, it might be disabled when you upgrade PI
Coresight. If you are using mobile devices over SSL, you need to re-enable Basic
authentication. For more information, see PI Data Archive server authentication on mobile
devices.
Upgrading the PI Coresight database

If Microsoft SQL Server is on the PI Coresight application server computer, the PI Coresight
database is upgraded automatically.
If SQL Server is on a remote server, you need to manually upgrade the PI Coresight
database.

Note:
There may be cases where you are notified on the PI Coresight administration website
that the PI Coresight database needs to be upgraded. If you have the required
permissions (described at the beginning of this procedure) you can perform the upgrade
at that time. The administration site is located at https://webServer/Coresight/
Admin where webServer is the name of your PI Coresight web server.
Automatic PI Coresight upgrade backups

When you upgrade PI Coresight, the installation program creates a copy of the PI Coresight
database.
This backup file is called CoresightDatabase.backup and is located in the default Microsoft
SQL Server backup directory. For example:
Program Files\Microsoft SQL Server\MSSQL10_50.SQLEXPRESS\MSSQL\Backup
If a backup database already exists at this location from a previous PI Coresight upgrade, the
installation kit overwrites the older backup file.
The installation program also creates copies of upgraded web.config files, which are located
in:
Program Data\OSIsoft\Coresight\PIDSTemp


Preparation for a new PI Coresight installation
To prepare for a new PI Coresight installation, complete the following tasks:
Topics in this section

Create a domain user account for PI Coresight
Prepare the PI Coresight application server computer
Create a domain user account for PI Coresight

By default, the PI Coresight application services run under the machine account of the
application server itself. Instead, OSIsoft recommends that you create a dedicated Windows
Active Directory account for the PI Coresight application service.
Note:
The indexed search crawler service requires read access to the PIUSER, PIPOINT,
PIMAPPING and PIDBSEC databases on the PI Data Archive server.
Procedure
1. On the domain controller, create the account. OSIsoft recommends that you name this
account CoresightService.
2. Make a note of the account name and password. After installation, you will configure the PI
Coresight application pools and services to run under this new account. For more
information, see Configure PI Coresight service accounts.
3. Grant the Coresight Service account all permissions listed in Required PI Coresight service
account access permissions.
Note:
OSIsoft strongly recommends that you create a custom account for the PI Coresight
service. If you choose to ignore this recommendation and use the default machine
accounts, then you should review the other applications running on the application
server computer. All applications running on this computer will have the Coresight
access permissions on the SQL, PI Data Archive, and PI AF servers. For security
reasons, consider removing some or all of the other applications running on this
computer.
Required PI Coresight service account access permissions

The service account requires the following access permissions:
Login access to the Microsoft 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). PI
Coresight automatically configures the Microsoft SQL Server login, database, and security
settings when you install the PI Coresight database, if you have the appropriate
authorization to the Microsoft SQL Server.
For the PI Indexed Search Crawler service:

Read access to the PIUsers, PIDBSEC, PIMappings and PIPOINTdatabases on the PI Data
Archive server.
Note:
By default, the PIWorld identity has read access to PIUsers and PIDBSEC, therefore
explicit access for these two groups is not required unless you have disabled
PIWorld.
Read and write privileges to the ProgramData folder, in which the search index files are
located.
Note:
The index files can be large, especially if you have many PI Data Archive servers or
complex databases. For more information, see Hardware requirements for PI
Coresight application server.
The crawler can access the PI Data Archive server with a trust or a mapping, however
mappings must exist for each PI Coresight user, so that the index can successfully
associate Windows users with the PI Identities that have access to points.
PI Data Archive servers: On each allowed PI Data Archive server, the PI Coresight service
account needs read access to all PI points that need to be accessed by client users. See
Configure PI Coresight access to PI Data Archive server data.
PI AF servers: The PI Coresight service account needs read access to the PI AF servers and
to all allowed PI AF databases on each PI AF server. In addition, the PI Coresight service
account needs read access to all PI AF elements and tables that can be accessed by client
users. See Configure PI AF authentication and permissions.
Folders configured for import of PI ProcessBook displays: The application pool identity
must have read access to any folder from which you import PDI or SVG files. See Configure
folders for import.
Prepare the PI Coresight application server computer

Procedure
1. Open the required ports for the configured PI Coresight website. All required ports must be
open for PI Coresight to function properly.
Typical required ports
Port Used by
80 or 443 PI Coresight web server
5450 PI Data Archive Server
5457 PI AF Server
2. If you are installing on a web server that hosts multiple sites on the same port, you need to
temporarily change the port number before installation:
a. In Internet Information Server (IIS) Manager, select the website where you want to
install PI Coresight, right-click and select Edit Bindings.
b. In Site Bindings, select the first row and click Edit.

c. Change the port number to a unique number and click OK.

d. After installation, you can change the port number back to the original number.
3. If you are installing on an existing PI WebParts or PI Web Services application server, then
you must create a separate website with a unique port number. You cannot install PI
Coresight under an existing web application. Make a note of this website. During
installation, enter it when prompted for the website.
4. Download the required software:
OSIsoft Prerequisites kit and the PI Coresight installation kit. You can download these
kits from the OSIsoft Tech Support website (http://techsupport.osisoft.com/).
Microsoft SQL Server installation kit (you can skip this step if you plan to use an existing
SQL Server installation). The setup kit for SQL Server Express is available for download
on the OSIsoft Technical Support website. See Microsoft SQL Server requirements for a
list of supported versions.
5. From the Microsoft Server Manager application:
Install the Web Server (IIS) role (required) and install the Application Server role
(required for Windows Server 2012, optional for Windows Server 2008).
Install at least the minimum role services. See Role services for web server and Role
services for application server for lists of required and recommended role services.
Install the Required server features.
6. Run the OSIsoft Prerequisites installation kit.
7. Install Microsoft SQL Server (if you plan to use an existing SQL Server installation, then skip
this step).
Server Manager roles and features

PI Coresight has the following requirements:
Web server (IIS) role with at least the minimum role services listed in Role services for web
server.
The server features listed in Required server features.
OSIsoft recommends, but does not require, that you perform the following configuration steps:
For Windows Server 2008 R2, install the Application server role. No non-default role
services are required for this role, but consider adding the additional recommended roles
listed in Role services for application server.
Enable HTTP compression on the PI Coresight application server. See Enable HTTP
compression on the PI Coresight application server

Role services for web server

Windows Server 2008 R2 Windows Server 2012
Common HTTP Required: Required:
Features Static Content Static Content
Default Document Default Document
HTTP Errors HTTP Errors
Recommended: Recommended:
All except WebDAV Publishing All except WebDAV Publishing
Application Required: Required:

Development .NET Extensibility .NET Extensibility 3.5
Recommended: .NET Extensibility 4.5
ASP .NET Recommended:
ISAPI Extensions ASP .NET 3.5
ISAPI Filters ASP .NET 4.5
ISAPI Extensions
ISAPI Filters
Health and Required: Required:

Diagnostics None None
HTTP Logging HTTP Logging
Logging Tools Logging Tools
Request monitor Request monitor
Tracing Tracing
Security Required: Required:

Windows Authentication Windows Authentication
Request Filtering Request Filtering
URL Authorization URL Authorization
Basic Authentication Basic Authentication
All All
Performance Required: Required:

All All
Management Tools Required: Required:
IIS Management Console IIS Management Console
IIS Management Scripts and Tools IIS Management Scripts and Tools
Management Service Management Service

Role services for application server

The following role services are required or recommended for Application Server.
Recommended: Required:
.NET Framework .NET Framework 4.5
Windows Process Activation Service Support - Windows Process Activation Service Support -
HTTP Activation HTTP Activation
Web Server (IIS) Support Recommended:
Web Server (IIS) Support
Required server features

Windows Process Activation Process Model Process Model
Service
.NET Environment Configuration APIs
Configuration APIs


PI Coresight installation
Here is a quick overview of PI Coresight installation process.
Note:
For an instructional video on how to install PI Coresight, see "PI Coresight 2014
Installation Walk-through" in the "PI System Installation Walk-throughs" playlist
(https://www.youtube.com/playlist?list=PLMcG1Hs2Jbct0EHchLIiJTegzXSv3XVWF) on
Youtube. For a video on post-installation configuration of PI Coresight, see "Configure PI
Coresight 2014 with the PI Coresight Administration Page" on the same playlist.
Prerequisites
Before starting PI Coresight 2015 installation, you will need the following:
Operating system: Windows Server 2008 R2 SP1 or newer

Roles and features must also be enabled on the Web server for PI Coresight to function
properly
Microsoft SQL Server 2008 R2 (Express, Standard or Enterprise) or later to host the PI
Coresight SQL database
PI AF Server to hold the PI Web API configuration
The following ports must be opened on the web server : 5450, 5457, 443 and 80.
Hardware (see Hardware requirements for PI Coresight application server)
Permissions
The PI Coresight server machine account must have the following permissions:
PI Data Archive
Read access to PIUsers, PIDBSEC, PIMappings, PIPOINT and all PI tags that are going to be
crawled.
PI AF Sever
Read access to all PI AF databases that are going to be crawled.
Kerberos
If you want to use Kerberos delegation, the computer account must also be trusted for
delegation.
The installing user must have the following permissions:
PI AF Server
Write access to the Configuration database.
SQL Server
db_creator server role
ALTER ANY LOGIN permission

End users of PI Coresight must have the following permissions:
PI Data Archive
Read access to all PI points (tags) the user will search for or retrieve data from. A PI
Mapping on the PI Data Archive must be created for the end user explicitly or through a
domain group.
PI AF Sever
Read access to all PI AF databases and attributes the user will search for or retrieve data
from.
Pre-Installation Preparation
1. Create a domain user account for PI Coresight. See Preparation for a new PI Coresight
installation.
2. Prepare the PI Coresight application server computer.
Installation Procedure
1. Run the PI Coresight 2015 Install kit as administrator. See Install PI Coresight.
2. Select a "Typical" install for PI Web API.
3. Select the AF Server to hold the PI Web API configuration information.
4. Install PI Coresight to the Default Web Site.
5. Reboot the PI Coresight server.
Post-Installation Configuration
1. Configure PI Coresight service accounts. See Configure PI Coresight after installation.
2. Create the PI Coresight SQL database from the PI Coresight Admin site.
3. Configure PI Coresight access to PI Data Archive server data.
4. Add PI Data Archives and PI AF Servers to be crawled from the PI Coresight Admin site.
5. Install Microsoft Silverlight on any machine accessing PI Coresight.
Pre-Install recommendations
OSIsoft recommends the following configuration:
For the PI Coresight database, use the same Microsoft SQL Server that PI AF uses.
The PI Data Archive servers and PI AF servers are in the domain where:
The PI Coresight application server resides
Microsoft SQL Server hosts the PI Coresight database

Caution:
New for PI Coresight 2014, and later:
You must have a digital certificate to complete installation (the installation program
allows you to create and use a self-signed certificate, if required).
You must specify your AF server during installation. Minimum AF server and PI Data
Archive server versions have changed, see PI System requirements for PI Coresight.
You need to know the PI Coresight service account name in current use for PI
Coresight. For more information on how to retrieve this account, see PI Coresight
application pools and service accounts.
If you plan to import PI ProcessBook displays, allow extra disk space (approximately
500KB per display).
PI mappings are required for all client users to search PI Data Archive servers and AF
servers (a PI trust is not sufficient for search, but can still be used for viewing data). A
PI mapping associates a user or group with a PI identity.
PI Coresight administrators must be members of the PI Web API Admins group, in
order to allow PI Data Archive servers and PI AF databases.
Before you start the installation, check the prerequisites shown in Pre-install checklist.
Pre-install checklist
Prerequisites Recommendation or Requirement For more information
Storage space Approximately 250MB + 5 MB per Hardware requirements for PI
user Coresight application server
Note:
For each imported PI
ProcessBook display, allow an
extra 500KB.
Domain user account for PI Coresight To keep your data secure, OSIsoft Create a domain user account for PI
service recommends you create a domain Coresight
account for the PI Coresight service.
Configure PI Coresight service
Note: accounts
After install, you must configure
the application pools to use this
identity.


PI Coresight service account access Login access to the SQL Server Required PI Coresight service account
permissions used by PI Coresight and limited access permissions
access to the PI Coresight PI Coresight application pools and
database service accounts
Read access to PIUsers, PIDBSEC,
Configure folders for import
PIMappings and PIPOINT.
Read and write privileges to the
ProgramData folder, in which the
search index files are located.
The PI Coresight service account
can access the PI Data Archive
server with a trust or a mapping.
Caution:
Mappings must exist for each PI
Coresight user to the PI Data
Archive server.
Read access to all PI Points on
each allowed PI Data Archive
server
Read access to the PI AF servers,
allowed PI AF databases, and
elements and tables.
Read access to any folder
configured to import PDI or SVG
files.
Software on PI Coresight application Windows Server 2008 R2 SP1 64- PI Coresight application server
server bit, or later software requirements
IIS 7.5, or later
Microsoft .NET Framework,
version 4
Microsoft SQL Server 2008 R2, or later Microsoft SQL Server requirements
Standard, Enterprise, and Express are
all supported.
Ensure Allow Triggers to Fire Others
is set to True.
Note:
OSIsoft recommends that you
host your PI Coresight database
on the same SQL Server that PI
AF uses.
PI System PI Data Archive server version PI System requirements for PI

3.4.380, and later Coresight
PI Asset Framework 2010, and
later


Server Manager roles and features The web server (IIS) role must have Server Manager roles and features
at least the minimum role services
shown in Role services for web server
The server features shown in
Required server features are also
required.
Microsoft Silverlight Version 5.1.20125.0, or later Ensure Silverlight is at the required

version
Relevant ports 80 or 443: PI Coresight web server Prepare the PI Coresight application
server computer
5450: PI Data Archive server
5457: PI AF server
Installing user privileges db_creator server role Install PI Coresight
Write access to the Configuration
database on the default PI AF
server
Log on to the application server as a
System Administrator, using a
domain user account that belongs to
the local Administrators group.
SSL digital certificate During installation, you need to

specify a certificate that you have
purchased from a certificate
authority, or you can create and use a
self-signed certificate.
AF server name During installation, you need to
specify the name of the default PI AF
server.
Install PI Coresight
Follow the steps in this procedure to install PI Coresight for the first time.
Note:
For an instructional video on how to install PI Coresight, see "PI Coresight 2014
Installation Walk-through" (https://www.youtube.com/watch?
v=9bpBQwiy_XQ&index=9&list=PLMcG1Hs2Jbct0EHchLIiJTegzXSv3XVWF) in the "PI
System Installation Walk-throughs" playlist on Youtube.
Before you start

When you install PI Coresight for the first time, the PI Coresight database must be created.
Therefore, the user performing the installation (through the installation program,
administration web site or by using the go.bat script) must have the following privileges:

The db_creator server role.

ALTER ANY LOGIN permission. Users can be granted this permission by use of the
statement GRANT ALTER ANY LOGIN TO "domain\account". If a user is a member of the
securityadmin server role, they already have ALTER ANY LOGIN permission.
The installing user also requires write access to the Configuration database on the default AF
server. You access the Configuration database by using PI System Explorer.
Make sure you have met the prerequisites listed in Pre-install checklist.
Note:
During installation, you will see setup screens for the following software:
1. PI Web API
2. PI Indexed Search Crawler
3. PI Coresight
If the computer where you installed PI Coresight is later added to a domain, you must
uninstall and reinstall PI Web API and the PI Indexed Search Crawler. If you used a self-
signed certificate, you will need to generate a new certificate when you reinstall.
Procedure
1. Log on to 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 might already be present on your computer.
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 Web API, and PI
SDK.
4. The install kit will prompt you to specify:
The name of a PI AF Server.
An SSL digital certificate (either a certificate you have purchased from a certificate
authority or the installation program allows you to create and use a self-signed
certificate). This certificate is used for internal communication between PI Coresight
server components, and is not necessarily used for securing client access to the website.
For more information about securing the website with SSL, see Configure Secure Sockets
Layer (SSL) access.
A directory location for PI Coresight. OSIsoft highly recommends that all OSIsoft
components are installed in the same root folder. For example, Program Files\PIPC.
A website name where PI Coresight will be installed. If you are installing on an existing
PI WebParts or PI Web Services application server, enter the website you created when
you prepared the application server--see Prepare the PI Coresight application server
computer.
5. The install kit prompts you to begin the installation. The installation process creates the
following items:

The pre-populated Windows groups on the application server: PI Coresight Admins,

PI Coresight Users, and PI Web API Admins
The PI Coresight Administration website
The PI Coresight website, plus the application pools: CoresightServiceAppPool and
CoresightAdminAppPool
Two Windows services: PI Web API and PI Index Search Crawler
6. For the PI Web API installation, choose the Custom setup type.
7. When prompted during the PI Web API installation for an account, choose the
CoresightService account that was created.
8. When prompted during the PI Web API installation for a trusted certificate, either select an
existing SSL certificate or choose the option to create a self-signed certificate and then
select it.
For more information, see Configure Secure Sockets Layer (SSL) access.
9. Follow the directions in Configure PI Coresight service accounts to ensure all services are
running under the correct accounts.
10. After the installation completes, reboot your machine, and then follow the instructions in
Configure PI Coresight after installation to finish the configuration.
Silent installation
To invoke a silent installation, enter the following command:
setup.exe -f silent.ini
You can customize the silent.ini file to provide a default PI Data Archive server
configuration, as follows:
[COMMANDLINE] 4 = /qn REBOOT=Suppress
ALLUSERS=1 PI_SERVER= localhost PI_ALIAS=localhost PI_TYPE=3
PI_PORT=5450 PI_USER=piadmin INSTALLDIR="C:\Program Files\PIPC"
Multilingual UI available to install

The PI Coresight Multilingual User Interface (MUI) is available for download from the OSIsoft
Technical Support website (http://techsupport.osisoft.com/).
After the MUI is installed on the web server, users can change the language seen in PI Coresight
by modifying the language settings in their browser.
PI Coresight Multilingual User Interface (MUI) support allows users to view the application in
eight different languages:
French
German
Spanish
Portuguese
Simplified Chinese
Japanese

Korean
Russian

Configure PI Coresight after installation
After installation completes, configure PI Coresight by following these steps:
Note:
For an instructional video on how to configure PI Coresight, see "Configure PI Coresight
2014 with the PI Coresight Administration Page" (https://www.youtube.com/watch?
v=6-SBORJGFNU&index=10&list=PLMcG1Hs2Jbct0EHchLIiJTegzXSv3XVWF) in the "PI
System Installation Walk-throughs" playlist on Youtube.
Procedure
1. Configure PI Coresight application pools to use the PI Coresight service account. See
Configure PI Coresight service accounts for more information. If you opted to use the
machine account rather than a dedicated domain account, then you can skip this step.
2. Create the 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. See PI Coresight database creation.
3. Disable Secure Sockets Layer (SSL), version 2.0 and earlier, on the PI Coresight application
server. See Disable SSL Version 2 and earlier.
4. Optionally, configure SSL access. See Configure Secure Sockets Layer (SSL) access.
You must use SSL and Basic authentication for most mobile client apps and browsers.
Note:
If you have configured your SSL site to use Basic authentication and then you upgrade
PI Coresight, Basic authentication is disabled and needs to be re-enabled.
For more information, see PI Data Archive server authentication on mobile devices.
5. Configure access to PI Data Archive server data. See Configure PI Coresight access to PI Data
Archive server data.
6. Configure access to PI AF databases. See Configure PI Coresight access to PI AF databases.
Configure PI Coresight service accounts

If you are using a domain account for the PI Coresight service account, then you must
configure the application pools to use this identity , as described below. If you plan to use the
machine account for the PI Coresight service, then you do not need to configure the application
pools accounts.
Caution:
OSIsoft strongly recommends that you create a domain account for the PI Coresight
service. If you use the machine account (the default), then all the applications running on
the application server computer will have all the access permissions on the SQL, PI, and
PI AF servers that the PI Coresight service has. This is a security risk. At a minimum,
consider removing some or all of the other applications running on this computer.

Note:
As described in these steps, you must ensure that the Enable 32-bit Applications setting
is set to False. PI Coresight is a 64-bit application and will not work properly in a 32-bit
application pool.
Procedure
1. Run Internet Information Services (IIS) Manager.
2. Under Connections, click Application Pools to display the list of application pools. The list
includes the two Coresight application pools:
CoresightAdminAppPool runs the PI Coresight Administration website, located at
https://webServer/Coresight/Admin
CoresightServiceAppPool runs the main PI Coresight application services located at
https://webServerCoresight
3. Right-click the CoresightAdminAppPool and choose Advanced Settings. The Advanced
Settings dialog box opens.
4. Under General, the Enable 32-bit Applications setting should be False. PI Coresight is a 64-
bit application and will not work properly in a 32-bit application pool.
5. Under Process Model, click in the Identity field and then click the Browse button. The
Application Pool Identity dialog box opens.
6. Click the Custom account radio button and then click Set. The Set Credentials dialog box
opens.
7. Enter the user name and password for the Coresight service account. Click OK on this and
subsequent dialog boxes.
8. In the application pools list, repeat these steps for the CoresightServiceAppPool
application pool.
9. If the PI Web API and PI Web API Crawler were not installed using the Coresight service
account, open the Control Panel, navigate to Programs and select Programs and Features.
10. Select the PI Web API and click Change. This will open up the PI Web API Setup. The current
configuration will be reflected, so you may keep the selections and continue through the
wizard until you reach the Web API Service Account and Crawler Service Account screens
where you can select the radio button A custom account and enter the custom domain
account and password.
If a domain account is not being used, you can skip this step.
PI Coresight database creation

To create the PI Coresight database, follow these steps:
Procedure
1. Configure the Microsoft SQL Server connection. See Configure the Microsoft SQL Server
connection.
2. Use one of the following methods to create the PI Coresight database:

Use the PI Coresight Administration website, as described in Create the PI Coresight

database. This is the easiest way to create the database.
Manually create the PI Coresight database on the Microsoft SQL Server as described in
Manually create the PI Coresight database. This method is typically required unless you
are working on the PI Coresight server machine itself or PI Coresight and the SQL server
that will host the PI Coresight database on the same machine.
Configure the Microsoft SQL Server connection

The user logged into the PI Coresight administration site must have access to the Microsoft
SQL Server in order to complete this procedure.
Note:
Ensure the SQL Server configuration setting Allow Triggers to Fire Others is set to True.
For more information, see Microsoft SQL Server requirements.
Follow these steps to configure your connection to a local or remote Microsoft SQL Server.
Procedure
1. In your web browser, navigate to the PI Coresight Administration website. By default this
site is located at: https://webServer/Coresight/Admin where webServer is the name of
the PI Coresight web server.
Note:
If you access the PI Coresight Administration website from a browser that is running
locally on the PI Coresight application server, then you must run the browser as an
administrator. To do this, right-click the browsers shortcut icon and select Run as
Administrator.
2. Click Configuration in the navigation at left and choose the PI Coresight Database tab.
3. To specify the Microsoft SQL Server instance to host the PI Coresight database, click the
dropdown button next to the SQL Server field and select the server you want, or type its
name directly in the box, for example, .\sqlexpress.
4. Click Save.
Create the PI Coresight database

The method shown here is applicable in only the following situations:
Kerberos delegation is configured between the PI Coresight application server and the SQL
Server computer.
The PI Coresight database is located on the same computer as the PI Coresight application
server.
You are running your browser locally on the same computer as the PI Coresight application
server.
If your configuration does not meet these conditions, follow the instructions in Manually create
the PI Coresight database.

Before you start

Note:
To create the Coresight database, you must have:
The db_creator server role
ALTER ANY LOGIN permission (meaning you have been granted this permission by
use of the statement GRANT ALTER ANY LOGIN TO "domain\account" or you are a
member of the securityadmin server role).
Procedure
1. In your web browser, navigate to the PI Coresight Administration website. By default this
site is located at: https://webServer/Coresight/Admin where webServer is the name of
the PI Coresight web server.
Note:
Administrator.
2. Click Configuration in the navigation at left and choose the PI Coresight Database tab.
3. Click Save. A green check mark appears next to the Microsoft SQL Server and database
names to verify successful configuration.
Manually create the PI Coresight database

Note:
To create the PI Coresight database, you must have the following privileges:
Membership of the db_creator server role
You can be granted this permission by use of the statement GRANT ALTER ANY
LOGIN TO "domain\account". If you are a member of the securityadmin server role
you already have ALTER ANY LOGIN permission.
Note:
To upgrade the PI Coresight database, you must have the following minimum database
role memberships, or be a member of the db_owner database role.
db_datareader
db_datawriter
db_ddladmin
You can use the following steps to create, upgrade and configure a PI Coresight database on a
Microsoft SQL Server.
Procedure
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. On the machine running SQL Server, paste the folder and all its contents to a local directory.
3. On the machine running SQL Server, open a command prompt as Administrator, navigate to
the local directory used in Step 2, and run the Go.bat script:
Go.bat DBServer DBName CoresightService
DBServer is the name of the SQL server

Note:
If DBServer contains any spaces, enclose the string in double quotes.
DBName is the name of the PI Coresight database

CoresightService is the name of the PI Coresight service account
You need to format CoresightService according to which type of account you are using:
CoresightService account type Format for CoresightService
Domain user domain\service account name
Network Service, and the SQL Server is not Enter the application server computer domain
installed on the PI Coresight application server account. Active Directory computer accounts
always end in a dollar sign, for example:
"domain\computer name$"
Network Service, and the SQL Server is "NT AUTHORITY\Network Service"
installed locally on the PI Coresight application
server
Note:
If CoresightService contains any spaces, enclose the string in double quotes.
4. After the command has completed, return to the PI Coresight Configuration page on the PI
Coresight Administration website.
5. Click the PI Coresight Configuration tab.
6. Click the change link in the table row for the PI Coresight database.
7. Enter the name of the PI Coresight database you created, or click the ellipsis button to
search for it.
8. Click Set. When you have successfully completed the configuration, a green check mark
appears in the Status column next to the Microsoft SQL Server and database names.
Examples of input parameters for go.bat

The following examples demonstrate the use of input parameters with the Go.bat script.
Default local instance of SQL Server, custom domain account

For the command:
Go.bat .\ PICoresight mydomain\coresightaccount

The PI Coresight SQL database is named PICoresight

The default local instance of SQL Server is used.
A custom domain account is used.
Specific instance of SQL Server, machine account

For the next command:
Go.bat sqlserver\sqlinstance PICoresight mydomain\coresightserver$
The PI Coresight SQL database is named PICoresight

A particular instance of SQL Server is used.
The machine account of the PI Coresight application server is used.
Local SQL Express database, services running under default application pool
For this command:
go .\SQLEXPRESS Coresight "NT AUTHORITY\NETWORK SERVICE" output.log
The PI Coresight SQL database is a SQL Express database named Coresight and is local.
The PI Coresight web services run under the default application pool.
The output.log keyword causes the results to be captured and stored in the file TEMP
\coresightdbupgrade.log (for example, C:\Users\username\AppData\Local
\Temp\coresightdbupgrade.log).
Disable SSL Version 2 and earlier

OSIsoft strongly recommends that you disable support for SSL Version 2.0 and earlier, on the
Coresight application server. These versions of SSL represent a security risk. Windows Server
2008 R2 has SSL v2.0 turned off by default but Windows Server 2008 and other versions may
have it turned on.
For instructions, see the Microsoft article How to disable PCT 1.0, SSL 2.0, SSL 3.0, or TLS 1.0 in
Internet Information Services (http://support.microsoft.com/kb/187498).
Configure Secure Sockets Layer (SSL) access

OSIsoft recommends that you enable SSL for your PI Coresight website; this is required by
most mobile clients. For more information see PI Data Archive server authentication on mobile
devices.
To fully secure access to PI Coresight, use a digital certificate obtained from a trusted third-
party registrar or from your enterprise's private certificate authority. While the installation
program can create a self-signed certificate, you should only use that option if the PI Coresight
website will not be secured using SSL.
To run PI Coresight from a website that is using SSL, follow these steps.
Procedure
1. Configure the IIS site that hosts the PI Coresight website to use SSL.

For more information, see the Microsoft articles How to implement SSL in IIS (http://
support.microsoft.com/kb/299875) and SSL Certificate Installation in Microsoft IIS 8 and
IIS 8.5 (http://www.digicert.com/ssl-certificate-installation-microsoft-iis-8.htm).
2. Use an editor to open the web.config file located in the Services folder:
%Program Files%/PIPC/Coresight/Services/web.config
3. Change to secure http by replacing httpTransport with httpsTransport.
Enable HTTP compression on the PI Coresight application server

HTTP compression allows web servers and web clients to make more efficient use of available
bandwidth and can improve transmission speeds. To enable dynamic HTTP compression in
Internet Information Services (IIS) on the PI Coresight application server, perform the
following steps.
Note:
OSIsoft recommends that you enable compression, but it is not required. If you enable
compression, it will affect every web application on the machine, not just PI Coresight.
Procedure
1. Ensure that both the Static Content Compression and Dynamic Content Compression role
services are installed under Web Server\Performance on the application server. See Server
Manager roles and features for a full list of all the role services that are required or
recommended.

2. Register two MIME types on the application server. To register the MIME types, open an
Administrator command prompt and navigate to the folder c:\WINDOWS
\System32\inetsrv:
a. Execute the following two commands:
appcmd set config /section:httpCompression /+dynamicTypes.
[mimeType='application/soap+msbin1',
enabled='true'] /commit:apphost
appcmd set config /section:httpCompression /+dynamicTypes.

[mimeType='application/json',
enabled='true'] /commit:apphost
Note:
If either of these MIME types is already installed on the server, you will receive an
error similar to: Cannot add duplicate collection entry of type 'add'
with unique key attribute. You can ignore this error.
b. Restart IIS by running IISRESET on the application server from the same command
prompt.
3. Enable Static and Dynamic Compression in IIS Manager.

a. Open Control Panel > Administrative Tools > Internet Information Services (IIS)
Manager
b. In the left pane, locate the website under which PI Coresight was installed (by default,
this is "Default Web Site") and click this entry.
c. In the IIS section, double click Compression.

d. If they are not already selected, check Enable dynamic content compression and Enable
static content compression, and close IIS Manager.


Configure PI Coresight access to PI Data Archive
server data
To set up PI Coresight access to PI Data Archive server data:
Procedure
1. Configure access permissions for the PI Coresight service account. PI Coresight users should
be able to use their existing PI Data Archive server access permissions.
2. Configure PI Data Archive server authentication for the Coresight service account and for PI
Coresight users.
3. Finally, use the PI Coresight Administration website to allow PI Coresight users access to
each allowed PI Data Archive server. See Allow access to each PI Data Archive server from
PI Coresight.
Configure PI Data Archive server access permissions

The Coresight service account requires read access to PI point data security and point security
on each PI Data Archive server that is available to PI Coresight users. PI Coresight users need
data security and point security for any PI points that they are allowed to view. If these users
already have the appropriate access on the PI Data Archive server, then you do not need to
configure access permissions for them.
You define PI Data Archive server access permissions on a PI identity, PI user or PI group. On
each PI Data Archive server that you plan to access through PI Coresight, follow these steps:
Procedure
1. Create a PI identity for PI Coresight or identify an existing PI identity that has the required
access permissions. Since read access to each PI point is required, it is easiest to use an
existing PI identity that already has that access. See Create the PI identity.
2. If you created a new PI identity for PI Coresight, then you need to grant the PI identity read
access to the PI points. See Grant the PI identity the required access permissions.
3. Finally, set up authentication. The procedure depends on your configuration. See Configure
PI Data Archive server authentication.
Create the PI identity

Procedure
1. Run the PI System Management Tools application.
2. Under Collectives and Servers, select a server.
3. Under System Management Tools, select Security > Identities, Users, & Groups.
4. Select the PI Identities tab.
5. Click the New Identity button to open the New Identity dialog box.

Configure PI Coresight access to PI Data Archive server data
6. In Identity, type a name for the new identity. This is the only field that is required when you
create a new identity. Note the following restrictions on identity names:
The name must be unique.
The name cannot include the vertical pipe (|) character or the colon (:) character.
The name cannot be a positive integer, although it can contain numbers. For example, the
name "407" is not valid, but the name "Admins407" is valid.
The name is not case sensitive.
If you try to create an identity with an invalid name, an error message appears and the
identity is not created. Note that you can change an identity name any time after creation.
7. Select the appropriate server from the drop-down Server list. This list is populated from the
selected servers under Collectives and Servers. Only version 3.4.380 and later PI Data
Archive servers appear in the list. Earlier versions of the PI Data Archive server do not
support PI identities.
8. Optionally, enter a brief description in Description. There are no restrictions on the
contents of this field.
9. At the bottom of the dialog box, select the Identity cannot be deleted check box. This
prevents the identity from being accidentally deleted. To delete this identity, you must first
edit the identity and clear this check box.
10. Click Create. The new PI identity now appears in the PI Identities tab.
Grant the PI identity the required access permissions

To grant the PI identity read access to the PI points on a PI Data Archive server, you need to
grant to the identity:
Read access on the PIPOINT and PIMAPPINGS database tables. Use the Database security
tool in PI SMT (Security > Database Security).
Read access to the point data for each PI point. The simplest method is to use Tag
Configurator to edit the points in bulk. Alternatively, you can use PI SMT to edit point
security on each point.
Note:
If the indexed search service is running under a different account than the PI Coresight
service, that account also needs these access permissions.
Configure PI Data Archive server authentication

Configure PI Data Archive server authentication for PI Coresight through Windows Integrated
Security (WIS).
Caution:
OSIsoft does not recommend that you use a PI trust to configure authentication. If you
use a PI trust, you will not be able to search for PI points unless the client user also has a
PI Mapping to associate their Active Directory user to a PI Identity.
To use WIS authentication, the following criteria must apply:

1. WIS requires Kerberos delegation. Kerberos delegation enables users in a distributed

application environment to access remote data sources through Windows authentication.
See Enable Kerberos delegation.
2. WIS requires that you use PI mappings to authenticate users on the PI Data Archive server.
If you are not already using PI mappings to authenticate PI Data Archive server users, then
you need to set up the requisite mappings in order to use WIS. The PI Data Archive Server
Security Configuration Guide explains how to do this.
Caution:
If you support PI Coresight users on the PI Coresight iPhone or iPad apps or on mobile
browsers and you use WIS to authenticate PI Data Archive server users, then you need to
configure SSL and Basic authentication. Follow the instructions in PI Data Archive server
authentication on mobile devices.
Configure WIS authentication

Follow these steps:
Procedure
1. Enable Kerberos delegation.
2. Create a PI mapping for the PI Coresight service account identity.
3. If PI mappings for the PI Coresight users do not exist, you need to create them. See the
Configuring PI Data Archive Server Security Guide for guidance.
Enable Kerberos delegation

To enable PI Coresight to connect using Windows Integrated Security, configure Kerberos
delegation for the PI Coresight application server.
Note:
If you are using a Custom Host name instead of a NetBIOS name, refer to the Microsoft
archives for information about: 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).
The procedures below assume you are accessing the web server with a NetBIOS name, such as
https://webServer/Coresight.
Use a default machine account

By default, the application pools and Windows services associated with PI Coresight will use
the following users:
PI Web API: NT Service\piwebapi
PI Web API Crawler: NT Service\picrawler
PI Coresight: NT Authority\Network Service
PI Coresight Admin: NT Authority\Network Service

When this configuration is used, the HOST SPNs below must exist for the machine account of
the PI Coresight application server. These SPNs should already exist by default, but you may
verify their existence using setspn -l netbios-server-name.
HOST/netbios-server-name
HOST/fully-qualified-DNS-name
Kernel mode is enabled by default and it should remain enabled for this configuration.
Procedure
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 the following options:
Trust this computer for delegation to specified services only
Use any authentication protocol
When you choose the first option, you will need to add the Service Principle Names for each
PI Data Archive server and AF server that will be accessed through PI Coresight by clicking
Add, Users or Computers and specifying the name of the PI Data Archive server or AF
server. Then locate the SPN and select it as the service to which to allow delegation. A PI
Data Archive server SPN will have the Service Type PIServer and an AF server will have the
Service Type AFServer. Selecting Use any authentication protocol allows for a protocol
transition.

After you finish

In some Active Directory environments, you also need to disable kernel-mode authentication
and create service principal names (SPNs), as described in Use a custom domain account
Use a custom domain account

If a custom domain account is being used, both application pools and Windows services
associated with PI Coresight should be running as that user.
When this configuration is used, HTTP SPNs must exist for the domain account used by the PI
Coresight application server. These SPNs will most likely need to be added, but you may check
their existence using setspn -l domain\service-account.
HTTP/netbios-server-name
HTTP/fully-qualified-DNS-name
When using a custom domain account, you might need to disable kernel-mode authentication:

If you require access to websites or services that are not hosted in IIS, which are installed
on the PI Coresight server. For example, the PI Web API website.
If you want to restrict delegation to the PI Coresight service account, rather than to the
server machine account in Active Directory.
To disable kernel-mode authentication, use Internet Information Server (IIS) Manager to
configure the security settings for the PI Coresight web application.
Procedure
1. In Internet Information Services (IIS) Manager, select the PI Coresight web application and
double-click the Authentication icon under the features view.
2. Select Windows Authentication and click the Advanced Settings link in the right pane.
3. Uncheck Enable Kernel-mode authentication.
4. If you are running PI Coresight under a custom domain account, open an Administrator
command prompt with domain administrative rights and create two Active Directory
Service Principal Names (SPNs).
One SPN is for the netbios name and one for the fully-qualified DNS name of the PI
Coresight application server:
setspn -S http/netbios-server-name domain\service-account
setspn -S http/fully-qualified-DNS-name domain\service-account
5. Specify a trust setting for the service account. For a Windows Server 2003 or 2008 domain
controller: on the Delegation tab, select the following options:
Trust this computer for delegation to specified services only
Use any authentication protocol
When you choose the first option, you will need to add the Service Principle Names for each
PI Data Archive server and PI AF server that will be accessed through PI Coresight by
clicking Add, Users or Computers and specifying the name of the PI Data Archive server or
AF server. Then locate the SPN and select it as the service to which to allow delegation. A PI
Data Archive server SPN will have the Service Type PIServer and an AF server will have the
Service Type AFServer. Selecting Use any authentication protocol allows for a protocol
transition.
Examples
setspn -S http/myserver mydomain\CoresightService
setspn -S http/myserver.mydomain.int mydomain\CoresightService
Basic authentication
The end users credentials can also be delegated if Basic authentication is configured. This
approach will allow Coresight to honor user specific security, but Basic authentication sends
the user credentials to the web server in plain text, so you must also configure the PI Coresight
website to use Secure Sockets Layer (SSL). For more information, see Configure Secure Sockets
Layer (SSL) access.
Procedure
1. Select the PI Coresight web application and double-click the Authentication icon under the
features view.

2. Select Basic Authentication and click the Enable link in the right pane.
3. Open the web.config file in the folder %pihome64%\Coresight\Services and set the
value of the authenticationScheme attribute to Basic for the httpsTransport element.
Create PI mappings
You need PI mappings for the PI Coresight service account and for PI Coresight users. If your PI
Coresight users are existing PI Data Archive server users, then you can use their existing
mappings. Otherwise, you need to create them. See the Configuring PI Data Archive Server
Security Guide for tips.
To create a mapping:
Procedure
1. Open PI SMT.
2. Under Collectives and Servers, select the server.
3. Under System Management Tools, select Security > Identities, Users, & Groups.
4. Select the identity, user, or group that you want to map.
5. In the toolbar, click the properties button . The Properties dialog box opens.
6. In the Properties dialog box, click the Mappings and Trusts tab. The top portion of the dialog
box shows all existing mappings for this PI identity, user, or group. The bottom portion
shows all existing PI trusts.
7. Click the Add button under the mappings portion of the dialog box. The Add New Mapping
dialog box opens.

Note:
The Add button is disabled if the selected PI identity is flagged as disabled or not
usable in a mapping.
8. Enter the Windows account. This can be an AD principal or a local Windows group or user.
To select the account either:
Click the browse button to browse for the account.
Type in the account name. If you choose to type in the account name, click the resolve
SID button to verify that this is a valid account. If the account is valid, an SID appears
in the field. Otherwise, a dialog box with an error message opens.
After you finish

If you have difficulty creating the mapping, click the Help button in PI SMT.
PI Data Archive server authentication on mobile devices

OSIsoft recommends that you use Basic authentication with SSL encryption for mobile device
users.
This enables all supported mobile apps and browsers to authenticate to the PI Coresight server
successfully. Some devices can also support Kerberos authentication.
Note:
You can use NTLM rather than Basic authentication if the PI Coresight application server
and the PI Data Archive server are installed on the same server machine.
Kerberos authentication in mobile Safari for iPhones and iPads

Starting with iOS 7, you can configure the mobile Safari browser to access the PI Coresight
mobile website on iPhones and iPads and use Kerberos authentication through the enterprise
single sign on (SSO) feature. (This information does not apply to using the native iOS PI
Coresight apps.)
You must configure allowed websites through Apple enterprise management tools and they
can be pushed to devices in various ways. For more information, see Apple's webpages about
iOS 7 and business (http://www.apple.com/ios/business/).
Basic authentication
With Basic authentication, user credentials are passed to the PI System. You should use the
Basic authentication method if you use mappings on the PI Data Archive server to provide user
specific security. However, Basic authentication sends the user credentials to the web server in
plain text, so you must also configure the PI Coresight website to use Secure Sockets Layer
(SSL). For more information, see Configure Secure Sockets Layer (SSL) access.
Use Internet Information Server (IIS) Manager to configure the security settings for the PI
Coresight web application:
1. Select the PI Coresight web application and double-click the Authentication icon under the
features view.

2. Select Basic Authentication and click the Enable link in the right pane.
3. Select Windows Authentication.
4. Click the Providers link from the right pane.
5. Delete NTLM from the window that opens.


Configure PI Coresight access to PI AF databases
PI Coresight users can search PI AF data without having to specify or manually connect to a PI
AF database. To enable this feature, you need to configure PI Coresight access to the relevant
PI AF databases. Before you configure database access, make sure that you have the correct
access permissions.
Configure PI AF authentication and access permissions.

Use the PI Coresight Administration website to grant PI Coresight users access to PI AF
databases.
If users have trouble seeing PI AF data, check the access permissions.
Configure PI AF authentication and permissions

PI AF uses Windows security. If you have a Windows group (domain, not local) that currently
has the required access permissions, then you can just add the Coresight service account to
that group. Otherwise, you will need to manually grant the required access.
Configure read access for the PI Coresight service account for the following:
Each PI AF server that you want to access through PI Coresight. See Configure access to a PI
AF server.
Each AF database that you want to access through PI Coresight. See Configure access to a PI
AF database.
All the PI AF elements, event frames and tables that you want to access through PI
Coresight. See Configure read access for PI AF objects.
Individual PI Coresight users access the PI AF server data through their own Windows
accounts. If existing PI AF users get PI AF access through their domain accounts, then you do
not need to configure access for these users. If users get PI AF access through a local group or
account on the PI AF server, then they will not be able to see AF objects in PI Coresight.
Note:
If you cannot switch to a domain account, you can use the following workaround. You can
create the same local group on the PI Coresight application server with the same name
and the same members. As long as these two groups are completely identical, the users
should have the correct access to PI AF through PI Coresight.
Configure access to a PI AF server

Procedure
1. Open PI System Explorer.
2. Choose File > Connections. The Servers dialog box opens and lists all PI Data Archive
servers and PI AF servers for which a connection is configured. The currently connected PI
Data Archive server and PI AF server are indicated with green circles.

Configure PI Coresight access to PI AF databases
3. If the currently connected PI AF server is the server to which you want to configure access,
skip this step. Otherwise, right-click on the name of the server you want to configure in the
list and choose Connect.
4. Right-click the connected PI AF server and choose Security > Server. The Permissions dialog
box for that server opens.
5. Click Add. The Select Users or Groups dialog box opens.
6. Enter the Coresight service account name and click OK. The Coresight service account name
appears in the Group or user names field.
7. In the Permissions field, check the Read check box in the Allow column.
8. Click OK.
Configure access to a PI AF database

Procedure
1. Open PI System Explorer.
2. Choose File > Connections. The Servers dialog box opens and lists all the PI Data Archive
servers and PI AF servers for which a connection is configured. The currently connected PI
and PI AF servers are indicated with green circles.
3. If the currently connected PI AF server is the server to which you want to configure access,
skip this step. Otherwise, right-click on the name of the server you want to configure in the
list and choose Connect.
4. Right-click the connected PI AF server and choose Security > Databases. The Permissions
dialog box for that server opens.
5. Click Add. The Select Users or Groups dialog box opens.
6. Enter the Coresight service account name and click OK. The Coresight service account name
appears in the Group or user names field.
7. In the Permissions field, check the Read check box in the Allow column.
8. Click OK.
Configure read access for PI AF objects

The PI Coresight service account needs read access to each AF element, table, and event frame
that you want to access through PI Coresight. You can set access permissions for AF objects in
PI System Explorer or in PI AF Builder. PI AF Builder is a Microsoft Excel plug-in that allows
you to edit PI AF objects in bulk. If you need to edit the security settings for many objects, then
PI AF Builder is the best choice.
Note:
In PI AF, library objects are always readable regardless of their security settings. This
means you do not need to grant read access for the following AF objects: categories,
templates, enumeration sets, reference types, and UOMs.

PI Coresight administration tasks
This section explains how to perform various PI Coresight administration tasks.
Set up user access
Configure user access to the PI Coresight application

Configure Firefox and Chrome browsers for PI Coresight clients
Check the health of your PI Coresight installation

You can use the PI Coresight Administration website Overview page to check the health of your
PI Coresight installation:
Check PI Coresight status
Manage access to data, ownership, and reports

You can use the Administration website to control access to your data, manage ownership of
objects, and generate reports:
Allow access to each PI Data Archive server from PI Coresight
Add a PI Data Archive server to the registered PI Data Archive servers list
Configure PI AF database connections
Add a PI AF server to the list of registered PI AF servers
Reassign display ownership
Reset user settings
Generate reports
Manage access to PI ProcessBook displays

Starting with PI Coresight 2014, you can configure your application server to enable PI
Coresight users to view PI ProcessBook displays. Use the Administration web site to specify
which folders you want PI Coresight to monitor for PI ProcessBook displays:
Update the PI Coresight database
Update the SQL Server instance and PI Coresight database

Change the account of the PI Coresight database
Adjust time zone and regionalization settings
Change time-zone settings

Change regionalization settings
Uninstall
Uninstall PI Coresight

Configure user access to the PI Coresight application

The PI Coresight Users group controls access to the PI Coresight application. It is a local
Microsoft Windows user group on the PI Coresight application server. To grant a user access to
the PI Coresight application, add the user account to this group. To revoke access, remove the
user account from this group.
By default the PI Coresight Users group includes Authenticated Users as a member.
With this configuration, anyone who can access the application server can also access PI
Coresight. To limit access to PI Coresight, first remove Authenticated Users from the group,
and then add authorized users.
To open the PI Coresight application, in a supported browser, users navigate to: https://
webServer/Coresight/
where webServer is the name of your PI Coresight web server that you specified during
installation.
Configure Firefox and Chrome browsers for PI Coresight clients

To use the Firefox or Google Chrome browsers for PI Coresight clients, you must first add the
PI Coresight application server as a trusted site.
For a list of supported browsers, see Supported browsers for PI Coresight.
Add PI Coresight application server as a Google Chrome trusted site and

authenticate using Kerberos
Google Chrome uses the same Trusted Sites list as Internet Explorer which can be configured
through Control Panel by selecting Network and Internet and opening Internet Options.
Trusted Sites are accessible through the security tab in Internet Options.
Add the PI Coresight application server as a Firefox trusted site
Procedure
1. Open Firefox and type about:config into the address bar. Confirm any warning dialogs
that may appear.
2. Enter auth in the Search field to filter the list.
3. Locate these two preference fields:
network.negotiate-auth.trusted-uris
network.negotiate-auth.delegation-uris
4. Double-click each field and enter the name/URL of the PI Coresight application server.

The PI Coresight Administration website and Administrator

users
The PI Coresight Administration website provides a graphical user interface for PI Coresight
administration tasks. The Overview page shows you a snapshot of your current PI Coresight
installation. To access the site, browse to:
https://webServer/Coresight/Admin
where webServer is the name of your PI Coresight web server.
To grant a user access to the PI Coresight Administration website, add their user account to the
PI Coresight Admins group and to the PI Web API Admins group. These are local
Microsoft Windows user groups on the PI Coresight application server. By default, only the
user who runs the installation is added to these groups.
In addition to having access to the PI Coresight Administration website, users in the PI
Coresight Admins group can perform restricted tasks in the main PI Coresight application,
such as reassigning individual displays to another user.
Note:
If you are running a browser locally on the PI Coresight application server, it must be run
by an administrator for any changes to take effect. To set your browser to run as
administrator, right-click the browser's shortcut icon and select Run as administrator.
Check PI Coresight status

Use the PI Coresight Administration website to check the status of your PI Coresight
installation and make configuration updates. The Overview page shows you a current snapshot
of the following information:
PI Coresight Databaseshows the SQL Server instance and the PI Coresight database.
The Status column displays a green checkmark if the PI Coresight application server can
connect to the PI Coresight database running on SQL Server.
PI Servers AllowedPI Data Archive servers that are used by PI Coresight for searching and
retrieving data. Additionally, the current user of the PI Coresight Administration website as
well as the application pool identity are shown for each allowed PI Data Archive server.
The Status column shows a green checkmark if the application pool account can connect to
the PI Data Archive server.
The Indexed column shows a green checkmark if the indexed search service can
successfully crawl the PI Data Archive server.
PI AF Servers/Databases AllowedAF Servers and corresponding databases that are used
by PI Coresight for searching and retrieving data.
The Status column shows a green checkmark if the application pool account can connect to
the PI AF database.
The Kerberos column shows a green checkmark if the application can impersonate the
client user when accessing the applicable PI AF server.

The Indexed column shows a green checkmark if the indexed search service can
successfully crawl the PI AF database.
Indexed Search Service Statusshows the URL of the service for indexed search.
The Status column shows a green checkmark if the PI Coresight application server can
successfully communicate with this service.
When you first install PI Coresight, your allowed PI Data Archive servers and AF databases
are crawled to find metadata to build indexes to improve the performance of commonly
used queries. If you have large databases, initial crawling will take longer than if your
databases are smaller. To maintain these indexes as your data changes over time, the
indexed search service periodically runs the crawlers to gather updated metadata.
File Version Statusindicates whether all file versions meet minimum requirements.
To make configuration updates, click Manage Configuration next to the appropriate list.
Alternatively, you can use the navigation tabs at left. For example, to make a PI Data Archive
server available to your users' searches, you need to change its status to Allowed. Therefore,
click Manage Configuration next to PI Servers Allowed and at the Configuration page that opens
you can add or remove access to any PI Data Archive server that is available on the PI
The Version Information link at top right opens a list showing the versions of all software
components that are installed to run PI Coresight. The Connection Status column indicates
whether a file exists and meets the minimum version requirements.
Access to PI Data Archive and PI AF data

Add server to the registered servers list

Use the PI Coresight Administration website to allow access to each PI Data Archive server that
your users are working with:
Procedure
1. On the Overview page, click Manage Configuration next to the PI Servers Allowed list. Or
click Configuration in the navigation tree at left and then choose the PI Servers tab.
2. To add a PI Data Archive server for use, click Allow next to that server.
If the PI Data Archive server that you are looking for is not in the list, see Add a PI Data
Archive server to the registered PI Data Archive servers list.

Note:
The Test Connection button tests whether you can connect to the appropriate PI Data
Archive server using the CoresightService account. This is the identity used by the
PI Coresight application pools.
3. After you finish making changes, click Save to update the PI Coresight application server
with your selections.
Add a PI Data Archive server to the registered PI Data Archive servers list
Configure a connection from the PI Coresight application server to each PI Data Archive server
that you plan to use with PI Coresight:
Procedure
1. On the application server, open the PI SDK utility. The PI SDK utility is installed as part of
the PI Coresight installation.
2. Choose File > Connections. The PI Connection Manager dialog box opens
3. Choose Server > Add PI Server. The Add PI Server dialog box opens.
4. Configure the connection. Connection parameters include:
Network Path/FQDN
The DNS name of the computer where the PI Data Archive server resides. If the node
cannot be resolved automatically, you can also enter the fully qualified domain name (for
example, MyServer.MyDomain.com, instead of MyServer)
Confirm
Select Confirm to verify the connection to the new server. If the initial connection fails,
the Add Server dialog box remains open to allow you to try the connection again with
correct server information. Make sure to clear this option if you know a server does not
yet exist, or is unreachable at the moment.
Procedure
1. On the Overview page, click Manage Configuration next to the PI AF Servers/Databases
Allowed list. Or click Configuration in the navigation tree at left and choose the PI AF
Servers tab.
The PI AF Servers and Databases page appears. This page presents the AF Servers
recognized by PI Coresight. To add a PI AF server to the list, see Add a PI AF server to the
list of registered PI AF servers.
2. If a PI AF server has a triangle symbol beside it, you can expand it to see a list of PI AF
databases on that server in the Databases column:
a. To verify the connection to an PI AF server, click Test Connection in the Connection
Status column.
b. To allow access to all databases, select All. Alternatively, to enable access to a subset of
the databases, select the checkboxes of only those databases to which you want to allow
access.

3. If a PI AF server does not have a triangle symbol beside it, click Test Connection to initiate a
connection to that server. If the connection is successful, you can then see the databases
that reside on that server.
4. After you have finished making changes, click Save to update the PI Coresight application
server with your selections.

If the list of registered PI AF servers and databases does not include the AF server that you
want, follow these steps:
Procedure
1. Run PI System Explorer locally on the PI Coresight application server. PI System Explorer is
installed as part of the PI Coresight installation.
2. Choose File > Connections. The Servers dialog box opens. This dialog box lists all the PI Data
Archive servers and PI AF servers for which a connection is configured. The currently
connected PI Data Archive and PI AF servers are indicated with green circles.
3. Right-click the PI AF server that you want to add to the list of registered servers and choose
Connect.
Note:
If the server you need is not displayed, refer to the PI System Explorer help for
instructions (you can access the help by clicking Help > Help Topics).

Starting with PI Coresight 2014, you can configure your application server so users can view PI
ProcessBook displays.
Use the Administration website to specify which folders you want PI Coresight to monitor for
PI ProcessBook displays. When the monitoring service detects a new, modified, or deleted PI
ProcessBook file in these folders, it automatically adds, updates, or deletes it from PI Coresight.
All PDI and SVG files in the specified folders and any subfolders are automatically imported
into the PI Coresight application server.
Caution:
To keep your data secure, OSIsoft recommends you implement the following measures:
Restrict network access to the import folders to only allow those users and groups
who require it to add displays. You can authorize users and groups by using the
security settings of the Windows operating system for folders and shared volumes.
Please note that imported displays will be available to view by client users in
Coresight. Permissions on the display files in the import folders are not applied to the
imported displays.
Enable Windows Security Auditing to track who adds, deletes, or modifies the files in
the import folders. For more information see: Apply or Modify Auditing Policy Settings
for a Local File or Folder (http://technet.microsoft.com/en-US/library/
cc771070.aspx).
Note:
PI Coresight never modifies the contents of an imported folder.

Procedure
1. On the Overview page, click Import Folder Management.
2. To add a new folder, enter the path in the Folder column. You can optionally also enter an
alias for the folder in the Friendly Name field. Then click Add.
The Folder Accessible field indicates whether the folder is accessible by the monitoring
service. After you add a folder, the Folder Accessible status shows a question mark until you
refresh the PI Coresight administration page. If the path to the new folder is accessible and
no errors occur, it shows a green check mark.
A red X indicates that there is a problem with the file-monitoring process accessing the
specified folder. To determine the cause, investigate errors in the PISymbols Admin event
log. In general, file monitoring errors are due to an invalid path, or the
CoresightServiceAppPool application pool account might have insufficient privilege to
access the import folder hierarchy.
Note:
It can take a few minutes for the folder monitoring process to start importing files,
because the process searches for all files to import before starting the actual import
process.
The folder is accessed using the identity of the CoresightServiceAppPool application pool.
3. (Optional) Click Show Status to see information about any errors that occurred during
import.
4. (Optional) To modify a friendly name, enter your changes in the Friendly Name field and
click Apply.
5. (Optional) If you no longer want to import PI ProcessBook displays from a folder, click the
Remove button.
All files from that folder will be removed from the PI Coresight application server; the
actual PI ProcessBook files are not touched.
Note:
After you delete import folders, reindex the PI Coresight SQL Server database and
update its statistics. To learn more about reindexing Microsoft SQL Server, go to the
Microsoft TechNet (https://technet.microsoft.com/library) website and search for
How to: Rebuild an Index (SQL Server Management Studio). You can also find out
more about updating query statistics in Microsoft SQL Server by going to the
Microsoft Developer Network (https://msdn.microsoft.com) and searching for
Update Statistics (Transact-SQL).
Update the SQL Server instance and PI Coresight database

Note:
Administrator.

Before you start

The currently logged-in Windows user must have administrator access to the Microsoft SQL
Server in order to complete this procedure.
The method shown here is applicable in only the following situations:
The PI Coresight database is located on the PI Coresight application server.
If the currently logged-in Windows user is running the PI Coresight administration page in
their browser while logged onto the web server.
If your configuration does not meet these conditions, follow the instructions in Manually create
the PI Coresight database.
Procedure
1. On the Overview page, click Manage Configuration next to the PI Coresight Database table.
Or click Configuration in the navigation tree at left and then choose the PI Coresight
Database tab.
2. To change the Microsoft SQL Server instance that hosts the PI Coresight database, click the
dropdown button next to the SQL Server field and select the server you want, or type its
name directly in the box, for example, .\sqlexpress.
3. Enter the name of the PI Coresight database you want to use in the Database field, or click
the dropdown button to choose an existing database.
After you select a database, PI Coresight verifies whether it can be used as is, or if an
upgrade is necessary.
If you enter a new database name, and the user running the Administration website has
sufficient permissions to create a database on the Microsoft SQL Server, a new database of
that name is created.
To create a new Coresight database, you must have:
The db_creator server role
ALTER ANY LOGIN permission (meaning you have been granted this permission by use
of the statement GRANT ALTER ANY LOGIN TO "domain\account" or you are a
member of the securityadmin server role. )
PI Coresight connects to the specified database.
4. Click Save.
Update display ownership and reset user settings

Reset user settings

To reassign ownership of all the displays from one user to another, follow this procedure.

Procedure
1. Click Display Management in the navigation tree at left.
2. In the From field, select the user name for which you want to reassign display ownership.
3. In the To field, select the user name of the new owner.
4. Check the box I understand this operation cannot be undone.
5. Click Reassign Displays.
Note:
At the Homepage of the PI Coresight application, https://webServer/Coresight,
administrators can reassign any public display from one user to another. Click the Edit
display settings icon and select another username in the Display Owner field.
This field is populated with users who have accessed a display.
Reset user settings

PI Coresight users can save preferences for certain ways of viewing and handling information,
for example, the configuration for viewing tables. Other information is recorded automatically,
such as the last page viewed.
If necessary, the administrator can clear all settings for a user and set them back to default
values.
Procedure
1. Click User Settings in the navigation tree at left.
2. Choose the user in the drop-down box.
3. Click Clear Settings.
Generate reports
PI Coresight administrators can view or export reports about usage of PI Coresight, such as
reports that show detailed information about the contents of the displays in your database.
Procedure
1. Click Reports in the navigation tree at left.
2. If appropriate, select a time range for your report.
3. Click View or Export:
View shows the report in your browser.
Export saves the report information to a .csv file.
Backup strategy for the PI Coresight database

To develop your strategy, see the Microsoft documentation about SQL Server backups (http://
msdn.microsoft.com/en-us/library/ms187048.aspx).

Your strategy should be tailored to your environment, but ideally you need to backup your PI
Coresight SQL Server database every day. Standard maintenance best practices include:
Backups of logs
Daily data backups
Periodic re-index and update statistics on all databases, and always after importing
displays, deleting import folders, or deleting many displays
Use Microsoft SQL Server Management Studio or the sqlcmd command utility.
OSIsoft recommends that you change your database from the simple recovery model to the full
recovery model to allow point-in-time recovery. The installation kit configures the database
with a simple recovery model by default. With this simple recovery model, transaction logs
cannot be backed up and point-of-failure recovery is not possible. If you set the database to the
full recovery model, the transaction logs are also backed up. The transaction logs are truncated
so they do not grow without bounds and either point-in-time or point-of-failure recovery is
allowed.
Consider these further points as you design your backup strategy:
Place the backup file on a different physical disk from where the SQL Server data is located.
You might not be able to write to the root folder of the C:\ drive. Use another drive, such as
a network drive, or a subfolder.
Frequency of backup depends on your application; nightly backups are usually best. You
can set the timing and frequency of backups and whether full or differential backups are
done. Daily, full backup is recommended.
SQL Express 2008 does not include a job scheduler, so you need to use a Windows utility to
schedule the backup.
You can use the following command to run the backup:
sqlcmd -S SQLINSTANCE -d PI Coresight database -Q "EXEC dbo.usp_backup
@outpath = N'', @allwaysfullbackup = 1;" -E
You can put contents similar to the example below into a file called
BackupPICoresight.sql and schedule a task to run the command below. Note that you
will need to change DestFile to the directory that you have created to store backups and
change the database name from CoresightDB to the name of your Coresight database.
Command for Scheduled Task:
sqlcmd -S .\SQLEXPRESS -i "E:\Backups\BackupPICoresight.sql
Contents of BackupPICoresight.sql
declare @DestFile varchar(128) = E:\Backups\CoresightBackupDB.bak;
backup database CoresightDB
to disk = @DestFile;
go
You need the sysadmin, db_owner, or db_backupoperator role (the least privilege is the best
security practice).
Change the account of the PI Coresight database

If the PI Coresight Application Pool ID is changed after the PI Coresight database has been
created, then you need to modify the account used to access the PI Coresight database.

Run the following SQL commands:

ALTER USER "DVService" with
LOGIN="<domain>\<Application Pool ID>"
ALTER USER "<domain>\<Application Pool ID>" with
NAME="DVService"
Reassign a display from the Homepage

At the Homepage of the PI Coresight application (https://webServer/Coresight)
administrators can reassign any public display from one user to another. Click the Edit display
settings icon and select another username in the Display Owner field. This field is
populated with users who have accessed a display.

To reassign ownership of all the displays from one user to another, see Reassign display
ownership.
Time zone and regionalization settings


By default, PI Coresight uses the time zone of the client machine to display information.
To override the client time zone and set every user browsing to the PI Coresight website to use
the same time zone, follow this procedure.
Procedure
1. Use an editor to open the web.config file located in the PI Coresight root installation
folder.
2. Add the following line to the web.config file:
<appSettings>
<add key="PISymbols_SystemTimeZoneId" value="YourTimeZoneID"/>
where YourTimeZoneID is one of the time zone IDs listed in System time zone IDs. For
example, to set the PI Coresight time zone to Pacific Standard Time for all users, you would
add the following line to the web.config file:
<appSettings>
<add key="PISymbols_SystemTimeZoneId"
value="Pacific Standard Time"/>
System time zone IDs

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)
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
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
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

To support one regionalization format for all users browsing to a PI Coresight website, follow
this procedure.
Procedure
1. Use an editor to open the web.config file in the root PI Coresight installation folder.
2. Locate the line for the globalization element. The default value looks like this:
<globalization culture="auto" uiCulture="auto" />
3. Modify the culture value to the desired sitewide region option:
<globalization culture="siteWideRegion" uiCulture="auto" />
where siteWideRegion is the code for the appropriate region. For a list of codes, go to the
Microsoft Developer Network website: http://msdn.microsoft.com/.
For example, to set PI Coresight to use the French Canadian regionalization format for all
users, type:
<globalization culture="fr-CA" uiCulture="auto" />

Uninstall PI Coresight
To uninstall the PI Coresight application, launch the Programs and Features Control Panel
applet, select PI Coresight, and select Uninstall. If you wish to remove the PI Web API, it must
be uninstalled separately.


URL parameters for controlling the presentation of
displays
You can use a URL to open PI Coresight displays programmatically from other applications.
You can use the URL to:
Create a temporary display that shows a single trend populated with specified data items;
the URL can also specify a time range for the display.
Open an existing saved display and, optionally, specify a time range for the display.
Specify kiosk mode to open a display with limited interactivity.
Configure an existing display to use other assets that share the same AF template. To do
this, specify the assets to show in a display by appending ?Asset to the URL, followed by
the path of the new asset.
Specify the element for a PI ProcessBook element relative display that you've accessed from
within PI Coresight.
Set the time zone for a display so that users see data in the time zone you specify, rather
than in the time zone of their client machine.
Hide the toolbar or timebar, or both, in a display.
Prevent automatic redirection for users of PI Coresight on mobile devices. Users of a
smaller device or browser window are automatically redirected to the mobile version of PI
Coresight. However, you can bypass this behavior, such as in cases where you have
embedded a PI Coresight or PI ProcessBook display in your own dash board.
Note:
A URL must include URL-encoded characters where needed. For example, the plus sign
(+) indicates <Space> in HTML. To enter an actual plus sign as part of a URL, it must be
encoded as "%2B". For the URL syntax: &EndTime=+8h you need to use: &EndTime=
%2B8h. See the reference page http://www.w3schools.com/tags/ref_urlencode.asp for
more information about URL encoding.
Creating a new temporary display with particular data items

A URL can specify data items to show in a single trend on a temporary (ad hoc) display. The
data items can be any combination of PI tags, attributes, and (AF element) assets. If the URL
specifies an asset, all of its attributes appear in the trend.
Users can save a temporary display for later use by making a copy of the display.
The URL can include start and end time parameters for the display time range using any PI
time expression. If no start and end times are specified, the default time range of 8 hours ago
until now is applied, and the time range is continuously updating.

URL parameters for controlling the presentation of displays
Examples
The following URL creates a temporary display with one trend containing a single attribute
(Fuel) from the B-210 asset.
Attributes are delimited by the pipe (|) character. No start and end times are specified, so
the default time range applies to the display.
https://webserver/website/#/Displays/AdHoc?DataItems=\\EastCoast\HiEfficiency
\B-210|Fuel
The following URL creates a temporary display with a single asset (B-210) in a specified
time range.
This shows data for all attributes of B-210 in the trend on the temporary display during the
time range of midnight September 25, 2012, to midnight September 27, 2012.
https://webserver/website/#/Displays/AdHoc?DataItems=\\EastCoast\HiEfficiency
\B-210&StartTime=25-sep-12&EndTime=27-sep-12
Multiple data items, delimited by semicolons.
Notice that attributes from the same asset (Temperature and Fuel) must be specified
completely. No start and end times are specified, so the default time range applies to the
display.
https://webserver/website/#/Displays/AdHoc?DataItems=\\afserver
\B-210|Temperature;\\piserver\aPIPoint
Opening an existing saved display

You can give a URL to other users to open an existing saved display. Make sure the users have
access to the saved display by marking the display as public.
You can append start and end time parameters for the display time range using any PI time
expression. If no start and end times are specified, the time range of the saved display applies.
For PI Coresight displays, you specify the display ID in the URL, appended to the URL
parameter, #/Displays, as shown in the following examples. (The display ID is shown in the
URL when you open the display).
For PI ProcessBook displays, you can either specify the display ID or the name and path of the
imported PI ProcessBook file in the URL:
To open a PI ProcessBook display by name and path, specify the URL parameter, #/
PBDisplayName, and append to it the path and name of the PI ProcessBook display file.
To open a PI ProcessBook display by ID, specify the URL parameter, #/PBDisplays, and
append to it the ID of the PI ProcessBook display.
Examples are shown, below.
PI Coresight examples
The following URL opens the saved PI Coresight display 3117 (named PowerAnalysis). No
time range is specified so the display opens with the time range from the saved display.
https://webserver/website/#/Displays/3117/PowerAnalysis
This URL opens the saved PI Coresight display 3117 (named PowerAnalysis) with the
specified time range of midnight September 25, 2012, to midnight September 27, 2012.

https://webserver/website/#/Displays/3117/PowerAnalysis?mode=kiosk
&StartTime=25-sep-12&EndTime=27-sep-12
PI ProcessBook examples
In these examples, the import folder is assumed to be \\fileServer\Imports and the PI
Coresight server is assumed to be https://webServer/Coresight.
If the path to the PI ProcessBook display file is \\fileServer\Imports\Kamyr.pdi you
can open it using the following URL:
https://webServer/Coresight/#/PBDisplayName/Kamyr
If the path to the PI ProcessBook display file is \\fileServer\Imports\Dealer
\Customer2\ChemicalPlant\DistillationProcess.svg you can open it using the
following URL:
https://webServer/Coresight/#/PBDisplayName/Dealer
/Customer2/ChemicalPlant/DistillationProcess
Note:
Do not include \\fileServer\Imports in the URL for the PI ProcessBook display.
You can also open a PI ProcessBook display by specifying the display ID.
For example, the following URL opens the imported PI ProcessBook display called
PressureVariation, which has an ID of 3649, with the specified time range of midnight
February 1, 2015 to midnight February 28, 2015:
https://webServer/Coresight/#/PBDisplays/3649/PressureVariation
?&StartTime=01-feb-15&EndTime=28-feb-15
Applying kiosk mode to a display

A URL can specify a display with limited interactivity using kiosk mode. You can apply kiosk
mode to either a temporary display or a saved display.
When a display is in kiosk mode:
The display is read-only.

Only the workspace of the display is visible. Left-side panelsfor example, Search and Cart
are omitted. To further limit interaction, the Help and Homepage links are not available.
This parameter will not remove the Back button from a display viewed in the mobile site.
Users can interact with the timebar and symbols but are unable to save any changes.
Refreshing the browser displays the original view of the display.
To place a display into kiosk mode, append this parameter to the URL:
?mode=kiosk
Examples
The following URL creates a temporary display in kiosk mode.
The display will show one trend containing a single attribute (Fuel) from the B-210 asset
during the time range of midnight September 25, 2012, to midnight September 27, 2012.
https://webserver/website/#/Displays/AdHoc?DataItems=\\EastCoast\HiEfficiency\
B-210|Fuel&StartTime=25-sep-12&EndTime=27-sep-12&mode=kiosk
This URL opens the saved display 3117 (named PowerAnalysis) in kiosk mode.

No time range is specified so the display will open with the time range from the saved
display.
https://webserver/website/#/Displays/3117/PowerAnalysis?mode=kiosk
Reuse displays for assets built from the same AF template

You can configure an existing display to use other assets that share the same AF template. To
do this, specify the assets to show in a display by appending ?Asset to the URL, followed by
the path of the new asset.
Procedure
1. Obtain the paths of the assets you want to use to replace the existing assets on the display.
You can find these paths in PI Coresight search results, or in PI System Explorer.
2. Specify the related assets by updating the existing display URL. Append the string ?Asset
followed by the path of the new asset. Separate multiple asset paths with a semicolon (;).
Example
In the following example, a PI Coresight display named "BoilerFanInformation" contains two
table symbolsone shows information about a boiler, and the other shows information about
a fan.
The boiler asset on the display was built from an AF element template of type Boiler, and the
fan asset was built from an AF element template of type Fan.
An engineer wants to use this display to show information about a different boiler and fan,
which were built from the same templates. The original "BoilerFanInformation" display has
the URL: https://CoresightServ/Displays/15914/BoilerFanInformation
To see information about a different boiler and fan on this display, perform these steps:
1. In PI System Explorer, identify the paths to the AF assets of interest.
2. Append the following string to the "BoilerFanInformation" display URL:
?Asset=\\AFServer1\DB1\CrackingProcess\Equipment\Boiler309;\\AFServer1\DB1\
Cracking Process\Equipment\Fan486
This creates the URL:

https://CoresightServ/Displays/15914/BoilerFanInformation?Asset=\
\AFServer1\DB1\
CrackingProcess\Equipment\Boiler309;\\AFServer1\DB1\
Cracking Process\Equipment\Fan486
The tables on the display now show Boiler asset information for Boiler309 and Fan asset
information for Fan486.
Note:
You do not have to specify an asset for each template. For example, you could specify
only a fan in the URL and not specify a boiler. In that case, the default boiler associated
with the display will be used.

Specify the element for PI ProcessBook element relative

displays
For an element-relative display (ERD), when you view it in PI ProcessBook, you change the
element you are viewing by selecting another element in the Elements of Interest pane. When
you view a PI ProcessBook ERD from within in PI Coresight, you use a different method to
switch elements.
Procedure
Append ?CurrentElement to the URL, followed by the path to the element for which to
show data.
Relative path syntax of PI AF elements is supported.
For example, each of the following URLs shows data from a different element on the ERD
identified as 15914:
https://CoresightServ/Coresight/#/PBDisplays/15914?CurrentElement=
\\AFServer1\DB1\CrackingProcess\Boiler202
https://CoresightServ/Coresight/#/PBDisplays/15914?CurrentElement=
\\AFServer1\DB1\CrackingProcess\Boiler209
Set the time zone for a display

You can use a URL parameter to set the time zone for a display so that users see data in the
time zone you specify, rather than in the time zone of their client machine.
You do this by specifying a time offset from UTC time (Coordinated Universal Time) in the URL
of a display. This offset is only used for:
The specified display
Trend previews of dynamic symbols on that display
Temporary (ad hoc) PI Coresight displays accessed from a PI ProcessBook display
The timebar shows the UTC string. Daylight saving time does not affect displays that use this
parameter.
As an example, assume you want to specify the time zone in which your users view data for the
following display:
https://CoresightServ/Coresight/#/Displays/3117/PowerAnalysis
Procedure
Append the TZ parameter to the URL. For example:
https://CoresightServ/Coresight/#/Displays/3117/PowerAnalysis?tz=UTC-5:00
The TZ parameter name and the UTC keyword are not case sensitive. The offset can be
positive or negative. To apply a positive offset, you must encode the + (plus) sign as %2B.
Syntax and examples

There cannot be any spaces within the time zone offset specification, for example:
TZ=UTC-3:00.

You can enter the time offset in either of the following formats:
H:MM or HH:MM
For example: TZ=UTC-5:05
If you specify minutes, you must use two digits and precede them with a : (colon). Values
for minutes can range from 00 to 59. For example:
tz=utc%2B8:05
+n or -n hours. Values for hours (n) can range from 1 to 13.
For example: tz=Utc-1
Note:
In Mozilla Firefox browsers, the UTC+H format can fail, because the + (plus) sign is not
properly transmitted (whether or not it is encoded as %2B).
Any invalid specifications cause the display to revert to the client time zone.
Hide the toolbar or timebar

You can use the URL parameters HideToolbar and HideTimebar to hide the toolbar or the
timebar in a display.
The setting applies to:
The specified display
Temporary (ad hoc) PI Coresight displays accessed from a PI ProcessBook display
After being hidden, to revert to showing the toolbar and timebar, you need to remove the
HideToolbar and HideTimebar parameters and reload the display.
As an example, assume you want to hide the toolbar or timebar in the following display:
https://CoresightServ/Coresight/#/Displays/3117/PowerAnalysis
Procedure
To hide the toolbar, append the parameter ?HideToolbar to the URL. For example:
https://CoresightServ/Coresight/#/Displays/3117/PowerAnalysis?HideToolbar
The parameter name is not case sensitive. There cannot be any spaces within the parameter
specification.
To hide the timebar, append the parameter ?HideTimebar to the URL. For example:
https://CoresightServ/Coresight/#/Displays/3117/PowerAnalysis?HideTimebar
To hide both the toolbar and the timebar, append the parameters ?
HideToolbar&HideTimebar to the URL. For example:
https://CoresightServ/Coresight/#/Displays/3117/
PowerAnalysis?hideToolbar&HideTimebar
Prevent automatic redirection to PI Coresight mobile website

Based on the size of the device or browser window, a user of a smaller device or browser is by
default redirected to the PI Coresight mobile website.

You might find it necessary to bypass this behavior, such as when you embed a PI Coresight or
PI ProcessBook display in your own dashboard.
Procedure
To override the default behavior, add redirect=false to the PI Coresight URL.
This parameter causes the user to view the full PI Coresight web application, regardless of
window size. Note that if Silverlight is not supported by a device, the display will be
redirected even with this parameter set.
Examples
The following URL opens the saved display 3117 (named PowerAnalysis) in the full PI
Coresight web application, even when accessed from small devices or browser windows.
http://webserver/website/#/Displays/3117/PowerAnalysis?redirect=false


High availability options for PI Coresight
The high availability (HA) solutions described here are independent of PI Coresight. These
strategies are recommendations, but all systems have unique requirements, therefore you
should discuss these strategies with your database administrator and Internet Information
Services (IIS) administrator while planning your architecture.
HA options are available for PI Coresight at both the database and application server levels.
Each of these options has its own benefits.
Database options include:
Clustering
Mirroring
AlwaysOn Availability Groups
Transactional replication
PI Coresight application server options include:
Network load balancing (NLB)
Application request routing (ARR)
NLB and ARR in an active/passive failover configuration
NLB and ARR in an active/active failover configuration
Database level options

Employing HA at the database level prevents the PI Coresight database in Microsoft SQL Server
from becoming a single point of failure.
You should implement HA for the PI Coresight database in the same way as applying HA to any
other SQL Server database. Microsoft provides a general description of their HA
implementation options for MS SQL Server in the article Overview of SQL Server High
Availability Solutions (HTTP://MSDN.MICROSOFT.COM/EN-US/LIBRARY/MS190202.ASPX).
After connection, a replicated database acts in the same way as the database it replaces,
therefore the only configuration change required is to make the PI Coresight application aware
of the replicated database. You do this when you specify the connection string for the
application. For example:
connectionString = "Data Source=myPrimaryServer;Failover
Partner=mySecondaryServer;
Initial Catalog=myDataBase;Integrated Security=True;
Application Name=&quotCoresight Web Service&quot"
The connection string can be edited in the web.config for the PI Coresight web application
directly, or through the Connection Strings module in IIS Manager when you have the PI
Coresight web application selected. The web.config file is located in one of the following
directories:
%pihome64%\Coresight\Services for versions 1.x
%pihome64%\Coresight for versions 2.x
The following table summarizes the benefits and disadvantages of each SQL Server HA option.

SQL Server HA option Advantages Disadvantages

Clustering Allows full-time read-write Requires a significant initial
access to the PI Coresight investment in cluster
database. hardware.
No re-synchronization Can be slow to failover
required. Cluster members between cluster members
always use the latest shared (compared to mirroring).
copy of the database. Only one copy of the
database.
Distance between nodes is
limited to a few meters,
because they share a physical
drive.
Mirroring Allows full-time read-write Requires a third "witness
access to the PI Coresight server" for hot failover.
database. If run in asynchronous mode,
Fast failover time (compared the mirror database may not
to SQL clustering). always be up-to-date.
Two copies of the database
on independent hardware.
The members can be
physically separated by a long
distance.
AlwaysOn Availability Groups Allows full-time read-write SQL Enterprise is required to
access to the PI Coresight utilize Availability Groups.
database.
Fast failover time (compared
to SQL clustering).
Two copies of the database
on independent hardware.
No witness server required.
Transactional replication Two copies of the data on Failover is not supported.
independent hardware. Load balancing is not
supported.
No protection from replicated
data being changed.
PI Coresight application server HA options

HA at the application server level can provide load balancing and fault tolerance.
The following table outlines some of the pros and cons for different network load balancing
(NLB) and application request routing (ARR) implementations. For a more detailed discussion
of the configuration, benefits, and drawbacks for these scenarios, see the IIS article Achieving
High Availability and Scalability - ARR and NLB (HTTP://WWW.IIS.NET/LEARN/
EXTENSIONS/CONFIGURING-APPLICATION-REQUEST-ROUTING-(ARR)/ACHIEVING-HIGH-
AVAILABILITY-AND-SCALABILITY-ARR-AND-NLB).
The following table summarizes the benefits and disadvantages of each PI Coresight
application server HA option.

PI Coresight Application Server Advantages Disadvantages

HA options
Application request routing Divides the data access load Does not provide true HA,
(ARR) on the application server. because the ARR node
Other features are available remains a single point of
that allow ARR to act as a failure.
reverse proxy, if desired. Limited scalability, because
the traffic is channeled
Network load balancing (NLB) Divides the data access load through a single node.
on the application server.
NLB and ARR (active/passive) Provides true HA since there Larger investment required,
is no single point of failure. in terms of setup and number
Other features are available of available machines
that allow ARR to act as a required.
reverse proxy if desired.
NLB and ARR (active/active) Provides true HA since there
is no single point of failure.
Provides true scalability since
traffic is not channeled
through a single node.
Other features are available
that allow ARR to act as a
reverse proxy, if desired.
For further information about high availability and the PI System, see the High Availability
section under PI Data Archive server on PI Live Library (http://livelibrary.osisoft.com/
LiveLibrary/web/pub.xql?action=publist_home).


Appendix A View and configure PI Coresight message
logs
This appendix explains how to view PI Coresight messages and how to configure message
logging. By default PI Coresight messages appear in the Windows Event Viewer tool on the PI
View the message logs

Procedure
1. Open the Windows Event Viewer tool on the PI Coresight application server computer. By
default, the tool is accessible directly from the Windows Start menu.
2. Click the + button to expand Applications and Services Logs. PI Coresight application
messages appear under the following categories:
OSIsoft-PIDataServices
Contains messages related to data access from PI Data Archive servers and PI AF servers.
Admin
Operational
OSIsoft-PISymbols
Includes search and data retrieval messages (including all messages from the
administration website and file monitoring services).
Admin
Operational
OSIsoft-PISystemSearch
Includes messages related to the PI Web API Crawler and PI Web API search queries.
Admin
Operational
OSIsoft-Search
Includes messages related to searches executed by PI Coresight.
Admin
3. You can optionally create a custom view to see all of these events in one place:
a. Right-click the Custom Views row in the left pane of the Windows Event Viewer and
select Create Custom View.
b. Give the view a name, for example, PI Coresight Events.
c. Select the XML tab.
d. Check Edit query manually and add the following text:

Appendix A View and configure PI Coresight message logs
<QueryList>
<Query Id="0" Path="OSIsoft-PIDataServices/Admin">
<Select Path="OSIsoft-PIDataServices/Admin">*</Select>
<Select Path="OSIsoft-PIDataServices/Operational">*</Select>
<Select Path="OSIsoft-PISymbols/Admin">*</Select>
<Select Path="OSIsoft-PISymbols/Operational">*</Select>
<Select Path="OSIsoft-PISystemSearch/Admin">*</Select>
<Select Path="OSIsoft-PISystemSearch/Operational">*</Select>
<Select Path="OSIsoft-Search/Admin">*</Select>
<Select Path="PIWebAPI/Admin">*</Select>
</Query>
</QueryList>
Collect analytic and debug events using Windows Performance

Monitor
For debugging purposes, you can enable trace logs to collect diagnostic data to provide to
OSIsoft Technical Support. Templates for this type of data collection are available through
Technical Support. You can configure event trace logs to be collected for a dynamic time
period, by using Event Trace Sessions.
For more information about data collectors, see this Microsoft article about performance and
reliability monitoring: http://technet.microsoft.com/en-us/library/cc771692.aspx
Suppress duplicate messages (message throttling)

You can prevent 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="" />
The value is a time in minutes. So the following line would set message throttling to ten
minutes:
<add key="ErrorSuppressionTime" value="10" />
If the value is zero, then message throttling is disabled. OSIsoft recommends that you do not
disable message throttling.

Technical support and other resources
For technical assistance, contact OSIsoft Technical Support at +1 510-297-5828 or through the
OSIsoft Tech Support Contact Us page (https://techsupport.osisoft.com/Contact-Us/). The
website offers additional contact options for customers outside of the United States.
When you contact OSIsoft Technical Support, be prepared to provide this information:
Product name, version, and build numbers
Details about your computer platform (CPU type, operating system, and version number)
Time that the difficulty started
Log files at that time
Details of any environment changes prior to the start of the issue
Summary of the issue, including any relevant log files during the time the issue occurred
To ask questions of others who use OSIsoft software, join the OSIsoft user community,
PI Square (https://pisquare.osisoft.com). Members of the community can request advice and
share ideas about the PI System. The PI Developers Club space within PI Square offers
resources to help you with the programming and integration of OSIsoft products.

Technical support and other resources

PI Coresight 2015 Installation and Administration Guide

Hochgeladen von

Dokumentinformationen

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

PI Coresight 2015 Installation and Administration Guide

Hochgeladen von

Copyright:

Verfügbare Formate

PI Coresight 2015

Installation and Administration Guide

PI Coresight 2015 Installation and Administration Guide

PI Coresight architecture and system requirements...................................................... 1

Preparation for a new PI Coresight installation........................................................... 13

Configure PI Coresight after installation.....................................................................27

Configure PI Coresight access to PI Data Archive server data....................................... 37

PI Coresight 2015 Installation and Administration Guide iii

Configure PI Coresight access to PI AF databases........................................................47

PI Coresight administration tasks.............................................................................. 49

URL parameters for controlling the presentation of displays....................................... 65

High availability options for PI Coresight....................................................................73

Appendix A View and configure PI Coresight message logs..........................................77

Technical support and other resources....................................................................... 79

iv PI Coresight 2015 Installation and Administration Guide

PI Coresight 2015 Installation and Administration Guide 1

About the PI Coresight web server

PI Coresight application pools and service accounts

2 PI Coresight 2015 Installation and Administration Guide

PI Coresight access groups

PI Coresight 2015 Installation and Administration Guide 3

Software and hardware requirements

Hardware requirements for PI Coresight application server

Index files requirements

Summary of hardware requirements

Where the parameters are:

4 PI Coresight 2015 Installation and Administration Guide

PI Coresight application server software requirements

Microsoft Windows Server 2008 R2 SP1 64-bit, or later

Microsoft SQL Server requirements

PI System requirements for PI Coresight

PI Data Archive version 3.4.380, and later.

PI Coresight 2015 Installation and Administration Guide 5

PI ProcessBook display version

Supported browsers for PI Coresight

Ensure Silverlight is at the required version

6 PI Coresight 2015 Installation and Administration Guide

Mobile devices as clients

PI Coresight 2015 Installation and Administration Guide 7

8 PI Coresight 2015 Installation and Administration Guide

Upgrade a PI Coresight installation

Before you start

PI Coresight 2015 Installation and Administration Guide 9

Upgrading the PI Coresight database

10 PI Coresight 2015 Installation and Administration Guide

Automatic PI Coresight upgrade backups

PI Coresight 2015 Installation and Administration Guide 11

12 PI Coresight 2015 Installation and Administration Guide

Topics in this section

Create a domain user account for PI Coresight

Required PI Coresight service account access permissions

PI Coresight 2015 Installation and Administration Guide 13

Prepare the PI Coresight application server computer

14 PI Coresight 2015 Installation and Administration Guide

c. Change the port number to a unique number and click OK.

Server Manager roles and features

PI Coresight 2015 Installation and Administration Guide 15

Role services for web server

Application Required: Required:

Health and Required: Required:

Security Required: Required:

Performance Required: Required:

16 PI Coresight 2015 Installation and Administration Guide

Role services for application server