A Sample rule calculates KPIs based on original data taken from sample fields; the number of samples included in the calculation is limited by a maximum number of samples parameter.
Sample Rule Methods and Fields
The Sample rule implements the Rules API Interface LeafCalculator, using the following guidelines:
-
In this interface, the only method is calculateKPI. The method signature is:
-
The calculateKPI method includes the parameters ci, kpi, and samples. These represent the current CI, the KPI whose value the rule calculates, and the samples to be used in the rule calculation based on the Maximum number of samples parameter. (If this parameter value is 1, list one sample in this field.)
-
The kpi parameter type is KPI, and is used to set calculation results.
-
The samples parameter is a List of Sample objects, which hold sample field values.
public void calculateKPI(CI ci, KPI kpi, List<Sample> samples)
-
The rule must also set the sampleFields field to define which sample fields are held by the Sample object. These values are the values used by the rule.
For detailed examples of Sample rules, see Examples - API Sample Rule.
API rules can be defined within the CI Customizations page or the Rule Repository, or using a text file template, as described in Create rules with the Rules API.
The Rules API classes are documented in Javadoc format in the OMi Rules API Reference. These files are located in the following folder:
<OMi_HOME_GW>/AppServer/webapps/site.war/amdocs/eng/API_docs/Rules_API/index.html
Defining a Sample Rule in the CI Customizations page
or Rule Repository
To define a Sample rule by using the CI Customizations page or within the Rule Repository, fill in the fields as follows:
-
KPI Calculation Script. Enter the calculateKPI method implementation. Do not enter the method signature. The parameters ci, kpi, and samples of the calculateKPI method are available for use in this script.
-
Maximum number of samples. By default only the most recent sample is included (default=1). You can use this field to change this setting.
For detailed instructions, see Define an API rule in the CI Customizations page or Define an API rule in the rule repository.
Defining a Sample Rule Using a Text File
To define a Sample rule using a text file template, use the DashboardSampleRuleTemplate.groovy template file as described in Create a text file-based API rule.
Within the text file, enter the calculateKPI method body, and define the sampleFields field.