Administration > Application Administration > Repositories Administration > Dashboard Business Rules Details > Generic Sample Rule
Generic Sample Rule
Use this rule to create a customized rule. The rule compares the value of a selected field from a sample to the objectives and returns the result of the comparison.
The tooltip of the Generic Sample Rule is empty.
KPIs Using this Rule
You can attach this rule to an existing KPI or to a new KPI that you create - for details, see Understanding the Rule.
This rule is used by the following KPI(s):
Understanding the Rule
To use the Generic Sample rule, you must first customize the rule, and then attach the rule to a KPI, and then attach the KPI to a view. The KPI automatically propagates the rule selected in the Default Rule list to all the CI parents.
To create a customized Generic Sample Rule:
- Select Admin> Dashboard, and select Business Rules in the Repositories tab.
- In the Factory Business Rules area, select the Generic Sample Rule and click Clone.
- In the Custom Business Rule area, click the Edit button
corresponding to the Generic Sample Rule to open the Rule Details window.
- In the Display Name box, enter a new name for the cloned rule.
- In the Rule Parameters area:
- Click the Edit button
corresponding to the Field Name to open the Parameter Details window. In the Default Value box, specify the name of the field (in the sample) on which to apply the rule. The field must have a numeric value. Click OK to save the change.
Note: The units of the objectives and of the field value must be the same. The result is provided with the same unit too.
- If the name of the time stamp field in the sample is not time_stamp, click Edit for the Time Stamp Field parameter. Enter the name of the sample time stamp field in the Default Value box. The type of the sample time stamp field must be time. Click OK to save the change.
- If required, in the Objective Parameters area, click the Edit button
corresponding to the appropriate objective to open the Parameter details window and make the changes - for details, see Specifying the Rule Objective Parameters.
Note: The units of the objectives and of the field value must be the same. The result is provided with the same unit too.
- Click OK to save the changes.
To define the customized rule for a KPI:
- Select Admin> Dashboard, and select KPIs in the Repositories tab.
- In the Factory KPIs area, select any KPI and click Clone.
- In the Custom KPIs area, click the Edit button
corresponding to the KPI you just cloned to open the Item Details window.
- In the Display Label box, enter a new name for the cloned KPI.
- In the Default Rule list, select Worst Child.
- In the Applicable Rules list, select Worst Child, click CtRl and click the cloned Generic Sample Rule you just created.
- In the Applicable Sections list, select Dashboard.
- Click OK to save the changes.
To attach the customized rule to a KPI for a CI:
- Select Admin> Dashboard, and select the KPIs tab.
- Select a view.
- Select the appropriate monitor level to which you want to attach the KPI.
- Click New KPI to open the New KPI window.
- In the KPI list, select the KPI you just created.
- In the Business rule list, select the generic rule you just created.
- Click OK to save the changes.
Parameters
The rule parameters are:
No data timeout - The timeout period for a KPI. Defines the number of seconds from the time the last sample was received for the KPI, until the KPI is timed out - at which point the KPI changes to decay status (gray). The default value for this property should be changed with caution. Note that a different default value may actually be used for Business Process Monitor transaction CIs—for details, see No Data Timeout for Transaction CIs.
Field Name - The name of the sample field you want to compare to the objectives. The field must have a numeric value.
Time Stamp Field - The name of the time stamp field, if its name is not time_stamp.
| Copyright 2006 Mercury Interactive Corporation |