Action Button

Properties

General

Common

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 action button, like its purpose, usage in other models, etc.
Label	Text	The label attribute adds a label to the component.
Label tooltip	Text	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.
Refresh time	Text	Timer, set in milliseconds, to automatically execute the script.	Configure whether this button auto executes and what the refresh time is.
Auto execute	Boolean	Auto execute button when rendered.
Execute always	Boolean	Auto execute button when rendered even if disabled.

Details

Attribute	Type	Description	Category
Action definition key	Reference	Key of the action definition	Create or link an Action model to this button, which will configure the action that is executed when clicking this button. An action model reference can be unlinked to allow another action model to be linked in its place. Note that unlinking a model does not delete the model itself.
Definition Id(s)	Text	Comma separated ids of instances to display	An action is always executed within a certain scope, which can be configured with the Definition id, scope id and scope type. Checking the Send scope id to get definition will send end the scope id to the action definition GET request (It is always sent to the execute POST request). Unchecking it may lead to less requests fired when several buttons pointing to the same action definition are rendered in the same form. The Permission groups configure which users will be able to see this action button.
Scope Id	Text	Id of the Scope
Scope Type	Text	Type of the Scope
Send scope id to get definition	Boolean	Send the scope id to the action definition GET request (It is always sent to the execute POST request). Unchecking it may lead to less requests fired when several buttons pointing to the same action definition are rendered in the same form
Permission groups	Group Selection	User groups that will see this button. All the users will see it if this attribute is left empty. Note: The default permission checks defined in the action button are also applied when executing it.
Send full scope	Boolean	Send the scope of this action button when executing the action. When the action has a form, that form''s payload is sent instead	Send full payload: send the whole payload when executing the action. When the action has a form, that form's payload is sent instead. Store full response: store all the attributes of the response of the action into the form payload. Store response inside scope: store the response attributes of the action in the current scope or in the form payload root.
Send full payload	Boolean	Send the whole payload when executing the action. When the action has a form, that form''s payload is sent instead
Store full response	Boolean	Store all the attributes in the response into the payload
Store response inside scope	Boolean	Store the response attributes in the current scope or in the payload root
Store response attributes	List	Map some attributes from the response into the payload. Please use \\{\\{$response.attributeFromResponse\\}\\} in the expression column
Send payload map	List	Send a mapping of the current scope (you can use also $payload.something expressions)
Navigation URL	Text	After a successful execution the browser will be redirected there. You can use \\{\\{$response.anything\\}\\} bindings	Configure how the navigation should behave when the action button is clicked.
Target	Text	Specifies the target for the navigation URL, use '_blank' to open the selected item in a new window or '_self' to use the same window for navigation.

Advanced options

Attribute	Type	Description	Category
Button text	Text	Text that appears inside the button.	Give the button a custom text. Leave it empty to use the action name by default.

Button

Attribute	Type	Description	Category
Button alignment	Selection: Left Right	Where the button will be aligned.	Configuration properties for how the action button is rendered on the form.
Tooltip	Text	When the user hovers the button it will show this text in a tooltip.
Primary	Boolean	Mark the button as primary.
Icon URL	Text	The URL of the icon to show.	Configuration properties for how the icon for the action button is rendered on the form.
Font Awesome icon name	Text	The icon name to be used for the button icon from Font Awesome.
Icon alignment	Selection: Left Right	The alignment of the icon.

Validation

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

Attribute	Type	Description	Category
Ignored	Boolean	If true the component will be hidden and the value will not be part of any payload.	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.
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.
Enabled	Boolean	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 action 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.

Advanced

Attribute	Type	Description	Category
Events	List		The action 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

Store response attributes

Attribute	Type	Description
Name	Text	A human-readable name.
Expression	Text	Validation passes when this expression is true.

Send payload map

Attribute	Type	Description
Name	Text	A human-readable name.
Expression	Text	Validation passes when this expression is true.

Custom validations

Attribute	Type	Description
Expression	Text	Validation passes when this expression is true.
Error message	Text	Message to display when the validation fails.

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.