Product DocsMenu

Configuring the Scope of a Search Interface

You can configure the scope of a search interface to define:

  • Collections from which results will be returned for queries from this search interface.
  • Hidden search filters to transparently restrict the results for all queries performed from this search interface.
  • Remote indexes from other Coveo instances, to which queries from this interface are sent and results received to be merged.

Note: Alternatively, you can configure a custom scope in the Custom Search Scopes section. A custom scope is visible to end-user as an option in the Search In facet (see Configuring a Custom Scope).

To configure the scope of a search interface

  1. Access the Interface Editor (see Opening the Interface Editor).

  2. Select Search Interfaces > Features.

  3. In the Current Interface drop-down box, select the search interface for which you wish to configure the scope.

  4. In the navigation panel on the left, select Scopes.

  5. In the page that appears in the right panel:

    1. Under Available Collections, select the check box for one or more collections in which the search will be performed.

      Examples: For a My Email search interface, you could select one or more collections containing email and mail archives content.

      For an All Content search interface, you could select all available collections.

    2. Optionally, in the Hidden search filter text box, enter a hidden search filter.

      Example: For a My Email search interface returning results from a Microsoft Exchange server, a hidden query could restrict results to each user mailbox and exclude certain types of documents to present only email messages applicable to the current user:
      @sysmailbox=="" @sysfiletype<>exchangeappointment @sysfiletype<>exchangetask @sysmailbox @sysfiletype<>(activedirperson,csuser,exchangeperson,mergedperson,msdcontact, sblcontact,sfcontact,spuserprofile) @sysfiletype<>exchangecalendarmessage @sysfiletype<>exchangerssfeed

      Note: The user does not see this filter in the search box but can see it using the query link icon (Query Link icon) when it is available (see Viewing the Complete Underlying Query).

    3. Optionally, when more than one Coveo instance exists within your organization (see About Geographically Distributed Indexing), you can also add one or more remote indexes to the scope of the search interface:

      1. Next to Additional Indexes To Include In Default Search, click Add New.

        Note: You can click Add New only when at least one remote index is defined in the Administration Tool for the current Coveo instance (see Adding or Modifying Remote Indexes).

      2. From the Name drop-down list, select the remote index from which you want to receive results for the current search interface.

      3. Optionally, in the Filter Expression field, enter a filter expression in the form of a query to add to every query sent to the remote index.

      4. In the Time to execute (sec) field, enter the maximum time to wait for the query results from the remote index. A warning message appears in the search interface when the time out is reached. The default value is 0, in which case the search interface waits indefinitely.

        Note: When the remote Coveo instance is down, local search results are presented immediately without waiting for remote results.

        Example: You can enter 3 (sec) to prevent the search interface from freezing when the WAN connection to the remote index is overloaded, delaying the return of the remote search results.

        Important: When you do not select all available collections under Available Collections, a hidden collection filter is generated and also applied to remote indexes. In this case, the remote indexes will only return results from collections with the same name. When remote indexes do not have the same collection names, no results will be returned. To prevent this hidden collection filter, select all collections.

    4. Click Apply.

      A message appears at the top of the page when the modifications are effective.