AX1836

Configure grid properties in a web report

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 Configuration Panel.

  1. On the Build tab of the Report Builder, in the report canvas, click the grid that appears below the column setup boxes.

  2. In the right configuration pane, complete the Grid Configuration properties, as needed.

The grid configuration properties are separated into two tabs:

  • General: Basic grid properties to review and configure 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 pane:

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), the filter icons appear 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 appear 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, 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, the grid is first sorted by the most recent column and then sorted by the original column. Columns remain sorted until the user toggles the sort disabled for that column.

  • If disabled (default), 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, the sort is disabled on the original column and the grid becomes sorted by the most recent column.

Users can sort columns by clicking the column header. Each click toggles through sort ascending, sort descending, and no sort.

NOTE: Clearing the sort is only available if multi-column sorting is enabled. Otherwise, clicking a column header toggles 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), users can drag and drop columns within the grid to temporarily reorder them.

  • If disabled, 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, the grid uses a fixed row structure to define the rows. Select the structure using the Fixed row structure field. For more information, see Specify the fixed row structure for a web report.

  • If disabled (default), 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 preferred table column into the Row Dimensions box at the top of the report canvas. For more information, see Specify the row dimension for a web report.

Fixed row structure

Specifies the fixed row structure to use in the grid. Only applies when you enable Use fixed rows.

Select an existing fixed row structure to define the rows of the grid. You can enter text in the box to filter the list of fixed row structures by name.

Create fixed row structures from the Intelligence Center. For more information about creating fixed row structures, see Manage fixed row structures for web reports.

Include total row

Specifies whether a total row exists on the grid. Only applies to grids with dynamic rows; if Use fixed rows is enabled, the grid uses subtotal and total rows as defined in the fixed row structure.

  • If enabled, 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 appears in the last row dimension column.

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

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

Suppress zero rows

Optional. Specifies whether data rows with all zeros are suppressed from appearing 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, users can drill rows in the grid. Use the Drilling type property to specify what type of drilling options exist:

    • 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 Configure drilling for web reports.

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

Grid sort order

Specifies the sort order for data in the grid.

  • Default: Data is sorted by the row dimension columns specified for the grid in ascending order. If multiple row dimension columns exist, the first row dimension column is the primary sort column, followed by the second row dimension column, and so on.

  • Custom: Specify one or more columns to sort the grid data in either ascending or descending order. Use the View/Edit Configuration link underneath the Custom option to select the drill columns.

    • The Edit Sorting Configuration dialog lists all columns in the grid. You cannot sort by a column that does not exist in the grid. If necessary, you can add a column to the grid to sort by that column, and then configure the column as hidden so that it does not appear in the grid.

    • To add a column to the sorting configuration, drag the column from the left pane to the right pane, and select Asc (default) or Desc for the sort order. To remove a column from the sorting configuration, click the Close X icon on the right side of the column box.

    • If multiple columns are added to the sorting configuration, the top-most column is the primary sort column, followed by the next column, and so on. You can reorder the columns in the list by clicking the drag handle on the left side of the column box and then dragging and dropping it to a new location.

If a custom sort is specified but no columns are added to the sorting configuration, the grid reverts to using the default sort order.

NOTE:
• If Multi column sorting is not enabled for the grid, the grid still honors a multi-column sort configuration when the report is initially rendered. However, if a user sorts by any column, the grid reverts to single-column sorting and does not return to the previous sort configuration other than by reloading the report.
• You cannot add process columns as custom sort columns.
• If you add a dynamic column to the sort configuration, it appears in the list with its assigned Column List report parameter name in parentheses. If you hover your cursor over the column name in the sort configuration, the current column used by the dynamic column appears in the tooltip.

Advanced grid properties

Using the properties on the Advanced tab of the Grid Configuration pane, you can view and edit Default column formats for columns in the current report. Select a column Data type that you want to configure and this section populates with the properties for the selected data type.

All columns added to the report inherit the settings defined here. By default, columns 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 preferred, 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 continues 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 the Date data type.

  • DateTime: Columns containing date-time values. Includes table columns using the DateTime data type.

  • 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 then uses 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 preferred column width as a whole integer between 30 and 600.

The default width for each data type is as follows:

  • Currency, Decimal, Percent, Date, Boolean: 120
  • Number: 150
  • DateTime, 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:

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

Numeric default properties

The following default properties only appear if the selected Data type is a numeric data type. Use these properties to define the default numeric format by column data type.

For example, the default number format for the Currency data type uses zero decimal places, with a thousands separator, and a negative number format of red parentheses. When you add a Currency column to the grid, the contents automatically appear using this number format. If preferred, change the default number format for Currency so that it uses two decimal places and all Currency columns in the grid update to show two 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 manually configured a particular Currency column so that it now uses a Custom number format instead of the Currency number format, it continues to use its custom configuration.

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:

  • 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 show negative numbers. Select the preferred format from the dropdown. 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:

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

Date and Date Time default properties

The following default properties only appear if the selected Data type is a date data type. Use these properties to define the default date format by column data type.

For example, the default format for Date columns is Month/Day/Year (such as "10/152023"). When you add a Date column to the grid, the contents automatically appear using this format. If preferred, change the default format for Date so that it appears as "October 15, 2023" instead, and all Date columns in the grid update to use this format. However, if you have manually configured a particular Date column so that it uses a different date format instead of the default format, it continues to use its custom configuration.

Item Description

Date format

or

Date Time format

The format used by the selected Data Type to show date or date-time values. Select any of the full date formats supported by Date and DateTime columns, including custom formats. By default, the formats are:

  • Date: 10/15/2020
  • Date Time: 10/15/2020 13:25

NOTE: Only full date formats are supported as the default format. If you configure an individual Date or DateTime column to use a different date part, such as Year or Quarter, the default date format no longer applies, and the column is treated as a Dimension data type.

Custom Date format

or

Custom Date Time format

Use this field to define the custom date or date-time format, if Custom is specified as the Date format or Date Time format. For more information about the syntax to define custom date and date-time formats, see Custom formats.

Frequently asked questions

Can I disable paging for a dynamic row grid?

If the grid uses dynamic rows, it is automatically paged if it exceeds 25 rows. You cannot disable this paging.

How do I define a grid-level filter to limit the data in the report?

To filter the data in the grid, define a report-level filter. Select the Filters tab of the Report Builder to define one or more report-level filters.