Creating a Hierarchical Facet Component Using the Coveo for Sitecore Legacy Search UI Framework

Create a new C# project named Coveo.Custom that targets the .Net Framework 4.5.

Add references to the Sitecore.ContentSearch, Coveo.Framework, and Coveo.SearchProviderBase assemblies located in the <SITECORE_INSTANCE_ROOT>\Website\bin folder.

Create a new class named HierarchicalCategoryComputedField that inherits from the ConfigurableComputedField class as in the code sample below.

using System;
using Coveo.Framework.CNL;
using Coveo.Framework.Items;
using Coveo.SearchProvider.ComputedFields;
using Sitecore.ContentSearch;
​
namespace Coveo.Custom
{
    public class HierarchicalCategoryComputedField : ConfigurableComputedField
    {
        /// <inheritDoc />
        public override object ComputeFieldValue(IIndexable p_Indexable)
        {
            Precondition.NotNull(p_Indexable, () => () => p_Indexable);
​
            IItem item = new ItemWrapper(new IndexableWrapper(p_Indexable));
            string hierarchicalCategory = null;
​
            string categoryFieldValue = item.GetFieldValue("Category");
            if (!String.IsNullOrEmpty(categoryFieldValue)) {
                hierarchicalCategory = categoryFieldValue;
​
                string subcategoryFieldValue = item.GetFieldValue("Subcategory");
                if (!String.IsNullOrEmpty(subcategoryFieldValue)) {
                    hierarchicalCategory += ";" + categoryFieldValue + "|" + subcategoryFieldValue;
                }
            }
​
            return hierarchicalCategory;
        }
    }
}

Compile the project.

Copy the resulting assembly (Coveo.Custom.dll) to the C:\inetpub\wwwroot\Instance\Website\bin folder.

Using a text editor, open the <SITECORE_INSTANCE_ROOT>\Website\App_config\Include\Coveo.SearchProvider.Custom.config file.

Locate the defaultIndexConfiguration element.

Add a computed field named hierarchicalcategory.

<defaultIndexConfiguration type="Coveo.Framework.Configuration.CoveoIndexConfiguration, Coveo.Framework">
  <fields hint="raw:AddComputedIndexField">
    <field fieldName="hierarchicalcategory">Coveo.Custom.HierarchicalCategoryComputedField, Coveo.Custom</field>
  </fields>
</defaultIndexConfiguration>

Add the hierarchicalcategory field as a facet and multi-value field in the fieldMap.

<defaultIndexConfiguration type="Coveo.Framework.Configuration.CoveoIndexConfiguration, Coveo.Framework">
  <fieldMap type="Coveo.Framework.Fields.CoveoFieldMap, Coveo.Framework">
    <fieldNames hint="raw:AddFieldByFieldName">
      <fieldType fieldName="hierarchicalcategory" isFacet="true" isMultiValue="true" settingType="Coveo.Framework.Configuration.FieldConfiguration, Coveo.Framework" />
    </fieldNames>
  </fieldMap>
</defaultIndexConfiguration>

Save and close the file.

Re-index only the sections of the Sitecore Content Tree that you know contain the items with the Category and Subcategory fields. You can also optionally rebuild your entire search index (see Coveo for Sitecore Indexing Guide).

Validate that the computed field now exists in the Coveo index:

Log into the Sitecore Desktop.

Open the Content Editor (Sitecore Start Menu > Content Editor).

For Web Forms:

For MVC:

In the left side of the panel (Content Tree), expand the /sitecore/System/Settings/Buckets/Facets item.

Duplicate the /sitecore/System/Settings/Buckets/Facets/Author item (Right-click > Duplicate) and name it Hierarchical Category.

In the right side of the panel, select the Content tab.

Change the item name (Facet > Name) to Hierarchical Category.

Change the item field name (Facet > Field Name) to hierarchicalcategory.

Save the item.

In the left side of the panel (Content Tree), select the Coveo-Powered Search Page item in which you want to add the hierarchical facet.

Open the Layout Details dialog of this item (Presentation > Details).

For the Default device, select Edit under the list of controls.

In the Device Editor dialog, under Controls, click Add.

In the Select a Rendering dialog, select the appropriate rendering and placeholder.

Ensure that the Open the Properties dialog box immediately checkbox is checked.

Click Select.

In the properties dialog box:

Click OK to close the Device Editor dialog.

Click OK to close the Layout Details dialog.

Validate the result by opening the Coveo-Powered Search Page in Preview mode (Publish > Preview) or Edit mode (Publish > Page Editor).