Configure and test the Aveva Connect Integration

Prerequisites

• Integration Server deployed and registered on the platform

• Access to Aveva Connect Data Services

Supported query types

• Get the last value from one or many SDS Stream

Supported features

• Automatic UoM support

Configuration steps

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

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

1. Obtain a client authentication token from Aveva Connect

2. Register the Aveva Connect data source on RealityPlatform

3. Link the integration to an Asset Type

4. Send a test query in order to validate the connection to Connect

Obtain a client authentication token from Aveva Connect

1. Log into Aveva Connect and navigate to Aveva Data Services

2. Navigate to Security → Clients and click on the Add Client button on the top right

3. Select the appropriate permissions and generate a client token. The integration will need at least read access to the streams that will be accessed.

Register the Aveva Connect data source on the Integration Server

1. Add the new data source

2. Select the AVEVA_CONNECT type

3. Fill up the required parameters to establish the connection

Aveva Connect data source parameters

{
  "baseUrl": "https://example.avevaconnect.com",
  "namespaceId": "exampleNamespaceId",
  "tenantId": "exampleTenantId",
  "communityId": "exampleCommunityId",
  "clientId": "exampleClientId",
  "clientSecret": "exampleClientSecret"
}

baseUrl

The base URL of the Aveva Connect service.

nameSpaceId

The namespace ID of the Aveva Connect service.

tenantId

The tenantId of the Aveva Connect service.

CommunityId (Optional)

The id of the community that is hosting the data, if applicable.

clientId

The Id of the client that is assigned to the integration service installation.

clientSecret

The client secret that is assigned to the integration service installation.

Linking Asset Type Properties to Aveva Connect

Before linking, make sure you have:

• An existing Asset Type with a property to hold the required Aveva Connect parameter values (e.g., Stream Ids). It must be a “Short text” property type.

• An Integration Server configured with an Aveva Connect data source and queries.

To link an Asset Type property to Aveva Connect:

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 Connect.

4. Choose the appropriate Aveva Connect data source and query.

5. For each required parameter (e.g., StreamId), select the Asset Type property that should provide its value (e.g., Stream Ids).

   

6. 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 Connect

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

2. Enter one or many stream IDs, separated by commas, under the Parameters configuration and click on Test query to see the result. The stream Ids can be obtained from Aveva Connect directly.

Note

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., Stream Ids) is filled in. Use any valid stream ID from Aveva Connect to validate connectivity.