Installing Coveo for Sitecore SXA Components

Prerequisites

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

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

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

For upgrades, first upgrade Coveo for Sitecore, and then upgrade 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 pick the version matching your installed SXA version.

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 for Sitecore 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

  • Components views

    Website\Areas\CoveoHiveSxa\Views

Sitecore Content Tree:

  • Components placeholders settings

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

  • Components renderings

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

To use the component, you must first allow it on your site.

Allowing the Components in Your Site

Before inserting the components, 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.

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

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

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 (see Using Hive SXA Components in the Experience Editor).

Recommended Articles