Subform
The Subform component allows you to add forms inside other forms.
Use the Form reference attribute to include an existing form in the subform component. You can use the subform as a collection of components. You can also bind it to another component by selecting the Store subform data in single variable attribute and providing the variable that stores the values from the linked component.
Outcome buttons are not available in subforms.
Attributes: General
| Attribute | Description |
|---|---|
| ID | The unique ID of the component. |
| Label | The label of the component. |
| Label tooltip | Used to provide additional help or information to the user. When it is defined, a question mark icon appears in the component label. The text displays when the user hovers their pointer over the icon. The tooltip supports plain text only. |
| Value | The binding for the component. Use an expression to bind the component to its value and specify where the value is saved. For example, use {{myVariableName}} to store the value of the component in a variable named myVariableName. Use prefixes to define the scope of the value, for example, root. for referencing the root case to store the value in or parent. to store the value in the parent work item of the current one. For example, {{root.foo}} stores the value in the root case using a variable named foo. |
| Default Value | If a Value is not set, such as on Initialization forms, then this value will be used. |
| Store subform data in single variable |
Specifies how the selected data is stored in the variable: Choose ID if you want to only save the value of the selected entry in the variable. You can then retrieve the value by using a form expression with the variable defined for the Value attribute, for example Choose Full value if you want to save the whole object. This enables you to retrieve other values of the selected element in the form, such as the name of the selected option by using a form expression with the variable defined for the Value attribute and the name of the field, for example When binding the subform to a Select (multiple) component, you must set this attribute to Full value. To get the value stored by a Select (multiple) component for the subform that is linked to it, use |
| Ignored | Determines if the component should be hidden and the value excluded from any payload. |
| Visible | Determines whether the component is visible or hidden. You can also use this expression to only show or hide the component based on another component. For example, if this component is bound to a checkbox component, you can use this expression to show or hide this component based on the checkbox selection made by the user. This is enabled by default. |
| Enabled | Determines whether the component is enabled or disabled. This is enabled by default. |
Attributes: Details
| Attribute | Description |
|---|---|
| Form reference | Includes another form in your form. You can either select a form reference directly or use an expression to dynamically specify the subform used at runtime. |
| Show border | Determines whether a border is displayed around the subform. |
| Collapsible | Determines whether you can collapse or expand the component. Enabling this option adds a + / - icon in the upper-right corner of the subform. |
| Initially collapsed | Determines whether the component is initially collapsed on the form. |
Attributes: Validation
| Attribute | Description |
|---|---|
| Custom validations | List of additional validations you can apply. |
Attributes: Documentation
| Attribute | Description |
|---|---|
| Documentation | Allows you to explain concepts of the component's use for future reference. |