System Overview

  • updated 2 yrs ago

Powerpoint Overview

System Overview.pptx

Live Demo

Canary Installer

  • You may obtain the latest installer by contacting your Canary representative.
  • The installer is configurable so you can only install the pertinent Canary services based on the function of the machine (e.g. data logger, historian server, etc).

Example of data logger install


Example of historian server install


Canary Admin Application Overview

  • Launch from Windows Start menu - Canary > Canary Admin

The Canary Admin application visually organizes all Canary components installed on a server.  The main home screen of the application features a tiled grid, with each tile representing a different component. 


The top of the home screen is bordered by a yellow title bar.  This bar includes a '?' icon that will provide access to searchable help files, as well as a navigation tool for remote Canary Admin connectivity.  The currently connected Canary Admin service is displayed by default along with a down arrow icon.  Clicking the name of the server, often 'LOCALHOST' will allow the administrator to type in the server name or IP address of the machine they wish to connect to.  If required, a dialog displays to provide credentials. Once connected, the name will remain in the drop down.

Below the yellow bar is the menu bar which is used to navigate between open sub menus and the 'Home' screen.

Depending on your installation the components that are shown will likely be different than the reference image.  However, several will be universal.  These include 'Services', 'Messages', 'Licenses', and 'Admin'.

Each tile provides system admins with useful information from this screen.  This includes version numbers.  If there is a version mismatch between components, that tile's version info will be shown in red.

Clicking on any of the tiles will navigate to additional sub menus and provide the admin with more management tools.  When this occurs, the tile that has been selected will now appear on the main screen and a tab or bread crumb for that tile will be added to the top menu bar.  In the below image you can see that the admin is currently on the 'Services' menu and has also currently has the 'Messages' panel open in the background.  

Each individual tile screen follows a similar design scheme that is useful for navigation.

When a tile is opened a new navigation schema is introduced.  The bottom of the Canary Admin window now features a dark grey bar that provides any available navigation tabs.  The currently selected tab is bright blue in color.

If the current displayed tile screen has any sub menu navigation options, they will be displayed on the left side of the screen. In the example below, the tab 'Configuration' has been selected and shows two sub menus in the light grey bar on the left, 'Sessions', which is currently selected, and 'Settings'.

The 'Admin' tile can be used to configure remote administrator permissions.  

  1. Open the Canary Admin application
  2. Click the 'Admin' tile
  3. Configure the endpoints as required
  4. Net.TCP - Windows When connecting remotely to another Canary Admin Service this endpoint will be tried first using the local users windows credentials
    Net.TCP - Username If the windows credentials fail then the communication will fail over to allow the user to enter credentials for remote connection
  5. Use the 'Access' submenu to either specifically allow or deny users.  For example, you could allow Active Directory groups while still specifically denying a member of that group.
  6. Select the 'Settings' submenu and determine whether you wish to 'Persist Last Connection' for the Canary Admin remote session.  Enabling this feature will cause the Canary Admin application to recall and reconnect to the last remote session upon application launch.


Canary Historian

  • The Canary Historian can either be licensed for a specific number of tags or have the tag license removed for an 'unlimited' tag license.
  • Tag licenses are consumed by tags being logged to the system as well as by tags generated through the Calculation Service. Virtual Views and Asset Models do not consume tag licenses.
  • A tag's license can be revoked and applied to another tag by modifying data collection. Doing so does not purge the tag from the historical archive, but does limit clients from being able to query the tag or its historical record.

Axiom and the Excel Add-in

  • Canary Systems come with one Axiom license and one Excel Add-in license.
  • Both of these licenses are based on concurrent users and may be shared by multiple individuals as long as they are not active at the same time.

API Connector

  • The Canary System provides 25 concurrent API licenses free of charge. Should more concurrent license be required, contact your Canary representative. Additional licenses are free.

ODBC Connector

  • ODBC licenses are applied by Canary System on a one per server ratio. This allows for unlimited client queries without adding additional licensing.


How To License Your System

Licenses for the Canary System may be applied in the Licenses tile.  This can be done whether the machine has access to the internet or not.

Licensing with Internet Access

  1. Open the Canary Admin application and select the 'Licenses' tile.
  2. Find the 'ADD LICENSE THROUGH INTERNET' section on the right side of the screen.
  3. Enter the required information.
  4. Enter the Serial Number provided by your Canary representative.
  5. Select the checkbox for all purchased products of the Canary System. By default this would be Canary Historian, Axiom, Excel Add-in, and API Connector.
  6. Select 'GET LICENSE'. The 'License Key' populates automatically and now the selected products are accessible.

  1. Copy the License Code from the 'ADD LICENSE MANUALLY' window. This code is dynamic and will change.
  2. On a device connected to the Internet, navigate to canarylabs.com/support/license
  3. Enter the required information, including the Serial Number provided to you by Canary, the parts you wish to license, and the quantity. Select 'Submit'.
  4. A license key appears. Enter the License Key information in the 'License Key' field.
  5. Select 'Accept Key' The Canary product(s) are now licensed.

Services Tile

All Canary services may be controlled from within the Canary Admin application.  This convenient feature allows you to stop and start services without leaving the application as necessary.

You may choose an individual service to start or stop, or if necessary, you may use the 'START ALL' and 'STOP ALL' feature in the top right hand corner.


Messages Tile

Canary creates an audit trail of messages that can be viewed for up to one year or until the message log receives 500,000 entries.  These messages are reflective of the activity of each of the Canary services and can be used for troubleshooting.


Audit Overview

  • The Audit tab provides a real time feed of the messages
  • Column headers may be sorted by clicking on them
  • Filters can be applied using the 'FILTER' selection at top right
  • Messages may be exported using the 'EXPORT' selection at top right


Configuration Overview

  • The 'Email' submenu at left should be used to configure the Canary Admin to communicate to your SMTP server
  • Adjust the level of messages received by using the 'Verbosity' submenu


Reply Oldest first
  • Oldest first
  • Newest first
  • Active threads
  • Popular