Configure an xConnect Client endpoint

Abstract

How to configure an xConnect client endpoint for a Data Exchange Framework tenant.

In order to make a connection between a tenant and xConnect, you must specify a collection model and collection service in an xConnect endpoint.

To configure an xConnect Client endpoint:

  1. In the Content Editor, navigate to your tenant.

  2. In the tenant folder structure, navigate to Endpoints/Providers/xConnect/xConnect Client Endpoint.

  3. On the Content tab, in the Collection Service section, in the Collection Model field, select the appropriate value for your Collection Model. This setting determines which data Sitecore retrieves from xConnect.

    Collection service dialog box
  4. In the Collection Service section, enter values for the following fields:

    • Collection Service Connection String Name

    • Collection Service Certificate Connection String Name

    • Collection Service Credentials Connection String Name

    You can find all of these values as connection string names in the  ConnectionStrings.config file on your Sitecore server.

    Note

    For XP0 single deployments you can select the Use Collection Service For All Services check box. For XP1 scaled deployments you must use different connection strings for each service.

    The following table describes the fields in the Collection Service section:

    Field name 

    When  required 

    Description

    Collection Service Connection String Name

    Always required

    • Connection string that identifies the xConnect collection service.

    • By default the value is xconnect.collection.

    Collection Service Certificate Connection String Name

    Required if SSL is enabled on the xConnect server.

    • Connection string that identifies the certificate to use when establishing a secure connection to the xConnect server.

    • By default the value is xconnect.collection.certificate.

    Collection Service Credentials Connection String Name

    Required if authentication is enabled on the xConnect server.

    • Connection string that specifies the credentials to use to connect to an xConnect server with authentication enabled.

    • Authentication is not enabled on the xConnect server by default.

  5. If your xConnect server is using a self-signed certificate for SSL, select the Allow Invalid Certificates check box and save the item.

    Allow invalid certificates check box
  6. On the menu ribbon, click Run Troubleshooter. A message indicates if a connection can be established to your xConnect server. Click OK to close the message.