Viewing Rules Usage

Business rules can be used in the following artifacts:

  • Forms

  • Rulesets

  • Menus

  • Task lists

Service Administrators can generate a report, called the Rules Usage Report, that details where rules are used. Filters enable you to refine the details by rule name, rule type, and cube.

Note:

The only rules listed in the Rules Usage Report are those rules that are deployed in Planning.

To view rules usage:

  1. Click the Navigator icon Navigator icon, and then under Monitor and Explore, click System Reports.
  2. Click the Rules Details tab.
  3. If filtering, select filter criteria, and then click Apply Filter:
    • Rule Type—Choose one or more options: All, Rules, and Rulesets

    • Cube—Choose from a list of available cubes.

    • Name Filter—Enter a rule or ruleset name. Optionally, you can use wildcard characters.

    The Rules list displays the rules that are deployed in Planning and that match the filter criteria.

  4. For File Format, select one of the following formats:
    • XLSX (default)

    • PDF

    • HTML

    • XML

      Note:

      Choosing XML format enables you to configure the Rules Usage Report with the help of Oracle BI Publisher Add-in for MS Office. You can have greater control over which columns to display in your report, the order in which the columns are displayed, whether to apply sorting, and so on.

  5. Click Create Report.

The Rules Usage Reports provides the following information:

  • Rule Name

  • Rule Type

  • Cube

  • Primary Association (Type and Name)

  • Secondary Association (Type and Name)

Primary association refers to the rule that is associated with the artifact directly; for example, a rule linked to a form or to a task. Secondary association refers to the rule that is associated with an artifact indirectly; for example, a rule that is linked to a menu item, and the menu item is linked to a form, or a rule that is linked to a task for a given task list.

Rules in the generated report are displayed in alphabetical order as follows:

  • Rule name

  • Primary association type

  • Primary association name

Example 18-1 Sample Rules Usage Report Showing Primary Associations (PDF Format)

Sample rules usage report showing primary associations in PDF format

Example 18-2 Sample Rules Usage Report Showing Primary and Secondary Associations (PDF Format)

Sample rules usage report showing primary and secondary associations in PDF format