Service Button

v3.14.0+

The Service Button component is bound to a service registry model definition which executes a service call in the backend. This can be used for triggering various service model operations in the backend from a form.

Properties

General

commonDetails

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 invoke service 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	MarkdownMinimal	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.	Give the button a custom text.
Refresh time	Text	Timer, set in milliseconds, to automatically execute the script.	The script associated with the invoke service button. These scripts are very powerful, but take into account the logic contained within needs to be tested and maintained, like any other software artifact.
Auto execute	Boolean	Auto execute button when rendered.
Execute always	Boolean	Auto execute button when rendered even if disabled.

details

Attribute	Type	Description	Category
Service Model	ServiceModel	Service Model	Create or link a Service registry model to this button, which will configure the service that is executed when clicking this button. A service registry model reference can be unlinked to allow another service registry model to be linked in its place. Note that unlinking a model does not delete the model itself.
Store response inside scope	Boolean	Store the response attributes in the current scope or in the payload root	Advanced settings for the service invocation: whether the result needs to be stored in the form payload and which users can see the button.
Invocation result value	Text	Store the result of the service invocation in a variable with this name. No output parameters will be applied to this variable
Permission groups	Group Selection	User groups that control who can see and run this button. If left empty, all users can see the button, but only administrators can run it; other users will receive a permission error when they try. If one or more groups are selected, their members can see and run the button. Note: The default permission checks defined in the action button are also applied when executing it.

common

Attribute	Type	Description	Category
Override button text	Text	Replace the default action button text with this (leave blank to use default action name)	Give the button a custom text.

Button

Attribute	Type	Description	Category
Button alignment	Selection: Left Right	Where the button will be aligned.	Configuration properties for how the invoke service 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 alignment	Selection: Left Right	The alignment of the icon.	Configuration properties for how the icon for the service button is rendered on the form.

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 invoke service 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 invoke service 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 invoke service 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

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.