Show Form
  • 10 Nov 2022
  • 2 Minutes to read
  • Dark
    Light

Show Form

  • Dark
    Light

Article Summary

Step Details

Introduced in Version4.0.0
Last Modified in Version7.12.0
LocationFavorites

Designer Entities > Forms [Interaction] > Default

Used to display a Form in Decisions. Users may create a new Form or select a pre-existing one via the Properties panel.



Properties

Assignment

PropertyDescriptionData Type
Assignment TypeSelect whether the Assignment is InSession, Assigned, Assigned to Guest, or Named Session.---

Inputs

Inputs will change based on how the Form is configured.

PropertyDescriptionData Type
---------

Outputs

Outputs will change based on how the Form is configured.

PropertyDescriptionData Type
---------

On Step Run

PropertyDescriptionData Type
Step Start Flow TypeThis setting allows for additional options for Runtime behaviors via the On Step Run section. Such options allow users to define the Step Start Flow Type as either None, SharedFlow, or Private. Triggering one of these options will allow the user to define which Flow To Run and the URL Parameter Name, the Assignment ID, Step Tracking ID, and Flow Tracking Parameters for the Assignment.---
Specify Queue for Running the Start Flow
Boolean

Queue Name for Running the Start Flow
---

Form Setup

PropertyDescriptionData Type
Show Form InProvides options to show the Form in a Dialog, on the Side Panel, or in a New Window.---
Runtime Selection EnabledWhen set to true, this will show a Target ID as an Input.---
Pick or Create ---Select the Default notification policy, choose no policy or create a custom policy.---
Do Not Allow ResizeWhen set to true, the end user will not be able to adjust the size of the Form.---
Form Title SourceThis option can override the Form Title displayed with the Form shows.---
Background ColorChanges background color of the Form---
Display OptionsSettings to provide a message if the assignment was completed. Show or remove the top bar, border, and background. If the Form is displayed in a dialog, set where the Form displays.---
SizingSet sizing options for if the Form is set to open in a New Window or a Sub Dialog.---

Email

PropertyDescriptionData Type
Email Notifications

Notification PolicySelect the Default notification policy, choose no policy or create a custom policy.---
Email Response Handling

Get Email Address From InputsRetrieve the Email Address from the Inputs of the step.Boolean

Email TemplateEmail Templates are HTML documents that define the look and feel of Emails sent from a Flow.---

Auto Resume

PropertyDescriptionData Type
Make Auto ResumeThe Expiration and Auto Resume Form properties allow Forms to be suspended, tasked for continuation, and automatically resolved with specified Flow outcomes.
Boolean

Save DataChoose to save data Immediately or OnAssignment.---

Make Auto Resume Delay


Auto Resume ExpiresExpire Type and Expire Auto Resume Delay settings will be available when set to True. Will also add an "Auto Resume Timeout" outcome path to the External Form step.Boolean

Related Information

Articles:
Create Forms
Configure Forms

Example Labs:
Creating Dynamic Forms
Dynamically Populate Lists in Forms


Was this article helpful?

What's Next