Data selection parameters

Selected

Optional

boolean

Use this field to select or clear a measurement. To select an item, set to true. To remove an item, leave the field empty or set to false.

Allowed value: true or false

Default value: true

Name

Optional

string

The optional friendly name of the data item collected from the data source.

Default value: null

Setting the value results in StreamId value being used also as a Name

StreamId

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

Optional

string

The unique identifier for the streamID used to create the streams. If not specified, the agent will generate a default StreamId based on the resources and query configuration. The StreamId serves as the unique identifier of a data selection item.

A properly configured custom stream ID follows these rules:

Is not case-sensitive. Can contain spaces. Cannot start with two underscores ("__"). Can contain a maximum of 2000 characters. Cannot use the following characters: / : ? # [ ] @ ! $ & ' ( ) \ * + , ; = % < > |Cannot start or end with a period. Cannot contain consecutive periods. Cannot consist of only periods.

For more information on how the agent encodes special characters in the Stream Id, see Egress endpoints.

DataFilterId

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

Optional

string

Enables data filtering for this data selection item if the ID of a data filter is specified. If the specified DataFilterId does not exist, unfiltered data is sent until that DataFilterId is created.

Type

Required

string

Name of the type.

Allowed values: AuthorizationTags, AssetTypes, Enumerations, ReferenceDataTypes, EventTypes, Assets, ReferenceData, Events.

Action

Required

string

Name of the action.

Allowed values: Create, Update, Delete,Patch.

The property is used to manage the sequence priority while egressing data to Connect Data Services.

Note: The property supports the Patch action type for assets.

ResourceId

Required

string

Specifies the unique identifier of a resource that is configured in the agent to support multiple endpoints for fetching the data from the on-premises REST API. It will be added to Base endpoint to poll the data.

Note: Configure resources before using it here.

QueryId

Optional

string

Specifies the unique identifier of a query that is configured in the agent. It is used as a query string to filter the required data.

Note: Configure queries before using it here.

ScheduleId

Optional

string

Specifies the unique identifier of a schedule for a time interval to poll the data.

Note: Configure schedules before using it here.

For example, if schedule interval is 30 sec, data will be polled every 30 sec.

Note: If ScheduleId is not provided, the data selection item will be picked up whenever the data selection configuration is created or updated.

For more details on assigning the ScheduleId for a data selection item, refer the Using Data Selection to publish types and events to CONNECT data services .

messageTypeField

Required

string

Specifies the syntax to fetch the Type Field from the Message Formatted data from on-premises REST API.

For example, if the JSON data is {"header": { "type": "sampleType"}}, then its value will be "header.type".

messageTypeIdField

Optional

string

Specifies the syntax to fetch the Type ID Field from the Message Formatted data from the on-premises REST API. Refer also to the messageTypeField.

messageActionField

Required

string

Specifies the syntax to fetch Action Field from the Message Formatted data from the on-premises REST API. Refer also to the messageTypeField.

messageValueField

Required

string

Specifies the syntax to fetch Value Field from the Message Formatted data from the on-premises REST API. Refer also to the messageTypeField.

messageContinuationTokenField

Optional

string

Specifies the continuation Token. If the data from the on-premises REST API is bulk and it has pagination support. So the next set of records can be fetched by passing the continuation token here.