Skip to main content
Italiano
Help Desk

Dynamics connector

Updated

This section is devoted to the Admin profile, a user profile in charge of activities such as setup, configuration and settings management for using Dynamics CRM Connector.

The configurations listed below can be made only with a platform Administrator profile.

Setup

Please find instructions for installation, connection and setup of the MS Dynamics CRM and the platform below.

Installation of the Microsoft Dynamics CRM Connector app

For more details about installing on your MS Dynamics CRM account, please contact our Help Desk service.

Platform

First, you need to install the Microsoft Dynamics CRM Connector app on your Platform account. In the user menu, follow the path

Management > AppCenter 

en_dyn001.png.png

and, on the landing page, click on the Microsoft Dynamics CRM Connector app,

en_dyn002.png.png

click on the button Install to install the app.

Connection of the app Microsoft Dynamics CRM Connector

Follow the path:

Management > Microsoft Dynamics > Setup

en_dyn004.png.png

to set its configuration.

The setup page is divided into five sections:

General

Dynamics CRM Connector global setup

You can connect your Microsoft Dynamics Online account to the platform by using one of this web services: the Web Api (REST api) or the Organization Service Api (SOAP api).

Microsoft has announced the deprecation of the SOAP endpoint (also known as CRM 2011 endpoint or OrganizationServiceProxy), so it is recommended to migrate to the Web API (see Microsoft Dynamics CRM 2011 endpoint for reference).

Configure connection to use Web Api

Enable the Use Web Api option and set the Organization url parameter and click on Save. 

en_dyn225.png.png

Click on Modify the digital certificate to connect using Web Api and keep the page open for reference.

You need to fill Application ID and App Secret fields with the right credentials off an App created in your Azure AD Portal.

Follow this guide to register an App on Azure: Create an application registration.
When requested, set the Redirect URI by coping the value of Redirect URI to be configured field you'll find in the digital certificate.

en_dyn226.png.png

Once the App is created on Azure, click on Overview and copy the Application ID, then paste it on the Application ID on the digital certificate you leaved open for on the platform.

en_dyn227.png.png

On Azure, click on Certificates & secrets and generate a new Client Secret, then paste the Value (not the Id) of the secret on the App Secret field of the platform digital certificate. 

en_dyn235.png.png

On Azure, click on Endpoint. A window will open where several urls are available. Check that the first 2: OAuth 2.0 Authorization Endpoints (v2) and OAuth 2.0 Token Endpoints (v2) are aligned with those set in the digital certificate, respectively: OAuth Dialog URL and Token Location URL.

en_dyn233.png.png

If not, then overwrite those present on the Digital Certificate present on the platform. Then click on Save to save all updated values of Digital Certificate.

Return to the Dynamics CRM global setup and click on Authorize connection. You should be able to see the description of connected user.

Migrate from the Organization Service to the Web Api

The switch from the Organization Service to the Web Api doesn't implies the migration of datas or configurations.
Once you have configured the connection as explained in the above paragraph, you can continue to use the connector like you did before.
The only thing you need to check to avoid an interruption of service in the automatic scheduled operations, is that the user configured as the Default user to run the App is connected to Dynamics.

en_dyn228.png.png

Configure connection to use Organization Service

This section describes how to connect to the OrganizationServiceProxy (SOAP api) endpoint. If you're Dynamics environment support the Web Api we strongly recommend to switch to the that method of connection described in the above paragraphs.

en_dyn192.png.png

Enable the Microsoft Dynamics CRM on-premise version option if you are using a server solution of MS Dynamics CRM.
Leave this option unflagged if you are using a SaaS version of MS Dynamics CRM.

  • Webservice CRM URL:
    URL of the server on which MS Dynamics CRM is installed (e.g. Https://SERVERNAME/XRMServices/2011/Organization.svc)
  • ADFS server name:
    (only for On-Premise installations) - specify the hostname of your ADFS server.
  • Certificate validation disabled:
    Enable this option only if the connection between Dynamics and the platform does not supply any verifiable certificate.
  • Modify digital certificate to connect with MagNews:
    This certificate is used to connections that start from Dynamics (i.e. custom buttons on Dynamics that send data to MagNews) and it's the same for both connection methods (Web Api and Organization Service).

en_dyn005.png.png

  • User name:
    • On-Premise: enter a complete Microsoft Dynamics User ID
    • On-line: enter a valid Windows Live ID or an Office 365 user ID.
  • Password:
    enter a valid password. The password is hidden for security reasons.

When this operation is complete, click on the Test the connection button to test whether the connection is working properly.
The following message will be displayed:
Connected as: Username
Verified: Date of last valid user verification

A further message will confirm successful connection with the defined user.

If authentication fails, an error message with the list of problems will be shown.

Unsubscribe/suspension cause management

In this section, you can assign a specific suspension or unsubscription cause if a contact is unsubscribed or suspended or not present in the CRM.

en_dyn195.png.png

  • Unsubscribe from Dynamics synchronization
    If mapped, this status will be used if the option Unsubscribe contacts who are not on the CRM is active. (It may be activated in the Dynamics Contacts configuration section).
  • Unsubscribe error during synchronization:
    If mapped, this status will be used if an error occurs during the import process.
  • Suspended by Dynamics Synchronization:
    If mapped, this status will be used for the contacts suspended on the CRM.

Advanced

Timeout settings

en_dyn015.png.png

  • Read timeout
    set the time range after which a reading operation will get a timeout. Time is expressed in milliseconds. If no value is indicated, the default value will be 60000.
  • Connection timeout
    set the time range after which the platform will get a connection timeout. Time is expressed in milliseconds. If no value is indicated, the default value will be 60000.

Batch size

en_dyn114.png.png

  • Fetch batch size
    number of records that will be downloaded in a single session (remaining records will be downloaded in one or more further sessions).
  • Upload batch size
    number of records that will be uploaded in a single session (remaining records will be uploaded in one or more further sessions)

Timezone setting

en_dyn015.png.png

This field is used during the synchronization to assign a timezone to the Dynamics' TimezoneIndependent fields, and only to them.
The default timezone is UTC

Entity definitions

The next step is to download the Entity definitions.

en_dyn194.png.png

Click on the Download and update link, confirm the operation and wait until it is complete.

Note you need to download them every time a Dynamics field is added or changed.

CRM Connection

Click on the CRM connection link and enter the Platform's user connection page

en_dyn006.png.png

Enter the username and password used on MS Dynamics CRM and perform a connection test:

en_dyn007.png.png

Note
if you are using Microsoft Dynamics CRM On-Premise, the user name is your Microsoft Dynamics CRM complete User ID (including the domain name, for example, Domain\User ID).
If you are using Microsoft Dynamics CRM online, use a valid Windows Live ID or Office 365 user ID.