Configuration with PI Web API Admin Utility
- Last UpdatedMar 20, 2025
- 2 minute read
- PI System
- PI Web API 2023 SP1 Patch 1
- Developer
PI Web API Admin Utility automatically presents a series of configuration options.
You need to provide configuration settings for the following components:
|
Component |
Description |
|---|---|
|
PI Web API |
|
|
Telemetry |
Enables AVEVA to collect anonymous usage data to improve the PI System and to prioritize new features. The collected data does not include business data or logic, but can include information such as IP addresses, host names, and names of PI System objects. |
|
Configuration Store |
Specifies the PI AF server and the name of the space in the Configuration database where PI Web API can store operating configurations and persist other data. |
|
Authentication Option |
Specifies PI Web API's authentication methods. |
|
AIM Registration |
Specifies the AIM server for a new registration or displays existing registration information. This is optional and only be available if "OpenID Connect/Bearer" is selected as an authentication option. |
|
Listen Port |
Specifies the communication port that PI Web API uses to listen for HTTPS traffic. Also enables a Windows Firewall exception to allow remote clients to access the service when Windows Firewall is enabled. |
|
Certificate |
Enables an SSL certificate to be selected or changed to encrypt traffic between the server and clients on the selected listen port. If no SSL certificate is selected or set on the port, PI Web API creates and uses a self-signed certificate. |
|
API Service |
Specifies the account under which the API Windows service will run. For integrated Windows security that uses the Kerberos authentication protocol, this account must be trusted for delegation in Active Directory, ideally the default NT Service account. |
|
OMF Servers |
Specifies the PI AF server, asset database, and Data Archive to be used to store OMF-specific data. The PI Web API service account and PI Buffer Subsystem service account must have Write permissions in order to proceed. You can create a new asset database to store the OMF data separately from your other data. |
Caution: You should always use PI Web API Admin Utility to change these settings. Using other methods to modify these settings can result in errors or cause PI Web API to stop working.
PI Web API Admin Utility location
If you later need to change any of the configuration settings you established initially for the above components, you can open PI Web API Admin Utility manually. The utility is located under PI System on the Start menu.