RCG Customers 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 |
| oms-system.host | oms-system HostName |
| oms-system.port | oms-system Port |
| oms-system.base-path-orders | oms-system Base path |
| oms-system.base-path-customers | oms-system Base path customers |
| anypoint-mq.server-url | Anypoint MQ URL where the message Exchange, Topics, queues have been created |
| anypoint-mq.client-id | Anypoint MQ Client Id to access messages from MQ |
| anypoint-mq.client-secret | Anypoint MQ Client Secret to access messages from MQ |
| mdm-sys.host | MDM System API HostName |
| mdm-sys.port | MDM System API Port |
| mdm-sys.base-path | MDM System API Base path |
| marketing-sys.host | Salesforce Marketing System API HostName |
| marketing-sys.port | Salesforce Marketing System API Port |
| marketing-sys.base-path | Salesforce Marketing System API Base path |
| salesforce-sys.host | Salesforce Customers System API HostName |
| salesforce-sys.port | Salesforce Customers System API Port |
| salesforce-sys.base-path | Salesforce Customers System API Base path |
| sap-sys.host | SAP ECC Customers System API HostName |
| sap-sys.port | SAP ECC Customers System API Port |
| sap-sys.base-path | SAP ECC Customers System API Base path |
| b2c-customer-sys.host | B2C Customers System API HostName |
| b2c-customer-sys.port | B2C Customers System API Port |
| b2c-customer-sys.base-path | B2C Customers System API Base path |
| customers-prc-api.http-client.client-id | Client Id provided for Customer Process API to interact with all System API's |
| customers-prc-api.http-client.client-secret | Client 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.
- 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.
Next steps
Visit the Data mappings tab to learn more about how the request and response data structures are mapped between the API interface.