List of Rule Parameters

The rule parameters are as follows:

Parameter

Description

The weight assigned to At Risk instances to provide more importance to a specific status. You can assign any appropriate number with the following specific cases: 1 is the default, 0 causes the status to be ignored in the rule calculation, or a negative number is considered to be 1.
Internal parameter for the sample field used to calculate availability; do not modify this value.
The weight assigned to Blocked instances to provide more importance to a specific status. You can assign any appropriate number with the following specific cases: 1 is the default, 0 causes the status to be ignored in the rule calculation, or a negative number is considered to be 1.
For KPI rules, defines which indicators are used to calculate the KPI:
0 - HIs and child KPIs
1 - HIs only
2 - Child KPIs
3 - HIs; if none exist, use child KPIs
Default/Mandatory: 0/No
Internal parameter showing which KPI the rule uses for calculation; do not modify this value.
If true, events with Normal status are not included in event-based HI calculation. Note that if this is false, the setting of reportNormalStatusesEvents is ignored.
Default: true; changing this default increases use of memory.
The weight assigned to the Critical status. You can assign any appropriate number with the following specific cases: 1 is the default, 0 causes the status to be ignored in the rule calculation.
The name of the sample field whose sum is used together with the Sum field parameter to generate a rule calculation result as follows:
Sum of <Sum field> / Sum of <Divide by field> = rule result.
The financial loss factor per hour. The financial loss factor is used to calculate the financial impact of a CI non-availability.
Service Health calculates CI status based on the samples received during the duration period (defined in seconds). For example, if a CI has a duration of 5 minutes, status is calculated based on the samples received during the past 5 minutes.
Default: 15 minutes
The factor used to multiply the result of the operation performed on the two fields, before comparing the result to the thresholds.
The name of the sample field with a numeric value which is used to calculate the rule result.
The final status of the incident received in the sample.
Default: Closed.
The name of the first field on which to apply the rule. The field must have a numeric value.
The formula to be used to calculate the value or the status of the KPI to which the Generic Formula rule is attached, for the time period specified in the duration parameter.
The weight assigned to Healthy instances to provide more importance to a specific status. You can assign any appropriate number with the following specific cases: 1 is the default, 0 causes the status to be ignored in the rule calculation, or a negative number is considered to be 1.
For KPI rules, this is the list of HIs used to calculate the KPI.
Default/Mandatory: (empty list)/No
The initial status of the incident received in the sample.
Default: Open.
Defines a different initial status of a group level CI's KPI until samples are received. The default KPI status for rules that do not include an InitStatus parameter is No data.
Internal for API rules; do not modify.
For API rules, defines the calculateKPI method implementation.
Default/Mandatory: (no default)/Yes
The name of the sample field which contains latency data.
Specifies the type of calculation the rule should perform. The valid values can be a subset of: maximum, minimum, average, or weighted-average.
The weight assigned to the Major status. You can assign any appropriate number with the following specific cases: 1 is the default, 0 causes the status to be ignored in the rule calculation, or a negative number is considered to be 1.
The name of the sample field whose values are used as the mean in calculating the baseline.
The weight assigned to the Minor status. You can assign any appropriate number with the following specific cases: 1 is the default, 0 causes the status to be ignored in the rule calculation.
The weight assigned to the OK status. You can assign any appropriate number with the following specific cases: 1 is the default, 0 causes the status to be ignored in the rule calculation.
The operator used to calculate the result of the first and second fields. It can be:
+, -, *, or /.
Status level that is set to serve as the lowest limit above which the instances are considered for the status calculation.
Example: If PassedStatus is defined as 15 (Warning), all instances with status 15 or more (OK, or Warning) are PassedStatus instances. The instances with lower levels (Minor, Major, or Warning) are not taken into consideration in the status calculation.
Internal for API rules; do not modify.
The name of the second field on which to apply the rule. The field must have a numeric value.
The severity of the sample incident that is used in the calculations.
The values are:
5 – very low
4 – low
3 – medium
2 – urgent
1 – critical
Defines the ID of the KPI for which the other rule parameters apply when you want to use KPIs other than Availability.
Defines the conditions under which a measurement's status can improve. If the parameter value is true, a measurement's status can improve only when the full number of consecutive statuses are received. If the parameter value is false, a single "better" measurement can change the measurement's status. For example, if the second option is defined, if the measurement's status is red and an OK measurement is received, the status changes to green.
The name of the sample field whose sum is used together with the Divide by field parameter to generate a rule calculation result as follows:
Sum of <Sum field> / Sum of <Divide by field> = rule result.
The name of the time stamp field in the external source sample, if its name is not time_stamp.
Internal. This parameter must not be modified.
The KPI number of the Volume KPI (in EUM). Used to calculate rules in EUM group rules.
The weight assigned to the Warning status. You can assign any appropriate number with the following specific cases:
1 is the default.
0 causes the status to be ignored in the rule calculation.