Create the Search Solution

When beginning to integrate Coveo into your Sitecore website, you might feel overwhelmed and not know where to start. The goal of this article is to show the path to a leading-practice compliant search solution by presenting implementation options that are available, providing tips, and steering you towards the relevant documentation resources for your implementation scenario.

At the end of this phase in your Coveo for Sitecore implementation journey, you will have integrated a complete Coveo-powered search solution into your website. A complete Coveo-powered search solution consists in:

Creating the Main Search Page

The Coveo for Sitecore Hive Framework gives you the ability to build your main search page using one of the methods below.

Using the Example Hosted Search Page Branch Template

Search page editing The actual search page (i.e., the hosted search page) is created and edited in the Coveo Administration Console using the Interface Editor.
Implementation summary The Example Hosted Search Page branch template generates:
  • a Sitecore item linked to a search interface layout
  • one Hive rendering (i.e., the Coveo Hosted Search Page rendering) inserted in the layout
  • the rendering data source

The Coveo Hosted Search Page rendering dynamically fetches the code of the selected Coveo organization hosted search page when the Sitecore page is loaded.
Main pros and cons + Ease of editing with the Interface Editor.

+ Access to entire set of Coveo JavaScript Search Framework features.

+ The branch template can be used in regular MVC sites and in SXA sites.

-  No access to single-purpose Coveo for Sitecore Hive Framework renderings (some of which can simplify search result scoping).
Step-by-step instructions See Integrate a Hosted Search Page in a Sitecore Item.

Using the Example Search Page Branch Template

Search page editing Search page creation and editing is done in the Sitecore Experience Editor.
Implementation summary The Example Search Page branch template generates:
  • a Sitecore item linked to a search interface layout
  • 18 Hive renderings inserted in the layout
  • a complete data source folder branch
  • populated data sources for all 18 renderings
Main pros and cons + Quick and easy way to get a complete and functional search page.

+ Coveo for Sitecore Hive Framework single-purpose scoping renderings may be used.

+ A full data source folder branch is automatically created.

-  The 18 rendering search page is generic. You need to add other renderings to customize the search page.

-  The branch template can't be used for SXA sites.

-  The search page is built over the Modular Frame. You are limited presentation-wise.

-  Access to only the subset of Coveo JavaScript Search Framework features covered by Coveo for Sitecore Hive renderings.
Step-by-step instructions See Insert an Example Search Page.

Starting From Scratch With Hive/SXA Single-Purpose Renderings

Search page editing Done in the Sitecore Experience Editor
Implementation summary The search page is created from scratch using a Sitecore item/page.
Main pros and cons + Coveo for Sitecore Hive Framework single-purpose scoping renderings may be used.

+ You may choose any frame rendering as your starting point (Hive), or use Sitecore containers and splitters with the grid system (Hive SXA) to customize the search page presentation.

-  Creating the search page is time consuming.

-  Access to only the subset of Coveo JavaScript Search Framework features covered by Coveo for Sitecore Hive renderings.

-  You might want to create a data source folder branch to avoid clutter in the Content Editor.
Step-by-step instructions Hive
  1. Implement a data source management strategy.
  2. Create a sample item in the Sitecore Content Editor.
  3. In the Sitecore Presentation Details, assign the Coveo Hive Basic Search Interface Layout to the item.
  4. In the Sitecore Experience Editor, add the Coveo Search Interface rendering and the Coveo Search Resources in the Coveo UI and UI Resources placeholders respectively (see Search Page Structure).
  5. Add other renderings as needed (see Add Basic Controls).

Hive SXA
  1. Install and allow Coveo Hive SXA renderings on your site.
  2. Implement a data source management strategy.
  3. Create an SXA page, a page design, and one or multiple partial design(s).
  4. Link your SXA page to the page design.
  5. Add your partial design(s) to the page design.
  6. Add your Hive SXA renderings to your partial design(s) beginning with the Coveo Search Interface and Coveo Search Resources renderings.
Recommended Articles