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 in the Configure data source (Structured Data Files).

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 100 characters.

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

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.

timeField

Optional

string

Name of the time field. JSONPath, XPath, and CSV are supported1.

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

Default value (also when empty string, or only whitespace characters):

null - UTC time the file is processed by the adapter.

Allowed values if no timestamp is provided in the file:

• null

• FileCreationTime - UTC time when the file was created.

• FileModifiedTime - UTC time when the file was modified.

• Any valid JSONPath, XPath, or CSV column number or header

  Example: "FanSpeedTimeStamp"

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.

timeFormat

Optional

string

Time format of the timestamp specified in the TimeField parameter. When TimeField is null, IndexFormat is passed as Adapter.

Default value: null.

Example: MM/dd/yyyy H:mm:ss zzz.

Note: For more examples of time format syntax, see Text parser.

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.