• License Agreement
• Use Case
• Considerations
  • DB Considerations
  • Salesforce Considerations
• Run it!
  • Running on premise
  • Running on Studio
  • Running on Mule ESB stand alone
  • Running on CloudHub
  • Deploying your Anypoint Template on CloudHub
  • Properties to be configured (With examples)
• API Calls
• Customize It!
  • config.xml
  • businessLogic.xml
  • endpoints.xml
  • errorHandling.xml

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 accounts synchronized between Salesforce and Database organizations.

Let's say we want to keep Salesforce instance synchronized with Database instance. Then, the integration behavior can be summarized just with the following steps:

1. Ask Salesforce:

Which changes have there been since the last time I got in touch with you?

2. For each of the updates fetched in the previous step (1.), ask Database:

Does the update received from Salesforce should be applied?

3. If Database answer for the previous question (2.) is Yes, then upsert (create or update depending each particular case) Database with the belonging change

4. Repeat previous steps (1. to 3.) the other way around (using Database as source instance and Salesforce as the target one)

Repeat ad infinitum:

5. Ask Salesforce:

Which changes have there been since the question I've made in the step 1.?

And so on...

This particular Anypoint Template illustrate the synchronization use case between SalesForce and a Database, thus it requires a DB instance to work. The Anypoint Template comes packaged with a SQL script to create the DB table that uses. It is the user responsibility to use that script to create the table in an available schema and change the configuration accordingly. The SQL script file can be found in [src/main/resources/account.sql] (../master/src/main/resources/account.sql)

The question for recent changes since a certain moment is nothing but a poll inbound with a watermark defined.

There may be a few things that you need to know regarding DB, in order for this template to work.

This Anypoint Template may be using date time/timestamp fields from the DB in order to do comparisons and take further actions. While the template handles the time zone by sending all such fields in a neutral time zone, it can not handle time offsets. We define as time offsets the time difference that may surface between date time/timestamp fields from different systems due to a differences in the system's internal clock. The user of this template should take this in consideration and take the actions needed to avoid the time offset.

There are no particular considerations for this Anypoint Template regarding DB as data origin.

There are no particular considerations for this Anypoint Template regarding DB as data destination.

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?

  Salesforce: Modifying Field Access Settings

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 SFDC2DB-account-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.

• You can download Mule Studio from this Location
• You can download Mule ESB from this Location

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" 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:

• poll.frequencyMillis 10000
  Thesse are the milliseconds (also different time units can be used) that will run between two different checks for updates in Salesforce and Database
• poll.startDelayMillis 0
• page.size 200

• sfdc.username [email protected]
• sfdc.password Noctiluca123
• sfdc.securityToken avsfwCUl7apQs56Xq2AKi3X
• sfdc.url https://login.salesforce.com/services/Soap/u/32.0
• sfdc.integration.user.id 005n0000000T3QkAAK
• sfdc.watermark.default.expression 2015-11-26T11:00:00.000Z The watermark default properties are important ones, as they configure what should be the start point of the synchronization for each system. 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 As a default value for this default properties we provide a groovy expression that starts checking for updates since almost the moment where the template is started (you can check an example here)

• database.url jdbc:mysql://localhost:3306/sfdc2db?user=root&password=
• database.integration.user.id mule@localhost
• database.watermark.default.expression 2015-11-26T11:00:00.000Z

+database.timeZoneOffset -03:00 You can get this value by running the following SQL selection:

SELECT @@system_time_zone;

If it is required to connect to a different Database there should be provided the jar for the library and changed the value of that field in the connector.

SalesForce imposes limits on the number of API Calls that can be made. Therefore calculating this amount may be an important factor to consider. Product Broadcast Template calls to the API can be calculated using the formula:

X / 200

Being X the number of Products 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 1 api calls to SFDC will be made ( 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:

• config.xml
• endpoints.xml
• businessLogic.xml
• errorHandling.xml

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.

A functional aspect of this Anypoint Template implemented in this XML is to create or update objects in the destination system for a represented use case. You can customize and extend the logic of this Anypoint Template in this XML to more specifically meet your needs.

This is file is conformed by a Flow containing the endpoints for triggering the template and retrieving the objects that meet the defined criteria in the query. And then executing the batch job process with the query results.

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.