The Xentara Clarify Client Microservice v1.1
User Manual
Loading...
Searching...
No Matches
Dataset

Description

A "Dataset" in Xentara Clarify Client Microservice is a collection of datapoints that share the same settings for collect and send intervals. One or more Datasets can be defined as the children of an Integration

Model File Format

The Datasets will be configured under the "children" list of the Integration as below

"@Microservice.Clarify.Dataset": {
"id" : "Dataset 1",
"uuid" : "c45e2ba2-710f-45ce-ab83-c49eb74998e5",
"dataPoints": {
"Test.Data.Signal 1" : "default",
"Test.Data.Signal 2" : "compact",
...
}
}

Object Members
idA string value containing the ID of the Dataset. The ID is used to construct the Dataset's Primary Keys
uuidA string value containing the unique UUID of the Dataset.
dataPointsA json object containing a key/value list of datapoints' Primary Keys and the scheme to be used for each of them.

Published Attributes

An overview of the plugin current operation condition can be obtained by reading its published attributes. The Dataset's published attributes are explained here.

Published Tasks

Collect Task

The sampling of the Dataset's datapoints can be trigered by invoking this task. For example by invoking this task as a "function" from a timer, the sampling can be done in configurable intervals. The "collect task" primary key would be a ".collect" suffix added to the Dataset's primary key.

Send Task

The sending of the Dataset's data to the database can be trigured by invoking this task. For example by invoking this task as a "function" from a timer, the send operation can be done in configurable intervals. The "send task" primary key would be a ".send" suffix added to the Dataset's primary key.

Gap Detection

The Gap Detection is switched on for all the data sent to the Clarify database. The gap detection time period will be set automatically based on the collect task interval.