Documentation

Use the documentation below to configure Form screen components.

Select Object/Form

Use the selectors in this section to select the form component to display.

• Select Object: This selector displays Object options for all objects with active form components configured. This selector changes the options available within the Select Form selector below.
• Select Form: This selector displays active form component options configured for the selected Object. Select the form component name.

Prefill Records/Template

Use the selectors in this section to prefill field values within the form component. It is important to note that Form components are interoperable, meaning that multiple form components can share the same "Record Variable." If a field value changes within a form component, all other form components within the flow screen will receive those changes.

• Select Merge Field: This selector defines the field that links all related form components. Available options include the record, ID, and all ExternalId fields on the related Object.
• Select Record Variable: Use this selector to define the flow record variable Users should use it to prefill the field values within the component.

Form Properties (Optional)

The following section allows admins to override the default display properties for a form component.

• Form Record Type Options: Use this selector to assign a collection of record types available for selecting within a form component. When a form component includes the record type field, set this value to a group of available record types.
• Form Display Options: expand this accordion to configure the following display properties for the form component.
  • Override Form Input Fields: Use this button group to override fields within the form component. Select "Default" to keep properties defined within the form component. Selecting "Disabled All" changes all fields within the form to ReadOnly/Disabled. Selecting "RequireAll" changes all fields within the form to Required.
  • Hide all Headers: When enabled, all headers within the form component are disabled/hidden.
  • Display Section(s) as Accordion: When enabled, all sections will display as collapsed accordion sections.
  • Display Prompt(s): By default, configured prompts are only visible when a User focuses on the related input field. Enabling this selector will force all prompts to be visible without focus.
  • Override Form Theme: Use this selector to override the form component's configured theme value.

Output Variables

The following variables are returned from the form component. These output variables can either be assigned to flow variables or referenced as automatic output variables. It is easiest to reference the automatic output variables, however if you need to transform any of the data, after the screen, we recommend assigning to a variable. To assign to a variable, click the Advanced accordion button then check the "Manually assign variables" checkbox.

Record

Returns a record with any field value that was changed by the User. Note: This includes all field values that were prefilled, even if not changed or visible. Visible fields that are left blank will be returned as null. Furthermore this includes all input field values from linked form components (See Select Merge Field for more details.)

Record (Visible Fields Only)

Returns a record where all non visible field values have been removed. Any prefilled values, not visible within the component will be removed. With the exception of 'Id'. Note: This record will not include any value from linked form components.

Record (Without Nulls)

Returns a record where all empty, null, or blank values have been removed. Note: This includes all field values that were prefilled, even if not changed or visible. Furthermore this includes all input field values from linked form components (See Select Merge Field for more details.)

Record (Without Nulls/Visible Fields Only)

Returns a record with only visible fields, that have a value, not empty, null or blank. Any prefilled values, not visible within the component will be removed. With the exception of 'Id'. Note: This record will not include any value from linked form components.

Valid

Returns TRUE when all validation such as, required fields, min, max, and formatting passes the validation check. Note: Validation is checked with every field change. This returns as an automatic output variable, therefore it can be used within the Set Component Visibility section to display or hide other flow components.

Form Considerations

Configuring modular form components within the Form Builder will allow your team to layer multiple components within a flow screen. Mixing in standard flow screen components and custom and third-party components means limitless possibilities for your flow solutions.

Form components can be linked together via the Select Merge Field input parameter. This default utilizes a records Id value to communicate between and update field values. If a record does not contain an Id, all form components that share the same Object will be linked together. We recommend utilizing a field configured as an ExternalId when your solution needs to prevent syncing. This feature extends beyond the active flow screen. All open flows can communicate between Form Components. That means your team can combine multiple flows onto Lightning Record Pages, and our components will still communicate, passing updates back and forth.

Take advantage of the output variables. We provide multiple output variables to make complex requirements easier to achieve. For example, the Valid output can reference to show or hide other screen components such as Display Text or Buttons whenever a component's required fields are valid/invalid.

Do not manually assign variables when a component is hidden via the Set Component Visibility feature or an empty record will return.