MFG Customers Process API - Implementation Template
home
This asset is a component of the MuleSoft Accelerator for Manufacturing, which accelerates the implementation of essential integration use cases.
The solution unlocks rich data between SAP, Salesforce Manufacturing Cloud, Salesforce Rebate Management, OSIsoft PI System, Amazon Redshift, Tableau, and Salesforce Service Cloud with pre-built APIs, templates, reference architecture, and additional technical assets for manufacturing companies. Our foundational assets are expertly designed to jumpstart your top integration and business initiatives so that IT teams can spend more time innovating and less time building from scratch.
Overview
This integration template implements the MFG Customers Process API specification.
The Customers Process API orchestrates the customer creation and update from SAP S/4HANA and Salesforce Manufacturing Cloud. A unique GUID is generated to identify a Customer/Individual across all systems. This API uses the Cloud Information Model to interact with each of the System APIs that have been developed for Manufacturing Cloud Customer Sync use case.
Getting started
|
The Getting Started with MuleSoft Accelerators guide provides general information on getting started with the accelerator components. This includes instructions on setting up your local workstation for configuring and deploying the applications. |
Once your workstation has been set up and the application template imported into Anypoint Studio, proceed with the Prerequisites section.
Prerequisites
This implementation template has the following dependencies:
- Anypoint MQ Destinations
- MFG Salesforce Customers System API
- RCG SAP S/4 HANA Customers System API
- Object Store configuration for Customers
Please review the use cases described on the MuleSoft Accelerator for Manufacturing solution pages for more information about dependencies on other APIs and services.
Anypoint MQ destinations
In addition to the Anypoint MQ client application credentials, the following destinations must be created and made accessible to this API:
- mfg-customer-update-queue
- mfg-customer-update-queue-dlq
API dependencies
The following table lists all endpoints used by this API (assuming all synchronisation targets are enabled).
| API name | Endpoint | Action |
|---|---|---|
| MFG Salesforce Customers System API | get:/customers | Search for an existing customer |
| MFG Salesforce Customers System API | post:/customers | Create a new customer |
| MFG Salesforce Customers System API | patch:/customers/{customerId} | Update an existing customer |
| MFG SAP S/4 HANA Customers System API | get:/customers | Search for an existing customer |
| MFG SAP S/4 HANA Customers System API | post:/customers | Create a new customer |
| MFG SAP S/4 HANA Customers System API | patch:/customers/{customerId} | Update an existing customer |
Deployment
Each Accelerator implementation template in Exchange includes Bash and Windows scripts for building and deploying the APIs to CloudHub. These scripts depend on repositories, global settings, deployment profiles, and associated properties configured in the Maven settings.xml file. In particular, make sure the common properties for your environment have been provided in the CloudHub-DEV profile (e.g., Anypoint Platform client ID and secret).
For additional details, please refer to the Application Deployment section of the Getting Started Guide.
Required property overrides
Many templates can also be run from Anypoint Studio without having to customize the Run/Debug profiles. However, some templates make use of hidden deployment properties to protect sensitive information (e.g., passwords and secret keys). These properties must be supplied to the runtime by updating the configuration profile and adding them as VM arguments. At a minimum, the following properties must be customized to reflect the target deployment environment.
| Property Name | Description |
|---|---|
| api.autodiscoveryID | Required if using API Manager to secure this API |
| anypoint-mq.server-url | Anypoint MQ URL where the message Exchange, Topics, queues have been created |
| anypoint-mq.client-id | Anypoint MQ Client Id to access messages from MQ |
| anypoint-mq.client-secret | Anypoint MQ Client Secret to access messages from MQ |
| salesforce-customer-sys.host | MFG Salesforce Customers System API HostName |
| salesforce-customer-sys.port | MFG Salesforce Customers System API Port |
| salesforce-customer-sys.base-path | MFG Salesforce Customers System API Base path |
| saphana-customer-sys.host | MFG SAP Hana Customers System API HostName |
| saphana-customer-sys.port | MFG SAP Hana Customers System API Port |
| saphana-customer-sys.base-path | MFG SAP Hana Customers System API Base path |
| customers-prc-api.http-client.client-id | Client Id provided for MFG Customer Process API to interact with all System API's |
| customers-prc-api.http-client.client-secret | Client Secret provided for MFG Customer Process API to interact with all System API's |
Additional resources
- The Data mappings tab describes the mappings if any specific to interact with other system APIs.
- Refer to the Accelerators documentation home for more information about the MuleSoft Accelerators.