A Duration-Based Sample rule calculates KPIs based on original data taken from sample fields; the duration rule parameter defines which samples are included in the calculation. For example, if duration is defined as fifteen minutes, all samples collected during the last fifteen minutes are included in the calculation.
Duration-Based Sample Rule Methods and Fields
The Duration-Based 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 list of samples to be used in the rule calculation.
-
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 this rule, see Examples - API Sample Rule.
API rules can be defined by using the CI Customizations page, by using a text file, or within the Rule Repository, 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 Duration-Based Sample Rule in the CI Customizations page or Rule Repository
To define a Duration-Based Sample rule by using the CI Customizations page or within the Rule Repository, fill in the fields as follows:
-
KPI Calculation Script. Enter the 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.
-
No data timeout and duration. (Optional) You can define the timeout period and duration parameters, as described in List of Rule Parameters.
For detailed instructions, see Define an API rule in the CI Customizations page or Define an API rule in the rule repository.
Defining a Duration-Based Sample Rule Using a Text File
To define a Duration-Based Sample rule using a text file template, use the DashboardDurationBasedSampleRuleTemplate.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.