You are here: Reporting > Deprecated report types > Summary View rule form > Summary View form - Completing the Format tab

Summary View form - Understanding the Format tab

  1. About
  2. New
  3. Content
  4. Drill Down
  5. Organize
  6. Format
  7. Chart
  1. Pages & Classes
  2. Join
  3. HTML
  4. History
  5. More...

All fields on this tab are optional. Complete this tab to control the runtime appearance and behavior of rows of the display, and up to two pop-up SmartInfo sections.

View Style

Field

Description
Style Name

Optional. To override the default CSS styles associated with the display of this summary view report, identify the final and middle key part of a text file rule containing report styles, with the format css/reports_zzzz, where the rule key is webwb.reports_zzzz.css.

You can override the styles for all list view and summary view reports at the portal level, through a skins rule that references your custom report styles. See About Skin rules.

Events Handling

Field

Description
Events Handling

Complete these optional fields to allow the view to respond to mouse clicks. The response can be an activity, started on the Pega Platform server, or a JavaScript function, executing in a client browser session.

When the parameter param.glimpseMode is set to the literal value Scripts, the system responds to click events by calling the script identified in the call script function field. Otherwise, it responds by calling the activity.
Single click event - call Activity

Optional. Identify an activity to run upon single click.
call script function

Optional. Identify a JavaScript function to run upon single click.
Custom tool tip for summary view Optional. Enter Tooltip text to appear explaining the single-click event.
Custom tool tip for detailed view Optional. Enter Tooltip text to appear explaining the drill-down to detailed view.
Target Frame

Optional. Identify the HTML frame in the display for the output of the event. The default frame is DETAILS.
Fragment for script functions

Optional. Identify an HTML Fragment rule that contains the JavaScript functions identified above, or that references a static file containing the script functions.

Preview Setting

Field

Description
Show glimpse of record?

Select if you want the summary view display to be included in a FRAMESET. The upper frame displays the drill-down data. The bottom frame renders the HTML code produced by the activity in the Single Click event — call Activity field.

Size of top frame in %

Optional. If you selected Show glimpse of record?, specify here what percent of the height of the workspace is to hold rows of the report. For example, enter 80 to leave 20 percent of the height for the FrameSet information.

The default value is 70.

SmartInfo Settings (for hover)

Optionally, you can define a source for HTML code to be rendered in a pop-up window or displayed as an embedded <DIV> when users hold the mouse pointer over a row (hover) or when they click a row expand arrow(Row Expand Arrow) at the beginning of the row. For example, this capability can allow users to review details about a work item on a worklist, without requiring the users to open the work item.

SmartInfo pop-ups are designed for read-only presentation. Do not attempt to include input fields or other controls.

Field

Description
Header

Enter text to appear in the header of the pop-up window. Alternatively, if this summary view report is to be localized, identify a field value rule to contain the header text.
Content

Identify the name of an activity to develop the HTML text to be rendered. This activity must meet the following conditions:

  • The Applies To key part of the activity matches the Applies To key part of the summary view rule, or is a parent class of this list rule
  • The activity accepts a parameter named keyHandle.
  • The activity assembles and returns text or an HTML stream that meets certain restrictions listed here.

The activity can return HTML code that is a partial document that contains:

  • No <HTML> or </HTML> elements
  • No input fields
  • No <TEXTAREA > elements
  • No JavaScript code or calls

Additionally, when rendered by a browser as a pop-up, the window must be modest in size. For an example activity that meets these criteria, see PDN article How to enable a SmartInfo display on report rows.

It may be beneficial to record in the Description field a notification that this capability is available, for example:

Hold mouse pointer over any row to see details...

This facility uses AJAX to communicate the request to the Pega Platform server.
Embedded

Select to have the SmartInfo content embedded in the report to display when you click the expand arrow at the beginning of the row.

When selected, at runtime a Row Expand Arrow (Row Expand Arrow) changes to a Row Collapse Arrow (Row Collapse Arrow), the workstation sends a request to the server to run the Content activity specified in the previous field, and the resulting HTML output appears below the current line.
Field

Optional. Select one field — from those appearing in the Display fields tab — to activate the SmartInfo display — to cause the SmartInfo display to appear only when the mouse pointer is held over a value in that field.

If blank, the SmartInfo display is activated when the mouse pointer is held over any field in the row and does not move for at least 700 milliseconds. The workstation sends a request to the server to run the Content activity specified in the previous field, and the resulting HTML output appears in a pop-up window.

This field appears only when the Embedded? option is not selected.

Right-click smart info settings

Optionally, you can define a source for HTML code to be rendered in a pop-up window or displayed as an embedded <DIV> when users right-click a value in the row. For example, this capability can allow users to review details about a work item on a worklist, without requiring the users to open the work item.

SmartInfo pop-ups are designed for read-only presentation. Do not attempt to include input fields or other controls.

Field

Description
Header

Optional. Enter text to appear in the header of the pop-up window. Alternatively, if this summary view report is to be localized, identify a field value rule to contain the header text.
Contents

Optional. Identify the name of an activity that computes the HTML text to be rendered. This field functions similarly to the Content field in SmartInfo Settings.
Field Optional. Select one field — from those appearing in the Display fields tab — to activate the SmartInfo display — to cause the SmartInfo display to appear only when the user right-clicks over a value in that field. If blank, the Smart Info display is activated from a right-click in any field in the row.

The workstation sends a request to the server to run the Content activity specified in the previous field, and the resulting HTML output appears in a pop-up window.

Header and Footer

You can add a header and footer to reports. For an example, see PDN article How to add a header or footer to a report.

Header Optional. Select a section that specifies content to be included in the section as a header.
Footer Select a section that specifies content to be included in the section as a footer.

About Summary View rules

Open topic with navigation