Salesforce and Microsoft Dynamics CRM Account Bidirectional Sync
home
Synchronizes account data between Salesforce and Microsoft Dynamics CRM in both directions. This template lets quickly configure the fields to synchronize, how they map, and criteria on when to trigger the synchronization.
You can invoke this template using a polling mechanism or modify it to work with Salesforce outbound messaging to make efficient Salesforce API calls. This template leverages watermarking functionality to make sure only the latest modified changes are synchronized. It also uses the batch functionality to effectively process many records at a time.
License Agreement
This template is subject to the conditions of the MuleSoft License Agreement. Review the terms of the license before downloading and using this template. You can use this template for free with the Mule Enterprise Edition, CloudHub, or as a trial in Anypoint Studio.
Use Case
As an admin, I want to have my accounts synchronized between two different systems in Salesforce and MS Dynamics CRM.
Template Overview
Let's say we want to keep accounts synchronized between a Salesforce instance and an MS Dynamics CRM instance.
The integration behavior is as follows:
- Ask Salesforce:What changes have there been since the last time we communicated?
- For each of the updates fetched in the previous step (1), ask MS Dynamics:Should I apply the update received from Salesforce?
- If MS Dynamics answers Yes to the previous question (2), then upsert (create or update depending on each particular case) MS Dynamics with the change.
- Repeat previous steps (1 to 3) the other way around (using MS Dynamics as source instance and Salesforce as the target one).Repeat ad infinitum:
- Ask Salesforce:What changes have been since the step 1?
And so on...
The question for recent changes since a certain moment in nothing but a Scheduler with a watermark defined.
Considerations
To make this template run, there are certain preconditions that must be considered. All of them deal with the preparations in both, that must be made for the template to run smoothly. Failing to do so could lead to unexpected behavior of the template.
Note: You need to install Java Cryptography Extensions to connect to MS Dynamics. Choose a relevant version according to your Java installation.
Salesforce Considerations
Here's what you need to know about Salesforce to get this template to work:
- Where can I check that the field configuration for my Salesforce instance is the right one? See: Salesforce: Checking Field Accessibility for a Particular Field.
- Can I modify the Field Access Settings? How? See: Salesforce: Modifying Field Access Settings.
As a Data Source
If the user who configured the template for the source system does not have at least read only permissions for the fields that are fetched, an InvalidFieldFault API fault displays.
java.lang.RuntimeException: [InvalidFieldFault [ApiQueryFault
[ApiFault exceptionCode='INVALID_FIELD'
exceptionMessage='Account.Phone, Account.Rating, Account.RecordTypeId,
Account.ShippingCity
^
ERROR at Row:1:Column:486
No such column 'RecordTypeId' on entity 'Account'. If you are
attempting to use a custom field, be sure to append the '__c' after the
custom field name.
Reference your WSDL or the describe call for the appropriate names.'
]
row='1'
column='486'
]
]As a Data Destination
There are no considerations with using Salesforce as a data destination.
Microsoft Dynamics CRM Considerations
As a Data Source or Data Destination
For this template to work, a custom field new_salesforceid has to be defined for accounts. See Microsoft's Create and edit fields for information on adding this field.
There are no other particular considerations for this template regarding Microsoft Dynamics CRM as a data origin or data destination.
Run it!
Simple steps to get this template running.
See below.
Running On Premises
Use this section to run this template on your computer.
Where to Download Anypoint Studio and the Mule Runtime
If you are new to Mule, download this software:
Note: Anypoint Studio requires JDK 8.
Importing a Template into Studio
In Studio, click the Exchange X icon in the upper left of the taskbar, log in with your Anypoint Platform credentials, search for the template, and click Open.
Running on Studio
After you import your template into Anypoint Studio, follow these steps to run it:
- Locate the properties file
mule.dev.properties, in src/main/resources. - Complete all the properties required as per the examples in the "Properties to Configure" section.
- Right click the template project folder.
- Hover your mouse over
Run as. - Click
Mule Application (configure). - Inside the dialog, select Environment and set the variable
mule.envto the valuedev. - Click
Run.
Running on Mule Standalone
Update the properties in one of the property files, for example in mule.prod.properties, and run your app with a corresponding environment variable. In this example, use mule.env=prod.
Running on CloudHub
When creating your application in CloudHub, go to Runtime Manager > Manage Application > Properties to set the environment variables listed in "Properties to Configure" as well as the mule.env value.
Deploying a Template in CloudHub
In Studio, right click your project name in Package Explorer and select Anypoint Platform > Deploy on CloudHub.
Properties to Configure
To use this template, configure properties such as credentials, configurations, etc.) in the properties file or in CloudHub from Runtime Manager > Manage Application > Properties. The sections that follow list example values.
Application Configuration
Application Configuration
- scheduler.frequency
10000 - scheduler.startDelay 0 The number of milliseconds (also different time units can be used) between checks for updates in Salesforce and MS Dynamics.
SalesForce Connector Configuration for Company A
- sfdc.username
salesforce.user@mail.com - sfdc.password
salesforcePass - sfdc.securityToken
wJFJAf6lw3vH86bDLWSjpfJC - sfdc.integration.user.id
00520000003LtvGAASNote: To find the correct sfdc.integration.user.id value, see Salesforce Data Retrieval. - sfdc.watermark.default.expression
2019-04-01T19:40:27.000Z
MS Dynamics Connector Configuration for Company B
- msdyn.authenticationRetries
3 - msdyn.username
msDynamicsUser@@yourOrg.onmicrosoft.com - msdyn.password
msDynamicsPass - msdyn.url
https://htesting.api.crm4.dynamics.com/XRMServices/2011/Organization.svc - msdyn.watermark.default.expression
2019-04-01T19:40:27Z - msdyn.integration.user.id
534679675
API Calls
Salesforce imposes limits on the number of API calls that can be made. Therefore calculating this amount may be an important factor to consider.
The template calls to the API can be calculated using the formula:
- 1 + X + X / 200 -- Where X is the number of accounts to synchronize on each run.
- Divide by 200 because by default accounts are gathered in groups of 200 for each Upsert API call in the commit step. Also consider that this calls are executed repeatedly every polling cycle.
For instance if 10 records are fetched from origin instance, then 12 API calls are made (1 + 10 + 1).
Customize It!
This brief guide provides a high level understanding of how this template is built and how you can change it according to your needs. As Mule applications are based on XML files, this page describes the XML files used with this template. More files are available such as test classes and Mule application files, but to keep it simple, we focus on these XML files:
- config.xml
- businessLogic.xml
- endpoints.xml
- errorHandling.xml
config.xml
This file provides the configuration for connectors and configuration properties. Only change this file to make core changes to the connector processing logic. Otherwise, all parameters that can be modified should instead be in a properties file, which is the recommended place to make changes.
businessLogic.xml
Functional aspect of the Template is implemented in this XML, directed by one flow responsible of executing the logic. For the purpose of this particular Template there are two batch jobs, which handles all the logic of the template. The first fromSalesforceBatch batch job is called for synchronization of accounts from Salesforce to MS Dynamics. If the account already exists in MS Dynamics, the last modified date is compared and according to the result, the account is updated or not. On the other hand, if the account does not exist, it is created. The second fromDynamicsCrmBatch batch job works in the same way, but in the opposite direction.
endpoints.xml
This file provides the inbound and outbound sides of your integration app. These flows have error handling consisting of invoking the On error propagate defined in errorHandling.xml file. This file defines the application API.
errorHandling.xml
This file handles how your integration reacts depending on the different exceptions. This file provides error handling that is referenced by the main flow in the business logic.