In Clarify Client, a "Scheme" is a set of configurations that defines that under which conditions the value of a certain datapoint should be stored in the clarify database and what other attributes of the datapoint should be stored along with it.

Custom Schemes

A custom scheme can be configured as a sub object of "customSchemes" object.

"customSchemes": {
  "custom scheme name": {
    "extraSignals" : [ "datapoint's attribute name", "datapoint's other attribute name, ... ]",
    "qualityFilter" : "[ "a quality state", "other quality state", ... ]",
    "qualitySignal" : true/false
  }
}

Object Members

extraSignals	A list of extra attributes of the datapoint that need to be sent along with the `value` attribute.
qualityFilter	A list of quality states. The value and extra attributes of the datapoint will be sent to the database only if the quality of the datapoint is one of the listed qualities. An empty list is not allowed. If this field is missing, no quality filter will be applied.
qualitySignal	A boolean value that defines whether the quality attribute of the datapoint must be sent or not.

Pre Defined Schemes

Currently there are two pre defined schemes to be used, "default" and "compact" schemes.

The "default" Scheme

Applying the pre defined "default" scheme to a datapoint, will cause the datapoint's "value" and "quality" attributes to be stored in the database without any additional attributes or setting any quality filter.

The "compact" Scheme

Applying the pre defined "compact" scheme to a datapoint, will cause the datapoint's "value" attribute to be stored in the database only if the datapoint's quality is Good or Acceptable.