Concepts → Prompt
An prompt is a type of dashboard filter. A dashboard developer creates and configures the properties of one or more prompts for a given dashboard.
A prompt specifies either a filterable column or filter expression for a dashboard runtime filter. In this regard, a prompt overrides the default behavior of dashboard which is to coalesce a list of dimension columns from all insights on all tabs as filterable columns available in the Filter and Search controls of the Filter bar. Once defined and configured, a prompt appears in the Filter dialog in Filter pane.
A prompt has various properties. For example, a prompt can serve as a default dashboard runtime filter with or without a default filter value. Depending on the prompt’s properties, a prompt will also appear as a filter bar pill. A prompt with a default value, including an undefined value, appears as filter bar pill. If there is more than one prompt, a dashboard developer can order prompts alphabetically or manually so as to affect how the prompts appear as filterable columns in the Filter dialog of the Filter bar.
Unlike other dashboard filters, a prompt can have an undefined filter value. A prompt that has a filter expression with an undefined filter value is an incomplete dashboard runtime filter, and as such, does not affect the insights on the dashboard.
A prompt can also serve as mandatory dashboard runtime filter that has a default filter value. A dashboard consumer is unable to remove or clear a mandatory prompt.
In addition, the configuration of a prompt supports enabling a default for a hierarchy level for a self-referential table.
Here are some the reasons why a dashboard developer creates one or more prompts for a given dashboard:
- Govern the list of available filterable columns
- Specify a measure or key column as a filterable column
- Specify complex filter expression as a filterable column
- Control the display order of filterable columns in the Filter dialog of the Filter bar
- Implement a default dashboard runtime filter for a hierarchy level
- Implement a default dashboard runtime filter that appears as removable filter bar
- Implement a mandatory dashboard runtime filter that is a non-removable filter bar pill
A dashboard developer with Edit access rights to a dashboard can create and edit one or more prompts. Here’s how:
- In the Action bar of a dashboard, select More Options (⋮ vertical ellipsis icon).
- In the More Options menu, select Manage Filter & Prompts.
- In Dashboard Filters, select Prompts.
- From the Data panel, drag & drop a column or formula to the prompts tray.
As a filter expression, a prompt consists of least one filterable column, a filter operator, and an optional filter value. It is possible for a prompt to have an undefined filter value. A prompt that has a filter expression with an undefined filter value is an incomplete dashboard runtime filter, and as such, does not affect the dashboard.
A filterable column for an prompt can be a data-backed column or a formula column from:
- physical schema alias, table, or derived table
- runtime business view
The join relationships between physical schema tables affect a filter expression. For example, when the filterable column is from a parent table, the filter expression automatically applies to all the dashboard insights related to this table’s child tables. However, if the filterable column is from a child table, the filter expression does not affect the insights related to the parent tables.
Certain filter operators afford various options for selecting one or more filter values. For example, the
Not In operators allow for the selection of none, one or more, or all filter values.
A filter value for an prompt can be a scalar value, array of scalar values, or a reference to a variable as follows:
- a filter expression session variable
- an internal session variable
- an external session variable
- a global variable
- a date system variable
- a miscellaneous system variable
You can also define an prompt as a filter expression using the Formula Builder.
In order to reference a column or variable in a filter expression, you must have View access privileges to the grandparent object such as a physical schema, business schema, or session variable. A global variable is available to all users.
The joins between the physical schema tables in the query plan for an insight measure determine whether or not a filterable column affects the insight. For example, a physical schema column in a parent table serves as a filterable column for a measure in a child table. However, a physical schema column from a child table is not a filterable column for a parent table, even when it is the foreign key reference.
For a filterable column, a prompt meets one of the following conditions:
- The filterable column is a key, dimension, or measure column in the insight.
- The filterable column has a sibling column from the same physical schema table, and that sibling is a dimension or measure for the insight.
- The filterable column is a dimension or key that shares a measure on the insight from a common child table with other dashboard insights.
If an applicable insight already contains an insight filter, an applied filter will complement the insight filter based on a common filterable column as described above
The following are the properties of the prompt that is a column.
|Column name||label||Displays the fully-qualified name|
|Display Name||text box||Optional, though highly recommended. Enter the display name for the prompt|
|Default||toggle||Enable to specify a default filter value. The filter value can be undefined.|
|Default → Operator||link||Select to specify the filter operator|
|Default → Search/Add||text box||Search and select zero or more filter valuers. Add a value as a literal, valid variable reference, or leave undefined.|
|Default → Select filter||link||Available when default is already defined. Select to specify the filter operator and/or a default filter value. The filter value can be undefined.|
|Mandatory||toggle||Enable to specify as a mandatory dashboard runtime filter. The default property must be enabled and a default filter expression must be defined. The filter value must be defined in the filter expression.|
|Sort||tray and pill||Only columns from the same physical schema table as the prompt column can be used for sorting the prompt. Drag and drop a column from the Data panel to the tray. Select the ascending (
|Hierarchy||toggle||Appears only if the filterable column is related to a self-referential table join. Once enable, you specify a hierarchy level starting at 0.|
A prompt with a default filter appears on the Filter bar. A user may edit, remove, or clear a default that is not a mandatory prompt.
The following are the properties of the prompt that is a formula column.
|Display Name||text box||Enter the display name for the prompt. If undefined, the prompt display name will be blank.|
|Default||toggle||Only available to enable with a defined formula. Enable to specify a default filter operator of either
|Default → Operator||link||The default operator is
|Default → Select filter||link||Available when default is already defined. Select to specify the filter operator.|
|Mandatory||toggle||Enable to specify as a mandatory dashboard runtime filter. The default property must be enabled.|
|Formula||text box||Select the text box to open the Formula Builder. Specify a filter expression.|
For a formula column, you specify a filter expression. A filter expression evaluates to
false. A prompt with a default filter appears on the Filter bar. A user may edit, remove, or clear a default that is not a mandatory prompt.