RCG Orders 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
anypoint-mq.orders-queue-nameAnypoint-mq Orders Update Queue Name
anypoint-mq.server-urlAnypoint-mq server host url
anypoint-mq.orders-dl-queue-nameAnypoint-mq Orders Dead Letter Queue Name
anypoint-mq.orders-status-queue-nameAnypoint-mq Orders Status Queue Name
anypoint-mq.orders-status-dl-queue-nameAnypoint-mq Orders Status Dead Letter Queue Name
anypoint-mq.client-idAnypoint-mq client id
anypoint-mq.client-secretAnypoint-mq client secret
oms-sys-api.hostoms-system HostName
oms-sys-api.portoms-system Port
oms-sys-api.base-pathoms-system Base path
mdm-sys.hostMDM System API HostName
mdm-sys.portMDM System API Port
mdm-sys.base-pathMDM System API Base path
salesforce-orders-sys-api.hostSalesforce Orders System API HostName
salesforce-orders-sys-api.portSalesforce Orders System API Port
salesforce-orders-sys-api.base-pathSalesforce Orders System API Base path
erp-orders-prc-api.hostERP Orders Process API HostName
erp-orders-prc-api.portERP Orders Process API Port
erp-orders-prc-api.base-pathERP Orders Process API Base path
commercecloud-sys-api.hostB2C Commerce System API HostName
commercecloud-sys-api.portB2C Commerce System API Port
commercecloud-sys-api.base-pathB2C Commerce System API Base path
orders-prc-api.http-client.client-idClient Id provided for Orders Process API to interact with all System API's
orders-prc-api.http-client.client-secretClient Secret provided for Orders 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.

Deployment instructions for CloudHub

The following instructions apply to CloudHub deployments only.

  1. Update the config-dev.yaml properties as described above. You can also choose to add them to your settings.xml file instead.
  2. Use one of the following scripts to deploy application to CloudHub:
    • packageDeploy.sh (Mac/Linux) or packageDeploy.cmd (Windows) - clean, build, and deploy the application
    • deployOnly.sh (Mac/Linux) or deployOnly.cmd (Windows) - deploy a previously-built application
  3. Bring up the Runtime Manager console in Anypoint and monitor the application for proper startup.

Next steps

Visit the Data mappings tab describes the mappings if any specific to interact with other system APIs.


Published by
MuleSoft Solutions
Published onSep 30, 2022
Asset overview

Asset versions for 2.2.x

Asset versions