THIS IS ARCHIVED DOCUMENTATION

Making a Sitecore Field Facetable

This is for:

Developer System Administrator

A facet field can be used to create facets (see Adding Components).

It’s also required if you want to use a Sitecore field in a query with a comparator different than equals (such as contains or ends with) in the Rule Set Editor.

Making a Field Available to Select in the Facet Component

To make a Sitecore field facetable for a Hive UI Framework or Legacy Search UI Framework search page

  1. Open the Coveo.SearchProvider.Custom.config file with a text editor.

  2. In the fieldMap/fieldNames section, add a new element like the following (you must replace mysitecorefield with the name of the Sitecore field):

    <fieldType fieldName="mysitecorefield" isFacet="true" settingType="Coveo.Framework.Configuration.FieldConfiguration, Coveo.Framework" />

    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 Managing Fields for a Specific Index.

  3. To synchronize these field settings changes into your search indexes, an indexing action must be performed. Alternatively, the /coveo/api/index/v1/indexes/synchronize API POST call can be used (see Synchronize Coveo for Sitecore Configuration).

  4. For Legacy Search UI Framework search pages only, you also need to create a new Sitecore system facet item.
    1. In the Sitecore content tree, navigate to the sitecore/System/Settings/Buckets/Facets folder.
    2. Right-click the Facets folder and select Insert > Facet.
    3. Enter a name for your new item.

    4. Under the Content tab of the new item, specify a value for the Field Name field. The Field Name field must be set to the name of the Sitecore field previously configured as isFacet="true" in the Coveo.SearchProvider.Custom.config file.