Users Inputs provide an interface for users to supply values that effect gadgets widgets search terms in a visual formand 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.
Configuring User Inputs:
There are 2 aspects the should be configured in order to use Inputs
...
Searches in the widgets within a dashboard
After the inputs are defined in the dashboard settings it is mandatory to configure the searches of the widgets to use them in order to update a widget's result upon an input selection.
The syntax which is used in the
...
- Text
- Default Value - The value that will be used by default (leave empty for empty default)
- Placeholder - Text that will be displayed within the input text area to imply the user what the optional values are
- List
- Multiple Selection - Determines whether it is possible to select more than one value of the list or not
- Show as Drop Down - Determines whether the list should be display an horizontal values list or as a dropdown menu
- List Type - Determines the type of list of this input:
- Static - A static list of values entered by the administrator
- Query Based - A dynamic list which is a result of a search query
- Sources Based - A dynamic list of sources available in XpoLog (Logs, Folders, AppTags, Servers)
- Predefined - Upload a key=value type of file which contains a list of values that will be displayed in the input
- Checkbox
- Checked by Default - Allow a true/false type of input
- Checkbox Label - The label to be displayed next to the checkbox
- Searches in the Gadgets within a dashboard
After the inputs are defined it is required to enter their references inside the gadgets search queries in order to update a gadget's result on 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 click Apply.
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:
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:
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 widget will not react to selections made on the input as the input key is not combined with the search query yet:
Edit the widget 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.
A selection of Granularity 'Minutes' and applying will display a different view of the widget:
