Tag Configuration

The tag configuration is a collection of tags, that are all named uniquely according to a common naming standard used in the cloud platoform. The tag configuration is set up in the edge device, that defines how data is collected, aggregated and compressed, from source systems at the factory floor.

A tag configuration has the following properties:

Id Destination tag name according to the Cloud Platform naming standard. Must be unique.

AccessType Sets the read/write properties. Possible values are:

0 = Read only 1 = Write only 2 = Read and write

Input

MeasurementType Declares the expected data type of the input data 1 = Analog 2 = Digital 3 = String 4 = AnalogAgg (all analog aggregations) 5 = DigitalAgg (all digital aggregations)

SourceId Input source id (user friendly name). Must be unique within a module.

ModuleId Name of the module that must retrieve the data.

Endpoint Used if the module supports multiple endpoints, such as different OPC servers or Modbus Slaves. The endpoint names must be defined in the Module Twin, dependent on the specific module type. If the module only supports one endpoint, this property can be omitted.

Source Custom connection properties for the data retrieval of the tag. Examples are modbus address or OPC item reference.

SamplingRate Sets how often the input signal is sampled, in the format "hh:mm:ss" or "hh:mm:ss.xxx" if milliseconds are required.

Interpolation Determines how input values are interpreted. The calculation mode determines how values are determined between two measurements. 0 = Linear(continuous values) 1 = StairStep (setpoints)

Output

AggregationInterval Desired output resolution, in the format "hh:mm:ss" or "hh:mm:ss.xxx" if milliseconds are required. If the resolution should remain be unchanged (passthrough) then set this value to zero "00:00:00".

Aggregation If aggregation logic must be applied to the data, the following values are possible. 0 = None = 0 1 = TimeWeightedAverage 2 = ValueWeightedAverage 3 = Min 4 = Max 5 = Sum 6 = Count 7 = StdDev (Standard deviation) 8 = All (All above aggregations)

The logic property only applies if the output resolution is not zero.

MinMeasurements The minimum number of measurements required for an aggregation. If the number of measurements for an aggregation is below this limit, the output value is set to "uncertain" quality. The MinRecords property only applies if the output resolution is not zero.

Compression

OutputCompression Sets post-processing of the output time series data. Possible values are: 0 = Passthrough / no post processing 1 = SwingingDoor 2 = Deadband

CompressionDeadband Sets the change threshold for when data should be logged, if the compression mode is set to either SwingingDoor or DeadBand.

CompressionMaxInterval Sets the maximum time between when data should be logged, if the compression mode is set to either SwingingDoor or DeadBand.

Example tag configurations

Below is a sample configuration of a tag named "EmualatorTag1", that is configured for the EmulatorModule. It has one static and one dynamic route.

{
    "staticConfig": {
        "version": "1.0.0",
        "configurations": [
            {
                "id": "EmulatorTag1",
                "input": {
                    "moduleId": "EmulatorModule",
                    "sourceId": "EmulatedTag1",
                    "source": "sequence;80;82;83;84;82",
                    "endpoint": null,
                    "measurementType": "Analog",
                    "interpolation": "Linear",
                    "samplingRate": "00:00:05"
                },
                "output": {
                    "aggregation": "TimeWeightedAverage",
                    "aggregationInterval": "00:01:00",
                    "compression": {
                        "outputCompression": "SwingingDoor",
                        "compressionDeadBand": 4,
                        "compressionMaxInterval": "00:01:00",
                     },
                    "minMeasurements": 5
                },
                "accessType": "ReadOnly",
                "routes": [
                    {
                        "type": "ColdPath",
                        "uploadInterval": "00:00:01",
                        "routingInterval": "00:01:00"
                    }
                ]
            }
        ]
    },
    "dynamicConfig": {
        "configurations": [
            {
                "id": "EmulatorTag1",
                "routes": [
                    {
                        "timeToLive": "01:00:00",
                        "streamToClient": true,
                        "type": "HotPath",
                        "routingInterval": "00:01:00",
                        "uploadHistoryWindow": "00:01:00"
                   }
                ]
            }
        ]
    }
}