Accelerator Global Financial Account 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-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 to reflect the target deployment environment.
Property Name | Description |
---|---|
api.autodiscoveryID | Required if using API Manager to secure this API |
sys.global-party.host | Accelerator Global Party System API Hostname |
sys.global-finacct.host | Accelerator Global Financial Account System API DB Hostname |
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.yaml
file 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
Arguments
tab and add the property definitions to theVM arguments
section. For example:-M-Dglobal.database.password=<provide password>
- 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.
- Update the
config-dev.yaml
properties as described above. You can also choose to add them to yoursettings.xml
file 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 how the request and response data structures are mapped between the API interface and the Global Data Service.