Concepts → Prompt

About a prompt

A prompt is a type of dashboard filter. A dashboard developer creates and configures the properties of one or more prompts for a given dashboard using the Dashboard Filters Manager.

Unlike other types of dashboard filters, a prompt can be simply a filterable column, a partial filter expression, or a complete filter expression. Like a presentation variable, a prompt overrides the default behavior of a 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.

A prompt has various properties. Once defined and configured, a prompt always appears in the Columns panel of the Filter dialog. However, a prompt may not always appear initially as a filter bar pill. There are two properties that influence this behavior, the Default property and the Mandatory property. Here is a brief summary of how these properties affect a prompt’s behavior:

Property Initially requires
filter operator
Initially requires
filter value
Initially
appears on
filter bar bill
Is a partial
filter expression
Is a complete
filter expression
Is removable
Default disabled yes yes no yes no yes
Default enabled
with undefined filter value
no yes yes yes no yes
Default enabled
for formula
with undefined
filter operator
and filter value
yes yes yes yes no yes
Default enabled
with defined filter value
no no yes no yes yes
Mandatory enabled no no yes no yes no
  • A prompt with the Default property disabled does not initially appear as a filter bar pill and requires a dashboard consumer to select a filter operator and filter value in the Filter dialog.
  • A prompt that is a default prompt with an undefined filter value appears initially as a filter bar bill and requires a dashboard consumer to select a filter value in the Filter dialog.
  • A prompt that is a default prompt with a defined filter value appears initially as a filter bar bill and applies the initial filter expression as a dashboard runtime filter.
  • A prompt that is a mandatory prompt appears always as a filter bar bill and always applies a filter expression as a dashboard runtime filter.
Note

A prompt also supports enabling a default for a hierarchy level for a filterable column that from a self-referential table.

A dashboard developer can order prompts alphabetically or manually so as to affect how the prompts appear as filterable columns in the Filter dialog.

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
  • Control the display order of filterable columns in the Filter dialog
  • Specify a measure or key column as a filterable column
  • Specify complex filter expression as a filterable column
  • Specify a partial filter expression as filterable column for the dashboard consumer to complete
  • 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 using the Dashboard Filters Manager. 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 the Dashboard Filters Manager, select Prompts.
  • From the Data panel, drag & drop a column or formula to the Prompts tray.
  • Configure the properties of the prompt pill.

Valid references in a filter expression for a prompt pill

As a filter expression, a prompt pill consists of at least one filterable column, a filter operator, and an optional filter value. A prompt pill that has a filter expression with an undefined filter value represents a partial filter expression. A partial filter expression results in an incomplete dashboard runtime filter, and as such, does not affect the dashboard.

A filterable column for a prompt pill can be a data-backed column or a formula column from:

  • an alias
  • a physical schema table
  • an Incorta Analyzer table
  • a materialized View
  • a business Schema View
  • an Incorta View

A formula expression can encapsulate the filterable column or filterable columns within the filter expression.

Note

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.

Important: A filterable column from an Incorta View

A filterable column from an Incorta View will only affect an in insight on a dashboard that queries the Incorta View.

Certain filter operators afford various options for selecting one or more filter values. For example, the In and Not In operators allow for the selection of none, one or more, or all filter values.

Depending on the data type and filter operator, a filter value for a prompt pill can be a scalar value or array of scalar values. In certain cases, it is possible reference a variable as follows:

You can also define a prompt pill as a filter expression using the Formula Builder.

View access rights

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.

About an applicable insight for a prompt pill

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.

Important: Limitations of using an Incorta View

An insight that queries an Incorta View is an applicable insight for a dashboard filter or dashboard runtime filter only for filterable columns from the Incorta View.

Properties for a prompt pill that is a column

A prompt pill that is a column can be a filterable column, a partial filter expression with an undefined filter value, or a complete filter expression that serves as a dashboard runtime filter. The following are the properties of a prompt pill that is a column:

Property Control Description
Column name label Displays the fully-qualified name
Display Name text box Optional, though highly recommended. Enter the display name for the prompt
Default Filter toggle Enable to have the prompt appear initially as a filter bar bill and to apply a complete filter expression when defined.
Default Filter → Select filter link Select to specify the filter operator and/or a default filter value. The filter value can be undefined. For a prompt, you can specify as filter operator and leave the filter value defined or undefined. Opens Select Filter.
Select Filter → Back link Select to go back to the pill properties without saving selected values, if any
Select Filter → Operator link Select the default operator next to the pill name, and then select the operator you want. Available operators may vary according to the data type of the selected column.
Select Filter → Filter link Select to confirm the values you select, or to confirm an undefined filter value. This property is available only when the selected operator allows for none or multiple values, for example. In, Not In, Null, and Between.
Select Filter → Search / Add text box Enter a search term to search for specific values, or enter a value, and then press Enter. You can reference an internal or external session variable, global variable, date system variable, or miscellaneous system variable. This property is available only when the selected operator requires one or more values.
Values list Select none, one, or more values. This property is available only when the selected operator allows for one or more values. For some operators, you can select all available values or select to enter multiple values in bulk by entering them as delimited values.
Values → Case Sensitive toggle Enable to match both the value text and letter case. This property is available only when you select an operator that requires string input, such as Starts With, Ends With, and Contains.
Values → Select All link Select all values on the list. This property is available only when the selected operator allows for multiple values.
Select None link Clear the selection of values. This property is available only when the selected operator allows for multiple values.
Values → Bulk link Select to enter multiple values in bulk by entering delimited values. This property is available only when the selected operator allows for multiple values.
Bulk → Delimiter drop down Select the delimiter you use to separate the values you enter in bulk, Comma or Line break. This property is available when you select Bulk for the values.
Bulk text text box Enter or paste the values separated by the delimiter you select. This property is available when you select Bulk for the values.
Bulk → Select link Select this property to confirm the delimited values you entered. This property is available when you select Bulk for the values.
Mandatory toggle Enable to specify as a mandatory prompt. Requires a complete filter expression that includes a defined filter value. This property is available only when you enable the Default Filter toggle and define the filter expression operator and default filter value.
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 () or descending arrows () on the pill. You can use only columns from the same physical schema table as the prompt column.
Hierarchy toggle Enable to specify a hierarchy level starting at 0. Appears only if the filterable column is related to a self-referential table join. Once enable, you specify a hierarchy level starting at 0.
Note

A default prompt appears on the Filter bar regardless of whether there is a default filter value or an undefined filter value. A default prompt with an undefined filter value cannot be a mandatory prompt. A dashboard consumer may edit, remove, or clear a default prompt that is not a mandatory prompt.

Properties for a prompt pill that is a formula with a partial filter expression

A formula expression can encapsulate the filterable column or filterable columns within the filter expression.

Here is an example of formula for a prompt pill that is a partial filter expression.

SALES.SALES.AMOUNT_SOLD - SALES.SALES.COST_OF_GOODS

In this example, the two columns in a calculation serve as the filterable columns in the filter expression. A dashboard consumer can select the filter operator and the filter value(s). The data type for the formula result determines the available filter operators. The formula result determine the available filter values.

The following are the properties of the prompt that is a formula pill with a partial filter expression such as a calculation:

Property Control Description
Display Name text box Enter the display name for the prompt. If undefined, the prompt display name will be blank.
Default Filter toggle Enable to have the prompt appear initially as a filter bar bill and to apply a complete filter expression when defined.
Default Filter → Select filter link Select to specify the filter operator and/or a default filter value. The filter value can be undefined. For a prompt, you can specify as filter operator and leave the filter value defined or undefined. Opens Select Filter.
Select Filter → Back link Select to go back to the pill properties without saving selected values, if any
Select Filter → Operator link Select the default operator next to the pill name, and then select the operator you want. Available operators may vary according to the data type of the selected column.
Select Filter → Filter link Select to confirm the values you select, or to confirm an undefined filter value. This property is available only when the selected operator allows for none or multiple values, for example. In, Not In, Null, and Between.
Select Filter → Search / Add text box Enter a search term to search for specific values, or enter a value, and then press Enter. You can reference an internal or external session variable, global variable, date system variable, or miscellaneous system variable. This property is available only when the selected operator requires one or more values.
Values list Select none, one, or more values. This property is available only when the selected operator allows for one or more values. For some operators, you can select all available values or select to enter multiple values in bulk by entering them as delimited values.
Values → Case Sensitive toggle Enable to match both the value text and letter case. This property is available only when you select an operator that requires string input, such as Starts With, Ends With, and Contains.
Values → Select All link Select all values on the list. This property is available only when the selected operator allows for multiple values.
Select None link Clear the selection of values. This property is available only when the selected operator allows for multiple values.
Values → Bulk link Select to enter multiple values in bulk by entering delimited values. This property is available only when the selected operator allows for multiple values.
Bulk → Delimiter drop down Select the delimiter you use to separate the values you enter in bulk, Comma or Line break. This property is available when you select Bulk for the values.
Bulk text text box Enter or paste the values separated by the delimiter you select. This property is available when you select Bulk for the values.
Bulk → Select link Select this property to confirm the delimited values you entered. This property is available when you select Bulk for the values.
Mandatory toggle Enable to specify as a mandatory prompt. Requires a complete filter expression that includes a defined filter value. This property is available only when you enable the Default Filter toggle and define the filter expression operator and default filter value.
Formula text box Select the text box to open the Formula Builder. Specify a filter expression.

Properties for a prompt pill that is a formula with a complete filter expression

A formula expression can encapsulate the filterable column or filterable columns within the filter expression. Here is an example of a formula for a prompt pill that is a complete filter expression.

or(
	SALES.PRODUCTS.PROD_CATEGORY = "Photo",
	startsWith(
		SALES.PRODUCTS.PROD_NAME,
		"17"
	)
)

In this example, there are two filter expressions within the OR boolean built-in function:

SALES.PRODUCTS.PROD_CATEGORY = "Photo"

and

startsWith(SALES.PRODUCTS.PROD_NAME,"17")

As complete filter expression, these will evaluate to either True or False.

The following are the properties of the prompt that is a formula pill with a complete filter expression:

Property Control Description
Display Name text box Enter the display name for the prompt. If undefined, the prompt display name will be blank.
Default Filter toggle Enable to have the prompt appear initially as a filter bar bill and to apply a complete filter expression when defined.
Default Filter → Select filter link Select to specify the filter operator and/or a default filter value. The filter value is either True or False. For a prompt, you can specify as filter operator and leave the filter value defined or undefined. Opens Select Filter.
Select Filter → Back link Select to go back to the pill properties.
Select Filter → Operator link Select the default operator next to the pill name, and then select either True or False.
Select Filter → Filter link Select to confirm the values you select.
Mandatory toggle Enable to specify as a mandatory prompt. Requires a complete filter expression that includes a defined filter value. This property is available only when you enable the Default Filter toggle and define the filter expression operator and default filter value.
Formula text box Select the text box to open the Formula Builder. Specify a filter expression.