How to Install Canary

Working on your first Canary install?  Start here.

Overview

The Canary System consists of three components, Data Collection, Data Storage, and Data Analytics. This guide will focus on the installation process for the first two components, data collection and storage. To collect data, we will use an OPC UA Server and implement Store & Forward by installing the data collector on the same machine as the OPC server. The Canary Historian is used for data storage and will be installed on its own server. You can find additional guides in the Canary Knowledge Base for logging data via OPC DA or MQTT Sparkplug B.

Architecture

A typical architecture example for a single Canary System logging data from an OPC Server.

Best practice is to install the Canary Collector and Sender Service local to the OPC Server and to provide a standalone server or VM for the Canary Historian.

The Canary System is comprised of many pieces of software that are all designed to work together. Each component has  specific roles and permissions.

System Specifications

The Canary Historian must be installed on a Windows server running at least Windows 7 or a VM running Server 2012 or newer.  It is recommended that the server have the following resources as a minimum:

·      4 Core 2.20 GHz Processor

·      16 GB Memory

·      500 GB HD

Depending on the number of tags you wish to store, how often those tag values update, and the client demands on the server, you may need to scale these resources.  Typically, we suggest these benchmarks based on TVQ update frequency:

 *Storage capacity will change based on data types stored, desired historical availability, and other varying factors.

Software Installation

Historian Server

Download and the following software on the Canary Historian:

·       CanaryHistorian-x64-20.1.*.exe

·       Axiom-x64-20.1.*.exe

Begin by installing the CanaryHistorian-x64-20.1.*.exe first.  

Right-click on the executable and select “Run as Administrator”

The installer will require you to also install Microsoft Visual C++ 2015 Updates as well as .Net Framework 4.7.x if they are not already present

After accepting the Terms of Agreement, select only the following components for installation:

·       Canary Administrator

·       Canary Enterprise Historian

Click “Next” to complete the installation.

To install the Axiom Core on the Historian Server, right-click on Axiom-x64-20.1.*.exe and select “Run as Administrator”.

Follow all installer instructions andcomplete the installation.

Restart the server.

OPC UA Server

Download and install the following software on the OPC UA Server:

·       Collectors-x64-20.1.*.exe

Right-click on the executable and select “Run as Administrator”

After accepting the Terms of Agreement, select only the following components for installation:

·       Canary Collectors

·       OPC

Click “Next” to complete the installation.

Licensing the Historian Server

 

To license, you will need a serial number.  The S/N should be in the following format:

C007-XXX-XXXX

Access the Canary Historian server.

Launch the application “Canary Admin”.

Select the Licenses Panel.

The main window will display any licenses that you currently have.  To the right are two windows, the top window is for manually licensing if you do not have internet access, the bottom right window is for adding license with internet access.

 

Adding Licenses Automatically (requires direct internet access)

Fill out the fields for “Name”,“Company”, and “Email” based on how you would like the software licensed.

Insert your serial number in the“Serial Number” field.

Select a Quantity of “1”.

Check the boxes for “Axiom” and“Historian”.

In the bottom right corner, select “Get License”.

Your system is now licensed.

 

Adding Licenses Manually (no internet access required)

Copy the License Code.

Navigate to www.canarylabs.com/support/license on a resource that has internet access (cell phones will work).

Fill out the fields for “Name”,“Company”, and “Email” based on how you would like the software licensed.

Insert your serial number in the“Serial Number” field.

Insert the License Code.

Select a Quantity of “1”.

From the License Products drop down select “Axiom” and “Historian”.

Click “Send”.

You will be provided with a License Key.  Copy this key into the License Keybox on the Canary Admin’s Licenses panel.

Click “Accept Key”.

Your system is now licensed.

Configuring OPC UA Logging Sessions

Create a Logging Session

From the OPC Server, launch the application Canary Admin.

Open the OPC Collector panel.

Select “Configuration” from the menu across the bottom of the Canary Admin.

The Configuration page features three windows, “Sessions”, “Session Settings”, and “Tags”.

From the Sessions window, select “New Session”.

In the “Session Settings” window, create a Name for the session.

Determine which historian or historians you wish to push data to and enter those names in the “Historian” section.  This can be either the machine name or the IP address.  If logging to multiple historians, separate their names with a comma. (ie Historian1, Historian2).

Select the DataSet you wish to log to from the drop down menu or enter the name of the DataSet manually that you wish to create.

“New File” is used to create a logging file revision.  It instructs the Historian to release any tag licensing for tag names that do not appear in this new session.  You may leave it unchecked for a new session, but should always be checked it if you are removing tags from a previous session.

Enter the machine name or URL for the OPC server.  If you are local to the machine, you may also use “localhost”.

Specify the host port.

Apply your changes in the red bar at the top of the page.

 

Configure Tags

Click “Browse” in the Tags window.

From the popup window, browse the OPC server and highlight the tags you wish to log by using the mouse and the Shift key.  Once selected, you may choose which properties you would like to include by checking the available properties listed in the “Properties” window.

Use the “Apply” button to select the tags you wish to log.  When finished, click “OK”.

A table has been created that will list all tags you have selected.  The first column of the table is empty.  Clicking on a cell in the first column will highlight the entire corresponding row.

When a row is selected, you may edit each cell within the “Tag Settings” window.

You can also delete an entire row by first selecting the row, and then clicking “Delete” from the top right corner of the “Tags” window.

Clicking the “New” button will create a new row which can then manually be configured within the “Tag Settings” window.

You may also use the “Tag Properties” feature to add metadata or property columns.

Once clicked, a side window appears that features a drop down of standard properties.  You may select and add these properties or manually enter your own desired properties. Once your property list has been created, click “Apply”.

You must finalize all additions and modifications by clicking the Apply button within the red bar at the top of the page.

 

Create Groups

You can create multiple logging groups within a single session by using the “New Group” button within the “Sessions” window.

Clicking “New Group” will create another group within the session.  When the group is selected, you may edit its Name, Sample Interval, Deadband Type, and choose to Normalize Time in the “Group Settings” window.

Finalize all modifications by clicking “Apply” at the top of page.

 

Start/Stop Logging Session

To begin logging data, click on the “Status” on the bottom menu.

You will see a grey panel for each session you have created.  

Click the play icon to begin logging. The panel will turn blue when logging has begun.  To stop the session, click the stop logo.

Clicking the panel once will highlight it yellow and display a session summary in the “Session” window on the bottom left of the Canary Admin.

Double clicking the session panel will show all logging groups within the session.

Double clicking a group will allow you to visually monitor the logging session as well as filter the columns that are shown using the “Modify Grid” feature.

Configuring OPC DA Logging Sessions

 

Create a Logging Session

From the OPC Server, launch the application Logger Administrator.

A logging session will automatically cache data to local memory.  To adjust the memory threshold, change the value in the “Minimum available memory” field.

Click “File” and select “New Log Session”

A new tab named “Untitled” will be created next to the “General” tab.

Name your logging session in the “Name” field.

Enter the machine name or IP address for your Canary Historian in the “Historian Computer” field.  If logging to multiple historians, separate their names with a comma.  (ie Historian1, Historian2).

“Create new file when logging starts” is used to create a logging file revision. It instructs the Historian to release any tag licensing for tag names that do not appear in this new session. You may leave it unchecked for a new session but should always be checked it if you are removing tags from a previous session.

Edit and Create Tag Groups

Group 1 has automatically been created and a tab for Group 1 is visible under the “Name” field. To create additional groups, right-click the Group 1 tab and select “Add New Group”.

Edit the “Group Name” as needed.

Use the “Computer” field to enter the machine name or IP address of the OPC Server if not local.  If local, leave blank.

Select the OPC Server of choice by clicking the button with three dots.

Once the OPC Server is selected, you can browse for tabs by using Ctrl+B or right-clicking within the main dark grey window and selecting “Browse OPC Server”.

A new “Add Trends” window will appear.  

First, use the drop down at the top of the window to select the DataSet in which you wish to log data.  Note, if no DataSets are visible, you will need to close the “Add Trends” window and create a DataSet on the Canary Historian Server.

You may choose to prepend the tag name with it’s browse path by selecting the “Prepend browser path” box.

Browse through the OPC Server structure in the “Server Nodes” window to find your tags. Once tags are visible in the window on the right, select the tags you wish to log using the mouse and Shift key.

Use the “Apply” button to select the tags you wish to log.  When finished, click “OK”.

A table has been created that will list all tags you have selected.  The first column of the table is empty.  Clicking on a cell in the first column will highlight the entire corresponding row.

Any cell may be edited by double-clicking on the cell.

You can also delete an entire row by first selecting the row, and then pressing the delete key or by right-clicking and selecting “Delete Selected Trend(s)”.

Once all tags are selected you can apply your changes at the top of the Logger Administrator by clicking the“Apply” icon.

Next, save your logging configuration by clicking the “Save” icon.

Finally, click “Start” to log data.