Create a text file-based API rule

There are three rule template files corresponding to the three API rules; each template implements the rule's interface.

Create a text file defining a new rule using one of the templates, and then add the new rule to the Business Rule Repository. The rule can then 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.

1. Create a text file for a rule

   Based on the type of rule you want to create, copy and rename one of the template files located in the <Data Processing server root directory>\BLE\rules\groovy\templates directory.

   Within your copy of the template, define the rule methods and fields as described in:

   • API Group and Sibling Rule

   • API Sample Rule

   • API Duration-Based Sample Rule

   Save the file to the <Data Processing server root directory>\BLE\rules\groovy\rules directory.

   You must now add a rule in the Rule Repository that uses the rule logic in the text file.

2. Add a business rule

   1. Select Administration > Service Health > Business Rules. Click New. For details on adding rules, see Business Rules.

   2. In the Display name field, type the name of the rule you want to create (mandatory).

   3. In the Type section, select Java Class as the implementation method. Enter groovy: <file name> as the class name.
      Note that the file name must be identical (case sensitive) to the file name in the <Data Processing server root directory>\BLE\rules\groovy\rules directory.

   4. Create rule parameters depending on your API rule type, as follows:

   • In the Parameters area, click New Parameter.

   • For API Sample rules:

     In the Name field, type Maximum number of samples. In the Type field, select Integer. In the Default Value field, type 1. Leave the Unit field empty, and the Configurable field unchecked.

     Click Apply to save.

   • For API Duration-Based Sample rules:

     In the Name field, type duration. In the Type field, select Long. In the Default Value field, type 990. Leave the Unit field empty, and the Configurable field unchecked.

     Click Apply to save.

   Repeat these steps to add the No Data Timeout rule parameter (Type: Long; Default Value = 990).

   The following image shows a Sample rule after the rule parameter has been added:

   

   The following image shows a Duration-Based Sample rule after the rule parameters have been added:

   

   5. Modify the thresholds. (Skip this step if you are defining a Group and Sibling rule that does not have thresholds, where status is calculated by the rule code.)

   • In the Thresholds section, select Calculate severity based on predefined thresholds.

   • Set the threshold values for each operator by using the + and - buttons.

3. Add the rule to the KPI's applicable rules list

   Add the new rule to the list of applicable rules already attached to the relevant KPI. For details, see the Applicable Rules parameter in .

4. Add tooltip parameters to the new tooltip

   When a rule is created using this procedure, a corresponding tooltip is with no tooltip parameters. For instructions on adding tooltip parameters to the new tooltip, see Work with tooltip entries.

5. Reload rules after editing the text file

   If you make changes to the text file at any time after the rule is created, perform the following steps to apply the changes.

   1. In the browser, access the JMX port 29800.

   2. Within OMi-Platform, select the service called MarbleWorker and invoke the reloadRules method. This method is applied to all the customers served by this worker.