FINS 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-FINS-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 |
| 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 |
| global-party-prc.host | Accelerator Global Party Process API Hostname |
| global-party-prc.port | Accelerator Global Party Process API Port |
| global-party-prc.base-path | Accelerator Global Party Process API Base path |
| salesforce-fsc-banking-sys.host | Hostname of FINS Salesforce Customers System API that is pointing to FSC Banking |
| salesforce-fsc-banking-sys.port | Port of FINS Salesforce Customers System API that is pointing to FSC Banking |
| salesforce-fsc-banking-sys.base-path | Base Path of FINS Salesforce Customers System API that is pointing to FSC Banking |
| salesforce-fsc-banking-sys.enabled | Flag to enable or disable sync to FINS Salesforce Customers System API that is pointing to FSC Banking |
| salesforce-fsc-insurance-sys.host | Hostname of FINS Salesforce Customers System API that is pointing to FSC Insurance |
| salesforce-fsc-insurance-sys.port | Port of FINS Salesforce Customers System API that is pointing to FSC Insurance |
| salesforce-fsc-insurance-sys.base-path | Base Path of FINS Salesforce Customers System API that is pointing to FSC Insurance |
| salesforce-fsc-insurance-sys.enabled | Flag to enable or disable sync to FINS Salesforce Customers System API that is pointing to FSC Insurance |
| salesforce-fsc-wealth-sys.host | Hostname of FINS Salesforce Customers System API that is pointing to FSC Wealth |
| salesforce-fsc-wealth-sys.port | Port of FINS Salesforce Customers System API that is pointing to FSC Wealth |
| salesforce-fsc-wealth-sys.base-path | Base Path of FINS Salesforce Customers System API that is pointing to FSC Wealth |
| salesforce-fsc-wealth-sys.enabled | Flag to enable or disable sync to FINS Salesforce Customers System API that is pointing to FSC Wealth |
| core-banking-sys.host | FINS Core Banking Customers System API Hostname |
| core-banking-sys.port | FINS Core Banking Customers System API Port |
| core-banking-sys.base-path | FINS Core Banking Customers System API Base path |
| core-banking-sys.enabled | Flag to enable or disable sync to FINS Core Banking Customers System API |
| los-sys.host | Loan Origination System API Hostname |
| los-sys.port | Loan Origination System API Port |
| los-sys.base-path | Loan Origination System API Base path |
| los-sys.enabled | Flag to enable or disable sync to Loan Origination System API |
| marketing-sys.host | FINS Salesforce Marketing System API Hostname |
| marketing-sys.port | FINS Salesforce Marketing System API Port |
| marketing-sys.base-path | FINS Salesforce Marketing System API path |
| marketing-sys.enabled | Flag to enable or disable sync to FINS Salesforce Marketing System API |
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.server-url=<server url> -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.