Salesforce to S/4HANA Cloud Order Migration
home
This template moves a large set of order objects from Salesforce to SAP S/4HANA Cloud. Order objects are upserted so that migration can be executed multiple times without worrying concerns about duplicating information. This template uses MuleSoft's batching capabilities to move a large set of data easily and transparently from Salesforce into SAP S/4HANA Cloud.
Dependencies
- Anypoint platform Enterprise Edition subscription or a trial account.
- An entitlement to the Anypoint connector for SAP S/4HANA Cloud.
This Anypoint template serves as a foundation for setting an online sync of orders from Salesforce to SAP S/4HANA.
Use this template if you would like to sync orders from Salesforce to SAP S/4HANA sales orders in manner of one time synchronization by browse toting the HTTP endpoint. The template will fetch all orders by specified criteria and send it to SAP S/4HANA to create/update sales order. 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 into Process and On Complete stages.
The integration is triggered by the HTTP endpoint to fetch all the Salesforce Orders suitable for migration. Fetched orders are passed to the batch as input. In the batch the sales order is fetched from SAP S/4HANA by its order number. If it exists, its sales order identifier is resolved against SAP S/4HANA. If it doesn't exist, then new sales order is fetched from SAP S/4HANA. Afterwards every sales order from Salesforce is sent to SAP S/4HANA where it is asynchronously updated or created. Finally during the On Complete stage the template logs output statistics data into the console and sends a notification e-mail with the results of the batch execution.
Considerations
To make this template run, there are certain preconditions that must be considered. All of them deal with the preparations in both source (Salesforce) and destination (SAP S4Hana) systems, that must be made for the template to run smoothly.
Failing to do so could lead to unexpected behavior of the template.
Before using this template, you may want to check out this Documentation Page, that will teach you how to work
with SAP S/4HANA and Anypoint Studio.
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 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'
]
]SAP S/4HANA Considerations
Here's what you need to know to get this template to work with SAP S/4HANA.
As a Data Destination
Here's what you need to know about SAP S/4HANA to get this template to work.
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.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.
In order to make this template run on Anypoint Studio there are a few extra steps that needs to be made.
Please check this Documentation Page:
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
Application Configuration
- http.port
9090 - page.size
1000
SoldToParty Configuration: The sold-to party is contractually responsible for sales orders.
- s4hana.soldToParty
123456
Watermarking default last query timestamp e.g. 2017-12-13T03:00:59Z
- watermark.default.expression
2019-07-13T03:00:59Z
SalesForce Connector Configuration
- sfdc.username
bob.dylan@sfdc - sfdc.password
DylanPassword123 - sfdc.securityToken
avsfwCUl7apQs56Xq2AKi3X
SAP S/4HANA Connector Configuration
- s4hana.baseUrl
your.s4hana.address.com - s4hana.username
your.s4hana.username - s4hana.password
your.s4hana.password
SMTP Services Configuration
- smtp.host
smtp.gmail.com - smtp.port
587 - smtp.user
email@example.com - smtp.password
password
Email Details
- mail.from
batch.migrateOrders.migration@mulesoft.com - mail.to
your@email.com - mail.subject
Batch Job Finished Report
API Calls
There are no particular considerations for this template regarding API calls
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 one flow responsible of executing the logic.
For the purpose of this particular template the mainFlow just executes the Batch Job which handles all the logic of it.
This flow has Error Handling that basically consists on invoking the On Error Propagate Component defined in errorHandling.xml file.
endpoints.xml
This is the file where you will found the inbound and outbound sides of your integration app.
This Template has a HTTP Listener Connector as the way to trigger the use case.
Trigger Flow
HTTP Listener Connector - Start Report Generation
${http.port}is set as a property to be defined either on a property file or in CloudHub environment variables.The path configured by default is
migrateordersand you are free to change for the one you prefer.The host name for all endpoints in your CloudHub configuration should be defined as
localhost. CloudHub will then route requests from your application domain URL to the endpoint.
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.