RCG Hyperforce 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 |
| hyperforce-system.get-token.host | Hostname of Salesforce Organization |
| hyperforce-system.get-token.path | Resource path |
| hyperforce-system.get-token.grant_type | Grant Type for token service |
| hyperforce-system.get-token.client_id | Consumer Key of Connected App |
| hyperforce-system.get-token.client_secret | Consumer Key of Connected App |
| hyperforce-system.get-token.username | Username |
| hyperforce-system.get-token.password | Password |
| hyperforce-system.generic.host | Hostname of third party integration url |
| hyperforce-system.trigger-export.path | Path for triggering export-job |
| hyperforce-system.get-export-status.path | Path for checking export status |
| hyperforce-system.get-file.host | Hostname of third party integration url |
| hyperforce-system.get-file.path | Path for retrieving file |
| hyperforce-system.commit-export-job.path | Path to commit export-job |
| condition-management.get-token.client_id | Consumer Key of Connected App |
| condition-management.get-token.client_secret | Consumer Key of Connected App |
| condition-management.get-token.username | Username |
| condition-management.get-token.password | Password |
Running the application from Anypoint Studio
The following instructions are for running applications from Studio but also apply to debugging.
- 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 step 2 instead.
Deployment instructions for CloudHub
The following instructions apply to CloudHub deployments only:
- Update the
config-dev.yamlproperties as described above. Or, add them to yoursettings.xmlfile instead. - Use one of the following scripts to deploy the application to CloudHub:
packageDeploy.sh(Mac/Linux) orpackageDeploy.cmd(Windows) - clean, build, and deploy the application.deployOnly.sh(Mac/Linux) ordeployOnly.cmd(Windows) - deploy an application built previously..
- Open the Runtime Manager console in Anypoint and monitor the application for proper startup.
Next steps
Visit the Data mappings tab describes how the request and response data structures are mapped between the API interface and Hyperforce System.