Coveo product documentation changes
Coveo product documentation changes
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 Platform
Update - Modifed the "Taking advantage of the Partial match feature" article
This article was updated to include guidance on how to use the newly revamped Partial match feature.
See Taking advantage of the Partial match feature.
Update - Modified and renamed the "Troubleshoot Push API error codes" article
With the Push source and Push API documentation now united, the scope of the Troubleshoot Push API error codes article has been expanded to include non-API call-related issues when using the Push source. The article has also been renamed to Troubleshooting Push source issues to reflect this change.
See Troubleshooting Push source issues.
Update - Modified the "Manage query parameter rules" article
This article was updated to reflect the revamped Query parameters interface on the Query Pipelines page.
See Manage query parameter rules.
New - Published the "Google Drive source configuration leading practices" article
This article offers tips to Google Drive users on how to maximize content indexing speed and freshness.
See Google Drive source configuration leading practices.
New - Published the "Migrate to Event Protocol" article
The article explains the differences between the Coveo UA protocol and the new Event Protocol, helping readers make an informed decision whether to migrate.
See Migrate to Event Protocol.
Update - Modified the "Review incoherent events" article
This article was archived because the Incoherent Events page in the Coveo Administration Console is now deprecated.
See Review incoherent events (Deprecated).
New - Published the "Analyze RGA data in Snowflake" article
This article details how to view Relevance Generative Answering (RGA) data in Snowflake for an in-depth analysis of your RGA implementation. It guides you on how to access your RGA data in Snowflake, execute SQL queries to analyze question-answer pairs, and explore the complexities between user queries and generated answers.
See Analyze RGA data in Snowflake.
Update - Modified the "Associate a Relevance Generative Answering (RGA) model with a query pipeline" article
This article was updated to include instructions on how to modify the semantic similarity threshold that RGA uses to determine if a segment of text (chunk) is considered relevant to a query.
See Associate a Relevance Generative Answering (RGA) model with a query pipeline.
New - Published the "Optimize Snowflake reader account credits" article
In our effort to help users with efficient data management strategies, we’ve added a new article illustrating how to better manage Snowflake reader account credits.
The article delves into the benefits of well-optimized queries and direct data streaming. It highlights how these strategies can significantly reduce computational load, allowing you to maintain high levels of data analysis and insights.
Use this article to maximize your analytics capabilities while maintaining your monthly Snowflake credits.
See Optimize Snowflake reader account credits.
Update - Modified the "Create and manage Relevance Generative Answering (RGA) models" article
This article was updated to include instructions on how to edit a Relevance Generative Answering model.
See Create and manage Relevance Generative Answering (RGA) models.
Update - Modified the "Create and manage Semantic Encoder (SE) models" article
This article was updated to include instructions on how to edit a Semantic Encoder model.
See Create and manage Semantic Encoder (SE) models.
Update - Modified the "Create and manage a Smart Snippet model" article
This article was updated to include instructions on how to edit a Smart Snippet model.
See Create and manage a Smart Snippet model.
New - Published the "Index metadata" article
This article presents a comprehensive guide to the process of metadata indexing. It offers end-to-end instructions that take you from the efficient extraction of metadata from your content repository, all the way to its storage in your Coveo organization fields. By the conclusion of the article, you’ll be ready to use the indexed metadata in your search interfaces.
Additionally, for ease of reference, we’ve consolidated related articles on the View and map metadata subpage, source mappings, and field management under this new article.
See Index metadata.
Update - Modified the "Create and manage in-product experiences" article
This article was updated to include information on the following:
- When creating a new IPX configuration, enable the Include basic query pipelines and ML models option to automatically create the two recommended query pipelines, and the minimum recommended Coveo ML models, for your IPX configuration.
- How to use the new Version history tab of the In-Product Experience (IPX) builder to view, manage, and restore earlier versions of your IPX search interface configuration.
See:
New - Published the "SharePoint Online source JSON modification" article
This article offers guidance on how to configure SharePoint Online connector parameters that aren’t accessible in the source configuration user interface.
See SharePoint Online source JSON modification.
Release - Published the Relevance Generative Answering (RGA) articles
Published documentation to support the release of the new Relevance Generative Answering (RGA) feature. RGA leverages generative AI technology to generate answers to natural language user queries in a Coveo-powered search interface.
See:
Release - Published the Semantic Encoder (SE) articles
Published documentation to support the release of the new Coveo ML Semantic Encoder (SE) model. When used in a Coveo-powered search interface with Relevance Generative Answering (RGA), an SE model uses vector search to retrieve items from your index based on semantic similarity with the query.
See:
Update - Modified the "Create and manage a Smart Snippet model" article
You can now use a custom filter expression to select the content that a Smart Snippet model uses. This article was updated to include instructions on how to configure a Smart Snippet model using a custom filter expression for content selection.
See Create and manage a Smart Snippet model.
Update - Modified the ML model statuses
We’ve simplified the statuses for the Coveo Machine Learning (ML) models. The model statuses appear on the Models page of the Administration Console.
See Manage models.
New - Published the "Event errors" article
Monitoring an organization’s data health is key to improving and maintaining overall data integrity. This article provides an overview of the new Event errors tab on the Data Health page. This new feature helps you identify syntactic event errors and provides details to help you assess and fix them.
See Event errors.
New - Published the search page builder series
This three-part series of articles covers the process of:
-
Using the search page builder to create a simple search page.
-
Creating query pipelines and machine learning models to improve the relevance of the search results.
-
Adding the search page to your website.
See:
Update - Updated "Add or edit source" articles
Most connector directory Add or edit source articles have been updated to guide readers with the metadata indexing process. The Completion section of these articles now contains an introduction video, instructions on how to map available metadata, and general information on retrieving custom metadata.
See:
Update - Modified the Data Health articles
The revamped Data Health Overview tab is live!
This update offers a comprehensive perspective on your organization’s data health, highlighting areas that need attention. Designed to provide a layered breakdown of your data integrity, the Data Health Overview tab displays several key indicators, such as your Data Health score. This score serves as a baseline for your overall data integrity, with the objective of reaching the highest score possible.
You can achieve this goal by using the Overview tab to explore data validations categorized by specific criteria. You can investigate validation errors to assess their severity levels and the total number of impacted events. Use the Overview tab’s intelligent insights to delve into the cause of these errors and understand what steps are required to fix them and improve the entirety of your data.
Our documentation reflects the new changes, but also includes steps on how to use the tab effectively and also highlights the importance of regularly inspecting your data health to ensure that your Coveo solutions continue to work seamlessly.
See:
New - Published the "Manage version history" article
This article describes how to view, manage, and restore earlier versions of your Coveo Insight Panel Builder implementation.
New - Published the "About Relevance Generative Answering" article
This article provides an overview of the new Coveo Relevance Generative Answering (RGA) feature that generates answers to natural language user queries in Coveo-powered search interfaces. RGA is currently available as a beta.
See About Relevance Generative Answering (RGA).
New - Published the SharePoint Online connector "Performance leading practices" article
Indexing performance with bulky SharePoint Online tenants can be a challenge. This article suggests SharePoint Online connector leading practices that will help you maximize content freshness and relevance.
See Performance leading practices.
Update - Modified the "Manage source mappings" article
This article has been revamped to include better definitions of content metadata and source mappings, as well as an explanation of how Coveo uses mappings to index your metadata. The instructions detailing how to manage your source mappings have also been streamlined.
New - Published the "Snowflake reader account FAQ" article
This article provides an extensive compilation of frequently asked questions regarding the Snowflake reader account and its role in usage analytics.
See Snowflake reader account FAQ.
New - Published articles on how to build SQL queries for reports
These new articles provide guidelines on how to build SQL queries and use them in either the Snowflake reader account or through Data Share to create usage analytics reports. The articles provide code snippets as well as examples of SQL queries.
See:
Update - Modified the "Add an IPX interface to a website" article
This article now includes instructions on how to configure advanced search token authentication for a next-gen IPX search interface. This allows you to generate a distinct search token for each authenticated user so that each user only sees the secured content that they’re allowed to access.
See Add an in-product experience to a website.
New - Published the revamped Web source articles
The Web source user interface is getting revamped!
Don’t let the sleek look fool you. This is anything but a makeover. Clearer instructions, more robust input validations, and new interface-assisted crawling and web scraping configuration modules will ensure you attain the desired indexing result in a fraction of the time.
This revamped Web source is now available in trial organizations only, but it will supersede the legacy Web source user interface very soon. There’s no change in indexing behavior though, and the new Web source handles legacy Web source configurations transparently. We encourage legacy Web source users to create a trial organization and enjoy the new UI experience. You can even use the Resource Snapshot feature to copy existing resources over to the trial organization to get a glimpse into how your current production organization Web source configurations will be displayed and editable.
The public documentation associated with the revamped Web source reflects user interface changes, but it also incorporates countless improvements across most Web source-related articles. A Troubleshooting Web source issues article has even been added.
See:
Update - Modified the "Coveo In-Product Experience (IPX)" articles
Updated the Coveo In-Product Experience (IPX) documentation to include instructions on how to enable Smart Snippets in a next-gen IPX search interface.
See Create and manage in-product experiences.
Update - Modified the "Add or edit a Slack source" article
This article has been updated to reflect the redesigned Slack source configuration interface.
See Add a Slack source.
Update - Modified the "IP Addresses to allowlist" article
The article includes new IP addresses to allowlist for US organizations.
See IP addresses to allowlist.
Update - Modified the "Deployment regions and strategies" article
The article now includes a section describing the new Active-Active resiliency upgrade.
See Deployment regions and strategies.
New - Published the "Relevance Inspector" article
This article introduces the new Relevance Inspector (RI) and provides the necessary steps on how to use this tool to review and troubleshoot the relevance of the search results returned for specific queries.
See Relevance Inspector.
Update - Modified the "Custom login sequence" article
This article has been updated to document previously unmentioned JSON parameters. Examples are now provided for each action type along with a full “real world” custom login sequence example. A JSON schema has also been added to describe all login sequence specifications.
Update - Modified the "Coveo In-Product Experience (IPX)" articles
Updated the Coveo In-Product Experience (IPX) documentation to include instructions on how to create an IPX search interface using the new IPX builder, and how to deploy the IPX to websites and applications.
See Coveo In-Product Experience.
New - Published the "Organization endpoints" article
This article introduces the new organization endpoints and explains how to use them.
New - Published the "Troubleshooting Sitemap source issues" article
This article centralizes Sitemap source issue troubleshooting information. To ease issue identification, cases are grouped into categories and only symptoms are initially displayed; a collapsed section can be expanded to reveal the likely cause of the issue and resolution instructions.
See Troubleshooting Sitemap source issues.
Update - Modified the "Use the Extensions API" article
This article has been updated to include a section about an upcoming Python version update and possible deprecation consequences.
New - Published articles on how to build SQL queries to create reports
This new section provides guidelines on how to build SQL queries and use them in either the Snowflake reader account or through Data Share to create usage analytics reports. The articles provide code snippets as well as examples of SQL queries.
See:
Update - Modified and renamed the "User activity monitoring" article
This article has been renamed and modified to reflect Coveo’s current tracking methods. The “Data tracking” article now includes additional details including the tracking identifiers in use, as well as the current tracking methods.
See Data tracking.
New - Created the "Debug data tracking" and "Customize data tracking" articles
The first article covers the steps required to ensure that data tracking is properly implemented. The second article covers the steps required to set a custom client ID in special cases.
See:
New - Created the "Certificate authority change" article
The article explains that Coveo will change its certificate authority from GoDaddy to Amazon Trust Services on March 1st, 2023.
See Certificate authority change.
Update - Modified the "Evaluate your implementation before going live (checklist)" article
To improve readability and usability, the “Evaluate your implementation before going live (checklist)” article has been converted into a new documentation section that contains multiple articles.
Furthermore, this section now contains 3 new articles explaining how to test other aspects of a Coveo implementation before going live.
See:
New - Published the "Client ID FAQ" Article
This article provides a compilation of frequently asked questions about the client ID and its role in usage analytics.
See Client ID FAQ.
New - Published the "Use the CLI with a Proxy Server" Article
The article explains how to install, update, and use the Coveo CLI on a computer that’s behind a company firewall or web proxy.
See Usage with a proxy server.
Update - Modified and Renamed the "Cookie Compliance" Article
This article has been renamed and reworked to reflect Coveo’s current tracking methods. While it still focuses on compliance, the “User Activity Monitoring” article now includes additional details about the client ID, and also includes a new FAQ section for improved clarity, with questions related to user monitoring.
See Data tracking.
Update - Modified the "Manage trigger rules" Article
This article now includes a new “Reporting on Notification Clicks” section that explains how to track click events on notification links and use them on usage analytics reports.
See Manage trigger rules.
New - Created the "Use the CLI in a CI/CD Pipeline" Article
The article provides an example of a GitHub Action workflow that integrates the Coveo CLI to back up a Coveo organization daily.
See Usage in a CI/CD pipeline.
New - Created the "Manage Organization Snapshots With the Coveo CLI" Article
The article explains how to use the Coveo CLI to pull and push Coveo organization snapshots, simplifying your deployments with modern infrastructure-as-code.
See Manage organization snapshots.
Update - Modified the "Add or Edit a Box Business Source" Article
This article now includes instructions on how to add source filters for Box Business sources to index only certain items and ignore unwanted ones.
See Add a Box Business source.
Update - Modified the "Manage Featured Result Rules"
This article has been updated to reflect the new workflow for creating and editing query pipeline featured result rules.
See Manage featured result rules.
Update - Modified the "Manage the basic configuration of a query pipeline" article
This article has been updated to reflect the changes made to the Overview tab of a query pipeline configuration.
See Manage the basic configuration of a query pipeline.
Update - Modified the "Client ID, Visitor ID, and Visit ID Dimensions" Article
This article was updated to highlight the differences between the client ID and visitor ID dimensions with the aim of encouraging users to transition to using client ID instead of visitor ID. The client ID is the recommended identifier to track the number of visits and unique visitors, especially when a user is anonymous.
See Client ID, Visitor ID, and Visit ID Dimensions.
New - Published the "Model advanced parameters" Article
This article provides instructions on how to use the Coveo Administration Console to configure advanced parameters for your Coveo Machine Learning models.
See Model advanced parameters.
Update - Modified the "Manage ranking expression rules" Article
This article has been updated to reflect the new workflow for creating and editing query pipeline ranking expression rules.
See Manage ranking expression rules.
New - Published the "Third-Party Cookie Deprecation" Article
This article provides details on the upcoming cookie deprecation and instructions on when to upgrade your Coveo implementation.
See Third-party cookie deprecation.
Update - Modified the "Source JSON Modification Options" Article
The JSON Filter Reference section of this article was updated to reinforce the importance of the all-inclusive filter in preventing source starting addresses from being excluded.
See Source JSON modification options.
New - Published the "Add structured data (JSON-LD) to HTML items from index fields" Article
This article provides instructions on how to create an indexing pipeline extension script that lets you specify index fields whose content must be targeted as questions and answers by a Coveo Machine Learning Smart Snippet model.
See Add structured data (JSON-LD) to HTML items from index fields.
Update - Modified the "Create a Slack Connector Bot" Article
This article was updated to include instructions on how to create a Slack bot using a preconfigured manifest file for use with a Slack source.
See Create a Slack connector bot.
New - Published the "PhantomJS End-Of-Life" Article
As of January 2023, Coveo will no longer support the PhantomJS web driver in Web and Sitemap sources. This article guides customers on how to migrate their existing PhantomJS sources to use ChromeDriver.
New - Published the "Manage Data Share" Article
This article provides details on how to use the Data Share feature that lets you integrate your Coveo data into your existing Snowflake account.
See Manage Data Share.
Update - Modified the "Index XML Sitemap Metadata" Article
The scope of the IndexHtmlMetadata JSON parameter was clarified by specifying that this is a crawling stage parameter. The metadata set during the crawling stage is, by default, overridden when the document is processed in the indexing pipeline.
See Index XML sitemap metadata.
Update - Updated the "Privilege reference" Article
This article has been updated to include information about the new Allow content preview privilege of the Machine Learning service.
See Privilege reference.
Update - Modified the "Index XML Sitemap Metadata" Article
This article was updated as it’s no longer necessary to prefix a custom sitemap metadata field name with “sitemap”. The article text and examples were adjusted accordingly. An article note about Coveo support for nested custom metadata XML elements was also clarified.
See Index XML sitemap metadata.
Update - Refactored the "Add Source Filters" Section
The “Add Source Filters” section of the “Source JSON Modification Examples” article has been restructured and streamlined to enhance usability.
See Source JSON modification options.
New - Published the "Add Structured Data (JSON-LD) to HTML Items" Article
This article provides instructions on how to create an indexing pipeline extension script that allows you to specify CSS selectors to be targeted as questions and answers by a Coveo Machine Learning Smart Snippet model.
See Add structured data (JSON-LD) to HTML items from CSS selectors.
New - Created the "Configure an Automatic Relevance Tuning Model for Case Deflection" Article
This article provides instructions on how to configure a Coveo Machine Learning Automatic Relevance Tuning model that is optimized for case deflection.
New - Critical update: Optimized security for Quick views
This article provides instructions on how to ensure that your item Quick views work as expected following the activation of a critical update that includes a security patch for implementations using the Quickview component.
See Critical update: Optimized security for Quick views.
New - Published the "Whitespace Character" Section
This new section presents the syntax to use when including dynamic values that contain whitespace characters in your Generic REST API source configuration.
New - Published the "Manage Snowflake Reader Account" Article
This new article explains how to access and manage the Snowflake reader account using the Coveo Administration Console.
See Manage Snowflake reader account.
New - Created the "Deploy Smart Snippets" Article
This new article provides a step-by-step guide to help users configure and test their Coveo Machine Learning Smart Snippet models.
See Smart Snippets deployment overview.
New - Created the "Exclude Search Interfaces From External Search Engines" article
This new article explains how to exclude Coveo-powered search interfaces from external search engines.
See Exclude search interfaces from external search engines.
New - Published the "Use Smart Snippets" Section
This new section provides an overview of the Coveo Machine Learning Smart Snippet model. It also provides instructions on how to configure and manage Smart Snippet models using the Coveo Administration Console.
See:
New - Published the "Use Coveo Machine Learning Case Classification (CC)" Section
This new section provides an overview of the Coveo Machine Learning Case Classification model. It also provides instructions on how to configure and manage Case Classification models using the Coveo Administration Console.
See:
Update - Modified the "Add or Edit a SharePoint Online Source" Instructions
Coveo now offers improved indexing for SharePoint Online items when a SharePoint Online source is set to not index unapproved items. As a result, we removed mention of Coveo potentially deleting an approved item from the index when a newer Draft or Pending version of the item exists in a SharePoint Online list. Now, if the Unapproved items option is disabled in a SharePoint Online source, approved items are no longer deleted from the index when a draft version of the item exists.
See Add a SharePoint Online source.
New - Published the "Index Content of Shared Drives" Instructions
These instructions describe how to configure your Google Drive for Work source to index content from users’ Shared Drives.
See Add a Google Drive for Work source.
Update - Modified the Web and Sitemap Source JSON Modification Articles
The Web and Sitemap connectors now support JSON-LD metadata. The Web Source JSON Modification and Sitemap Source JSON Modification articles were updated accordingly.
See:
Update - Modified the "Sitemap Source JSON Modification" Article
With the added support of alternate language links in Sitemap files, we updated the Sitemap Source JSON Modification article. The article was also moved and now resides under the Sitemap Source article in the Connector Directory.
See Sitemap source JSON modification.
Update - Refactored the "Leverage Machine Learning" Collection
The “Leverage Machine Learning” collection has been restructured to enhance usability. Each type of Coveo Machine Learning model now has documentation articles dedicated to model creation and model association with query pipelines.
See Leverage machine learning.
New - Published "Changing the Identity Used by the Maestro Service" Instructions
If you use the Coveo Crawling Module, you might need to have the Maestro Service use a specific identity to retrieve your content. These new instructions explain how to change the identity used by the service.
See Crawling Module additional configuration.
New - Created Fourth Module of Platform Developer Tutorial Phase 5
The fourth module of Platform Developer Tutorial Phase 5 is now available. In this module, you will configure Coveo Machine Learning models and associate them to different query pipelines. You will then create a group that grants its members the privilege to view your hosted search page so that you can gather usage analytics data.
See Lesson 3: Machine Learning.
New - Published the "Log Case Assist Events" Article
The article explains how to log usage analytics events in the Case Assist workflow.
New - Created Fourth Module of Platform Developer Tutorial Phase 4
The fourth module of Platform Developer Tutorial Phase 4 is now available. In this module, you will use the Push API SDK for Python to make a single call and a batch call, and to push security identities and aliases.
See Using the Push API SDK for Python.
New - Created Second Module of Platform Developer Tutorial Phase 5
The second module of Platform Developer Tutorial Phase 5 is now available. In this module, you will continue to learn about query pipelines and query pipeline rules.
Update - Modified the "Create a File Container" Article
The article now includes a section about the upcoming deprecation of path-style URLs and the impact it will have on Push API batch calls.
New - Created First Module of Platform Developer Tutorial Phase 5
The first module of Platform Developer Tutorial Phase 5 is now available. In this module, you will learn the basics of query pipelines and query pipeline rules.
Update - Modified JSON Data in Module 1 - Creating a Push Source Article
In the employee_items.json file used in the third Action of Phase 4 Module 1 of the Platform Developer Tutorial, each item in the addOrUpdate array now includes a short biography of the employee in its data field. Unused fields have been removed, while some other metadata keys have been renamed to ensure that their values are automatically mapped to the intended fields when indexing the batch.
If you have already completed this module, you should perform this action once again to push the corrected items.
See Push API Batch Calls.
New - Published the "Manage groups and campaigns" Article
This article explains how you can group query pipeline rules using the new Groups & Campaigns feature in your query pipeline configurations.
See Manage groups and campaigns.
New - Created First Three Modules of Platform Developer Tutorial Phase 4
The first three modules of Platform Developer Tutorial Phase 4 are now available! In these modules, you’ll configure a Push source and use the Push API to interact with it. You’ll learn about making batch calls with the Push API, using security identity providers and permission sets, as well as result template conditions and usage analytics.
See:
New - Published the Coveo Connectivity Library and Connector Building Best Practices
The range of content that Coveo can index and make searchable isn’t limited to the native connectors available in the Administration Console. Thanks to the generic connectors, Coveo can also retrieve content from databases, web applications, websites, etc. To help you index this content, Coveo has created an open-source Connectivity Library on GitHub. This library contains over 15 REST API connector configurations that you can adapt to your needs to index your Slack messages, Stack Overflow questions, etc.
Alternatively, you might want to build your own connector. To help you in this project, Coveo has published the guidelines and best practices you should follow for a successful journey.
See:
New - Critical update: Safer conditional pipeline routing
This article explains what the Safer conditional pipeline routing critical update does, and provides instructions to follow before applying the update in a production organization.
See Critical update: Safer conditional pipeline routing.
Update - Modified the "Deployment Regions and Strategies" Article
The article has been rewritten following the new data residency options. It distinguishes between primary and secondary deployment regions and explains how to implement data residency and multi-region deployments.
See Deployment regions and strategies.
Update - Modified the "Using Special Characters in Queries" Article
The list of special characters has been restructured in an effort to make the information more concise and easier to follow.
See Using special characters in queries.
New - Created Second and Third Modules of Platform Developer Tutorial Phase 3
The second and third modules of Platform Developer Tutorial Phase 3 are now available. In these modules, you will learn about dynamic values, subqueries, and configuring metadata in Generic REST API sources, as well as using geospatial data, event handlers, and result boosting in search interfaces.
See:
New - Published the "Critical update: Improve performance robustness for Case Deflection and Insight Panels" Article
This article explains what the Improve Performance Robustness for Case Deflection and Insight Panels critical update does, and provides instructions to follow before applying the update in a production organization.
See Critical update: Improve performance robustness for Case Deflection and Insight Panels.
New - Created First Module of Platform Developer Tutorial Phase 3
The first module of Platform Developer Tutorial Phase 3 is now available. In this module, you will learn the basics of Generic REST API sources.
See Creating a Generic REST API Source - Part 1.
New - Published the Documentation of the New Crawling Module
A new version of the Coveo On-Premises Crawling Module has been released. This entirely refactored version, which doesn’t require Docker, is meant to replace the Crawling Module working with Docker by December 31, 2020.
The documentation of the new Crawling Module is now available alongside the original Crawling Module documentation.
See:
Update - Modified the "Switch to the New Crawling Module" Article
Details and leading practices regarding the upgrade process have been added.
See Switch to the New Crawling Module.
New - Created Fourth Module of Platform Developer Tutorial Phase 2
The fourth module of Platform Developer Tutorial Phase 2 is now available. In this module, you will learn about item permissions and source content security.
See Managing Source Schedules and Content Security.
Update - Coveo for Microsoft Dynamics 365 End-of-Life
In December 2020, the Coveo for Microsoft Dynamics 365 integration will reach its end-of-life and will no longer be supported by Coveo. This deprecation does not impact custom integrations in a Microsoft Dynamics 365 Portal.
Past the integration end-of-life, the Microsoft Dynamics 365 source will remain available in the Coveo Administration Console to allow you to index Microsoft Dynamics 365 content.
See Coveo for Microsoft Dynamics 365 End-of-Life.
New - Created First Three Modules of Platform Developer Tutorial Phase 2
The first three modules of Platform Developer Tutorial Phase 2 are now available!
See:
Update - Modified the "Add or Edit a Dropbox Business Source" Article
Details regarding the shared folder and file permissions that Coveo supports have been added.
See Add a Dropbox Business source.
New - Published the "Defining Source-Level Permissions" Article
This article explains how you can leverage source-level permissions to restrict access to your indexed content when a connector doesn’t support replicating item-level permissions.
See Defining source-level permissions.
New - Created Fourth Module of Platform Developer Tutorial
The fourth module of Platform Developer Tutorial is now available. In this module, you will configure URL filters, and use web scraping to extract metadata and exclude unwanted document sections.
See URL Filters and Web Scraping.
Update - Modified the "Manage sources" Article
This article has been refactored and reorganized in an effort to make the information clearer and more concise.
See Manage your sources.
New - Created Third Module of Platform Developer Tutorial
The third module of Platform Developer Tutorial is now available. In this module, you will create a hosted search page and modify its default components.
See Creating a Hosted Search Page.
New - Created First Two Modules of Platform Developer Tutorial
The two first modules of Platform Developer Tutorial are now available!
See:
New - Published "Subscribing to Crawling Module Deactivation Notifications" Instructions
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 (Docker Version).
New - Published the "Implement Facets" Article
This new article provides explanations and examples regarding the implementation of facets using the facets query parameter.
See Implement facets.
Update - Modified the Crawling Module Documentation
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 Organizations" Article
The “About Non-Production Coveo Organizations” article has been rewritten to include the new test organization feature and further information on trial organizations.
See About non-production organizations.
New - Published the "How Do the Visit Metric and Visit Metric Time Series Cards, and the Other Card Types Compute Visits?" Article
This article explains how visit metric and visit metric time series, and the other card types compute visits.
See How cards compute user visits.
Update - Modified the "Taking advantage of the partial match feature" Article
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
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
This article has been extensively restructured in an effort to make the information on the configuration properties more readable and modular.
See REST API source reference.
Update - Modified the "Uploading a Data Stream for an Extension Test" Article
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
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
An example of a source JSON configuration with OAuth 2.0 authentication has been added.
See REST API source configuration examples.
Update - Modified the "Manage query pipeline featured results" article
The “Manage query pipeline featured results” article has been extensively refactored and reorganized in an effort to make it more readable.
See Manage featured result rules.
New - Created the Coveo In-Product Experience (IPX) Article
This article explains how to take advantage of the new Coveo In-Product Experience (IPX) feature to deploy and maintain Coveo-powered search interfaces within web sites and applications.
See Create and manage in-product experiences.
New - Created the "Pushing Embedded Documents" Article
This article explains which fields to leverage to implement result folding on embedded documents.
New - Published the "About SameSite cookie changes in Chrome 80" Article
This article explains that Coveo is committed to updating its Platform and related applications before the release of Google Chrome 80.
See Coveo documentation.
Update - Modified the Single Sign-On Documentation
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 "Manage Coveo Machine Learning models" Article
The “Manage Coveo Machine Learning models” article has been extensively refactored and reorganized in an effort to make it more readable and modular.
See Manage models.
Update - Modified the "Manage the Coveo Machine Learning model associations with query pipelines" Article
The “Manage 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 Manage model associations with query pipelines.
New - Published the TLS 1.1 Deprecation Article
This article explains how to validate that your Coveo On-Premises Crawling Module instance will seamlessly transition to TLS 1.2.
See Crawling Module additional configuration.
Update - Modified the "Query Correction feature" Article
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.
Update - Modified the "Export and import query pipeline elements" Article
The “Export and import 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 Export and import query pipeline elements.
Update - Modified the "Manage Query Pipeline Thesaurus Rules" Article
The “Manage Query Pipeline Thesaurus Rules” article has been extensively refactored and reorganized in an effort to make it more readable and modular.
Update - Modified the "Inspecting All Metadata Values" Article
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 "About Stemming" Article
The article includes more detailed information and has been extensively reorganized to make it more readable and modular.
See About stemming.
New - Published the "Modifying Item Language" Article
This article explains how to use an indexing pipeline extension to modify item language when many or no languages have been detected.
Update - Modified the "Manage Query Pipeline Ranking Expressions" Article
The “Manage Query Pipeline Ranking Expressions” article has been extensively refactored and reorganized in an effort to make it more readable and modular.
See Manage ranking expression rules.
Update - Modified the "Push API Limits" Article
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.
New - Published the "Copying Fields From an Organization to Another" Article
This article explains how to export fields from one organization and import them into another.
See Manage resource snapshots.
Update - Modified the "Manage Members" Article
The “Manage Members” article underwent some general improvements.
See Manage members.
Update - Modified the "Add or Edit a Database Source" Article
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.
Update - Modified the Manage privileges Documentation
The articles in the “Manage privileges” section have been extensively refactored and reorganized in an effort to make them more readable and modular.
See Manage privileges.
Coveo for Commerce
New - Published the "About field decomposition" article
This article explains how to use field decomposition to enhance product identifier searchability. It provides a step-by-step guide to breaking down complex strings like model numbers or SKUs into multiple searchable variations using an indexing pipeline extension (IPE).
See About field decomposition.
New - Published the "Debug SAP Commerce Cloud 2011 and later" article
This article provides guidance on debugging SAP Commerce Cloud 2011 and later versions in the context of Coveo for Commerce integration.
See Debug SAP Commerce Cloud 2011 and later.
New - Published Recommendations manager documentation
This article explains how to manage recommendation slots using the Coveo Merchandising Hub (CMH) Recommendations manager. It provides an overview of the Recommendations manager and guides merchandisers on how to apply various merchandising rules to fine-tune the products displayed in recommendation slots.
See CMH Recommendations manager.
New - Documentation for Coveo Merchandising Hub now available
We are excited to announce the release of our documentation for the Coveo Merchandising Hub (CMH). This guide is designed to help you navigate the CMH with ease and maximize the impact of your merchandising efforts in regards to product listing pages and search on a Coveo-powered commerce storefront.
- Overview: Gain a clear understanding of all the features and capabilities of the Coveo Merchandising Hub.
- Guides: Follow easy-to-understand instructions for setting up and managing your merchandising rules.
- Operators: Learn how to effectively use common and numerical operators to tailor product listings to your specific needs.
- Best practices: Discover tips and tricks for optimizing your product rankings and visibility.
- Use cases: Practical examples to illustrate how to apply the hub’s features in real-world scenarios.
- Performance metrics: Learn how to track and analyze the effectiveness of your merchandising strategies.
See Coveo Merchandising Hub (CMH).
New - Published the "User journey validation" article
This article explains how to validate that the Event Protocol is correctly implemented in a Coveo for Commerce user journey.
New - Published the "Catalog enrichment using image classification" article
This article explains how you can use a third-party image classification service to help you build relevant product metadata.
See Catalog enrichment using image classification.
Update - Modified the "Log Coveo events from GTM" article
The article was archived because it was written based on data layer usage specifications that Google had specified for Google Universal Analytics and that have been deprecated with Google Analytics 4.
See Log Coveo events from GTM (Deprecated).
New - Use multiple PR strategies
This article details the process of associating multiple PR strategies within a single query pipeline.
See Use multiple product recommendation strategies.
New - Optimize multiple Catalog sources within an organization
This article explains how to create a multi-catalog structure for Coveo for Commerce implementations that support different languages, operate in multiple countries, and/or manage multiple brands.
See Optimize Catalog sources for multi-language and multi-brand setups.
New - Created the "Index Salesforce Commerce Cloud: Push approach via Coveo Cartridge for B2C Commerce" article
This article explains how to push data from a Salesforce Commerce Cloud instance to a Coveo organization by using the Coveo Cartridge for B2C Commerce.
See Index Salesforce Commerce Cloud: Push approach via Coveo Cartridge for B2C Commerce.
Update - Updated the "Data and catalog" section
The Data and catalog section of the Coveo for Commerce collection was restructured to more effectively represent the process of building and maintaining catalog data in the Coveo index.
See Index and manage catalog data.
New - Created commerce event specific "Data validation" articles
The articles provide guidance on how to validate that you’ve properly captured commerce events which allow you to trace a user’s journey through your ecommerce site.
See Data validation.
New - Created the "Inspect content and properties" article
This article provides guidance on inspecting indexed commerce catalog data following the initial stream or a source update.
See Inspect content and properties.
New - Published the "About the search hub" article
This article offers insights into the role of the search hub in the context of Coveo for Commerce. It provides guidance on configuring the search hub both at the interface and authentication levels, as well as instructions on how to validate the correct implementation of the search hub.
See About the search hub.
Update - Modified the "Leverage variants and availabilities" article
This article has been updated with information about a feature that disables availability filtering to access the entire product catalog, regardless of whether the products are referenced in availability channels or not.
See Leverage variants and availabilities.
Update - Modified the "Log commerce events" articles
In addition to a title change from “Commerce Data Health Implementation Guide” to “Log commerce events”, several sub-articles have been updated in an effort to make the information clearer and more concise for implementers.
See Log commerce events.
Update - Modified the "Leverage variants and availabilities" article
This article has been updated with information on how to format availability metadata with multiple dimensions.
See Leverage variants and availabilities.
Update - Modified the "Overview" Article
This article was updated to include a link to the Coveo for Commerce Implementation Guide that covers the best practices when implementing Coveo for Commerce.
See Overview.
Update - Modified the "About Dynamic Navigation Experience (DNE)" Article
This article introduces the Facet Generator feature that generates facets dynamically for specific product attributes when performing a search.
See About Dynamic Navigation Experience (DNE).
Update - Modified the "Measure cart page events" Article
This article was updated to clarify how to send product quantity data to Coveo Usage Analytics when updating the quantity of items in a shopping cart.
See l3jg0266.
Update - Modified the "Commerce events reference" Article
This article was updated to clarify acceptable currency data types.
See Commerce UA API reference.
New - Created the "Merchandising with Coveo" Article
This article introduces the three key concepts (search interfaces, ranking rules, context information) to successfully implement merchandising with Coveo.
New - Created the "Location-based recommendations" Article
This article explains how you can leverage customer location to adapt the recommendations provided by a Coveo Machine Learning Product Recommendation (PR) model.
See Location-based recommendations.
Update - Modified the "Initialize the Coveo Analytics JavaScript" Article
This article was updated to include the context_website parameter when setting the global variables for collecting data with Coveo UA.
See Initialize the Coveo UA library.
Update - Modified the catalog update articles
The Full Document Update and Partial Document Update articles were merged and reorganized in an effort to make the information clearer and more concise.
See How to update your catalog data.
Update - Modified the "Index commerce catalog content with the Stream API" Article
This article has been updated with Stream API call limitations.
See Index commerce catalog content with the Stream API.
New - Created the "About Session-Based Product Recommendations (SBPR)" Article
This article describes the capabilities of the Coveo Machine Learning Session-Based Product Recommendations (SBPR) feature.
See About Session-Based Product Recommendations (SBPR).
New - Created the "About Intent-Aware Product Ranking" Article
This article describes the Intent-Aware Product Ranking (IAPR) feature as an additional layer of personalization to the offerings of Automatic Relevance Tuning (ART) for commerce.
See About Intent-Aware Product Ranking (IAPR).
Update - Modified the "Collect Commerce Events" Article
The “Collect Commerce Events” article was renamed to the “Commerce Data Health Implementation Guide”. This guide covers the data collection implementation for Coveo for Commerce.
See Log commerce events.
Update - Modified the "Source JSON Modification Options" Article
This article was updated to describe how to enable the group of functionalities that promote the personalization feature for the Generic REST API and Salesforce sources.
See Source JSON modification options.
New - Created the "Partial Document Update" Article
This article describes how to perform a partial document update by modifying specific field(s) within an existing Catalog source.
See m38b9192.
Update - Modified the "Leverage variants and availabilities" Article
This article was updated to describe the new percentage values in the Facet Association tab that represent the frequency of each field by object type.
See Leverage variants and availabilities.
New - Created the "Product Listings" Article
This article describes the Product Listing Page (PLP) REST API feature. The PLP configuration captures a series of include and exclude filters in its search syntax. The search then returns products that share a common trait.
See m27d0229.
New - Created the "About Predictive Query Suggestions (PQS)" Article
This article describes the Predictive Query Suggestions (PQS) feature as an additional layer of personalization to the offerings of Query Suggestions (QS) for commerce.
See About Predictive Query Suggestions (PQS).
Update - Modified the "Stream your catalog data to your source" Article
Added a link to the readme file that describes the Stream API operations that are also available in the Coveo C# Platform SDK.
See Stream your catalog data to your source.
Update - Modified the "Initialize the Coveo Analytics JavaScript" and "Integrate a Search Page Into Your Commerce Solution" Articles
We added an option to create an API key directly from the catalog management menu. It makes the configuration of the key automatic for search and usage analytics. For search, we currently don’t filter on products for the catalog, so it’s mainly used for UA where it will automatically be associated with the catalog ID.
See:
New - Created the "Product embeddings and vectors" Article
This article describes how embeddings and vectors can provide information about products and create personalization in search results.
See Product embeddings and vectors.
Update - Modified the "External search engine optimization (SEO)" Article
This article has been improved to ensure that your content is optimally indexed by external search engines. In addition, we have created an article that explains how to exclude search pages from external search engines.
See:
Update - Modified the "Product Grouping" Article
This article has been updated to explain how to apply product grouping when using the Headless library.
See Product grouping.
Update - Modified the "Product Grouping" Article
This article has been updated to explain how to manually set up product grouping within a recommendation component.
See Product grouping.
New - Created the "Product Grouping" Article
This article explains how to apply product grouping in a commerce interface.
See Product grouping.
Update - Modified the "Log Coveo events from Google Tag Manager" Article
This article has been updated to explain how a user can override a data field value in Google Tag Manager (GTM).
See Log Coveo events from GTM (Deprecated).
New - Created the "Update your Catalog Source" article
This article explains how to add, update or delete specific products in your source without having to re-upload the entire catalog.
See How to update your catalog data.
New - Created the "Event Parameters and Associated Product Recommendation (PR) Models" Article
This article lists the Product Recommendations (PR) strategies linked to specific tracking events.
See Event Parameters and Associated Product Recommendation Models.
Update - Modified the "Gather data and integrate your catalog" Article
This article has been updated to explain why your catalog metadata must contain unique SKUs before you index your data to create a commerce catalog.
See Index and manage catalog data.
Update - Modified the "Index commerce catalog content with the Stream API" article
In this article, the Step 2: Prepare your catalog data section was updated with an example to explain how to use the dictionary field parameter.
See Index commerce catalog content with the Stream API.
Update - Modified the "External Search Engine Optimization" Article
This article’s best practices have been updated to provide a better approach for client-side and server-side renderings.
See External search engine optimization (SEO).
Update - Modified the "Creating a Coveo commerce catalog" article
This article has been updated to explain that the product source you select when creating a catalog can only be used with a single catalog.
Update - Modified the "Creating a Coveo commerce catalog" article
This article has been updated with a Manage Configurations section that explains how to edit and delete a configuration.
New - Created the "Support Multiple Prices per Product" Article
This article describes how to support a dynamic pricing structure in your commerce catalog.
See Support Multiple Prices per Product.
Update - Modified the "Initialize the Coveo Analytics JavaScript" Article
This article has been updated with a list of Coveo Usage Analytics (Coveo UA) alternate endpoints.
See Initialize the Coveo UA library.
Update - Modified the "Tracking Commerce Events" Article
This article has been updated to separate the coveo.analytics.js script flow and examples from the reference documentation.
See Log commerce events.
New - Created the "Measure events on a listing or search page" Article
This article describes how to track and measure changes made on a listing or search page.
See Measure events on a search page.
New - Created the "Measure cart page events" Article
This article describes how to track and measure changes made on a Cart page.
See l3jg0266.
Update - Modified the "Measure events on a product detail page" Article
The Add Impression Data section was updated with clear instructions on how to log impressions manually when a product recommendation list is powered by Coveo and when it isn’t.
See Capture a product detail view event.
Update - Modified the "Creating a Coveo commerce catalog" article
The article has been updated with the new catalog creation process that now includes Catalog Configurations and the introduction of Standard Fields to assist with machine learning.
New - Created Pages for Dispatching Events and Tracking a Checkout Confirmation
The Dispatch an event article describes how to collect and send page view data. The Measure a purchase article is an example of how to track data from a checkout page using TheGym web store.
See:
Update - Modified the "Tracking Commerce Events" Article
We’re in the process of breaking down the “Tracking Commerce Events” section into bite-sized pieces of information. We’ve created specific sections on how to “Initialize the Coveo Analytics JavaScript” and “Extract the searchUid”. We have also added a “Product Detail Page” article and a “Tracking commerce events reference” page.
See:
New - Created a Landing Page for Build Search
This article describes how to integrate a search page and leverage variants and availabilities in Coveo.
Update - Modified the "Tracking Commerce Events" Article
The “Initialize the Script” section was updated to instruct the user to replace the COVEO_API_KEY parameter with an API Key or a search token with the Push access level on the Analytics Data domain and the Allowed access level on the Impersonate domain.
See Log commerce events.
New - Created a landing page for gathering data and integrating your catalog
This article describes how to integrate your products and catalogs into Coveo.
See Index and manage catalog data.
New - Created a Landing Page for Analytics Tracking
This new article describes the two exclusive approaches that exist for tracking analytics within Coveo for Commerce: the Tag Management System and Coveo Analytics JavaScript.
See Collect usage analytics events.
Update - Modified the "Leveraging Machine Learning Product Recommendations" Article
The article now includes a procedure that describes how to render Product Recommendations with the Headless library.
See Query a Product Recommendation model with Headless.
Update - Modified the "Log Coveo events from Google Tag Manager" Article
The article has been reworked in order to better align with the process flow of Google Tag Manager workspace.
See Log Coveo events from GTM (Deprecated).
New - Published Coveo Machine Learning Product Recommendations Public Documentation
The following articles now include procedures that describe how to manage Coveo Machine Learning Product Recommendation (PR) models in a Coveo-powered commerce solution.
See:
Update - Modified the "Integrating a Search Page Into Your Commerce Solution or Website" Article
The “Integrating a Search Page Into Your Commerce Solution or Website” article has been reworked to give a clearer overview of how to use the Coveo JavaScript Search Framework.
See Integrate a search page into your commerce solution.
New - Created the "Configuring a Coveo for Commerce Query Pipeline (Advanced)" Article
This article explains how to tune query pipeline components to improve the relevance of a Coveo for Commerce solution.
See Manage query pipeline configurations for commerce catalog content.
New - Published the "Querying commerce catalog content" article
This new article explains how to configure a search interface to query a specific Coveo commerce catalog.
See Leverage variants and availabilities.
New - Published the "Creating a Coveo commerce catalog" article
This new article explains how to create and configure a commerce catalog to define the structure of commerce-related items in your index.
Update - Modified the "Log Coveo events from Google Tag Manager" Article
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 Log Coveo events from GTM (Deprecated).
Coveo for Salesforce
New - Published the "Choose the right Insight Panel component" article
This article provides guidance on choosing the right component to implement an Insight Panel in your Salesforce organization.
See Choose the right Insight Panel component.
New - Published Coveo for Salesforce v6 articles
These articles describe the new features and updates introduced in the initial release of the Coveo for Salesforce v6 package.
See:
New - Published the "Impacts of endpoint deprecation" article
This article describes how the deprecation of the Coveo V1 platform and usage analytics endpoints impacts Coveo for Salesforce. It also provides guidelines to ensure that your Coveo for Salesforce implementation continues to function as expected.
See Impacts of endpoint deprecation.
Update - Modified the "Integrate a Coveo Hosted Insight Panel component" article
This article has been modified to include a new “Leverage Relevance Generative Answering” section. A new Custom Context Provider picklist option was also added to the Coveo Hosted Insight Panel component. This feature makes it easy to augment queries with additional context returned by a custom Apex class.
See Integrate a Coveo Hosted Insight Panel component.
New - Published the "Add custom context to the Hosted Insight Panel" article
This article describes how to add custom context to the Hosted Insight Panel by creating a custom Apex class that implements the CoveoV2.HostedCustomContextInterface.
See Add custom context to the Hosted Insight Panel.
Update - Modified the "Integrate a Coveo Hosted Insight Panel component" article
In this article, the Coveo Quantic Insight Panel component has been renamed to Coveo Hosted Insight Panel for consistency and clarity across the documentation.
See Integrate a Coveo Hosted Insight Panel component.
Update - Modified the "New Coveo for Salesforce features" article
This article has been updated to highlight the exciting new features that are part of the Coveo for Salesforce Fall ‘23 release.
See New Coveo for Salesforce features.
New - Published Coveo for Salesforce v5 articles
These articles describe the main changes and new features introduced in the initial release of the Coveo for Salesforce v5 package.
See:
New - Published the "Index Salesforce Knowledge" and "Salesforce source JSON modification" Articles
The first article describes how to index Salesforce Knowledge. The second one describes the Salesforce source hidden parameter that can be used to preserve the permanent IDs of your Classic Knowledge article versions when migrating to Lightning Knowledge.
See:
New - Published the "SalesforceAdaptiveResultLink Component" Article
This article provides developer reference documentation for the SalesforceAdaptiveResultLink component, which brings together the benefits of the ConsoleResultLink, SalesforceResultLink, and ResultLink components.
See SalesforceAdaptiveResultLink Component.
Update - Modified the "Adding the User Actions component to the Coveo Insight Panel Lightning Component" Article
This article has been updated to describe the latest Session Summary and User Activity Timeline improvements.
See Add the UserActions component to the Coveo Insight Panel Lightning Component.
New - Published the "Before you begin: Identify the requirements" and the "Design your form" Articles
The first article covers the information you need to configure the Coveo Case Assist solution. The second highlights key points to consider when designing a case creation form.
See:
Update - Modified the "Getting Started with Coveo Case Assist" Article
This article has been updated to showcase the latest Quantic Case Assist demo. The “Ensure You Have All the Requirements” and “Design Your User Interface” steps have also been added. Finally, a new “Documentation Quick Reference” section has been included to regroup all the articles that relate to Coveo Case Assist.
See Get started with Coveo Case Assist.
New - Published the "Safely Apply Content Filtering" Article
This article provides instructions on how to safely filter content from a Salesforce source whose content is accessible to everyone in a Salesforce Community.
See Safely apply content filtering.
New - Published the "Index Chatter feeds" Article
This article describes how to index the Chatter feeds that are associated with each type of object in your Salesforce organization.
See Index Chatter feeds.
Update - Modified the "Generate Case Assist reports" Article
This article has been updated to describe how to add a custom dimension using the new “Semi-structured dimension” feature. A new “Common Dimensions Quick Reference” section has also been added to list the dimensions that are most commonly used in Case Assist reports. Finally, this section also describes how to create a dimension for your custom data.
See Generate Case Assist reports.
New - Published the "Integrate a Coveo VisitorIdAccessor Lightning Component" and the "VisitorIdAccessor Lightning Component" Articles
The first article describes how to integrate the new Coveo VisitorIdAccessor Lightning component to enable customers to retrieve the visitor ID in their custom components. The second article provides developer reference information about the component.
See:
Update - Modified the "Manage Case Assist Configurations" Article
This article has been updated to describe the new Case Classification methods (that is, Case Similarity and Context Recognition) that can be used to generate classification suggestions.
See Manage Case Assist configurations.
Update - Modified the "Configuring a Salesforce source" and "Get Started With Coveo for Salesforce B2B Commerce" Articles
These articles have been updated to document the new B2B Commerce for Visualforce (Products) and B2B Commerce for Visualforce (Orders) presets that can be used to configure B2B Commerce for Visualforce sources. For clarity and consistency, the “Get started with Coveo for Salesforce B2B Commerce” article has also been renamed to “Get started with Salesforce B2B Commerce for Visualforce”.
See:
New - Published the "Generate Case Assist reports" Article
This article describes how to generate a Case Assist dashboard based on the standard Case Assist events.
See Generate Case Assist reports.
New - Published the "Get Started With Coveo Case Assist" Article
The new Get Started With Coveo Case Assist article provides an overview of the resources available to implement a case creation experience powered by Coveo Case Assist.
See Get started with Coveo Case Assist.
Update - Modified the "Configuring a Salesforce source" Article
The permission descriptions in the “Creating a Dedicated Salesforce Crawling User” section have been updated and a new “Permissions Quick Reference” section has been added. This new section provides a summary of the permissions that must be set for the crawling user depending on the Salesforce objects you want to index.
Update - Modified the "Configuring the Salesforce Source" Article
A dedicated Salesforce linking account is no longer required to configure the Coveo for Salesforce integration package. For information on how to crawl and index your Salesforce content, see the new “Creating a Dedicated Salesforce Crawling User” section in the “Configuring the Salesforce Source” article.
New - Published the "Get started with Coveo for Einstein Bots" Article
The new Get started with Coveo for Einstein Bots article explains how to take advantage of Coveo’s search and recommendation capabilities in your Salesforce Einstein bots.
See Get started with Coveo for Einstein Bots.
Update - Modified the "About the architecture" Article
This article has been refactored and reorganized to make it clearer and easier to follow.
New - Published the "Upgrading to the New Coveo Insight Panel Lightning Component Experience" Article
This article describes how to upgrade your existing Coveo Insight Panel Lightning Component to the new design and activate the new experience available in the Coveo for Salesforce v4.6 release package.
See Upgrade to the new Coveo Insight Panel Lightning Component experience.
Update - Modified the "Creating a Dedicated Salesforce Linking Account" Article
The “Modify All Data” permission is no longer required by the Salesforce crawling account to index content inside the Coveo index.
New - Insight Query Summary component
These articles respectively provide reference and administrator documentation for the new Insight Query Summary component that was introduced in the Coveo for Salesforce v4.4 release package.
See:
Update - Modified the Attached Results component Documentation
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 Add the Attached Results component.
New - Coveo for Einstein Bots Documentation Available
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
This article explains how to access the Interface Editor with different versions of Coveo for Salesforce.
See Access the Coveo for Salesforce Interface Editor.
Coveo for SAP Commerce
New - Created the "Use Coveo recommendations in SAP Commerce Cloud Composable Storefront" article
This article explains how to implement product recommendations powered by Coveo Machine Learning in an SAP Commerce Cloud project.
See Build your product recommendations interface (legacy).
New - Created the "Authenticate via search token" Article
This article explains how to use Coveo search token authentication in SAP Commerce Cloud.
See Authenticate via search token.
New - Created the "Use Coveo Search in SAP Commerce Cloud Composable Storefront" Article
This article explains how to add Coveo search to the SAP Commerce Cloud composable storefront.
See Build your search interface (legacy).
New - Created the "Add or Edit an SAP Source" Article
This article explains how to add and edit an SAP source that allows you to index SAP Commerce catalogs.
See Add an SAP source.
New - Created the "Index SAP Commerce Cloud" Article
This article explains how to index your SAP Commerce catalogs via the pull or push approach.
New - Created the "Indexing SAP Commerce Using the SAP OData2 GET API" Article
This article describes how to import products from an endpoint in SAP Commerce (previously called Hybris) and how to crawl the content using a Generic REST API connector.
Coveo for ServiceNow
Update - Modified the "Configure the Coveo Insight Panel" Article
This article was updated to include instructions on how to add the Coveo Insight Panel to a CSM Configurable Workspace in ServiceNow.
See Configure the Insight Panel.
Update - Modified the "Use extension points to customize your deployment" Article
This article was updated to include the new getJsUiCultureMap extension point function that’s used to map a ServiceNow language ID to the appropriate language culture file key in the Coveo JavaScript Search Framework.
See Use extension points to customize your deployment.
Update - Modified the "Create a ServiceNow Source" Article
This article was updated to include a new Safely Apply Content Filtering section that details leading practices to ensure that your source content is safely filtered and only accessible by the appropriate users when the indexed source content is accessible to everyone.
Update - Modified the "Create a ServiceNow Source" Article
This article was updated to add the sys_db_object and sys_dictionary tables to the list of tables to which your ServiceNow crawling account must have access. These tables provide the crawling account with access to your ServiceNow system tables in the source panel “Content to include” tab.
New - Added the "Add the Coveo Search Box to a Service Portal Header" Section
This section describes how to add the standalone Coveo search box to a header in your Service Portal.
See Replace the Service Portal search boxes.
Update - Modified the "Install Coveo for ServiceNow" Article
This article was updated to include instructions on how to connect a ServiceNow instance to an organization on the Coveo HIPAA Platform.
New - Published the "Create a ServiceNow business rule for work notes" article
This article describes how to create a ServiceNow business rule that automatically adds a custom work note when a user attaches or detaches a Coveo search result in a case or incident.
See Create a ServiceNow business rule for work notes.
Update - Modified the "Widget reference" article
Updated the article to include details on how to add the Coveo Top Queries widget to your ServiceNow instance.
See Widget reference.
New - Published the "Index ServiceNow Knowledge Blocks" Article
This article describes how your ServiceNow source indexes the content of ServiceNow knowledge blocks, and how to exclude knowledge blocks from Coveo search results.
See Index ServiceNow knowledge blocks.
New - Published the "Use Custom Table Fields in User Criteria Records" Article
This article describes how to use custom table fields in a ServiceNow user criteria record with advanced (scripted) permissions to replicate the ServiceNow user permissions and index who can access source items through a Coveo-powered search interface in ServiceNow.
See Use custom table fields in user criteria records.
New - Published the "Implement a 'Create Knowledge Article' Button" Article
This article explains how you can implement a “Create Knowledge Article” button to help support agents create knowledge articles for future reference. This button appears on the case or incident form and acts as a shortcut to open a knowledge article creation form. This button can also be added to the Insight Panel.
See Implement a Create Knowledge Article button.
Update - Modified the "Creating a ServiceNow Source" Article
Details regarding field and mapping creation have been added.
Update - Modified the "Configuring Coveo Query Filters" Article
An example has been added to illustrate a way in which you can leverage Coveo query filters.
New - Created the "Throttling the Coveo for ServiceNow Indexing Process" Article
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 Throttle the indexing process.
New - Published the "Powering the Global Search Box With Coveo" Article
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 Configure the built-in Coveo-powered search page.
New - Created the "About the Coveo for ServiceNow" Architecture Article
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 Architecture.
Coveo for Sitecore
Update - Modified the "Activate silently" article
This article has been modified to reflect the updated Coveo for Sitecore API key privileges.
For Sitecore users who activated Coveo for Sitecore through the user interface or by using the bundled Coveo for Sitecore API, no action is required on your part.
For users who created their Coveo for Sitecore API keys manually using the Coveo Platform API, we recommend that you review and update your API key privileges, if you haven’t already done so.
See New features.
Update - Modified the "About the coveoPostItemProcessingPipeline pipeline" article
As a follow-up to the code sample illustrating how to index a Sitecore item and its related media item, we’ve added a new code sample that shows how you can populate a Coveo field on the media item.
See Code sample: Adding and populating a field on a Coveo item.
Update - Modified the "Understanding how Coveo for Sitecore loads the Coveo JavaScript Search Framework files (CDN)" article
This article has been revised to better separate parts about Coveo for Sitecore Hive and those related to the Coveo JavaScript Search Framework. Advantages of using either local files or the CDN to load the Coveo JavaScript Search Framework are now more clearly stated.
See Understanding how the Coveo JavaScript files are loaded (CDN).
Update - Modified the "Display Result Sort Options in a Dropdown" Article
Screenshots and an animation were added to this article to improve clarity.
See Display Result Sort Options in a Dropdown.
Update - Modified the "Computed Fields" Section
The Computed Fields section home page has been reworked and enriched with additional general information. The entire content in this section has also been refreshed and clarified, with all children articles now sharing a common structure.
See Computed fields.
Update - Modified the "Analyze the Rebuild Process" Article
This article has been reworked to improve clarity. A section on configuring custom Coveo for Sitecore logs has also been added.
See Analyze the rebuild process.
Update - Modified the "About the Architecture of Coveo for Sitecore" Article
Notes were added in the query event workflow sections to explain how Coveo for Sitecore generates and uses search tokens.
Update - Modified the "Coveo for Sitecore Configuration Guide" Article
This article was redone to better describe the resources it references. The child articles have also been reorganized more logically.
See Configuration Guide.
Update - Modified the "Specify Which Templates to Index" Article
This article was reworked to improve clarity. Configuration instructions were separated into two sections, one for pre-Sitecore 8.1 versions and the other for more recent Sitecore versions. Example code blocks are more meaningful as they now include multiple child template elements, each with a unique name and Item ID.
See Specify which templates to index.
Update - Modified the "Prepare the Main Sitecore Content Manager for a Scaled Environment" Article
This article has been revised to reduce the number of configuration steps and to make it easier to follow.
See Prepare the main Sitecore content manager for a scaled environment.
New - Published the "Install Coveo for Sitecore With Sitecore in Docker" Article
This article provides instructions on how to generate Coveo for Sitecore Docker images and launch Sitecore Docker instances with Coveo for Sitecore pre-installed.
See Install With Sitecore in Docker.
Update - Modified Coveo Distance Resources Related Articles
An example item showing latitude and longitude coordinates of the Coveo Quebec City office was added to the Insert and Customize a Distance Resources Component and Coveo Distance Resources articles. The former was also updated to provide links to related Coveo for Sitecore Hive Rendering reference articles and to make it more in line with current Coveo for Sitecore documentation practices.
See:
Update - Modified and Renamed the "Set Up the Interface" Article
This article has been renamed and its purpose has slightly changed. While it remains a general overview of the articles in the section, the Create the Search Solution article now more clearly specifies the search solution pieces that should be created by the end of the current implementation phase. The article now also describes Coveo for Sitecore main search page creation options, with pros and cons and getting started instructions for each one.
See Create the search solution.
Update - Modified the "Understanding the REST Endpoint Configuration File" Article
This article has been reworked to improve clarity by adding, among other changes, information on the Coveo.SearchProvider.Rest.Custom.config file and how its settings impact the compiled configuration in Sitecore. The article terminology has also been harmonized with more recent wording used throughout the Coveo for Sitecore documentation and other Coveo documentation collections.
See About the REST Endpoint Configuration Files.
New - Published the "Coveo for Sitecore JSS" Documentation
Coveo for Sitecore JSS gives you the ability to deploy a Coveo-powered search interface within your Sitecore JSS apps. In this new documentation section, we cover all the Coveo for Sitecore JSS implementation steps, from installing the Coveo for Sitecore JSS beta package, to integrating and deploying Coveo for Sitecore JSS components within a JSS app. As the recommended Coveo for Sitecore JSS implementation strategy is to use the Coveo Hosted Search Page component to retrieve the HTML of a hosted search page, the documentation also explains how developers can use Coveo Turbo to create, update, and deploy search pages to a Coveo organization.
See:
Update - Modified the "What's Coveo for Sitecore?" and "About the Architecture of Coveo for Sitecore" Articles
The product architecture diagram in the What’s Coveo for Sitecore? article has been updated to include Coveo modules. All diagrams in the About the Architecture of Coveo for Sitecore article have also been revamped, with Query Pipeline and Machine Learning modules added to the query processing workflow.
See:
Update - Modified the "Query Suggestions" Article
This article on implementing Query Suggestions in Coveo for Sitecore search interfaces has been reworked to improve clarity with regards to the amount of usage analytics required before the Coveo Searchbox component begins suggesting queries. We also added a link to the Coveo UA bot, a tool that empowers users to batch generate usage analytics events.
See Query Suggestions.
Update - Modified Articles in the "Change the Settings of Sitecore Fields" Section
The listed articles have been reviewed to improve accuracy and consistency.
See:
Update - Added Section to the "Editing the Content of a Result Template" Article
The new Server-Side Versus Client-Side Result Template Resolution section provides syntax for both server-side and client-side code. Using an example, the article explains how a piece of code from a .cshtml file is progressively resolved until it’s rendered as HTML in a browser.
See Server-Side Versus Client-Side Result Template Resolution.
New - Published the "Accessibility in Coveo for Sitecore" Article
This article explains how accessibility in Coveo for Sitecore is handled through the underlying Coveo JavaScript Search Framework, and provides guidance on adding ARIA landmarks in Coveo for Sitecore search interfaces.
See Accessibility in Coveo Hive.
New - Enriched the Reference Articles of the "Components" Group
The overhaul of the Coveo Hive Renderings Reference Documentation articles continues.
In this installment, the articles of the Components group were enriched 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 in an SXA site. The articles provide details on the data source options each rendering exposes. Finally, each article includes a sample of the HTML generated by the rendering and the corresponding rendering visual output and behavior.
See:
New - Enriched the Four Remaining Reference Articles of the "Facets" Group
The overhaul of the Coveo Hive Renderings Reference Documentation articles continues.
In this installment, the Coveo Category Facet, Coveo Distance Facet Range, Coveo Numeric Facet Range, and Coveo Numeric Facet Slider articles were enriched 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 in an SXA site. The articles provide details on the data source options each rendering exposes. Finally, each article includes a sample of the HTML generated by the rendering and the corresponding rendering visual output and behavior.
See:
New - Enriched Two Rendering Reference Articles of the "Sections" Group
The overhaul of the Coveo Hive Renderings Reference Documentation articles continues.
In this installment, the External Components Section and Placeholder Section articles were enriched to provide developers and system integrators with all the information they need to add these renderings to a search interface. The articles provide details on the data source options each rendering exposes. Finally, each article includes a sample of the HTML generated by the rendering and the corresponding rendering behavior or output in the Experience Editor.
See:
New - Enriched Three Rendering Reference Articles of the "Facets" Group
The overhaul of the Coveo Hive Renderings Reference Documentation articles continues.
In this installment, three articles in the Facets group were enriched 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 the corresponding visual output.
See:
New - Added the "About the Search Hub" Article
In the Setting Up the Interface section, the About the Search Hub article was added to emphasize the importance of providing custom search hub values and show integrators where they can be applied in Coveo for Sitecore rendering data sources.
See About the Search Hub.
New - Enriched Most Rendering Reference Articles of the "Sections" Group
The overhaul of the Coveo Hive Renderings Reference Documentation articles continues.
In this installment, ten of the twelve articles in the Sections group were enriched to provide developers and system integrators with all the information they need to add these renderings to a standard Hive search interface. For SXA sites, we suggest alternatives to Coveo Hive section renderings (that is, Sitecore Containers and Splitters) and link to relevant SXA rendering insertion sequence videos, when possible. The articles also include a sample of the HTML generated by the rendering in the Sitecore Experience Editor.
See The Sections Group.
New - Enriched the "Coveo Facet Value Suggestions" Rendering Reference Article
The overhaul of the Hive Renderings List articles continues.
The Coveo Facet Value Suggestions article was enriched to provide developers and system integrators with all the information they need to add this rendering to a search interface, whether in standard Hive or an SXA site. The article also lists all rendering data source options, with details on their usage. Finally, the article includes a sample of the HTML generated by the rendering and the corresponding rendering behavior.
See Coveo Facet Value Suggestions.
New - Enriched the "Coveo Tab" Rendering Reference Article
The overhaul of the Hive Renderings List articles continues.
The Coveo Tab article was enriched to provide developers and system integrators with all the information they need to add this rendering to a search interface, whether in standard Hive or an SXA site. The article also lists all rendering data source options, with details on their usage. Finally, the article includes a sample of the HTML generated by the rendering and the corresponding Search API call aq value.
See Coveo Tab.
Update - Modified the "Coveo for Sitecore 4 to Coveo for Sitecore 5 Upgrade Procedure" Article
The Coveo for Sitecore 4 to Coveo for Sitecore 5 Upgrade Procedure article has been reworked in an effort to make the information clearer.
See Coveo for Sitecore 4 to 5 upgrade procedure.
Update - Added Troubleshooting Documentation for Malformed or Unexpected ClickableURIs
We added a Troubleshooting section to the Understanding How Coveo for Sitecore Resolves the Site for the Clickable URI article to help customers facing malformed or unexpected ClickableURI issues.
See Troubleshooting.
Update - Increased Prominence of the Version 5 Collection and Enhanced the Home Page
To streamline access to Coveo for Sitecore 5 documentation, we moved the entire collection up one level in the public documentation hierarchy. As a result, the Coveo for Sitecore 5 Documentation article becomes the Coveo for Sitecore root page in the table of contents. Coveo for Sitecore 4 articles remain accessible using the same navigation path as before.
We also reinvented the Coveo for Sitecore home page.
See Coveo for Sitecore 5.
New - Enriched the "Search Boxes" Rendering Reference Articles
The overhaul of the Hive Renderings List articles continues.
In this installment, the Search Boxes section articles 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 an illustration of the corresponding search box behavior.
See:
New - Enriched the "Resources" Rendering Reference Articles
The overhaul of the Hive Renderings List articles continues.
In this installment, the Resources section articles 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 an illustration of the corresponding rendering behavior.
See:
New - Enriched the "Settings Button Options" Rendering Reference Articles
The overhaul of the Hive Renderings List articles continues.
In this installment, the Settings Button Options section articles 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 an illustration of the corresponding rendering behavior.
See:
New - Enriched the "Analytics" Rendering Reference Articles
The overhaul of the Hive Renderings List articles continues.
In this installment, the Analytics section 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 of the related requests to the Coveo Usage Analytics service or to Sitecore Experience Analytics.
See:
New - Enriched the "Sorts" Rendering Reference Articles
The overhaul of the Hive Renderings List articles continues.
In this installment, the Sorts section 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 an animation demonstrating the user interface control in action.
See:
New - Enriched the "Frames" Rendering Reference Articles
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:
New - Fleshed out the "Scopes" Rendering Reference Articles
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
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
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’ll 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
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
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 How the site for the clickable URI is resolved.
New - Added the "Installation" and "Scaling" Section Home Pages
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
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 Coveo for Sitecore indexing.
New - Added the "Handling Sitecore Access Rights" Section Home Page
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 Handle Sitecore access rights.
Update - Added Note in the "Troubleshooting Top Result Issues" Article
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
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 Index fields.
New - Added the "Indexing Page Content" Section Home Page
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 Index page content.
Update - Modified the "Field Is No Longer Indexed in the Sitecore Items" Article
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
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.
New - Added the "Modifying Your Content" Home Page
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.
Update - Modified the "Enabling the External Source in Sitecore" Article
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
Updated the JavaScript code sample in the “Workaround” section to support Internet Explorer.
See:
-
Unexpected Token When Editing Page With SXA Components in Experience Editor (C4SC 5)
-
Unexpected Token When Editing Page With SXA Components in Experience Editor (C4SC 4.1)
Coveo for Zendesk
New - Published the "Safely Apply Content Filtering for Zendesk"
This article provides the leading practices to ensure that your indexed content is accessible to the appropriate users when your Zendesk source items are available to everyone.
See Safely apply content filtering.
New - Published the "Coveo for Zendesk" Collection
This article collection explains how the Coveo for Zendesk integration connects a Coveo organization to a Zendesk instance and enhances the user experience for agents using Zendesk Support, and end users using the self-service Help Center on Zendesk Guide.
See Coveo for Zendesk.
Coveo Customer Service Solutions
New - Use Case Assist with secured content
This article describes how to use a platform token instead of an API key to access secured content in Case Assist.
See Use Case Assist with secured content.
Coveo JavaScript Search Framework
New - Published the "JavaScript search framework component equivalences" article
This article includes a table listing JavaScript Search Framework components alongside their equivalents in Atomic and/or Headless, where applicable.
See JavaScript search framework component equivalences.
Update - Modified the "Facet Types" Article
The “Facet Types” article has been rewritten to be more thorough and to include examples as well as screen captures for all dynamic and regular facet types.
See Facet types.
Update - Modified the "Using Hierarchical Facets" Article
The “Navigating and Filtering” section was added to explain how navigation works in hierarchical facets and how to combine them with dependent facets for increased filtering capabilities.
New - Published the "Defining Dependent Facets" Article
This article explains how to use the dependsOn and dependsOnCondition facet options to display a facet only when another facet is in a certain state.
New - Published the "Adding the Settings Component to a Search Interface" Article
The article explains how to integrate the Settings component to a Coveo-powered search interface.
See Add the Settings component to a search interface.
Update - Modified the "Sending Custom Context Information" Article
The article has been reworked to clarify the use of the PipelineContext component.
See Send custom context information.
Update - Modified the "Version 1.x to 2.x Breaking Changes and Upgrade Guidelines" Article
Generic guidelines for upgrading Coveo hosted search pages from v1.x to v2.x have been added to the article.
See Version 1.x to 2.x breaking changes and upgrade guidelines.
Update - Modified the "Folding results - Example" Article
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.
New - Published the "Leveraging Geolocalization" Article
This article explains how to use the DistanceResources component to leverage geospatial data and provides several sample use cases.
Update - Modified the "JavaScript Search Framework Tutorial 5" Article
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 - Result Templates.
Update - Modified the "Creating a Standalone Search Box" Page
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 Create a standalone search box.
Update - Modified the "JavaScript Search Framework Endpoints" Section
The JavaScript Search Framework Endpoints page has been entirely rewritten. Its former child articles have been removed, as they were no longer relevant.
See Endpoints.
New - Published the "Adding Promoted Results Badges" Article
This article explains how to add badges which highlight promoted items in a search interface.
See Add promoted results badges.
New - Published the "Setting the Search Hub" Article
This article explains the purpose of the search hub and how to set it properly.
See Set the Search Hub.
Update - Modified the "Normalizing Facet Value Captions" Article
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 Normalize facet value captions.
Update - Modified the "Interface Editor" Article
The “Interface Editor” article has been rewritten and updated with new animated GIFs.
See Use the legacy Interface Editor.
Coveo Atomic Library
Update - Modified the "Usage Analytics" section
The articles in this section have been reorganized to host new articles on Event Protocol, the new standard for sending analytics events to Coveo.
See Usage Analytics.
Update - Modified the Atomic custom component articles
This documentation section has been reorganized to be easier to use and its contents have been updated to cover new ways of leveraging the Coveo CLI when creating custom Atomic components.
See:
New - Created the "Upgrading from v1 to v2" Article
The article lists the breaking changes that are part of the Coveo Atomic v2 release and explains which adjustments to make to your projects, if applicable.
Update - Modified the "Atomic Usage Analytics" Article
The article was restructured and now includes more detailed information about click events and sending events externally.
See Usage Analytics.
New - Published the "Displaying Instant Results" Article
This article explains how to display instant results when a user hovers over a query suggestion.
See Displaying Instant Results.
New - Published the "Usage Analytics" Article
This article covers various Usage Analytics customizations in the context of Coveo Atomic, such as how to modify event metadata and how to anonymize metadata.
See Usage Analytics.
New - Published the "Sending Usage Analytics View Events" Article
This article explains how to send Coveo Usage Analytics view events in the context of an Atomic project.
See Sending Usage Analytics View Events.
New - Published the "Download your Atomic project via CLI" Article
This article explains how to download search page projects from the Coveo Administration Console using the Coveo CLI.
See Download your Atomic project via CLI.
New - Published the "Use a standalone search box" Article
This article explains how to create a standalone search box using the Coveo Atomic library.
See Use a standalone search box.
New - Published the "Atomic Code Samples" Article
This article provides a list of the available Coveo Atomic code samples.
See Code Samples.
New - Published the "Displaying Results" Articles
These articles provide instructions on how to manage the result section in your search interfaces.
See Displaying Results.
New - Published the "Implement Folding" Article
This article explains how to implement result folding in your search interfaces using the Atomic library.
See Implement Folding.
New - Published the "Use Atomic in a Vue project" Article
This article explains how to use the Atomic library in a Vue.js project.
Coveo Headless Library
Update - Modified the "Usage Analytics" section
The articles in this section have been reorganized to host new articles on Event Protocol, the new standard for sending analytics events to Coveo.
See Usage Analytics.
New - Created the "Configure SAML authentication with Headless" Article
This article explains how to configure SAML authentication in a search page built with the Headless library.
See Configure SAML authentication with Headless.
New - Created the "Upgrading from v1 to v2" Article
The article lists the breaking changes that are part of the Coveo Headless v2 release and explains which adjustments to make to your projects, if applicable.
Update - Modified the "Headless Usage Analytics" Article
The article was restructured and now includes more detailed information about click events and sending events externally.
See Usage Analytics.
New - Published the "Sending Usage Analytics View Events" Article
This article explains how to send Coveo Usage Analytics view events in the context of a Headless project.
See Sending Usage Analytics View Events.
New - Published the "Usage Analytics" Article
This article covers various Usage Analytics customizations in the context of Coveo Headless, such as how to modify event metadata and how to anonymize metadata.
See Usage Analytics.
New - Published the "Headless Code Samples" Article
This article provides a list of the available Coveo Headless code samples.
See Code Samples.
Coveo Quantic Library
Update - Modified the "QuanticDocumentSuggestion" Article
This article was updated to include a section detailing the different slots you can use when implementing your Document Suggestion interface.
See QuanticDocumentSuggestion.
New - Created the "Access Headless Through Quantic" Article
This article explains how to leverage the Headless library in Quantic components.
See Access Headless Through Quantic.
New - Created the "Safely Set the Search Hub Value" Article
This article explains how to safely enforce a search hub through search tokens when using the Coveo Quantic library.
See Safely Set the Search Hub Value.
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:
- Access the Create a new subscription panel by selecting Ctrl+N (Windows) or Command+N (Mac).
- In the Enter URL of RSS feed text box, type or paste
https://docs.coveo.com/en/feed.rss. - Click Subscribe.
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:
- Access the New Feed panel by clicking New above the Feeds panel.
- In the Create a feed by supplying the website or direct link text box, type or paste
https://docs.coveo.com/en/feed.rss. - Click Finish.
You’re now set up to automatically receive Coveo product documentation updates.
Very useful
Not really
Very useful
Not really