Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Using the Report Viewer to define and evolve simple reports

Updated on September 20, 2019


When you run a Report Definition report from the Report Browser of the Manager portal, results appear in a separate window called the Report Viewer. You can also access the Report Viewer from the Report Definition rule form.

The Report Viewer offers many options for manipulating the displayed report, such as Printing it, Exporting it to Excel, and so on.

The Report Viewer also provides intelligent drill-down and drill-up behavior and offers almost all the functionality from the Design tab of the Report Definition rule form to re-design the report.

Using the Report Viewer, you can:

  • Change the report title.
  • Modify filter criteria.
  • Change column headings, format, and sorting.
  • Change order of columns.
  • Add columns.
  • Save changes to original report, or save changes as a new report.

The Report Viewer features discussed here are available only for reports produced from Report Definition rules in V6.1+. Reports defined in earlier versions are displayed in an earlier version of the Report Viewer, which provides more limited user interactions.

For an overview of V5.X reports, see How to create a report (V5).



Suggested Approach

The Report Viewer is comprised of several key areas which allow for data and display manipulation.

The sample Report Viewer below displays a report on Purchase Orders by Operator Name, including Create Date and Time, Work ID and Work status.

Command Bar and Search

At the top of the window is a Command bar. It features several icons that provide basic commands for manipulating the report.

Using the Command Bar icons

The Command Bar icons include:

  •  Save: If this is a report that you have created, this command lets you save your changes, which overwrite and replace the previous report definition rule.
  •  Save As: This command lets you save this report, with any changes you have made, as a new Personal report.
  •  Print: Prints the report.
  •  Edit Columns to Include: Provides a global view of the design of the report, and lets you change which columns are included, column order, and all of the column settings listed below.
  •  Append Column: Lets you add a new column to the report. The new column appears as the right-most column.
    • In the example, the .pyResolvedTime property is appended to the report.

      The Resolution TimeStamp column appears at the end of the report, following Work Status.

  •  Edit Report Title: Lets you change the report title.
  •  Add or Edit Chart: Lets you add a chart to the report, or modify the design of an existing chart on the report.
  •  Export to Excel: Exports the data of the report into an Excel workbook.
  •  Export to PDF: Exports the formatted report into a PDF document.

How to Search in the Report Viewer

The Commander Bar also includes a Search box at the upper right. Search from the Report Viewer allows for quick searching of the currently open report.

To perform a search:

  • Type any text into this box and press Enter or click the Search icon ().
    Search finds the first occurrence of the text in the body of the report, highlights it, and the cursor moves to that position in the report.
  • Click the Search icon () again without changing the text moves to the next occurrence of the text within the report, and so on.

Report Header

The report header displays the title of the report, the count of rows displayed in the report, and the filter conditions that determine which rows are included.

The filter conditions (Filters) are displayed as a hyperlink. Click to open the Rows to Include dialog (below). This lets you change the conditions that describe which rows of data to include in the report. This provides the same functionality as the Design tab of the report definition rule form.

Column Heading

At the top of each column is a column heading that describes the information in the column.

Click the column heading to sort the report based on the values in that column.

Click repeatedly on the column heading to change the sorting from ascending (), or descending () order.

Settings on the User Interactions tab

It is also possible to set or restrict many of the Report Viewer capabilities from the User Interactions tab in the Report Definition rule form. Some of the capabilities include: Save, Save As, Print, Edit Columns to Include, Append Column, Edit Report Title, Add or Edit Chart, Export to Excel, and Export to PDF.

Additional information


Pega Platform 7.1.1 - 7.4 Reporting Financial Services Healthcare and Life Sciences Insurance Communications and Media Government Healthcare and Life Sciences Consumer Services Consumer Services Manufacturing Consumer Services

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us