Install Coveo for Sitecore SXA Components

This is for:

Developer System Administrator
Warning
Legacy feature

This article pertains to the Coveo Hive framework which is now in maintenance mode.

Choose one of Coveo’s more modern, lightweight, and responsive libraries for any future search interface development. See the search interface Implementation guide for more details.

The Coveo for Sitecore SXA package is an add-on module that goes on top of Coveo for Sitecore to make the Coveo Hive components available in SXA-powered pages.

This article provides the instructions to enable use of the Coveo for Sitecore SXA renderings on your SXA sites.

Prerequisites

Before installing the Coveo for Sitecore SXA package, you must ensure that your Sitecore instance meets the following requirements:

Important

  • The version of Coveo for Sitecore and Coveo for Sitecore SXA must be the same.

  • When upgrading, do Coveo for Sitecore first followed by Coveo for Sitecore SXA.

Installing the Coveo for Sitecore SXA Package

Upload and install the last Coveo for Sitecore SXA official package from Releases and Downloads using the Sitecore Installation Wizard (Sitecore Desktop > Start Menu > Development Tools > Installation Wizard).

Ensure that you choose the version matching your installed SXA version.

Notes

  • This operation can take several minutes to complete.

  • If you’re asked whether to overwrite files or items during the installation, proceed to do so.

Package Architecture

The package contains a new version of the Coveo Hive components made compatible with the SXA framework.

Server Folder:

  • Configuration file

    Website\App_Config\Include\Coveo\Coveo.UI.Components.Sxa.config

  • Assembly containing the components

    Website\bin\Coveo.UI.Components.Sxa.dll

  • Component views

    Website\Areas\CoveoHiveSxa\Views

Sitecore Content Tree:

  • Component placeholders settings

    /sitecore/layout/Placeholder Settings/Feature/Coveo Hive SXA

  • Component renderings

    /sitecore/layout/Renderings/Feature/Coveo Hive SXA/Search - Coveo

Allowing the Renderings on Your Site

Before inserting the renderings, you need to allow them on your site.

  1. Open the Sitecore Content Tree and, under your tenant and site, locate the Available Renderings item.

    Available Renderings item in the Content Editor | Coveo for Sitecore 5

  2. Right-click and insert a new Available Renderings. Name it Coveo.

    Adding a Coveo available renderings item | Coveo for Sitecore 5

  3. Edit the Renderings field and add the Coveo renderings.

    Adding the Coveo renderings in the Coveo available renderings item | Coveo for Sitecore 5

The Coveo components are now available for use with SXA pages in the Experience Editor.

What’s Next?

Start using the Hive SXA components in the Experience Editor.