Accelerator Salesforce Financial Account Event Listener - Implementation Template

This API implementation template is a 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

The following functionality is supported by the Salesforce Financial Account Event Listener application.

Financial account event listener

This event listener is subscribed to the Platform Event channel configured in Salesforce with API Name as FinancialAccounte. A Trigger generates an Event based on changes to Accounts in FinServFinancialAccount__c Object. The trigger filters records based on LastModifiedBy <> Service Account User ID to avoid cyclical updates.

The fields in the Platform Event include financial account information. These fields are received as JSON Objects from Salesforce and transformed to CIM data type (Accounts) and published to Anypoint MQ. In case of any failure the incoming original payload is published to the dead letter queue by the exception handler.

Transactions event listener

This event listener is subscribed to the Platform Event channel configured in Salesforce with API Name as FinancialAccountTransactione. A Trigger generates an Event based on changes to Transactions in FinServFinancialAccountTransaction__c Object. The trigger filters records based on LastModifiedBy <> Service Account User ID to avoid cyclical updates.

The fields in the Platform Event include financial transaction information. These fields are received as JSON Objects from Salesforce and transformed to CIM data type (Accounts) and published to Anypoint MQ. In case of any failure the incoming original payload is published to the dead letter queue by the exception handler.

Cards event listener

This event listener is subscribed to the Platform Event channel configured in Salesforce with API Name as FinancialAccountTransactione. A Trigger generates an Event based on changes to cards in FinServCard__c Object. The trigger filters records based on LastModifiedBy <> Service Account User ID to avoid cyclical updates.

The fields in the Platform Event include cards information. These fields are received as JSON Objects from Salesforce and transformed to CIM data type (Accounts) and published to Anypoint MQ. In case of any failure the incoming original payload is published to the dead letter queue by the exception handler.

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:

• Anypoint MQ Destinations
• Salesforce Platform Events
• Salesforce Apex Triggers

Please review the use cases described on the MuleSoft Accelerators solution pages for more information about dependencies on other APIs and services.

Anypoint MQ destinations

In addition to the Anypoint MQ client application credentials, the following destinations must be created and made accessible to this API:

1. accel-account-update-exchange
2. accel-account-update-dl-queue
3. accel-transaction-update-exchange
4. accel-transaction-update-dl-queue
5. accel-card-update-exchange
6. accel-card-update-dl-queue

Salesforce Platform Events

This implementation requires creation of Platform Events in Salesforce. To create a Platform event Object following the below steps:

1. Login to Salesforce.
2. Click Setup to search for Platform Events in Quick Find Box. Platform Events Page under Integrations section appears with list of available Platform Events.
3. Click New Platform Event button to create an Object and enter Platform Information Details fields like Label, Plural Label and Object. Click Save.
4. Enter Custom Fields & RelationShips to create Event with specific defintions.

Platform Event Definition for Financial Account PlatformEvent

Create a Platform Event with Label as FinancialAccountPlatformEvent, Object as FinancialAccount and Custom Fields & RelationShips as per below table. These Custom fields can also be created via apex script and the instructions are included in Create Custom Fields via Apex script section below.

Platform Event Definition for Financial Account Transaction PlatformEvent

Create a Platform Event with Label as FinancialAccountTransactionPlatformEvent, Object as FinancialAccountTransaction, and Custom Fields & RelationShips as per below table. These Custom fields can also be created via Apex script - instructions are included in the "Create Custom Fields via Apex script section", below.

Platform Event Definition for Financial Card PlatformEvent

Create a Platform Event with Label as FinancialCardPlatformEvent, Object as FinancialCard and Custom Fields & RelationShips as per below table. As mentioned above, these Custom fields can also be created via Apex script.

Create Custom Fields via Apex script

An Apex class called CustomFieldUtility can be used to create custom fields programmatically. The source for this class can be found in the Common Resources project. Download this project and follow the steps below.

1. Click on Salesforce Setup icon and select Developer Console to open a new console window
2. Go to File -> New -> Apex class and create a new class named CustomFieldUtility
3. Copy the code from accelerator-common-resources/salesforce/CustomFieldUtility.apxc to the script editor
4. Select the File -> Save menu option to compile and save the class
5. Select Debug -> Open Execute Anonymous Window
6. Copy and paste the contents of accelerator-common-resources/salesforce/CreatePlatformEventsCustomFields.txt into the window.
7. Enable the Open Log option and click the Execute button.

Once the script completes, select the Debug Only filter option to show just the results of each create request. Verify that all fields have been successfully created.

Note: Do not execute all the content in the CreatePlatformEventsCustomFields.txt file at once as the console might throw a timeout error. Instead execute it in batches.

Salesforce Apex Triggers

This implementation requires creation of Apex Triggers for the Platform Events to be generated on changes to records in Salesforce.

Follow the below steps to create the Apex Triggers:

1. Login to Salesforce.
2. Click Setup to search for Object Manager in Quick Find Box.
3. Search for the Salesforce Object. A page appears with Details of the Object.
4. Click Triggers unders the Details section to see list of available triggers on the Object. Click New.
5. Copy the Script from the location specified in the above table .
6. Obtain the LastModifiedById and RecordTypeId (if it exists) by running the queries mentioned in the trigger from Developer Console.
7. Replace the values in the script and Save the trigger
8. Repeat the steps for all the Salesforce objects in the above table

Additional notes:

• All the Apex Triggers created above filters records based on LastModifiedBy <> {Service account ID}. This is to filter out updates done by the Salesforce Customers and Salesforce Financial System APIs to avoid cyclical updates. This can be obtained by running the query SELECT Id FROM User WHERE Username='<service-account-username>' in the Developer Console.

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.

For additional details, please refer to the Application Deployment section of the Getting Started Guide.

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.

Implementation notes

1. The fields 'Account Holder', 'Card Type', 'Financial Account', and 'Cardholder Name' are optional in FSC. For the cards sync process, these fields are mandatory for syncing to all downstream APIs.
2. The Mule idempotent message validator is used to ensure that only unique messages are published to Anypoint MQ. The Salesforce ID with an expiration interval and time-to-live (ttl) of 30 seconds (configurable) is used as the unique ID to filter out duplicate Mule messages.
3. The current implementation does not support replay of Platform Events that were missed when the Mule application is down.

Additional resources

• The Data mappings tab describes how the request and response data structures are mapped between the API interfaces.
• Refer to the Accelerators documentation home for more information about the MuleSoft Accelerators.