Trendz Analytics
Klyff Platform Cloud Edge IoT Gateway Trendz Analytics Mobile Application MQTT Broker
Installation > Connect Trendz to Thingsboard
Getting Started Documentation Guides
On this page

Connect To the Klyff

Connect to Klyff

You can connect Trendz Analytics to the Klyff Community Edition or Klyff Professional Edition.


By default, Trendz expects that Klyff is hosted on the same instance and accessible via an URL:

  • http://localhost:9090

If your Klyff installation is hosted on another instance/port - you have to update config with correct value:

Open Trendz configuration file:

1

sudo nano /usr/share/trendz/conf/trendz.conf

And update this property to the correct value:

1

export TB_API_URL=http://localhost:9090

For docker installations - update environment variable TB_API_URL with the correct value.

Authentication and Security

Trendz uses Klyff as an authentication service. Any Tenant Administrator or Customer User can sign in into Trendz UI using their login\password that they use for authentication in the Klyff.

Same security restrictions that are configured on the Klyff works in the Trendz Analytics.

  • Tenant Administrator has access to all Devices/Assets
  • Customer user has access only to those Devices/Assets that they have permissions to view

Topology Discovery

Trendz Topology represents the business model of Devices/Assets that was created in Klyff. Topology defines dimensions/fields that used for building visualizations and relation between Devices/Assets. Here are the core components of Trendz Topology:

Business Entity - Definition of a group of Devices or Assets with same Device Type/Asset Type. Each Business Entity has:

  • Criteria - General properties that define how Devices/Assets fetched from the Klyff
  • Business Entity Field - Represent field that is used during building visualizations. Field contains data type, label and query parameters used during fetching data from The thingsBoard. Here is a list of supported fields:
    • Entity Name - the name of the Device or Asset
    • Owner - who own device (administrator/customer)
    • Attribute
    • Telemetry
  • Relations - configured relations between Business Entities and their properties. Trendz Relations represent Klyff relations between Devices and Assets

First Topology discovery

After the first sign-in user should perform initial Topology Discovery. During this process, Trendz will analyze all Devices/Assets available in the Klyff, their attributes/telemetry and all relations between them. As a result, Trendz will extract and save the collection of Business Entities. You can view and modify them on the Settings page.

image


image

Manual Topology rediscovery

Business Entity does not represent a single Device or Asset, but the query that used for fetching Device/Asset from the Klyff. It means that you do not need to update topology if new Devices Assets with the same type were added on the Klyff.

When new Device/Asset types were added or attribute/telemetry with a new key was created in the Klyff - you should update Topology.

Manual Topology Rediscovery will scan Klyff again, detect modifications and update collection of Business Entities with required settings. You can trigger this process on the Settings page by pressing Refresh Topology.

Manual Modification

Another option for updating topology is a manual modification of Business Entity properties. You can have as many Business Entities with similar properties as you want. It may be useful in case when the same devices/assets represent different aspects of business solution. For example, single devices can monitor the environment and submit debug events for troubleshooting. By separating debug events from environment measurements into isolated Business Entities it becomes easier to build visualizations focused on a single aspect of your solution.

Next Steps

  • Getting started guide - These guide provide quick overview of main Trendz features.

  • Calculated Fields - Learn about Calculated fields and how to use them.

  • States - Learn how to define and analyse states for assets based on raw telemetry.

  • Prediction - Learn how to make forecasts and predict telemetry behavior.

  • Filters - Learn how filter dataset during analysis.

  • Available Visualizations - Learn about visualization widgets available in Trendz and how to configure them.

  • Share and embed Visualizations - Learn how to add Trendz visualizations on Klyff dashboard or 3rd party web pages.