Salesforce to SAP Opportunity Migration
home
This template moves a large set of opportunities from Salesforce to SAP. Trigger with an HTTP call either manually or programmatically.
Opportunities 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 Anypoint template serves as a foundation for setting a migration of won opportunities from Salesforce to sales orders in SAP.
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 in Process and On Complete stages. The integration is triggered by the HTTP Listener to fetch all Salesforce won opportunities with assigned Account suitable for migration. In the batch the sales order is fetched from SAP by its purchase order number equal to opportunity ID. If it exists, more sales order details are fetched from SAP. In next batch step customer is looked up by opportunity account name if sync policy is set to synchronize accounts. If the customer is found its sales areas are fetched from SAP and first one is selected to be used in sales order creation. If it is not found, then new customer is created with preconfigured sales area.
This template doesn't support changing a customer in an existing sales order.
The next batch step executes only if a preconfigured (dummy) account is configured to be used. In that step also preconfigured sales area and customer number are set up. Account synchronization policy must be either syncAccount or assignDummyAccount. Sales order creation fails if it has no account (ship to) assigned. The next two steps create or update the sales order in SAP. Finally during the On Complete stage the template sends an email and logs output statistics data to the console.
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 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 Anypoint template uses a few private Maven dependencies from MuleSoft in order to work. If you intend to run this template with Maven support, you need to add extra dependencies for SAP in the pom.xml file.
SAP Considerations
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.
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 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'
]
]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 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.
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 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
HTTP Connector Configuration
- http.port
9090
SalesForce Connector Configuration
- sfdc.username
bob.dylan@sfdc - sfdc.password
DylanPassword123 - sfdc.securityToken
avsfwCUl7apQs56Xq2AKi3X
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 - account.sync.policy
syncAccount - account.sapCustomerNumber
0000001175 - account.sapSalesOrganization
3020 - account.sapDistributionChannel
30 - account.sapDivision
00 - account.sapRefCustomer
0000000255
SMTP Services Configuration
- smtp.host
smtp.gmail.com - smtp.port
587 - smtp.user
gmailuser - smtp.password
gmailpassword
Email details
- mail.from
your.email@gmail.com - mail.to
your.email@gmail.com - mail.subject
Mail subject
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 uses a batch job, which handles all the logic of it.
endpoints.xml
This file provides the inbound and outbound sides of your integration app.
This Template has only an HTTP Listener as the way to trigger the use case.
Inbound 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
migrateopportunitiesand 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. - The endpoint is a request-response since as a result of calling it the response will be the total of Opportunities synced and filtered by the criteria specified.
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.