Learn how to install PI Connector Relay

If any prerequisite software included in the PI Connector Relay setup kit is not already installed, the setup program prompts you to configure the additional software included in the setup kit before installing and configuring PI Connector Relay.

1. Complete pre-installation tasks for PI Connector Relay. See Learn about pre-installation tasks.

   Note: Relay version 1.x cannot be upgraded to version 2.x. For more information, see System requirements.

   You must be logged into a Windows account with administrator privileges.

2. Double-click to run the PI Connector Relay_<VersionNumber>_.exe file.

3. Set the extraction path for the installation files and select OK. The setup program opens.

4. Install and configure all required software using the setup program.

   The setup program installs the prerequisite software and opens the relay installation wizard to guide you through relay configuration choices.

5. Configure the following items:

   • A port number for hosting the administration web service and OMF application data ingress. For more information, see Identify port numbers.

     Note: Record the port number you use. You will need to enter this port number later when you add the relay in PI Data Collection Manager.

   • Windows service account information. For more information, see Learn how to create Windows accounts for PI Data Collection Manager and PI Connector Relay.

     Note: The user must have read and write access in all Data Archive and PI AF hosts to which PI Connector Relay will send data.

   • Optional: Alternate file path for buffer and other local files

6. Select Install.

7. Add all local or domain users that require relay administrative privileges to the PI Connector Administrators group, and then select Next.

   When you add a relay in PI Connector Relay, you are prompted to enter a user name and password. This user account must be in the PI Connector Administrators group.

   The Windows service account for the relay is automatically added to the local PI Connector Administrators group.

   Note: Accounts in the local PI Connector Administrators group also have administrative privileges to any other connector applications installed on the same host.

8. By default, a passwordless virtual service account will be configured to run PI Connector Relay. Alternatively, a local or domain account with minimal privileges can be entered—in the format domain\user_name—and password.

   This user must have read access to any Data Archive and PI AF servers that will be configured in PI Connector Relay.

   This account is implicitly added to the local PI Connector Administrators group.

9. Select Validate. For the default virtual service account, do not alter the account name or enter a password. If the account and password are correct for user-entered account, the message Valid name and password combination is displayed.

10. Select Next. The Ready to install PI Connector Relay window displays.

11. Select Install. The Installing PI Connector Relay window displays.

12. Select Next. The Configuration Security window displays.

13. Optionally, select Add User to provide the current user with access to PI Connector Relay.

14. Optionally, select Add More Users to provide additional users with access to PI Connector Relay and any other connector programs installed on the same host.

15. Select Next.

16. Select Finish.

    Note: The system may prompt you to reboot in order to update shared system files used by the PI Connector Relay. The system requires a reboot because these files may be in use by other applications or services. This reboot ensures that all necessary files are properly updated.