Page History

System Requirements

This TagProvider requires the user to have access to an InfluxDB Server with support for API Version 2.0 or greater.

Anchor
InfluxDB Tag Provider and Historian Integration InfluxDB Tag Provider and Historian Integration

InfluxDB TagProvider and Historian Integration

To configure this Protocol as a ExternalTags, go to Unified Namespace → External TagProviders Source and create a new provider for InfluxDB Connector.

The Station syntax is similar to the Device one, with two additional fields:

• IP Address: InfluxDB Database Server Default value is localhost.
• Port: InfluxDB Database Server Port Default value is 8086.
• Token: Token used to verify Read/Write Permission.
• Bucket: Bucket in which client will connect If Connection parameters are correctly filled, you should see all buckets available in the ComboBox DropDown.
• Organization: Organization defined for user in InfluxDB Database.

• Collector: Specifies the type of Collector to be used. Each one have a specific behavior in Runtime. Options are:
  • Default: Connects to any InfluxDB Database without any custom TreeView is based only on Filter configuration.
  • tProj Historian: Is used to Write ProjectTags Historian data in a custom.
    • Filters field will always be disabled, with measurement and field columns added to.
    • When Provider is used as Historian, Historian TableName will be used as measurement.
    • TreeView structure will behave different than Default and MQTT  More details available in following sections.
  • MQTT: Is used to Read Data that was stored using Telegraf’s MQTT Plugin pre-defined column structure.
    • The Topic information MUST be stored in a column named topic.
    • Filters field will always be disabled, with measurement, topic and field columns added to
    • TreeView structure will behave different than Default and tProj Historian.More details available in following sections.
• Filters: Defines a hierarchical order for columns, separated by comma (","), when assembling the TreeView.

1. You can browse the columns to be discarded at the "+"
2. Click on + or - to add / remove And Up/Down arrows to change the filter order.

The Filters are used to define the Query to be executed when assembling the TreeView. In this example with measurement and field,the structure would be as follows:

Collectors

A DataCollector is an application that collects data from the field. 

This ExternalTags can act as a Collector for different InfluxDB Schemas. Each one of them will have its own characteristic when assembling the Data in a TreeView Structure. 

The Collectors are described in the sections below.

Default Collector

This collector will access any InfluxDB Database, and create the TreeView Structure based on the Filters. 

This Collector can Read/Write data.

tProj Historian Collector

When a new Provider is Created, there is an option at the Dialog Window to Enable it as an Historian Server. When enabled, the provider is Write-Only.

Storing Data

In this Configuration, Tags added on Historian →  Historian Tags, into a Table targeted for InfluxDB Provider, will be automatically logged in your Database.

In this scenario, the Table Name will act as our _measurement and the Complete TagName will be added to the field column.

Reading Historical Data

By using the Complete TagName as _field, the TreeView can use that information to transform that name into a multi-level structure as illustrated below.

MQTT Collector

This Collector is used to Read Data from an InfluxDB Database Structure that was stored using Telegraf’s MQTT Plugin pre-defined schema, with MQTT topic stored in a column called topic.

The filters are, by default, defined as _measurement, topic and _field.

In Runtime, the TreeView Structure will use the MQTT Topic similar to what is done in MQTTspB ExternalTags.

As an example, let us assume we have an MQTT Client publishing to Topics:

Panel/Motor1/RPM
Panel/Motor2/RPM

The _measurement is defined as mqtt_consumer and _field is value.

Our TreeView Structure is illustrated below.

Aggregation Methods in Charts

This Provider can be used to plot Historized data in the Project’s built-in TrendChart component. To do so, just add the component into a Display (1) and add to the PenList (2) an asset from this Provider (3), as illustrated in the image below.

Now, using the Trend ControlName (4), we can access its properties in CodeBehind.

There is a property called GetSamplesMode that allows us to use different Aggregation Methods to the data to be displayed. The syntax used will be:

TTrendChart trend = this.CurrentDisplay.GetControl("trend") as TTrendChart;
trend.GetSamplesMode = "<AggregationMethod>;<AggregationInterval>";
trend.Refresh();

Where:

• AggregationMethod: One of the methods available in the list below:

For more information, please refer to the InfluxDB documentation.

• AggregationInterval: TimeSpan as a String, with syntax: ”hh:mm:ss”. E.g.: ”00:01:00” to represent one minute.

In this section: