The role component creates a drop-down list that allows you to select existing roles. You can restrict the selection to one item, allow multiple items, or provide a proposed list of values.

Attributes: General

Attribute Description
ID The unique ID of the component.
Label The label of the component.
Value The binding for the component. Use an expression to bind the component to its value and specify where the value is saved. For example, use {{myVariableName}} to store the value of the component in a variable named myVariableName. Use prefixes to define the scope of the value, for example, root. for referencing the root case to store the value in or parent. to store the value in the parent work item of the current one. For example, {{}} stores the value in the root case using a variable named foo.
Default Value If a Value is not set, such as on Initialization forms, then this value will be used.
Description Adds a description to the component.
Ignored Determines if the component should be hidden and the value excluded from any payload.
Visible Determines whether the component is visible or hidden. You can also use this expression to only show or hide the component based on another component. For example, if this component is bound to a checkbox component, you can use this expression to show or hide this component based on the checkbox selection made by the user. This is enabled by default.
Enabled Determines whether the component is enabled or disabled. This is enabled by default.

Attributes: Data source

Attribute Description

Determines how the data retrieved by the REST endpoint should be stored in the variable.

You can choose for the following options:

  • - No value -: No part of the entry will be saved in the variable.
  • ID: Only the ID of the selected entry will be saved in the variable.
  • Full value: The whole object will be saved in the variable. This makes it possible to display other values of the selected element within the form as well.

Storing the full value could lead to the variables full of unnecessary information depending on the amount of data retrieved by the REST endpoint.

Attributes: More

Attribute Description
Multi value Determines if the user can select multiple values in this component.
Proposed values Allows you to create a list of proposed values that are always presented at the top of the component's input list.
Proposed values only If selected, the user can only select from the options defined in the Proposed values list.

Attributes: Validation

Attribute Description
Required Used to determine if the user must enter a value for this component.
Custom validations List of additional validations you can apply.

Attributes: Documentation

Attribute Description
Documentation Allows you to explain concepts of the component's use for future reference.