Broadcast changes or creations of accounts from Salesforce to SAP as customers in real time. The detection criteria and fields to move are configurable. Additional systems can be added to be notified of the changes.
Real time synchronization is achieved either via rapid polling of Salesforce or Outbound Notifications to reduce the number of API calls.
This template uses Mule batching and watermarking capabilities to capture only recent changes, and to efficiently process large amounts of records.
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.
This template serves as a foundation for setting an online synchronization of accounts/customers from Salesforce to SAP.
Every time there is a new account or a change in an existing one in Salesforce instance, the template fetches it and send sit as IDoc to SAP to update customer there.
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. This template leverages the Mule batch module. The batch job is divided in Process and On Complete stages. The integration is triggered by poll to Salesforce Accounts. New or modified accounts are passed to the batch as input. In the batch the customer is fetched from SAP by its name. If it exists, its SAP Account Group is resolved against SAP. If it doesn't exist, then new customer number is fetched from SAP. Afterwards every such account from Salesforce is sent to SAP in form of iDoc XML where it is asynchronously updated or created. 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, that must be made for the template to run smoothly. Failing to do so could lead to unexpected behavior of the template.
Before continuing with the use of this template, see the SAP connector guide, that teaches you how to work with SAP and Anypoint Studio.
This Anypoint template uses a few private Maven dependencies from MuleSoft to work. If you intend to run this template with Maven support, you need to add extra dependencies for SAP to the pom.xml file.
Here's what you need to know to get this template to work with SAP.
As a Data Destination
There are no considerations with using SAP as a data destination.
- 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.
- How can I modify the Field Access Settings? 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, 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' ] ]
Simple steps to get this template running.
Running On Premises
In this section we help you 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 per the examples in the "Properties to Configure" section.
- Right click the template project folder.
- Hover your mouse over
Mule Application (configure).
- Inside the dialog, select Environment and set the variable
mule.envto the value
For this template to run in Anypoint Studio, you need to install SAP libraries. See Install SAP Libraries.
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
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.
Batch Aggregator Configuration
Watermarking default last query timestamp for example 2018-12-13T03:00:59Z
SalesForce Connector Configuration
SAP Connector Configuration
There are no particular considerations for this template regarding API calls.
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:
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 a batch job that will be responsible for creations/updates. The several message processors constitute four high level actions that fully implement the logic of this template:
- The integration is triggered by poll to Salesforce Accounts. New or modified accounts are passed to the batch as input.
- During the Process stage, the customer is fetched from SAP by its name.
- If customer exists, its SAP Account Group is resolved against SAP. If it doesn't exist, then new customer number is fetched from SAP. Afterwards every such account from Salesforce is sent to SAP in form of iDoc XML where it is asynchronously updated or created.
- 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 is the scheduler flow. This one contains the Scheduler endpoint that will periodically trigger query flow and then executing the batch job process.
The second one is the query flow. This one contains watermarking logic that will be querying Salesforce for updated/created Accounts that meet the defined criteria in the query since the last polling. The last invocation timestamp is stored by using Object Store Component and updated after each Salesforce 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.