Versions Compared

Old Version 3

changes.mady.by.user admin

Saved on

compared with

New Version Current

changes.mady.by.user admin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page properties
hiddentrue
idconnector-metadata


Property

Value

Sector

Historian & Databases

Group

Process Historians

Connector

InfluxDB Database

Name

InfluxDB



InfluxDB databases

  • Name: InfluxDB
  • Version: 1.0.0.0
  • Protocol: Proprietary
  • Interface: TCP/IP
  • Runtime: .NET 4.8 (Windows)
  • Configuration:
    • Devices / Protocols

Table of Contents
maxLevel2

There are 2 independent ways to use this protocol, using a TagProvider or as a DeviceChannel in the Module Device.

  • TagProvider: allows to use the database addresses directly without creating any Tags nor mappings in the Project.
  • DeviceChannel: create Project Tags and map to the database addresses, allowing more control over names and data blocks. Use the Solution Import Tags to setup automatically the mapping.

This document has only the specific information about the device connection settings and its address syntax.

Refer to the User Guide for more information on the Device Module or on UNS TagProvider Services (Reference).

On this page:

Table of Contents
maxLevel3
minLevel2
stylenone

Summary

Overview

Communication Driver Information

Driver name

InfluxDB

Assembly Name

T.ProtocolDriver.InfluxDB

Assembly Version

1.0.0.0

Multiplatform

False

Supported versions

InfluxDB 2.x

Manufacturer

InfluxData

Supported protocols

Proprietary for custom, non-standardized communication and REST API for HTTP-based standardized interaction.

PC Requirements

Ethernet port


Channels

Channel Configuration

There is no configuration settings necessary for this interface.

Nodes


Node Configuration

PrimaryStation or SecondaryStation

Thestationparametersare:

  • IPAddress:InfluxDBDatabaseServerAddress.Defaultvalueislocalhost.
  • Port:InfluxDBDatabaseServer PortNumber.Defaultvalueis8086.
  • ConnectionType:SpecifiestheConnectionTypewiththeDatabaseServer.Optionsare:
    1. UserCredentials:Connection willbe made usingUserNameand Passwordvalidation.
    2. Token:Connectionwillbemadeusingsecuritytokenvalidation.
  • UserName:UserName usedtoverifycredentials.Validfor UserCredentialsConnectionType.
  • Password:Passwordused toverifycredentials.ValidforUserCredentialsConnectionType.
  • Token:Tokenusedtoverifycredentials. ValidforTokenConnectionType.
  • Database:Databaseinwhichclientwillconnectto.
  • Bucket:Bucketinwhichclientwillconnectto.IfConnectionparametersarecorrectlyfilled,youshould see all buckets available in the ComboBox DropDown.
  • Organization:Organization definedforuserinInfluxDBDatabaseServer.


Note
Alwaysuse theTestbuttontoverifytheconnectionstatus.


Points Configuration

Theaddressparametersare:

  • Measurement:MeasurementinwhichTagWillbeassignedinInfluxDBTable.
    • IfPointisaProjectTagandmeasurement fieldisblank, MainTagName(Name definedin Edit → Tags>Objects)willbe used.
    • IfPointiffromTagProviderand measurement fieldisblank,ProviderName willbe used.
  • Field:FieldinwhichTagWillbeassignedinInfluxDBTable.Ifblank,TagAttibutewillbeused(element of default types, like Integer, Decimal, etc).
  • UseTemplateAsCustomColumns:FlagindicatingifTemplateswhichTagbelongstowillbeusedas Custom Columns in InfluxDB Table. Default value is true.

IfPointisfromTagProviderandCheckBoxistrue,aColumncalledTagProviderPathwillbecreated with the path leading to the TagProvider asset.

  • AdditionalCustomColumns:ListofUser-DefinedCustomColumns,separatedbycomma,tomapa variable in the Database.

Syntax: <ColumName>= <ColumnValue>

Youcanadd,removeoreditcustomcolumnsinthedialogwindowat’+’button.


Example

Toillustratetheresultofasucessfullconfigurationwewillmakethefollowingassumptions.

  • TheTagisstructured as:

Panel1 [Tag of Template 'Panel']

Motor1 [Tag of Template 'Motor']

AMP [Final Attribute of 'Double' Type]

RPM [Final Attribute of 'Double' Type]

Motor2 [Tag of Template 'Motor']

AMP [Final Attribute of 'Double' Type]

RPM [Final Attribute of 'Double' Type]

TheAddressisconfigured as:

    1. Measurement:Panel1.
    2. Field:””.[Leaveitblanksoourattributesareused].
    3. UseTemplateAsCustomColumns:true.
    4. AdditionalCustomColumns:Owner=PC1.

Thisconfiguration willresult inthe followingTable insideInfluxDB:

Reading Data

ToReadbackthesevalues,allyouhavetodoisuseanotherTag,ofsame "Panel" Templateanduse the same Custom Column Configuration.

Working with Arrays

WhenTagAttributeisArray,anewcolumncalledArrayIndexwillbecreatedandpopulated with the indexes. An example is illustrated below:

Troubleshoot

The status of the driver execution can be observed through the platform built-in diagnostic tools. Refer to Devices - Using Diagnostic Tools.

In this section

:

...

Page Tree
root@parentspaces93DRAFT