Exclude a field from the search results

This is for:

Developer System Administrator

By default, every indexed field is returned in the search results when a query is executed. However, it’s possible to configure a field so that the Coveo index doesn’t include this field in the response to Coveo-powered search interface requests.

To configure a Sitecore field so that it’s excluded from results

  1. Open the Coveo.SearchProvider.Custom.config file in a text editor. This file is typically located in <SITECORE_INSTANCE_ROOT>\App_Config\Include\Coveo or <SITECORE_INSTANCE_ROOT>\website\App_Config\Include\Coveo.

  2. In the fieldMap/fieldNames element, add the <fieldType> element below. Replace mysitecorefield with the Sitecore field name (not the Translated Name).

    <fieldType fieldName="mysitecorefield" isDisplayField="false" settingType="Coveo.Framework.Configuration.FieldConfiguration, Coveo.Framework" />
    Note

    The fieldMap/fieldNames element is located in the defaultIndexConfiguration element. Field settings defined in the defaultIndexConfiguration element are applied to all indexes that reference the defaultIndexConfiguration element. To apply field configurations on a specific index, see Manage fields for a specific index.

  3. Save your changes.

  4. Rebuild your indexes.

    Note

    Performing a POST request to /coveo/api/index/v1/indexes/synchronize isn’t enough for the change to be effective. A rebuild is required.

You can combine isDisplayField with the other settings presented in this section.