Add a control from which the Request participant submits the Screen.
The Submit Button control adds a button to the Screen. The Submit Button control has two functions:
Submit: Submits the Screen whilst setting this control's value as specified from the Value setting. This is the default setting.
Do Not Submit, Set Value: Sets this control's value as specified from the Value setting, but does not submit the Screen.
This control is only available for Form-type Screens. See Screen Types.
See how to configure a Submit Button control that prevents the Request participant from clicking on that control multiple times so the Screen cannot be submitted after the first click.
For a documented example of using this control, see Show or Hide Controls Based on Button Selection.
Follow these steps to add this control to the Screen:
Configure the Submit Button control. See Settings.
Validate that the control is configured correctly. See Validate Your Screen.
Below is a form with two Submit Button controls.
The Submit Button control has the following configurable settings in the Properties Panel:
Expand the Variable panel from the Properties Panel on the right to configure the following properties:
Expand the Configuration panel from the Properties Panel on the right to configure the following properties:
Expand the Design panel from the Properties Panel on the right to configure the following properties:
Expand the Advanced panel from the Properties Panel on the right to configure the following properties:
From the Controls Menu on the left, expand the Input Fields category, and then locate the Submit Button icon.
Drag and drop the control to the Screen Builder canvas. Existing controls in the Screen will adjust positioning based on where you drag the control.
Edit the default label that displays for this control if necessary. New Submit is the default value.
Edit the default Variable Name setting value for this control if necessary. The Variable Name setting value represents data in this control during Requests. Ensure that the Variable Name setting value is a unique name from other controls in this Screen and contains at least one letter. This is a required setting.
Reference this control by its Variable Name setting's value. The Data Preview panel in Preview mode corresponds the Submit Button control's Variable Name value. In the example below, SubmitButtonControl
is the Variable Name setting's value when the button is clicked.
Enter any alphanumeric value that represents data when the Request participant selects the Submit Button control. This value can be evaluated in a Visibility Rule setting expression or in a Sequence Flow element's condition(s) to trigger.
Do Not Submit, Set Value: Sets this control's value as specified from the Value setting, but does not submit the Screen.
Enable the Loading Submit Button option, and then edit the default Loading Label setting text as necessary. The Loading Submit Button option replaces the interstitial Screen and instead displays the text entered in the Loading Label option along with a spinner within the button; the Screen does not refresh entirely until the next Task's Screen is ready to load. If this option is disabled, the interstitial Screen works as configured in the Form Task/Manual Task element.
Configure a tooltip that displays when hovering over the Submit Button control.
Link: White-colored background with blue-colored Label text.
Specify an expression that indicates the condition(s) under which this control displays. See Expression Syntax Components. If this setting does not have an expression, then this control displays by default.
Both: The control displays on both desktop and mobile devices. Both toggle keys are enabled by default.
Enter the value to represent this control in custom CSS syntax when in Custom CSS mode. As a best practice, use the same CSS Selector Name value on different controls of the same type to apply the same custom CSS style to all those controls.
The Aria Label setting value replaces the Label setting value. For example, if a Submit Button control has both a Label setting value and an Aria Label setting value, assistive technology only uses the Aria Label setting value.
Enter the number for the sequential keyboard navigation order that this control takes focus amongst other controls in this Screen.