Parameter Combination

The Parameter Combination Monitor can combine any Monitor parameter of the Template with a specified mathematical formula or a PSL statement, like a function call. You can for example add, subtract, multiply, concatenate, or divide two values, calculate an average, perform table joins, etc. The returned value can be used to perform additional operations such as converting units, performing correlation, etc.

Note: It is not possible to refer to Monitors from other Templates.

Refer to the tables below to know how to configure the Parameter Combination Monitor:

Variables Properties

Property Description
Variable Name Name of the variable that will be processed in the formula. Add as many variables as needed.
Variable Path Set to PICK to select the Parameter of a Monitor, or CUSTOM to specify an internal namespace variable (advanced).
Monitor (Only available when PICK is selected) Select a Monitor from the list of Monitors available for the given Template.
Parameter (Only available when PICK is selected) Select a Parameter among the ones available for the Monitor previously selected.
Formula The formula to apply to the provided. The parameters are identified by a letter listed in the dialog box. Build the required formula using:

  • The variable name (A, B, etc.).
  • PSL operators: addition (+), subtraction (-), multiplication (*), division (/) concatenation (.), bitwise (&), etc.
  • Predefined PSL functions: tableJoin(), min(), max(), average(), and sum() parameter(s).
  • When a Variable is Not Set Indicates how Monitoring Studio X handles undefined variables:

  • INTERPRET AS ZERO: Parameters without values are considered as parameters with a value of 0
  • SKIP COLLECTION: The collect of parameters without value is skipped.
  • Monitor Properties

    Property Description
    Display Name Name to identify the Parameter Combination instance in TrueSight Operations Management.
    Internal ID ID to be used to store the Parameter Combination configuration in the PATROL Agent configuration. This Internal ID is automatically generated based on the Display Name provided but can be edited if needed.
    Collect Schedule How often new data is collected. A new collect can be performed from once every second, to once in a day. By default, the collect schedule is set to 2 minutes.

    Predefined PSL Functions

    tableJoin

    The tableJoin() PSL function is used to join two different tables from text parameters:

    tableJoin(tableA, separatorsA, keyColumnA, tableB, separatorsB, keyColumnB, defaultRightLine, keyType, timeout)

    where:

    • tableA is the left table derived from text parameter A
    • separatorsA are the separators that separate the columns in tableA
    • keyColumnA is the key column number in tableA used for matching the key columns in tableB
    • tableB is the right table derived from text parameter B
    • separatorsB are the separators that separate the columns in tableB
    • keyColumnB is the key column number in tableB used for matching the key columns in tableA
    • defaultRightLine (Optional) default rightTable line, when a match is not found
    • keyType (Optional) key type such as wbem used by Matsya TableJointClient used by the Java client.
    • timeout (Optional) timeout for the table joint query.

    Example:

    tableJoin(A, "|", 1, B, "|", 1)

    where:

    Table 1 (in parameter A: path1/Result): key 1|A|B|C| key 2|aa|bb|cc| key 3|1|2|3|

    Table 2 (in parameter B: path2/Result): key 1|X|Y|Z| key 2|xx|yy|zz| key 3|4|5|6|

    The returned output is a table that is set to the Result text parameter: key 1;A;B;C;key 1;X;Y;Z; key 2;aa;bb;cc;key 2;xx;yy;zz; key 3;1;2;3;key 3;4;5;6;

    min

    The min() PSL function is used to find the minimum value among several parameters:

    where:

    • A and B are number parameters: min([A, B, etc.])

    max

    The max() PSL function is used to find the maximum value among several parameters:

    where:

    • A and B are number parameters: max([A, B, etc.])

    average

    The average() PSL function is used to find the average value for the chosen list of parameters:

    where:

    • A and B are number parameters): average([A, B, etc.])

    sum

    The sum() PSL function is used to find the sum of the chosen list of parameters:

    where:

    • A and B are number parameters): sum([A, B, etc.])

    The returned output of the tableJoin, min, max, average, and sum PSL functions will be displayed by the Value parameter.

    Note: If the provided formula or parameters are not PSL-compatible, an error will be reported by the Collection Error Count parameter.

    Refer to:

    No results.