Configure installation settings
- Last UpdatedMar 20, 2025
- 4 minute read
- PI System
- PI Web API 2023 SP1 Patch 1
- Developer
-
In the PI System Customer Experience Improvement Program pane, indicate whether you want to participate in the program by selecting Yes, I would like to participate.
Click Next to continue.
-
In the Select Operating Configuration Store pane, select the PI AF server where you want to store configuration data. The default value is the previously configured PI AF server or, if not yet configured, the default PI AF server configured for the system.
To select a configuration space on a different server:
-
Click the ellipsis
.
-
In the PI AF Servers window, select a server from the list and click OK.
-
If you are not currently connected to the server, click Connect.
The default configuration instance has the same name as the host name of the server where you installed PI Web API. You can change the instance name as needed.
Click Next to continue.
-
-
In the Authentication Options pane, select the authentication methods you would like to use. You can choose between the following authentication methods:
-
OpenID Connect / Bearer
-
Kerberos
-
Basic
-
None / Anonymous
Be advised that certain authentication methods cannot be combined together
-
Bearer and Kerberos are mutually exclusive; only one method can be selected at a time.
-
Anonymous access disables all authentication and cannot be used with any other methods.
If you select Open ID Connect / Bearer as your authentication option, the system asks for the AVEVA Identity Manager URL.
If PI Web API has not yet been registered with AIM, the system prompts you for the AIM URL. If it has been registered, the registration information displays with the option to deregister (if necessary).
-
-
In the Select Communication Port pane, enter a communication port number for PI Web API. If you do not want to use the default value (443), you can enter a port number between 1 and 65535.
-
To create a Windows Firewall exception to enable remote clients to access the PI Web API service, keep Yes, please create a Firewall Exception for PI Web API selected.
To prevent remote client access or set up firewall exceptions manually, clear the check box.
Click Next to continue.
-
In the Select an SSL Certificate for Encrypting Traffic pane, select or change an SSL certificate for the communications port you just selected.
Click OK to continue to the Welcome to the PI Web API Setup Wizard window.
To ...
Do this ...
Set an SSL certificate
Click Select
In the Windows Security window, select the certificate. To view certificate properties, click the link and then click OK.
Click Next to continue.
Set a self-signed certificate created by PI Web API
Click Next.
A self-signed certificate is not issued if the port has been bound to another certificate or a certificate has been selected.
View or change a previously set certificate
Click the certificate thumbprint to view detailed information about the certificate.
To change a certificate, click Change.
Click Yes in response to the warning that changing the binding certificate can disrupt an existing application.
In the Windows Security window, select the certificate. To view certificate properties, click the link.
Click OK.
Click Next to continue.
-
In the Configure PI Web API Windows Service pane, choose the account under which the installed API Windows Service operates.
To use a ...
Do this ...
Default NT Service account
Leave the Account Type field value at Default.
Leave the Account name field value at NT Service\piwebapi.
Click Next to continue.
Custom account
In the Account Type field, select Custom.
In the Account name field, enter an account name in Domain\User format.
In the Account password field, enter a valid password for the account name.
Click Test.
If the test is successful, Next is enabled.
If the test failed, click OK and enter the correct password.
Click Next to continue.
-
In the OMF Servers pane, select where you want to store OMF data. The default value is the currently connected PI AF server.
Select Confirm to save changes.
Click Next to continue.
-
In the Ready to Apply Changes pane, review the settings you have just configured.
-
If you are satisfied that the settings are correct, select Accept all the configurations and click "Next" to apply and click Next.
-
If you need to modify a setting, click Back until the setting you want to change is displayed.
In the Applying Changes pane as the configuration is in progress, you can click Cancel if necessary. When all jobs are completed, the Confirmation pane is displayed.
-
-
Click Finish.