In this example, we will create an Apex Class to update a custom field on our audience results dynamically.
Apex Setup
We need to implement an interface so that our apex class is a valid final action.
It has two methods, one for synchronous execution and one for asynchronous execution, which will be run if the batch size defined during the action setup is exceeded.
Here's the class we'd like to embed. It implements both the FinalAction_Interface and the Database.Batchable<SObject> interfaces.
The Database.Batchable interface runs the class as a batch job for the asynchronous executions. You might also use other asynchronous approaches, such as Queueable Apex chaining, so that is not a requirement.
We recommend Batchable Apex because it's the most reliable mechanism.
Important: The class needs to be global. Otherwise, Campaign Audience Builder will not be able to access it.
As you can see, the arguments are passed in as a string-to-object map. This map includes some predefined arguments and custom variables defined during the setup of the action.
The predefined arguments always have the same keys, all part of the FinalAction.Variable Enum. They include:
AUDIENCE_VERSION_ID: Used to identify the audience on which the action is executed
AUDIENCE_RESULTS: The audience result records (e.g., Contacts) with all the fields selected during the setup of the Final Action
BATCH_SIZE: Batch size for asynchronous execution, defined during the setup of the Final Action
The custom variables in this example are "fieldName", which stores the API name of the field which should be updated, and "value", which holds the new value accessed in the updateField method.
Final Action Setup
Open the CAB Settings tab in the Campaign Audience Builder app, navigate to Final Actions in the sidebar, and click New to create a new action.
In the first modal screen, we enter the following information.
Final Action Name: Used as the button label on the audience results page.
Final Action API Name: Set automatically to identify the final action.
Type: Choose if you want to use Flow or Apex logic.
Flow: Search the available autolaunched flows to find the flow you'd like to use.
Description: Optional. Rich text will be displayed to the user before they run the action.
Success Message: Optional. Displayed when the action has been executed.
Custom Permission Name: Optional. The action will only be available to users with the corresponding custom permission if set.
Batch Size: Defines the batch size for asynchronous runs of the action. Defaults to 500. Depending on the logic you've implemented in your Flow / Apex, this can be increased or needs to be decreased.
In the next step, choose the object for which your logic has been configured. The action will only be available for audiences with the same result object type.
In our example, we've created the logic for the Contact object, so we select Contact:
Our Apex class doesn't reference fields on the audience results, so we don't need to add any.
In the third step, the custom variables used in the custom logic and entered by the user must be defined.
After clicking New Input Variable, a modal opens:
The label entered here is displayed to the user. The name is the key with which the variable is passed in the argument map. The type defines which input is displayed to the user.
We need to set up two variables, "fieldName" and "value":
And we're done!
Using the Final Action
The action is now available on the results page in the dropdown next to Add to Campaign.
To celebrate the power of Salesforce, we want to set all Contact descriptions to "May the force be with you":
When we click run, our custom apex logic is executed and updates the field values to our celebratory text:
