Group by section field properties

The fields for a Group By section come from the query as Display Columns for the primary business object. Use the Components panel to add fields to the control. The following figure shows this relationship. All display columns in the Group By query can be added to the Group By section. For example, triActualAreaNU has already been added to the Group By section, and triForcastAreaActualNU has not yet been added but is available in the Components section.

The image is explained in the text. — Figure 1. Example showing fields and display columns

Select what the fields represent with the Column Use property. Order the fields left to right with the Start Row. The fields of type Column must be first and in the sequence indicated by the query Order By settings. Place the other fields in the sequence you want them to appear in the Group By section.

Most are as described in "Form field properties". The properties unique to a Group By section's field are as follows:

Label Style Class

If you do not specify a value for this property, the appearance of Column labels and Group By value labels will be determined by default settings in the Style Manager.

If you do specify a value for this property, it will be the name of a field style sheet defined by the Style Sheet Editor. The style sheet determines the appearance of the Column and Group By value labels. The Style Sheet Editor is described in the IBM TRIRIGA Application Platform: User Experience User Guide.

Sub Label Style Class

If you do not specify a value for this property, the appearance of this field's Group By Column labels will be determined by default settings in the Style Manager.

If you do specify a value for this property, it will be the name of a field style sheet defined by the Style Sheet Editor. The style sheet determines the appearance of the Group By Column label (these are the circled labels in the figures for "Group by section properties"). The Style Sheet Editor is described in the IBM TRIRIGA Application Platform: User Experience User Guide.

Column Use

The value of this property determines how the column is used when the Group By section is rendered. The values are Group By field, Group By order field, Group By Column, and Column.

Group By field is the area in the Group By section described in "Group by sections". During publish, the platform validates that a Group By field is defined.

Group By order field is the field supplying the values used to order the Group By section.

Group By Column is the area in the Group By section described in "Group by sections".

Column is the area in the Group By section described in "Group by sections".

Only one field can be designated as either the Group By field or the Group By order field. The platform validates this when you click Apply.

If you do not set a Group By order field, the Group By field values are sorted alphabetically.

Start Row

The sequence in which columns are displayed comes from the Start Row property. This applies to Group By Columns and Columns. It is extremely important that the Column's Start Row is the same order as the Order By in the defined query as this determines the layout order of the section.

Start Column

Use the Start Column property to indicate that the Group By Columns should use two rows instead of one. For Group By Columns, valid values are 1 and 2. The Hide Label property hides the label on the second row if set.

The following figure shows an example of a horizontal orientation with Start Column = 2 for Actual Area and Forecast Area, and with Hide Label checked for Actual Area and Forecast Area:

If the Hide Label property had not been checked for Actual Area and Forecast Area, the second row of labels would appear immediately below the first row of labels, and would look like the following figure:

The following figure shows an example of a vertical orientation with Start Column = 2 for Actual Area and Forecast Area, and with Hide Label checked for Actual Area and Forecast Area:

If there is an issue when the platform is building a multi-row / multi-column Group By section, the platform attempts to use a single-row layout.