avatar  

Log out

Recently viewed tickets

Data Collection Cloud (Secomea) dataserver

Purpose
The purpose of this guide is to be a reference guide for DCC as dataserver.

This guide is part of the complete documentation for the Data Collection Module feature in SiteManager.

Prerequisite:

A Starter package (SiteManager + accounts) 
A cloud subscription (Trial) from Secomea cloud DCC
Other sections in DCM:


Information;
First time users might benefit from using the Setting up DCC guide.
 

The DataServers (array of objects, mandatory) list elements contains the following fields:
FunctionTypeImportanceDescription
DatasrvNamestringmandatoryUnique (within this configuration file) name for each dataserver, this SiteManager delivers data to. Follows the normal rules for names.
DatasrvDesriptionstringoptionalA description of this data server. For your future reference
SampleListarray of stringsoptional This array contains the list of sampleref, this dataserver will deliver data for. If it is not present, all sample values in this configuration will be delivered. Since this object is not a Collectors 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.
IOPinbooleanoptionalIf set to true, the Output I/O pins configured to follow DCM dataloss, will be controlled by this datasrv. If multiple dataservers are controlling the I/O pins, then the value will be the logical OR of all dataservers data loss state. (I.e. If any dataserver is in dataloss, the I/O pins will be in logical high). If not set, the value is false.
DatasrvProtocolstring-enummandatoryDesignates 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 exists: "AWS/MQTT", "AZURE/IOTHUB", "SCI/SPD", "C8Y/REST", "SEMA/REST" or "SIMULATOR/NONE".
ConnectRetryMininteger > 0mandatoryMinimum number of seconds before trying to reestablish a connection to the dataserver for data delivery. An exponential back-off algorithm is used to retry connection establishment, starting after ConnectRetryMin and increasing to ConnectRetryMax.
ConnectRetryMaxinteger > 0mandatoryMaximum number of seconds before trying to reestablish a connection to the dataserver for data delivery.
SCISPDParamsobjectmandatory
for Secomea
Data Collectio Cloud
Contains all the parameters needed to deliver (publish) data to the Secomea cloud service. Mandatory if DatasrvProtocol has the value "SCI/SPD"..


The SCISPDParams (array of objects, mandatory) list elements contains the following fields:
FunctionTypeImportanceDescription
SCIServerAddrstringmandatoryThe DNS name/IP address of the SDCC server to deliver data to from the Store'n'Forward database.
SecuritystringoptionalThe security protocol used to encapsulate the SPD protocol. Currently 3 values are supported: "NONE", "TLS1.2" and "TLS1.3". If not specified, "NONE" is used.
SPDPortinteger > 0 and < 65535optionalThe TCP portnumber to use for the connection from the SiteManager to the SDCC server. IF not specified, the Security value defaults the value to 48040 for "NONE" and 443 otherwise.
RootCANamestringoptionalThe certname of the SDCC ROOT-CA certificate to use for the connection. If not specified, the first SDCC ROOT-CA certificate found in the cert repository will be used. This field is not used if the Security field is "NONE".
DevCertNamestringoptionalThe certname of the SDCC Device certificate to use for the connection. If not specified, the first SDCC Device certificate found in the cert repository will be used. If no SDCC Device certificate is found the connection will not be mutually authenticated.
DevPkeyNamestringoptionalThe certname of the SDCC Device Private Key to use for the connection. If not specified, the first SDCC Device Private Key found in the cert repository will be used. If no SDCC Device Private Key is found the connection will not be mutually authenticated.
PushIntervalinteger >= 0mandatoryThe 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.



{
            "ConnectRetryMax": 60,
            "ConnectRetryMin": 2,
            "DatasrvName": "DCC",
            "DatasrvProtocol": "SCI/SPD",
            "IOPin": true,
            "SCISPDParams": {
                "DevCertName": "dccdevcert",
                "DevPkeyName": "dccprivkey",
                "PushInterval": 5,
                "RootCAName": "dccrootca",
                "SCIServerAddr": "dcm-dcc.secomea.com",
                "SPDPort": 443,
                "Security": "TLS1.2"
            }
}
Creation date: 02/09/2020 10:16 (tvo@secomea.com)      Updated: 02/09/2020 11:03 (tvo@secomea.com)