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.
As a Salesforce admin I want to synchronize custom objects between two Salesforce orgs.
This Anypoint template serves as a foundation for setting an online sync of custom objects from one SalesForce instance to another. When there is new custom object or a change in an already existing one, the integration will poll for changes in SalesForce source instance and it will be responsible for updating the custom object on the target org.
Requirements have been set not only to be used as examples, but also to establish a starting point to adapt your integration to your requirements.
As implemented, this template leverages the Mule batch module. The batch job is divided in Process and On Complete stages. During the Input stage the template will go to the SalesForce Org A and query all the existing custom objects that match the filter criteria. During the Process stage, each Salesforce custom object is filtered depending on if it has an existing matching custom object in the Salesforce Org B. The last step of the Process stage groups the custom objects and create/update them in Salesforce Org B. Finally during the On Complete stage the template logs output statistics data into the console.
To make this template run, there are certain preconditions that must be considered. All of them deal with the preparations in both source and destination systems, that must be made for the template to run smoothly. Failing to do so could lead to unexpected behavior of the template.
In order to run the template as is, you'll need to create the custom objects provided in your Salesforce accounts. In order to do so, please follow the steps documented in SalesForce documentation.
The custom objects and custom fields created for this application are the following:
- SalesForce org A MusicAlbum interpreter year genre
- SalesForce org B MusicAlbum interpreter year genre
Note: Please, take into account that this sample application uses SalesForce Object Query Language which, when querying for custom objects and fields, requires you to append __c
to your query. So for example, to query the music albums' interptreters, the query would be this way: SELECT interpreter__c FROM MusicAlbum__c
.
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.
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, then 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'
]
]
There are no considerations with using Salesforce as a data destination.
Simple steps to get this template running.
In this section we help you run this template on your computer.
If you are new to Mule, download this software:
Note: Anypoint Studio requires JDK 8.
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.
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.env
to the valuedev
. - Click
Run
.
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
.
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.
Once your app is all set and started, there is no need to do anything else. Every time a custom object is created or modified, it will be automatically synchronised to Salesforce Org B as long as it has an Email.
In Studio, right click your project name in Package Explorer and select Anypoint Platform > Deploy on CloudHub.
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
- scheduler.frequency
60000
- scheduler.startDelay
0
- watermark.default.expression
YESTERDAY
- page.size
200
- sfdc.a.username
bob.dylan@orga
- sfdc.a.password
DylanPassword123
- sfdc.a.securityToken
avsfwCUl7apQs56Xq2AKi3X
- sfdc.b.username
joan.baez@orgb
- sfdc.b.password
JoanBaez456
- sfdc.b.securityToken
ces56arl7apQs56XTddf34X
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
Being X the number of Custom Objects to be synchronized on each run.
The division by 200 is because, by default, Custom Objects 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 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
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.
Functional aspect of the template is implemented on this XML, directed by one flow that will poll for SalesForce creations/updates. The several message processors constitute four high level actions that fully implement the logic of this template:
- During the Input stage the template will go to the SalesForce Org A and query all the existing custom objects that match the filter criteria.
- During the Process stage, each Salesforce custom object is filtered depending on if it has an existing matching custom object in the Salesforce Org B.
- The last step of the Process stage groups the custom objects and create/update them in Salesforce Org B.
- Finally during the On Complete stage the template logs output statistics data into the console.
This file is conformed by two flows.
The first one we'll call it scheduler flow. This one contains the Scheduler endpoint that will periodically trigger watermarking flow and then executing the batch job process.
The second one we'll call it watermarking flow. This one contains watermarking logic that will be querying Salasforce for updated/created Custom Objects that meet the defined criteria in the query since the last polling. The last invocation timestamp is stored by using Objectstore Component and updated after each Salasforce query.
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.