RMS Monitoring templates

Summary

Monitoring templates feature let's you create your own custom monitoring templates, where you can easily monitor those parameters that are important to you.

Overview

1. By clicking on + ADD you will be to create your own custom monitoring template
2. Here, on template's action you can:
   1. Assign new devices to the monitoring template and view which devices are currently using the selected monitoring template.
   2. Modify the selected monitoring template.
   3. Delete the selected monitoring template.
3. The name of your monitoring template
4. Shows which RutOS API version the template is using.
5. Displays the devices assigned to the template.
6. Shows which parameters are being monitored on the template.
7. Monitoring template's creation date.

Create new monitoring template

To monitor your own desired parameters, you firstly need to create a new monitoring template which will collect data from those selected parameters.

1. Click on + ADD button in the top of Monitoring templates page.
2. In the next window, select the RutOS/TSWOS API version (based on device's firmware that will be assigned to this template) your monitoring template will be using. You can also choose to copy monitored parameters from your already existing custom monitoring template.
   
3. After pressing next, you will be redirected to paramater selection. All parameters belong to their specific configuration section and some parameters even have their own sub-paramater values.
   
4. To test the output/values of paramaters you'd like to monitor, use TEST ENDPOINT functionality:
   1. Select the device on which you are testing you custom monitoring template:
      
   2. Click TEST to get the output from the desired configuration section endpoint:
      
   3. Once you get the values of monitored parameter test request, you can select them into your monitoring template. You can also check Raw Data tab if you're interested in getting monitoring data via RMS API, there the output is displayed in JSON format.
      
5. All selected parameters that you wish to monitor will be listed on the right side. You can choose up to 200 parameters.
   
6. On the right side, in selected parameters section, by clicking on edit icon, you can customize the monitored parameters name, default value (if no value is received from the device), and monitored parameter's description.
   
7. After configuring everything your monitoring template, click on SAVE on the right side.
8. Input the name for your new monitoring template, description and the default monitoring period which would be used for newly assigned devices.

Assigning new template

After the template has been created, you will need to assign it to desired devices and then enable its monitoring.

Templates can be either assigned from Monitoring template page or from Devices page by selecting desired devices and in top menu under Management selecting Manage monitoring templates.

Assigning from Monitoring templates page

1. In Monitoring templates page, on your newly created template, click on "+" icon:
   
2. Select devices on which the template will be assigned and click on Assign to confirm the changes:
   
3. However, you will still need to enable newly assigned template in order to monitor parameters. Please, go to step no. 5 on the next paragraph.

Assigning and enabling from Devices page

1. Select your desired devices in device table.
2. In the top menu under management select Manage monitoring templates.
3. Select Manage templates to assign or unassign templates on selected devices:
   
4. Select which template to assign/unassign and click APPLY to save changes:
   
5. Newly assigned template will appear in the Manage monitoring templates list, to monitor your devices using that template - you will need to enable it:
   
6. Click apply to save changes.

Viewing monitored data

You can view monitored data by going on desired device's Device details page, Monitoring History tab.