MFG Customers Process API - Implementation Template

(0 reviews)

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

bulb.png 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:

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:

  1. mfg-customer-update-queue
  2. mfg-customer-update-queue-dlq

API dependencies

The following table lists all endpoints used by this API (assuming all synchronisation targets are enabled).

API nameEndpointAction
MFG Salesforce Customers System APIget:/customersSearch for an existing customer
MFG Salesforce Customers System APIpost:/customersCreate a new customer
MFG Salesforce Customers System APIpatch:/customers/{customerId}Update an existing customer
MFG SAP S/4 HANA Customers System APIget:/customersSearch for an existing customer
MFG SAP S/4 HANA Customers System APIpost:/customersCreate a new customer
MFG SAP S/4 HANA Customers System APIpatch:/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 NameDescription
api.autodiscoveryIDRequired if using API Manager to secure this API
anypoint-mq.server-urlAnypoint MQ URL where the message Exchange, Topics, queues have been created
anypoint-mq.client-idAnypoint MQ Client Id to access messages from MQ
anypoint-mq.client-secretAnypoint MQ Client Secret to access messages from MQ
salesforce-customer-sys.hostMFG Salesforce Customers System API HostName
salesforce-customer-sys.portMFG Salesforce Customers System API Port
salesforce-customer-sys.base-pathMFG Salesforce Customers System API Base path
saphana-customer-sys.hostMFG SAP Hana Customers System API HostName
saphana-customer-sys.portMFG SAP Hana Customers System API Port
saphana-customer-sys.base-pathMFG SAP Hana Customers System API Base path
customers-prc-api.http-client.client-idClient Id provided for MFG Customer Process API to interact with all System API's
customers-prc-api.http-client.client-secretClient Secret provided for MFG Customer Process API to interact with all System API's

Additional resources


Reviews

TypeTemplate
OrganizationMuleSoft
Published by
MuleSoft Solutions
Published onOct 25, 2023
Asset overview

Asset versions for 2.2.x

Asset versions
VersionActions
2.2.4
2.2.3
2.2.2