Installing the Canary System (version 23)

The same installation program is used for all parts of the Canary System.  Typically, different modules are installed based on the purpose of the server.  These purposes usually are:

• Data collection
• Data storage and contextualization
• Client tools for reporting

A silent install option is available upon request.

Data Collection Installation

Data collection from a data source involves the following components and is recommended to be done on a separate server or VM than the Canary Historian itself.

1. Use the received download link to download the Canary Installer from a Canary representative.
2. Run the file 'CanaryInstaller-*.*.*.exe' with elevated privileges.
3. Select the system modules you desire to install and deselect modules not appropriate for the desired solution.  You must install the following:
   • Canary Admin Service (required)
   • Store & Forward (required)

      Note, some components will not be able to be deselected as they are required based on other components that are currently selected (e.g., 'Sender' and 'Canary Admin Service/Client' are required for 'Store & Forward').

4. You should then choose which of the Canary Data Collectors are appropriate for your use case and install them accordingly:
   • OPC DA
   • OPC UA
   • MQTT
   • CSV
   • SQL
   • CygNet
5. Select 'Install' and complete the installation.
6. When the status bar is solid green and the 'Success' message appears, the installation is complete. Note, Canary will automatically stop and restart its services which will cause a pause during the installation. This is normal.

Above is an example of an install specifically for OP UA and MQTT data collection.  

Canary Historian Installation

1. Use the received download link to download the Canary Installer from a Canary representative.
2. Run the file 'CanaryInstaller-*.*.*.exe' with elevated privileges.
3. Select the system modules you desire to install and deselect modules not appropriate for the desired solution. Typically, the following modules are installed on a dedicated machine for the Canary Historian:
   • Historian
   • Canary Admin Service
   • Sender
   • Receiver
   • Virtual Views
   • Calculation Server
   • Events
   • Axiom (refers to the Axiom Core, not an Axiom client)
   • Publisher

     Note, some components will not be able to be deselected as they are required based on other components that are currently selected (e.g., 'Store & Forward' will remain selected when the 'Sender' is selected).

4. Select 'Install' and complete the installation.
5. When the status bar is solid green and the 'Success' message appears, the installation is complete. Note, Canary will automatically stop and restart its services which will cause a pause during the installation. This is normal.

Above is an example of the recommended modules for a Canary Historian server with data collection occurring remotely. 

Client Tool Installation

Data queries can be made via the Excel Add-in client, the ODBC client, and the Axiom client tools.  Only Excel Add-in and ODBC require installation.  Axiom runs with a web browser and does not require installation.  The Axiom component listed under Historian Server refers to the Axiom Core that needs to be installed as part of the historian server.

1. Use the received download link to download the Canary Installer from a Canary representative.
2. Run the file 'CanaryInstaller-*.*.*.exe' with elevated privileges.
3. Select the system modules you desire to install and deselect modules not appropriate for the desired solution.  Choose from the following:
   • Excel Add-in
   • ODBC Client

      If installing the ODBC Client, make sure that the module 'ODBC' has been installed on the historian server.

4. Select 'Install' and complete the installation.
5. When the status bar is solid green and the 'Success' message appears, the installation is complete. Note, Canary will automatically stop and restart its services which will cause a pause during the installation. This is normal.

Modifying the Installation

Should changes need made to a current Canary install, follow these steps.

1. Run the file 'CanaryInstaller-*.*.*.exe' with elevated privileges.
2. Select the system modules you desire to install and deselect modules not appropriate for the desired solution.
3. Select 'Repair/Change' and complete the installation.
4. When the status bar is solid green and the 'Success' message appears, the installation is complete. Note, Canary will automatically stop and restart its services which will cause a pause during the installation. This is normal.

Uninstalling Components

Should components need removed from a current Canary install, follow these steps.

1. Run the file 'CanaryInstaller-*.*.*.exe' with elevated privileges.
2. Select only the system modules you desire to uninstall.
3. Select 'Uninstall' and complete the installation.
4. When the status bar is solid green and the 'Success' message appears, the installation is complete. Note, Canary will automatically stop and restart its services which will cause a pause during the installation. This is normal.