Back Forward Report Definition rules
Working with the Report Viewer

About Report Definition rules

  Show all 

Purpose

When you run a report from the Report Browser, the Report Viewer displays its results in a separate window. The Report Viewer offers many options for manipulating the displayed report, such as () printing it and () exporting it to Excel. 

Within the Report Viewer, you can also change the design of the report. You can adjust column headings and width, formatting of values, the order and sorting of columns, and which rows of data to include. You can save these changes or use them to create a new report.

Note Report Viewer features are available only for reports produced from Report Definition rules. V5 reports are displayed in an older viewer, which provides only limited user interactions. See Interacting with list view reports and About List View rules.

You can import V.5 reports into the Report Browser, so they can be found there and reviewed in the Report Viewer. See How to make V5 reports available in a Report Browser.

 Command Bar and Search

At the top of the window is a Command bar. It includes a Search box at the upper right. Typing any text into this box and hitting Enter or clicking the Search icon () finds the first occurrence of the text in the body of the report, highlights it, and moves the cursor to that position in the report. Clicking the Search icon () again moves the cursor to the next occurrence of the text within the report.

The command bar also includes these command icons at the upper left:

Icon

Description

Save

If this is a personal report that you have modified in the Report Viewer, this command lets overwrite and replace the previous report definition rule with your revised version.

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, the column order, and filtering of data to customize what the report includes.

Append Column

Lets you add a new column at the right end of the report. Use the Edit Columns to Include command to reorder columns as desired.

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.
NoteThis command is only available for summary reports that contain at least one column, that represents counts, totals, averages, etc. See Defining and Editing Charts.

Export to Excel

Exports the report's data into an Excel workbook.

Export to PDF

Exports the formatted report into a PDF document.

 Report Header and Filter Conditions

The report header displays the length of the report ("Displaying 4 records"),the title of the report, the date the report ran, and a list of any filter conditions that determine which rows are included.

The filter conditions display as a hyperlink if you are allowed to change them. Clicking the link opens the Rows to Include form, which lets you change these conditions. You can define a series of filters that describe which rows of data to include in the report. Each condition compares the values in a column to one or more values you enter. GATZH updates 3/23/2010

To enter each condition:

 Column Heading sorting, and right-click menu

At the top of each column is a heading that describes the information in the column. Clicking the column heading sorts the report based on the values in that column;  clicking repeatedly on the column heading changes whether the sorting is from highest to lowest (), or lowest to highest (). The direction of sorting is indicated by an icon next to the column heading.

Right-clicking the column heading displays the following command menu:

Label

Description

Heading... Prompts you to change the heading displayed at the top of the column.
Format.. Prompts you to enter a control rule to use in formatting the values for the field. If the selected control rule takes parameters, click the magnifying glass icon () to the right of the selected control rule to enter these parameters.
Width... Prompts you to change the width of the column, specified as an integer followed by either px, to indicate a value in screen pixels, or %, to indicate a percentage value of the overall width of the window.
Hide Hides the column so that it is not displayed on the report. This option lets you sort rows on a report based on the values in a column that you do not want to display in the report.
Sort... Lets you change the display of the report based on the sort order of the current column, and set whether the column is in ascending order (lowest to highest), or in descending order (highest to lowest).
Summarize Report Data Summarizes the data in a list-type report, grouped by whichever columns you choose in the pop-up window that appears.
Edit All Filters... Opens the Rows to Include dialog so you can adjust the filters that govern which rows to include in the report.

 Defining columns with SQL functions

To the right of the Column Name field for each column is a SQL function icon (SQL function icon ). Click the icon to display the SQL Function Builder. The Function Builder appears in a pop-up window and lets you select an existing SQL function template to use as the basis for the SQL function you wish to use to populate the current column. When you have selected the template, the form displays further fields where you select the properties the function is to use. See Report Definition rules - using the Function Builder.

 PDN Examples

See Pega Developer Network article PRKB-26095 Using the Report Viewer to define simple reports.

Related topicsReport Definition rules — Defining and Editing Charts
Report Definition form — Completing the Chart Definition dialog
Manager portal — Using the Report Browser

Up About Report Definition rules