Develop > Service Health > Service Health Rules API

Service Health Rules API

Note In OMi versions 9.00 and later, the rules that calculate indicator statuses and values based on samples (API Sample Rule and API Duration-Based Sample Rule) are used to calculate metric-based health indicators (HIs).

Throughout the Rules API documentation, you will see references to various methods used to calculate KPIs. In OMi versions 9.00 and later, when calculating sample-based values, these methods are used to calculate metric-based HIs.

This section describes how to use the Rules API to create new business rules. Business rules are used to calculate Key Performance Indicators (KPIs). A KPI must have an associated business rule that defines how the KPI is calculated.

HPE recommends to create rules with the Rules API. The Rules API enables you to create rules using the Groovy scripting language with Groovy runtime environment. Users of the Rules API should be familiar with Groovy and Java, and with OMi administration and applications. For more information about developing and deploying Groovy scripts, see Groovy scripts.

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

ClosedService Health API Rules

These are the types of Service Health API rules:

  • Group and Sibling Rule. This rule calculates KPIs based on data received from other KPIs, rather than from original sample data. For details, see API Group and Sibling Rule.

  • Sample Rule. This 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 rule parameter. For details, see API Sample Rule.

  • Duration-Based Sample Rule. This rule calculates KPIs based on original data taken from sample fields; a duration parameter defines which samples are included in the calculation. For details, see API Duration-Based Sample Rule.

ClosedCreating API Rules

Rules can be created using the Rules API in these ways:

  • Using the CI Customizations page to create a rule for a specific KPI.

  • Using a text file to create a new rule for multiple KPIs.

  • Using a clone of an API rule in the Rule Repository to create a new rule.

These ways are described in Create rules with the Rules API.

ClosedTooltips and Log Files

To display KPI information in tooltips when working with the Rules API, see Work with tooltip entries.

You can write to log files from the Rules API code, as described in Write to log files from the Rules API code.

Send Help Center feedback