Send data to Microsoft Dynamics

Microsoft Dynamics CRM is a customer relationship management (CRM) software application that is focused on the supporting sales, marketing, and services. It is part of the Microsoft Dynamics family of business applications.

Note

This destination uses the Microsoft Dynamics Web API .

This topic describes the steps that are required to send data to Microsoft Dynamics from Amperity:

  1. Get details

  2. Configure Microsoft Dynamics

  3. Build a query

  4. Add destination

  5. Add data template

Get details

Microsoft Dynamics requires the following configuration details:

  1. The client ID.

  2. The client secret.

  3. The Azure Active Directory ID.

  4. The login URL for Microsoft Dynamics, similar to “<tenant-name>.crm.dynamics.com”.

  5. Admin credentials for portal.azure.com (if the customer wants Amperity to configure Microsoft Dynamics on their behalf).

  6. An application user that is assigned to a role with an access level that allows that user to modify and update records. (Some use cases require a user to delete records.)

    Note

    A single tenant account type should be all that is required for Amperity to send data to Microsoft Dynamics.

  7. The expiration date for the client secret: one of “expires in 1 year”, “expires in 2 years”, or “never expires”.

Configure Microsoft Dynamics

Microsoft Dynamics requires an application to be created in Microsoft Azure, and then add an application user to Microsoft Dynamics

Build Azure application

An application for Microsoft Dynamics must be created in Microsoft Azure. This is the location to which query data is sent by Amperity.

To build the Azure application

  1. Go to portal.azure.com, and then log in with Admin credentials.

  2. Open Azure Active Directory, and then click App registrations.

  3. Click New Registration. The Register an application page opens.

  4. Enter a name, such as “Amperity integration with Microsoft Dynamics”, specify the account type (single tenant should be fine), and then click Register. (You should leave the redirect URI setting blank.)

  5. The application page opens. The client ID and Azure Active Directory ID are shown on the page.

    Important

    The Azure Active Directory ID is sometimes referred to as the tenant ID.

  6. On the application page, click Certificates & secrets, and then click New client secret.

  7. Add a description for the secret, specify if the secret “expires in 1 year”, “expires in 2 years”, or “never expires”, and then click Add.

  8. Copy the secret that is generated.

Add application user

An application user with permission to modify and update records is required.

Warning

Only one application user may be created per Microsoft Dynamics client ID in Microsoft Dymanics.

To add the application user

  1. Go to the customer’s instance of Microsoft Dynamics, and then log in with Admin credentials. The URL for Microsoft Dynamics is similar to “<tenant-name>.crm.dynamics.com”.

  2. Click Settings, then System, and then Security.

  3. On the Security page, click Users, and then click Application Users.

  4. Click New.

  5. In the New User dialog box enter the user name, the application ID (which is the same as the Microsoft Dynamics client ID), full name, and primary email address.

    Note

    The URI for the application ID and the Azure Active Directory Object ID are both completed automatically.

  6. Assign the user a role. Click Manage Roles, and then select a role with an access level that allows that user to modify and update records. (Some use cases require a user to delete records.)

Build query

You will need to build a query that outputs fields that can be mapped to Microsoft Dynamics.

Add destination

Microsoft Dynamics is a destination that may be configured directly from Amperity.

To add a destination

  1. From the Destinations tab, click Add Destination. This opens the Add Destination dialog box.

  2. Enter the name of the destination and a description. For example: “Microsoft Dynamics” and “This sends query results to Microsoft Dynamics”.

  3. From the Plugin drop-down, select Microsoft Dynamics.

  4. The “azure-application” credential type is selected automatically.

  5. From the Credential drop-down, select Create a new credential. This opens the Create New Credential dialog box.

  6. Enter a name for the credential, the Microsoft Dynamics client ID, and the client secret. Click Save.

  7. Under Microsoft Dynamics Settings, add the customer’s Azure Active Directory ID and the URL for the customer’s instance of Microsoft Dynamics. The URL must be the full URL, including https://. For example:

    https://<tenant-name>.crm.dynamics.com
    
  8. Select Allow customers to use this data template.

  9. Select Allow orchestrations from users with limited PII access.

  10. Click Save.

Add data template

A data template defines how columns in Amperity data structures are sent to downstream workflows. A data template is part of the configuration for sending query and segment results from Amperity to an external location.

To add a data template

  1. From the Destinations tab, open the menu for the Microsoft Dynamics destination, and then select Add data template. This opens the Add Data Template dialog box.

  2. Enter the name of the data template and a description. For example: “Microsoft Dynamics” and “This template maps data for Microsoft Dynamics.”

  3. Verify all settings.

  4. Click Save.

Common Data Service Web API

Note

Microsoft Dynamics is a complex system. Even though Amperity has a built-in connector that supports sending data to entities within Microsoft Dynamics, there are more than 400 possible entities to which you can send data, with each of these entities having its own schema that requires a unique mapping of data in a data template.

The Common Data Service Web API (version 8.2 and higher or version 9.0) is the API to which Amperity can send data.

  • Microsoft Dynamics is not strict about required fields, in that you may choose to not send fields to Microsoft Dynamics even when they are marked as required.

  • Microsoft Dynamics is strict about extra fields, in that you should not send fields to Microsoft Dynamics that do not already exist in the entity’s schema. Use the include section in the data template mapping to drop fields that should not be sent to Microsoft Dynamics.

Review the entities in the Common Data Service Web API prior to configuring a data template. Some of the entities that are more focused toward marketing and user activity include Contact , List , Campaign , CampaignActivity , CampaignResponse , or CustomerAddress . Any of the entities found in the Web API EntityType Reference may be configured as a destination, depending on your use case.