Dataserver Cumulocity IoT
- 18 May 2021
- 2 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Dataserver Cumulocity IoT
- Updated on 18 May 2021
- 2 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
The purpose of this article is to serve as a reference guide for using Cumulocity a data server in the Data Collection Module.
This guide is part of the complete documentation for the Data Collection Module feature in SiteManager.
Prerequisite
A starter pack (SiteManager + accounts)
A cloud subscription (trial) from Cumulocity IoT
Information
First time users might benefit from using the Setting up Cumulocity IoT guide. (See related articles section below)
The data server's (array of objects, mandatory) list elements contain the following fields:
| Function | Type | Importance | Description |
|---|---|---|---|
| DatasrvName | string | mandatory | Unique (within this configuration file) name for each data server this SiteManager delivers data to. Follows the normal rules for names. |
| DatasrvDesription | string | optional | A description of this data server. For your future reference. |
| SampleList | array of strings | optional | This array contains the list of sampleref this data server will deliver data for. If it is not present, all sample values in this configuration will be delivered. Since this object is not a Collector's object, the CollectorName part of the sampleref field is mandatory. If the SampleName part of the sampleref is left blank, all samples from that collector are delivered. |
| IOPin | boolean | optional | If set to true, the Output I/O pins configured to follow DCM data loss will be controlled by this datasrv. If multiple data servers control the I/O pins, then the value will be the logical OR of all data servers in data loss state. (I.e. If any data server is in data loss, the I/O pins will be in logical high). If not set, the value is false. |
| DatasrvProtocol | string-enum | mandatory | Designates the protocol used to deliver data from the Store'n'Forward database to data servers, aka Cloud Systems. For Cumulocity use "C8Y/REST". Currently 6 possible values exist: "AWS/MQTT", "AZURE/IOTHUB", "SCI/SPD", "C8Y/REST", "SEMA/REST" or "SIMULATOR/NONE". |
| ConnectRetryMin | integer > 0 | mandatory | Minimum number of seconds before trying to reestablish a connection to the data server for data delivery. An exponential back-off algorithm is used to retry connection establishment, starting after ConnectRetryMin and increasing to ConnectRetryMax. |
| ConnectRetryMax | integer > 0 | mandatory | Maximum number of seconds before trying to reestablish a connection to the data server for data delivery. |
| C8YParams | object | mandatory for Cumulocity | Contains all the parameters needed to deliver (publish) data to the Cumulocity Cloud service. Mandatory if DatasrvProtocol has the value "C8Y/REST". |
The C8YParams object contains the following fields:
| Function | Type | Importance | Description |
|---|---|---|---|
| C8YRegisterURL | string | mandatory | The URL of the Cumulocity Cloud for registering new devices. |
| C8YRootCAName | string | optional | The certname of the Cumulosity Root-CA certificate. If the certname cannot be found only unsecured HTTP server connections can be used. If not specified, the first Cumulocity ROOT-CA found in the cert repository will be used. |
| RegName | string | optional | The certname of the Cumulosity Device Registration Information for this connection. If not specified, the first Cumulosity Device Registration Information found in the cert repository will be used. |
| PushInterval | (integer >= 0 | mandatory | The interval in seconds between each delivery of new data from the store'n'forward database. The value 0 means that data is delivered as fast as possible. |
{
"DatasrvName": "secomea_c8y",
"DatasrvProtocol": "C8Y/REST",
"ConnectRetryMin": 2,
"ConnectRetryMax": 10,
"C8YParams": {
"C8YRegisterURL": "https://SecomeaPresales.cumulocity.com",
"RegName": "c8yreg",
"C8YRootCAName": "cumulocityROOTCA",
"PushInterval": 30
}
}Was this article helpful?
