Configuring the Scope of a .NET Search Interface

You can configure the scope of a Coveo .NET Front-End search interface using one or more of the following methods to transparently restrict the results for all queries performed from this .NET search interface:

• Hidden search filters

• Selection of one or more index collections (see What Is an Index Collection?)

• Inclusion of one or more search scopes defined on the Coveo Master server (see What Are Search Scopes? and Adding a Search Scope).

To configure the scope of a .NET search interface

1. Access the Coveo .NET Front-End Interface Editor (see Opening the .NET Interface Editor).

2. Select Search Interfaces > Features.

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

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

5. In the page that appears in the right panel, use one or more of the following steps to configure the scope of the search interface:

   

   1. In the Hidden search filter box, optionally enter a filter expression using search features such as field queries (see What Are Field Queries and Free Text Queries?).

      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=="username@MyOrganization.com" @sysfiletype<>exchangeappointment @sysfiletype<>exchangetask @sysmailbox @sysfiletype<>(activedirperson,csuser,exchangeperson,mergedperson,msdcontact, sblcontact,sfcontact,spuserprofile) @sysfiletype<>exchangecalendarmessage @sysfiletype<>exchangerssfeed

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

   2. Under Available Collections, optionally 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.

   3. Under Scope Configuration, when you want to include one or more search scopes defined on the Coveo Master server: 

      

      • Select the Use the Default Scope from the Administration Tool option, to follow the default search scope defined from the Administration Tool (see Setting a Default Search Scope).

        OR

      1. Select the Select Scopes from the Administration Tool option.

      2. In the drop-down list, select one of the search scopes available from the Coveo Master server, and then click Add.

         Note: When the drop-down list is empty, you must first centrally define search scopes using the Administration Tool (see Adding a Search Scope).

      3. Click the Translation link to enter a localized name for this search scope in the other supported languages (see Configuring the Available .NET Search Interface Languages).

      4. Optionally add other search scopes and then use the Up and Down links to set the order in which the search scopes appear in the Search In facet.

      5. Select the check box in front of one added search scope and then click Set as Default when you want this search scope to be automatically selected in the Search In facet when an end-user accesses the search interface for which you are configuring the scope.

      Note: CES 7.0.5556– (June 2013) When more than one Coveo instance exists within your organization (see About Geographically Distributed Indexing), you can also optionally 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 box, 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) box, 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.

Note: CES 7.0.5556– (June 2013) You can also use the deprecated custom search feature. A custom scope is visible to end-user as an option in the Search In facet (see Configuring a Custom Scope With the .NET Interface Editor).