This article explains how form behaviours work in Backstage, as well as how you can
add and combine them within your form template in order to achieve various outcomes.
To access the form behaviours, click on > Behaviors at the bottom of a form’s display template:
Form behavior categories
Clicking on the Behaviors expandable list displays three categories of behaviors, in the central pane, that can be used in the form:
- Inherited from components.
- Added on this page.
- Available new behaviors
These categories are explained below.
Behaviors inherited from component
The Inherited from components behaviors are those added automatically to the form template
when components are added.
You'll notice for example that when creating a new form there are always the Rating scale and Text input components added by default to the new form. These components require the Form behavior, so that particular behavior is added automatically based on those components.
Added on this page
The Added on this page behaviors are those that are added to the form either by default (based on the Default behaviors in the form settings), or manually when adding behaviors from the Available new behaviors category (explained below).
You can easily add or remove the default form behaviors by going to Forms > Preferences > Forms settings.
Available new behaviors
Available new behaviors are all the possible behaviors that can be added to the form template.
Note: The Inherited from components behaviors cannot be removed from the form, whereas the Added on this page and the Available new behaviors (once added) can be removed manually by clicking on the bin icon to the right of the behavior component you wish to delete.
Using form behaviors
All form behaviors have their descriptions available onscreen, next to their names, explaining what they do. Based on this description, when a behavior is added to a form, functionalities or additional components become available to be used in the form template.
Some behaviors directly add functionalities to the form itself and require very little or no configuration at all.
For example, Local Save, Manual submit, and Reset after submit require no configuration at all, and Submission notification or Anonymous results can be easily configured by selecting the behavior and respectively adding the email recipient or fields to be anonymized.
Important: Please note that the Submission notification and Reset after submit behaviors cannot be used at the same time on the same form, as this would cause the behaviors to not work correctly.
Other behaviors are used to add functionalities to the form via the use of components.
For example. the Budget behavior enables the Budget block component to be added to the form, in order to be used and configured.