Multi-Parameter Formula

Home  Previous  Next

Objective

The aim of this Multi-Parameter Formula tool is to monitor parameters of any KMs loaded in your console and to apply a mathematic formula to the collected values in order to obtain a meaningful result.

Method (summary)

The Multi-Parameter Formula option has been specifically designed to apply mathematical formulas to monitored Knowledge Modules’ parameters.

All you need to do is:

Create a Multi-Parameter Formula
Select the parameter(s) of the KM that you wish to monitor
Define the formula you wish to apply to the collected value(s)
Enter a name and an identifier for the object, representing the formula results, that will be created in the console
Set the threshold conditions

Result

You can then receive alerts for any malfunction in the KM(s) that could in turn affect the functioning of your application.

Create or edit a Multi-Parameter Formula

To create a new Multi-Parameter Formula, right-click the application/container icon in the PATROL Console and select KM Commands > New > Multi-Parameter Formula...

WIZ_MultiParameterFormula_1Welcome

Multi-Parameter Formula Wizard — Welcome Page

To edit an existing Multi-Parameter Formula, right-click the Multi-Parameter Formula icon in the PATROL Console and select KM Commands > Edit.

Step 1: Selecting the parameter(s) you wish to use in the formula

WIZ_MultiParameterFormula_2SelectObject

Multi-Parameter Formula Wizard — Parameter(s) Selection Page

Select the parameter(s) you wish to use in the formula: Click as many parameters as you need to select. The list displays all the KMs and their respective parameters currently available on the Agent. Click Next to continue.

If needed, check the Use the objects display name to dynamically determine the PATROL IDs option to allow the use of label instances instead of PATROL IDs to determine a parameter's path. This option may be particularly useful when an object ID is unknown; in that case, upon each collect, Monitoring Studio will determine the parameter's path according to the parameter's class and the selected instance label. Monitoring Studio will list the objects actually present at the time of the collect and will only consider and monitor the first instance  that matches the label selected in the Multi-Parameter Formula wizard.

Step 2: Define the formula to apply to the monitored parameter(s)

WIZ_MultiParameterFormula_3Formula

Multi-Parameter Formula Wizard — Defining a formula to apply to the selected parameter(s)

The parameter(s) you have selected at the previous step are listed and labeled alphabetically: A, for the first parameter, B for the second, C for the third, and so on. Use these letters to represent the parameters in the formula.

Formula: Enter the formula you wish to apply to the parameter(s). Use the standard mathematical symbols to do so, such as: + - / * ( ).
Do not collect if one or more parameter has no value: Select this option if you do not wish to collect data for parameter(s) not returning any value.
NoteOff-line parameters and parameters with no values (like collectors) are displayed as "OFFLINE" in the list. It is recommended not to select these parameters.

Step 3: Defining a name for the formula result

WIZ_MultiParameterFormula_4ID

Multi-Parameter Formula Wizard — Defining a Name for the Formula Result

Object display name: Label that will be displayed in the PATROL Console for this Multi-Parameter Formula.
Object internal identifier (ID): PATROL internal identifier of this monitored object.

What thresholds do you want to set for the newly created instance? A drop-down list allows you to select the mode of setting alert thresholds:

Use default thresholds: Uses the default thresholds set by Monitoring Studio
Set custom thresholds: Allows you to customize the thresholds for all parameters of the instance
Use default thresholds and customize them: Sets the default Monitoring Studio thresholds on certain parameters (see list of parameters with default thresholds) and then allows you to customize any/all of them. This is mainly intended to help save time if you wish to customize the thresholds of just one of many parameters for the instance, and leave the default settings for the others.
NoteIf you select Use default thresholds and customize them; on clicking Finish, the Set Thresholds panel will appear, certain parameters for the instance may appear with an asterisk symbol - indicating that they already have thresholds. You can then customize (any/all) the thresholds of the parameters as per your specific needs.
Do not set any thresholds for now: No thresholds will be set on any parameter of the instance, and as a result no alerts will be triggered. Monitoring Studio will poll the object and return the output of the polling, but will not raise any alerts until you set thresholds.
TipThresholds can be set or modified at anytime by right-clicking on the instance > KM commands > Set Thresholds.

Click Finish to start monitoring the selected parameters. A new object labeled with the name you have entered at Step 3, is automatically created under the application/container icon in the PATROL console.

WIZ_MultiParameterFormula_5TreeView

Multi-Parameter Formula Object in the PATROL Console

Multi-Parameter Formula objects are instances of the SW_KMWATCH class.