Skip to main content

Outcome Button

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

Documentation Multiline Text

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

Tab Index Integer

Determine their relative ordering for sequential focus navigation. Tab index will be ignored if the component is inside a subform.

The purpose of a form is to either display some value or to have users provide values for the various fields of a form.

In both situations, this value needs to be bound to an identifier using the {{myValue}} notation, and the value provided by the user will be stored in a variable with that identifier.

If there already was a value bound to the identifier before, for example because another form had a field bound to the same identifier, it will be displayed.

Button text RequiredTranslatable to different languagesText

Button text.

Value RequiredExpression usage possibleText

The value that will be stored as a variable when using this outcome button.

Rendering

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.

Primary Expression usage possibleBoolean

Mark the button as primary.

Style class Expression usage possibleText

An optional CSS style class definition that will be used for the styling of the outcome button.

The outcome button 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.

Outcome configuration

AttributeTypeDescriptionCategory
Optional outcome form Expression usage possibleReference

When a form is configured, this form reference is used to show an additional outcome dialog.

An optional form that is shown when clicking the outcome button in Flowable Work.

Ignore payload Expression usage possibleBoolean

Ignores the form data and any validation on it and just sends the outcome value

Advanced configurations options for the outcome button.

Ignore validation Expression usage possibleBoolean

Ignores the form validation and just sends the payload

Hide validation errors Boolean

Hide the form validation errors when the outcome is clicked

Navigation URL Expression usage possibleText

An optional navigation URL definition that will be used when this outcome is chosen.

Advanced

AttributeTypeDescriptionCategory
Events List

The outcome button 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

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.