Syntax for threshold specification

Use the syntax, values, and parameters described here to modify predefined thresholds.

Specification of thresholds uses the following syntax:
syntax diagram for threshold specification

Parameters

Each threshold specification consists of six required elements and three optional elements that are used when a complex threshold is specified:
IF keyword
This keyword indicates the beginning of the threshold specification. Internal parsing considers all text between IF statements as a threshold specification. Only the first column in the IF statement is statused if it evaluates positively.
Left parenthesis – (
An optional left parenthesis is used to help group connected thresholds in a complex threshold specification. Specification of the left parenthesis is optional, but if specified it is treated based on the normal rules of operator precedence. That is, the highest level of precedence among parentheses and AND and OR operators. Each left parenthesis must be matched in the complex threshold specification by a corresponding right parenthesis or errors will be flagged during parsing.
Note: This parenthesis MUST be preceded and succeeded by at least one blank.
application_name.table_name.column_name
This triplet must follow the IF keyword with each of the three components delimited by a period. The triplet must be contiguous, that is, must contain no embedded blanks.
Comparator
This 1-2 byte specification must follow the application.table_name.column.name triplet. Valid comparators are:
EQ
compare equal
=
compare equal
NE
compare not equal
!=
compare not equal
GT
compare greater than
>
compare greater than
LT
compare less than
<
compare less than
GE
compare greater than or equal
>=
compare greater than or equal
LE
compare less than or equal
<=
compare less than or equal
Comparison value or range of values
This value must follow the comparator with the following formats supported:
  • The value is considered a string if enclosed by double-quotes. Up to 70 characters may be specified.
    Note: If a comparator other than EQ or “=” is used against a string the assumption is that a numeric string value is being thresholded. Currently, the UI data value and the threshold value are right-justified before comparison in these situations. This will provide expected threshold comparison results for numeric values that are specified with the same number of decimal places, scaling units but no parsing of the string is attempted in the evaluation to “normalize” the strings.
  • Decimal integer, preceded by an optional sign character (+ or -), in the range -2^63 + 1 through 2^63 – 1, that is, -9,223,372,036,854,775,807 to +9,223,372,036,854,775,807. A decimal point may be inserted in any position, including as first or last in the value: that is, 1234. and .1234 are valid.
  • Hexadecimal value in the range 0x8000000000000000 through 0x7FFFFFFFFFFFFFFF. After the 0x prefix, 1 – 16 hexadecimal digits can be specified; for example, 0x3F is valid.
  • Optionally, a range of values may be specified using a <> symbol immediately after and contiguous to the 1st decimal or hexadecimal value. The second, upper value in the range must follow the same specification rules as the first value in the range though a mixture of decimal and hexadecimal values can be specified if desired. The second value must immediately and contiguously follow the range symbol.
    Note: The use of the <> symbol may be replaced by a compound IF statement such as IF (a.b.c >= value1 AND a.b.c <= value2).
  • A suffix specifying the units that apply to the numeric value(s) can optionally be specified. The unit characters must immediately follow, and be contiguous with, the numeric value they apply to. Valid unit specifications are:
    K
    scales the numeric value by a factor of 1024
    M
    scales the numeric value by a factor of 1024*1024
    G
    scales the numeric value by a factor of 1024*1024*1024
    T
    scales the numeric value by a factor of 1024*1024*1024*1024
    P
    scales the numeric value by a factor of 1024*1024*1024*1024*1024
    E
    scales the numeric value by a factor of 1024*1024*1024*1024*1024*1024
    ms
    milliseconds, scales the numeric value to seconds by a factor of 1000
    csec
    centiseconds, scales the numeric value to seconds by a factor of 100
    sec
    seconds, no scaling
    /sec
    units per second, scales to rate per hour internally (*3600)
    /min
    units per minute, scales to rate per hour internally (*60)
    /hr
    units per hour, no scaling
    %
    percentage, no scaling
Right parenthesis – )
An optional right parenthesis is used to help group connected thresholds in a complex threshold specification. Specification of the right parenthesis is optional but if specified will be treated based on the normal rules of operator precedence. That is, the highest level of precedence amongst parentheses and AND and OR operators. Each right parenthesis must be matched in the complex threshold specification by a corresponding left parenthesis or errors will be flagged during parsing.
Note: This parenthesis MUST be preceded and succeeded by at least one blank.
Connector AND and OR keywords
The connector between any two individual thresholds, or parenthesized groups of thresholds, must be an AND or an OR keyword. If both are used in a complex threshold, normal rules of precedence and associativity apply. That is, AND has higher precedence than OR if no parentheses are used or both connectors are contained within a single left and right parentheses pair. Associativity is left to right.
THEN DO keywords
THEN DO must be specified after the threshold IF statements with a corresponding terminating ENDDO keyword. The THEN DO and ENDDO keywords are specified before and after one or more of the STATUS, ZOOMDEST or HELPDEST keywords and keyword values.
STATUS keyword
STATUS is an optional keyword that can follow the comparison DO THEN keywords.
(status_state, status_range)
This is a parenthesized, space-delimited pair of two keyword parameters that designate one or two statuses for interpretation by the user interface. Both designation types must be specified. Specific keywords indicating that one or more of the status designations does not apply to the current threshold (NOSTATE or NORANGE) are used in place of an actual value. At least one blank must be specified between the STATUS keyword and the left parenthesis.
Note: The status_state value takes precedence over the status_range specified if both are specified.
  • status_state sets the state to be interpreted by the user interface. Valid specifications are:
    • GOOD
    • WARNING
    • CRITICAL
    • IDLE
    • NOSTATE
  • status_range sets a value in the range 0 through 9 (0 is equivalent to the NORANGE keyword) to augment the column data in the user interface subpanel. Valid specifications are:
    • Numeric value in the range 0 through 9
    • NORANGE
ENDDO keywords
ENDDO must be specified after the threshold STATUS statements with a corresponding initiating THEN DO keyword pair.

Acceptable formats

Hexadecimal
0xH - 0xHHHHHHHHHHHHHHHH
0XH - 0XHHHHHHHHHHHHHHHH
1-16 hexadecimal digits
Decimal
(+/-)(.)nnnnnnnnnnnnnnnnnnn - (+/-)nnnnnnnnnnnnnnnnnnn(.)
1-19 decimal digits with decimal point in any position including 1st or last character position
Scaling suffix
(1024) K (kilobytes), M (megabytes), G (gigabytes), T (terabytes), P (petabytes), E (exabytes)
Percentage
%
Time suffix
ms, csec, sec
Rate
/sec, /min, /hr
String
1-70 characters enclosed by double quotes