Creating a report definition

In Dev Studio, you use the report definition rule to create reports.

The report definition rule generates an SQL query that retrieves and sorts information from the PegaRULES database, an external database, or an Elasticsearch index, and displays the results in various formats.
  1. Open the report definition rule form by clicking Create > Reports > Report Definition.
  2. Create a report definition:
    1. In the Label field, enter the title or description of the record.
    2. Optional: To edit the Java identifier, in the Identifier field, click Edit, and then provide a new name.
      By default, the Identifier field inherits the name from the Label field. A valid identifier name starts with a letter, and consists of letters, digits, and underscores.
    3. In the Apply to field, select a class applicable for the report definition, or select a work pool to report on all work types in the work pool.
      Note:

      For certain uses, you can select an abstract class for the field, such as the Work- class. The system then determines a work pool, or a single class that is the source of the report contents. For example, a report definition with Work- class presents drill-down details that another report definition references.

      The list of available class names depends on the ruleset you select. Each class can restrict applying rules to an explicit set of rulesets as specified on the Advanced tab of the class form.

    4. In the Add to ruleset list, select the ruleset to include the report definition.
    5. Optional: In the Work item to associate field, press the Down arrow key, and then select a work item.
    6. Click Create and open.
  3. In the Edit Report definition page, define the contents and display of the report.
    For more information about the configurable options, see Report Definition rule form.
  4. Click Save.