Harness, Section, and Flow Action forms
|
A Grid layout allows users to view (and possibly edit) values in a spreadsheet format of a Page List
or Page Group
property, or a Report Definition. GRP-7426 This layout, as an improved alternative to Row Repeat, Column Repeat, or Tabbed Repeat, controls when large amounts of data need to be displayed. The layout can display a custom skin; is cross-browser compatible; is sortable by column; fields can be configured to be editable and localizable. PROJ-185 Sequoia See Pega Developer Network article PRKB-26089 How to add a Grid layout to a section for an example.
Adding and configuring a Grid layout
Page List
, Page Group
, or Report Definition you want to use in your layout and drag it to the section. Grid
as the layout type.Grid
as the repeat type.To delete a Grid layout, select the layout and click the Delete Row button (). Do not use the Delete Cell button for this action.
You configure many elements in a grid layout using properties panels. To display the panels, turn on the wireframe, select an element, and click the magnifying glass icon (). To select an element, click the following:
Property fields may appear at the top of the panel, or in one or more tabs. If the panel is pinned (), click Apply to apply your changes. Click the red x at the top right of the panel to close it. If the panel is not pinned, click Apply to apply your changes and continue editing, or OK to apply your changes and close the panel.
The Grid layout has three areas:
Adjust the grid repeat layout area
Select the Grid Repeat Layout header and open the properties panel. Configure the layout using the following fields:
Field |
Description |
||||||||||||||||||||||||||
Format |
Choose a format to control what appears above the layout (known as a header or subheader), and the appearance of both the header and any subheader, and aspects of the body. This choice primarily affects styles and appearance.
Information in or below a subheader (including Using the Branding wizard, you can review or revise the styles (colors, fonts, padding and margins) associated with each header or subheader format.
|
||||||||||||||||||||||||||
In the workform CSS style sheets, the various styles named groupTitleBarzzzz define the appearance of the SubHeader element; for example groupTitleBarBackground. For A, the corresponding styles are named a_groupTitleBarBackground and so on. Similarly, the names of styles for B, C and D start with b_groupTitleBar, c_groupTitleBar, and d_groupTitleBar respectively. | |||||||||||||||||||||||||||
Title | Optional. Enter text to appear in the header or subheader. This text may include directives or JSP tags, such as <p:r > or <pega:lookup >.
If you plan to localize the application using this rule so the application can support users in various languages or locales, choose the text carefully and limit the length to no more than 64 characters. When practical, choose a caption already included in a language pack, to simplify later localization. A field value rule with this text as the final key part is needed for each locale. See About the Localization wizard. This field is not visible if the Format field contains |
||||||||||||||||||||||||||
Visible When |
Optional. To control visibility of this header, enter or select one of the following:
To make a dynamic condition, enter a simple Java comparison of a property and a value, or a combination of such comparisons using parentheses and the && and || operators, such as: (.Width >= "20") && (.Length >= "40) This causes dynamic execution of the condition each time the value of a property mentioned in the condition changes. (Mark the fields containing such properties as a Client Event.) |
||||||||||||||||||||||||||
HTML |
Appears when you select the Custom format. Identify the second key part (Stream Name) of an HTML rule that defines the display of the header contents. |
General tab
Depending on your Format choice, you may see here a Header Type field. The available options are:
Bar
|
Provides a static horizontal bar at the top of the layout. |
Collapsible
|
Provides a horizontal bar at the top of the layout, with the ability to expand or collapse, to show or hide the layout, when clicked |
Tabbed
|
Creates a new TabGroup to which additional layouts can be added. |
Accordion
|
Creates a new group of layouts that contain collapsible headers. Only one layout can be displayed at once. |
Depending on your Header Type or Format choices, you may see one or more of these fields:
Expand When | Optional. Select a when condition rule to control whether this layout first appears expanded or collapsed. If you leave the field blank, the state of the layout (expanded or collapsed) when you save the Harness, Section, or Flow Action form becomes the state the next time the grid is displayed. | ||||||||||
Defer Load? | Appears for Tabbed or Accordion values of the Header Type. Select if you want the system to retrieve only the data necessary for the current tab or accordion display. When another tab or accordion is selected, the system will retrieve further data for it. This speeds up first display of the page. |
||||||||||
Retrieve Activity | Appears when you select Defer Load. Select the activity that will retrieve the data. | ||||||||||
New Tab Group | For Header Type of Tabbed only. Select to present this tab as the first in a distinct group of tabs, identified by indenting and optionally styles. |
||||||||||
New Layout? | For Header Type of Accordion only. Select to start this accordion element as the first in a group. |
||||||||||
Template Styles | If you selected a Tabbed or Accordion header style, choose a SmartLayout template to control the number of columns created. |
||||||||||
Width | Select a grid-width option to determine whether the width of the individual columns within the layout (action and repeating areas) are set as a percentage or in pixel values. Use the options as follows:
|
||||||||||
Paging |
Optional. Choose a format for presenting the data results in segments — known as pages — each containing a fixed number of rows (defined in the Rows per Page setting). The system retrieves a segment from the total data set on the clipboard and presents the page navigation controls in a format defined in this option. You can drag and drop rows in all paging options. When you select an option, the paging gadget (pyGridPaginator section) appears in the right top Action area cell. You can drag and drop the gadget onto any cell in an action area (do not drop into the repeating area). If the results produce less than one page, the paginate gadget does not appear at runtime. V6.2 GRP-23116 pashm The options are:
In cases where the data set is large and performance is an issue, you can populate the clipboard incrementally using the Paginate Activity on the Advanced tab. |
||||||||||
Rows per Page | Appears if you select a Paging option. Select the row limit per page (20 is the default). To specify a custom value, select Other and enter a positive integer in the empty field. |
||||||||||
Style | Appears if header type is Bar or Collapsible . Select a style for previewing the repeating area elements (text, borders, backgrounds, and images) as defined in the workform CSS text file created by the Branding wizard. Specify the appropriate skin in your Designer Studio General Preferences panel. The initial settings are as follows:
Use the Branding wizard to modify the settings for any of the styles. Open the 4. Styles and Formats panel in the wizard and select Category |
Advanced tab
Header Image | To add a header image at the top of the Grid:
The image must already be present in a binary file rule that is part of your application; you cannot search your local computer or the Internet through the Image Catalog. |
Image Title | Appears when you select a Header Image. Add text here to describe the image: those using assistive devices will hear this title although they may not be able to perceive the image. |
Style Prefix |
Optional. If the Header Type is For example, type A in this field to use styles named .A_standardheader* rather than the normal .standardheader* styles. Define the prefixed styles in your workform_zzzzz.css text file (created by the Branding wizard) or in another text file that you identify on the Scripts and Styles tab of the Harness form. To learn more about style sheets, see Understanding CSS styles. |
Paginate Activity | Optional. Appears if you selected a paging option in the Paging field on the General tab, and the data source is a Page List or Page Group property. V6.2 GRP-21887 Extended for filtering - pashmYou cannot use this activity with a Report Definition source. Select a custom activity that populates the clipboard from a Page List in a page size you define. Because the activity limits clipboard size, this option is useful when retrieving large amounts of data from an external Web service or database. You can also use this activity to control sorting and filtering behavior. For guidance on configuring the parameters in your activity, use the standard activity pyTemplateAdvancedGridActivity. |
Activity Sorting | Appears if you enter a Paginate Activity. Select if you want the activity to control sorting behavior. For example, if a user is on the fifth page and clicks the sort control on the grid header the above mentioned parameters are passed to the activity, which populates the clipboard with the first page of the entire data sorted on the column represented by the parameter sortProperty . If you do not select this option, the Obj-Sort method is applied to the page in view mode only. |
Activity Filtering | Appears if you enter a Paginate Activity. Select if you want the activity to control filtering behavior. V6.2 GRP-21887 pashm |
If you select the Standard or Standard (sub) formats, a cell appears to the right of the grid's title.
Open the properties panel to set the following values:
Value | Select a field value that appears as the column title. |
Label For | Indicate the property that appears in this column in the repeating rows. |
General tab
Visible | Select one of the options presented. The default is Always . If you select Other Condition , the Condition field appears. Select or create the when rule that governs this cell's visibility. |
Required | Select this option to make this a required field if the user adds data to the display. |
Wrap Text | Select this option so that long text entries in this field appear over multiple lines, rather than requiring a scrollbar. |
Read Only | Select this option to prevent edits to this field. You can refine this control by selecting or creating a when rule in the Read Only Condition field that appears when you select this option. |
Advanced tab
Width | Specify the cell width in pixels. |
Height | Specify the cell height in pixels. |
Default Value | Specify a default value for this field. Click the magnifying glass icon () to display the Expression Builder, where you can select or create an expression to generate the default value. Leave the field blank if it does not require a default value. |
Read-Write Style | Displays the stylesheet settings for this cell when editing is enabled. |
Read-Only Style | Displays the stylesheet settings for this cell when editing is disabled. |
Inline Style | Optional: Override the stylesheet settings in this cell with local values.
Enter CSS code for an inline style for a cells in the column. For guided assistance in composing a style definition, click the magnifying glass icon () to open the Style Editor. You can select from predefined lists or type a style definition directly, and preview the results. |
Use Heading Styles | Select to display the cell values with the same style the column heading uses — changes the cell HTML element from <TD> to <TH>, with a resulting style change. |
Adjust the Repeat Grid repeating area
Select the Repeat Grid header and open its properties panel to set the following values:
Source
|
Select either a Property (default) or a list-type Report Definition as the data source. You cannot select a summary-type Report Definition. |
List/Group
|
If you specified Property , select the Page List or Page Group property as the data source. |
Applies To
|
If you specified Report Definition , select the Applies To key part of the rule. |
Report Definition
|
If you specified Report Definition , the list contains list-type reports. Select the Report Name key part of the rule.
|
General tab
Edit Mode | Choose from the displayed options:
Modal Dialog , Embedded Pane , and Expand Pane , click the pencil icon next to the field to open the template section rule used to render the layout. By default, the templates are standard rules .pyGridModalTemplate, .pyGridDetails , and .pyGridRowDetails, respectively. To create custom templates, copy these rules into your Applies To class. Do not change the Purpose. V6.2 GRP-19651 pashm |
||||||||||||
Depending on the mode you select, you will see a different array of the following fields: | |||||||||||||
Flow Action |
Appears if edit mode is Modal Dialog or Embedded Panel , or Read Only and Show Details is selected. Select or create the flow action that will provide the form for the modal dialog or detail area that appears when the user clicks a row. V6.2 GRP-2025 pashm |
||||||||||||
Reordering | Select to allow users to move objects higher or lower on the display by dragging and dropping individual rows. Depending on the properties of the objects the rows represent, rows may be moved above or below other rows, or dropped into a row that can receive them to become child entries of that row.
Unavailable if source is Report Definition. |
||||||||||||
Row Resizing | Appears if px-fixed is selected in the Width field on the Grid Repeat Layout properties panel. Select to allow users to click a row border and drag it beyond the Height setting in the Row Properties panel. V6.2 GRP-19650 pashm |
||||||||||||
Row Numbers | Optional. Select if you want to sequentially number the rows in the grid. | ||||||||||||
Sorting | Select to allow users to sort on a column in the grid. This setting applies to all columns. You can disable sorting for individual columns by clearing the Enable Sorting checkbox in a column's Cell Properties panel. Sorting is not available for columns containing Value Lists , Page Groups , images, or controls.
If enabled, a tool tip appears at runtime when the user hovers the mouse pointer over the column header. The user can alternate the sort order (ascending/descending) by clicking the header. Icons indicating ascending sort () and descending sort () appear to the right of the header label. You can use the Branding Wizard to replace the default icons. See Branding wizard — Layouts. Sorting is performed on all rows in the grid. If paging is enabled and the user changes the sort order, the grid view returns to the first page. |
||||||||||||
Filtering | Select to allow users to show only those rows that match a column value filter. This setting applies to all columns (except as noted below). You can disable filtering for individual columns using the Enable Filtering checkbox in the Column Properties panel. V6.2 GRP-22524 pashm If a column can be filtered, a filter icon ( ) appears on the right side of the column's header cell. The user clicks the button to display the filter pop-up menu. On the menu, the user selects the checkbox next to each property to include. Filtering mechanisms also appear in the menus for the following property types:
When finished, the user clicks Apply. The filter icon changes to a filter-on icon () indicating that a filter has been applied to the column. You can use the Branding Wizard to replace the default icons. See Branding wizard — Layouts. Columns containing images, controls, and subsections cannot be filtered. In addition, the following property types cannot be filtered:
|
||||||||||||
Show Details | Appears if edit mode is Read Only . Select to allow the user to click a row and display its flow action details beneath the row in read-only mode. The user can expand multiple rows. Enter the flow action in the Flow Action field. V6.2 GRP-2025 pashm |
||||||||||||
Expand All | Appears if Show Details is selected. Select to display details for all rows when the user opens the form. V6.2 GRP-2025 pashm | ||||||||||||
Fixed Size | Appears if px-fixed is selected in the Width field on the Grid Repeat Layout properties panel. Select this option to specify the maximum height and width of the layout. Further fields appear:
|
||||||||||||
Open on double-click | Appears if the Edit Mode is Read Only . When checked, the related work object opens for editing in a work object gadget when the user double-clicks on a row of data in the display. If Process Commander cannot find the gadget, it opens the work object in a new tab or new window. |
Advanced tab
Right Click | Optional. Specify a the Name key part of a navigation rule that defines a context menu to appear when the user right-clicks a row in the grid. Such a menu can offer standard actions such as "Add After", "Delete", and so on. See About Navigation rules and Pega Developer Network article PRKB-26111 How to create context menus for grid layouts using navigation rules. |
ID | Optional. Provide an identifier for this grid. Start with a letter, use no spaces, and include only alphanumeric characters, dashes, or underscores. |
Summary | Describe the data to be displayed. |
Refresh on Update | Appears if the Edit Mode is Modal Dialog . When checked, the entire layout is refreshed each time data is updated or submitted. |
Append Activity | Select or create an activity that runs when the user adds an entry. |
Delete Activity | Select or create an activity that runs when the user deletes an entry. |
Target for Edit |
This field appears when edit mode is Embedded Pane . Select a custom section in which you want the details to appear. For example, assume you want the detail area to appear to the right of the grid instead of below it (default). Create a section (named gridResults) containing a two-column layout. Embed the grid in the first column and an empty section in the second column. Enter the name of the empty section in Target for Edit. |
Select a column in the repeating area and open its properties panel.
Width | Specify the column width of this column in pixels. You can also adjust the width of a column directly:
The unlabeled Use at Runtime checkbox to the right of the width field is enabled by default and cannot be edited. This forces the Width value to be used by the browser at runtime, even when data values in this column or in other columns would otherwise cause the browser to present a wider or narrower column. Data values may sometimes wrap or appear truncated. |
Inline Style | Optional: Override the stylesheet settings in this cell with local values.
Enter CSS code for an inline style for a cells in the column. For guided assistance in composing a style definition, click the magnifying glass icon () to open the Style Editor. You can select from predefined lists or type a style definition directly, and preview the results. |
Enable Sorting | Appears if the Enable Sorting checkbox is selected on the Repeat Grid panel. It is checked by default. Clear this checkbox to disable sorting on this column. |
Use Heading Styles | Select to display the cell values with the same style the column heading uses — changes the cell HTML element from <TD> to <TH>, with a resulting style change. |
Enable Filtering | Appears if the Filtering checkbox is selected on the Repeat Grid panel. Clear this checkbox to disable filtering on this column. V6.2 GRP-15908 pashm |
Select a column header and open its properties panel.
Value | Enter the title for this column. |
Label For | Select the property that will be rendered in the header cell of this column. |
General tab
Visible | Select one of the available values. If you select Other Condition , a field appears where you can specify or select the When rule that checks whether the column is to be visible. |
Required | Select to make the values in this column required. |
Wrap Text | Select to force the text in this column to wrap to additional lines if it is longer than the width of the column. |
Read Only | This option is selected by default, which prevent edits to this field. You can refine this control by selecting or creating a when rule in the Read Only Condition field that appears when you select this option. |
Advanced tab
Width | Specify the width of the column in pixels. Provides the same control as the Width setting in the Column properties panel. |
Height | Specify the height of the cell in pixels. Provides the same control as the Height setting in the Row properties panel. |
Read-Write Style | Displays the stylesheet settings for this cell when editing is enabled. |
Read-Only Style | Displays the stylesheet settings for this cell when editing is disabled. |
Inline Style | Open the Style Editor panel for this cell to override the stylesheet settings with local values. |
Use Heading Styles | Select to display the cell values with the same style the column heading uses — changes the cell HTML element from <TD> to <TH>, with a resulting style change. |
Select either row in the repeating area and open its properties panel.
Height |
Enter a positive number for the height in pixels of this cell. (At runtime, normal browser processing for rendering tables determines the actual displayed height.) You can also adjust the height of a row directly:
The unlabeled Use at Runtime checkbox to the right of the width field is enabled by default and cannot be edited. This setting forces the Height value to be used by the browser at runtime, even when data values in this column or in other cells would otherwise cause the browser to present a taller or shorter column. |
Inline Style | Optional. Open the Style Editor panel for this cell to override the stylesheet settings with local values. |
Make Header? | Select to display all the cell values in the row with the same style that the column heading uses. This is an alternative to individually selecting the Use Heading Styles checkbox for each column. This option is unchecked by default. |
Select a cell from the second row in the repeating area and open its properties panel.
|
General tab
Visible | Select one of the options presented. The default is Always. If you select Other Condition, the Condition field appears. Select or create the When rule that governs this cell's visibility. |
Required | Select to make this a required field if the user adds data to the display. |
Wrap Text | Select so that long text entries in this field appear over multiple lines, rather than requiring a scrollbar. |
Read Only | Select to prevent edits to this field. You can refine this control by selecting or creating a When rule in the Read Only Condition field that appears when you select this option.
This setting has no effect if the data source is a Report Definition. |
Advanced tab
Width | Specify the width of the column in pixels. Provides the same control as the Width setting in the Column properties panel. |
Height | Specify the height of the cell in pixels. Provides the same control as the Height setting in the Row properties panel. |
Default Value | Specify a default value for this field. Click the magnifying glass beside it to display the Expression Builder, where you can select or create an expression to generate the default value. Leave the field blank if it does not require a default value. |
Read-Write Style | Displays the stylesheet settings for this cell when editing is enabled. |
Read-Only Style | Displays the stylesheet settings for this cell when editing is disabled. |
Inline Style | Open the Style Editor panel for this cell to override the stylesheet settings with local values. |
Use Heading Styles | Select to display the cell values with the same style the column heading uses — changes the cell HTML element from <TD> to <TH>, with a resulting style change. |
The delete icon appears at the right of the repeating row in this area, to indicate how and where it appears at runtime. Do not use it to attempt to remove cells or rows while editing the layout.
The Grid layout has two action areas, one at the top and one at the bottom of the display. You can use one or both.
If you use both, configure each action area separately.
Select Action Top or Action Bottom, then display the properties panel. Select a column header and open its properties panel.
Visible When: | Optional. If the action area is only visible under certain circumstances, select or create a when rule. |
General tab
This tab has no options.
Advanced tab
ID | Optional. Provide an identifier for this grid, for JavaScript use. Start with a letter, use no spaces, and include only alphanumeric characters, dashes, or underscores. |
Select a column in one of the action areas and open its properties panel.
Width | Specify the column width in pixels.
Clear the Use at Runtime checkbox (unlabeled) next to the width field to allow the browser at runtime to determine the width of this column based on the size of the column contents and the size of other columns. The width may vary from use to use depending on the contents of this cell and other cells. (When cleared, the generated HTML for this column includes a <TD> element with no WIDTH= attribute.) The Width value is used as you view the rule form, but not at runtime. For example, clear this checkbox if the cell is to contain a section rule that may be wide in some situations and narrow in others. Select (default) the Use at Runtime checkbox to force the Width value to be used by the browser at runtime, even when data values in this column or in other columns would otherwise cause the browser to present a wider or narrower column. If checked, data values may sometimes wrap or appear truncated. |
Inline Style | Optional. Enter CSS code for an inline style for a cells in the column. For guided assistance in composing a style definition, click the magnifying glass icon () to open the Style Editor. You can select from predefined lists or type a style definition directly, and preview the results. |
Enable Sorting | Appears and selected by default if Sorting in the Repeat Grid properties panel is selected. Clear the checkbox to disable sorting on this column. |
Use Heading Styles checkbox | Select to display the cell values with the same style the column heading uses — changes the cell HTML element from <TD> to <TH>, with a resulting style change. |
Enable Filtering | Appears and selected by default if Filtering in the Repeat Grid properties panel is selected. Clear the checkbox to disable filtering on this column. |
Select the row in the top or bottom action area and open its properties panel.
Height |
Enter a positive number for the height in pixels of this cell. Clear the Use at Runtime checkbox (unlabeled) to allow the browser at runtime to determine the height of this row based on the size of the row contents and the size of other rows. The height may vary from use to use depending on the contents of this cell and other cells. (When cleared, the generated HTML for this column includes a <TD> element with no HEIGHT= attribute.) The Height value is used as you update the rule, but not at runtime. For example, clear this checkbox if the cell is to contain a section rule that may be tall in some situations and short in others. Select the Use at Runtime checkbox to force the Height value to be used by the browser at runtime, even when data values in this column or in other cells would otherwise cause the browser to present a taller or shorter column. |
Inline Style | Open the Style Editor panel for this cell to override the stylesheet settings with local values. |
Make Header? | Select to display all the cell values in the row with the same style that the column heading uses. This is an alternative to individually selecting the Use Heading Styles checkbox for each column. This option is unchecked by default. |
Add a control, property, or other section rule that is appropriate to the display and function of your data. Configure the section rule's properties by selecting it and then displaying the properties panel. For buttons, see Section and Flow Action forms — Adding a Button Control.