• More
  • Product news
  • Community
  • Support

  • Settings
  • Cookie preferences
  • Home
    • Coveo Platform
      • Implementation guide
      • Index content
      • Build a search UI
      • Tune relevance
      • Analyze usage data
      • Leverage machine learning
      • Manage an organization
      • Manage customer service solutions
      • Knowledge Hub
      • Coveo CLI
      • Coveo REST APIs
      • Searching with Coveo
    • Solutions and integrations
      • Coveo for Adobe
      • Coveo for Agentforce
      • Coveo for Commerce
      • Coveo for Contentful
      • Coveo for Genesys
      • Coveo for Optimizely
      • Coveo In-Product Experience (IPX)
      • Coveo for Salesforce
      • Coveo for ServiceNow
      • Coveo for Sitecore
      • Coveo for Zendesk
    • Security
    • Compliance
    • Services
    • Product entitlements
    • Coveo product news
    • Supported browsers
    • Glossary
    • Log in to Coveo for the first time
    • Design
    • Design (markdown)
  • Archived content
    • Coveo Enterprise Search 7.0
    • Connector API - CES 7.0
    • Converter API - CES 7.0
    • Coveo .NET Front-End 12.0 for Developers
    • Coveo Enterprise Search 6.5 (English)
    • Coveo Enterprise Search 6.5 (Français)
    • Coveo for Adobe
      • Overview
        • Supported Adobe Experience Manager versions and dependencies
        • Validate routes and ports
      • Adobe Experience Manager Connector
        • Install the Adobe Experience Manager Connector package
        • Configure the connector
        • Create workflow models
        • Trigger indexing
        • Adobe Experience Manager metadata mapping
        • Filtering
      • Hosted Search Page component
        • Create hosted search pages
        • Add the Coveo Hosted Search Page component
      • New features
      • Releases
        • Connector package release notes
          • June 15, 2022 release (3.0.0)
          • February 28, 2022 release (2.0.1)
          • September 24, 2021 release (1.10.10)
        • Hosted Search Page package release notes
          • April 26, 2021 Beta release
    • Coveo for Salesforce v1
    • Coveo for Sitecore v3
    • Coveo for Sitecore v4
      • What is Coveo for Sitecore?
        • What is new in Coveo for Sitecore 4
      • Deployment
        • Before you start
          • Project guide
          • Project checklist
          • Management cheat sheet
        • Installation
          • Architecture
          • Silently activating
            • Using PowerShell to configure and activate
          • Installing
          • Installing SXA components
          • Enabling Coveo analytics in Sitecore xConnect
          • Sitecore credential usage in Coveo for Sitecore
          • Organization provisioning
          • Sharing an organization between many environments
        • Scaling
          • Prepare the Sitecore content manager for a scaled environment
          • Deploying Coveo for Sitecore on the content delivery servers
            • Sitecore indexes not loading
            • Disabling the master database on Sitecore 9 CD servers
          • Validating connectivity of the new hosts
          • Leading practices when deploying
          • Assigning a farm name to resources
          • Deploying on additional content managers
          • High availability
        • Indexing
          • Excluding Sitecore items from your Coveo index
            • Changing the crawling root of an index
            • Specifying which templates to index
            • Creating a custom Coveo inbound filter
            • Using the ItemPathInboundFilter
          • Rebuilding a search index
          • Indexing strategies
          • Indexing item content for relevance
            • Understanding Sitecore, Coveo for Sitecore, and Coveo Fields
              • Specifying which fields to index
              • Changing the settings of Sitecore fields
                • Making facettable
                • Making sortable
                • Excluding from the search results
                • Making multi-value
                • Making free-text searchable
                • How to reset a field attribute using Coveo Cloud administration console
                • Managing fields for a specific index
            • Creating an HTML representation of page content
              • Indexing with the BasicHtmlContentInBodyProcessor
              • Indexing with the FetchPageContentProcessor
              • Indexing with the HTMLContentInBodyWithRequestsProcessor
                • Configuring form authentication
              • Avoiding search queries in page Quick view
              • Performing search queries when indexing
            • Understanding the title selection sequence
          • Understanding how the ClickableUri value is computed
          • Analyzing the rebuild process
          • How Coveo for Sitecore handles Sitecore access rights
          • Indexing performance leading practices
          • Managing Sitecore content in Coveo
          • Browsing through indexed fields
          • Advanced indexing customizations
            • Using pipelines
              • Understanding the indexing and search pipelines
                • Adding processors
                • Understanding the coveoIndexingGetFields and coveoIndexingGetTemplates pipelines
                • Excluding items without layouts from being indexed
                • Including fields using the Indexing Manager
              • Understanding the REST endpoint pipelines
                • Creating a processor for the getSearchUserIdentities pipeline
                • Understanding the AddActiveDirectoryIdentity pipeline processor
              • Understanding the analytics pipelines
              • Understanding the Coveo UI pipelines
              • Understanding the cloud platform client pipelines
              • Understanding the coveoItemProcessingPipeline pipeline
              • Understanding the coveoPostItemProcessingPipeline pipeline
              • Understanding the coveoBeforeUpdatingIndexFields pipeline
              • Understanding the coveoResolveItemSite pipeline
            • Creating computed fields
              • Creating for a referenced item
              • Creating a computed date field
              • Passing custom parameters
              • Using out of the box computed fields
              • Implementing and configuring a computed field in your index
            • Overview of field management in the Coveo.SearchProvider.config File
            • Use separate security identity providers per Sitecore index
            • Changing the name of sources created in the Coveo index
        • Search and relevance
          • Hive UI framework
            • Getting started tutorial
              • Hive versus legacy UI
              • Step 1: Branching the data sources
              • Step 2: Adding and previewing the search resources
              • Step 3: Adding basic controls
              • Step 4: Adding related controls
              • Step 5: Customizing result templates
              • Step 6: Changing the result layout
              • Inserting an Example Search Page
            • Hive search page structure
            • Rendering data source branch templates
            • Hive components reference
              • CoveoForSitecoreAnalytics
              • CoveoForSitecoreBindWithUserContext
              • CoveoForSitecoreContext
              • CoveoForSitecoreExpressions
              • CoveoForSitecoreExternalContent
              • CoveoForSitecoreFilterExpression
              • CoveoForSitecoreLocalExpression
              • CoveoForSitecoreRankingExpression
              • DistanceResources
              • GoogleApiPositionProvider
              • NavigatorPositionProvider
              • SendAnalyticsToSitecore
              • StaticPositionProvider
              • ValidateAnalyticsIncluded
            • Hive renderings list
            • Rule Set Editor boosting and filtering rules reference
            • Query and result suggestions
              • Query suggestions
              • Result suggestions
            • Hive examples
              • Creating and making use of a new result template
              • Editing the content of a result template
              • Creating a simple listing page
              • Applying filtering and ranking rules
              • Routing search queries to query pipelines
              • Inserting and configuring a global search box
              • Inserting and customizing a distance resources component
              • Configuring custom ranges for a date range or numeric range facet
              • Inserting custom components in an existing search interface
              • Integrate the search interface in an existing page
              • Translating fields to the Coveo format
              • Overriding Coveo for Sitecore Hive initialization options
              • Duplicating a component to modify its HTML
              • Creating a custom Hive component - multi-sort tutorial
                • Preparing the ground
                • Integrating the component
                • Adding one simple option
                • Adding other options
                • Translating fields
                • Validation, helpers, and debugging
            • Understanding prebinding helpers
              • Prebinding helpers list reference
            • Hive custom components reference
              • Integrating a custom component in sitecore using Coveo for Sitecore Hive framework
              • Reusing properties from another existing component
            • Using the CDN
            • Inserting custom CSS
            • Overriding the search friendly error message
          • Legacy search UI framework
            • Creating a basic search interface
            • Inserting and customizing a search interface component
            • Inserting Coveo search components to an existing item
            • Inserting and customizing a facet component
            • Inserting and customizing a sort component
            • Inserting and customizing a tab component
            • Inserting and customizing a related query component
            • Inserting and customizing a recommendations component
            • Inserting and customizing a user context component
            • Ranking and filtering rules
              • Using boosting or filtering rules on the search component programmatically
              • Using boosting or filtering rules on the tab component programmatically
              • Adding boosting or filtering expressions
            • Inserting and customizing a distance resources component
            • Creating a search driven page
            • Duplicating the Coveo search component
            • Inserting a Coveo search box to your header
            • Autocomplete and suggestions
              • Facet suggestions
              • Query suggestions
              • Result suggestions
            • Adding a field to a result template
            • Adding images to your search page
            • Customizing a search interface
              • Creating custom filtering rule conditions in Sitecore
                • Creating a custom rule condition
                • Integrating the custom rule condition in Sitecore
              • Using many layouts for Coveo components
              • Adding custom parameters
                • With the additional parameters field
                • By creating a new template
              • Customizing the result template
                • Changing the default
                • Displaying results differently according to the item template
              • Creating a hierarchical facet component
              • Performing aggregation operations on facet values
              • Jquery plugin
                • Binding custom event handlers
                • Setting custom initialization options
                • Setting up external sources programmatically
              • Link a Coveo tab component to other components
              • Using Sitecore items for a component properties
              • Adding a custom geolocation provider
            • List of available components
              • Search properties
              • Facet
                • Facet properties
                • Facet range properties
                • Facet slider properties
                • Facet date slider properties
                • Facet distance range properties
                • Facet distance slider properties
              • Sort
                • Date sort properties
                • Distance sort properties
                • Field sort properties
                • Relevancy sort properties
              • Tab properties
              • Searchbox properties
              • Omnibox result list properties
              • Recommendations properties
              • Related query properties
              • Coveo fields resources
              • Coveo distance resources properties
              • User context properties
            • List of available parameters
            • Relating Coveo for Sitecore components to sitecore templates, Layouts, and Sublayouts
            • Digging into the layouts and components code
              • Overview of SearchLayout.aspx
              • Overview of CoveoSearchResources.ascx
              • Overview of CoveoSearch.ascx
              • Overview of CoveoFacet.ascx
              • Overview of Coveo sort components code
              • Overview of CoveoTab.ascx
            • Creating a custom component parameters
            • Inserting custom component parameters
            • Creating a search interface optimized for mobile devices
            • Creating a search interface optimized for web crawlers
            • Understanding how MVC components work behind the scenes
            • Modifying or removing the Insert Option for the Coveo-powered search page
          • Using a query pipeline
          • Altering search results before they are displayed in a search interface
            • Removing fields from search results
            • Using the Sitecore LinkManager to resolve URIs in a search page
          • Displaying external content in a search interface
            • Configuring an external source
            • Enabling the external source in Sitecore
            • Displaying external content in a tab
            • Using external content in Sitecore facets
            • Adding external fields
            • Using Windows Authentication to query external sources
          • Using analytics
            • Coveo Usage Analytics
              • Adding custom usage analytics metadata in Coveo for Sitecore
              • Logging page view events
            • Sitecore Analytics
              • Configuring Coveo events in Sitecore Analytics
              • Changing the events data
              • Recording custom events
              • Tracking events into an external database
              • Querying page events in the Analytics database
              • Available page events
              • Sitecore page events logged by Coveo for Sitecore
              • Understanding the Experience Profile
              • Customize page events caption displayed in Experience Profile
              • Leveraging Sitecore Analytics in Coveo for Sitecore
                • Understanding profiles and pattern cards
                • Using automatic boosting
                • Using the Coveo conditional renderings
                • Using the Experience Explorer
          • Get started with Coveo Machine Learning
            • Getting recommendations
            • Leveraging user context
            • Using Automatic Relevance Tuning in Coveo for Sitecore
          • Using Sitecore personalization with Coveo
            • Implementing device detection in Sitecore
          • Query performance leading practices
          • Understanding how to leverage virtual users with Coveo
          • Using LINQ to customize queries
            • Coveo LINQ extensions
            • Supported LINQ operators
            • Optimizing LINQ query performance
            • Joining results using LINQ
              • The GroupJoin extension
              • The Join extension
              • The SelfJoin extension
            • Retrieving metadata in LINQ query results
            • Using QueryResults to retrieve query metadata
              • Example: Introduction
              • Example: Create a basic search page
              • Example: Adding a pager section
              • Example: Adding a did you mean section
              • Example: Adding facets
              • Example: Add a sorting section
              • Example: Debugging helpers
              • Example: Putting it all together
              • Advanced example: Bind the model to URL parameters
            • Supported Sitecore features
              • Global LINQ filters
              • Ignore index fields
              • Mapping targets
              • Predefined queries
        • Configuration
          • Coveo Control Panel administration access
            • Opening the Coveo Search Control Panel section
            • Synchronizing Coveo for Sitecore with the Coveo Platform
              • Synchronize Coveo for Sitecore configuration
              • Updating security cache
              • Synchronize Sitecore permissions
            • Cleaning up unused field resources
            • Configuring the Sitecore credentials
          • Managing your license
            • Understanding the license
            • Upgrading your license
            • Viewing the license details
            • Creating a Coveo Cloud group for developers and system integrators
              • Adding members to the group
            • Managing your cloud license
            • Configuring the query rate limit
          • Understanding the Command Center
            • Giving access to the Command Center
            • Activating Coveo for Sitecore using the Command Center
            • Updating Coveo for Sitecore settings
            • Understanding the Indexing Manager
            • Understanding the Relevance Manager
          • Accessing the Coveo for Sitecore API
          • The Coveo configuration files
            • Understanding the Coveo search provider configuration file
            • Understanding the REST endpoint configuration files
            • Changing the default Coveo for Sitecore REST endpoint proxy path
        • On-premises only topics
          • Administering RabbitMQ
            • Accessing the Management Console
            • Changing the location of RabbitMQ queues
            • Configuring the indexing queue connection
          • Securing the Admin Service
            • Configuring the Admin Service after install
          • Managing your CES license
          • Managing your CES index
          • Changing the REST Search API default port
          • How to load balance queries using CES mirror and Coveo for Sitecore
          • Installing Coveo Enterprise Search (CES)
          • Scaling out Coveo for Sitecore with CES mirrors
          • Setting up Coveo for Sitecore in a remote server configuration
          • Understanding and customizing the binary data indexing process
          • Understanding the Search API configuration file (config.yml)
          • Managing top results
            • Configuring the top results folder
            • Managing top result items in Sitecore
            • Synchronizing top results automatically
            • Synchronizing top results manually
            • Localizing top results
            • Troubleshooting top result issues
      • Upgrade and migration
        • Index hosting migration
          • Switch from on-premises to cloud indexes
          • Switch from cloud to on-premises indexes
        • Upgrade
          • Leading practices
          • Upgrading from Coveo for Sitecore 4.0 to Coveo for Sitecore 4.1
            • Installing Coveo for Sitecore 4.1
            • Upgrading configuration files from Coveo for Sitecore 4.0 to Coveo for Sitecore 4.1
            • Upgrading to Coveo for Sitecore Hive framework: FAQ
          • Upgrade procedures for Coveo for Sitecore 4.1 previous releases
            • August 2019 to March 2020
            • May 2019 to August 2019
            • February 2019 to May 2019
            • November 2018 to February 2019
            • October 2018 to November 2018
            • September 2018 to October 2018
            • August 2018 to September 2018
            • July 2018 to August 2018
            • May 2018 to July 2018
            • April 2018 to May 2018
            • March 2018 to April 2018
            • January 2018 to March 2018
            • December 2017 to January 2018
            • October 2017 to December 2017
            • September 2017 to October 2017
          • Upgrade procedures for Coveo for Sitecore 4.0 previous releases
            • May 2018 to August 2018
            • March 2018 to May 2018
            • December 2017 to March 2018
            • September 2017 to December 2017
            • July 2017 to September 2017
            • June 2017 to July 2017
            • April 2017 to June 2017
            • March 2017 to April 2017
            • January 2017 to March 2017
            • December 2016 to January 2017
            • October 2016 to December 2016
            • September 2016 to October 2016
            • July 2016 to September 2016
            • June 2016 to July 2016
            • April 2016 to June 2016
          • Upgrading Sitecore with Coveo for Sitecore
          • Upgrading to the expanded security provider
        • Coveo for Sitecore 4.1: Release Notes
          • March 2020
          • 2019 releases
          • 2018 releases
          • 2017 releases
        • Coveo for Sitecore 4.0: Release Notes
          • 2018 releases
          • 2017 releases
          • 2016 releases
      • Getting help and support
        • Embedded developer and support resources
          • Troubleshooting problems using the Coveo Diagnostic Page
        • Most common issues
          • Inactivity timeout during rebuild
          • Coveo sort components are stacked in an MVC search page
          • Security provider error something went wrong on the server
          • Problem accessing the Coveo Admin Service
          • Problem loading the Ninject assembly
          • Empty strings are not allowed exception occurring when specifying creator-owner permissions
          • Internal server error when querying the REST service
          • Editing the properties of a Coveo search MVC component freezes the page editor in ie11
          • Error with ID no\_DOCument\_indexed
          • Error or document not found page after rebuilding the indexes
          • Problem registering search page events in Sitecore Analytics
          • Sitecore items do not get automatically indexed
          • Sitecore 8.0 Session is not Initialized Exception
          • The Indexing Manager is reporting an error
          • Configuration wizard error - unable to add the certificate to the root store. Access is denied.
          • Slow queries in a Coveo-powered search page
          • Issue in ie during admin service configuration with the configuration wizard
          • High memory usage while rebuilding indexes
          • Root element of a crawler for a Coveo index is invalid
          • 404 errors on Coveo Usage Analytics search events
          • HTML version of indexed items are showing an error page
          • Coveo-powered search page fails to load after upgrade
          • Diagnostic Page error - invalid cast from system.String to Coveo.Framework.Configuration.SecurityConfiguration
          • Including a search box with omniboxResultList results in cannot read property addeventlistener of null error
          • Timeout while expanding Sitecore security provider
          • Nullreferenceexception on Tracking.Current when executing a request for a Quick view
          • Coveo for Sitecore security cache refresh issues
          • How to modify the Coveo for Sitecore security provider refreshing parameters
          • 403 forbidden error when calling yourSitecoresite/coveo/rest
          • Getting log4net errors when attempting to browse Sitecore pages
          • The Sitecore security provider ABC has encountered a fatal exception class CSP fatalexception unable to connect to Sitecore
          • No user has been provided for the search request
          • Opening Sitecore Indexing Manager returns a 405 (method not allowed) error
          • Secured admin service - could not establish trust relationship for the SSL/TLS secure channel with authority localhost
          • Hive components - Inserting an example search page results in no renderings
        • Known issues
          • An index should be configured for database web error is preventing the REST service from loading
          • Cannot insert the value null into column ID, table INSTANCE_HOSTNAME_Core.dbo.Properties column does not allow nulls. INSERT fails.
          • Coveo for Sitecore not properly replicating the sitecore permission model
          • Error in filewatcher internal buffer overflow while installing Coveo for Sitecore
          • Error exception while handling event Sitecore.ContentSearch.Events.IndexingFinishedEvent, index MY_INDEX was not found
          • Error in the Experience Profile after installing Coveo for Sitecore
          • Failed to reactivate the organization message in Command Center
          • Field is no longer indexed in the Sitecore items
          • Handler CoveoSearchEndpoint has a bad module ManagedPipelineHandler in its module list
          • Items in different languages are not automatically indexed or updated when language fallback is enabled
          • Metadata duplicated keys are producing warnings in the Log Browser
          • Missing valid xDB license
          • Multi-value field - migrating from on-premises to cloud version
          • Opening the Experience Explorer sets the static context to 'master'
          • Prebinding isn't applied to elements within a Searchbox container
          • Publishing multi-language Sitecore items leads to a large amount of files being indexed
          • Sitecore 8.0+ error when saving a Coveo-powered search page using the Sitecore Rule Engine
          • Sitecore 8.2 with WFFM refuses to start after installing Coveo for Sitecore
          • Sitecore.ContentSearch.SitecoreItemCrawler.IsAncestorOf(Item item) error
          • Slow initial rebuild time caused by the ExcludeCoveoDataSourceItems processor
          • Solr - error when initializing Coveo when side-by-side with solr is enabled
          • Solving the conflict between keys from dynamic placeholder modules and Coveo dynamic placeholders
          • The Experience Editor for non-default language page fails to load when using Coveo for Sitecore Hive
          • The RouteData must contain an item named 'controller' error with SXA
          • Two instances of the same search page component have been added on a page but only one is initialized
          • Unexpected token < when editing page with SXA components in Experience Editor
          • Send Analytics to Sitecore component not working in Sitecore 9
          • Exception when trying to switch organization
          • Issues when the core database is disabled on content delivery servers
          • Content database 'master' not found on a content delivery server
          • Coveo analytics events are not logged in Sitecore 9.1 analytics
          • Ajax error 500 when using special characters in a query
        • Troubleshooting guide
          • Analyzing HTTP traffic using Chrome developer tools
          • Tracing HTTP(S) communications issued by Sitecore
          • Cloud issues
          • On-premises issues
            • Checking if the ports used by Coveo for Sitecore are opened on the remote CES server
            • Troubleshooting a Coveo search REST endpoint error
        • SSL/TLS support
      • Releases
        • Supported Sitecore versions
          • Finding your Coveo for Sitecore version
          • Compatibility with Sitecore Commerce
          • Compatibility with Sitecore on Azure
            • Understanding infrastructure with the legacy Sitecore Azure module
            • Configuring with the legacy Sitecore Azure module
    • Coveo for Sitecore v5 (legacy)
      • Starting a new project
      • Known issues
        • Sitecore indexes not loading
        • Error in filewatcher internal buffer overflow while installing Coveo for Sitecore
        • Items in different languages are not automatically indexed or updated when language fallback is enabled
        • Missing valid xDB license
        • Sitecore 8.2 with WFFM refuses to start after installing Coveo for Sitecore
        • Compilation error in Diagnostic Page in Sitecore 8.0
        • Unhandled exception after installing Coveo for Sitecore on Sitecore 8.0 or 8.1 instance
      • Coveo for Sitecore JSS
        • Install Coveo for Sitecore JSS
        • Deploy Coveo for Sitecore JSS
        • Create hosted search pages
        • Available components
      • Miscellaneous legacy articles
        • Customize Experience Profile event captions
        • Certified developers
    • Gmail for Work source
      • Create a Google API console project and service account
      • Modify security parameters in your Google apps account
    • SharePoint Online legacy source
    • JavaScript Search Framework v0.9 (legacy)
    • Legacy api.developers.coveo.com site deprecation
    • On-premises REST Search API
      • Using the JavaScript Search Framework with the on-premises REST Search API
    • PhantomJS end-of-life
    • Search SOAP API - CES 7.0
    • Security Provider API - CES 7.0
    • Support knowledge base
    • About user stitching
    • Using an HTML archive
  • Home
    • Coveo Platform
      • Implementation guide
      • Index content
      • Build a search UI
      • Tune relevance
      • Analyze usage data
      • Leverage machine learning
      • Manage an organization
      • Manage customer service solutions
      • Knowledge Hub
      • Coveo CLI
      • Coveo REST APIs
      • Searching with Coveo
    • Solutions and integrations
      • Coveo for Adobe
      • Coveo for Agentforce
      • Coveo for Commerce
      • Coveo for Contentful
      • Coveo for Genesys
      • Coveo for Optimizely
      • Coveo In-Product Experience (IPX)
      • Coveo for Salesforce
      • Coveo for ServiceNow
      • Coveo for Sitecore
      • Coveo for Zendesk
    • Security
    • Compliance
    • Services
    • Product entitlements
    • Coveo product news
    • Supported browsers
    • Glossary
    • Log in to Coveo for the first time
    • Design
    • Design (markdown)
  • Archived content
    • Coveo Enterprise Search 7.0
    • Connector API - CES 7.0
    • Converter API - CES 7.0
    • Coveo .NET Front-End 12.0 for Developers
    • Coveo Enterprise Search 6.5 (English)
    • Coveo Enterprise Search 6.5 (Français)
    • Coveo for Adobe
      • Overview
        • Supported Adobe Experience Manager versions and dependencies
        • Validate routes and ports
      • Adobe Experience Manager Connector
        • Install the Adobe Experience Manager Connector package
        • Configure the connector
        • Create workflow models
        • Trigger indexing
        • Adobe Experience Manager metadata mapping
        • Filtering
      • Hosted Search Page component
        • Create hosted search pages
        • Add the Coveo Hosted Search Page component
      • New features
      • Releases
        • Connector package release notes
          • June 15, 2022 release (3.0.0)
          • February 28, 2022 release (2.0.1)
          • September 24, 2021 release (1.10.10)
        • Hosted Search Page package release notes
          • April 26, 2021 Beta release
    • Coveo for Salesforce v1
    • Coveo for Sitecore v3
    • Coveo for Sitecore v4
      • What is Coveo for Sitecore?
        • What is new in Coveo for Sitecore 4
      • Deployment
        • Before you start
          • Project guide
          • Project checklist
          • Management cheat sheet
        • Installation
          • Architecture
          • Silently activating
            • Using PowerShell to configure and activate
          • Installing
          • Installing SXA components
          • Enabling Coveo analytics in Sitecore xConnect
          • Sitecore credential usage in Coveo for Sitecore
          • Organization provisioning
          • Sharing an organization between many environments
        • Scaling
          • Prepare the Sitecore content manager for a scaled environment
          • Deploying Coveo for Sitecore on the content delivery servers
            • Sitecore indexes not loading
            • Disabling the master database on Sitecore 9 CD servers
          • Validating connectivity of the new hosts
          • Leading practices when deploying
          • Assigning a farm name to resources
          • Deploying on additional content managers
          • High availability
        • Indexing
          • Excluding Sitecore items from your Coveo index
            • Changing the crawling root of an index
            • Specifying which templates to index
            • Creating a custom Coveo inbound filter
            • Using the ItemPathInboundFilter
          • Rebuilding a search index
          • Indexing strategies
          • Indexing item content for relevance
            • Understanding Sitecore, Coveo for Sitecore, and Coveo Fields
              • Specifying which fields to index
              • Changing the settings of Sitecore fields
                • Making facettable
                • Making sortable
                • Excluding from the search results
                • Making multi-value
                • Making free-text searchable
                • How to reset a field attribute using Coveo Cloud administration console
                • Managing fields for a specific index
            • Creating an HTML representation of page content
              • Indexing with the BasicHtmlContentInBodyProcessor
              • Indexing with the FetchPageContentProcessor
              • Indexing with the HTMLContentInBodyWithRequestsProcessor
                • Configuring form authentication
              • Avoiding search queries in page Quick view
              • Performing search queries when indexing
            • Understanding the title selection sequence
          • Understanding how the ClickableUri value is computed
          • Analyzing the rebuild process
          • How Coveo for Sitecore handles Sitecore access rights
          • Indexing performance leading practices
          • Managing Sitecore content in Coveo
          • Browsing through indexed fields
          • Advanced indexing customizations
            • Using pipelines
              • Understanding the indexing and search pipelines
                • Adding processors
                • Understanding the coveoIndexingGetFields and coveoIndexingGetTemplates pipelines
                • Excluding items without layouts from being indexed
                • Including fields using the Indexing Manager
              • Understanding the REST endpoint pipelines
                • Creating a processor for the getSearchUserIdentities pipeline
                • Understanding the AddActiveDirectoryIdentity pipeline processor
              • Understanding the analytics pipelines
              • Understanding the Coveo UI pipelines
              • Understanding the cloud platform client pipelines
              • Understanding the coveoItemProcessingPipeline pipeline
              • Understanding the coveoPostItemProcessingPipeline pipeline
              • Understanding the coveoBeforeUpdatingIndexFields pipeline
              • Understanding the coveoResolveItemSite pipeline
            • Creating computed fields
              • Creating for a referenced item
              • Creating a computed date field
              • Passing custom parameters
              • Using out of the box computed fields
              • Implementing and configuring a computed field in your index
            • Overview of field management in the Coveo.SearchProvider.config File
            • Use separate security identity providers per Sitecore index
            • Changing the name of sources created in the Coveo index
        • Search and relevance
          • Hive UI framework
            • Getting started tutorial
              • Hive versus legacy UI
              • Step 1: Branching the data sources
              • Step 2: Adding and previewing the search resources
              • Step 3: Adding basic controls
              • Step 4: Adding related controls
              • Step 5: Customizing result templates
              • Step 6: Changing the result layout
              • Inserting an Example Search Page
            • Hive search page structure
            • Rendering data source branch templates
            • Hive components reference
              • CoveoForSitecoreAnalytics
              • CoveoForSitecoreBindWithUserContext
              • CoveoForSitecoreContext
              • CoveoForSitecoreExpressions
              • CoveoForSitecoreExternalContent
              • CoveoForSitecoreFilterExpression
              • CoveoForSitecoreLocalExpression
              • CoveoForSitecoreRankingExpression
              • DistanceResources
              • GoogleApiPositionProvider
              • NavigatorPositionProvider
              • SendAnalyticsToSitecore
              • StaticPositionProvider
              • ValidateAnalyticsIncluded
            • Hive renderings list
            • Rule Set Editor boosting and filtering rules reference
            • Query and result suggestions
              • Query suggestions
              • Result suggestions
            • Hive examples
              • Creating and making use of a new result template
              • Editing the content of a result template
              • Creating a simple listing page
              • Applying filtering and ranking rules
              • Routing search queries to query pipelines
              • Inserting and configuring a global search box
              • Inserting and customizing a distance resources component
              • Configuring custom ranges for a date range or numeric range facet
              • Inserting custom components in an existing search interface
              • Integrate the search interface in an existing page
              • Translating fields to the Coveo format
              • Overriding Coveo for Sitecore Hive initialization options
              • Duplicating a component to modify its HTML
              • Creating a custom Hive component - multi-sort tutorial
                • Preparing the ground
                • Integrating the component
                • Adding one simple option
                • Adding other options
                • Translating fields
                • Validation, helpers, and debugging
            • Understanding prebinding helpers
              • Prebinding helpers list reference
            • Hive custom components reference
              • Integrating a custom component in sitecore using Coveo for Sitecore Hive framework
              • Reusing properties from another existing component
            • Using the CDN
            • Inserting custom CSS
            • Overriding the search friendly error message
          • Legacy search UI framework
            • Creating a basic search interface
            • Inserting and customizing a search interface component
            • Inserting Coveo search components to an existing item
            • Inserting and customizing a facet component
            • Inserting and customizing a sort component
            • Inserting and customizing a tab component
            • Inserting and customizing a related query component
            • Inserting and customizing a recommendations component
            • Inserting and customizing a user context component
            • Ranking and filtering rules
              • Using boosting or filtering rules on the search component programmatically
              • Using boosting or filtering rules on the tab component programmatically
              • Adding boosting or filtering expressions
            • Inserting and customizing a distance resources component
            • Creating a search driven page
            • Duplicating the Coveo search component
            • Inserting a Coveo search box to your header
            • Autocomplete and suggestions
              • Facet suggestions
              • Query suggestions
              • Result suggestions
            • Adding a field to a result template
            • Adding images to your search page
            • Customizing a search interface
              • Creating custom filtering rule conditions in Sitecore
                • Creating a custom rule condition
                • Integrating the custom rule condition in Sitecore
              • Using many layouts for Coveo components
              • Adding custom parameters
                • With the additional parameters field
                • By creating a new template
              • Customizing the result template
                • Changing the default
                • Displaying results differently according to the item template
              • Creating a hierarchical facet component
              • Performing aggregation operations on facet values
              • Jquery plugin
                • Binding custom event handlers
                • Setting custom initialization options
                • Setting up external sources programmatically
              • Link a Coveo tab component to other components
              • Using Sitecore items for a component properties
              • Adding a custom geolocation provider
            • List of available components
              • Search properties
              • Facet
                • Facet properties
                • Facet range properties
                • Facet slider properties
                • Facet date slider properties
                • Facet distance range properties
                • Facet distance slider properties
              • Sort
                • Date sort properties
                • Distance sort properties
                • Field sort properties
                • Relevancy sort properties
              • Tab properties
              • Searchbox properties
              • Omnibox result list properties
              • Recommendations properties
              • Related query properties
              • Coveo fields resources
              • Coveo distance resources properties
              • User context properties
            • List of available parameters
            • Relating Coveo for Sitecore components to sitecore templates, Layouts, and Sublayouts
            • Digging into the layouts and components code
              • Overview of SearchLayout.aspx
              • Overview of CoveoSearchResources.ascx
              • Overview of CoveoSearch.ascx
              • Overview of CoveoFacet.ascx
              • Overview of Coveo sort components code
              • Overview of CoveoTab.ascx
            • Creating a custom component parameters
            • Inserting custom component parameters
            • Creating a search interface optimized for mobile devices
            • Creating a search interface optimized for web crawlers
            • Understanding how MVC components work behind the scenes
            • Modifying or removing the Insert Option for the Coveo-powered search page
          • Using a query pipeline
          • Altering search results before they are displayed in a search interface
            • Removing fields from search results
            • Using the Sitecore LinkManager to resolve URIs in a search page
          • Displaying external content in a search interface
            • Configuring an external source
            • Enabling the external source in Sitecore
            • Displaying external content in a tab
            • Using external content in Sitecore facets
            • Adding external fields
            • Using Windows Authentication to query external sources
          • Using analytics
            • Coveo Usage Analytics
              • Adding custom usage analytics metadata in Coveo for Sitecore
              • Logging page view events
            • Sitecore Analytics
              • Configuring Coveo events in Sitecore Analytics
              • Changing the events data
              • Recording custom events
              • Tracking events into an external database
              • Querying page events in the Analytics database
              • Available page events
              • Sitecore page events logged by Coveo for Sitecore
              • Understanding the Experience Profile
              • Customize page events caption displayed in Experience Profile
              • Leveraging Sitecore Analytics in Coveo for Sitecore
                • Understanding profiles and pattern cards
                • Using automatic boosting
                • Using the Coveo conditional renderings
                • Using the Experience Explorer
          • Get started with Coveo Machine Learning
            • Getting recommendations
            • Leveraging user context
            • Using Automatic Relevance Tuning in Coveo for Sitecore
          • Using Sitecore personalization with Coveo
            • Implementing device detection in Sitecore
          • Query performance leading practices
          • Understanding how to leverage virtual users with Coveo
          • Using LINQ to customize queries
            • Coveo LINQ extensions
            • Supported LINQ operators
            • Optimizing LINQ query performance
            • Joining results using LINQ
              • The GroupJoin extension
              • The Join extension
              • The SelfJoin extension
            • Retrieving metadata in LINQ query results
            • Using QueryResults to retrieve query metadata
              • Example: Introduction
              • Example: Create a basic search page
              • Example: Adding a pager section
              • Example: Adding a did you mean section
              • Example: Adding facets
              • Example: Add a sorting section
              • Example: Debugging helpers
              • Example: Putting it all together
              • Advanced example: Bind the model to URL parameters
            • Supported Sitecore features
              • Global LINQ filters
              • Ignore index fields
              • Mapping targets
              • Predefined queries
        • Configuration
          • Coveo Control Panel administration access
            • Opening the Coveo Search Control Panel section
            • Synchronizing Coveo for Sitecore with the Coveo Platform
              • Synchronize Coveo for Sitecore configuration
              • Updating security cache
              • Synchronize Sitecore permissions
            • Cleaning up unused field resources
            • Configuring the Sitecore credentials
          • Managing your license
            • Understanding the license
            • Upgrading your license
            • Viewing the license details
            • Creating a Coveo Cloud group for developers and system integrators
              • Adding members to the group
            • Managing your cloud license
            • Configuring the query rate limit
          • Understanding the Command Center
            • Giving access to the Command Center
            • Activating Coveo for Sitecore using the Command Center
            • Updating Coveo for Sitecore settings
            • Understanding the Indexing Manager
            • Understanding the Relevance Manager
          • Accessing the Coveo for Sitecore API
          • The Coveo configuration files
            • Understanding the Coveo search provider configuration file
            • Understanding the REST endpoint configuration files
            • Changing the default Coveo for Sitecore REST endpoint proxy path
        • On-premises only topics
          • Administering RabbitMQ
            • Accessing the Management Console
            • Changing the location of RabbitMQ queues
            • Configuring the indexing queue connection
          • Securing the Admin Service
            • Configuring the Admin Service after install
          • Managing your CES license
          • Managing your CES index
          • Changing the REST Search API default port
          • How to load balance queries using CES mirror and Coveo for Sitecore
          • Installing Coveo Enterprise Search (CES)
          • Scaling out Coveo for Sitecore with CES mirrors
          • Setting up Coveo for Sitecore in a remote server configuration
          • Understanding and customizing the binary data indexing process
          • Understanding the Search API configuration file (config.yml)
          • Managing top results
            • Configuring the top results folder
            • Managing top result items in Sitecore
            • Synchronizing top results automatically
            • Synchronizing top results manually
            • Localizing top results
            • Troubleshooting top result issues
      • Upgrade and migration
        • Index hosting migration
          • Switch from on-premises to cloud indexes
          • Switch from cloud to on-premises indexes
        • Upgrade
          • Leading practices
          • Upgrading from Coveo for Sitecore 4.0 to Coveo for Sitecore 4.1
            • Installing Coveo for Sitecore 4.1
            • Upgrading configuration files from Coveo for Sitecore 4.0 to Coveo for Sitecore 4.1
            • Upgrading to Coveo for Sitecore Hive framework: FAQ
          • Upgrade procedures for Coveo for Sitecore 4.1 previous releases
            • August 2019 to March 2020
            • May 2019 to August 2019
            • February 2019 to May 2019
            • November 2018 to February 2019
            • October 2018 to November 2018
            • September 2018 to October 2018
            • August 2018 to September 2018
            • July 2018 to August 2018
            • May 2018 to July 2018
            • April 2018 to May 2018
            • March 2018 to April 2018
            • January 2018 to March 2018
            • December 2017 to January 2018
            • October 2017 to December 2017
            • September 2017 to October 2017
          • Upgrade procedures for Coveo for Sitecore 4.0 previous releases
            • May 2018 to August 2018
            • March 2018 to May 2018
            • December 2017 to March 2018
            • September 2017 to December 2017
            • July 2017 to September 2017
            • June 2017 to July 2017
            • April 2017 to June 2017
            • March 2017 to April 2017
            • January 2017 to March 2017
            • December 2016 to January 2017
            • October 2016 to December 2016
            • September 2016 to October 2016
            • July 2016 to September 2016
            • June 2016 to July 2016
            • April 2016 to June 2016
          • Upgrading Sitecore with Coveo for Sitecore
          • Upgrading to the expanded security provider
        • Coveo for Sitecore 4.1: Release Notes
          • March 2020
          • 2019 releases
          • 2018 releases
          • 2017 releases
        • Coveo for Sitecore 4.0: Release Notes
          • 2018 releases
          • 2017 releases
          • 2016 releases
      • Getting help and support
        • Embedded developer and support resources
          • Troubleshooting problems using the Coveo Diagnostic Page
        • Most common issues
          • Inactivity timeout during rebuild
          • Coveo sort components are stacked in an MVC search page
          • Security provider error something went wrong on the server
          • Problem accessing the Coveo Admin Service
          • Problem loading the Ninject assembly
          • Empty strings are not allowed exception occurring when specifying creator-owner permissions
          • Internal server error when querying the REST service
          • Editing the properties of a Coveo search MVC component freezes the page editor in ie11
          • Error with ID no\_DOCument\_indexed
          • Error or document not found page after rebuilding the indexes
          • Problem registering search page events in Sitecore Analytics
          • Sitecore items do not get automatically indexed
          • Sitecore 8.0 Session is not Initialized Exception
          • The Indexing Manager is reporting an error
          • Configuration wizard error - unable to add the certificate to the root store. Access is denied.
          • Slow queries in a Coveo-powered search page
          • Issue in ie during admin service configuration with the configuration wizard
          • High memory usage while rebuilding indexes
          • Root element of a crawler for a Coveo index is invalid
          • 404 errors on Coveo Usage Analytics search events
          • HTML version of indexed items are showing an error page
          • Coveo-powered search page fails to load after upgrade
          • Diagnostic Page error - invalid cast from system.String to Coveo.Framework.Configuration.SecurityConfiguration
          • Including a search box with omniboxResultList results in cannot read property addeventlistener of null error
          • Timeout while expanding Sitecore security provider
          • Nullreferenceexception on Tracking.Current when executing a request for a Quick view
          • Coveo for Sitecore security cache refresh issues
          • How to modify the Coveo for Sitecore security provider refreshing parameters
          • 403 forbidden error when calling yourSitecoresite/coveo/rest
          • Getting log4net errors when attempting to browse Sitecore pages
          • The Sitecore security provider ABC has encountered a fatal exception class CSP fatalexception unable to connect to Sitecore
          • No user has been provided for the search request
          • Opening Sitecore Indexing Manager returns a 405 (method not allowed) error
          • Secured admin service - could not establish trust relationship for the SSL/TLS secure channel with authority localhost
          • Hive components - Inserting an example search page results in no renderings
        • Known issues
          • An index should be configured for database web error is preventing the REST service from loading
          • Cannot insert the value null into column ID, table INSTANCE_HOSTNAME_Core.dbo.Properties column does not allow nulls. INSERT fails.
          • Coveo for Sitecore not properly replicating the sitecore permission model
          • Error in filewatcher internal buffer overflow while installing Coveo for Sitecore
          • Error exception while handling event Sitecore.ContentSearch.Events.IndexingFinishedEvent, index MY_INDEX was not found
          • Error in the Experience Profile after installing Coveo for Sitecore
          • Failed to reactivate the organization message in Command Center
          • Field is no longer indexed in the Sitecore items
          • Handler CoveoSearchEndpoint has a bad module ManagedPipelineHandler in its module list
          • Items in different languages are not automatically indexed or updated when language fallback is enabled
          • Metadata duplicated keys are producing warnings in the Log Browser
          • Missing valid xDB license
          • Multi-value field - migrating from on-premises to cloud version
          • Opening the Experience Explorer sets the static context to 'master'
          • Prebinding isn't applied to elements within a Searchbox container
          • Publishing multi-language Sitecore items leads to a large amount of files being indexed
          • Sitecore 8.0+ error when saving a Coveo-powered search page using the Sitecore Rule Engine
          • Sitecore 8.2 with WFFM refuses to start after installing Coveo for Sitecore
          • Sitecore.ContentSearch.SitecoreItemCrawler.IsAncestorOf(Item item) error
          • Slow initial rebuild time caused by the ExcludeCoveoDataSourceItems processor
          • Solr - error when initializing Coveo when side-by-side with solr is enabled
          • Solving the conflict between keys from dynamic placeholder modules and Coveo dynamic placeholders
          • The Experience Editor for non-default language page fails to load when using Coveo for Sitecore Hive
          • The RouteData must contain an item named 'controller' error with SXA
          • Two instances of the same search page component have been added on a page but only one is initialized
          • Unexpected token < when editing page with SXA components in Experience Editor
          • Send Analytics to Sitecore component not working in Sitecore 9
          • Exception when trying to switch organization
          • Issues when the core database is disabled on content delivery servers
          • Content database 'master' not found on a content delivery server
          • Coveo analytics events are not logged in Sitecore 9.1 analytics
          • Ajax error 500 when using special characters in a query
        • Troubleshooting guide
          • Analyzing HTTP traffic using Chrome developer tools
          • Tracing HTTP(S) communications issued by Sitecore
          • Cloud issues
          • On-premises issues
            • Checking if the ports used by Coveo for Sitecore are opened on the remote CES server
            • Troubleshooting a Coveo search REST endpoint error
        • SSL/TLS support
      • Releases
        • Supported Sitecore versions
          • Finding your Coveo for Sitecore version
          • Compatibility with Sitecore Commerce
          • Compatibility with Sitecore on Azure
            • Understanding infrastructure with the legacy Sitecore Azure module
            • Configuring with the legacy Sitecore Azure module
    • Coveo for Sitecore v5 (legacy)
      • Starting a new project
      • Known issues
        • Sitecore indexes not loading
        • Error in filewatcher internal buffer overflow while installing Coveo for Sitecore
        • Items in different languages are not automatically indexed or updated when language fallback is enabled
        • Missing valid xDB license
        • Sitecore 8.2 with WFFM refuses to start after installing Coveo for Sitecore
        • Compilation error in Diagnostic Page in Sitecore 8.0
        • Unhandled exception after installing Coveo for Sitecore on Sitecore 8.0 or 8.1 instance
      • Coveo for Sitecore JSS
        • Install Coveo for Sitecore JSS
        • Deploy Coveo for Sitecore JSS
        • Create hosted search pages
        • Available components
      • Miscellaneous legacy articles
        • Customize Experience Profile event captions
        • Certified developers
    • Gmail for Work source
      • Create a Google API console project and service account
      • Modify security parameters in your Google apps account
    • SharePoint Online legacy source
    • JavaScript Search Framework v0.9 (legacy)
    • Legacy api.developers.coveo.com site deprecation
    • On-premises REST Search API
      • Using the JavaScript Search Framework with the on-premises REST Search API
    • PhantomJS end-of-life
    • Search SOAP API - CES 7.0
    • Security Provider API - CES 7.0
    • Support knowledge base
    • About user stitching
    • Using an HTML archive
THIS IS ARCHIVED DOCUMENTATION
   Coveo for Sitecore v4    Deployment    Search and relevance

Search and Relevance Guide

Search and Relevance Guide

This is for:

Developer System Administrator

With the index built and healthy, it’s now possible to start building a search and relevance solution in Sitecore.

In This Section

  • Hive UI framework
  • Legacy search UI framework
  • Using a query pipeline
  • Altering search results before they are displayed in a search interface
  • Displaying external content in a search interface
  • Using analytics
  • Get started with Coveo Machine Learning
  • Using Sitecore personalization with Coveo
  • Query performance leading practices
  • Understanding how to leverage virtual users with Coveo
  • Using LINQ to customize queries