Show
all
Execution of a
summary view rule
To present a summary view report to a user, your activity can call
the standard activity Rule-Obj-SummaryView.ShowView.
Through parameter options, you can choose to retrieve the data from
the database and add it to the clipboard with or without
displaying.
Specify one of four values for the pyAction
parameter:
Prepare
— Execute all aspects of the summary
view rule except the HTML display. KARAF 7/27/04
Refresh
— Execute the entire summary view
rule, retrieving data from the database, sorting and filtering the
data, and presenting the display.
Redisplay
— Execute the display aspects of
the summary view rule, using data previously retrieved.
Sort
— Resort the existing data. (WAS
WRONGbased on the Organize
tab)
To specify that execution is to use a reports database (regardless
of the setting of the Use reports database? checkbox
on the Contents tab), set the
pyUseAlternateDb
parameter to true. GRP-445 DSILA
9/16/08
To remove the data page after the initial display (reducing the
size of the clipboard), set the removeDataPage
parameter
to true.
To execute a summary view report or interactive chart when the user
clicks a link, such as on a portal gadget, call the built-in
JavaScript function showSummary()
, which calls one of
these two activities. KARAF 9/27/2007 and PRKB-24090 as
corrected.
The older activities Rule-Obj-SummaryView.ShowGraph
and Rule-Obj-SummaryView.ShowViewGraph. are deprecated.
KARAF 10/10/06 Clinic
Summary view rules can accept additional parameters for selection,
by referencing them with the notation param
.name in the
Value column of the Criteria array
on the Content tab. Ensure that processing
sets values for these parameters before the summary view rule
executes. For a similar example, see Pega Developer Network article
PRKB-25410 How to use parameters as selection
criteria in a list view rule.
Report title
from Full Description field
The text of the Full Description field (property
pyDescription) of a summary view rule on the History tab appears to application users as a report
title. Choose text that clearly describes the report contents. You can
include reference JSP tags (or reference directives) in the
Full Description. For example:
List of {pagename.property1} as of
{pagename.property2 }
Include only references that are certain to be present. This
feature can support localization, through language-specific RuleSets.
KARAF 1/2?/04B-3413
You can't place JSP tags or directives other than the reference
tag in the Full Description field.
If your summary view rule calls a custom getContent activity, the
activity can set property values that are then displayed in the title.
F-15 Vidoni
Personalization
R-5432 If your access group includes an unlocked RuleSet
version, you can use the Customize View feature. Use the Customize
View button to create a
personal copy of the summary view rule, with your Operator ID as the
last key part. DELETED A local RuleSet is one that has the
Local customization? box selected. B-10902
Performance and
limits
The summary view facility works best for queries involving 1,000 or
fewer rows. It does not support queries that contain more than 10,000
rows.
To the extent possible, design summary view reports to maximize
processing by database software (based on the Content tab) and reduce processing within the Process
Commander server.
Access Role
restrictions
To execute a summary view rule, users must have the ability to search
through instances of the class identified in the Applies
To key part. Accordingly, users must have an access role that
links to an Access of Role to Object rule (for the Applies
To class or a parent class) in which the Search
Instances value grants read-only access. KARAF
10/5/04
Time zone
conversion of DateTime values
When processing a summary view report, the system converts
DateTime
values (but not
Date
or
TimeofDay
values) in the results are converted to display
in the time zone of the user, based on the
Time Zone
value on the
Availability tab of the
Operator ID instance. This conversion affects selection criteria and
displayed results, and so may present a different day and time for
different users.
KARAF B-15820
Heat map
chart
Using a summary view rule and a
special section, your application can include a heat map about work
objects, assignments, or other application data. See Pega Developer
Network article
PRKB-25614
How to create a heat
map.
Agent can
produce scheduled reports as files
Using an agent and a Connect File rule, your application can produce
PDF files of reports, on a daily or other regular schedule. See
PRKB-25731
How to product reports on a nightly
schedule.
Display of
generated Java code
When you save a summary view rule, the system converts your HTML
and JSP tags to Java source code. As a learning or debugging aid, you
can review this Java code.
C-1665Click the Show Java toolbar button () to see the
system-generated Java code that implements the summary view rule. The
window presents a read-only preview of the Java that implements this
rule instance. This Java code is not identical to the Java that
executes at runtime, which includes Java code inlined from other rule
instances and reflects rules in the requestor's RuleSet list.
Parent
class
The immediate parent class of Rule-Obj-SummaryView and
Rule-Obj-ListView classes is the
Rule-Obj-Report-class. At runtime, the system uses stream
processing to assemble the query results.
About Summary View
rules