Overview
This page provides information about configuring the CanaryLabs ExternalTags in your software. By establishing this connection, you can seamlessly integrate and visualize data from CanaryLabs in real-timeThe Canary Labs TagProvider integrates and visualizes real-time data from Canary Labs without manual tag creation. Configure a connection to access data directly, enabling exploration and analysis within the Unified Namespace. This TagProvider enhances data accessibility, providing a streamlined method for incorporating Canary Labs data into applications.
On this page:
| Table of Contents | ||||
|---|---|---|---|---|
|
Configuration
To set up CanaryLabs as an ExternalTags sourcea new TagProvider connection navigate to Unified Namespace/TagProvider Connections and press the add button to open the New TagProvider Connection dialog. You can also create your TagProvider Connection directly from the AssetTree. To do this, navigate to Unified Namespaces → ExternalTags Sources and select the CanaryLabs Communication Driver option.Namespace/Assets Tree and press 
to open the New TagProvider Connection dialog. In the configuration dialog, select the Canary Labs Driver on the Provider field and insert the required connection parameters. After that, press the Ok button to finish the provider configuration, and it will create a folder automatically in the Assets Tree (Unified Namespace / Assets Tree).
Connection Parameters
Field | Description |
|---|---|
Provider | Specifies the system the TagProvider will interface with. In this case, it interfaces with the Canary Labs Communication Driver. |
Access Mode | Determines permissions for interacting with tags. Read allows data reading. Write permits data writing. ReadWrite enables both reading and writing. |
Name | User-defined name for the TagProvider instance. Identifies the specific configuration in the system. |
Description | Explains the TagProvider's purpose or the systems it interfaces with. Provides context for its usage. |
ProtocolOptions | Defines specific communication settings for the connection to the device. |
TagPropertiesCommunication | Determines whether to include tag properties in communication. |
Connection | Displays the connection string used to connect to the Canary Labs server. Defines connection settings for the Canary Labs server, including server name, client ID, connection type, username, password, view, and dataset. Make sure to test the connection with the Test button once you add all the information. |
Field | Description |
|---|---|
Server Name | Specifies the server name where the Canary Labs Communication Driver is hosted. |
Client Id | Unique identifier for the client connecting to the Canary Labs server. |
ConnectionType | Defines the type of authentication used for the connection. Options include Anonymous, Windows, and Username. |
Here's a detailed breakdown of the configuration fields:
Server Name: Enter the name or IP address of the CanaryLabs server you wish to connect to.
Client Id: Input the unique identifier for the client application.
Anonymous: Allows connection without any specific authentication. Windows: Utilizes the credentials of the Windows user. Username: Requires a specific username (and potentially a password) for connection. |
UserName |
Password: If the 'Username' option is chosen in 'ConnectionType,' input the corresponding password here.
Specifies the username for authentication if the ConnectionType is set to Username or Windows. | |
Password | Specifies the password for authentication if the ConnectionType is set to Username or Windows. |
Enable Backfill Insert | Enables the backfill insert feature, which allows for historical data to be inserted into the database. |
Toggle this option if you wish to retrieve historical data from CanaryLabs, filling any gaps in the data timeline. |
View |
Dataset: Choose the dataset from CanaryLabs you wish to connect to.
Specifies the view name within the Canary Labs system to access the data. | |
Dataset | Defines the dataset within the Canary Labs system to retrieve data from. |
Test | Verifies the connection settings to ensure successful communication with the specified server. |
Connection Str | Displays the full connection string used to connect to the Canary Labs server. Provides a summary of all connection parameters |
. |
In this section
...:
| Page Tree | ||||
|---|---|---|---|---|
|