How to Configure a Node Device (version 23)

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

updated 1 yr ago
2replies

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.

For troubleshooting purposes, click the 'Logs' tab on the left and select the row of the appropriate node.

Central Admin

- timothy_vertin
- 1 yr ago
- Reported - view
Is there any way a modbus JSON file can be posted that is filled out as an example. With a variety of actual (example) MODBUS registers and canary tags? I have a MODBUS register map but it isn't clear how to enter them into JSON file. This would be a huge help. Cheers!
- smason
  
  1 yr ago
  
  Reported - view
  Hi timothy. vertin , I know you were able to get this running but I wanted to post this anyway. Attached is an example sent to us from one of our partners at AP4. A few things you will find in this template:
  
  This file is configured to record data from the Alstom BlueLine Control System using Modbus TCP
  
  The template reads data from 3 devices ( ME01 Modbus TCP Bus Couplers).
  
  Analog values are determined to be bad quality if the Modbus Register Value is Odd
  
  If the Modbus Register Value is even, then the template transforms the register value to the Engineering Value.
  
  Please note, some of the information in the tags may need to be re-arranged to display better in Axiom.
  
  SFDL_1_ME01_Collector.json