Configuring Search Configurations

This topic describes the high-level steps involved in adding and configuring the Search Box component.

When you first open Search Box preferences, you see a list of existing search configurations:

From this dialog box, you add and delete configurations, as well as edit an existing search configuration. When you select a search configuration, or click Add Configuration, Search Box preferences updates to include the Enable type-ahead suggestions dialog. This topic describes just the Search Configurations dialog, while the following topic describes the type-ahead configuration procedure.

To add a search configuration to the Search Box component or edit an existing one:

  1. After adding a Search Box component to a page, click its .... button and then click Preferences.

  2. In the Search Configurations edit view, use the Display Name field to supply a name for the new search configuration or to change the existing name. The Display Name is used in the Search Box component (as a selectable search configuration for the user) and in the Breadcrumbs component.
  3. If you have two or more search configurations, use the Default radio button to set one of them as the default search configuration for the search box.
  4. Use the Data Source drop-down menu to select one of the available data sources to associate with this search configuration.

  5. Use the Search Interface drop-down menu to select from the search interfaces defined in this data source. The search interface limits the end user's search, and allows you to control record search behavior for groupings of some number of dimensions, properties, attributes, and ranking strategies.

  6. Use the Match Mode drop-down menu to select a match mode for the search configuration:
    • all matches all user search terms (that is, perform a conjunctive search). This is the default mode.
    • any matches at least one user search term.
    • partial matches some user search terms.
    • partialmax matches a maximal subset of user search terms.
    • boolean matches using a Boolean query.
    • allany matches all user search terms if possible, otherwise matches at least one. This mode is not recommended in cases where queries can exceed two words.
    • allpartial matches all user search terms if possible, otherwise matches some.

  7. Optionally, use the Target Page field to set the target page for a page transition. Page transitions allow a component on one page in your Discovery Framework application to pass data to a component on another page. In the example below, data will be sent to a component on the Comparisons page.

  8. By clicking in the label of any column, you can sort the contents of that column or remove columns from the Search Configurations display. Details are provided in the "Column Sort and Removal controls" topic.
  9. Use the Enable type-ahead suggestions checkbox to enable or disable type-ahead suggestions. Details are provided in the "Configuring Search Box type-ahead suggestions" topic.
  10. Click Save Preferences to save your changes.