Add or Edit a Catalog Source

A Coveo commerce catalog contains SKUs designed to be sold. Most catalogs will contain products, variants, stores or entitlement information. The catalog source is the recommended approach for most commerce catalogs. For Coveo for Salesforce business-to-business (B2B) Commerce, use the Salesforce source.

Take advantage of the Coveo Catalog to index content similar to a Push source (see Use the Push API).

Notes
  • Contact your sales representative to enable Coveo for Commerce features in your organization.

  • You can review your organization license limits in the Coveo Administration Console.

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.

Add or Edit a Catalog Source

When adding or editing a Catalog source, follow the instructions below.

"Configuration" Tab

In the Add/Edit a Catalog Source panel, the Configuration tab is selected by default. It contains your source’s general and authentication information, as well as other parameters.

General Information

Source Name

Enter a name for your source.

Tip
Leading practice

A source name can’t be modified once it’s saved, therefore be sure to use a short and descriptive name, using letters, numbers, hyphens (-), and underscores (_). Avoid spaces and other special characters.

When coding a crawler to push content in this source, a developer will need this name to get the corresponding sourceId.

Stream API URL

Available only when you edit the source, the input contains the URL you must use to add and update an item in your source (see Manage Items and Permissions in a Push Source). The URL has the following form:

https://api.cloud.coveo.com/push/v1/organizations/<ORGANIZATION_ID>/sources/<SOURCE_ID>/stream/open

The URL that you can Copy to clipboard contains your <ORGANIZATION_ID> and <SOURCE_ID>, which are required parameters for all operations regarding your source. See the Stream section in Push API to test API calls.

API Key

When you create the source, we recommend also creating an API key with appropriate privileges to authorize a process and send information to the source. This option is available at source creation only.

Note

This option isn’t visible if you don’t have the Edit API keys privilege.

"Content Security" Tab

Select who will be able to access the source items through a Coveo-powered search interface. For details on this parameter, see Content Security.

Note

If you select Determined by source permissions, your crawler process must push item permissions along with the content (see Manage Security Identities in a Security Identity Provider and Manage Items and Permissions in a Push Source).

"Access" Tab

In the Access tab, set whether each group and API key can view or edit the source configuration (see Resource Access):

  1. If available, in the left pane, click Groups or API Keys to select the appropriate list.

  2. In the Access Level column for groups or API keys with access to source content, select View or Edit.

Completion

Important

The Your API Key dialog appears only once and is the only place where you can see and copy the key value.

If you fail to copy (or lose) the key value, the workaround is to manually create a new API key. In the Privileges tab, under the Content service, for the Sources privileges, locate your source name. Then, select View from the drop-down list in the Access Level column. Furthermore, under the Organization service, for the Organization privileges, select View from the drop-down list in the Access Level column. In this case, you should also disable or delete the original unused API key.

What’s Next?

Now that you’ve created your Catalog source, go ahead and index some content. Proceed to Indexing Commerce Catalog Content.

What's next for me?