Skip to main content
Version: v4.5

NamedTelemetryCollection

A NamedTelemetryCollection is a type of NamedUserCollection that contains telemetry items. It inherits all the properties and characteristics of a named user collection with the following additional time series properties:

  • _tsProperites._granularity: Defines the interval granularity for new readings for the purpose of optimal data storage and query. You can enter one of the following granularity values:

    • seconds
    • minutes
    • hours

      Note: If you do not define a granularity value, the default value is minutes.

  • _tsProperties._expiry: Enter an expiry time in seconds to automatically delete added Readings after a time you define.

    Note: Expiry time does not guarantee deletion of the Readings exactly at their expiry time. Readings which have expired will be deleted in due course of time.

For more information, see the following code example of a NamedTelemetryCollection definition with its mandatory properties only:

let telemetryCollection = {  name: "Example Telemetry Collection", //Name the collection  _userType: "temp_telemetry_col", // A short custom name to describe the collection  _itemClass: "NamedTelemetryCollection",   _tsProperties: {    _granularity: "minutes",    _expiry: "2630000", //Expiry time of one month in seconds   }, };

Indoor Air Quality sensor example of a NamedTelemetryCollection, RelatedItems, and readings#

As an example, consider an Indoor Air Quality (IAQ) sensor you want to treat as an asset of interest. The IAQ sensor has the following two points that generate a different type of sensor reading:

  • Point-1 measures temperature
  • Point-2 measures carbon dioxide

The IAQ sensor is a RelatedItem in a building elements collection, which contains other assets of interest. Point-1 and Point-2 are separate telemetry items in a Sensor Points NamedTelemetryCollection because each point has its own readings.

image

Schema#

For more information on the NamedFileCollection type and its properties, see the

NamedUserCollection schema.

API#

You can create and manage NamedTelemetryCollections with the IafItemSvc JavaScript Platform API or the Item Service REST API.