Setting up Senseye as a synchronization destination
Special features and limitations
Unidirectional synchronization
Data is always synchronized in one direction – from IIH Essentials to Senseye. Synchronization in the other direction – from Senseye to IIH Essentials – does not take place.
Delayed visibility of data
It can take up to 24 hours for synchronized data to be visible in Senseye.
Data prioritization
IIH Essentials synchronizes data for an attribute in chronological order. This means it starts with the oldest but not yet synchronized data and continues until all data up to the current timestamp is synchronized.
If an attribute with historical data is added to an entity, sending this data is prioritized. The data of other already synchronized attributes for this entity will only be sent again if the historical data of the new attribute is synchronized.
Hierarchy
Consider the following aspects about synchronization from IIH Essentials to Senseye:
- For every entity of type
anchor.asset-base
(or inherited children), a sublevel object is created in Senseye. - For every entity of type
anchor.asset-base
(or inherited children) with an aspect or attributes, an asset object is created in Senseye. - For every entity of type
anchor.aspect-base
a sensor is created in Senseye and added to its according asset. - For every attribute a measure is created and added to its according sensor in Senseye.
- Attributes with the data type
composition
oraggregation
are not created in Senseye, as there is no according object, but their aspect value is created as sensor (see entity of typeanchor.aspect-base
) - If no attribute has been linked with an entity in the hierarchy, no sublevel or asset is created in Senseye.
- If an attribute has been linked directly with an entity of type
anchor.asset-base
, an implicit sensor is created in Senseye. - An entity of type
anchor.aspect-base
which is a child of an entity of typeanchor.aspect-base
cannot be synced to Senseye as this hierarchy is not possible in Senseye. - An entity of type
anchor.asset-base
which is connected via composition is not synced to Senseye.
Possible hierarchy
This tables shows different hierarchy structures and if they are possible to sync with Senseye:
Top element | Link to parent | Subelement (with attribute) |
Link to parent | Allowed in IIH | Sync with Senseye |
---|---|---|---|---|---|
Asset | Relation | ||||
Asset | Relation | Yes | Yes | ||
Asset | Composition | Yes | No | ||
Aspect | Relation/Composition | Yes | Yes | ||
Asset/Aspect | Aggregation | Yes | Yes * | ||
Asset | Composition | ||||
Asset/Aspect | Relation | No | |||
Asset/Aspect | Composition | Yes | No | ||
Asset/Aspect | Aggregation | Yes | Yes * | ||
Aspect | Relation | ||||
Asset | Relation/Composition | No | |||
Aspect | Relation/Composition | Yes | No | ||
Asset/Aspect | Aggregation | Yes | Yes * | ||
Aspect | Composition | ||||
Asset | Relation/Composition | No | |||
Aspect | Relation | No | |||
Aspect | Composition | Yes | No | ||
Asset/Aspect | Aggregation | Yes | Yes * |
*: The subelement will be synced via the Relation/Composition hierarchy.
Prerequisite
- Senseye can be accessed via the network.
Procedure
To set up Senseye as a data destination, follow these steps:
-
Create a new data destination and select "Senseye" as the destination type.
Adding Senseye as synchronization destination in IIH Essentials -
Enter the relevant information.
- Name: Name of the data destination. This name must be unique.
- MQTT Host: The URL for the connection to the MQTT broker.
- MQTT Port: The port for the connection to the MQTT broker.
- MQTT User Name: User name for the connection to the MQTT broker.
- MQTT Password: Password for the connection to the MQTT broker.
- MQTT OrgID: ID in Senseye of the organization to which the data is to be transferred.
- Synchronize with Hierarchy: Enables the hierarchy to be synchronized to Senseye hierarchy. If it is disabled, the hierarchy is not synchronized and only the time series data is synchronized to Senseye. This means, attributes will not be created in Senseye's hierarchy. Only the data of the attribute will be sent to a specific MQTT topic, which needs to be mapped to a sensor manually.
- API Host: The URL for the connection to the API server. This control is hidden if syncHierarchy is disabled.
- API User Name: User name for the connection to the API server. This control is hidden if syncHierarchy is disabled.
- API Password: Password for the connection to the API server. This control is hidden if syncHierarchy is disabled.
- Sublevel Root: Sublevel in Senseye with which the hierarchy is to be synchronized. This control is hidden if syncHierarchy is disabled.
- Publishing Interval in Seconds: The rate at which the data is transferred to Senseye. At least 60 seconds is recommended so that Senseye has time to process the data and reduce the backlog.
-
Enable the data destination.
- To create the data destination, click "Save".
Result
Senseye is available as a data destination and can be specified as the storage location