Sign in

Data Source - Canary Historian

Canary Historian

The Canary Enterprise Historian from Canary Labs is the platform that acquires and stores large volumes of data generated from process applications.

To create a connection to the Canary Data Source: Right-click on the Data Sources group, then click “Canary”, and then select “Canary Historian”.

DataSources-SelectCanaryHistorian.png

To successfully retrieve data from a Canary Historian data source, the following properties need to be set.

DataSources-CanaryDataSourceProperties.png

  • Name (String)
 Name to identify the data source.
  • Server (String)
 Location of the Canary Historian. This can be the local server name or the cloud hosted endpoint address (Server Name, IP Address or URL).
  • Historian Type (Dropdown)
 Locally hosted (With Anonymous or Local Security enabled) or Cloud based. The Local Historian option also caters for Anonymous or Security Enabled connections. If the Security Enabled connection is selected, the username and password fields will be visible.
  • Port (Int)
 Port number of your Canary Historian, default 55234.
  • Username (String)
 If security is enabled, supply your Username.
  • Password (String)
 If security is enabled, supply your Password.
  • Maximum Concurrent (Int)
 Maximum concurrent connection to connect to the Historian to retrieve data, default 4.
   
Note: Flow will utilize one of your client connections to connect to your Canary Historian.

Store and Forward Detection

At the end of every interval type, the Flow Data Source will query the Historian for the raw data for the relative time period. But what if the Historian is in Store and Forward mode? The default behaviour for Flow is to wait for the data to be available again for the period it is querying. 

 

On both retrieved measures and tags retrieving data from a Canary Historian, there is a property to enable/disable Store and Forward ("Detect SF"). This property is enabled by default.

Screenshot_2023-02-07_at_09.59.58.png

If enabled, Flow will wait at the specific point in time Store and Forward is detected and not move forward retrieving data.

Store and forward is detected by no end bound value retrieved from Canary together with a specific quality code form the Historian stating that the retrieved data point is "the last known available data" point.

 

See an example below: Data stopped Historizing just after 11:30am in the Canary Historian:

 

Screenshot_2023-02-07_at_11.53.15.png

 

The last time bucket available in Flow is the period from 11:25 am to 11:30 am (5 minutely interval type was used in this example)

Screenshot_2023-02-07_at_11.55.18.png

 A warning will also be logged in the Windows Event Viewer, stating that the measure is waiting as it detected a Store and Forward scenario. The measure will be placed on the quarantine list:

Screenshot_2023-02-07_at_11.56.59.png

 

Measures aggregating from tags will go into the faulted state. This can be seen on the activity of the measure:

Screenshot_2023-02-07_at_12.01.58.png

This is only available on the Canary Historian data source.