Coveo for Sitecore Management Reference (Cheat Sheet)

THIS IS ARCHIVED DOCUMENTATION

Coveo for Sitecore Management Reference (Cheat Sheet)

This is for:

Coveo for Sitecore introduces many new components and concepts to Sitecore. The following list is meant as a cheat sheet to quickly remind you where to configure these components. For each action, a documentation page is linked to give you more information if need be.

Indexing

Action	Location	Documentation	Additional information
Rebuilding a Coveo for Sitecore index	Sitecore Control Panel > Indexing > Indexing Manager	Coveo for Sitecore Indexing Guide	It's also possible to only index part of a tree.
Index and manage external sources (non Sitecore)	CES Administration Tool > Index > Sources and Collections Coveo Administration Console > Content > Sources	Configuring an External Source	The Coveo for Sitecore Free (On-Premises) edition doesn't allow the indexing and usage of external sources.

Search Page

Action	Location	Documentation	Additional information
Creating a basic standalone search page	Sitecore Content Editor > `[Your Sitecore item]` > right-click > Insert > Coveo-Powered Search Page For ASP.Net MVC: Coveo-Powered Search Page (MVC)	Inserting and Customizing a Search Interface Component	Enabled only for the `/sitecore/content` item or its children.
Adding a search interface to an existing item	Sitecore Content Editor > `[Your Sitecore item]` > Publish ribbon tab > Experience Editor > `[Your placeholder]`	Inserting Coveo Search Components to an Existing Item	We recommend that you achieve this in the `__Standard Values` item of a search page template.
Adding/Customizing facets to a search page	Sitecore Content Editor > `[Your search page item]` > Publish ribbon tab > Experience Editor > `coveo-facets` placeholder For ASP.Net MVC: `coveo-facets-mvc`	Inserting and Customizing a Facet Component
Adding/Customizing a sort component to a search page	Sitecore Content Editor > `[Your search page item]` > Publish ribbon tab > Experience Editor > `coveo-sorts` placeholder For ASP.Net MVC: `coveo-sorts-mvc`	Inserting and Customizing a Sort Component
Adding/Customizing a tab component to a search page	Sitecore Content Editor > `[Your search page item]` > Publish ribbon tab > Experience Editor > `coveo-tabs` placeholder For ASP.Net MVC: `coveo-tabs-mvc`	Inserting and Customizing a Tab Component
Adding/Customizing a recommendations/related query component in a search page	Sitecore Content Editor > `[Your search page item]` > Publish ribbon tab > Experience Editor > `coveo-recommendations` placeholder For ASP.Net MVC: `coveo-recommendations-mvc`	Recommendation: Inserting and Customizing a Recommendations Component Related Query: Inserting and Customizing a Related Query Component	The Recommendation component is only available to Enterprise Cloud edition users.
Adding/Customizing a user context component in a Sitecore item	Sitecore Content Editor > `[Your Sitecore item]` > Presentation ribbon tab > Details > `[Your device]` > Edit > Controls	Inserting and Customizing a User Context Component	We recommend that you achieve this in the `__Standard Values` item of templates.

Fields

Action	Location	Documentation	Additional information
Configuring Sitecore fields and computed index fields	`[SitecoreInstallationPath]\Website\App_Config\Include\Coveo\Coveo.SearchProvider.Custom.config`	Changing the Settings of Sitecore Fields
Creating or modifying non Sitecore fields	CES Administration Tool > Configuration > Fields > `[Your field set]` Coveo Administration Console > Content > Fields	Adding or Modifying Custom Fields Manage fields	Fields are grouped in fields sets (see What Are Field Sets?).
Mapping fields on external sources	CES Administration Console > Index > Sources and Collections > Fields Coveo Administration Console > Content > Sources > `[Your source]` > Edit > Mapping tab	Using External Content in Sitecore Facets	The source must be rebuilt in order for the new mappings to take effect.

Query Filtering

Action Location Documentation Additional information

Filtering search results on a search page

Action	Location	Documentation	Additional information
Filtering search results on a search page	Sitecore Content Editor > `[Your search page item]` > Publish ribbon tab > Experience Editor > `[Your Coveo Search component]` > Edit Properties > Results scope	Adding Boosting or Filtering Expressions	This feature is only available to Enterprise editions users. In can also be done on a tab component. For more information on filtering and boosting rules, see Rule Set Editor Boosting and Filtering Rules Reference
Filtering search results programmatically	For ASP.Net Web Forms: Your own copy of `[SitecoreInstallationPath]\Website\layout\Coveo\CoveoSearch.ascx` For ASP.Net MVC: Your own copy of `[SitecoreInstallationPath]\Website\Views\Coveo\SearchView.cshtml`	On a search component: Using Boosting or Filtering Rules on the Search Component Programmatically On a tab component: Using Boosting or Filtering Rules on the Tab Component Programmatically	It's not recommended to modify the out of the box Coveo for Sitecore files. You should duplicate the original file first. For more information, see Duplicating the Coveo Search Component
Displaying external sources on a search page	Sitecore Content Editor > `[Your search page item]` > Publish ribbon tab > Experience Editor > Coveo Search component > Edit Properties > External Content	Enabling the External Source in Sitecore	You must also ensure that your filter rules allow the external source to be displayed.

Sitecore Content Editor > [Your search page item] > Publish ribbon tab > Experience Editor > [Your Coveo Search component] > Edit Properties > Results scope

Adding Boosting or Filtering Expressions

This feature is only available to Enterprise editions users.

In can also be done on a tab component.

For more information on filtering and boosting rules, see Rule Set Editor Boosting and Filtering Rules Reference

Filtering search results programmatically

For ASP.Net Web Forms: Your own copy of [SitecoreInstallationPath]\Website\layout\Coveo\CoveoSearch.ascx

For ASP.Net MVC: Your own copy of [SitecoreInstallationPath]\Website\Views\Coveo\SearchView.cshtml

On a search component: Using Boosting or Filtering Rules on the Search Component Programmatically

On a tab component: Using Boosting or Filtering Rules on the Tab Component Programmatically

It's not recommended to modify the out of the box Coveo for Sitecore files. You should duplicate the original file first. For more information, see Duplicating the Coveo Search Component

Displaying external sources on a search page Sitecore Content Editor > [Your search page item] > Publish ribbon tab > Experience Editor > Coveo Search component > Edit Properties > External Content Enabling the External Source in Sitecore You must also ensure that your filter rules allow the external source to be displayed.

Relevancy Tools

Action	Location	Documentation	Additional information
Managing top results	Sitecore Content Editor > `/sitecore/system/Modules/Coveo/Top Results`	Managing Top Result Items in Sitecore	This is its default location. To learn how to change its location, see Configuring the Top Results Folder. Alternatively, it's possible to manage Top Results through the CES Administration Tool. for more information, see Managing Top Results in a CES Index. If you want to do so, you must synchronize CES Top Results with Sitecore (see Synchronizing Top Results Manually
Adding thesaurus entries	CES Administration Tool > Index > Thesaurus	Adding Thesaurus Entries From the Administration Tool
Filtering/Boosting search results on a search page	Sitecore Content Editor > `[Your search page item]` > Publish ribbon tab > Experience Editor > `[Your Coveo Search component]` > Edit Properties > Results scope	Adding Boosting or Filtering Expressions	This feature is only available to Enterprise editions users. In can also be done on a tab component. For more information on filtering and boosting rules, see Rule Set Editor Boosting and Filtering Rules Reference.
Filtering/Boosting search results programmatically	For ASP.Net Web Forms: Your own copy of `[SitecoreInstallationPath]\Website\layout\Coveo\CoveoSearch.ascx` For ASP.Net MVC: Your own copy of `[SitecoreInstallationPath]\Website\Views\Coveo\SearchView.cshtml`	On a search component: Using Boosting or Filtering Rules on the Search Component Programmatically On a tab component: Using Boosting or Filtering Rules on the Tab Component Programmatically	It's not recommended to modify the out of the box Coveo for Sitecore files. You should duplicate the original file first. For more information, see Duplicating the Coveo Search Component.
Automatically boosting results based on Sitecore Profiles and Pattern Cards	Sitecore Content Editor > `[Your search page item]` > Publish ribbon tab > Experience Editor > `[Your Coveo Search component]` > Edit Properties > Results scope > Enable Automatic Boosting	Using Automatic Boosting	Your Sitecore license must allow Profiles and Pattern Cards. This feature is only available to Coveo for Sitecore Enterprise and Enterprise Cloud users.

Action	Location	Documentation	Additional information
Adding/Editing pipelines	Coveo Administration Console > Search > Pipelines	Managing Query Pipelines
Managing Featured Results	Coveo Administration Console > Search > Pipelines > `[pipeline]` > Edit > Featured Results	Managing Query Pipeline Featured Results
Configuring a Coveo Machine Learning model	Coveo Administration Console > Search > Pipelines > `[pipeline]` > Edit > Machine Learning	Get Started With Coveo Machine Learning
Adding Thesaurus Entries	Coveo Administration Console > Search > Pipelines > `[pipeline]` > Edit > Thesaurus	Managing Query Pipeline Thesaurus	While it's possible to statically add thesaurus entries, it's usually recommended to let Coveo Machine Learning adapt on its own. To learn how to accelerate the Machine Learning training process, see Training ART Models by Linking Queries to Results .
Boosting search results on a search page	Sitecore Content Editor > `[Your search page item]` > Publish ribbon tab > Experience Editor > `[Your Coveo Search component]` > Edit Properties > Results scope	Adding Boosting or Filtering Expressions	This feature is only available to Enterprise editions users. In can also be done on a tab component. For more information on filtering and boosting rules, see Rule Set Editor Boosting and Filtering Rules Reference.
Boosting search results programmatically	For ASP.Net Web Forms: Your own copy of `[SitecoreInstallationPath]\Website\layout\Coveo\CoveoSearch.ascx` For ASP.Net MVC: Your own copy of `[SitecoreInstallationPath]\Website\Views\Coveo\SearchView.cshtml`	On a search component: Using Boosting or Filtering Rules on the Search Component Programmatically On a tab component: Using Boosting or Filtering Rules on the Tab Component Programmatically	It's not recommended to modify the out of the box Coveo for Sitecore files. You should duplicate the original file first. For more information, see Duplicating the Coveo Search Component.
Automatically Boost Results Based on Sitecore Profiles and Pattern Cards	Sitecore Content Editor > `[Your search page item]` > Publish ribbon tab > Experience Editor > `[Your Coveo Search component]` > Edit Properties > Results scope > Enable Automatic Boosting	Using Automatic Boosting	Your Sitecore license must allow Profiles and Pattern Cards. This feature is only available to Coveo for Sitecore Enterprise and Enterprise Cloud users.

Usage Analytics

Action	Location	Documentation	Additional information
Coveo Analytics
Viewing the Analytics Events	Coveo Administration Console > Analytics > Reports	Usage analytics reports	The Analytics are available from your Coveo organization whether you use Coveo for Sitecore Cloud or On-Premises.
Logging View Events (for Recommendations and User Context)	Sitecore Content Editor > `[Your Sitecore item]` > Presentation ribbon tab > Details > `[Your device]` > Edit > Controls	Logging View Events	This is especially used for the Recommendations and the User Context components.
Adding custom metadata	Sitecore Content Editor > `[Your search page item]` > Publish ribbon tab > Experience Editor > `[Your Coveo Search component]` > Edit Properties > Analytics	Adding custom usage analytics metadata in Coveo for Sitecore
Sending Custom Analytics and Metadata Programmatically	For ASP.Net Web Forms: Your own copy of `[SitecoreInstallationPath]\Website\layout\Coveo\CoveoSearch.ascx` For ASP.Net MVC: Your own copy of `[SitecoreInstallationPath]\Website\Views\Coveo\SearchView.cshtml`	Send your own UA events	It's not recommended to modify the out of the box Coveo for Sitecore files. You should duplicate the original file first. For more information, see Duplicating the Coveo Search Component.
Sitecore Analytics
Enabling Sitecore Analytics	Sitecore Content Editor > `[Your search page item]` > Publish ribbon tab > Experience Editor > `[Your Coveo Search component]` > Edit Properties > Analytics	Configuring the Analytics Feature
Sending Custom Events to Sitecore Analytics	Sitecore Content Editor > `/sitecore/System/Settings/Analytics/Page Events`	Recording Custom Events with Sitecore Analytics	When adding a custom event, you must also add custom code to have the event sent to Sitecore Analytics.