Coveo Error Report

This is for:

Developer System Administrator
Warning
Legacy feature

The Coveo Hive Framework is now in maintenance mode and is no longer recommended for new implementations.

To build new search experiences, use one of Coveo’s more modern, lightweight, and responsive libraries. To get started, see the Build search article.

Implements the Coveo JavaScript Search Framework ErrorReport component which handles and issues a generic message for search query fatal errors. You may choose whether to display the JSON content of the detailed error message along with the generic message.

Usage notes

  • The Coveo Error Report rendering is only displayed when a query yields a fatal error.

  • You can customize the CSS associated with this rendering.

Insertion location

Coveo Hive

The Coveo Error Report rendering is an Allowed Control in the following placeholder(s): UI Header, UI Results Header, Results Header, UI Footer, Recommendations Components, Results Header

Example insertion sequence for the Coveo Error Report rendering.

Coveo Hive SXA

Coveo for Sitecore SXA rendering insertion locations aren't limited by placeholder Allowed Controls. The Coveo Error Report rendering may therefore be inserted throughout the partial design, whether in Coveo for Sitecore or Sitecore placeholders.

Example insertion sequence for the Coveo Error Report rendering.

Data source options

The following table lists the available data source options for this rendering.

Option name Description

Additional data attributes

Allows use of the Coveo JavaScript Search Framework ErrorReport component options that aren’t directly available in the data source.

Sample generated HTML and corresponding visual output

<div class="CoveoErrorReport">
Error Report example output | Coveo for Sitecore 5