Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Users Inputs provide an interface for users to supply values that effect gadgets search terms in a visual form. 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 

  • Dashboard's Settings 
    In the Settings area, Administrators define the list of Inputs to be available while viewing a dashboard. The input has several settings:



    General Settings:
    - Input Key - The key is the unique identifier of an input in which is used in the underlying search within a gadget. Upon selection of a value in the input form in the dashboard, the selected value will be integrated in the query or queries that contains this key
    Display Settings:
    - Title - The title of the input that is displayed in the inputs form above this input
    - Description - The input's description
    - Visible - Determines whether this input is displayed in the inputs form or not
    - Break Line - Determines whether this input starts a new line in the inputs form or not
    - Advanced - Determines if this input should be presented in the main inputs form (default) or should be displayed only in the advanced section of the inputs form
    Input Settings:
    -  Input Type:
    • 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.

 

  • No labels