RCG B2C Customers System 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 |
| b2c-commerce-sys-api.host | Headless cc API Instance Hostname |
| b2c-commerce-sys-api.port | Headless cc API Instance Port |
| b2c-commerce-sys-api.uri | Headless cc API URI |
| b2c-commerce-sys-api.shortCode | Headless cc API Instance ShortCode |
| b2c-commerce-sys-api.siteId | Headless cc API Instance SiteId of the referring site |
| b2c-commerce-sys-api.version | Headless cc API Instance version |
| b2c-commerce-sys-api.organizationId | Headless cc API Instance OrganizationId |
| b2c-commerce-sys-api.scope | Headless cc API Instance scope value |
| b2c-commerce-sys-api.clientId | ID of the client account created with Salesforce Commerce |
| b2c-commerce-sys-api.clientSecret | Secret of the client account created with Salesforce Commerce |
| b2c-commerce-sys-api.tokenUri | Access token URL |
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 describes how the request and response data structures are mapped between the API interface and the B2C Commerce System.