Difference between revisions of "Adding a computed measurement"

From Senfi Docs
Jump to: navigation, search
Line 1: Line 1:
 
=== Pre-requisites ===
 
=== Pre-requisites ===
A computed measurement requires design in order for it to work correctly. If you have not designed your computed measurement yet, please read [[Computed_measurement|this guide]] first.
+
A computed measurement requires design and basic scripting in order for it to work correctly. If you have not designed or created a script for your computed measurement yet, please read [[Computed_measurement|this guide]] first.
  
You should also be similar with the concept of [[Measurement|measurements/metric/tag]]. Please read [[Concepts#Measurement.2C_Metric.2C_Tag|this section]] first.
+
You should also be similar with the basic [[Measurement|measurements]] and its concepts. Please read [[Concepts#Measurement.2C_Metric.2C_Tag|this section]] if you require a refresher.
  
 
+
You should
 
+
* Note down the source (input) measurements.
* [[Computed_measurement#Design|Design]] your computed measurement
+
* Note down the metrics you want to output.
* note down the metrics you want to capture.
+
* Decide on a set of tags to use or re-use. Make sure that there is a combination of tags that will uniquely identify the unit/device/equipment that outputs those metrics.
Decide on a set of tags to use. Make sure that there is a combination of tags that will uniquely  
+
* Have the computed measurement script ready.
 +
* (Optional) Have a set of test data for your computed measurement
  
 
=== Adding a New Computed Measurement ===
 
=== Adding a New Computed Measurement ===
 
  
 
# Login to the [https://ems.senfi.io/cms CMS]
 
# Login to the [https://ems.senfi.io/cms CMS]
Line 22: Line 22:
 
# Add metrics and specify the type of each metric.
 
# Add metrics and specify the type of each metric.
 
# Write the computed measurement script
 
# Write the computed measurement script
# Test the computed measurement (Optional)
+
# (Optional) Test the computed measurement  
 
# Save when done.
 
# Save when done.
  

Revision as of 16:53, 16 September 2019

Pre-requisites

A computed measurement requires design and basic scripting in order for it to work correctly. If you have not designed or created a script for your computed measurement yet, please read this guide first.

You should also be similar with the basic measurements and its concepts. Please read this section if you require a refresher.

You should

  • Note down the source (input) measurements.
  • Note down the metrics you want to output.
  • Decide on a set of tags to use or re-use. Make sure that there is a combination of tags that will uniquely identify the unit/device/equipment that outputs those metrics.
  • Have the computed measurement script ready.
  • (Optional) Have a set of test data for your computed measurement

Adding a New Computed Measurement

  1. Login to the CMS
  2. Go to the Computed Measurement tab
  3. Click the + button to add a new computed measurement.
  4. Give the measurement a descriptive name. This will be shown to users of the dashboard.
  5. Specify a measurement code.
  6. Select your Source Measurements
  7. Add tags.
  8. Add metrics and specify the type of each metric.
  9. Write the computed measurement script
  10. (Optional) Test the computed measurement
  11. Save when done.

Writing the Computed Measurement Script

Testing the Computed Measurement