Option: Screen Flow

Users have the ability to include Salesforce Flows in their form. Those components will be rendered on the form only if Lightning Experience is enabled for the organization and the form is opened within the Lightning context.

Adding component:

Component properties:

  • Screen Flow Name - select Existing Active Screen Flows from the list (1)

  • Input Parameters - provide screen flow input parameters if needed (2). See example below (3):

NOTE: To use a Screen Flow within the form, it must be active.

Validation rules:

  • This component has no validation rules

Events:

  • You can configure form actions to handle the following screen flow events:

    • onStarted - is executed immediately when the Screen Flow is started. For a Screen Flow integrated into a form as a component, this will execute when the component is rendered on the form.

    • onScreenStarted - is executed each time a NEW screen of the Screen Flow is shown. This means that this event will not be executed for the first screen, and will never be executed if your Screen Flow has only one screen. This event has a standard output parameter, "screenName," that can be passed to event handler(s) as {$Output.screenName} a merge field and will contain the name of that screen.

    • onFinished - is executed when the Screen Flow is finished.

    • onError - is executed if the ScreenFlow returns an error (e.g., when a user tries to pass a nonexistent input variable to the Screen Flow). This event has a standard output parameter, "message," that can be passed to event handler(s) as {$Output.message} merge field and will contain the error message returned by the system. Example: Suppose you need to close the form once the screen flow finishes. Implementation steps: Add a handler to your screen flow component's "onFinished" event: 1. In the "Events" section, click the "Add New" button. 2. Choose "onFinished" as the event type for your screen flow. 3. Click the "Add" button in the "Handlers" section. 3. Select an existing action that closes the current form, or create one by clicking the "+" green button if you don't have it yet (here's an article on how to create such an action). 4. Save all your changes.

Conditional styles:

Last updated