S/4HANA Cloud to Salesforce Partner Broadcast
home
This template serves as a foundation for setting an online sync of Partners from a SAP S4HANA instance to a Salesforce instance. Every time there is new Partner or a change in an already existing one, the integration will poll for changes in SAP S4HANA instance and it will be responsible for updating the Account in Salesforce.
As implemented, this template leverages the Mule batch module.
The batch job is divided into Process and On Complete stages.
The migration process starts by fetching all the existing partners that match the filter criteria from SAP S4HANA.
On Process stage matches accounts that are grouped and inserted or updated into Salesforce.
Finally during the On Complete stage, the Template logs output statistics data into the console.
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.
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 all to run smoothly.
Failing to do so can lead to unexpected behaviour of the template.
SAP S/4HANA Considerations
Here's what you need to know to get this template to work with SAP S/4HANA.
As a Data Source
There are no considerations with using SAP S/4HANA as a data destination.
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 Destination
There are no considerations with using Salesforce as a data destination.
Run it!
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 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
Batch Aggregator Configuration
- page.size
1000
Scheduler Configuration
- scheduler.frequency
60000 - scheduler.start.delay
0 - watermark.default.expression
"2016-12-13T03:00:59Z"
SAP S4Hana Connector configuration
- s4hana.baseUrl
your.sap4hana.address.com - s4hana.username
your.sap4hana.username - s4hana.password
your.sap4hana.password
Salesforce Connector Configuration
- sfdc.username
bob.dylan@orga - sfdc.password
DylanPassword123 - sfdc.securityToken
avsfwCUl7apQs56Xq2AKi3X
API Calls
Salesforce imposes limits on the number of API Calls that can be made. Therefore calculating this amount is important. This template calls the API using this formula:
2X / ${page.size}
X is the number of accounts to be synchronized on each run.
Divide by ${page.size} because by default, accounts are gathered in groups of ${page.size} for each Upsert API Call in the aggregation step.
For instance if 10 records are fetched from origin instance, then 2 API calls are made (1 + 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 on this XML, directed by a batch job that will be responsible for creations/updates. The several message processors constitute high level actions that fully implement the logic of this Template:
- On Process stage matches accounts that are grouped and inserted or updated into Salesforce.
- Finally during the On Complete stage the Template logs output statistics data into the console.
endpoints.xml
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 query flow and then executing the batch job process.
The second one we'll call it query flow. This one contains watermarking logic that will be querying SAP S4HANA for updated/created Partners 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 SAP S4HANA query.
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.