How To Install and Configure the ODBC Client (version 24)

The Canary ODBC Client is used for generating reports using SQL queries and populating data from the Canary Historian into SQL databases. It is a server/client based architecture in which the ODBC server component must be installed/licensed on the Historian machine and the ODBC client installed on the SQL server wishing to query the Canary database.

Licensing is server based and can be managed through the Canary Admin>License Tile. The ODBC client does NOT need licensed.

This article will take you through the basic steps of installing and licensing the ODBC client. If the server component is already installed and licensed, skip to Installing the ODBC Client.

Installing the ODBC Server

Run the CanaryInstaller-*.*.*.exe and select ODBC as a feature to install along with the Historian and any other services that are needed on the Historian server.

Licensing the ODBC Server

1. Open the Canary Admin and select the License tile.
2. If the server has internet access, fill out the necessary information underneath ADD LICENSE THROUGH INTERNET. Otherwise, you may license your product by visiting https://canarylabs.com/support/license and selecting the LICENSING INFO tab. See How to License the Canary System for more details.

   

3. Check Canary Historian ODBC and click GET LICENSE.

Installing the ODBC Client

The ODBC client will need to be installed on the SQL server wishing to query the Historian. (The client can also be installed on client machines wishing to pull data into 3rd party applications, such as Power BI or Excel.) The client installs as a System DSN (Data Source Name).

1. Run the CanaryInstaller-*.*.*.exe and select the ODBC Client to install.

   

2. Open the ODBC Data Source Administrator (32 or 64-bit, depending on the application using the Canary ODBC client) and select the System DSN tab. Click the Configure... button.
   
3. Set the Server IP to the IP address of the Canary Historian server or use the server name.
   

By default, the ODBC client makes an anonymous connection to the Views service. This requires the Anonymous provider be enabled in the Identity service.

If the Anonymous provider is NOT enabled, an API token must be created and passed into the ODBC client configuration.

1. Create an API token in the Identity service.

   

2. If Tag Security is enabled within the Identity service, the Canary user linked to the API token must be given Read permissions within the Identity tile>Security>Tag Security screen.

   

3. Enter "apitoken" for the Username and paste the token into the Password field.

   

   ---

4. If wishing to encrypt the traffic, click the 'Options...' button and select 'Require SSL'.

   

5. On the Historian Server, the following registry settings are needed along with the corresponding certificate files.