You are here:
Toggle Screen Input Component
Let users flip a toggle in a flow screen.
Required Editions
Configure the Toggle Component
You can select resources from the flow, such as variables or global constants, or you can manually enter a value.
| Attribute | Description |
|---|---|
| Active Label | When the toggle is active, this label appears underneath the toggle. Use it to clarify what active means. The default label is “Active.” This attribute accepts single-value resources. The value is treated as text. |
| API Name | The API name of the component. An API name can include underscores and alphanumeric characters without spaces. It must begin with a letter and can’t end with an underscore. It also can’t have two consecutive underscores. |
| Disabled | If set to true, the user can’t modify the value. The default value is false. This attribute accepts a resource with a Boolean value. |
| Inactive Label | When the toggle is inactive, this label appears underneath the toggle. Use it to clarify what inactive means. The default label is “Inactive.” This attribute accepts single-value resources. The value is treated as text. |
| Label | This label appears next to the toggle and describes what the user is enabling. This attribute accepts single-value resources. The value is treated as text. |
| Value | Whether the toggle is active ($GlobalConstant.True) or inactive ($GlobalConstant.False). Setting this attribute from the Inputs tab controls the default state of the toggle. To store the user’s selection in a flow variable, set this attribute from the Outputs tab. This parameter accepts single-value Boolean resources. |
Store the Toggle Component’s Values in the Flow
The flow stores values automatically. If you store values manually, store the attribute’s output value in a variable.
To store values manually, select Manually assign variables (advanced).
All attributes are available to store in flow variables, but Value is the most likely attribute you must store.
To store the user’s selection, map the Value attribute to a Boolean flow variable or a checkbox field on a record variable.
- Navigates to another screen and returns to the component’s screen.
- Pauses the flow then resumes it.
- Navigates to the next screen and triggers an input validation error.
Setting the attribute enables a flow to remember the value. The flow stores the value automatically. If you store values manually, store the attribute’s output value in a variable.
Set the Component Visibility
Specify the logic that determines when the flow displays the component.
| Option | Description |
|---|---|
| When to Display Component | Configure when the component is displayed by using conditional logic. You can set the components to:
|
Validate Input
Provide a formula that evaluates whether what the user entered is valid and the error message to display if invalid.
| Option | Description |
|---|---|
| Error Message | Specify the error message that appears below the component if the user enters an invalid value. |
| Formula | Provide a formula expression that returns a Boolean value. If the formula expression evaluates to true, the input is valid. If the formula expression evaluates to false, the error message appears below the component. If the user leaves the field blank and the field isn’t required, the flow doesn’t perform the validation. If the user leaves the field blank and the field is required, the flow shows the default error message and not your custom error message. |
Specify the Behavior of Values on Revisited Screens
Specify what this component does when a user enters a value, navigates to a previous screen, and then returns to the screen with this component.
