Add or Edit a Push Source

You may want to make searchable some content of a type for which a specific connector isn’t yet available. In such a case, members of the Administrators and Content Managers built-in groups can take advantage of the Coveo Push API to index this content in a Push source (see Push API).

You have valuable content in an on-premises content management system (CMS) developed in-house. One of your developers can create a crawler to get this content and push it to your Coveo organization.

Before you can push content to Coveo Cloud, you must create a Push type source to which the content will be sent.

Add or Edit a Push Source

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

“Configuration” Tab

In the Add/Edit a Push 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.

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.

Push 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:

  • US primary region: https://api.cloud.coveo.com/push/v1/organizations/<ORGANIZATION_ID>/sources/<SOURCE_ID>/documents

  • European primary region: https://api-eu.cloud.coveo.com/push/v1/organizations/<ORGANIZATION_ID>/sources/<SOURCE_ID>/documents

  • Australian primary region: https://api-au.cloud.coveo.com/push/v1/organizations/<ORGANIZATION_ID>/sources/<SOURCE_ID>/documents

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.

Character Optical Recognition (OCR)

Check this box if you want Coveo Cloud to extract text from image files or PDF files containing images. OCR-extracted text is processed as item data, meaning that it’s fully searchable and will appear in the item Quick View. See Enable Optical Character Recognition for details on this feature.

Index

When adding a source, if you have more than one logical (non-Elasticsearch) index in your organization, select the index in which the retrieved content will be stored (see Leverage Many Coveo Indexes). If your organization only has one index, this drop-down menu isn’t visible and you have no decision to make.

  • To add a source storing content in an index different than default, you need the View access level on the Logical Index domain (see Manage Privileges and Logical Indexes Domain).

  • Once the source is added, you can’t switch to a different index.

API Key

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

The Create an API key box 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.

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, determine whether each group and API key can view or edit the source configuration (see Resource Access):

  1. In the Access Level column, select View or Edit for each available group.

  2. On the left-hand side of the tab, if available, click Groups or API Keys to switch lists.

Completion

  1. Click Add Source/Save.

  2. If you’re creating a source and selected the Create an API key check box:

    1. In the Your API Key dialog that appears, click Copy to copy the API key value to the clipboard, and then click OK.

      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 by selecting only the View and Edit check boxes for the Sources privileges of the Content service (see Add an API Key). In this case, you should also disable or delete the original unused API key.

      The key appears on the Administration Console API Keys page and its name is your source name followed by API key.

    2. Paste the API key value and source name in a secure location, so that you may communicate this information to the person who manages the crawling process.

  3. Optionally, consider editing or adding mappings.

Recommended Articles