There are a number of ways to create rules using the Rules API, as described in the following section.
Define a rule for a specific KPI by using the CI Customizations page
Each Service Health KPI has these applicable API rules: API Group and Sibling Rule, API Sample Rule, or API Duration-Based Sample Rule. From the CI Customizations page, you can assign one of the API rules to a KPI, and enter a calculation script (and other rule details) to define rule logic for that KPI.
You can then edit the rule details in the CI Customizations page at any time to change the rule logic for the KPI.
For details, see Define an API rule in the CI Customizations page.
Create a rule using a text file
For each of the API rules (Group and Sibling Rule, Sample Rule, or Duration-Based Sample Rule) there is a corresponding template file, located in the <Data Processing server root directory>\BLE\rules\groovy\templates directory. You can use one of the template files to create a text file defining a new rule. You then add this rule to the Rule Repository, and it can be applied like any out-of-the-box rule.
The API code cannot be seen or changed within Service Health, but only within the text file. If you make changes to the code within the text file, these changes are applied to all instances where the rule has been assigned, after you reload Service Health rules.
For details, see Create a text file-based API rule.
Define a rule within the Rule Repository
The Rule Repository contains three API rules: API Group and Sibling Rule, API Sample Rule, or API Duration-Based Sample Rule. You can use the Rule Repository to clone an API rule and enter a calculation script (and other rule details) to define the rule logic.
After the rule is applied to a KPI, you can edit rule details within the CI Customizations page at any time to change the rule logic for a specific KPI.
For details, see Define an API rule in the rule repository.