The purpose of this article is to serve as a reference guide for using AVEVA as data server in the Data Collection Module.
This guide is part of the complete documentation for the Data Collection Module feature in SiteManager.
The AVEVA dataserver is used to send collected samples (data points) to an AVEVA Insights instance.
Configuration
The data server's (array of objects, mandatory) list elements contain the following fields:
| Function | Type | Importance | Description |
|---|---|---|---|
| DatasrvName | string | mandatory | Unique name (within this configuration file) 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 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 and Forward database to data servers, aka Cloud Systems. For AVEVA use AVEVA/REST. Other possible values (for other dataservers) are: C8Y/REST, AWS/MQTT, AZURE/IOTHUB, SCI/SPD, C8Y/REST, SEMA/REST and 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. |
| AVEVAParams | object | mandatory for AVEVA | Contains all the parameters needed to deliver (publish) data to the AVEVA Insight Cloud service. Mandatory if DatasrvProtocol has the value AVEVA/REST. |
AVEVAParams object
The AVEVAParams object contains the following fields:
| Function | Type | Importance | Description |
|---|---|---|---|
| UploadEndpointName | string | mandatory | The Upload endpoint URL to use for the AVEVA Insight connection. If not specified, the first AVEVA Upload endpoint URL found in the cert repository will be used. |
| TokenName | string | mandatory | The certname of the Authorization bearer token string to use for the AVEVA Insight connection. If not specified, the first AVEVA TokenName found in the cert repository will be used. |
| AvevaRootCAName | string | optional | The certname of the AVEVA Insight Root-CA certificate. If not specified, the first AVEVA Insight ROOT-CA found in the cert repository will be used. If none is found, then a built-in ROOT-CA certificate will be used. |
| PushInterval | integer >= 0 | mandatory | The interval in seconds between each delivery of new data from the Store and Forward database. The value 0 means that data is delivered as fast as possible. |
| TagNameFormat | string | optional | The format used to generate tag names. Defaults to: %d.%s. |
Example configuration
{
"ConfigName": "Aveva_Insight",
"ConfigDescription": "Configuration for aveva_test",
"CheckpointInterval": 600,
"Collectors": [
...
],
"DataServers": [
{
"DatasrvName" : "aveva_insight",
"DatasrvProtocol" : "AVEVA/REST",
"AvevaParams": {
"UploadEndpointName" : "aveva_uploadendpoint",
"TokenName" : "aveva_token",
"PushInterval" : 30
},
"ConnectRetryMin": 30,
"ConnectRetryMax": 240
}
]
}