Outcome Button

The Outcome Button component fires the main form actions (save, complete...) as well as custom form outcomes.

Properties

General

Attribute	Type	Description	Category
Model Id	String	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 value of the outcome button is used to identify later in a process or case which button was pressed. The value will be stored in a variable and can be used for comparison.
Button text	Text	Button text.
Value	Text	The value that will be stored as a variable when using this outcome button.

Rendering

renderDetails

Attribute	Type	Description	Category
Visible	Boolean	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	Boolean	Boolean value or expression specifies whether component is enabled or disabled.
Primary	Boolean	Mark the button as primary.
Style class	Text	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.

outcomeDetails

Attribute	Type	Description	Category
Optional outcome form	Reference	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	Boolean	Ignores the form data and any validation on it and just sends the outcome value	Advanced configurations options for the outcome button.
Ignore validation	Boolean	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	Text	An optional navigation URL definition that will be used when this outcome is chosen.

Advanced

Attribute	Type	Description	Category
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

Attribute	Type	Description
Event label	Text	This is a unique id for the component.
Event type	Selection: On value change	The type of event emitted by the form field.
Expression	Text	Validation passes when this expression is true.
Result variable	Text	Capture the result of the expression in a result variable.