THIS IS ARCHIVED DOCUMENTATION

Install the Adobe Experience Manager Connector Package

This is for:

Developer System Administrator
Warning

Coveo ended support for the Coveo Adobe Experience Manager Connector package in February 2023. This package should no longer be used.

For recipes on how to index Adobe Experience Manager content and add search interfaces in your AEM websites, see Coveo for Adobe.

This article provides a step-by-step procedure to install the Coveo Adobe Experience Manager Connector package.

Prerequisites

To be able to index your Adobe Experience Manager content in a Coveo index, you must have:

  • A Coveo organization

    If you don’t already have a Coveo organization, you can start a free trial.

    Note the Organization ID as you’ll need it to configure the Coveo Adobe Experience Manager Connector.

    Tip
    Leading practice

    You can get the Organization ID from the URL while in your Coveo organization.

    Getting your organization ID from your Coveo organization URL | Coveo

  • An API key

    If you haven’t already done so, create your API key now.

    To create the API key

    1. Open the API Keys (platform-ca | platform-eu | platform-au) page in your Coveo organization.

    2. Click Add key in the upper-right corner of the screen.

    3. In the Add an API key panel, provide a name in the Key name field.

    4. In the Privileges tab, in the Content privileges domain, for the Fields privilege, set the Access Level to Edit.

    5. In the Content privileges domain, for the Sources privilege, set the Access Level to Edit all and ensure Can Create is selected.

      API key sources privileges to set

    6. In the Organization privileges domain, for the Organization privilege, set the Access Level to View.

    7. Click Add key at the bottom-right of the panel.

    8. Note the API key as it will be required when configuring the Coveo Adobe Experience Manager Connector.

      Note

      The API key will be used by the Coveo Adobe Experience Manager Connector to create a source in your Coveo organization and to push your Adobe Experience Manager documents to that source.

Coveo Adobe Experience Manager Connector Installation

The Coveo Adobe Experience Manager Connector must be installed on both the author instance and the publish instance you want to index.

Important

You install the package on the author instance only for the creation of the indexing workflows. After the workflows have been created and replicated, you uninstall and delete the package from the author instance.

To install the Coveo Adobe Experience Manager Connector

  1. Request version 3.0.0 of the Coveo Adobe Experience Manager Connector package.

  2. In the authoring instance, in the Adobe Experience Manager CRX Package Manager, upload and install the coveo-connector-content-<VERSION>.zip package.

    Note

    Version numbers in the CRX Package Manager screenshots below and the actual connector release version may differ.
    Uploading the Coveo package in the Package Manager
    Installing the Coveo package in the Package Manager

  3. Repeat the process to install the package on the publish instance you want to index.

    Important

    Only install the connector on one publish instance (that is, the publish instance you want to index).
    Note

    Installing the Coveo Adobe Experience Manager Connector package creates the coveo-user service user in Adobe Experience Manager. The Coveo Adobe Experience Manager Connector uses coveo-user to access the JCR programmatically and retrieve the content to be indexed.

What’s Next?

Configure the connector.