martina-tutokiova-mulesoft / template-s4hana2sfdc-product-migration

Anypoint Template: SAP S/4HANA to Salesforce Product Migration

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.

Use Case

This Anypoint template serves as a foundation for setting an online sync of products from SAP S/4HANA to Salesforce.

Use this template if would like to sync products from SAP S/4HANA to Salesforce in manner of one time synchronization by browse toting the HTTP endpoint. The template will fetch all products by specified criteria and send it to Salesforce to create/update products 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.

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 SAP S/4HANA Products suitable for migration. Fetched products are passed to the batch as input. In the batch the product is fetched from Salesforce by its product code. If it exists, its product identifier is resolved against Salesforce. If it doesn't exist, then new product number is fetched from Salesforce. Afterwards every such product from SAP S/4HANA is sent to Salesforce where it is asynchronously updated or created. Finally during the On Complete stage the template logs output statistics data into the console and send 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, 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.

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 a SAP S/4HANA as a data origin.

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

Here's what you need to know about Salesforce 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:

• Download Anypoint Studio
• Download Mule runtime

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.env to the value dev.
• 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.env to the value dev.
• 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:

• Enabling Your Studio Project for SAP S/4HANA

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
• aggregator.size=10

Watermarking Default Last Query Timestamp e.g. 2019-12-13T03:00:59

• watermark.default.expression=2019-09-20T00:00:59

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 protected]
• smtp.password password

Email Details

• mail.from [email protected]
• mail.to [email protected]
• 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 file contains the endpoints for triggering the template and for retrieving the objects that meet the defined criteria in a query. You can execute a batch job process with the query results.

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.