Data source parameters

Endpoint

Required

string

The endpoint of the on-premises AVEVA Events to CONNECT service. The following is an example of the URL format: https://On-premiseRestAPIHost:Port/api/

Note: If you change the Endpoint on a configured agent that has ComponentID_DataSelection.json file exported, you need to remove the ComponentID_DataSelection.json file from the configuration directory to trigger a new browse (export).

Allowed value: well formed https endpoint string ending with '/'.

Default value: null

streamIdPrefix

Note: The AVEVA Events to CONNECT does not currently use the streamIdPrefix property.

Optional

string

Specifies what prefix is used for Stream IDs. The naming convention is {StreamIdPrefix}{StreamId}.

The streamIdPrefix is applied to all data items collected from the data source. If not configured, the default value will be the Component Id.

Allowed value: any string

Example default value: EventsToCONNECTComponent1

defaultStreamIdPattern

Note: The AVEVA Events to CONNECT does not currently use the defaultStreamIdPattern property.

Optional

string

Specifies the defaultStreamIdPattern to use. Possible parameters: {SourceId}, {ResourceId}, {QueryId}

HealthController

Required

string

Specifies the controller’s name of the on-premises Rest API endpoint to check the health of the on-premises application.

FailedRequestsController

Required

string

Specifies the controller’s name of the on-premises Rest API endpoint to send the error response for failed requests to CONNECT data services.

ClientId

Optional

string

Specifies the Auth0 or any OIDC provider’s client ID used to generate a bearer token to authenticate the on-premises Rest API.

ClientSecret

Optional

string

Specifies the Auth0 or any OIDC provider’s client secret used to generate a bearer token to authenticate the on-premises Rest API.

TokenEndpoint

Optional

string

Specifies the Auth0 or any OIDC provider’s token endpoint to generate a bearer token to authenticate the on-premises REST API.

TokenAudience

Optional

string

Specifies the Auth0 or any OIDC provider’s token audience used for generating a bearer token to authenticate the on-premises REST API.

ValidateEndpointCertificate

Optional

boolean

Specifies whether the agent should validate the certificate of the on-premises REST API endpoint.

Default value: true

Note: AVEVA strongly recommends only disabling server certificate validation for testing purposes.

Scopes

Required

array

Specifies the scope of the agent for which it can do the operations on the on-premises REST API endpoint.
Example values: "read", "write"

RequestInterval

Optional

string

Specifies the query interval for history recovery. This will be used to replace the ?ST? and ?ET? parameters in your query. For example, if the RequestInterval is set to 01:00:00, the difference between ?ST? and ?ET? in each query will be 1 hour.

UTC

Optional

boolean

Specifies the Time Zone of the data collected by the AVEVA Events to CONNECT agent.

Default value: true

dataCollectionMode

Optional

string

Specifies the data collection mode the agent is in. The following data collection modes are available:

HistoryOnly - The agent component does not get started and history recovery on-demand. For more information, see On-demand history recovery configuration.

CurrentOnly - The agent component operates normally and on-demand history recovery is disabled.

CurrentWithBackfill - The agent component operates normally, but disconnections are recorded based on device status. History recovery backfills data once device status is good. On-demand history recovery is disabled.

Default value: CurrentWithBackfill

For more information, see Automatic history recovery.

Important: Changing the mode requires a restart of the agent component.

backfillHistoricalData

Optional

boolean

Specifies whether backfill of historical data is to be enabled or disabled.

This option is to be used/visible only when dataCollectionMode is CurrentWithBackfill.

For more information, see History recovery.

backfillStartDateTime

Optional

string

Specifies the start date time for backfill of historical data.

This option is to be used/visible only when backfillHistoricalData is set to true.

By default the value is 4 days old and cannot be longer than this.

For more information, see History recovery.