Add or Edit a Push Source

You may want to make searchable some content of a type for which a specific connector is not yet available. In such a case, administrators and content managers 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 Cloud 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

  1. If not already in the Add/Edit a Push Source panel, go to the panel:

    • To add a source, in the main menu, under Content, select Sources > Add Source button > Push.

      OR

    • To edit a source, in the main menu, under Content, select Sources > source row > Edit in the Action bar.

  2. In the Configuration tab, enter appropriate values for the available parameters:

    • Source name

      A descriptive name for the content of your source under 255 characters (not already in use for another source in this organization).

      In-house CRM

      A developer coding a crawler to push content in this source 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 Adding and Managing Items and Permissions in a Push Source). The URL has the following form:

      https://push.cloud.coveo.com/v1/organizations/<organizationID>/sources/<sourceID>/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 Push source (see Push API to test API calls).

    • Character optical recognition (OCR)

      Check this box if you want Coveo Cloud to extract text from image files and/or PDF files containing images (see Enable Optical Character Recognition). OCR-extracted text is processed as item data, meaning that it is fully searchable and will appear in the item Quick View (see Search Result Quick View).

      Since the OCR feature is available at an extra charge, you must first contact Coveo Sales to add this feature to your organization license. You can then enable it for your source.

    • 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 Multiple Coveo Indexes). If your organization only has one index, this drop-down menu is not 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 Privilege Management and Logical Indexes Domain).

      • Once the source is added, you cannot switch to a different index.

    • Content security

      Select who can see items from this source in a search interface that includes this source in its scope (see Content Security). Your options are:

      • Shared: Everyone will be able to find the source content in the search interface.

      • Private: Only the source creator will be able to find the source content in the search interface. They must however authenticate to the search interface with the identity with which they created the source.

      • Secured: Only users authenticated in the search interface will see the source items for which they have read permission.

        In this case, your crawler process must push item permissions along with the content (see Managing Security Identities in a Security Identity Provider).

    • API key

      Available only when you create the source, it is recommended to select the Create an API key check box to easily get an API key with appropriate privileges to authorize a process to send information to the source.

  3. In the Access tab, determine whether each group and API key can view or edit the source configuration (see Understanding 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.

    If you remove the Edit access level from all the groups of which you are a member, you will not be able to edit the source again after saving. Only administrators and members of other groups that have Edit access on this resource will be able to do so. To keep your ability to edit this resource, you must grant the Edit access level to at least one of your groups.

  4. Optionally, consider editing or adding mappings (see Adding and Managing Source Mappings).

    You can only manage mapping rules once you build the source (see Refresh, Rescan, or Rebuild Sources).

  5. Click Add Source/Save when you want to save your source configuration.

  6. If you selected the Create an API key check box:

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

      The Your Key dialog box 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 (see Disable/Enable an API Key or Delete an API Key).

      An API key is an alphanumeric string that looks like the following:

      xx7fdcf07a-85af-446f-8992-6cd2d5ecc53c

      The key appears on the administration console API Access page and its name is your source name followed by API key.

    2. Paste the API key value with the source name to a safe location of your choice so you can later securely communicate this information to the person who manages the crawling process.

  7. Click Add Source/Save when you want to add/save your Push source configuration.