What’s New in Coveo Product Documentation

Our documentation is continually updated with new articles and changes made to existing content. You can subscribe to our RSS feed to be notified when new updates are published (see Subscribing to our Feed).

Coveo Cloud

Release - Coveo Cloud March 26, 2020 Release

March 26, 2020

You can now review the content and related documentation of the Coveo Cloud March 26, 2020 release.

See Coveo Cloud New Features.

New - Published "Subscribing to Crawling Module Deactivation Notifications" Instructions

March 25, 2020

These instructions explain how you can subscribe to activity notifications to receive an alert when a Crawling Module component becomes obsolete and stops your workers.

See Additional Configuration.

Release - Coveo Cloud March 23, 2020 Release

March 23, 2020

You can now review the content and related documentation of the Coveo Cloud March 23, 2020 release.

See Coveo Cloud New Features.

New - Published the "Implementing Facets" Article

March 20, 2020

This new article provides explanations and examples regarding the implementation of facets using the facets query parameter.

See Implementing Facets.

Update - Modified the Crawling Module Documentation

March 16, 2020

The next Coveo On-Premises Crawling Module release will introduce a security update requiring your host server to run Windows Server 2016 version 14393.3504 or greater. The Crawling Module documentation has therefore been updated to reflect this new requirement. In addition, a knowledge base article with details has been published.

See:

Update - Modified the "About Non-Production Coveo Cloud Organizations" Article

March 13, 2020

The “About Non-Production Coveo Cloud Organizations” article has been rewritten to include the new test organization feature and further information on trial organizations.

See About Non-Production Coveo Cloud Organizations.

New - Published the "How Do the Visit Metric and Visit Metric Time Series Cards, and the Other Card Types Compute Visits?" Article

March 5, 2020

This article explains how visit metric and visit metric time series, and the other card types compute visits.

See How Do the Visit Metric and Visit Metric Time Series Cards, and the Other Card Types Compute Visits?.

Update - Modified the "Taking Advantage of the Partial Match Feature" Article

March 4, 2020

This article has been rewritten to be clearer, and a realistic use case has been added.

See Taking Advantage of the Partial Match Feature.

Update - Modified the "Rejecting Items" Article

March 4, 2020

The indexing pipeline extension script sample has been rewritten in an effort to make it easier to understand and use.

See Rejecting Items.

Update - Modified the "Generic REST API Source Reference" Article

February 25, 2020

This article has been extensively restructured in an effort to make the information on the configuration properties more readable and modular.

See Generic REST API Source Reference.

Update - Modified the "Uploading a Data Stream for an Extension Test" Article

February 24, 2020

A section on how to request a data stream has been added to the article, and the examples have been updated to display a more realistic use case.

See Uploading a Data Stream for an Extension Test.

Update - Modified the "Indexing Pipeline Extension Parameters" Article

February 12, 2020

The “Indexing Pipeline Extension Parameters” article has been rewritten in an effort to make it clearer and more concise.

See Indexing Pipeline Extension Parameters.

Update - Modified the "Generic REST API Source JSON Configuration Examples" Article

February 11, 2020

An example of a source JSON configuration with OAuth 2.0 authentication has been added.

See Generic REST API Source JSON Configuration Examples.

Update - Modified the "Adding and Managing Query Pipeline Featured Results" Article

February 4, 2020

The “Adding and Managing Query Pipeline Featured Results” article has been extensively refactored and reorganized in an effort to make it more readable.

See Adding and Managing Query Pipeline Featured Results.

New - Created the Coveo In-Product Experience (IPX) Article

January 30, 2020

This article explains how to take advantage of the new Coveo In-Product Experience (IPX) feature to deploy and maintain Coveo search interfaces within web sites and applications.

See Coveo In-Product Experience (IPX).

New - Created the "Pushing Embedded Documents" Article

January 24, 2020

This article explains which fields to leverage to implement result folding on embedded documents.

See Pushing Embedded Documents.

Update - Modified the "Testing Coveo Machine Learning Models" Article

January 23, 2020

The “Testing Coveo Machine Learning Models” article has been updated to explain how to simulate a pipeline-model association and to test the results it would provide on the Model Testing page of the administration console.

See Testing Coveo Machine Learning Models.

New - Published the "About SameSite Cookie Changes in Chrome 80" Article

January 23, 2020

This article explains that Coveo is committed to updating its Platform and related applications before the release of Google Chrome 80.

See About SameSite Cookie Changes in Chrome 80.

Update - Modified the Single Sign-On Documentation

January 17, 2020

The single sign-on identity provider configuration articles have been reorganized in an effort to make the procedures easier to follow and complete.

See:

Update - Modified the "Adding and Managing Coveo Machine Learning Models" Article

January 15, 2020

The “Adding and Managing Coveo Machine Learning Models” article has been extensively refactored and reorganized in an effort to make it more readable and modular.

See Adding and Managing Coveo Machine Learning Models.

Update - Modified the "Managing the Coveo Machine Learning Model Associations With Query Pipelines" Article

January 15, 2020

The “Managing the Coveo Machine Learning Model Associations With Query Pipelines” article has been extensively refactored and reorganized in an effort to make it more readable and modular.

See Managing the Coveo Machine Learning Model Associations With Query Pipelines.

New - Published the TLS 1.1 Deprecation Article

January 14, 2020

This article explains how to validate that your Coveo On-Premises Crawling Module instance will seamlessly transition to TLS 1.2.

See TLS 1.1 Deprecation.

Update - Modified the "Query Correction Feature" Article

December 19, 2019

The “Query Correction Feature” article has been rewritten in an effort to make it more cohesive. Furthermore, the article now provides code samples for how to enable the Did You Mean feature in a JavaScript Search Framework interface.

See Query Correction Feature.

Update - Modified the "Testing Coveo Machine Learning Models" Article

December 17, 2019

The “Testing Coveo Machine Learning Models” article has been extensively refactored and reorganized in an effort to make it more readable and modular.

See Testing Coveo Machine Learning Models.

Update - Modified the "Exporting and Importing Query Pipeline Elements" Article

December 12, 2019

The “Exporting and Importing Query Pipeline Elements” article has been rewritten in an effort to make it more readable and modular. Furthermore, the article now indicates how to create CSV files to batch import query pipeline rules.

See Exporting and Importing Query Pipeline Elements.

Update - Modified the "Adding and Managing Query Pipeline Thesaurus Rules" Article

December 12, 2019

The “Adding and Managing Query Pipeline Thesaurus Rules” article has been extensively refactored and reorganized in an effort to make it more readable and modular.

See Adding and Managing Query Pipeline Thesaurus Rules.

Update - Modified the "Inspecting All Metadata Values" Article

December 9, 2019

The “Inspecting All Metadata Values” article has been rewritten to show the leading practices for tracing all metadata field values.

See Inspecting All Metadata Values.

Update - Modified the "Understanding Stemming" Article

November 25, 2019

The article includes more detailed information and has been extensively reorganized to make it more readable and modular.

See Understanding Stemming.

Release - Coveo Cloud November 19, 2019 Release

November 19, 2019

You can now review the content and related documentation of the Coveo Cloud November 19, 2019 release.

See November 19, 2019 Update.

New - Published the "Modifying Item Language" Article

October 31, 2019

This article explains how to use an indexing pipeline extension to modify item language when many or no languages have been detected.

See Modifying Item Language.

Update - Modified the "Adding and Managing Query Pipeline Ranking Expressions" Article

October 31, 2019

The “Adding and Managing Query Pipeline Ranking Expressions” article has been extensively refactored and reorganized in an effort to make it more readable and modular.

See Adding and Managing Query Pipeline Ranking Expressions.

Update - Modified the "Push API Limits" Article

October 31, 2019

The recommended maximum number of pushed items/security identities per hour has been disambiguated and more thoroughly explained.

See Recommended Maximum Number of Items/Security Identities per Hour.

Release - Coveo Cloud October 22, 2019 Release

October 22, 2019

You can now review the content and related documentation of the Coveo Cloud October 22, 2019 Release.

See October 22, 2019 Update.

New - Published the "Copying Fields From an Organization to Another" Article

October 10, 2019

This article explains how to export fields from one organization and import them into another.

See Copying Fields From an Organization to Another.

Update - Modified the "Adding and Managing Members" Article

October 8, 2019

The “Adding and Managing Members” article underwent some general improvements.

See Adding and Managing Members.

Update - Modified the "Add or Edit a Database Source" Article

October 8, 2019

A section describing how to retrieve database content using a stored procedure has been added. Stored procedures are especially useful when the query to run against the database is complex.

See Use a Stored Procedure.

Update - Modified the Privilege Management Documentation

The articles in the “Privilege Management” section have been extensively refactored and reorganized in an effort to make them more readable and modular.

See Privileges.

Coveo for Commerce

New - Created the "Configuring a Coveo for Commerce Query Pipeline (Advanced)" Article

February 18, 2020

This article explains how to tune query pipeline components to improve the relevance of a Coveo for Commerce solution.

See Configuring a Coveo Commerce Query Pipeline (Advanced).

New - Published the "Querying Commerce Catalog Content" Article

December 17, 2019

This new article explains how to configure a search interface to query a specific Coveo commerce catalog.

See Querying Commerce Catalog Content.

New - Published the "Creating a Coveo Commerce Catalog" Article

December 12, 2019

This new article explains how to create and configure a commerce catalog to define the structure of commerce-related items in your index.

See Creating a Coveo Commerce Catalog.

Update - Modified the "Logging Coveo Events From Google Tag Manager" Article

November 20, 2019

The article includes additional reference information, and now explains how to configure tags to record page view, product detail view, and add to cart usage analytics events.

See Logging Coveo Events From Google Tag Manager.

Coveo for Salesforce

Update - Modified the Attached Results Component Documentation

March 18, 2020

The Attached Results component documentation has been updated to highlight the differences between the AttachedResults Lightning component, the AttachedResults tab, and the AttachToCase result action.

See Adding the AttachedResults Component.

Release - Coveo for Salesforce February 2020 (v3.46)

February 19, 2020

You can now review the content and related documentation for the Coveo for Salesforce February 19, 2020 release.

See Coveo for Salesforce (3.46) - Winter ‘20 Release - February 19, 2020.

New - Coveo for Einstein Bots Documentation Available

October 31, 2019

These articles explain how to create the Apex classes needed to use the Coveo for Einstein Bots.

See:

New - Published the "Accessing the Coveo for Salesforce Interface Editor" Article

October 8, 2019

This article explains how to access the Interface Editor with different versions of Coveo for Salesforce.

See Accessing the Coveo for Salesforce Interface Editor.

Coveo for Sitecore

Release - Coveo for Sitecore 5 April 1, 2020 Release

April 2, 2020

You can now review the content of the Coveo for Sitecore 5 April 1, 2020 release.

See April 1, 2020 Release - 5.0.642.2.

New - Enriched the "Frames" Rendering Reference Articles

March 27, 2020

The overhaul of the Hive Renderings List articles continues.

In this installment, the Frames rendering articles were written to provide developers and system integrators with all the information they need to add these renderings to a standard Hive search interface, and the alternatives to frames in SXA. Each article also includes the HTML generated by the rendering and a layout of the frame placeholders.

See:

Release - Coveo for Sitecore 4.1 March 2020 Release

March 4, 2020

You can now review the content of the Coveo for Sitecore 4.1 March 2020 release.

See Release Notes for March 2020 - 4.1.735.153.

Release - Coveo for Sitecore 5 February 28, 2020 Release

March 2, 2020

You can now review the content of the Coveo for Sitecore 5 February 28, 2020 release.

See February 28, 2020 (5.0.587.9).

New - Fleshed out the "Scopes" Rendering Reference Articles

February 28, 2020

The overhaul of the Hive Renderings List articles continues.

In this installment, the Scopes rendering articles were written to provide developers and system integrators with all the information they need to add these renderings to a search interface, whether in standard Hive or an SXA site. The articles also list all rendering data source options, with details on their usage. Finally, the articles include samples of the HTML generated by the rendering, the way the rendering data source configuration alters Search API calls, and its effect on query results.

See:

New - Fleshed out the "Result Templates" Rendering Reference Articles

February 17, 2020

The overhaul of the Hive Renderings List articles continues.

In this installment, the Coveo File Result Template and Coveo Item Result Template articles were written to provide developers and system integrators with all the information they need to add these renderings to a search interface, whether in standard Hive or an SXA site. The articles also list all rendering data source options, with details on their usage. Finally, the articles include a sample of the HTML generated by the rendering and a screenshot of what the corresponding visual output could look like.

See:

New - Fleshed out the "Search Interfaces" Rendering Reference Articles

February 11, 2020

Most of the Hive Renderings List articles currently contain only a brief description of the rendering and, where applicable, a link to the reference documentation of its related Coveo JavaScript Search Framework component.

In the weeks to come, we will flesh out these articles and provide readers with all the information they need to add a rendering to a search interface, illustrated through video examples both in standard Hive and SXA sites. The articles will also list all rendering data source options, with the details on their usage. Finally, the articles will include a sample of the HTML generated by the rendering and a screenshot of what the corresponding visual output could look like.

Today, we unveil the first articles to undergo these changes, the Search Interfaces rendering reference pages.

See:

Update - Clarified Coveo for Sitecore 5 Scaling Instructions

January 16, 2020

The Copying the Configuration Files scaling instructions have been further detailed and clarified, especially regarding the location of the Coveo configuration files folder(s) which changes depending on the Sitecore version.

See:

Update - Modified the "Understanding How Coveo for Sitecore Resolves the Site for the Clickable URI" Article

January 6, 2020

The Understanding How Coveo for Sitecore Resolves the Site for the Clickable URI article has undergone general improvements, with a special focus on clarifying that URIs are updated automatically at query time.

See Understanding How Coveo for Sitecore Resolves the Site for the Clickable URI.

New - Added the "Installation" and "Scaling" Section Home Pages

December 13, 2019

As part of the structural changes we are bringing to the Coveo for Sitecore 5 documentation, the Installation and Scaling home pages have been added to introduce the new breakdown of both sections.

See:

Update - Modified the "Indexing" Section Home Page

December 5, 2019

As part of the structural changes we are bringing to the Coveo for Sitecore 5 documentation, the Indexing home page has been repurposed to introduce the new breakdown of the section content.

See Indexing Guide.

New - Added the "Handling Sitecore Access Rights" Section Home Page

December 2, 2019

As part of the structural changes we are bringing to the Coveo for Sitecore 5 documentation, the Handling Sitecore Access Rights section home page was added. The related content was revisited and gathered under this section.

See Handling Sitecore Access Rights.

Release - Coveo for Sitecore 5 November 22, 2019 Release

November 25, 2019

You can now review the content of the Coveo for Sitecore 5 November 22, 2019 release.

See November 22, 2019 - 5.0.515.1.

Update - Added Note in the "Troubleshooting Top Result Issues" Article

November 19, 2019

With Coveo for Sitecore on-premises installations, top results are only segregated by environment if you apply field name translation. A note to that effect was added.

See More on the Sitecore Key Format.

New - Added the "Indexing Fields" Section Home Page

November 19, 2019

As part of the structural changes we are bringing to the Coveo for Sitecore 5 documentation, the Indexing Fields section home page was added. The related content was revisited and gathered under this section.

See Indexing Fields.

New - Added the "Indexing Page Content" Section Home Page

November 5, 2019

As part of the structural changes we are bringing to the Coveo for Sitecore 5 documentation, the Indexing Page Content section home page was added. The related content was revisited and gathered under this section.

See Indexing Page Content.

Update - Modified the "Field Is No Longer Indexed in the Sitecore Items" Article

October 31, 2019

Added a table showing the comprehensive list of legacy fields that were removed in the October 2018 release of Coveo for Sitecore 4.1.

See Cause.

New - Added the "Filtering Your Content" Section Home Page

October 29, 2019

As part of the structural changes we are bringing to the Coveo for Sitecore 5 documentation, the Filtering Your Content section home page was added. The related content was revisited and gathered under this section.

See Filtering Your Content.

New - Added the "Modifying Your Content" Home Page

October 18, 2019

As part of the structural changes we are bringing to the Coveo for Sitecore 5 documentation, the Modifying Your Content section home page was added. The related content was revisited and gathered under this section.

See Modifying Your Content.

Update - Modified the "Enabling the External Source in Sitecore" Article

October 11, 2019

Improved the “Enabling the External Source in Sitecore” instructions by working through the Coveo Search Interface component (thus eliminating the need to insert an External Content component), and by clarifying when filtering rule changes are needed to have external content displayed in search results.

See:

Update - Modified the "Unexpected Token When Editing SXA Page" Article

October 10, 2019

Updated the JavaScript code sample in the “Workaround” section to support Internet Explorer.

See:

Coveo for ServiceNow

New - Created the "Throttling the Coveo for ServiceNow Indexing Process" Article

February 13, 2020

This article explains how to take advantage of REST API rate limiting feature of ServiceNow to throttle the Coveo for ServiceNow indexing process when it significantly impacts the server hosting your ServiceNow instance.

See Throttling the Coveo for ServiceNow Indexing Process.

Release - Coveo for ServiceNow January 2020 Release

January 21, 2020

You can now review the content and related documentation of the Coveo for ServiceNow January 2020 release.

See:

New - Published the "Powering the Global Search Box With Coveo" Article

December 11, 2019

This article explains how you can power the Now Platform UI search box with Coveo. This customization allows you to leverage the improved Coveo search experience while working in your ServiceNow instance.

See 3145.

New - Created the "Understanding the Coveo for ServiceNow" Architecture

This article summarizes how the Coveo for ServiceNow solution integrates in your ServiceNow instance and exchanges information with it to provide a proactive and personalized search experience to your ServiceNow end users.

See Understanding the Coveo for ServiceNow Architecture.

Coveo Javascript Search Framework

New - Published the "Adding the Settings Component to a Search Interface" Article

March 26, 2020

The article explains how to integrate the Settings component to a Coveo-powered search interface.

See Adding the Settings Component to a Search Interface.

Release - JavaScript Search Framework March 2020 (v2.8521) Release

March 6, 2020

You can now review the content and related documentation of the JavaScript Search Framework March 2020 release (v2.8521).

See March 2020 Release.

Release - Interface Editor February 2020 (v1.14.4) Release

February 10, 2020

You can now review the content and related documentation of the Interface Editor February 2020 release (v1.14.4).

See February 2020 Release (v1.14.4).

Update - Modified the "Sending Custom Context Information" Article

January 30, 2020

The article has been reworked to clarify the use of the PipelineContext component.

See Sending Custom Context Information.

Update - Modified the "Version 1.x to 2.x Breaking Changes and Migration Guidelines" Article

January 29, 2020

Generic guidelines for migrating Coveo Cloud hosted search pages from v1.x to v2.x have been added to the article.

See JavaScript Search Framework Version 1.x to 2.x Breaking Changes and Migration Guidelines.

Release - JavaScript Search Framework January 2020 (v2.7968) Release

January 27, 2020

You can now review the content and related documentation of the JavaScript Search Framework January 2020 release (v2.7968).

See January 2020 Release.

Update - Modified the "Folding Results - Example" Article

January 23, 2020

The article has been completely rewritten to make it easier to read and to make the example work out-of-the-box.

See Folding Results - Example.

Release - Interface Editor December 2019 (v1.13.2) Release

December 20, 2019

You can now review the content of the Interface Editor December 2019 Release.

See December 2019 Release.

New - Published the "Leveraging Geolocalization" Article

December 11, 2019

This article explains how to use the DistanceResources component to leverage geospatial data and provides several sample use cases.

See Leveraging Geolocalization.

Update - Modified the "JavaScript Search Framework Tutorial 5" Article

December 9, 2019

The fifth JavaScript Search Framework tutorial has been restructured and updated to make it easier to follow and understand.

See JavaScript Search Framework Tutorial 5 - Configuring Your Own Search Endpoint.

Update - Modified the "Creating a Standalone Search Box" Page

December 9, 2019

The “Creating a Standalone Search Box” article now includes a Node.js Express application example, and has been extensively refactored in an effort to make it easier to use.

See Creating a Standalone Search Box.

Release - JavaScript Search Framework December 2019 (v2.7610.7) Release

December 6, 2019

You can now review the content and related documentation of the JavaScript Search Framework December 2019 release (v2.7610.7).

See December 2019 Release.

Release - Interface Editor November 2019 (v1.12.3) Release

November 20, 2019

You can now review the content of the Interface Editor November 2019 release (v1.12.3).

In particular, this release introduces intelligent code completion when using the Code View.

See November 2019 Release (v1.12.3).

Update - Modified the "JavaScript Search Framework Endpoints" Section

November 20, 2019

The JavaScript Search Framework Endpoints page has been entirely rewritten. Its former child articles have been removed, as they were no longer relevant.

See JavaScript Search Framework Endpoints.

New - Published the "Adding Promoted Results Badges" Article

November 11, 2019

This article explains how to add badges which highlight promoted items in a search interface.

See Adding Promoted Results Badges.

New - Published the "Setting the Search Hub" Article

November 5, 2019

This article explains the purpose of the search hub and how to set it properly.

See Setting the Search Hub.

Update - Modified the "Normalizing Facet Value Captions" Article

October 31, 2019

The “Normalizing Facet Value Captions” article has been fully rewritten to offer a clearer overview of the various ways to customize facet value captions in a search interface.

See Normalizing Facet Value Captions.

Update - Modified the "Interface Editor" Article

October 21, 2019

The “Interface Editor” article has been rewritten and updated with new animated GIFs.

See Interface Editor.

Release - JavaScript Search Framework October 2019 (v2.7219) Release

October 10, 2019

You can now review the content and related documentation of the JavaScript Search Framework October 2019 Release.

See October 2019 Release.

Subscribing to Our Feed

To subscribe to the Coveo Documentation RSS feed, you must first install an RSS feed reader, such as Vienna or RSSOwl.

To subscribe to the Coveo product documentation RSS feed in the Vienna reader:

  1. Access the Create a new subscription panel by pressing Cmd + N.
  2. In the Enter URL of RSS feed text box, type or paste https://docs.coveo.com/en/feed.rss.
  3. Click the Subscribe button.

Subscribing to the feed using Vienna

You’re now set up to automatically receive Coveo product documentation updates.

To subscribe to the Coveo product documentation RSS feed in the RSSOwl reader:

  1. Access the New Feed panel by clicking the New button above the Feeds panel.
  2. In the Create a feed by supplying the website or direct link text box, type or paste https://docs.coveo.com/en/feed.rss.
  3. Click the Finish button.

Subscribing to the feed using RSSOwl

You’re now set up to automatically receive Coveo product documentation updates.

Recommended Articles