Coveo Export To Excel

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.

Export Menu Option | Coveo for Sitecore 5 Implements the Coveo JavaScript Search Framework ExportToExcel component which renders an Export to Excel item in the Settings popup menu.

The Export to Excel option allows website visitors to export their current search results to the Microsoft Excel™ format (.xlsx).

Insertion location

Coveo Hive

The Coveo Export To Excel rendering is an Allowed Control in the following placeholder(s): Searchbox Options

Example insertion sequence for the Coveo Export To Excel rendering.

Coveo Hive SXA

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

To ease rendering management, group Coveo Advanced Search, Coveo Export To Excel, Coveo Preferences Panel and Coveo Share Query renderings together near your Coveo Settings Button rendering.

Example insertion sequence for the Coveo Export To Excel rendering.

Data source options

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

Option name Description

Number of results

See the numberOfResults component option.

Additional data attributes

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

Sample Generated HTML and Corresponding Output

In this example, a user performs a search query in a lake cottage reservation website.

Generated HTML:

<div class="CoveoExportToExcel" data-number-of-results="4">
</div>

When a website visitor selects the Export To Excel option in the Settings popup menu, a Microsoft Excel™ file with the search result information is downloaded.

Export to Excel Sample | Coveo for Sitecore 5