Install PI Notifications Service

Before you begin, make sure these prerequisites are met:

• Confirm that the computer where PI Notifications Service will be installed meets all the system requirements. See System requirements for PI Notifications Service 2024 R2.

• You have the fully qualified domain name for the computer where AVEVA PI Vision is installed, if you plan to integrate notifications with PI Vision. If you plan to use AVEVA PI Vision for acknowledgment, you also must configure basic authentication or Kerberos-based authentication for that computer.

• Install the Install Microsoft Edge WebView2 Runtime for screenshots if you plan to use the screenshot feature in PI Notifications.

• PI AF server is installed. A connection is required to PI AF server to complete the installation. We recommend adding additional individual features after PI AF server has been fully setup.

• If you plan to use OpenID Connect (OIDC) for claims-based authentication, PI Notifications Service needs to use a configured TLS certificate for authentication. If the PI Notifications Service is installed on the same node as the AF server, both can be configured to use the same certificate. If you install both the AF server and the PI Notifications Service at the same time and provide a certificate to the PI Server 2024 Installer, both can use the same certificate.

This section provides details on installing PI Notifications Service through the install kit.

1. Go to the directory where you downloaded the PI Server install kit, and double-click the setup file to launch the installation.

   The Welcome page opens.

2. Click Next.

   The Feature Selection page opens.

3. In the Server Roles tab, select PI Notifications Service.

   A list of components to be installed is displayed in the Summary panel.

   

4. Click Next.

   The AF Server page opens.

5. Enter the PI AF server name to associate with PI Notifications Service.

6. Click Next to proceed with the setup.

   The Certificates Selection page opens.

7. Take one of the following actions:

   • To enable TLS certificates encryption for OpenID Connect (OIDC), ensure that the Configure certificate for TLS Encryption option is selected.

     If you do not provide a certificate, a certificate will be automatically generated for you when this option is selected.

   Note: If you installed and configured the AVEVA Identity Manager using the PCS 8.0.2 for the PI System setup kit and opted to use the PCS-generated certificate, the PCS certificate’s SSL Certificate thumbprint will be selected automatically after selecting Configure certificate for TLS Encryption. This certificate applies to any PI Server services selected for installation. This selection configures automatic certificate rotation for PI Server services.

   • If you do not plan to use TLS, deselect the Configure certificate for TLS Encryption option and proceed to step 10.

   

8. Click Select to choose a new certificate.

   The Select Certificate dialog opens. Any certificate that is already installed and meets certificate requirements will be detected and displayed in this dialog.

9. Select OK.

   The SSL Certificate thumbprint is displayed in the TLS Certificate section. The TLS certificate thumbprint is required for encryption.

10. Select Next to advance to the Notifications page.

11. On the Notifications page, enter the following information:

    1. SMTP Server: Port number (The default port number for the SMTP server is 25.)

    2. Optional. Backup SMTP Server: Port number

    From Email Address: The email address (name@domain.com) to be used with PI Notifications Service.

12. Select the Use TLS checkboxes to enable TLS encryption for the SMTP server or backup SMTP server connection. Specify the PI Vision Server URL address to integrate PI Notifications Service with AVEVA PI Vision.

13. Select Next.

    The Service Accounts window appears.

14. Specify the service account for PI Notifications Service.

    Select the default account NT SERVICE\PINotificationsService or specify a different service account. If the AF Server is remote to PI Notifications Service, then you must use a domain account or a Managed Service Account because the service account credentials will be mapped to the Notifications identity on the AF Server. If your computer is in a Workgroup, the installation must be run silently and additional steps might be necessary to guarantee that PI Notifications Service has access to AF Server. Since PI Notifications Service also needs read access to PI Points, a domain account or Managed Service Account may also be desired for configuring Windows integrated security in PI Data Archive.

15. Click Next to proceed with the setup.

    The Summary window appears, listing the selected features and version numbers scheduled for the installation.

16. Click Install.

    The Installation Progress page opens, then the Complete page opens when the installation is complete.

    Note: If you cancel the installation before it is complete, the PI AF SQL database might have already been created and you will need to remove the database manually.

17. Take one of the following actions:

    • If you did not select to enable TLS certificates, click Close to exit the setup.

    • If you enabled TLS certificates encryption, ensure the OpenID Connect Authentication requires configuration option is selected and then select Yes to restart now or No to restart later.

    • To bypass running the OpenID Connect Configurator utility, deselect the OpenID Connect Authentication requires configuration option, then select Yes or No.

      See Register PI Server components with the AVEVA Identity Manager if you selected the "Configure certificate for TLS Encryption" option and want to use OIDC for claims-based authentication.

18. Optional. Run the migration tool.

    Run the PI Notification Migration tool if you have existing legacy notifications that you want to migrate to notification rules. The migration tool can be launched from PI System Explorer only if PI Notifications Service is installed on the machine; the PINotificationsMigrationTool.exe command is located in the %PIHOME64%\Notifications directory.