Install and configure the Experience Edge Connector

Abstract

Describes how to install and configure the Experience Edge Connector module.

This topic shows how you install and do basic post-installation configuration of the Experience Edge Connector module. There are the following prerequisites for installing and using this module:

  • Sitecore Experience Management 10.1, or later

  • An active Sitecore Experience Edge subscription

Note

You can also use SIF to install the module.

Install the Experience Edge Connector

To install the Sitecore Experience Edge connector:

  1. Go to the Sitecore Downloads page, and download the installation package for the Experience Edge Connector module.

  2. In the Sitecore Launchpad, open the Control Panel, and in the Administration section select Install a package.

  3. Follow the steps in the installation wizard.

  4. Before you close the wizard, select Restart the Sitecore Client and Restart the Sitecore Server.

Note

Do not connect more than one Sitecore instance to an Edge instance.

Configure the Experience Edge Connector

There are three things you need to configure before you can use the connector module:

  • The authorization credentials

  • The API endpoint

  • The Solr index

To configure the authorization credentials:

  1. In the Website root folder, open the App_Config\ConnectionStrings.config file.

  2. Add a new connection string with the name experienceedge.authority and set the value to the Experience Edge authorization credentials you have been provided with when you signed up:

    <add name="experienceedge.authority" connectionString="url=AUTHORITY_URL_HERE;client_id=CLIENT_ID_HERE;client_secret=CLIENT_SECRET_HERE;audience=AUDIENCE_HERE"/>

    Note

    Replace the placeholders (AUTHORITY_URL_HERE, and so on) with the correct values for your subscription.

To configure the Experience Edge API endpoint:

  • Create a patch file that specifies the value of the ExperienceEdge.DeliveryEndpoint configuration setting as the Experience Edge API endpoint you have been provided. The file you are patching is the App_Config\Modules\ExperienceEdgeConnector\ExperienceEdgeConnector.config file.

To configure the Experience Edge CDN URI:

  • Create a patch file that specifies the value of the ExperienceEdge.CDN.Uri configuration setting as the Experience Edge CDN URI you have been provided. The file you are patching is the App_Config\Modules\ExperienceEdgeConnector\ExperienceEdgeConnector.config file.

To configure the Experience Edge CDN media prefix:

  • Create a patch file that specifies the value of the ExperienceEdge.CDN.MediaPrefix configuration setting as the Experience Edge CDN media prefix you have been provided. The file you are patching is the App_Config\Modules\ExperienceEdgeConnector\ExperienceEdgeConnector.config file.

To configure the Solr index core the connector uses:

  • Create a patch file that specifies the core parameter value under the sitecore_experienceedge_index node as the same Solr core name used by the sitecore_master_index index. The file you are patching is the App_Config\Modules\ExperienceEdgeConnector\ ExperienceEdgeConnector.Search.Solr.Index.config file.