You are here: Reference > Rule types > About Report Definitions

  About Report Definitions

 
  1. About 
  2. New 
  3. Query 
  4. Chart 
  5. Report Viewer 
  6. Data Access 
  7. Parameters 
  1. Pages & Classes 
  2. History 
  3. More... 

Use a report definition to define a report. This rule generates a SQL query against the Pega 7 database, or an external database, or against the Elasticsearch search index, and generates HTML that displays the query results in a wide variety of formats. Users can have the options of a range of user interactions with the displayed results, depending on the settings on the Report Viewer tab.

Basic concepts and terms

Report definitions define reports of two types:

The columns in report definitions can contain either property values or the values of expressions using SQL functions. See Using the Calculation Builder.

Note:  Report definition rules are easier to define and work with than the V5 ListView and SummaryView report rules. Managers can create, share, and schedule Report Definition reports through the Report Browser, and modify them through the Report Editor, with little or no assistance from developers.

Where referenced

Query results for report definitions are stored on a clipboard page (typically of class Code-Pega-List. APIs allow developers to run a report definition and access the data returned by its query without having the report definition itself display the results. See More about Report Definitions.

Your application can reference a report definition in these places:

Access

Both developers and managers can create, update, and execute report definitions.

Note: Using a single shared, unlocked local production ruleset for reports for all access groups for the whole application simplifies maintenance and migration of report definitions, report categories, and shortcuts in the Report Browser.

When a report executes, its results appear in the Report Viewer. The Report Viewer offers many options for manipulating the displayed report, such as printing it and exporting it to Excel or as a PDF file. From the Report Viewer, you can edit a report using the Report Editor.

You can save the updated report, or save a copy as the basis of a new report. See Report Viewer.

Completing the rule form

When creating a new report definition using the rule form, complete the tabs in the following order:

Defining report definitions on abstract classes

You can't run report definitions defined from the following classes from the rule form, but can run them in the Report Browser:

When you run such rules in the Report Browser, the Applies To class of the report is resolved as follows:

Defined on: Applies To class resolves to:
Work- or abstract classes derived from Work- ...the current work pool of the application being run.
History-Work- or abstract classes derived from History-Work- ...the History-Work- class for the current work pool of the application being run.
Assign- or abstract classes derived from Assign- ...Assign-Worklist
See Using the Report Browser.

Category

Report definitions are instances of the Rule-Obj-Report-Definition class. They are part of the Reports category.

Related topics

Working with the Report Viewer
Working with the Chart Editor
Using the Report Browser

AtlasAtlas — Standard Report Definitions
Atlas — Standard SQL function rules

Reports category
Help System home pageHelp Home