Manage Data Sources on an Integration Server

Prev Next
This content is currently unavailable in German. You are viewing the default (English) version.

Prerequisites

  • Integration Server deployed and registered on RealityPlatform

Manage data sources via RealityPlatform

RealityPlatform is the preferred way to create and edit data sources. The UI is user friendly and will perform validation in order to ensure that configuration sent to the Integration Server is valid.

Create data source

  1. In RealityPlatform, navigate to Settings → Asset settings → Integrations. The list of registered Integration Servers will appear. Verify that the integration server is reachable by making sure that the status turn to a green checkmark.

image.png

image-20250513-190331.png

  1. Click on “Manage” under the “Data sources” column to open the data source management UI. It will display the list of registered data sources.

    image-20250513-190428.png

  2. To create a new data source, click on the “Add data source” button.

  3. Enter a name for the data source and select the data source type. The configuration box will then appear. Refer to the next section to validate the configuration parameter that are required and optional. Click on the “Format JSON” button to validate the configuration syntax. When the syntax is valid, click on the “Save” button to register the data source. Any configuration error will be displayed on the screen.

image-20250513-190706.png

 

Edit data source

  1. Perform the steps 1-2 of the “Create data source” section to open the data source management UI.

  2. Click on the edit icon to open the edition UI for the selected data source.

    image-20250513-190824.png

  3. Refer to the next section for each data source type to see what are the required and optional parameters for each data source. Click on the “Format JSON” button in order to validate and format the JSON text. The Save button will become available when the JSON is validated. Any configuration error will be displayed on the screen when attempting to Save the configuration.

Data source parameters

After creating a data source, you must provide the required connection parameters.

Some parameters are common across all data sources (e.g., type, name, uuid), while others depend on the selected data source type (HTTP, SQL, AVEVA Connect, etc.) and must be filled in according to that type’s specific requirements.

Common data source parameters

type

The data source type that will be created.

Possible values
  • AVEVA_CONNECT

  • AVEVA_PI_WEB_API

  • AWS_IOT_SITEWISE

  • HTTP

name

The name of the data source that will be created

uuid (Optional)

The uuid of the data source that will be created. This parameter is optional.

Custom parameters by data source type

Each data source type has its own set of required parameters. See the specific configuration details for: