Set up a "Text input" control

“Text input” controls let you display values of a query into a searchable list.

Setting up a “Text input” control requires two main steps:

Create the “Text input” control for your dashboard
Connect the “Text input” control to a chart

Create a “Text input” control

To add a “Text input” control to your dashboard:

Open the dashboard where you want to add the “Text input” control.
Select Add control > Text input from the dashboard sidebar. A pop-up will appear for you to select the control’s settings.
Edit the control’s settings as needed. (See next section to learn more about “Text input” settings)
Select Add.
Place the newly created “Text input” control anywhere on your dashboard.

“Text input” control settings

You can edit the following settings for your “Text input”:

Name

The control’s name

Data type

The data type for the control (Text or Number)

Multi-value

Allows filtering by multiple search terms at once. If this is deselected, you can only provide one search term in the “Text input” at a time.

We wrap each search term in single quotes, so you shouldn’t provide multiple search terms in a single input field.

Empty state

Only available when Multi-value is selected

Specifies what happens when no search terms are provided in the “Text input”. There are two options:

Show all: does not filter the connected charts
Show none: shows no data for connected charts

Initial values

Set default values to select when you load the dashboard

Connect a “Text input” control to a chart

After you’ve created your “Text input” control, you’ll need to connect it to a chart in order to start using it to filter. You can do this by using its corresponding dashboard variable in a Visual SQL query.

Keep in mind that filtering with “Text input” controls requires an exact string match. Learn how to use wildcards to search by partial string matches.

In a visual mode query

To connect a “Text input” control to a chart using a visual mode query:

Open the chart editor by creating a new chart or editing an existing chart on the dashboard.
In the “Filters” section of your visual mode query:
1. Add the column you want the control to filter. It must have the same data type as your “Text input” control.
2. Select the appropriate filter operator. If you selected Multi-value in your “Text input” settings, use is one of.
3. Select your control’s variable.
Select Run query. The result table will update with the new filter applied to the data.
Select Save to dashboard to save the chart.

Filter condition using 'Text input' control named PROJECT_TYPE_TEXT_INPUT

In a SQL mode query

The syntax for connecting a “Text input” control in your SQL query varies depending on whether or not “Multi-value” is selected in the control’s settings.

Single-select “Text input”

For single-value “Text input” controls, the syntax is simple: {TEXT_INPUT_NAME}. Replace TEXT_INPUT_NAME with your control's name.

For “Text input” controls whose data type is text, we wrap the values in single quotes when they’re passed to a query. To remove the single quotes, append .RAW to the variable name: {TEXT_INPUT_NAME.RAW}

Here’s an example of how someone might get the total number of Jira issues where the project type is equal to the selected “Text input” value:

SELECT COUNT(DISTINCT "Jira Issue"."issue_id") AS "Count of distinct Issue Id"
FROM "jira _issue" AS "Jira Issue"
INNER JOIN "jira_project" AS "Jira Project"
  ON "Jira Project"."project_id" = "Jira Issue"."project_id"
WHERE "Jira Project"."project_type" = {TEXT_INPUT_NAME}

Multi-select “Text input”

If “Multi-select” is selected, use the following syntax:

to include data with the selected “Text input” values: {TEXT_INPUT_NAME.IN('"table_name"."column_name"')}
to exclude data with the selected “Text input” values: {TEXT_INPUT_NAME.NOT_IN('"table_name"."column_name"')}

Replace TEXT_INPUT_NAME with your control's name, and make sure to wrap the table-column reference in single quotes.

Here’s an example of how someone might get the total number of Jira issues for all project types selected in the “Text input” control:

SELECT COUNT(DISTINCT "Jira Issue"."issue_id") AS "Count of distinct Issue Id"
FROM "jira _issue" AS "Jira Issue"
INNER JOIN "jira_project" AS "Jira Project"
  ON "Jira Project"."project_id" = "Jira Issue"."project_id"
WHERE {TEXT_INPUT_NAME.IN('"Jira Project"."project_type"')}

Conversely, here’s an example of how someone might get the total number of Jira issues for all project types not selected in the “Text input” control:

SELECT COUNT(DISTINCT "Jira Issue"."issue_id") AS "Count of distinct Issue Id"
FROM "jira _issue" AS "Jira Issue"
INNER JOIN "jira_project" AS "Jira Project"
  ON "Jira Project"."project_id" = "Jira Issue"."project_id"
WHERE {TEXT_INPUT_NAME.IN('"Jira Project"."project_type"')}

Analytics Documentation