Data selection parameters

name

Optional

string

The optional friendly name of the data item collected from the data source. If not configured, data endpoints use the StreamId value as the Name.

Default value: null

dataFilterId

Optional

string

The identifier of a data filter defined in the Data filters.

By default, no filter is applied.

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

selected

Optional

boolean

If true, data for this item is collected and sent to one or more configured OMF endpoint.

Allowed value: true or false
Default value: true

streamId

Optional

string

The custom identifier used to create the streams. If not specified or null, the adapter generates a default value based on the DefaultStreamIdPattern from the data source configuration.

For more information on how the adapter encodes special characters in the StreamId, see Egress endpoints.

A properly configured custom stream ID follows these rules:

• Is not case-sensitive.

• Can contain spaces.

• Cannot start with two underscores (__) .

• Cannot exceed 100 characters.

valueField

Required2

string

Name of the value field.

JSONPath, XPath, and CSV are supported1.

For CSV files without a header, the column index (1 being the first column) should be specified.

Example: FanSpeed

Allowed Values: Any name to represent the value.

indexField

Optional

string

The JSONPath expression to take value to use as a timestamp from a property. A valid JSONPath expression starts with $.

For more information about JSONPath expression syntax, see JSONPath syntax for value retrieval.

Note: The adapter generates a timestamp when null is specified.

Allowed value: Any valid JSONPath expression

dataType

Required

string

Data type of the values specified in either the valueField or dataFields parameter. Only one parameter data type may be defined.

Example (valueField): Int32

Example (dataFields): COORDINATES

Allowed valueField values: Boolean, Int16, UInt16, Int32, UInt32, Int64, UInt64, Float32, Float64, String, Date-Time

Allowed dataFields values: COORDINATES, GEOLOCATION

Note: A data type of COORDINATES coincide with X,Y,Z dataFields. A data type of GEOLOCATION coincides with latitude (lat) and longitude (long) dataFields.

indexFormat

Optional

string

The time format of the timestamp value specified in the indexField property. The time format must be specified as yyyy-MM-ddTHH:mm:ss.

If you do not specify indexField and indexFormat, the adapter automatically sets the latter to Adapter, which uses an adapter-supplied timestamp for the data.

The timestamp is taken after the data is published to the adapter while the adapter processes it. If you specify indexFormat only with a value other than Adapter, the validation fails and the adapter triggers an error.

Default value: null

Allowed value: Any string that can be used as a DateTime format in the .NET DateTime.TryParseExact()method, for example, 01/30/2025.

For more information, see DateTime.TryParseExact Method.

Note: If the string cannot be parsed, specify a custom DateTime string or one of the following keywords: Adapter, UnixTimeSeconds, UnixTimeMilliseconds.

dataFields

Required2

dictionary
<string, string>

A dictionary of values with key-value pairs.

The keys are specific fields for a complex type and the values are a JSONPath, XPath, or CSV to the value field1. For CSV files without a header, the column index (1 being the first column) should be specified

Allowed keys: Latitude, Longitude, x, y, z
Default value: null

selectionCriteria

Optional

string

Defines the row selection criteria for the stream from CSV file. Comma separated list of pair of column names and the values that are used to construct the stream.

uom

Optional

string

Defines the column that has associated UOM.