Grid refresh variable for web reports

Grid refresh variables prompt users to select one or more values from a designated table column. The selected values are used to filter the data sources in the report that are dependent on the variable.

The list of values is displayed in a searchable multi-select dialog. The list can be filtered to only show a subset of values from the specified column.

This topic provides information on how Grid refresh variables behave in web reports and their configuration settings. For general information on defining refresh variables for web reports and creating dependencies between refresh variables and data sources, see Configuring refresh variables for web reports.

NOTE: In web reports, Grid refresh variables always allow selection of multiple values. You do not have to explicitly enable multi-select for the variable; it is always enabled. If you want to limit the user to only selecting a single value, use a Combo Box variable instead.

Variable behavior

The Grid variable displays as a read-only text box with a button next to it. The user can click the button to select items from the column.

Example Grid variable

Clicking the button opens the multi-select dialog. In this dialog, the user can select one or more items using check boxes.

Example multi-select dialog

The dialog is limited to displaying the first 100 values in the list. However, all values can be found by typing into the search box at the top of the dialog. The search matches on the primary value, any description columns, and any additional columns included in the display format.

The values in the list are sorted based on the display format if defined, otherwise based on the value column.

When the user clicks OK to select the values, they display in the text box using the value from the value column, separated by commas.

Example selected values

Variable properties

This section explains how to complete the variable properties for a Grid variable in a web report.

General variable properties

All refresh variables use a common set of general properties such as the variable display name, and whether the variable is enabled or required. Any special considerations for Grid variables are noted.

(missing or bad snippet)

Variable-specific properties

The following additional properties apply to Grid variable types:

Item	Description
Choose Variable Type	Specifies the variable type. Select Grid to allow the user to select one or more values from a table column.
Column	(missing or bad snippet)
Placeholder Text	Optional. Defines placeholder text to display within the variable box until a value is selected. This text also displays at the top of the multi-select dialog. If blank, then the default text "Choose a value for ColumnName" is used.
Default Value	(missing or bad snippet) You can list multiple valid values, separated by commas. In this context, it is not necessary to enclose string values in single quotation marks.
Column Filter	(missing or bad snippet)
Display Format	(missing or bad snippet)
Tooltip Column	(missing or bad snippet)