RCG Customers Process API - Implementation Template

(0 reviews)
Component of MuleSoft Accelerator for Salesforce Clouds

home

This API implementation template is a component of the MuleSoft Accelerator for Retail, which accelerate the implementation of essential integration use cases.

The solution includes pre-built APIs, connectors, and integration templates that help unlock business-critical data from external systems and guide you in adopting best practices synthesized from thousands of customer implementations. Use these assets as is or extend them to meet your company’s unique needs.


Overview

This integration template implements the RCG Customers Process API specification. It can be used to retrieve, create, and update Customers.

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 Retail and MuleSoft Accelerator for Consumer Goods solution pages for more information about dependencies on other APIs and services.

API dependencies

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

API nameEndpointAction
RCG MDM System APIget:/individualsSearch a individual party
RCG MDM System APIget:/customersSearch a customer party role
RCG MDM System APIget:/organizationsSearch an organization party
RCG MDM System APIpost:/individualsCreate a new individual party
RCG MDM System APIpost:/customersCreate a new customer party role
RCG MDM System APIpost:/organizationsCreate a new organization party
RCG MDM System APIpost:/parties/{partyId}/contactPointsCreate contact points for a party
RCG MDM System APIput:/parties/{partyId}/contactPointsUpdate contact points for a party
RCG MDM System APIput:/parties/{partyId}/externalIdsUpdate external IDs for a party
RCG MDM System APIpatch:/individuals/{individualId}Update an existing individual party
RCG MDM System APIpatch:/customers/{customerId}Update an existing customer party role
RCG MDM System APIput:/partyRoles/{partyRoleId}/externalIdsUpdate external IDs for a party role
RCG MDM System APIpatch:/organizations/{organizationId}Update an existing organization party
RCG MDM System APIget:/individuals/{individualId}Retrieve an existing individual party
RCG MDM System APIget:/customers/{customerId}Retrieve an existing customer party role
RCG MDM System APIget:/organizations/{organizationId}Retrieve an existing organization party
RCG MDM System APIget:/partyRoles/{partyRoleId}/externalIdsget external IDs for a party role
Accelerator Salesforce Customers System APIget:/customersSearch for an existing customer
Accelerator Salesforce Customers System APIpost:/customersCreate a new customer
Accelerator Salesforce Customers System APIpatch:/customers/{customerId}Update an existing customer
Accelerator Salesforce Marketing System APIget:/subscribersSearch for an existing subscriber or individual party
Accelerator Salesforce Marketing System APIpost:/subscribersCreate a new subscriber or individual party
Accelerator Salesforce Marketing System APIpatch:/subscribers/{subscriberId}Update an existing subscriber or individual party
Accelerator ERP Customers Process APIput:/customersCreate or update customers in ERP systems
RCG SAP S/4 HANA Customers System APIget:/customersSearch for an existing customer
RCG SAP S/4 HANA Customers System APIpost:/customersCreate a new customer
RCG SAP S/4 HANA Customers System APIpatch:/customers/{customerId}Update an existing customer
Accelerator B2C Customers System APIget:/customersSearch for an existing customer
Accelerator B2C Customers System APIpost:/customersCreate a new customer
Accelerator B2C Customers System APIpatch:/customers/{customerId}Update an existing customer
Accelerator OFBiz Customers System APIget:/customersSearch for an existing customer
Accelerator OFBiz Customers System APIpost:/customersCreate a new customer
Accelerator OFBiz Customers System APIpatch:/customers/{customerId}Update an existing customer
RCG Salesforce Consumer Goods Cloud System APIpost:/customersCreate a new customer

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. rcg-customer-update-retail-queue
  2. rcg-customer-update-retail-dl-queue
  3. rcg-individual-update-retail-queue
  4. rcg-individual-update-retail-dl-queue

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.

Preparation

Ensure the Maven profile CloudHub-RCG-DEV has been properly configured in your settings.xml file. In particular, make sure the common properties for your environment have been provided (e.g., Anypoint Platform client ID and secret).

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
oms-system.hostoms-system HostName
oms-system.portoms-system Port
oms-system.base-path-ordersoms-system Base path
oms-system.base-path-customersoms-system Base path customers
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
mdm-sys.hostMDM System API HostName
mdm-sys.portMDM System API Port
mdm-sys.base-pathMDM System API Base path
marketing-sys.hostSalesforce Marketing System API HostName
marketing-sys.portSalesforce Marketing System API Port
marketing-sys.base-pathSalesforce Marketing System API Base path
salesforce-sys.hostSalesforce Customers System API HostName
salesforce-sys.portSalesforce Customers System API Port
salesforce-sys.base-pathSalesforce Customers System API Base path
sap-sys.hostSAP ECC Customers System API HostName
sap-sys.portSAP ECC Customers System API Port
sap-sys.base-pathSAP ECC Customers System API Base path
b2c-customer-sys.hostB2C Customers System API HostName
b2c-customer-sys.portB2C Customers System API Port
b2c-customer-sys.base-pathB2C Customers System API Base path
customers-prc-api.http-client.client-idClient Id provided for Customer Process API to interact with all System API's
customers-prc-api.http-client.client-secretClient Secret provided for Customer Process API to interact with all System API's

Additional resources


Reviews

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

Asset versions for 2.6.x

Asset versions
VersionActions
2.6.7
2.6.3
2.6.1
2.6.0