How to Configure a Node Device (version 22)

Knowledge Base / Version 22 / System Admin Duties / Central Admin

updated 1 yr ago

allen-bradley-collector-example.json modbus-collector-example.json siemens-collector-example.json

Install the Canary Updater service on the collector machine/node
Browse to https://[CentralAdminMachineName]:8443 and log in.
Select the 'Templates' tab on the left
Select the 'Add Template' button at the top-right of the menu
A browse window will appear allowing the user to search and upload the template of their choice. An example template for an Allen-Bradley, Modbus, or Siemens device can be located in C:\Program Files\Canary\Central Administrator\SampleTemplates on the Central Admin machine, as well as at the top of this article.
*NOTE: The majority of work involved in configuring the node is within creating these templates. By opening one of the example templates, the user can see the JSON structure that is used and how to add the tags the collector will subscribe to.
Once the template is uploaded, select the 'Nodes' tab on the left. A grid will display 'All Nodes' visible to the Central Admin. Select the row of the new node to which to apply the template to.
Click the 'Template File' drop-down menu to select the appropriate template. Any templates that have been uploaded will appear in this list.
Once the template has been selected, 'Template Variables' will appear for the user to configure. These variables are created within the template.json file and are useful if using the template for multiple devices. If no variables are defined within the JSON file, all parameters must be hard-coded within the template.
Click the 'PUBLISH' button. The Canary Updater Service on the device node will download, install, and configure the Canary services specified in the template file. It may take a few minutes after the template is published for the changes to be applied.
Verify data is logging by selecting the 'Store and Forward' tab on the left. The 'INPUT RATE' column will display the updates/sec that are being collected from the device. The 'OUTPUT RATE' column will display the updates/sec being sent to the historian or proxy.