[Kibana]: Rename ES|QL controls to Variable controls #3334

alaudazzi · 2025-10-06T10:59:50Z

This PR:

Renames ES|QL controls to Variable controls
Resizes existing screenshots to show just the area in question without titles or menu bars that require maintenance over time. They are enough contextualized to remain helpful
Aligns the text with 9.2 UI

Note for the reviewers:

I'm figuring out how to refresh animated GIFs like this one:
![Editing {{esql}} controls from a dashboard](https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/blte42dfaa404bfc2d6/67d2e31e2e4dc59da190d78f/dashboard-esql-controls.gif)
The Applies switch mechanism is not working as expected

Closes #3013

github-actions · 2025-10-06T11:02:58Z

🔍 Preview links for changed docs

explore-analyze/dashboards/add-controls.md

benironside

Looks great! Left some suggestions, I hope they are helpful 🚀

benironside · 2025-10-07T04:15:19Z

explore-analyze/dashboards/add-controls.md

+6. Define how you want the control to appear:
+
+    * **Label**: Overwrite the default field name with a clearer and self-explanatory label.
+    * **Minimum width**: How much horizontal space does the control occupies. The final width can vary depending on the other controls and their own width setting.


Suggested change

* **Minimum width**: How much horizontal space does the control occupies. The final width can vary depending on the other controls and their own width setting.

* **Minimum width**: Specify how much horizontal space the control should occupy. The final width can vary depending on the other controls and their own width setting.

benironside · 2025-10-07T04:17:26Z

explore-analyze/dashboards/add-controls.md

+    * For Options lists:
+
+        * Define whether users can select multiple values to filter with the control, or only one.
+        * For Options list controls on *string* and *IP address* type fields, you can define how the control’s embedded search should behave:


Suggested change

* For Options list controls on *string* and *IP address* type fields, you can define how the control’s embedded search should behave:

* For controls on *string* and *IP address* type fields, define how the control’s embedded search should behave:

IIUC this whole list is about options lists so we don't need to specify again here. Removed "you can" to match the previous bullet.

benironside · 2025-10-07T04:18:26Z

explore-analyze/dashboards/add-controls.md

+
+            * **Prefix**: Show options that *start with* the entered value.
+            * **Contains**: Show options that *contain* the entered value. This setting option is only available for *string* type fields. Results can take longer to show with this option.
+            * **Exact**: Show options that are a 100% match with the entered value.


Suggested change

* **Exact**: Show options that are a 100% match with the entered value.

* **Exact**: Show options that are an **exact** match with the entered value.

This would be similar to the previous two bullet points.

benironside · 2025-10-07T04:19:47Z

explore-analyze/dashboards/add-controls.md

+              The search is not case sensitive. For example, searching for `ios` would still retrieve `iOS` if that value exists.
+              ::::
+
+        * **Ignore timeout for results** delays the display of the list of values to when it is fully loaded. This option is useful for large data sets, to avoid missing some available options in case they take longer to load and appear when using the control.


Suggested change

* **Ignore timeout for results** delays the display of the list of values to when it is fully loaded. This option is useful for large data sets, to avoid missing some available options in case they take longer to load and appear when using the control.

* **Ignore timeout for results:** Delays display of the list of values until it is fully loaded. This is useful for large data sets, to avoid missing some available options in case they take longer to load and appear when using the control.

benironside · 2025-10-07T04:20:38Z

explore-analyze/dashboards/add-controls.md

+
+        * **Ignore timeout for results** delays the display of the list of values to when it is fully loaded. This option is useful for large data sets, to avoid missing some available options in case they take longer to load and appear when using the control.
+
+    * For Range sliders, set the step size. The step size determines the number of steps of the slider. The smaller the step size is, the more steps there is in the slider.


Suggested change

* For Range sliders, set the step size. The step size determines the number of steps of the slider. The smaller the step size is, the more steps there is in the slider.

* For Range sliders, set the step size. The step size determines the slider's number of steps. The smaller a slider's step size, the more steps it has.

benironside · 2025-10-07T04:38:21Z

explore-analyze/dashboards/add-controls.md

+
+    * The type of the control. 
+      * For controls with **Static values**, you select the options available in the controls by entering them manually or by using a dropdown listing available values. 
+      * For controls with **Values from a query**, you write an {{esql}} query to populate the list of options.


Suggested change

* For controls with **Values from a query**, you write an {{esql}} query to populate the list of options.

* For controls with **Values from a query**, write an {{esql}} query to populate the list of options.

benironside · 2025-10-07T04:39:28Z

explore-analyze/dashboards/add-controls.md

+    * The name of the control. This name is used to reference the control in {{esql}} queries. 
+      * Start the name with `?` if you want the options to be simple static values.
+      * Start the name with `??` if you want the options of the control to be fields or functions. {applies_to}`stack: ga 9.1`
+    * Values available to select for users with this control. You can add multiple values from suggested fields, or type in custom values. If you selected **Values from a query**, you must instead write an {{esql}} query at this step.


Suggested change

* Values available to select for users with this control. You can add multiple values from suggested fields, or type in custom values. If you selected **Values from a query**, you must instead write an {{esql}} query at this step.

* The values users can select for this control. You can add multiple values from suggested fields, or type in custom values. If you selected **Values from a query**, you must instead write an {{esql}} query at this step.

More similar to other bullet points this way.

benironside · 2025-10-07T04:41:10Z

explore-analyze/dashboards/add-controls.md

+
+## Configure the controls settings [configure-controls-settings]
+
+Several settings that apply to all controls of the same dashboard are available.


Suggested change

Several settings that apply to all controls of the same dashboard are available.

Several settings apply to all controls that are part of a dashboard.

benironside · 2025-10-07T04:41:21Z

explore-analyze/dashboards/add-controls.md

+
+Several settings that apply to all controls of the same dashboard are available.
+
+1. In **Edit** mode, select **Add** > **Controls** > **Settings** in the toolbar..


Suggested change

1. In **Edit** mode, select **Add** > **Controls** > **Settings** in the toolbar..

1. In **Edit** mode, select **Add** > **Controls** > **Settings** in the toolbar.

benironside · 2025-10-07T04:41:48Z

explore-analyze/dashboards/add-controls.md

+1. In **Edit** mode, select **Add** > **Controls** > **Settings** in the toolbar..
+2. On the **Control settings** flyout, configure the following settings:
+
+    * **Label position** — Specify where the control label appears.


Suggested change

* **Label position** — Specify where the control label appears.

* **Label position**: Specify where the control label appears.

Maybe : here since the next bullet uses it too?

Update text and screenshots

5ce84e7

alaudazzi self-assigned this Oct 6, 2025

alaudazzi requested review from a team as code owners October 6, 2025 10:59

alaudazzi added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 6, 2025

github-actions bot deployed to docs-preview October 6, 2025 11:01 View deployment

benironside reviewed Oct 7, 2025

View reviewed changes

Rearrange applies-switch at section level

510be7d

github-actions bot deployed to docs-preview October 7, 2025 08:31 View deployment

Fix remaining sections

4005dc5

github-actions bot deployed to docs-preview October 7, 2025 08:42 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Kibana]: Rename ES|QL controls to Variable controls #3334

[Kibana]: Rename ES|QL controls to Variable controls #3334

alaudazzi commented Oct 6, 2025

Uh oh!

github-actions bot commented Oct 6, 2025 •

edited

Loading

Uh oh!

benironside left a comment

Uh oh!

benironside Oct 7, 2025

Uh oh!

benironside Oct 7, 2025

Uh oh!

benironside Oct 7, 2025

Uh oh!

benironside Oct 7, 2025

Uh oh!

benironside Oct 7, 2025

Uh oh!

benironside Oct 7, 2025

Uh oh!

benironside Oct 7, 2025

Uh oh!

benironside Oct 7, 2025

Uh oh!

benironside Oct 7, 2025

Uh oh!

benironside Oct 7, 2025

Uh oh!

Uh oh!

	* Minimum width: How much horizontal space does the control occupies. The final width can vary depending on the other controls and their own width setting.
	* Minimum width: Specify how much horizontal space the control should occupy. The final width can vary depending on the other controls and their own width setting.

	* For Options list controls on string and IP address type fields, you can define how the control’s embedded search should behave:
	* For controls on string and IP address type fields, define how the control’s embedded search should behave:

	* Exact: Show options that are a 100% match with the entered value.
	* Exact: Show options that are an exact match with the entered value.

	* Ignore timeout for results delays the display of the list of values to when it is fully loaded. This option is useful for large data sets, to avoid missing some available options in case they take longer to load and appear when using the control.
	* Ignore timeout for results: Delays display of the list of values until it is fully loaded. This is useful for large data sets, to avoid missing some available options in case they take longer to load and appear when using the control.


		* Ignore timeout for results delays the display of the list of values to when it is fully loaded. This option is useful for large data sets, to avoid missing some available options in case they take longer to load and appear when using the control.

		* For Range sliders, set the step size. The step size determines the number of steps of the slider. The smaller the step size is, the more steps there is in the slider.

	* For controls with Values from a query, you write an {{esql}} query to populate the list of options.
	* For controls with Values from a query, write an {{esql}} query to populate the list of options.

	* Values available to select for users with this control. You can add multiple values from suggested fields, or type in custom values. If you selected Values from a query, you must instead write an {{esql}} query at this step.
	* The values users can select for this control. You can add multiple values from suggested fields, or type in custom values. If you selected Values from a query, you must instead write an {{esql}} query at this step.


		## Configure the controls settings [configure-controls-settings]

		Several settings that apply to all controls of the same dashboard are available.

	Several settings that apply to all controls of the same dashboard are available.
	Several settings apply to all controls that are part of a dashboard.


		Several settings that apply to all controls of the same dashboard are available.

		1. In Edit mode, select Add > Controls > Settings in the toolbar..

	* Label position — Specify where the control label appears.
	* Label position: Specify where the control label appears.

[Kibana]: Rename ES|QL controls to Variable controls #3334

Are you sure you want to change the base?

[Kibana]: Rename ES|QL controls to Variable controls #3334

Conversation

alaudazzi commented Oct 6, 2025

Uh oh!

github-actions bot commented Oct 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔍 Preview links for changed docs

Uh oh!

benironside left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Oct 6, 2025 •

edited

Loading