Page History

Overview

FrameworX

The platform includes enhancements specifically designed to leverage Canary

History

Historian, a time-series database that provides high speed performance and friendly configuration tools.

Canary Historian Integration features

This integration includes:

Native Solution Historian: Canary Historian embeds in the platform easily as if it were a native tool. Solutions can use it in conjunction with the

exhisting build

existing built-in SQL Historian.
Free 100 Canary Points

: The first 100 Canary Historian points are included free of charge. Upgrade options are available for larger systems.
Create Canary Points directly at Designer:

no

No need to use or

lear

learn additional tools other

tools

than FrameworX Solution Designer.

Simplified

license management

License Management: Request license upgrades directly from FrameworX.
Out of Box TrendChart Monitor:

zero

Zero configuration is required

,

; an out-of-the-box TrendChart monitor for Canary Historian tags.
Edge Data Collector:

any

Any of the 70+ communication protocols is now a Data Collector for Canary Historian, with Store and Forward support.
Canary Driver and TagProvider: Connection with other Canary Historian instances, either mapping to Local Tags

,

or using dynamic referencing, with

Tunneling

tunneling features included.

On this page:

Table of Contents

maxLevel	3
style	none

About Canary

What is the Canary Historian?

Canary Historian is a time series database built for industrial automation. A It is a high-performance historian designed for large-scale applications that handle large substantial volumes of data writing. . It provides scalability and enables efficient management of high-volume write operations. Its design supports extensive dataset analysis within time contexts for effective trend identification, avoiding the constraints of relational schemas. Canary's architecture balances speed, accuracy, and volume, making it an ideal choice for specialized time series data management needs.

When to use Canary Historian or the built-in SQL Historian?

Solution Solutions can use both system systems concurrently. Performance on SQL storage increase has increased over the years, but can't it cannot reach the speed and storage capabilities that a database specifically designed for time-series data, like Canary, can deliver. Use Canary for the tags that requires require high speed and/or long time retention. Keep those in SQL where the ones that the retrieval and storage requirements can be delivered managed with the SQL storage.

Tip

title	Using Multiple Historians

Trend Charts on Displays, Scripts, and all FrameworX other modules uses use data abstraction layers, so there is are no changes on to the remaining configuration of the Solution, solution when you decide to modify the configuration of Tags tags from using one Historian historian to another.

Installation

The software platform should be installed and, where when necessary, licensed.

Licensing Canary Historian

Go to Solution Manager and navigate to 'Your License / License Information / Canary Historian'.
Request a license by clicking 'Request License'. Fill in the 'Name', 'Company', and 'Email' fields to generate the Serial Number, then click 'Request'.
Open the Canary Admin Tool, proceed to 'Home / Licenses', and select 'Local / Add license through the internet'. Enter the required details ('Name', 'Company', 'Serial Number', 'Email', 'Quantity') and check the 'Canary Historian' option. Click 'GET LICENSE'.
Upon receiving the License Key, confirm by clicking 'OK'. To verify the license, navigate to 'Solution Manager / Your License' and refresh the information by clicking the 'Refresh' button. The message should change to "Canary Historian is licensed."

Canary Admin Tool configuration

Set up the Sender's EndPoints and access the Receiver's EndPoints in the Canary Admin Tool.

Creating Solution and Enabling Canary Historian

In Solution Manager, create a solution (file .dbsln) and open it in the Solution Designer.
Access 'Solution / Settings / Target Platform and License', enable Canary Historian, and select the desired tag range (500, 1500, 5000, 15000, or Unlimited).

Done! The initial configuration is finished!.

Info
This integration includes support specifically for Windows, as Canary Labs is a Windows-only integration.

Modules' Connections

Canary Historian can be used in different ways by the various Framework Modules modules.

Historian: Uses Canary as a Storage Location for archiving or retrieving Tags historianHistorianTags.

Devices: Read and Write to external Canary Historian Server with the Device Module.

TagProvider: Map Map external Canary Historian Server to dynamic integration of its data and structures.

Displays and Scripts: No custom configuration is required, TrendCharts will use Canary Historian Data Automatically if available..

Historian Module

Configuring Historian using Canary

At Historian → / StorageLocations, include Canary as a Storage LocationStorageLocation.
at At Historian → / HistorianTables, define virtual tables to will control writing and retrieving data.
Map the tags at Historian → / HistorianTags.

→ Read about the Historian Module, or Read about the specific Canary Communication driver.

Device Module

Configuring Devices using Canary.

Navigate to 'Devices / Channels' and select a protocol (Canary) to create a Channel.
Navigate to 'Devices / Nodes', create a Node linked to that Channel.
Map the tags at 'Devices / Points'.

→ Read about the Devices Module, or Read about the specific Canary Labs Communication driver.

TagProvider Module

Configuring TagProvider using Canary.

At Unified Namespace → / TagProvider Connections, Crete create a connection to a Canary Historian.
At Unified Namespace → / AssetTree, add Canary data or strutting in the AssetTree.
Use Canary data in any module using the syntax Asset("<AssetPath>")

→ Read about Unified Namespaces

→ , or Read about the specific Canary Labs TagProvider

Displays and Scripts

Modules

Displays and Scripts, with not addition with no additional configuration, will query Canary Historian , in when using Tags tags that were previously connected with Canary using the Historian Module.
Examples of automted the automated usage:
In Displays TendCharts. See TrendChartsTrendChart Control.
In Displays, using the PlayBack feature .See PlayBack example.In Scripts, using the Historian .Historian Tables method to query data. See Historian Runtime Attributes.

CanaryLabs Configuration Procedure

Once you have the CanaryLabs Historiansoftware and the Canary Adminapplication installed, you will need to configure some permissions for the connection to work.

Admin Configuration

Open the Admin Tab.

Image Added