AX1836
Configuring grid properties in a web report
The grid properties define the available features and the overall presentation of data in a web report. Using the grid properties, you can configure:
- User interaction properties such as whether users can filter columns, sort columns, and reorder columns
- Display properties such as whether the grid has a total row and whether rows with all zero values display
- Drilling properties such as what type of drilling is enabled and configuration for directed drilling
In the Report Builder, the grid properties are defined in the right-hand Configuration Panel.
To configure grid properties for a web report:
-
On the Report tab of the Report Builder, in the Report Canvas, click the grid that displays below the column setup boxes.
-
In the right-hand Configuration Panel, complete the Grid Configuration properties as needed.
Example Grid Configuration properties
The grid configuration properties are separated into two tabs:
- General: Basic grid properties that should be reviewed and configured for all web reports.
- Advanced: Advanced grid properties such as default column formats for the grid.
General grid properties
The following grid properties are available for web reports on the General tab of the Grid Configuration panel:
Column Properties
Item | Description |
---|---|
Enable column filters |
Specifies whether users can filter columns in the grid. Only applies to grids with dynamic rows; users cannot filter columns in grids where Use fixed rows is enabled.
|
Multi column sorting |
Specifies whether users can sort by multiple columns in the grid. Only applies to grids with dynamic rows; users cannot filter columns in grids where Use fixed rows is enabled.
Users can sort columns by clicking on the column header. Each click toggles through sort ascending, sort descending, and no sort. NOTE: The ability to clear the sort is only available if multi-column sorting is enabled. Otherwise, clicking a column header will toggle between sort ascending and sort descending. You can click a different column header to sort by that column, but you cannot clear the sort. |
Enable reordering columns |
Specifies whether users can reorder columns in the grid.
|
Grid Properties
Item | Description |
---|---|
Use fixed rows |
Specifies whether the grid uses dynamic rows or a fixed row structure.
|
Fixed row structure |
Specifies the fixed row structure to use in the grid. Only applies when Use fixed rows is enabled. Select an existing fixed row structure to define the rows of the grid. You can type into the box to filter the list of fixed row structures by name. Fixed row structures can be created from the Intelligence Center. For more information on creating fixed row structures, see Managing fixed row structures for web reports. |
Include total row |
Specifies whether a total row is present on the grid. Only applies to grids with dynamic rows; if Use fixed rows is enabled then the grid uses subtotal and total rows as defined in the fixed row structure.
|
Suppress zero rows |
Optional. Specifies whether data rows with all zeros are suppressed from showing in the grid. Only applies to grids with dynamic rows; all zero rows cannot be suppressed in grids where Use fixed rows is enabled. Non-key columns that meet both of the following criteria are evaluated to determine whether a row should be hidden:
If the primary table is a data table, Integer and Numeric columns on lookup reference tables are ignored—meaning these columns may have values, but the row is still suppressed if all applicable data table columns have zero values. There is one exception: reference table columns are considered if the column classification is Values and the numeric type is Currency. Calculated columns defined in the grid are not evaluated for this purpose and do not prevent a row from being suppressed. |
Enable drilling |
Specifies whether users can drill down rows in the grid to view the underlying data.
|
Grid sort order |
Specifies the sort order for data in the grid.
If a custom sort is specified but no columns are added to the sorting configuration, the grid will revert to using the default sort order. NOTES:
|
NOTE: If you created a web report using the Report Builder in version 2021.1, that report may have had a defined Data Filter in the Grid Configuration properties. These filters are now defined at the report level, in the Report Configuration properties. Any existing grid filter will be automatically converted to a general report filter. In rare cases, this conversion may result in report errors if the grid-level filter is not valid as a general report filter. If this occurs, you can delete the converted filter and re-create it as a table-specific filter.
Advanced grid properties
The following grid configuration properties are available for web reports on the Advanced tab of the Grid Configuration panel:
Use this section to view and define default column formats for the grid based on column data type. All columns added to the grid will inherit the settings defined here. By default, columns will continue to inherit any changes made to the default column formats unless the format has been overridden at the column level.
For example, the default alignment for String columns is Left. When String columns are added to the grid, they are configured to use the Default alignment, meaning Left. If desired, you can change the default alignment for String columns to Center, and all String columns in the grid that are using the Default alignment will now update to use Center alignment. However, if you have manually configured a particular String column to use Right alignment instead of the Default alignment, that column will continue to use its configured alignment of Right.
Item | Description |
---|---|
Data type |
Select a column data type to view and edit the default column formats for that type. The following data types are available:
Additionally, when you create a calculated column, you can specify its data type as one of the numeric data types. The column will then use the default column formats for that data type. The default data type for calculated columns is Currency. NOTE: Columns that would normally be treated as Number data type are treated as Dimension data type if they are used as row dimension columns or drill columns. |
Column width |
The default column width for the selected Data Type, in pixels. Enter the desired column width as a whole integer between 30 and 600. The default width for each data type is as follows:
|
Alignment |
The default alignment of the column values for the selected Data Type. If you want to change the default alignment for a data type, select one of the following: Left, Right, Center. The default alignment for each data type is as follows:
|
Use this section to view and define default number formats for the grid based on column data type. All columns added to the grid will inherit the settings defined here. By default, columns will continue to inherit any changes made to the default number formats unless the column has been configured to use a custom format.
For example, the default number format for the Currency data type uses 0 decimal places, with a thousands separator, and a negative number format of red parentheses. When a Currency column is added to the grid, the contents automatically display using this number format. If desired, you can update the default number format for Currency so that it uses 2 decimal places, and all columns using the Currency number format will now update to show 2 decimal places. This applies to columns that use the Currency number format by default, as well as columns that you have manually configured to use the Currency format. However, if you have changed a column so that it now uses a Custom number format instead of the Currency number format, then it will continue to use its custom configuration.
This section only applies to numeric data types. It does not display for data types such as String or Date.
Item | Description |
---|---|
Decimal places |
The number of decimal places used by the selected Data Type. Enter any whole number from 0 to 10. You can also use the arrow keys to move the number up or down. The default number of decimal places for each numeric data type is as follows:
The Number data type does not use decimals. |
Use 1000's separator |
Specifies whether the selected Data Type uses a thousands separator:
|
Negative number format |
The format used by the selected Data Type to display negative numbers. Select the desired format from the drop-down list. Available formats use the minus sign, or parentheses, or red text (or a combination of these formats). The default negative number format for each numeric data type is as follows:
|
Frequently asked questions
Can I disable paging for a dynamic row grid?
Currently, if the grid uses dynamic rows then the grid is automatically paged if it exceeds 25 rows. This paging cannot be disabled.
How do I define a grid-level filter to limit the data in the report?
If you want to filter the data in the grid, you can define a report-level filter. Select the report title on the Report Canvas to load the Report Configuration properties, then use the Report filters section to define one or more filters.
Because currently web reports can only contain a single grid, defining a report-level filter is effectively the same as defining a grid-level filter.