1. Introduction
2. Example Options File
3. JSON Path
   1. Property Details
   2. Timestamp Type
   3. Property Map
   4. Value Sources
   5. Dictionary Key Types
4. Source Information
5. JSON Types

Introduction

This filter is designed to load the payload data as a JSON document and traverse through the document. During this process, it automatically incorporates all the encountered JSON properties into the payload values.

Example Options File

{
  "Devices": {
    "Device1": {
      "DeviceType": "Generic",
      ...
      "Filters": [
         {
            "FilterType": "JsonAutoMapper",
            "Order": 1,
            "JsonType": "SingleDocument",
            "TimestampPath": "Timestamp",
            "TimestampType": "String"
         }
      ]
    }
  }  
}

JSON Path

JSON Path serves as a query language for JSON, like XPath for XML. It enables the user to select a specific value from a JSON document.

The required JSON path depends on the specified JSONType:

• SingleDocument: The JSON path is relative to the entire document.
• DocumentArray: The JSON path is relative to the array element.
• Dictionary: The JSON path is relative to the array element.

For an accessible way to obtain the JSON path for a required value, users can use the JSON Path Online Evaluator.

Property Details

Here is an overview of the parameters for configuring the JsonAutoMapper filter:

Timestamp Type

Here is an explanation of the different configurations for representing a date:

Property Map

Here are the configurations for defining a property:

Value Sources

Here are the configurations for obtaining a value:

Dictionary Key Types

A breakdown of the possible configurations for a specific key, based on the provided values:

Source Information

If the Source Information provides values for the keys GatewayId, GroupName, DeviceType, or DeviceName, these respective values will be applied to the telemetry properties. However, it is important to note that any values retrieved from the JSON document will take precedence and overwrite these initial values. In other words, the Source Information values for GatewayId, GroupName, DeviceType, or DeviceName function as default values, subject to being overridden by corresponding values extracted from the JSON document.

JSON Types

0 = SingleDocument

The JSON contains a single root document.

{
  "StationId": "Station123",
  "Timestamp": "2022-09-28T15:58:00+02:00",
  "Temperature": {
    "Outside": 30.3,
    "Inside": 25.8
  },
  "WindSpeed": 20,
  "Humidity": 56.34,
  "Location": {
    "Lat": -25.863164,
    "Lon": 28.2084316
  }
}

1 = DocumentArray

The JSON contains an array of root documents.

[
  {
    "Timestamp": 1664373219,
    "Temp": 23,
    "Location": {
      "Lat": -25.863164,
      "Lon": 28.2084316
    }
  },
  {
    "Timestamp": 1664373220,
    "Temp": 24,
    "Location": {
      "Lat": -25.863164,
      "Lon": 28.2084316
    }
  }
]

2 = Dictionary

The JSON contains a dictionary of root documents. The dictionary key can be used to set a value (e.g. DeviceName).

{
  "Device1": {
    "Timestamp": 1664373219,
    "Temp": 23
  },
  "Device2": {
    "Timestamp": 1664373219,
    "Temp": 23, 
  }
}