List View form
|
Complete the Display Fields tab before the Organize tab. All data are optional. Complete this tab to:
Sorting and filtering that you define on this tab runs on the Process Commander server, and occurs after sorting and filtering by the database software.
Sort by..., Filter by..., Categorize by..
These fields are not available for reports in which paging is enabled.
Field |
Description |
Sort by... |
If you complete this array, the first row identifies the major sort. Later rows identify minor sorts within the major sort. Unlike sorting defined in the Get these fields array (on the Content tab), this sorting uses the OVERRIDE SORT FUNCTION (if any) defined in the property rule. For example, use this array to sort work objects by work object ID, property Work-.pyID has an Override Sort Function. |
Sort by Column |
Optional. Identify a property for this sort. (You can choose a property not referenced elsewhere on this form.) SR-4571 |
Sort Order |
Select |
Filter by... | |
When Expression |
Optional. To display only a subset of the results retrieved by the criteria set on the Content tab, you can identify a when condition rule here, or a Boolean expression. The text you enter here becomes the content of a when directive (or a <pega:when >JSP tag) in the generated HTML. At runtime, the system evaluates this condition for each potential row of the display, displaying only those for which the result is true. If you enter two or more When Expression values, records are included only if all evaluate to true. GUESS Rows excluded by such filtering are not displayed and not sent to Excel when a user clicks the Export to Excel button. B-15284 For best performance, selecting the desired instances through the criteria or a custom activity (so they never are added to the page) rather than through this filter mechanism is preferred, when possible. |
Categorize by... |
When you complete this optional array, the initial report presentation shows rows collapsed, labeled with a plus sign (+) and the values in this array. The user can click the + to view the rows. Each collapsed row can contain a prefix, a property value, and a suffix, in the format: PREFIX: value suffix |
Property |
Optional. Identify a property to provide a value for the collapsed row. |
Caption |
Optional. Enter literal text as a prefix for the value. |
Label |
Optional. Identify a property reference. The text value of this reference appears in italics as a suffix to the row. |
These fields determine the contents of the title area. Optionally, enter a caption for each button in the Caption column, or accept the default caption text.
Field |
Description |
Organize Title | |
Customize View button |
Select to cause the Customize View button to appear in the title area. This permits report users to make a personal copy of the list view rule, altering any part of it that can be changed using the Report wizard. Enter a Caption to appear as a ToolTip.
The default ToolTip is
This capability is not
available when the Embedded option (on the
Display Fields tab)
C-2414 is selected, or when the Activity
Name identified on the Content tab is not |
Customize Criteria link |
Select to cause the Customize Summary Criteria link to appear in the title area. This permits report users to make a personal copy of the summary view rule, altering the criteria. Enter a Caption to appear as a ToolTip.
The default text is This capability is not available when the Embedded option (on the Display Fields tab) is selected. C-2414 |
Export to PDF link |
Select to cause an Export to PDF link to appear in the title area. When clicked, the report output is converted to a Portable Document Format file and downloaded to the user workstation. 5.5 GRP-306 GRP-875 See these Pega Developer Network articles for examples and instructions: GRP-3197
Your application can attach list view report output, converted to PDF, to a work object. See How to attach report output (as PDF) to a work object. This conversion uses the Public API method getPDFUtils().generatePDF(byte[] htmlStream). |
Excel button |
Select to cause the Export to Excel button to appear in the title area. This allows users to export the report contents to Microsoft Excel, and (if configured), to edit Process Commander data using Excel. Enter a Caption to appear as the button
caption. The default text is |
Edit? |
Select to allow users to edit rows of the report data using Microsoft Excel and upload the results as instances into the PegaRULES database. Proj-164 Select this only when:
|
Configure
Edit in Excel |
If you selected the Edit? checkbox, click to define the operations that are supported when editing in Excel. Proj-164 See List View rules — Completing the Edit in Excel window. |
Add to Favorites Button |
Select to cause the Add to Favorites button to appear in the title area. This allows users to add a shortcut to this report on their Dashboard or Monitor Activity workspaces. Enter a Caption to appear as the button
caption. The default text is This capability is not available when the Embedded option (on the Display Fields tab) is selected. TASK-4086 |
Open button |
Select to allow users to open this summary view rule, allowing them to update it (unless it is locked) or save a copy for personalization. Enter a Caption to appear as the button
caption. The default text is |
New button |
Select to include a New button ( New) in the title area after drill down. This allows users of the report to add a new instance of the class supporting the drill-down report, using a temporary Rule-Template-Excel rule. Select this only for data classes that do not affect the integrity of your application. Enter a Caption to appear as a button
caption The default text is |
Model name for new window |
Optional. Identify a model in the Applies
To class to be applied when users click the
New
button. If this field is blank, the system uses the model
named |
Field |
Description |
Custom Buttons | |
Label |
Optional. To include additional text-labeled buttons, complete a row of this array. Enter brief text to appear as the label. |
Onclick function |
Enter the name of a script function (JavaScript or similar) to run when a report user clicks the button defined by this row. |
Tooltip |
Optional. Enter the help text to display when a report user points to the button defined by this row. |
Fragment for custom scripts |
Optional. Identify an HTML fragment rule that contains, or provides access to, the script functions referenced in the array above. |
SubHeader |
Optional. Select an HTML rule that provides the contents of an optional subheader that appears below the header on the report display. KARAF 4/12/05 |
Link to help topic |
Optional. Enter a relative URL for a help topic that explains the operation of this list view rule. If not blank, a help button () appears in the button group. VAGUE relative to what? GUESS SP6. |