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
  • Data properties such as a filter to limit data in the grid, and drilling options
  • Display properties such as whether the grid has a total row and whether rows with all zero values display

In the Report Builder, the grid properties are defined in the right-hand Configuration Panel.

To configure grid properties for a web report:

  1. In the Report Canvas of the Report Builder, click the grid that displays below the column setup boxes.

  2. In the right-hand Configuration Panel, complete the Grid Configuration properties as needed.

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.

  • If enabled (default), then filter icons display on columns where Enable filter is enabled in the column configuration properties. Report users can use these icons to filter the data shown in the column. If Enable filter is disabled on a column, the filter icon is not available for that column.

  • If disabled, then filter icons do not display on any columns, regardless of whether Enable filter is enabled for the column.

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.

  • If enabled, then users can sort the grid by multiple columns. If the grid is already sorted by a column and a user clicks another column to sort, then the grid is first sorted by the most recent column and then sorted by the original column. Columns will remain sorted until the user toggles the sort disabled for that column.

  • If disabled (default), then users can sort the grid by a single column. If the grid is already sorted by a column and a user clicks another column to sort, then the sort is disabled on the original column and the grid becomes sorted by the most recent column.

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.

  • If enabled (default), then users can drag and drop columns within the grid to temporarily reorder them.

  • If disabled, then users cannot reorder columns in the grid.

Grid Properties

Item Description

Use fixed rows

Specifies whether the grid uses dynamic rows or a fixed row structure.

  • If enabled, then the grid uses a fixed row structure to define the rows. Select the structure using the Fixed row structure field. For more information, see Specifying the fixed row structure for a web report.

  • If disabled (default), then the grid dynamically generates rows based on a table column specified as the row dimension. The row dimension is specified by dragging and dropping the desired table column into the Row Dimensions box at the top of the Report Canvas. For more information, see Specifying the row dimension for a web report.

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 Report 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.

  • If enabled, then a total row displays at the bottom of the grid. If the grid data is paged, the total row shows the total of all rows across all pages.

    Use the Total row header label field to define label text for the total row, such as "Total". This text displays in the last row dimension column.

    Columns displaying numeric, non-dimensional data are included in the total row by default. If desired, you can exclude a numeric column from the total row using the column configuration properties.

  • If disabled (default), then the grid does not have a total row.

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:

  • The column data type is Integer (all types) or Numeric.
  • The column is from the primary table or an additional data table.

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.

  • If enabled, then users can drill rows in the grid. Use the Drilling type property to specify what type of drilling options are present:

    • Key columns (default): Users can drill down to the key column level of the data. These drilling options are automatically generated based on the validated key columns of the primary table. No additional setup is required.

    • Directed: Users can drill down predefined drilling paths. Use the View/Edit Configuration link underneath the Directed option to configure the drilling paths.

    For more information, see Configuring drilling for web reports.

  • If disabled (default), then users cannot drill rows in the grid.

Data filter

Optional. Defines a filter to limit the data shown in the grid. The grid-level data filter should be used instead of column-level data filters when you want the filter to impact the entire grid.

Click the Edit button to open the Filter Wizard and define a filter. Once you have defined a filter, it displays in the Data filter box.

If you want to change or remove the filter, click the Edit link again and change or delete the filter within the Filter Wizard. The Data filter box is not directly editable.

Advanced grid properties

The following grid configuration properties are available for web reports on the Advanced tab of the Grid Configuration panel:

Default column formats

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:

  • String: Columns containing text or alphanumeric values. Includes table columns using the String data type.

  • Date: Columns containing dates. Includes table columns using Date or DateTime data types.

  • Boolean: Columns containing True or False values. Includes table columns using the Boolean data type.

  • Dimension: Columns containing numeric dimension codes. Includes table columns using Numeric, Integer, or Identity data types, where the Column Classification is Dimension.

  • Decimal: Columns containing decimal numeric values. Includes table columns using the Numeric data type, where the column has a Numeric Type of Number.

  • Number: Columns containing whole integer numeric values. Includes table columns using Integer or Identity data types, where the Column Classification is Value.

  • Currency: Columns containing currency numeric values. Includes table columns using the Numeric or Integer data types, where the column has a Numeric Type of Currency.

  • Percent: Columns containing percent numeric values. Includes table columns using the Numeric or Integer data types, where the column has a Numeric Type of Percent.

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 20 and 1000.

The default width for each data type is as follows:

  • Currency, Decimal, Percent, Date, Boolean: 120
  • Number: 150
  • String, Dimension: 200

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:

  • String, Date, Boolean, Dimension: Left
  • Decimal, Number, Currency, Percent: Right

Numeric properties

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:

  • Currency: 0
  • Decimal, Percent: 2

The Number data type does not use decimals.

Use 1000's separator

Specifies whether the selected Data Type uses a thousands separator:

  • If enabled (default), numbers show with a thousands separator, such as 1,000.

  • If disabled, numbers do not use a thousands separator, such as 1000.

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:

  • Decimal, Number, Percent: Minus sign
  • Currency: Red text in parentheses

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. However, keep in mind that when the grid is exported to PDF or Excel, the paging is automatically disabled and the export file will show all rows.