Add a Sitecore source

This is for:

Developer System Administrator

A Sitecore source indexes content from a Sitecore XP or XM installation. The Coveo for Sitecore integration seamlessly creates Sitecore sources and uses the Push content retrieval method to index content from your Sitecore instance.

Important

Members with the required privileges may only edit Sitecore JSON source configurations in the Coveo Administration Console on rare occasions following Coveo Support indications.

Tip
Leading practice

The number of items that a source processes per hour (crawling speed) depends on various factors, such as network bandwidth and source configuration. See About crawling speed for information on what can impact crawling speed, as well as possible solutions.

Source key characteristics

The following table presents the main characteristics of a Sitecore source.

Features Supported Additional information

Sitecore XP and XM versions

9.1 to latest

Indexable content

  • Site items

  • Media library items

Content update operations

Index on save/publish

check

All content update operations are initiated within Sitecore.

Re-index tree

check

Rebuild

check

Content security options

Same users and groups as in your content system

check

Specific users and groups

check

Everyone

check

Metadata extraction

check

The Sitecore source automatically indexes default metadata.

The Command Center allows you to specify Sitecore template fields you want to index as custom metadata.

Prerequisites

Ensure that your license allows you to create this source and that your organization hasn’t reached its source quota. You can review your quotas on the License & Usage (platform-ca | platform-eu | platform-au) page, along with your usage.

Add a Sitecore source

Follow these steps to add a Sitecore source.

  1. Make sure that your organization meets the prerequisites before adding this source.

  2. Follow the Coveo for Sitecore Deployment guide to install the Coveo for Sitecore package in your Sitecore instance.

Sitecore sources are automatically created in your Coveo organization as you use Coveo for Sitecore. Typically, this includes two sources: one for content from the master database of your Sitecore instance and another for content from the web database.

Assign a source to a project

You can assign a Sitecore source to one or multiple projects using the Coveo Administration Console.

  1. On the Sources (platform-ca | platform-eu | platform-au) page, click your Sitecore source and then click Edit in the Action bar.

  2. On the Configuration tab, click the Project drop-down menu, and then select the desired projects.

  3. Click Save.

Required privileges

You can assign privileges to allow access to specific tools in the Coveo Administration Console. The following table indicates the privileges required to view or edit elements of the Sources (platform-ca | platform-eu | platform-au) page and associated panels. See Manage privileges and Privilege reference for more information.

Note

The Edit all privilege isn’t required to create sources. When granting privileges for the Sources domain, you can grant a group or API key the View all or Custom access level, instead of Edit all, and then select the Can create checkbox to allow users to create sources. See Can create ability dependence for more information.
Actions Service Domain Required access level

View sources, view source update schedules, and subscribe to source notifications

Content

Fields

View

Sources

Organization

Organization

Edit sources, edit source update schedules, and edit source mappings

Organization

Organization

View

Content

Fields

Edit

Sources

View and map metadata

Content

Source metadata

View

Fields

Organization

Organization

Content

Sources

Edit