Configure and test the Aveva PI Web API Integration

Prerequisites

• Integration Server deployed and registered on the platform that can connect to PI Web API

• PI System with PI AF (if retrieving assets) with PI Web API installed and configured

Supported query types

• Get the last value from one or many PI Points

• Get the current value of a PI AF Asset properties

Supported features

• Automatic UoM support

• Filter PI AF properties by categories. Multiple categories can be specified in a single parameter by separating them with commas.

Configuration steps

This guide will describe how to configure the Aveva PI integration to retrieve data in a RealityAsset.

The main steps in order to configure the Aveva PI integration are the following :

1. Register the Aveva PI data source on RealityPlatform

2. Link the integration to an Asset Type

3. Send a test query in order to validate the connection to PI

Register the Aveva PI data source on the Integration Server

1. Add the new data source

2. Select the Aveva_PI_WEB_API type

3. Fill up the required parameters to establish the connection

Aveva PI Web API data source parameters

{
  "baseUrl": "https://example.avevapiwebapi.com",
  "authenticationMethod": "Basic",
  "ignoreSslCertificateErrors": false,
  "username": "johnDoe",
  "password": "password"
}

baseUrl

The base URL of Pi Web API.

username (Optional)

Username for basic authentication

password (Optional)

Password for basic authentication

authenticationMethod

The authentication method that will be used to authenticate against PI Web API.

Possible values

• disable

• basic

Linking Asset Type Properties to Aveva PI WEB API

Before linking, make sure you have:

• An existing Asset Type with a property to hold the required Aveva PI WEB API parameter values (e.g., PI AF Path). It must be a “Short text” property type.

• An Integration Server configured with an Aveva PI WEB API data source and queries.

To link an Asset Type property to Aveva PI WEB API:

1. In Asset Settings → Asset Types, open the Asset Type you want to link.

2. In the Integration Links panel (right side), click Create Integration Link.

   

3. Enter a link name and select the Integration Server configured for Aveva PI WEB API.

4. Choose the appropriate data source

5. Choose the desired query:
   
   -Get PI AF asset properties
   Retrieves the attributes of a PI AF asset and their latest values.

   Parameters:

   • PiAssetPath

   • CategoryName (Optional)
     

   -Get PI Points values
   Retrieves the latest value of a specified PI Point.

   Parameters:

   • WebID
     

6. For each required parameter (e.g., PIAssetPath), select the Asset Type property that should provide its value (e.g., PI Asset Path).

   

7. Click Save to create the link.

When this Asset Type is assigned to assets, the linked property values will automatically be passed to Aveva Connect when running the integration.

Send a test query to validate connectivity between RealityPlatform and Aveva PI WEB API

1. On the Asset Type Settings page, click on the play button next to the integration link that is targeting the Aveva PI WEB API data source. This will open the test query menu.

2. Enter a PI AF Asset Path (or a PI Point path, depending on the query that was selected) under the Parameters configuration and click on Test query to see the result. The integration uses standard PI path format and they can be found directly in PI System Explorer or PI System Management Tools.

Note

• CategoryName is optional, multiple categories can be specified in a single parameter by separating them with commas.

• The values entered here are only for testing purposes. They are not saved to the Asset Type or linked assets. This test simulates what RealityTwin will do when an asset is created, assigned this Asset Type, and the corresponding property (e.g., PI AF Path) is filled in. Use any valid PI AF Path or PI Point from Aveva PI to validate connectivity.