Add parameters to a custom XQL widget

Add parameters that let viewers filter custom XQL widgets.

If you want to use filters and drilldowns on your dashboard, one or more widgets on the dashboard must contain parameters. For more information about filters and drilldowns, see Configure global filters and Configure drilldowns.

Parameters can be static or dynamic, and support single or multi-select values.

1

Create an XQL widget.

2

Define an XQL query and click Preview.

You can base your filters on fields and values in the query results.

3

Add parameters to the query using the filter stage, define parameters prefixed with $.

• For single select filters: filter <field> = &<parameter>

  Example: This filter enables dashboard users to filter the dashboard by a single predefined severity value.

  filter xdm.issue.severity = &severity)
• For multi select filters: filter <field> in(&<parameter>)

  Example: This filter enables dashboard users to filter the dashboard by one or more domain values (predefined or dynamically generated).

  filter domain in(&domain)

4

(Optional) Under Parameters, define default values for your query parameters.

This makes the widget populate automatically on load. You can also define default values when configuring filters in the dashboard or report builder, or leave this blank.