com.atlassian.confluence.content.render.xhtml.migration.exceptions.UnknownMacroMigrationException: The macro 'html' is unknown.

User Inputs - Searches Definition

Owned by Omry Koschitzky
Jan 04, 2016
2 min read

Users Inputs provide an interface for users to supply values that effect gadgets search terms and displayed results based on their selection. Typically, the inputs are displayed in a checkbox, text area, dropdown menus or radio buttons. 

The forms allow users to visually make selections which impact the underlying searches and focus only on points of interest while viewing dashboard's results.

 

Searches in the Gadgets within a dashboard

After the inputs are defined in the dashboard settings it is mandatory to configure the searches of the gadgets to use them in order to update a gadget's result upon an input selection.

The syntax which is used in the search queries is [XI:INPUT_KEY] - this value will be replaced by XpoLog when a user makes a selection in the inputs forms and clicks Apply, INPUT_KEY stands for the input key configured in the dashboard settings inputs section.

 

For example:

  1. In the dashboard settings create a Granularity input with a key 'interval'. Set it as a list of static values (1 second, 1 minute, 1 hour (default), etc.) and save:
  2. In the dashboard itself you will see a drop down menu with the values of the Granularity input (with the default selected).
    Note, at this point the gadget will not react to selections made on the input as the input key is not combined with the search query yet:


  3. Edit the gadget and combine the interval XpoLog Input as part of the query and save:

    * | count | interval [XI:interval] | display count as events over time

    Notice the [XI:interval] which will be used when a selection of the input's value will be made.
     
  4. A selection of Granularity 'Minutes' and applying will display a different view of the gadget:

 

Â