FINS Salesforce Data Cloud System API - Implementation Template

This asset is a component of the MuleSoft Accelerator for Financial Services, which accelerates the implementation of essential integration use cases.

The solution boosts time-to-value in your customer 360 initiatives with pre-built APIs, templates, and reference architectures for financial services. Our foundational assets are expertly designed to jumpstart your top integration and business initiatives so that IT teams can spend more time innovating and less time building from scratch.

---

Overview

This integration template implements the FINS Salesforce Data Cloud System API specification. It is used to push financial accounts, transactions, external accounts, and web engagements to Salesforce Data Cloud.

This API uses the Streaming Insert Objects Operation in MuleSoft Salesforce CDP Connector to insert objects in to Salesforce Data Cloud.

Note: The Ingestion APIs must be created in Salesforce Data Cloud, and the appropriate Data Streams configured, before invoking the endpoints of this API.

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 assumes that the Salesforce Data Cloud has been set up to establish connection between Salesforce Data Cloud instance and Salesforce Data Cloud System API. It has the following dependencies:

• Data Cloud provisioning
• Setup Ingestion API connector in Salesforce Data Cloud
• Sample schema can be found at src/test/resources/cdp-schema/mule-cdp-connector-schema.yaml
• Create Ingestion API Data Stream for the required objects
• Create connected app in Salesforce Data Cloud instance and select the required Oauth scopes
• Configure Salesforce CDP connector in Salesforce Data Cloud System API

Instructions to configure the above dependencies can be found in the Salesforce Data 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

At a minimum, the following properties must be customized to reflect the target deployment environment.

Additional resources

• The Data mappings tab describes the mappings.
• Refer to the Accelerators documentation home for more information about the MuleSoft Accelerators.