Execute Flow
Last updated
Was this helpful?
Last updated
Was this helpful?
The "Execute Flow" interaction lets you launch an autolaunched Salesforce Flow directly from within an Avonni Dynamic Component. This provides a powerful way to integrate automation and business logic into your user interface, without requiring users to navigate away from the current page.
The Execute Flow interaction is a way to trigger a background process (an autolaunched Flow) from a user action within a component. This is useful for automating tasks, updating records, performing calculations, or implementing any other logic in a Flow.
You can add the "Execute Flow" interaction to the following Avonni Dynamic Components:
Button
Button Group
Button Menu
Button Icon
Data Table (Header Actions and Row Actions)
List Item
The "Execute Flow" interaction is designed for autolaunched Flows (Flows that run in the background). If you want to launch a Screen Flow (a Flow with user interface elements), use the "" or "" interactions instead
User Action: The user interacts with the component (e.g., clicks a button).
Flow Execution: The "Execute Flow" interaction triggers the specified autolaunched Flow.
Data Passing (Optional): You can pass data from the component to the Flow as input variables.
Flow Processing: The Flow runs its logic, potentially using the input variables.
Output (Optional): The Flow can return data as output variables.
Post-Execution Actions (Optional): You can configure actions to occur after the Flow finishes (e.g., display a toast message on success or error).
To configure the "Execute Flow" interaction:
Select the Component: Choose the Avonni component (e.g., a Button) that will trigger the Flow.
Add the Interaction: In the component's properties panel, find the section for configuring "Actions" or "Interactions." Add a new action and select the "Execute Flow" type.
Configure the Settings:
Flow API Name: Select the API name of the autolaunched Flow you want to execute. This is the unique identifier of the Flow.
Flow Input Variables (Optional):
To pass data into the Flow, add entries here.
For each input variable:
Name: Enter the exact API name of the input variable as defined in your Flow.
Value: Select the value you want to pass. This can be:
A static value (e.g., "New").
A dynamic value from the component (e.g., the selected row's ID).
A resource.
Output Variables (Optional):
To capture data from the Flow, add entries here.
For each output variable:
Name: Enter the exact API name of the output variable as defined in your Flow.
Resource Name: Enter the resource's name in your Dynamic Component, where you can use this value.
On Finish (Optional): Configure an action to occur when the Flow completes successfully. An everyday use case is to display a "Show Toast" action to notify the user.
On Error (Optional): Configure an action to occur if the Flow encounters an error. An everyday use case is to display a "Show Toast" action to inform the user.
Let's say you want to create a button that, when clicked, updates a Contact's status to "Active" using an autolaunched Flow.
Create the Autolaunched Flow:
Create a new autolaunched Flow in Salesforce Setup.
Add an input variable named ContactId (Text type).
Add a "Get Records" element to retrieve the Contact with the matching ContactId.
Add an "Update Records" element to update the Contact's Status field to "Active".
Add an output variable (Optional).
Activate the Flow. Note the Flow's API Name.
Add a Button Component: Add an Avonni Button component to your Dynamic Component.
Configure the "Execute Flow" Interaction:
Select the Button component.
Add an "Execute Flow" interaction.
Flow API Name: Enter the API name of your autolaunched Flow.
Flow Input Variables:
Name: ContactId
Value: @ThisItem.Id (This assumes your button is within a repeating component like a Data Table or List, and Id is the field containing the Contact ID. Adjust as needed.)
On Finish Action:
Add an action to display a message, like 'Show Toast' to confirm the contact update.
Test: Save and test.
Autolaunched Flows Only: The "Execute Flow" interaction only works with autolaunched Flows, not Screen Flows.
Input/Output Variable Names: The API names of your input and output variables must match strictly between the Flow and the "Execute Flow" configuration.
Error Handling: Use the "On Error" action to handle any errors that might occur during flow execution gracefully.
Data Types: Ensure that the data types of your input and output variables match between the Flow and the component.
The 'Execute Flow' interaction is a valuable feature for adding an autolaunched flow from a Dynamic Component. Configuration settings include setting the flow to trigger, input/output variables and on finish/error actions.