Create a Search Results List Widget

Use the Search Results List Widget Properties window (accessed from within the Widget Manager) to create a search results list widget.

To create a search results list widget:

  1. Create a Widget.
  2. In the Type drop-down list, select Search Results List.
  3. Define general properties:
    1. Default title:

      Provide the title to display above the widget. The font, style, and color is inherited from the dashboard on which this widget resides.

      You can change this title (Controls text box) when you put the widget on a dashboard; however, the title is not dynamic so changes are not pushed back to this field. Likewise, if you later change this title in Widget Properties, the changes are NOT pushed out to all the places it occurs on dashboards. For more formatting flexibility, use a "floating" text widget to display a label or title for a widget.

    2. Business Object:

      Select the Business Object to search (example: Incident). Only one type of Business Object can be selected. The drop-down list displays only Major Business Objects. To display all Business Objects, select the Show All check box.

  4. Define display properties:
    1. Specify how to display the search results (grid or clickable links):
      • Show Results in a Grid: Select this option to display the search results in a grid, and then define:
        • Custom Grid:

          Select this check box to display a custom grid, rather than the system administrator-defined default grid.

          The system administrator has defined multiple grids for the selected Business Object. If no grid is selected, the system administrator-selected default grid for the Business Object is used.

        • Default to Showing Grouping:

          Select this check box to automatically show grid grouping functionality in the search results list widget.

        • Allow User to Show/Hide Grouping Options:

          Select this check box to allow users to enable grid grouping in the search results list widgets if it is not automatically enabled.

        • Allow Drill-Down:

          Select this check box to allow users to double-click the widget and be taken to data represented by that widget.

      • Show Results as Links: Select this option to display each search result as a clickable link and to also set options for separator width and color.
        • Separator Color: Select this option to set the color of the separator to be transparent using a pre-set color, or by setting a custom color with an Alpha of 0 (using the RGBA color model).
        • Separator Width: Select this option to set the width of the separator between results in your results list. Choose from No Border or 1/2/3/4 pixels wide.
    2. Limit Results: Select this check box to limit the number of results in the search results list widget to a specified number, and then specify the number.
  5. Define the search criteria (what to search for - example: Open Incidents). Data is located/filtered using one the following options:
    • Saved Search Query: Select the ellipsis Ellipses Button to open the Search Manager, and then select an existing saved search (saved Search Query) or create a saved search. Saved searches can be used over and over in numerous places.
    • Custom Search Query: Select Custom Query General Knowledge Search Button to open the Custom Query Builder, and then create a custom search query to use only for this scenario.
  6. Define a timeframe for the search query (Date Range area):
    1. Select a range option, either:
      • Range: Select this option to define a date range for the query, and then select an existing time frame (example: Anytime or Previous Year), or select New to define a new time frame.
      • User Selectable: Select this option to allow the user/customer to select the date range from a drop-down list. Then, select the ellipsis Ellipses Button to open the Multiple Date Ranges window and select the Allowed date ranges to include in the drop-down list.
    2. Field used for date range: Select the field to use to give the range perspective (example: LastModDateTime gives Previous Year perspective).
  7. Define how often to refresh the widget:
    1. Refresh every:

      Select this check box to refresh the content according to a defined time period, and then provide the refresh timeframe (every x hours or minutes).

  8. Select Save.