Skip to main content

Tab / Section panel

Properties

General

AttributeTypeDescriptionCategory
Model Id RequiredString

This is a unique id for the component.

Every field on a form model needs a unique ID, which is automatically generated but can be changed if needed (e.g. to reference in expressions or for debugging purposes).

If the field type supports rendering a label, and most types do, it can be configured here. This label is a displayed on the form to the end user and typically indicates what value is expected in the field.

The documentation property holds free-form text that can be used to give more details about this tab panel, like its purpose, usage in other models, etc.

Label Expression usage possibleTranslatable to different languagesText

The label attribute adds a label to the component.

Label position Selection:
  • Left
  • Top

The position of the label, you can choose between left or top.

Label tooltip Expression usage possibleTranslatable to different languagesText

When it is defined, a question mark icon will appear in the component label. When the user hovers over it it will show this text in a tooltip.

Validation

AttributeTypeDescriptionCategory
Validation Panel Display Selection:
  • Show
  • Only message
  • Hide

Display at validation panel and validation tooltip.

Providing proper data in form fields is important, especially when in process, case, decision or any other models the values provided in the form fields are used in subsequent steps.

To make sure that the data is correct, validation is crucial. For this reason, a form can only be submitted when all fields are valid and thus all validation properties configured on the left apply.

Check the tooltips on the properties for more information.

Custom validations List

List of additional validations to apply.

The tab panel can have custom validation rules beyond the standard set of validations. Such a rule is written as a frontend expression in the form of {{myExpression}}. If this expression evaluates to false, the submission of the form won't be possible.

Server validation URL Expression usage possibleText

When the user clicks on Next button from this page a request will be done to this URL. If the server validation fails the wizard will not advance to the next page and an error is shown.

If a URL is set, the server will be contacted to apply validation on tab switch. If the server responds with a failure, the tab switch will not happen.

Server validation result path: If the server returns a JSON response, this attribute points to the path of the validation failure message in that json. For example data.errorMessage

Result message: If the server returns a JSON response, this attribute points to the path of the validation failure message in that json. For example _data.validationResult.

Server validation method: determines which HTTP request is executed when validating.

Server validation result path Expression usage possibleText

If the validation server returns a json, this attribute points to the path of the validation result in that json. For example, data.validationResult.

Result message Expression usage possibleText

If the validation server returns a json, this attribute points to the path of the validation failure message in that json. For example, data.errorMessage.

Server validation method Selection:
  • GET
  • POST

When it is POST it will fire the validation request using POST method instead of GET.

Server validation body Expression usage possibleText

When it is an expression and serverValidationMethod is POST, the validation request body will be the result of executing the expression. When it is not defined the whole payload will be sent.

Rendering

AttributeTypeDescriptionCategory
Visible Expression usage possibleBoolean

Boolean value or expression specifies whether the component is visible or hidden. This expression might include another value in the same form, for instance use a checkbox bound to {{showAdditionalFields}} and use the very same expression as the visible attribute to show or hide the component according the checked state of the checkbox. If you want to only show the component, if the form is not used as the init-form, you can use the expression '{{root.id}}' which evaluates to true only, if there is a current case id which is not the case in an initialization form.

Fields can also be shown or hidden based on the visible condition. This can be a frontend expression in the form of {{myExpression}} which can reference other form field values by their IDs.

Fields can also be enabled or disabled, and similarly this can be made dynamic based on a frontend expression.

Some field types can be ignored (the property is shown here if that's the case), which means that its value won't be taken into account.

Enabled Expression usage possibleBoolean

Boolean value or expression specifies whether component is enabled or disabled.

Advanced

AttributeTypeDescriptionCategory
Events List

The tab panel emits low-level events on which can be reacted with a frontend expression to implement various use cases that are not possible with regular modeling.

If the expression produces a value, it can be stored in a new variable using the Result variable property.

List Attribute Details

Custom validations

AttributeTypeDescription
Expression RequiredExpression usage possibleText

Validation passes when this expression is true.

Error message RequiredTranslatable to different languagesText

Message to display when the validation fails.

Events

AttributeTypeDescription
Event label RequiredText

This is a unique id for the component.

Event type Selection:
  • On value change

The type of event emitted by the form field.

Expression Expression usage possibleText

Validation passes when this expression is true.

Result variable Text

Capture the result of the expression in a result variable.