Run the CONNECT to PI Configuration Utility
- Last UpdatedMar 17, 2025
- 3 minute read
- CONNECT
- CONNECT to PI Agent
- Agents
- PI Server
The CONNECT to PI Configuration Utility launches automatically when installation is complete, or it can be launched from Start > PI System > CONNECT to PI Configuration Utility.
To use the configuration utility, the CONNECT user must have the Tenant Administrator role in CONNECT data services.
-
If a banner displays the message "Run the utility as administrator to change settings," select Relaunch as Administrator.
The Configuration / Cloud page displays.
-
Select Sign in to CONNECT data services.
-
Enter your user credentials.
This opens https://signin.connect.aveva.com/login in a web browser for login. The browser will indicate that the user has been successfully authenticated. After successful authentication, return to the configuration utility.
Note: You must have the role of Tenant Administrator.
-
Return to the CONNECT to PI Configuration Utility and enter an Agent Name.
-
Select the Namespace field to bring up a list of available namespaces and select the namespace in which your agent will be registered.
-
Select Confirm to verify the connection. An error message will appear if there is an issue.
-
Select Next to continue to the Service Account page.
-
Select Edit to configure the Service Account.
-
Choose the account which CONNECT to PI will run as. See Authentication for information on Data Archive authentication methods. If using Windows authentication, this account requires write permissions to the PI Server using PI and AF Mappings. See Create mappings in the PI Server documentation. Select Edit to make changes and select the Account Type:
-
Default Virtual Account – The default account for the service runs as NT SERVICE\PIAdapterCONNECT.
-
Custom Account – Specify a username and password (domain\account) for the Run as user for the CONNECT to PI Agent service.
-
-
Select Confirm to test the service account credentials.
-
Select Next to continue to the PI Web API page.
-
Enter your PI Web API Server URL.
-
Select the Authentication Type for PI Web API:
-
Windows – Uses the Service Account you configured the agent to run as.
-
Basic – Specify a username and password.
-
OpenID Connect – Specify the Client ID and Client Secret.
-
-
Select the checkbox to acknowledge that you understand that the entity selected in the Authentication Type must have a PI and AF mappings to write data. Refer to Manage mappings in the PI System Management Tools documentation and PI AF identities and mappings in the PI System Explorer documentation.
-
Select Confirm to test the PI Web API Server authentication.
-
Select Next to continue to the Review page.
The Review page lists all the configuration settings and shows a green checkmark on those items that have been validated. You can select Edit next to any setting to return to that page and make changes.
-
Select Submit.
You should see messages that validation and registration are successful. You can view the successfully registered agent in the CONNECT data services portal by navigating to Data Collection > PI Agents page and selecting CONNECT to PI Agents from the agents dropdown selector.
Note: During registration, a non-expiring client id and client secret required for communication with CONNECT data services are stored on the agent machine. If these client credentials ever need to be replaced, the user can do this by running the utility again, signing into CONNECT data services and then navigating to the Review page where the user can select Submit to update their registration.