Skip to main content

Configure an endpoint

Abstract

How to configure endpoints for the Sitecore Connect for Microsoft Dynamics 365 for Sales connector

You use an endpoint to identify a data source to read from, or a data target to write to. Connect for Microsoft Dynamics 365 for Sales uses endpoints to represent Sitecore and a Microsoft Dynamics instance.

To set up a connection between Sitecore and Microsoft Dynamics you must configure the following endpoints:

To configure a Dynamics Organization endpoint:

  1. In the Content Editor, select your tenant, for example, My Dynamics Tenant.

  2. Navigate to Endpoints/Providers/Dynamics/Dynamics Organization Endpoint.

  3. In the Connection String Name field, enter the name of the connection string you added in Add a connection string.

    The settings dialog with the connection string name input field

    Note

    If you enter a connection string that is not defined on your Sitecore server, a validation error is displayed.

    The settings dialog with the connection string name input field showing a validation error
  4. Save the item and then, on the ribbon, click Run Troubleshooter.

    The Run Troubleshooter button on the menu ribbon
  5. A message indicates if a connection can be established to your Dynamics instance. Click OK to close the message.

To configure an xConnect Client endpoint:

  1. In the Content Editor, select your tenant.

  2. Navigate to Endpoints/Providers/xConnect/xConnect Client Endpoint.

  3. 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

    The collection service section with the connection string input fields

    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 Use Collection Service For All Services. 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.

  4. 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
  5. On the ribbon, click Run Troubleshooter. A message indicates if a connection can be established to your xConnect server. Click OK to close the message.

To configure a xDB Reference Data Client endpoint:

  1. In the Content Editor, select your tenant.

  2. Navigate to Endpoints/Providers/xConnect/xDB Reference Data Client Endpoint.

  3. In the Settings section, enter values for the following fields:

    • Client Connection String

    • Client Certificate Connection String Name

    xDB Reference Data Client Endpoint settings

    The following table describes the fields in the Settings section:

    Field name

    When required

    Description

    Client Connection String Name

    Always

    Identifies the xDB Reference Data Client settings.

    By default, the value is blank.

    Client Certificate Connection String Name

    If SSL is enabled on the xConnect server

    Identifies the certificate to use for a secure connection to the xDB Reference Data server.

    By default, the value is blank.

  4. If your xDB Reference Data Client server uses a self-signed certificate for SSL, select the Allow Invalid Certificates check box.

  5. Save the item.

  6. On the ribbon, select Run Troubleshooter. A message indicates if a connection to your xDB Reference Data Client server could be established. Click OK to close the message.

To configure a Staging Database endpoint:

  1. In the Content Editor, select your tenant.

  2. Navigate to Endpoints/Providers/SQL/Staging Database.

  3. In the Settings section, in the following fields, enter values that match the connection string for the staging database you added to the Sitecore server:

    • Connection String Name

    • Database Type

    The settings dialog with the connection string name input field
  4. On the ribbon, click Run Troubleshooter. A message indicates if a connection can be established to your staging database. Click OK to close the message.