Enable and configure the connector

 

Applies To: Dynamics Marketing

Important

Microsoft Dynamics Marketing has been discontinued and is no longer available. All customer data related to this product has been permanently deleted from all Microsoft servers and is no longer available for extraction. This documentation is being provided for historical purposes only.

This topic explains how to configure the Microsoft Dynamics Marketing Connector for Microsoft Dynamics 365 in Microsoft Dynamics Marketing.

In this topic

On-page link button Prerequisites

On-page link button** **Configure the connector in Dynamics Marketing

On-page link button Run a system health check

On-page link button** **Fine tune your sync settings

Spacing imageOn-page link button Enable lists for sync in both Dynamics Marketing and Dynamics 365

Spacing imageOn-page link button** **Adjust field mappings as needed

Prerequisites

Configure the connector in Dynamics Marketing

  1. Sign in to your Dynamics Marketing instance as administrator.

  2. Go to Settings > Administrator > Integration Options.

  3. In the Services, click the Enable Dynamics 365 Connector services button Run button. After you enable the Dynamics 365 Connector services, by default the services are set to Not running.

    Enable Connector in Dynamics Marketing

  4. Check the value shown in the Dynamics 365 / Dynamics CRM Endpoint section for the Mode field. It should match the mode of the Dynamics 365 instance you are connecting to (“Online” or “OnPremise”). If the wrong value is shown, click the toggle button Refresh button at the top of the Dynamics 365 / Dynamics CRM Endpoint section to change it. Note that choosing this button will rest your connection settings; you will be prompted to confirm the operation.

  5. If you are syncing with Dynamics 365 (on-premises), then do the following (if you are syncing with Dynamics 365 (online), then skip this step):

    1. Click the Settings button Dynamics 365 web client Settings button at the top of the Dynamics 365 / Dynamics CRM Endpoint section to open the Configure Dynamics 365 / Dynamics CRM Service Account pop-up window.

    2. Specify the Service URL for your Dynamics 365 instance. This is the URL you would normally enter in a browser to open Dynamics 365.

      Important

      Be careful how you specify the Service URL. One way to find this value is to open Dynamics 365, go to Settings > Customizations > Developer Resources, and copy the value shown there. But that value typically looks something like: https://contoso.api.crm.dynamics.com, which includes an extra subdomain (.api) that will be accepted but won't work. Fix it by removing the ".api" part to create a URL that looks like: https://contoso.crm.dynamics.com

    3. Enter the Service Account and Password for the service account that the connector uses to sign in to Dynamics 365. You should have created this account and assigned it the Dynamics Marketing Connector security role when you installed the connector (More information: Install the Connector).

    4. Click Verify to test the connection. If the test succeeds, click Submit to save your settings and go back to the Integration Options page. If the test fails, check your settings and try again.

    Dynamics 365 Endpoint configuration dialog

  6. Use the settings in the Service Bus section to view and configure how the connector will authenticate and use its Azure Service Bus message queues, which temporarily store data as they are transferred between Microsoft Dynamics 365 and Dynamics Marketing.

    For complete details about how to work with the settings here, see Configure Azure Service Bus settings

  7. When you are done setting up the service bus and making all other settings on the Integration Options page, choose Submit or Save to save your settings.

Run a system health check

When you modify any of the settings, you can initiate a health check to retest the system. A system health check is done automatically when the service starts up and tests the following:

  • Administrative service is running.

  • Microsoft Dynamics Marketing Publisher can send messages.

  • Microsoft Dynamics Marketing Listener can read messages.

  • Microsoft Dynamics Marketing Listener can access database.

  • Dynamics 365 Publisher can request metadata.

  • Dynamics 365 Listener can read from the queue.

  • Dynamics 365 Listener can access Dynamics 365 via SDK and has the proper permissions.

  • Plugins can access queue.

  • Dynamics 365 service bus endpoint has been correctly configured.

To know the health status of the Dynamics 365 Connector, choose the Run button Run button. All the errors encountered during the health check will be captured in a downloadable log file. To download health check logs choose the Download button Download button.

Note

The health check monitoring shows the status of the last health check performed on the system. After you modify the settings, you need to re-perform the connector health check to ensure that the modifications are done successfully.

If you receive the following message:

“Please apply most recent version of solution to your Dynamics 365 and press restart button.”

  1. Open your Dynamics 365 instance and navigate to Home > Settings > Solutions and import your new Dynamics 365 solution.

  2. After importing your new Dynamics 365solution, open your Microsoft Dynamics Marketing instance and navigate to Home > Settings > Administrator > Integration Options and then in the Services choose the Restart button.

After you refresh the page, the status of the services will be changed to either ’in progress’ or ’completed’.

Fine tune your sync settings

When your installation has passed a health check, then it should be up and running. You can now fine-tune the integration as needed to match your business needs.

Enable lists for sync in both Dynamics Marketing and Dynamics 365

By default, none of your marketing lists are synced through the connector. You must explicitly enable each link that you want to sync.

  • Static lists created in Dynamics Marketing must have their Synchronize with Dynamics 365 check box selected to be synced with Dynamics 365. Lists with this box cleared are not synced. More information:List management and segmentation

  • All marketing lists created in Dynamics 365 must be explicitly enabled for sync with Dynamics Marketing. When you import the connector solution into Dynamics 365, a new marketing-list field called "Sync Enabled" is created in the database, but it is not added to the marketing-list form by default. To make this field visible to Dynamics 365 users, you must edit the respective form(s), add the custom “Sync Enabled” field to it/them, and then save/publish the change. You must set this field to "Yes" for each marketing list you want to synchronize. More information:Add a field to a form

Adjust field mappings as needed

Other than marketing lists, all of the database fields and records that are relevant for the connector should already be correctly mapped between the two systems based on a default scenario. However, if you have customized one or both systems (such as by introducing user-defined fields or custom contact fields in Dynamics Marketing, or by adding new fields or entities in Dynamics 365) then you may need to adjust the mappings.

See Also

Connect Microsoft Dynamics Marketing to Dynamics 365
Connector deployment scenarios
Prepare Dynamics 365 (on-premises) for Azure
Install the Connector
Configure Azure Service Bus settings
Install the seller portal for Dynamics 365
Connector entity mapping
Troubleshoot your connector setup
Update the Connector Service and Dynamics 365 Solution
Configure the SDK and Dynamics 365 Connector