Note that using this template is subject to the conditions of this License Agreement. Please review the terms of the license before downloading and using this template. In short, you are allowed to use the template for free with Mule ESB Enterprise Edition, CloudHub, or as a trial in Anypoint Studio.
As a Salesforce admin, I want to have my users synchronized between two different Salesforce organizations
Let's say we want to keep Salesforce instance A synchronized with Salesforce instance B. Then, the integration behavior can be summarized just with the following steps:
- Ask Salesforce A:
Which changes have there been since the last time I got in touch with you?
- For each of the updates fetched in the previous step (1.), ask Salesforce B:
Does the update received from A should be applied?
-
If Salesforce answer for the previous question (2.) is Yes, then upsert (create or update depending each particular case) B with the belonging change
-
Repeat previous steps (1. to 3.) the other way around (using B as source instance and A as the target one)
Repeat ad infinitum:
- Ask Salesforce A:
Which changes have there been since the question I've made in the step 1.?
And so on...
The question for recent changes since a certain moment in nothing but a poll inbound with a watermark defined.
There are a couple of things you should take into account before running this kick:
- Users cannot be deleted in SalesForce: For now, the only thing to do regarding users removal is disabling/deactivating them, but this won't make the username available for a new user.
- Each user needs to be associated to a Profile: SalesForce's profiles are what define the permissions the user will have for manipulating data and other users. Each SalesForce account has its own profiles. Check out the next section to define a map between Profile Ids (from the source account to the ones in the target account and the other way around).
- Working with sandboxes for the same account: Although each sandbox should be a completely different environment, Usernames cannot be repeated in different sandboxes, i.e. if you have a user with username bob.dylan in sandbox A, you will not be able to create another user with username bob.dylan in sandbox B. If you are indeed working with Sandboxes for the same SalesForce account you will need to map the source username to a different one in the target sandbox, for this purpose, please refer to the processor labeled assign ProfileId and Username to the User.
There may be a few things that you need to know regarding Salesforce, in order for this template to work.
In order to have this template working as expected, you should be aware of your own Salesforce field configuration.
###FAQ
-
Where can I check that the field configuration for my Salesforce instance is the right one?
Salesforce: Checking Field Accessibility for a Particular Field
-
Can I modify the Field Access Settings? How?
If the user configured in the template for the source system does not have at least read only permissions for the fields that are fetched, then a InvalidFieldFault API fault will show up.
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. Please reference your WSDL or the describe call for the appropriate names.'
]
row='1'
column='486'
]
]
There are no particular considerations for this Anypoint Template regarding Salesforce as data destination.
Simple steps to get Salesforce to Salesforce User Bidirectional Sync running.
In this section we detail the way you should run your Anypoint Template on your computer.
First thing to know if you are a newcomer to Mule is where to get the tools.
Mule Studio offers several ways to import a project into the workspace, for instance:
- Anypoint Studio generated Deployable Archive (.zip)
- Anypoint Studio Project from External Location
- Maven-based Mule Project from pom.xml
- Mule ESB Configuration XML from External Location
You can find a detailed description on how to do so in this Documentation Page.
Once you have imported you Anypoint Template into Anypoint Studio you need to 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 section Properties to be configured
- Once that is done, right click on you Anypoint Template project folder
- Hover you mouse over
"Run as" - Click on
"Mule Application"
Complete all properties in one of the property files, for example in [mule.prod.properties] (../master/src/main/resources/mule.prod.properties) and run your app with the corresponding environment variable to use it. To follow the example, this will be mule.env=prod.
While creating your application on CloudHub (Or you can do it later as a next step), you need to go to Deployment > Advanced to set all environment variables detailed in Properties to be configured as well as the mule.env.
Mule Studio provides you with really easy way to deploy your Template directly to CloudHub, for the specific steps to do so please check this link
In order to use this Mule Anypoint Template you need to configure properties (Credentials, configurations, etc.) either in properties file or in CloudHub as Environment Variables. Detail list with examples:
-
polling.frequency
10000
This are the miliseconds (also different time units can be used) that will run between two different checks for updates in Salesforce -
watermark.default.expression
2014-02-25T11:00:00.000Z
This property is an important one, as it configures what should be the start point of the synchronization.The date format accepted in SFDC Query Language is either YYYY-MM-DDThh:mm:ss+hh:mm or you can use Constants. [More information about Dates in SFDC][3] -
page.size
200
-
sfdc.a.username
jorge.drexler@mail.com -
sfdc.a.password
Noctiluca123 -
sfdc.a.securityToken
avsfwCUl7apQs56Xq2AKi3X -
sfdc.a.url
https://login.salesforce.com/services/Soap/u/32.0 -
sfdc.a.integration.user.id
A0ed000BO9TNote: To find out the correct sfdc.a.integration.user.id value, please, refer to example project Salesforce Data Retrieval in Anypoint Exchange.
-
sfdc.b.username
mariano.cozzi@mail.com -
sfdc.b.password
LaRanitaDeLaBicicleta456 -
sfdc.b.securityToken
ces56arl7apQs56XTddf34X -
sfdc.b.url
https://login.salesforce.com/services/Soap/u/32.0 -
sfdc.b.integration.user.id
A0ed000BO9TNote: To find out the correct sfdc.b.integration.user.id value, please, refer to example project Salesforce Data Retrieval in Anypoint Exchange.
SalesForce's profiles are what define the permissions the user will have for manipulating data and other users. Each SalesForce account has its own profiles.
This should be a map that associates a profile in sfdc A with a profile in sfdc B for example: ['SOME_PROFILE_IN_A': 'SOME_PROFILE_IN_B', 'ANOTHER_PROFILE_IN_A': 'ANOTHER_PROFILE_IN_B']
- from.A.to.B.profilesMap
['00e200000015oKF': '00e20000001UzDx']
This should be a map that associates a profile in sfdc B with a profile in sfdc A for example: ['SOME_PROFILE_IN_B': 'SOME_PROFILE_IN_A', 'ANOTHER_PROFILE_IN_B': 'ANOTHER_PROFILE_IN_A']
- from.B.to.A.profilesMap
['00e200000015oKF': '00e20000001UzDx']
The meaning of the properties above is defined in the second consideration on the previous section
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 Anypoint Template calls to the API can be calculated using the formula:
1 + X + X / 200
Being X the number of Users to be synchronized on each run.
The division by 200 is because, by default, Users 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 will be made (1 + 10 + 1).
This brief guide intends to give a high level idea of how this Anypoint Template is built and how you can change it according to your needs. As mule applications are based on XML files, this page will be organized by describing all the XML that conform the Anypoint Template. Of course more files will be found such as Test Classes and Mule Application Files, but to keep it simple we will focus on the XMLs.
Here is a list of the main XML files you'll find in this application:
Configuration for Connectors and Properties Place Holders are set in this file. Even you can change the configuration here, all parameters that can be modified here are in properties file, and this is the recommended place to do it so. Of course if you want to do core changes to the logic you will probably need to modify this file.
In the visual editor they can be found on the Global Element tab.
This file holds the functional aspect of the template (points 2. to 4. described in the template overview). Its main component is a [Batch job][8], and it includes steps for both executing the synchronization from Salesforce instance A to Salesforce instance B, and the other way around.
This file should contain every inbound and outbound endpoint of your integration app. It is intented to contain the application API. In this particular template, this file contains a couple of poll inbound endpoints that query salesforce for updates using watermark as mentioned before.
This is the right place to handle how your integration will react depending on the different exceptions. This file holds a Choice Exception Strategy that is referenced by the main flow in the business logic.