SAP to Salesforce Product Material Migration

This template moves a large set of materials or products from SAP to Salesforce. You can trigger the application with an HTTP call either manually or programmatically. Products are upserted so that the migration can be run multiple times without worrying about creating duplicates. This template uses the Mule batch module to make moving a large set of data easier and more transparent.

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 template should serve as a foundation for setting an offline migration of materials and products from SAP to Salesforce.

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.

The integration is triggered by an HTTP Endpoint that receives the migration request. Then it retrieves all materials from SAP from specific date, transforms them into Salesforce products and passes them to the Batch process.

As implemented, this template leverages the Batch Module. The batch job is divided in Process and On Complete stages.

During the Process stage, in the first Step the template goes to Salesforce and query all the existing Products matching the ProductCode for each SAP Material. In the following step, the Product is upserted to Salesforce.

Finally during the On Complete stage the template outputs statistics data into the console and sends a notification email 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 SAP, that must be made for this template to run smoothly.

Failing to do so can 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.

Disclaimer

This 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 three extra dependencies for SAP to the pom.xml file.

SAP Considerations

Here's what you need to know to get this template to work with SAP.

As a Data Source

The SAP backend system is used as a source of data. The SAP connector is used to send and receive the data from the SAP backend. The connector can either use RFC calls of BAPI functions and/or IDoc messages for data exchange, and needs to be properly customized per the "Properties to Configure" section.

This template uses custom BAPI functions. To create these:

1. Create structure ZMMST_ENH_MARA in transaction SE11 as per its definition in file structure_ZMMST_ENH_MARA.abap
2. Create table type ZMMTTY_ENH_MARA in transaction SE11 as per its definition in file table_type_ZMMTTY_ENH_MARA.abap
3. Create message class called ZMC_ENGTEMPLATES in transaction SE91 as per definition in file message_class_ZMC_ENGTEMPLATES.abap
4. Create function module ZMMFM_MATERIAL_GETLIST in transaction SE37 as per source file ZMMFM_MATERIAL_GETLIST.abap

Referenced files are in src/main/resources directory.

Salesforce Considerations

• 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 Destination

There are no considerations with using Salesforce as a data destination.

Run it!

Simple steps to get SAP to Salesforce Material Migration running.

Running On Premises

In this section we help you run your template on your computer.

Where to Download Anypoint Studio and the Mule Runtime

If you are a newcomer to Mule, here is where to get the tools.

• Download Anypoint Studio
• Download Mule runtime

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:

1. Locate the properties file mule.dev.properties, in src/main/resources.
2. Complete all the properties required per the examples in the "Properties to Configure" section.
3. Right click the template project folder.
4. Hover your mouse over Run as.
5. Click Mule Application (configure).
6. Inside the dialog, select Environment and set the variable mule.env to the value dev.
7. Click Run.

For this template to run in Anypoint Studio, you need to install SAP libraries. See Install SAP Libraries.

Running on Mule Standalone

Complete all properties in one of the property files, for example in mule.prod.properties and run your app with the corresponding environment variable. To follow the example, use mule.env=prod.

Running on CloudHub

While creating your application on CloudHub (or you can do it later as a next step), go to Runtime Manager > Manage Application > Properties to set the environment variables listed in "Properties to Configure" as well as the mule.env.

Deploying your Template on 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 (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

HTTP Connector Configuration

• http.port 9090

Batch Aggregator Configuration

• page.size 100

Watermarking default last query timestamp for example 2019-12-13T03:00:59Z

• watermark.default.expression 2019-03-07T09:38:00.000Z

SAP Connector Configuration

• sap.jco.ashost your.sap.address.com
• sap.jco.user SAP_USER
• sap.jco.passwd SAP_PASS
• sap.jco.sysnr 14
• sap.jco.client 800
• sap.jco.lang EN

SalesForce Connector Configuration

• sfdc.username bob.dylan@sfdc
• sfdc.password DylanPassword123
• sfdc.securityToken avsfwCUl7apQs56Xq2AKi3X

SMTP Services Configuration

• smtp.host smtp.gmail.com
• smtp.port 587
• smtp.user your%40email.com
• smtp.password password

Email Details

• mail.from your@email.com
• mail.to your@email.com
• mail.subject SAP2SFDC Material Migration Batch Report

API Calls

Salesforce imposes limits on the number of API calls that can be made. Therefore calculating this amount may be an important factor to consider. The template calls to the API can be calculated using the formula:

• 1 + X + X / ${page.size} -- Where ${page.size} is the number of products or materials to synchronize on each run.

• Divide by ${page.size} because by default, products and materials are gathered in groups of ${page.size} 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 12 API calls are made (1 + 10 + 1).

Customize It!

This brief guide intends to give a high level idea 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

Configuration for connectors and configuration properties are set in this file. Even change the configuration here, all parameters that can be modified are in properties file, which is the recommended place to make your changes. However if you want to do core changes to the logic, you need to modify this file.

In the Studio visual editor, the properties are on the Global Element tab.

businessLogic.xml

Functional aspect of the template is implemented on this XML, directed by a batch job that is responsible for creations/updates. The several message processors constitute four high level actions that fully implement the logic of this template :

1. Job execution is invoked from triggerFlow (endpoints.xml).
2. During the Process stage, each Material is filtered depending on, if it has an existing matching Product 2 in the Salesforce instance. The matching is performed by querying a Salesforce instance for an entry with the given ProductCode.
3. The next step inserts a new record into the Salesforce instance if there was none found in the previous step or update the existing one.

Finally during the On Complete stage the template logs output statistics data into the console and send a notification email with the results.

endpoints.xml

This file provides the inbound and outbound sides of your integration app. This template has an 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 migrate-materials and 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 then routes 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.