Data selection parameters

valueColumn

Required1

string

The database column to read data values from.

dataColumns

Required1

dictionary<string, string>

A dictionary containing key-value pairs, where the keys represent particular fields of a complex type, and the values indicate the database columns from which to retrieve data.

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

indexColumn

Optional

string

Column that contains the timestamp. If no column is specified, the timestamp will be the time that the adapter read the value.

queryId

Required

string

The identifier of the query configured.

selectColumn

Optional

string

Name of the column that contains the selectValue. Used to identify which rows of the query results belong to the selection item.

selectValue

Optional

string

The unique identifier of the source. This identifier is commonly found in the database column specified in SelectColumn. Used to identify which rows of the query results belong to the selection item.

scheduleId

Required

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

selected

Optional

boolean

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

Allowed value: true or false
Default value: true

uom

Optional

string

A Unit of Measurement (UoM) is a reference point for measuring and comparing data, such as temperature or voltage.

name

Optional

string

The friendly name of the data item collected from the data source. If not configured, the default value is the stream Id.

streamId

Optional

string

The custom stream Id used to create the streams. If not specified, the RDBMS adapter generates a default value based on the DefaultStreamIdPattern in the data source 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.

  The custom identifier used to create the stream. For more information on how the adapter encodes special characters in the StreamId, see Egress.

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.