Sign in

Data Source - Canary Historian V24

Canary Historian V24

The Canary Enterprise Historian from Canary Labs is the platform that acquires and stores large volumes of data generated from process applications. Canary Labs released a new version of their Historian that requires a new connector as it is not backwards compatible with the previous versions.

Note: Canary has introduced a new .NET API in version 24 that uses gRPC, replacing the old WCF-based API. This means the old API won’t work with version 24 and thus our normal Canary data source will not work with version after V23. Please make sure to confirm the version of your Canary Historian to use the correct data source in Flow.

You can check out how to use the new API for data retrieval and storage on their GitHub page here. 

 

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

 

Screenshot 2024-07-19 at 12.47.27.png

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

Screenshot 2024-07-19 at 12.48.35.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).
  • Security Type (Dropdown)
 Locally (Anonymous) (With Anonymous login enabled) or Secure (Token Based). The Local Historian option also caters for Anonymous connections with the default API key generated in Canary for Anonymous login. If the Security Enabled connection is selected, the Identity API Token field will be visible. A custom generated API token against a specific user can now be used to connect to the Historian.
  • Maximum Concurrent (Int)
 Maximum concurrent connection to connect to the Historian to retrieve data, default 4. Canary by default will license up to 25 API connections. 
Note: Flow will utilize one of your client connections to connect to your Canary Historian.
Press the test button to test the connection to the Historian. Make sure that your Data source is deployed before trying to test the connection. Flow will assign the data source to your default Platform and deploy it automatically after you save your data source configuration.
Screenshot 2024-07-19 at 13.06.49.png

Security Modes

Flow currently supports to connect to Canary via an API token. Two types of token authentication is supported, Local (Anonymous) or Secured (Token Based).

 

For Local Authentication, ensure that Canary is configured to allow Anonymous connections. This can be confirmed by accessing the Identity Tile in the Canary admin tool. Under Providers, ensure the option "Enable Anonymous" is enabled:

Screenshot 2024-07-19 at 13.11.15.png

This will utilise the default API token generated by Canary for the Anonymous Canary User account. API tokens are configured/viewed under the  Identity Tile, Security and then select the API Token Option:

Screenshot 2024-07-19 at 13.13.31.png

 

For Secured Connections, a new API token would need to be created and linked to an user account to allow a secured connection:

Screenshot 2024-07-19 at 13.16.51.png

The new API token can be copied;

Screenshot 2024-07-19 at 13.18.40.png

and pasted into the "Identity API Token" property on the data source configuration:

 

Screenshot 2024-07-19 at 13.20.12.png

 

Migrating from a pre V24 Historian

If this is not a new V24 Canary Historian install, but an upgrade from a previous version, you might have already configured a Canary data source in Flow. You can migrate the old data source connection to utilise the new V24 data source for all your configured tags.

 

This can be done misrelating the "Migrate" option on the previous configure data source by a right click command on the data source:

Screenshot 2024-07-19 at 13.25.41.png

The migrate option will only be available if the new V24 module is present in your instance.