Drill Down tab on the Summary View form

This tab is optional. You can allow the summary view report user to drill down from summary statistics to the supporting detail by clicking a plus sign icon. When a user clicks the plus sign icon to perform the drill-down operation, Pega Platform uses information in this tab to query the database, sort the results, and present the details.

Use this tab to define the fields in each detail or drill-down row.

In contrast to the properties listed on the Content tab, these properties are not limited to those that are exposed as database columns, and can be top-level or embedded properties. However, for optimal performance, use only top-level properties.

Columns display in the order listed. Sorting occurs in the order listed.

Field Description
Type Select a view type to display when the user drills down on a row in the report. You can drill down to another report or chart from the selected row.
  • Detailed View — This option displays detailed information in the called report or chart.
  • Summary View — This option displays summary information in the called report or chart and allows you to specify an additional drill-down to another report or chart. When you select this view, a Configure button is available that allows you to configure the summary view drill-down display.
  • List View — This option allows you to specify that a list view rule is available for users at run time when they drill down for more information. When you select this view, a Configure button is available that allows you to configure the summary view drill-down display.
Configure... If you selected List View or Summary view in the Drilldown To field, clicking this button opens a window where you can identify the target rule.

Complete this window to configure a drill-down from one summary view to another from a row in the summary view, from one interactive chart to another, or from a summary view or interactive chart to a list view. (Only interactive charts, not image charts, can be the source or target.)

If the summary view rule is within a harness, and the drill-down chart replaces the original summary view chart, both the original and drill-down chart must be of the same type. If the original chart is not replaced, the drill-down chart can be of a different type.

No data set is passed to the target list view or summary view, only parameters:

  • Class Name — Applies To key part of the target summary view or list view.
  • Purpose — Second key part of the target summary view or list view.
  • Owner — Third key part of the target summary view or list view.
  • Parameter Name — Name of an input parameter in the target view, identified on the Params tab.
  • Parameter Value — Three types of values are supported:
    • Literal — Text string enclosed by quotes.
    • Parameter Reference — This is an existing parameter that gets passed to the drill-down view. For example, Parameter Name:MyParamValue and Parameter Value: param.abc. The abc parameter value in the current summary view is passed to the drill-down view. The drill-down view can access this parameter by getting the value of Param.MyParamValue.
    • Groupby Column — You can provide a "group by" column property name to pass the value of the group by value selected by the user to the drill-down summary view. For example, assume the MyGrpValue parameter holds the value of the Groupby value that you selected. When you click Operator:tom from the summary view results page, MyGrpValue holds the value of “tom”.
  • Include Column Condition — This option passes the field setting to the target view and applies the same setting. When you click an aggregate value in the summary view, the drill-down summary view or list view uses the column condition of the aggregate value along with other criteria in the drill-down view.

Click Apply to save your changes.

For an example of this feature, see the Pega Community article How to drill down to a list view from a summary view report.

Fields

Complete these fields when you select Detailed View for the Drilldown To value.

Field Description
Field Optional. Enter a property reference for a value to display at run time when users request a drill-down from the summary report.
Caption Optional. Enter text for a caption for the value in the Field field.

If your application supports users in multiple locales, choose a noun or noun phrase for the caption of 64 characters or less and select the Localize? check box on the HTML tab. Choose a caption that is already included in a language pack, to simplify localization. Click the Open icon to review or create the field value rule supporting localization. The pencil icon appears only after you select the Localize? check box on the HTML tab. See About the Localization wizard and Rules Inspector tool — Localizing forms and reports with the Field Value Inspector.

Sort Select Ascending, Descending, or No Sorting to indicate how the drill-down data is sorted. Sorting occurs in the Pega Platform server.
Format

Optional. To override the normal HTML display-mode presentation of this property, identify a control to use when presenting this property in this report. Click the Open icon to open the control. Click the Gear icon to enter parameters for the control.

Images and Links

Two controls are useful here:

  • Select reporting_image to present a clickable image in the row; reference a binary file rule in the ImageSourceName parameter in the format /dir/name.jpg.
  • Select reporting_link to present a clickable link.

parameters to reporting_image and reporting_link include an activity that executes upon click. Typically, this activity executes an HTML rule, displayed in a new window. For an example, see the Pega Community article How to include an image or link as a report column.

Export format Optional. If this drill-down display can be exported to Excel, select a control to use for the export. Ordinarily, select one of the following, as appropriate to the type of the value:
  • Export_Integer
  • Export_Decimal
  • Export_DateTime
  • Export_Time
  • Export_Date

Click the Open icon to open the control.

Hide Select to retrieve this column in the drill-down detail, but to present it in a hidden field in the HTML display.

Content

These fields are optional when you select Detailed View for the DrillDown To value.

Field Description
Page name Enter a clipboard page name to contain the report contents. (You can't use pxResults as the name of this page.)
Content activity Optional. Identify the Activity Name key part of the getContent activity for the drill-down operation, which applies to the Embed-DrilldownParams class.

The activity name must be getContent (the default value) or drill-down is disabled.

Data source of drill down view Optional. Select the data source for the drill-down display.
Key of a row Identify a property that is present in every row of the drill-down display and uniquely identifies the row.

Enter pzInsKey (identifying the handle of an instance) in most cases, where Data Source field is blank or identifies an internal class.

If the Data Source identifies an external class, enter the property that forms the key of a row. (A custom GetContent activity must copy this property to the pxInsHandle property in each page within the pxResults list.)

Get row key Select to have the report display the key field for each row.
Get distinct records Select to eliminate duplicate records in the view.
Maximum number of rows to retrieve Optional. Enter a maximum number of instances to retrieve for the report contents. As a best practice during testing, enter 500. If you leave this blank, the system enforces a limit of 9,999.

Presentation

Field Description
Enable sorting? Select to allow the user to sort report values by clicking on column headers.
Fixed header? Select to prevent the header from scrolling if a user scrolls the drill down listing.