The Screen Flow component allows for integration of native Salesforce Screen Flows into the form.

Adding the component

• Open the "Options" section and drag the "Screen Flow" element onto the canvas.
  Note: The Screen Flow component cannot be placed into a Section. It is, itself, a section-level component (like lists and nested forms), so it must be placed above or below any existing Sections.

Component properties

• Similar to other components, the basic properties of Title and Name should be populated, as desired:

• Screen Flow Name (1) - Click the configuration icon to display a popup (6) from which you can select the desired Screen Flow and click the "Apply" button:

• Input Parameters (2) - click the configuration icon to display a popup (7) in which you can specify Screen Flow Input Variables (this is dependent upon the variables having already been properly configured in the Screen Flow and allowing input, according to Salesforce Screen Flow's instructions):

• Show Restart Button (3) will display the proper button after Screen Flow is finished.
• Finish Screen Message (4), if specified, will display on the final screen after the Screen Flow is finished.
• Show on Edit/View page checkboxes (5) toggle if the Screen Flow will be displayed in the Form in Edit and View mode correspondingly.

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} 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 system.

Conditional styles

• Form components conditional styling
• This component has the following conditional styles available:
  • hide
  • show