Summary Information

Communication Driver Name: CanaryLabs Historian

Current Version: 1.0.0.1

Implementation DLL: T.ProtocolDriver.CanaryLabs.dll

Manufacturer: CanaryLabs

System Requirements

The following requirements must be matched in order to use the CanaryLabs driver:

• Product version 9.1
• .Net Framework 7.1 or higher

For more information on how to set up the CanaryLabs Environment, see the Appendix.

Channel Configuration

Protocol Options

Protocol options are not used in this driver. The remaining channel configurations are the same as in the reference guide.

Node Configuration 

Station Configuration

The station parameters are:

• ServerName: The name or IP address of the machine running the CanaryLabs Historian. (If the service is not running in the default port, the syntax should be: ?ComputerName?:?PortNumber? or ?IpAddress?:?PortNumber?)

• ClientID: Indicates the client identification that is used to make calls in the Canary service
• ConnectionType: Specifies the ConnectionType with the service

               The options are:

• • Anonymous: Connection using no credentials
  • UserName: Connection using a username/password that is defined in CanaryAdmin
  • Windows: Connection using Windows credentials

• UserName: The user name used for verification (Valid for the Username and Windows connection types)
• Password: The password used for verification (Valid for the Username and Windows connection types)
• Views: A list of views found in the specified ServerName. If the view is virtual, the Node will be Read-Only
• Dataset: The name of the dataset you will connect to. (Not available when the selected view is Virtual)

With a Success! status message, 3 features are enabled for this Driver:

1. Import Tool
2. Unified Namespace
3. Asset Modeling

The Import Tool is described in this section, and the other two are detailed in the Appendix.

Import Tool

You can automatically import the existing Canary Variables into your Project by clicking on the Import button.

This tool allows you to choose variables, from the list, that will be imported into your project; automatically creating the Tags and Communication Points.

Point Configuration

Address

You can use the Browse button to see the available data in the CanaryHistorian database, or you can write a Tag address directly in the Item field.

For a simple Tag, use the syntax: ?DatabaseName?.?VariableName?. E.g.: 

Or, you can create a Template (ex. Motor1 and Motor2), and input it into the Points list. Its members (ex. Temperature and RPM) will be mapped automatically. E.g.:

Use the Verify button to check if a name is valid and get the current value and quality.

TagProvider

This Communication Protocol supports the TagProvider feature, which is a tool that allows you to access your Communication Device Data Model without creating project Tags.

For more information, please refer to the TagProvider document.

How to Configure

To configure the CanaryLabs protocol as a TagProvider, navigate to Edit  >  Tags  > Providers, and create a new provider for the CanaryLabs protocol.

Configure the items under the PrimaryStation column the same way that was described in the Node Configuration.

Troubleshooting

The status of the driver execution can be observed through the diagnostic tools, which are:

• Trace window
• Property Watch
• Module Information

A status value of 0 (zero) means the communication was successful. Negative values indicate an internal driver error, and positive values are the protocol's error codes.

Appendix

CanaryLabs Configuration Procedure

Once you have the CanaryLabs Historian software and the Canary Admin application installed, you will need to configure some permissions for the connection to work. 

Admin Configuration

Open the Admin Tab.

Under Endpoints, select every checkbox, but do not change the port numbers.

Under Access, add the users that will be allowed to access the CanaryAdmin programs.

• Anonymous
• System
• Administrator
• Interactive
• Everyone
• ?Your User?.

Under Settings, make sure the checkbox for the Persist Last Connection is selected. 

Receiver Configuration

Open the Receiver Tab.

Under Endpoints, select every checkbox, but do not change the port numbers.

Sender Configuration 

Open the Sender Tab.

Under Configuration > Endpoints, select every checkbox, but do not change the port numbers.

Under Configuration > Access, add all the users that will be allowed to write in the Canary Historian. E.g.:

• Anonymous
• System
• Administrator
• Interactive
• Everyone
• ?Your User?.

Views Configuration

Open the Views Tab.

Under Configuration > Endpoints, select every checkbox, but do not change the port numbers.

Under Configuration > Access, add all the users that will be allowed to write in Canary Historian. E.g.:

• Anonymous
• System
• Administrator
• Interactive
• Everyone
• ?Your User?.

Under Security > Permissions, add the users for the Root path with the ReadWrite AccessType.

Under Security > Settings, make sure the Security Enabled checkbox is selected.