Installed with Search Suggestions

  • Release version: Yokohama
  • Updated January 30, 2025
  • 1 minute to read
  • Several types of components are installed with activation of the Search Suggestions plugin, including tables, user roles, and scheduled jobs.

    Roles installed

    Role title [name] Description Contains roles
    Search Suggestions blocked searcher

    [cannot_read_suggestions]

    Doesn't see search or auto-complete suggestions displayed when searching. None
    Search Suggestions exempt searcher

    [suggestion_exempt]

    Submits searches that the system ignores when generating search or auto-complete suggestions. None

    For more details on restricting generation of search suggestions, see Prevent the creation of suggestions in special cases.

    Scheduled jobs installed

    Scheduled job Description
    Build Search Suggestions Converts searches stored in the Search Event [sys_search_event] table into auto-complete suggestions and search suggestions stored in the Search Suggestion [sys_search_suggestion] table.
    Prune Search Suggestions Removes the lowest-rated auto-complete suggestions and search suggestions from the Search Suggestion [sys_search_suggestion] table to keep the maximum number of suggestions at 500,000.

    Tables installed

    Table Description
    Search Event

    [sys_search_event]

    Search strings and details about their associated results, including the search user, application, UI source, session, and language, and any user-specified click rank and refinements.
    Search Event per source table

    [sys_search_source_event]

    Correlations between search strings with search results from a specific table (data source). A search that queries multiple tables produces multiple Search Event per source records.
    Search Suggestion

    [sys_search_suggestion]

    auto-complete suggestions and search suggestions generated from user searches by the Build Search Suggestions scheduled job. The Prune Search Suggestions scheduled job removes the lowest-rated auto-complete suggestions and search suggestions from this table to keep its maximum size at 500,000 suggestion records.

    To learn about individual columns on these tables, see Search Suggestions tables.