Skip to content

4.4 Scripts

General Information

Scripts are programs written for a language interpreter (primarily Python) that extend MultiProbe's measurement capabilities. Functionally, an integrated script works like a built-in analyzer — it retrieves data from a device and feeds measurements into MultiProbe for use in monitoring templates (see Section 5.2).

MultiProbe does not provide a script development environment. Scripts must be developed externally in the appropriate IDE and uploaded to MultiProbe in their final form. For script technical requirements, contact technical support.

The integration workflow is:

  1. Install the required interpreter — Section 4.4.2
  2. Upload the script — Section 4.4.3
  3. Define the measurements the script provides — Section 4.4.4
  4. Register the device types the script targets — Section 4.4.5

Interpreters

Interpreters execute script code. MultiProbe supports user-installed interpreters.

To manage interpreters, go to Administration → Scripts → Interpreters.

Each interpreter has the following parameters:

  • Name — the interpreter name (e.g., Python).
  • Executable — the interpreter's .exe file that MultiProbe will launch to run scripts.
  • Install path — the directory where the interpreter is installed on the Central Server.
  • Scripts — the number of scripts currently using this interpreter.

To add a new interpreter, click New interpreter and fill in the parameters.

Script Management

To manage scripts, go to Administration → Scripts → Scripts.

Figure 56. Scripts screen Figure 56. Scripts screen

The screen is split into two panels:

  • Left panel — list of uploaded scripts with name, interpreter, description, handles required, and handles in use.
  • Right panel — the script source code (read-only).

Single vs. Multi-Instance Scripts

By default, one running instance of a script serves one monitoring object. If the same script needs to run simultaneously for multiple monitoring objects, enable the option The script processes multiple instances at the same time, so it needs a handle to differentiate measurements between objects when uploading the script.

Warning

This option cannot be changed once the script is in use.

Uploading a Script

Click New script. The upload window appears.

Figure 57. New script upload window Figure 57. New script upload field

Drag the script file into the window, select the interpreter, enter a description, and — if multi-instance support is needed — check the corresponding option. Save to complete the upload.

Measurement Management

A script retrieves named data items from a monitoring object. Each data item in the script has an alias (identifier) and a type. To make this data available in MultiProbe's measurement templates, you must explicitly define each item — MultiProbe will not discover them automatically.

To manage script measurements, go to Administration → Scripts → Script measures.

Figure 58. Script Measures screen Figure 58. Scripts Measures screen

The screen shows scripts on the left and the measurement list for the selected script on the right.

Each measurement entry has:

  • Name — a user-defined label used when configuring measurement templates.
  • Alias — the exact identifier used in the script code. MultiProbe does not validate this — if the alias doesn't match the script, no data will be received.
  • Data type — the data format, selected from a list. Must match what the script actually provides.
  • Unit — the unit of measurement.
  • Description — optional description.

To add a measurement:

Select a script from the left list and click New Measure. Fill in the parameters and save.

Figure 59. New measurement entry window Figure 59. Window for entering a new script dimension

Device Types

Each script is designed to work with a specific type of device. To use a script in MultiProbe, you must explicitly link it to the corresponding device type.

To manage device types, go to Administration → Scripts → Device types.

Figure 60. Device types screen Figure 60. Device types screen

To add a new device type, click New device type and enter the name.

To link a device type to one or more scripts, select the device type from the left list and click Assign scripts. In the window that opens, select the applicable scripts.

Warning

MultiProbe does not automatically verify that a script is compatible with the assigned device type. Ensure the mapping is correct before deploying.