Page History

Summary Information

Communication Driver Name: CanaryLabs Historian

...

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 Appendix.

...

Channel Configuration

Protocol Options

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

...

Anchor
Node Configuration Node Configuration

Node Configuration 

Station Configuration

The station parameters are:

• ServerName: Name 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 The options are:

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

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

...

With a Success! status message, you enable 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 others other two are detailed in the appendix Appendix.

...

Import Tool

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

This tool allows you to choose the 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 all the available data available in the CanaryHistorian database, or you can write the a Tag address directly in the Item field.

For a simple Tag, fill use the address with 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 the a name is valid and get the current value and quality.

...

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

For more information, please refer to the TagProvider document.

How to Configure

...

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:

...

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.

...

Anchor
Appendix Appendix

Appendix

CanaryLabs Configuration Procedure

Once you have the CanaryLabs Historiansoftware and the Canary Adminapplication installed, there are some permission configuration that are required in order you will need to configure some permissions for the connection to work. 

Admin Configuration

Open the Admin Tab.

...

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

...

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

...

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

...

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

...

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

...

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

Under Security > Settings,make sure the Security Enabled CheckBoxcheckboxis selected.