RCG Customers Process API - Implementation Template

(0 reviews)


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.

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.


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

At a minimum, the following properties must be customized for this application 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

Running the application from Anypoint Studio

The following instructions are for running applications from Studio but apply to debugging as well.

  1. Update the src/main/resources/config/config-local.yaml file and provide values for the properties described above.
  2. Right-click the project and select Run As -> Mule Application (configure)
  3. If hidden deployment properties (e.g., Anypoint MQ credentials) are required, select the Arguments tab and add the property definitions to the VM arguments section. For example:
     -M-Danypoint-mq.client-id=<client id> -M-Danypoint-mq.client-secret=<client secret>
  4. Click Run to launch the application.

To debug an application, choose Debug As -> Mule Application (configure) in the second step instead.

Next steps

Visit the Data mappings tab to learn more about how the request and response data structures are mapped between the API interface.


Published by
MuleSoft Solutions
Published onSep 17, 2022
Asset overview

Asset versions for 2.6.x

Asset versions