Data selection parameters

selected

Optional

boolean

Use this field to select or clear a measurement.

To select an item, set to true and specify a scheduleId.

To remove an item, leave the field empty or set to false.

Allowed value: true or false
Default value: true

name

Optional

string

Name of the data item or event type collected from the data source.

The default value is null and results in the streamId value being used as a name.

nodeId

Required for data items

string

The nodeId of the variable.Required for data items, mutually exclusive to eventTypeNodeId.

Examples:

"ns=5;AString"`
`"ns=2;i=203"`
`"ns=<NamespaceIndex>;<IdentifierType>=<Identifer>"

streamId

Optional

string

The custom stream Id used to create the streams.

If not specified, the adapter generates a default stream Id based on the measurement 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 adapter encodes special characters in the streamId, see Egress endpoints.

dataFilterId

Optional

string

Enables data filtering for this data selection item if the ID of a data filter is specified.

Note: If the specified dataFilterId does not exist, unfiltered data is sent until that dataFilterId is created.

scheduleID

Optional

string

If the scheduleId parameter is specified, then the adapter polls the item for data on the specified schedule. If the scheduleId parameter is not specified, then the adapter subscribes the item for data.

Default value: null

eventTypeNodeId

Required (only for event type configuration)

string

Mutually exclusive to NodeId. If specified, indicates Event Type selection.

Example:

"eventTypeNodeId": "i=2915"
"ns=<NamespaceIndex>;<IdentifierType>=<Identifer>"

eventSourceNameFilter

Optional

string

A filter to limit the scope of event type to a source. If empty, source will be entire Server.

For more details, see Subscribing to Event Notifications.

eventProperties

Optional

string

List of Event fields to egress. If not specified, EventType, Message and Severity will be included.

For more details, see Subscribing to Event Notifications.