Create the search solution

This is for:

Developer System Administrator

In this article

Creating the main search page

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.

When beginning to build a Coveo Hive search solution into your 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:

A main search page

This is a full-fledged search page containing a result list and several other components (for example, facets, tabs). You have three main page creation options to choose from:

Using the Example Hosted Search Page branch template
Using the Example Search Page branch template

Starting from scratch with Hive/SXA single-purpose renderings

Many powerful Coveo features (for example, analytics reporting and machine learning driven features) rely on search hub values. Meaningful search hub values are also essential in identifying the origin of all calls to the Coveo Search API, as this can avoid you accidental extra costs.

Regardless of the way you build your search interfaces (or the other methods you may use to call the Search API), ensure you set search hub values properly from the beginning.

A global search box

The global search box can be added to your content article headers. Queries performed in the global search box are redirected to the main search page. Whether you’re using Hive or Hive SXA renderings, the Insert and configure a global search box article contains complete instructions for integrating a global search box into your website.

Creating the main search page

The Coveo 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

The following table summarizes the main characteristics of the Example Hosted Search Page branch template.

Search page editing	The actual search page (that is, the legacy 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 (that is, 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 legacy 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 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.

Search page editing

The actual search page (that is, the legacy 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 (that is, 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 legacy 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 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

The following table summarizes the main characteristics of 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 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 Hive renderings.
Step-by-step instructions	See Insert an Example Search Page.

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 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 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 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 Hive renderings. You might want to create a data source folder branch to avoid clutter in the Content Editor.
Step-by-step instructions	Hive Implement a data source management strategy. Create a sample item in the Sitecore Content Editor. In the Sitecore Presentation Details, assign the Coveo Hive Basic Search Interface Layout to the item. 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). Add other renderings as needed (see Add basic controls). Hive SXA Install and allow Coveo Hive SXA renderings on your site. Implement a data source management strategy. Create an SXA page, a page design, and one or multiple partial designs. Link your SXA page to the page design. Add your partial designs to the page design. Add your Hive SXA renderings to your partial designs beginning with the Coveo Search Interface and Coveo Search Resources 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 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 Hive renderings.

You might want to create a data source folder branch to avoid clutter in the Content Editor.

Step-by-step instructions

Hive

Implement a data source management strategy.
Create a sample item in the Sitecore Content Editor.
In the Sitecore Presentation Details, assign the Coveo Hive Basic Search Interface Layout to the item.
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).
Add other renderings as needed (see Add basic controls).

Hive SXA

Install and allow Coveo Hive SXA renderings on your site.
Implement a data source management strategy.
Create an SXA page, a page design, and one or multiple partial designs.
Link your SXA page to the page design.
Add your partial designs to the page design.
Add your Hive SXA renderings to your partial designs beginning with the Coveo Search Interface and Coveo Search Resources renderings.