Exception Handling in Salesforce Flow

Your flow may fail if it includes an element that interacts with the Salesforce database, such as an Update Records element, or a Submit for Approval core action. How do you handle errors in Salesforce Flow?

In this article, I’ll go over some exception handling techniques for both screen flow and auto-launched flow.

Advertisements

✷ What happens when a Flow fails?

When a flow fails, the user who is running it receives this error message.

An unhandled fault has occurred in this flow
An unhandled fault has occurred while processing 
the flow. Please contact your system administrator 
for more information.

The running user is unable to continue with the flow or return to a previous section of the flow. A fault email is sent to the admin who created the flow. The email describes the failed element, the error message, and which elements were executed during the failed interview.

Error element Assign_fields_values (FlowAssignment).
Flow encountered an error when processing and converting between data types. Please check the flow and ensure all data types are matched correctly.

The above flow error message indicates that an assignment element was used to insert a value into a field, but the values were not assigned based on the data type of the field. For example, you are not putting the correct record ID in the lookup field.

An error occurred at element Delete_1.
DELETE --- There is nothing in Salesforce matching your 
delete criteria.

In the preceding example, a Delete Record element in a Flow causes an error if no records matching the selection criteria are found.

↠ Salesforce publishes a Flow Execution Error Event platform event message for screen flows.

How to handle errors in Screen Flow ?

To change the default behavior of flow failures, we can use fault paths for all elements that can fail. We can deal with the error and do the following in the fault path.

Fault path
  • Add a screen element and display the flow failure message to the user.
  • Create a record in your custom Error Log object.
  • Send yourself an email in case of failure.

See how the exception in the screen flow can be handled in the video down below.

Advertisements

How to handle errors in Auto-launched Flow?

Salesforce does not publish Flow Execution Error Event platform event message in case of any exception in auto-launched flow. So, in order to display the user-friendly message to the user and to create an object record for the error log, we will use a custom platform event.

Create a platform event in your org.

  • Enter Label and Plural label
  • In Publish Behaviour field select ‘Publish Immediately
  • Click on Save.

Create a field to store the error message.

Check out the video below to see how the exception in the auto-lanched flow can be handled.

Advertisements

The custom exception class and LWC code are listed below.

errorMessage.js

import { LightningElement,api } from 'lwc';
import { subscribe, unsubscribe, onError, setDebugFlag, isEmpEnabled } from 'lightning/empApi';
import { ShowToastEvent } from 'lightning/platformShowToastEvent';
export default class ErrorMessage extends LightningElement {
subscription = {};
@api channelName = '/event/Flow_Error__e';
// connected callback : initialise
connectedCallback() {
// Register error listener
this.registerErrorListener();
this.handlePESubscribe();
}
handlePESubscribe() {
// Callback invoked whenever a new platfrom event message is created.
const thisReference = this;
const messageCallback = function(response) {
var obj = JSON.parse(JSON.stringify(response));
//simplify the flow failure error message
let error_message = obj.data.payload.Error_Message_Text__c.substring(0, obj.data.payload.Error_Message_Text__c.indexOf("You can look up ExceptionCode values"));
console.log('Simplified error: '+ error_message);
//show toast message
const evt = new ShowToastEvent({
title: 'Error !',
message: error_message,
variant: 'error',
mode:'sticky'
});
thisReference.dispatchEvent(evt);
};
// Invoke subscribe method of empApi. Pass reference to messageCallback
subscribe(this.channelName, -1, messageCallback).then(response => {
// Response contains the subscription information on subscribe call
console.log('Subscription request sent to: ', JSON.stringify(response.channel));
this.subscription = response;
});
}
/* If you want to unsubscribe use this channel.
handleUnsubscribe() {
// Invoke unsubscribe method of empApi
unsubscribe(this.subscription, response => {
console.log('unsubscribe method response: ', JSON.stringify(response));
});
}
*/
// Error listner method
registerErrorListener() {
onError(error => {
// Error contains the server-side error
console.log('Error received: ', JSON.stringify(error));
});
}
}
view raw errorMessage.js hosted with ❤ by GitHub

errorMessage.js-meta.xml

<?xml version="1.0" encoding="UTF-8"?>
<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
<apiVersion>55.0</apiVersion>
<isExposed>true</isExposed>
<targets>
<target>lightning__RecordPage</target>
<target>lightning__AppPage</target>
<target>lightning__HomePage</target>
</targets>
<targetConfigs>
<targetConfig targets="lightning__RecordPage, lightning__AppPage, lightning__HomePage">
<property name="channelName" type="String" />
</targetConfig>
</targetConfigs>
</LightningComponentBundle>

ExceptionUtilityCls.cls

public with sharing class ExceptionUtilityCls {
public class CustomException extends Exception{}
@invocableMethod(label='Custom Exception' description='Invoke custom eception method.' category='Exception Handling')
public static void throwCustomException(List<String> exceptionMessage) {
throw new CustomException('Exception hac occured in the process /flow '+
'Please contact your system adminstrator : '+ exceptionMessage[0] );
}
}

Summary

It is always a good idea to deal with exceptions in code; the same stands true for flow. The best course of action is to plan ahead for exception/errors and incorporate proper fault handling into your flow design, which will help you handle errors more effectively when they do happen.

Join 795 other followers
Advertisements
Advertisements
  • Handle the X close button event in Lightning quick action modal
    In Salesforce Lightning, quick actions are a powerful way to improve the user experience by allowing users to perform common tasks from a single location. However, one issue that can arise when using quick actions is that it can be difficult to handle the event when the user closes the quick action.
  • 10 Best Practices for Writing Apex Test Classes in Salesforce – Examples Included
    Apex Test classes are an essential part of Salesforce development, as they help ensure that your code is functioning correctly and that your business logic is sound. In this blog post, we will go over best practices for Apex Test classes, including tips for writing efficient and effective tests, as well as examples of how to implement these best practices in your own code.
  • Exploring the Different Methods of Parsing JSON in Apex
    Parsing JSON data in Apex, Salesforce’s proprietary programming language is a common task for developers. JSON (JavaScript Object Notation) is a lightweight data-interchange format that is easy for humans to read and write and easy for machines to parse and generate. In this blog post, we will go over some of the different ways to parse JSON data in Apex.

2 comments

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s