Report Definitions
Completing the Report Viewer tab

Optional. Available for list reports only. Select an option to control what information appears at the top of the report:

• Column Headings Only (default)
• Column Headings and Summary/Sort Options
• Summary/Sort Options Only
• Hide Column Headings

Note: if you select Hide Column Headings, the column command menu is not available.

Optional. Check this checkbox to replace the default Filters display at the top of a report with a custom section. The custom section can include basic controls (such as drop-down menu and text entry field), and the controls can only provide values for the filter functions established in the Edit filters section of the Query tab.

When the checkbox is checked, new fields appear:

• Class Name: provide the Applies To class of the custom section.
• Name: select the section using SmartPrompt; or click the edit icon to the right of the field to name and configure a new section to use.
• Prefix: Provide a unique text string to identify properties in the section. Use the same string to create a unique clipboard page to hold the submitted values on the Pages & Classes tab.

If you select the previous option, this option appears. Check the checkbox to have the custom filter section appear at the top of the tab displaying the report. Leave it unchecked for the default behavior: when you click the filters link, the custom section appears in a popup window.

Optional. Available only for list reports. Select to replace the default display for each row of a report with a custom section. A field appears where you can select the section; select the edit icon that appears beside the selection field to create a new custom section.

Sections used for this purpose can have simple controls such as text fields, but cannot use complex controls such as grids or trees.

Note: test carefully any custom sections you use for displaying rows. You may get unexpected results as the report definition tries to populate a section which, for instance, does not account for all the properties it is asked to display.

Note: Nested sections may not render properly when used as custom sections. PRPC cannot tell the width a custom section requires. When a window is resized, PRPC does not automatically resize the width of the custom section. Design the custom section to fit into the smallest display size possible.

Optional. Only available for summary reports. Select to not show group headings in the report display. This results in a spreadsheet-style display with no subtotals, subaverages, or similar values.

When this is selected, the user can sort the report in any way desired. When group headings are shown, there are restrictions on how results can be sorted: the first n-1 GROUP BY columns in a summary report must also be the first columns in the sort order.

Optional. Available only for list reports in which the previous option to Group results has been checked.

Select to replace the default display for each group with a custom section. A field appears where you can select the section; select the edit icon that appears beside the selection field to create a new custom section.

Sections used for this purpose can have simple controls such as text fields, but cannot use complex controls such as grids or trees.

Note: test carefully any custom sections you use for displaying groups. You may get unexpected results as the report definition tries to populate a section which, for instance, does not account for all the properties it is asked to display.

Note: Nested sections may not render properly when used as custom sections. PRPC cannot tell the width a custom section requires. When a window is resized, PRPC does not automatically resize the width of the custom section. Design the custom section to fit into the smallest display size possible.

Optional. Select to have a shortcut to this report created and display in the Report Browser. When this checkbox is checked, a field appears where you specify the Category in which the report shortcut should appear in the Report Browser. See Using the Report Browser.

This checkbox operates as a one-way control:

• If the checkbox is checked and a category is selected when you save the rule, the system creates a shortcut for the report in that category, if one does not already exist.
• If you later uncheck the checkbox and save the rule again, the system does not remove the report's shortcut in the Report Browser.
• If you change the category selection and save the rule, the system creates a shortcut for the report in the newly-selected category, without removing the shortcut from the previously-selected category.

To remove a report shortcut from the Report Browser, open the Report Browser, right-click the report shortcut, and click the Delete button.

Optional. Check this checkbox to display the toolbar within the Report Viewer and allow users access to those commands that are enabled. When this box is checked, click the Options button to enable or disable specific commands in the toolbar:

• Edit Report
• Summarize
• List
• Print
• Export to Excel
• Export to PDF
• Save
• Save As

Optional. Available only for summary reports. Check this checkbox to disable the ability for users to click on any row or cell in a summary report and drill down to a detailed list of the instances included in the row or cell.

When the box is unchecked, the report used for displaying drill down results is shown, and can be changed here. The default report used for displaying drill down results is the pyDefaultReport template for list reports for the Applies To class of the report. You can specify a different report definition in this class to use for drill downs; however, note this restriction: if the report you select for drill downs is in a ruleset that is higher in the ruleset stack for the application than the ruleset of the main report, the selected subreport is not available to the main report. In this case, the main report would use pyDefaultReport as described above.

When drill down results are shown, the filter conditions in the summary report (together with conditions that represent the row or cell clicked on) override those in the custom drill down report, and no parameter values are passed to the drill down report.

Optional. Available only for list reports. Check this checkbox to display report results as a series of pages, each containing a fixed number of rows. Unchecking this box will display all results on a single page.

Paging is enabled by default, since a list report may contain many rows of data, resulting in poor performance when trying to display the entire result set at once.

As a good practice, enable paging for worklists and for other lists that users need to scan only until they find a row of interest. However, for maximum user productivity, design filter conditions and sorting in each list view rule to eliminate the need for user paging, or to present as few pages as possible when paging is unavoidable. See the PDN article When and how to configure paging in reports.

Paging causes the system to retrieve only enough data at a time to populate the number of rows entered for the Page Size property, improving response time and reducing the size of the clipboard. At runtime, users may see the busy indicator while waiting for a paging operation to complete.

When paging is enabled, click the Options button to enter settings that control how paging operates:

• Page size: The number of rows displayed on each page.
• Page mode: Controls how pages are selected.
  • Numeric — A set of numeric links appears. (This is the default mode.)
  • Next/Previous — Next and Previous buttons appear and the user can click them to move from a page to the next or previous page, in order.
  • Drop-Down — A drop-down list of page numbers appears, enabling the user to select any page to move to at any time.
• Page navigation alignment: Controls whether the controls to navigate pages, described in the Page mode option above, appear on the left, center, or right of the paging bar.
• Paging bar position: Controls whether the paging bar containing the controls to navigate pages, described in the Page mode option above,appears above or below the report, or both above and below it.

Optional. Available only for list reports. Check this checkbox to add a SmartInfo icon to each row of the report, to display additional information about that row.

When the box is checked, click the Options button to enter settings that control how SmartInfo operates:

• Header: Enter the header to display for the SmartInfo pop-up window.
• Content: Select the appropriate activity for the enabled SmartInfo, or click the edit icon to create a new activity. This activity must take one parameter, the pzInsKey of the selected row, and return the output of a section.