RCG Orders Process API - Implementation Template
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.
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.
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
At a minimum, the following properties must be customized for this application to reflect the target deployment environment.
| Property Name | Description |
|---|---|
| api.autodiscoveryID | Required if using API Manager to secure this API |
| anypoint-mq.orders-queue-name | Anypoint-mq Orders Update Queue Name |
| anypoint-mq.server-url | Anypoint-mq server host url |
| anypoint-mq.orders-dl-queue-name | Anypoint-mq Orders Dead Letter Queue Name |
| anypoint-mq.orders-status-queue-name | Anypoint-mq Orders Status Queue Name |
| anypoint-mq.orders-status-dl-queue-name | Anypoint-mq Orders Status Dead Letter Queue Name |
| anypoint-mq.client-id | Anypoint-mq client id |
| anypoint-mq.client-secret | Anypoint-mq client secret |
| oms-sys-api.host | oms-system HostName |
| oms-sys-api.port | oms-system Port |
| oms-sys-api.base-path | oms-system Base path |
| mdm-sys.host | MDM System API HostName |
| mdm-sys.port | MDM System API Port |
| mdm-sys.base-path | MDM System API Base path |
| salesforce-orders-sys-api.host | Salesforce Orders System API HostName |
| salesforce-orders-sys-api.port | Salesforce Orders System API Port |
| salesforce-orders-sys-api.base-path | Salesforce Orders System API Base path |
| erp-orders-prc-api.host | ERP Orders Process API HostName |
| erp-orders-prc-api.port | ERP Orders Process API Port |
| erp-orders-prc-api.base-path | ERP Orders Process API Base path |
| commercecloud-sys-api.host | B2C Commerce System API HostName |
| commercecloud-sys-api.port | B2C Commerce System API Port |
| commercecloud-sys-api.base-path | B2C Commerce System API Base path |
| orders-prc-api.http-client.client-id | Client Id provided for Orders Process API to interact with all System API's |
| orders-prc-api.http-client.client-secret | Client 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.
- Update the
src/main/resources/config/config-local.yamlfile and provide values for the properties described above. - Right-click the project and select
Run As -> Mule Application (configure) - If hidden deployment properties (e.g., Anypoint MQ credentials) are required, select the
Argumentstab and add the property definitions to theVM argumentssection. For example:-M-Danypoint-mq.client-id=<client id> -M-Danypoint-mq.client-secret=<client secret> - Click
Runto 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.
- Update the
config-dev.yamlproperties as described above. You can also choose to add them to yoursettings.xmlfile instead. - Use one of the following scripts to deploy application to CloudHub:
packageDeploy.sh(Mac/Linux) orpackageDeploy.cmd(Windows) - clean, build, and deploy the applicationdeployOnly.sh(Mac/Linux) ordeployOnly.cmd(Windows) - deploy a previously-built application
- 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.