Complex search queries sometimes require defining a value multiple times. Changing this value can especially be demanding. Parameters are very helpful in this scenario. They allow the usage of a placeholder which can be used as many times as needed.
Declaring a Parameter
Parameters can be added to wherever you want to perform a search, like in saved searches, dashboards or on the main search page. To create a parameter just open the sidebar section and select the option.
This will open a modal with the following options.
- Name: The name of the placeholder you will use inside your query. It will represent the value.
- Title: The title will be displayed beside the parameter declaration input.
- Description: While the title should describe the parameter's purpose, the description allows defining a more complex explanation.
- Default: The default value for the parameter. More on this in the next section.
After clicking on Submit you will be able to implement the parameter inside your query with the syntax.
When using parameters you always need to define a value for every parameter. Otherwise, the query is not appropriate and the search can not be executed. With default parameter values, the search will always be executable, unless you remove a value manually.
When opening a dashboard or saved search you will see the following dialog first, unless your configured parameter has a default value.