The Coveo Configuration files
The Coveo Configuration files
Similar to Sitecore, the Coveo Search Provider is highly configurable and has many different configuration files. This page explains the roles of the different Coveo configuration files.
Locating and Identifying the Configuration Files
The Coveo for Sitecore configuration files are located with the other Sitecore configuration files under
<SITECORE_INSTANCE_ROOT>\Website\App_Config\Include. Depending on your Sitecore version, the Coveo configuration is located in one to three folders:
The Coveo for Sitecore configuration files are located in
Coveo folders with the other Sitecore configuration files. The
Coveo folders are located under:
To avoid issues and unexpected behavior, you should refrain from moving the Coveo for Sitecore configuration files from their intended location.
Coveo folder(s) can be found on all Sitecore versions. The files therein store the configurations of the Coveo Search Provider and of the different search components and the Coveo for Sitecore UI.
Coveo folder(s), you can find:
Coveo.CloudPlatformClient.config: contains configuration of the module responsible for interacting with the Coveo Platform.
Coveo.CloudPlatformClient.Custom.config: contains custom configuration of the module responsible for interacting with the Coveo Platform.
Coveo.SearchProvider.config: contains the Coveo indexes definitions and the default configuration of the Coveo Search Provider. No modification should be done to this file (see Understanding the Coveo Search Provider Configuration File).
Coveo.SearchProvider.Custom.config: contains the custom configuration of the Coveo Search Provider and pipeline examples. This file is meant to be modified.
Coveo for Sitecore 4.1 (September 2018)
Coveo.SearchProvider.Fields.Custom.config: contains the list of include fields. This file is automatically generated when using the PATCH or PUT
fieldsservices for the first time. No modification should be done to this file directly.
Coveo.SearchProvider.Licensing.config: contains the different commands used to open Coveo wizards.
Coveo.SearchProvider.Rest.config: contains the configuration of the REST endpoint used to query the Coveo index. It also includes configurations related to search results handling. No modification should be done to this file (see Understanding the REST Endpoint Configuration Files).
Coveo.SearchProvider.Rest.Custom.config: contains the custom configuration of the REST endpoint and pipeline examples. This file is meant to be modified.
Coveo.UI.Controls.config: this file is responsible for the configuration related to the integration of Coveo JS Framework in the Sitecore page editor.
SwitchMasterToWeb.Coveo.config.example: useful when configuring Sitecore in a CM/CD configuration. Activate only on CD instances.
This folder contains a single configuration file:
Coveo.Analytics.xDB.config, which defines the Coveo components related to Sitecore xDB. It can be found on instances of Sitecore 7.5+.
This folder also contains a single configuration file:
Coveo.ExperienceProfile.config, which defines the Coveo for Sitecore processors to report Coveo-powered search page events to Sitecore xDB. It can be found on instances of Sitecore 7.5+.
Configuration File Types
Most Coveo configuration files are split into two categories:
.config files contain the default configurations of Coveo for Sitecore, while the
.Custom.config files contain configuration examples and the configurations generated by Coveo UIs (e.g., the post installation wizard). Because the Sitecore wizard treats
.config files in alphabetical order, the configurations in the
.Custom.config files take priority over the
.config files. If you need to modify your configurations, you’re therefore encouraged to do so in the
.Custom.config files; otherwise, you may encounter unexpected bugs during updates.
We recommend the use of patching to configure the Coveo Search Provider. This practice makes Coveo for Sitecore updates easier and eases debugging.