Service Model Select

v3.17.0+

Data table that invokes the service registry from a form and allows the user to select one of the results.

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. 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 , like its purpose, usage in other models, etc.
Label	Text	The label attribute adds a label to the component.
Label position	Selection: Left Top	The position of the label, you can choose between left or top.
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.
Value	Text	The binding for the form field. Use an appropriate expression to bind the component to its value and specify where the value is written/read. For example, use '{{myVariableName}}' to store the value of the field in a variable named 'myVariableName'. Use prefixes to define the scope of the value, for example, 'root.' for referencing the root case/process to store the value in. Please refer to the section 'Frontend expressions' in the Flowable guide for more information.
Default value	Text	If the value is not set, the default value will be used.
Placeholder	Text	A text that appears in the input box when it has no value.

Datasource

Attribute	Type	Description	Category
Format	Text	An expression used to generate the label for each item. For example, Mr. {{$item.name}} {{$item.surname}} The expression is evaluated against the current work object. The selected item is available as $item.
Service Model	ServiceModelWithSearchAndLookup	Service Model	Create or link a Service registry model to this component, which will configure the service that is executed when the elements are requested. The search operation tab is used to select the search operation and defined the input parameters, the key work {{$searchText}} is used to map the user search text to the input parameter. The lookup operation tab is used to select the lookup operation and defined the input parameters, the key work {{$id}} is used to map the selected element id.
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.
Path	Text	When using a REST data source, this is the location in the response data to get the row collection.
Storage	Selection: ID Full value	Specifies how the data retrieved by the service should be stored in the variable. Choose 'ID' if only the ID (specified by the lookupId) of the selected entry should be saved in the variable, choose 'Full value' if the whole object should be saved and thus making it possible to display other values of the selected element within the form as well. Pay attention as storing the full value could lead int bloating the variables with unnecessary information depending on the amount of data retrieved by the service.

Validation

validation

Attribute	Type	Description	Category
Required	Boolean	The required flag specifies if entering a value for the component is mandatory.
Validation Panel Display	Selection: Show Only message Hide	Display at validation panel and validation tooltip.
Custom validations	List	List of additional validations to apply.

errorMessages

Attribute	Type	Description	Category
Invalid selection	Text	Specifies the error message to be displayed if the selection is invalid.

Rendering

Attribute	Type	Description	Category
Description	Text	The description attribute adds a description to the component.
Ignored	Boolean	If true the component will be hidden and the value will not be part of any payload.
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.

Invocation

Advanced

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