Skip to main content

Wizard

Layout with a guided step manager. Use it to generate guided forms through steps.

Example

Loading...

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 wizard field, like its purpose, usage in other models, etc.

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.

Documentation Multiline Text

A free-form text to explain the use cases for this form field.

Wizard

AttributeTypeDescriptionCategory
Tabs order FlowOrder

The display order of the tabs in the component.

Customize how the different steps of the wizard field are displayed to the user.

Show last page footer Expression usage possibleBoolean

Set visibility of the final action button in the last step.

Customize in detail how the various steps of the wizard field are displayed to the user.

Next enabled Expression usage possibleBoolean

Enable the Next action button.

Next visible Expression usage possibleBoolean

Set visibility of Next action button.

Previous enabled Expression usage possibleBoolean

Enable the Previous action button.

Previous visible Expression usage possibleBoolean

Set visibility of the Previous action button.

Initial page Expression usage possibleInteger

The number of the page that is initially opened.

Show border Boolean

If true, the sub form renders a border around the list of elements in it.

Previous button text Translatable to different languagesText

Text to be used in the Previous button.

Customize the text of the buttons of the wizard field.

Next button text Translatable to different languagesText

Text to be used in the Next button.

Start button text Translatable to different languagesText

Text to be used in the Start button.

Complete button text Translatable to different languagesText

Text to be used in the Complete button.

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 wizard field 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.

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.

Style class Text

Stylesheet class name. Add any style classes to be applied to the component for the desired styling and rendering.

The wizard field can get customized CSS classes to customize the default styling. Note that the CSS files needed for the customizations must be available on the runtime system.

Advanced

AttributeTypeDescriptionCategory
Events List

The wizard field 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.

Context

Wizard component has special expressions in its context in order to manage the current state.

ExpressionTypeDescription
{{$currentPage}}numberIndex of the current page. Starts from 0.
{{$isLast}}booleanTrue when current page is last one.
{{$isFirst}}booleanTrue when current page is first one.
{{$pageValid}}booleanTrue if current page has no errors.

e.g.
Complete button (= last page next button) invisible:

nextVisible : "{{!$isLast}}"

e.g.
Next button always enabled but force the 3rd page to be valid in order to continue:

nextEnabled : "{{$pageValid || $currentPage !== 2}}"

Events

EventWhenAdditionalCancellable
Wizard.nextWizard Next button is clickedDefinition + StateYes
Wizard.previousWizard Previous button is clickedDefinition + StateYes

See section Events for more information.