summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAlbin Suresh <albin.suresh@softwareag.com>2022-03-07 17:42:04 +0530
committerAlbin Suresh <albin.suresh@softwareag.com>2022-03-11 12:40:45 +0530
commit59fd1aa5ec16cc6a8cd89fc8f3541cf33f763ff3 (patch)
tree128406c2a056d723574d8496cc1f033efb9484c8 /docs
parentc02fd97270b026536ed4d3e12f793299e9e76b70 (diff)
Closes #893 Support custom fields and fragments in Thin Edge JSON events
Diffstat (limited to 'docs')
-rw-r--r--docs/src/tutorials/send-events.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/src/tutorials/send-events.md b/docs/src/tutorials/send-events.md
index b4c1263b..31306d64 100644
--- a/docs/src/tutorials/send-events.md
+++ b/docs/src/tutorials/send-events.md
@@ -57,8 +57,7 @@ For example, if the device is connected to Cumulocity IoT cloud platform, the Cu
### Cumulocity cloud data mapping
-The Cumulocity mapper will convert Thin Edge JSON into Cumulocity SmartREST messages and send it to Cumulocity via MQTT,
-if the event payload size is less than 16K bytes.
+The Cumulocity mapper will convert Thin Edge JSON events into its Cumulocity SmartREST equivalent if the payload only contains either a `text` field or `time` field.
For example the `login_event` described in the earlier sections will be converted to the following Cumulocity SmartREST message:
@@ -68,7 +67,8 @@ For example the `login_event` described in the earlier sections will be converte
... and is published to `c8y/s/us` topic which will get forwarded to the connected Cumulocity cloud instance.
-If the event payload size is more than 16K, it will be converted to Cumulocity JSON format and sent over HTTP.
+If the event JSON payload contains fields other than `text` and `time`, or when the payload size is more than 16K irrespective of its contents, it will be converted to Cumulocity JSON format.
+
The Cumulocity JSON mapping of the same event would be as follows:
```json
@@ -82,4 +82,6 @@ The Cumulocity JSON mapping of the same event would be as follows:
}
```
+> Note: Mapped events will be sent to Cumulocity via MQTT if the incoming Thin Edge JSON event payload size is less than 16K bytes. If higher, HTTP will be used.
+
Find more information about events data model in Cumulocity [here](https://cumulocity.com/guides/concepts/domain-model/#events).