Data selection parameters

selected

Optional

boolean

Selects or clears 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.

Allowed value: Any string
Default value: null

topic

Required

string

The MQTT topic string in the following format:

{namespace}/{groupId}/{messageType}/{edgeNodeId}/{deviceId}

The following rules apply to the MQTT topic string:

1. Both the topic string as a whole and the individual components are case-sensitive.

2. {namespace} must be spBv1.0 (case-sensitive).

3. {groupId} must be non-blank and can contain any character except for + and #

4. {messageType} must be either DDATA or NDATA (uppercase)

   Note: When NDATA is specified, {deviceId} must not be specified

5. edgeNodeId must be non-blank and can contain any character, except for + and #.

6. {deviceId} must be non-blank and can contain any character, except for + and #.

   Examples:

   spBv1.0/DemoCenters/DDATA/EPIC-DC004/DC004
   spBv1.0/DemoCenters/NDATA/EPIC-DC004

metricName

Required

string

The name of the property in the metric.

The parameter cannot be null, empty, or whitespace.

streamId

Optional

string

The custom stream Id that is used to create the streams.

If you do not specify the streamId, the adapter generates a default stream Id based on the measurement configuration.

A properly configured custom stream Id follows these rules:

• Is not case-sensitive

• Can contain spaces

• Can contain front slashes (/)

• Can contain a maximum of 100 characters

• Cannot start with two underscores (__)

• Cannot start or end with a period

• Cannot contain consecutive periods

• Cannot consist of only periods

  The default Id automatically updates when there are changes to the measurement.
  
  For more information on how the adapter encodes special characters in the streamId, see Egress endpoints.

dataFilterId

Optional

string

The identification of the data filter.

Allowed value: Any string
Default value: null

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

uom

Optional

string

The unit of measure value from a "properties" field of a metric within the payload supplied by the MQTT SparkplugB broker.

Allowed value: Any string
Default value: null