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

Introduction

This filter is designed to load the payload data as a JSON document. Subsequently, it creates the configured payload values by extracting the values for those properties from the specified JSON paths.

Example Options File

{
  "Devices": {
    "Device1": {
      "DeviceType": "Generic",
      ...
      "Filters": [
         {
            "FilterType": "JsonManualMapper",
            "Order": 1,
            "JsonType": "SingleDocument",
            "TimestampPath": "Timestamp",
            "TimestampType": "String",
            "PropertyMaps": {
               "StationId": {
                 "ValuePath": "StationId"
               },
               "OutsideTemp": {
                 "ValuePath": "Temperature.Outside"
               },
               "InsideTemp": {
                 "ValuePath": "Temperature.Inside"
               }
            }
         }
      ]
    }
  }  
}

JSON Path

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

The specified 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.

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 JsonManualMapper filter:

Property Map

Here are the configurations for defining a property:

Value Sources

Here are the configurations for obtaining a value:

Timestamp Types

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

Dictionary Key Types

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

Source Information

If the Source Information includes values for the keys GatewayId, GroupName, DeviceType, or DeviceName, those respective values will be set for the telemetry properties. However, it is important to note that any values obtained from the JSON document will overwrite these initially set values. In other words, the Source Information values for GatewayId, GroupName, DeviceType, or DeviceName function as default values, but they can be overridden by corresponding values 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, 
  }
}