FINS Salesforce Financial System API - Implementation Template
home
This API implementation template is a shared component of MuleSoft Accelerators, which accelerate the implementation of essential integration use cases.
The solution includes pre-built APIs, connectors, and integration templates that help unlock business-critical data from external systems and guide you in adopting best practices synthesized from thousands of customer implementations. Use these assets as is or extend them to meet your company’s unique needs.
Overview
This integration template implements the Salesforce Financial System API specification. It can be used to manage objects within Salesforce Financial Services Cloud.
Getting started
|
The Getting Started with MuleSoft Accelerators guide provides general information on getting started with the accelerator components. This includes instructions on setting up your local workstation for configuring and deploying the applications. |
Once your workstation has been set up and the application template imported into Anypoint Studio, proceed with the Prerequisites section.
Prerequisites
This implementation template has the following dependencies:
- Custom fields in Saleforce Financial Services Cloud
- Security token for service account user in Salesforce
- Connected App in Salesforce
Instructions to configure the above dependencies can be found in the Salesforce Financial Services Cloud setup guide.
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. In particular, make sure the common properties for your environment have been provided in the CloudHub-DEV profile (e.g., Anypoint Platform client ID and secret).
For additional details, please refer to the Application Deployment section of the Getting Started Guide.
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
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. At a minimum, the following properties must be customized to reflect the target deployment environment.
| Property Name | Description |
|---|---|
| sfdc.fsc.username | Username of the Salesforce service account |
| sfdc.fsc.password | Password for the Salesforce service account |
| sfdc.fsc.token | Security Token for the Salesforce service account |
| sfdc.fsc.client-id | The Consumer Id of the Connected App in Salesforce |
| sfdc.fsc.client-secret | The Consumer secret of the Connected App in Salesforce |
The following properties may need to be adjusted according to the configuration of the target Salesforce instance.
| Property Name | Description |
|---|---|
| sfdc.recordTypes.bankAccount | Name of the "Bank Account" FinancialAccount Record Type |
| sfdc.recordTypes.checkingAccount | Name of the "Checking Account" FinancialAccount Record Type |
| sfdc.recordTypes.savingsAccount | Name of the "Savings Account" FinancialAccount Record Type |
| sfdc.recordTypes.creditCardAccount | Name of the "Credit Card Account" FinancialAccount Record Type |
| sfdc.recordTypes.loanAccount | Name of the "Loan Account" FinancialAccount Record Type |
Additional resources
- The Data mappings tab describes how the request and response data structures are mapped between the API interface and Salesforce.
- Refer to the Accelerators documentation home for more information about the MuleSoft Accelerators.