Phase 1: Prepare to install PI Integrator for Business Analytics

The following components are required for a successful installation of PI Integrator for Business Analytics: PI Server (which includes the PI Asset Framework server and PI Data Archive), and Microsoft SQL Server (which will include the databases that store metadata for continuous views, and the PI Integrator for Business Analytics logs and statistics databases).

1. Ensure that the minimum requirements are met and the required software is installed. See System requirements.

2. Consider where you will install the components in your PI Integrator for Business Analytics installation.

3. The PI Integrator product can be installed using either Windows Virtual accounts or Windows domain user accounts. The passwords for the Virtual accounts and Managed Service accounts are managed by the Windows operating system. The default installation option is using Virtual accounts which do not require specification of username or password. If using Windows domain user accounts, obtain a Windows service account username. If you are not using a Managed Service account (MSA) or a group Managed Service Account (gMSA), you will need a password for your domain. You may need to contact your IT administrator to create one for you.

   Note: For the highest security deployment, we recommend using a Managed Service Account (MSA), a group Managed Service Account (gMSA),or Virtual accounts, but a standard domain user account dedicated to running the service is also supported.

4. The user account used to install PI Integrator for Business Analytics must be a domain user with local administrator privileges, located on the Microsoft Windows Server where you will be installing PI Integrator for Business Analytics.

5. Ensure that the user account used to install the software has sysadmin privileges on the SQL Server where you will be installing the PI Integrator databases. This is required to create the PI Integrator's backend SQL databases.

   Note: If the user account cannot be granted the required privileges, then the SQL databases must be manually created by a user, typically a database administrator, who does have sysadmin privileges. In this situation, the SQL databases must be created first before PI Integrator for Business Analytics is installed.

   Note: Go to the OSIsoft Customer Portal to download the PI Integrator for Business Analytics SQL Utility which contains the script that creates the databases. After you install the SQL databases, add the user account that will install PI Integrator for Business Analytics as a login on SQL Server.

   The user installing the PI Integrator for Business Analytics must have the following permissions:

   db_accessadmin database role membership on the PIIntegratorDB, PIIntegratorStats, and PIIntegratorLogs databases

   db_datareader database role membership on the PIIntegratorStats database

6. The user account used to install PI Integrator for Business Analytics must be mapped to the Administrators identity in PI AF.

7. Verify that the following ports are available. The below table describes how these ports are used in the PI Integrator for Business Analytics architecture.

   Functionality	Remote Application	Protocol	Port	Direction	Configured On
   PI Integrator for Business Analytics connection to PI AF	PI AF	TCP	5457	Inbound	PI AF Server
   PI Integrator for Business Analytics connection to Data Archive	Data Archive	TCP	5450	Inbound	Data Archive Server
   PI Integrator for Business Analytics connection to SQL database	PI Integrator for Business Analytics	TCP	1433 1	Inbound	SQL Server
   Client connections to PI Integrator for Business Analytics user interface	Client web browser	TCP	443 2	Inbound	PI Integrator for Business Analytics server
   PI Integrator for Business Analytics outgoing data (required only for Microsoft Azure IoT Hub or Microsoft Azure Event Hub)	Microsoft Azure IoT Hub or Microsoft Azure Event Hub	TCP	5671 3	Outbound	PI Integrator for Business Analytics server

   1 This connection can be configured to use a dynamic port.

   2 The default port for HTTPS is 443, but an alternate port can be specified during the PI Integrator for Business Analytics installation. Port 80 cannot be used due to internet convention.

   3 Microsoft may change these ports over time. Refer to the Microsoft documentation for the most current information.

8. (Optional) Contact your IT administrator to request a certificate from a Certificate Authority issued to the server that runs PI Integrator for Business Analytics. The certificate Subject should include the fully qualified domain name (FQDN) of the server, and the Subject Alternative Name should include both the FQDN and the host name of this server.

   The certificate also needs to meet the following criteria:

   • The certificate must be installed in the personal store of the local machine. For reference, the PI Web API certificate has the same requirements, and they are listed in the common installation problems section in that product's user guide.

   • The certificate must not be expired.

   • The certificate must have a private key.

   • The certificate must be a SHA-2 certificate.

   • The certificate must have a verifiably valid chain of trust.

9. (Optional) Contact your IT administrator if you are installing PI Integrator for Business Analytics in an environment where there are multiple domain controllers or a read-only domain controller. There may be additional port requirements for these environments. For more information, refer to the Microsoft documentation on Active Directory and Active Directory Domain Services Port Requirements.

10. If the account that will be running the PI Integrator Framework service is a group Managed Service Account (gMSA), then the Active Directory module for Windows PowerShell must be installed on the computer where PI Integrator for Business Analytics is installed; see Install the Active Directory PowerShell module.

11. If there are one or more PI Integrator 1.x instances installed against the PI AF server that you are installing this instance against, you must first upgrade all 1.x instances to 2.x. This will ensure that your PI Integrator 1.x views continue to publish after the install of the 2.x instance.

12. If you prefer to set up prerequisites and permission configurations on your publish targets prior to installing PI Integrator for Business Analytics, see the Set up your publish targets section for more information.