Difference between revisions of "Adding a computed measurement"
| Line 27: | Line 27: | ||
=== Writing the Computed Measurement Script === | === Writing the Computed Measurement Script === | ||
| − | + | Fill in the script of your computed measurement in the '''Script''' editor. When you add a new computed measurement, a template script will be pre-filled for you. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| + | # Fill in '''init()''', the initialization function | ||
| + | # Fill in '''compute()''', the computation function | ||
| + | # Declare any global variables, if you script requires them | ||
| + | Tip: The script editor will interactively notify you of any syntax errors in your script | ||
| + | Note: You should not modify the function signatures of the initialization or computation functions. | ||
=== Testing the Computed Measurement === | === Testing the Computed Measurement === | ||
| − | + | # Enter sample measurement data in the '''Testing Value''' editor | |
| − | + | # Click the '''TEST''' button | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | After you click the TEST button, your script and sample data will be submitted and executed. The CMS will wait for up to 5 seconds for your script to execute, and the output data from your script, if any, will be shown in the '''Testing Output''' panel. | |
| + | Any console messages that your script calls will be shown in the '''Testing Console''' panel. | ||
Revision as of 09:12, 17 September 2019
Contents
Pre-requisites
A computed measurement requires design and scripting in order for it to work correctly. If this is your first time creating a computed measurement, 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 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
- Login to the CMS
- Go to the Computed Measurement tab
- Click the + button to add a new computed measurement.
- Give the measurement a descriptive name. This will be shown to users of the dashboard.
- Specify a measurement code.
- Select your Source Measurements
- Add tags.
- Add metrics and specify the type of each metric.
- Write the computed measurement script. See Writing the Computed Measurement Script for more details.
- (Optional) Test the computed measurement. See Testing the Computed Measurement for more details.
- Save when done.
Writing the Computed Measurement Script
Fill in the script of your computed measurement in the Script editor. When you add a new computed measurement, a template script will be pre-filled for you.
- Fill in init(), the initialization function
- Fill in compute(), the computation function
- Declare any global variables, if you script requires them
Tip: The script editor will interactively notify you of any syntax errors in your script
Note: You should not modify the function signatures of the initialization or computation functions.
Testing the Computed Measurement
- Enter sample measurement data in the Testing Value editor
- Click the TEST button
After you click the TEST button, your script and sample data will be submitted and executed. The CMS will wait for up to 5 seconds for your script to execute, and the output data from your script, if any, will be shown in the Testing Output panel. Any console messages that your script calls will be shown in the Testing Console panel.