Form components

Form components allow you to collect data, provide options to choose from, display information and give structure to your forms.

When migrating from Flowable Eclipse Designer to Workflow Designer and replacing drop-down form properties with Collibra data entry form components, adjust your scripts to account for the fact that the class of the stored value for all these components is now String.

To convert a String to UUID, use string2Uuid(<variable_name>).

To convert a UUID to String, use <variable_name>.toString().

Data entry components

The following components are text or date input fields where you can specify and restrict the type of data you want your users to enter.

Text

The Text component is an input field where your users can enter a single line of plain text. This field is intended to capture short text elements, such as the name of a person. You can restrict this component to only accept certain values.

Use the Multiline text component to capture longer text elements.

Attributes: General

Attribute Description
ID The unique ID of the component.
Label The label of the component.
Label tooltip Used to provide additional help or information to the user. When it is defined, a question mark icon appears in the component label. The text displays when the user hovers their pointer over the icon.

The tooltip supports plain text only.

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, {{root.foo}} 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: 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.
Minimum length Determines the minimum number of characters required for this component.
Maximum length Determines the maximum number of characters required for this component.
Validation regex Specifies the validation pattern with a regular expression to match against the entered value in order to be considered valid.

Attributes: Error messages

Attribute Description
Minimum length Determines the error message that displays if the minimum length defined for the component has not been reached.
Maximum length Determines the error message that displays if the maximum length defined for the component has been exceeded.
Validation regex Determines the error message that displays if the value entered does not match the regular expression validation pattern.

Attributes: Documentation

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

Tags

The Tags component is an input field where your users can add multiple tags. You can restrict this component to only accept a certain number of tags.

Attributes: General

Attribute Description
ID The unique ID of the component.
Label The label of the component.
Label tooltip Used to provide additional help or information to the user. When it is defined, a question mark icon appears in the component label. The text displays when the user hovers their pointer over the icon.

The tooltip supports plain text only.

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, {{root.foo}} 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: 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.
Minimum elements When multi-selection is enabled, this component specifies the minimum number of items to be selected.
Maximum elements When multi-selection is enabled, this component specifies the maximum number of items to be selected.

Attributes: Error messages

Attribute Description
Minimum elements When multi-select is enabled, this determines the error message that displays if the number of items selected is less than the minimum specified in validation.
Maximum elements When multi-select is enabled, this determines the error message that displays if the number of items selected is bigger than the maximum specified in validation.

Date

The Date component is an input field where your users can enter a date.

Attributes: General

Attribute Description
ID The unique ID of the component.
Label The label of the component.
Label tooltip Used to provide additional help or information to the user. When it is defined, a question mark icon appears in the component label. The text displays when the user hovers their pointer over the icon.

The tooltip supports plain text only.

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, {{root.foo}} 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: Details

Attribute Description
Format

The format of the date, for example DD.MM.YYYY or MM.DD.YYYY.

Calendar start date Determines the day of the week the calendar starts on.

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.
Minimum date Determines the earliest valid date for this component. You can choose between an absolute value, a relative date in relation to the current date or an expression.
Maximum date Determines the latest valid date for this component. You can choose between an absolute value, a relative date in relation to the current date or an expression.

Attributes: Error messages

Attribute Description
Minimum date Determines the error message that displays if the selected date is before the specified validation minimum date.
Maximum date Determines the error message that displays if the selected date is after the specified validation maximum date.

Attributes: Documentation

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

Multiline text

The Multiline text component is an input field where you can enter multiple lines of plain text. This field is intended to capture longer text elements, such as the description of a defect. The field size will expand with the amount of text entered. The validation for this component is more limited than the other data entry fields, since a longer text does not usually follow a specific pattern.

Use the Text component to capture shorter text elements.

Attributes: General

Attribute Description
ID The unique ID of the component.
Label The label of the component.
Label tooltip Used to provide additional help or information to the user. When it is defined, a question mark icon appears in the component label. The text displays when the user hovers their pointer over the icon.

The tooltip supports plain text only.

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, {{root.foo}} 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: 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.
Minimum length Determines the minimum number of characters required for this component.
Maximum length Determines the maximum number of characters required for this component.

Attributes: Error messages

Attribute Description
Minimum length Determines the error message that displays if the minimum length defined for the component has not been reached.
Maximum length Determines the error message that displays if the maximum length defined for the component has been exceeded.

Attributes: Documentation

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

Rich text

The Rich text component is an input field for multiple lines of stylized text.

Attributes: General

Attribute Description
ID The unique ID of the component.
Label The label of the component.
Placeholder Specifies the text that appears in the input box when no value has been entered.
Label tooltip Used to provide additional help or information to the user. When it is defined, a question mark icon appears in the component label. The text displays when the user hovers their pointer over the icon.

The tooltip supports plain text only.

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, {{root.foo}} 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: 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.
Minimum length Determines the minimum number of characters required for this component.
Maximum length Determines the maximum number of characters required for this component.

Attributes: Error messages

Attribute Description
Minimum length Determines the error message that displays if the minimum length defined for the component has not been reached.
Maximum length Determines the error message that displays if the maximum length defined for the component has been exceeded.
Minimum date Determines the error message that displays if the selected date is before the specified validation minimum date.
Maximum date Determines the error message that displays if the selected date is after the specified validation maximum date.
Minimum elements When multi-select is enabled, this determines the error message that displays if the number of items selected is less than the minimum specified in validation.
Maximum elements When multi-select is enabled, this determines the error message that displays if the number of items selected is bigger than the maximum specified in validation.

Attributes: Documentation

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

Collibra data entry components

The following components are Collibra specific input fields where you can specify and restrict the type of data you want your users to enter.

File upload

The file upload component allows you to upload a file to the form.

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, {{root.foo}} 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: 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.

Asset type

The asset type component creates a drop-down list that only allows you to select existing asset types. 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, {{root.foo}} 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
Storage

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: Filters

Attribute Description
Exclude meta Whether to hide or show meta asset types, such as Asset.

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.

Domain type

The domain type component creates a drop-down list that allows you to select existing domain types. 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, {{root.foo}} 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
Storage

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.

Attribute type

The attribute type component creates a drop-down list that only allows you to select existing attribute types. 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, {{root.foo}} 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
Storage

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.

Relation type

The relation type component creates a drop-down list that allows you to select existing relation types. 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, {{root.foo}} 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
Storage

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.

User

The user component creates a drop-down list that allows you to select existing users. 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, {{root.foo}} 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
Storage

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.

Group

The group component creates a drop-down list that allows you to select existing groups. 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, {{root.foo}} 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
Storage

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.

Role

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, {{root.foo}} 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
Storage

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.

Asset

The asset component creates a drop-down list that only allows you to select existing assets. You can restrict the selection to one item, allow multiple items, provide a proposed list of values, or restrict the selection to assets in certain domains, communities, of certain types, or with certain statuses.

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, {{root.foo}} 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
Storage

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: Filters

Attribute Description
Asset type IDs Determines which assets are allowed as input for the component based on the asset types specified here. Only assets of the specified types are available.
Type inheritance Determines if the selected values in Asset type IDs should include descendant types.
Status IDs Determines which assets are allowed as input for the component based on the statuses specified here. Only assets with the specified statuses are available.
Community IDs Determines which assets are allowed as input for the component based on the communities specified here. Only assets contained in the specified communities are available.
Domain IDs Determines which assets are allowed as input for the component based on the domains specified here. Only assets contained in the specified domains are available.
Exclude meta Whether to hide or show assets from meta domains, such as issues.

Attributes: More

Attribute Description
Default from resource Determines whether the property's default value is the current resource.
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.

Domain

The domain component creates a drop-down list that allows you to select existing domains. 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, {{root.foo}} 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
Storage

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: Filters

Attribute Description
Community ID Determines which domains are allowed as input for the component based on the communities specified here. Only domains contained in the specified communities are available.
Domain type ID Determines the type of domains that are allowed as input for the component based on the domain type specified here. Only domains of the specified type are available.

Attributes: More

Attribute Description
Default from resource Determines whether the property's default value is the current resource.
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.

Community

The community component creates a drop-down list that allows you to select existing communities. 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, {{root.foo}} 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
Storage

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
Default from resource Determines whether the property's default value is the current resource.
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.

Role in community

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

This component is deprecated. We recommend you use a Subform container instead.

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, {{root.foo}} 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
Storage

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
Default from resource Determines whether the property's default value is the current resource.
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.

Container components

The following components allow you to organize the components on your form.

Panel

The Panel component allows you to group other components for better display management.

A typical use case for a panel is to use it like a column, with several other components grouped together next to a large component, such as an image. Without the panel, the other components can become misaligned. For example, the first component would be aligned with the large image component, but the other components would be placed below the image, regardless of their width. Panels give you more control over your form display.

Attributes: General

Attribute Description
ID The unique ID of the component.
Label The label of the component.
Store panel data into single variable 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, {{root.foo}} stores the value in the root case using a variable named foo.
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: Details

Attribute Description
Collapsible Determines whether you can collapse or expand the component.

Enabling this option adds a + / - icon in the upper-right corner of the panel.

Initially collapsed Determines whether the component is initially collapsed on the form.

Subform

The Subform component allows you to add forms inside other forms.

Use the Form reference attribute to include an existing form in the subform component. You can use the subform as a collection of components. You can also bind it to another component by selecting the Store subform data in single variable attribute and providing the variable that stores the values from the linked component.

Outcome buttons are not available in subforms.

Attributes: General

Attribute Description
ID The unique ID of the component.
Label The label of the component.
Label tooltip Used to provide additional help or information to the user. When it is defined, a question mark icon appears in the component label. The text displays when the user hovers their pointer over the icon.

The tooltip supports plain text only.

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, {{root.foo}} 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.
Store subform data in single variable

Specifies how the selected data is stored in the variable:

Choose ID if you want to only save the value of the selected entry in the variable. You can then retrieve the value by using a form expression with the variable defined for the Value attribute, for example {{myVariableName}}.

Choose Full value if you want to save the whole object. This enables you to retrieve other values of the selected element in the form, such as the name of the selected option by using a form expression with the variable defined for the Value attribute and the name of the field, for example {{myVariableName.text}} or {{myVariableName.value}}.

When binding the subform to a Select (multiple) component, you must set this attribute to Full value. To get the value stored by a Select (multiple) component for the subform that is linked to it, use $itemParent.myVariableName[$index].

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: Details

Attribute Description
Form reference Includes another form in your form. You can either select a form reference directly or use an expression to dynamically specify the subform used at runtime.
Show border Determines whether a border is displayed around the subform.
Collapsible Determines whether you can collapse or expand the component.

Enabling this option adds a + / - icon in the upper-right corner of the subform.

Initially collapsed Determines whether the component is initially collapsed on the form.

Attributes: Validation

Attribute Description
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.

Display components

The following components allow you to configure the display the components on your form.

Text display

The Text display component allows you to display a read-only text in HTML format, including dynamic text based on expressions.

Adding the Text display component to the canvas automatically opens the rich text editor. You can also double click the component to open the editor.

Some HTML elements that are currently not supported, such as tables, are removed if you edit the form after saving it.

Use the toolbar to format your text, and then click OK to apply your text.

Attributes: General

Attribute Description
ID The unique ID of the component.
Label The label of the component.
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: Validation

Attribute Description
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.

Image

The Image component allows you to display an image in your form based on a fixed or dynamic URL that uses form expressions.

Attributes: General

Attribute Description
ID The unique ID of the component.
Label The label of the component.
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: Details

Attribute Description
Source URL The image source URL. This is a mandatory field.

You can also use expressions.

Image max. height The maximum height of the image in pixels.

Attributes: Validation

Attribute Description
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.

Link

The Link component allows you to display a relative or absolute URL in your form.

Attributes: General

Attribute Description
ID The unique ID of the component.
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.

Attributes: Details

Attribute Description
Link text The text to display as the link.

You can also use expressions, for example Navigate to {{asset.text}}.

Navigation URL

The URL to navigate to:

  • An absolute URL, for example https://<your_collibra_url>/settings/workflows?tabbar=WorkflowsDefinitions.
  • A relative URL, for example /settings/workflows?tabbar=WorkflowsDefinitions.
  • A link to an email address, for example mailto:[email protected].

The link can also contain expressions, for example https://<your_collibra_url>/asset/{{asset.value}}.

Target Where to open the linked document:
  • _blank to open the link in a new window or tab.
  • _self to open the link in the same window.

To respect the user browser preferences, don't specify any value for this attribute.

Attributes: Validation

Attribute Description
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.

Horizontal Line

The Horizontal line component is allows you to visually separate components in a panel.

Attributes: General

Attribute Description
ID The unique ID of the component.
Label The label of 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: Validation

Attribute Description
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.

Selection components

The following components are selection fields where you can provide limited options for your users to chose from.

Radio buttons

The Radio buttons component allows you to only select one option from a list of predefined options.

Attributes: General

Attribute Description
ID The unique ID of the component.
Label The label of the component.
Label tooltip Used to provide additional help or information to the user. When it is defined, a question mark icon appears in the component label. The text displays when the user hovers their pointer over the icon.

The tooltip supports plain text only.

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, {{root.foo}} 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
Items When the data source is static, this determines the data that is shown. If you want to use dynamic values, provide an object that is declared as a list of maps which contain text and value elements. For example, def myDynamicOptions = [[text: "text1", value: "value1"],[text: "text2", value: "value2"]].
Storage

Specifies how the selected data is stored in the variable:

Choose ID if you want to only save the value of the selected entry in the variable. You can then retrieve the value by using a form expression with the variable defined for the Value attribute, for example {{myVariableName}}.

Choose Full value if you want to save the whole object. This enables you to retrieve other values of the selected element in the form, such as the name of the selected option by using a form expression with the variable defined for the Value attribute and the name of the field, for example {{myVariableName.text}} or {{myVariableName.value}}.

Format An expression used to generate the label for each item. For example, the expression Mr. {{$item.name}} {{$item.surname}} is evaluated against the current work object and the selected item is available as $item.

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.

You can add the label and value ID for the radio button component from the attribute bar.

To add your radio button options:

  1. Select the component on the canvas.
  2. In the attribute bar, select Items.

    The Items dialog box appears.


  3. Click an empty space below the column header to add an item.
  4. Click OK to save the items and close the dialog box.

You can also connect the selected radio button option to another component to build a dynamic dependency between them.

Example

In this example, we are configuring a text input component to display when a specific radio button option is selected.

We have already added the radio button and text input field to the canvas. The value of the radio button component value is set to {{exampleRadioButton}}.

See our Form expression article for more information.

For each radio button, enter the Text and Value:

  • Text:Item 1, Value:radioID1.
  • Text:Item 2, Value:radioID2.

By default, the radio button stores the ID of the select value item. The condition should return true if the variable exampleRadioButton is equal to the ID of the second radio button option. Since the ID is a String type, the expression should look like this:

{{exampleRadioButton == "radioID2"}}

You now need to add this expression to the Visible attribute of the text input component:

  1. Select the text input component.
  2. In the configuration bar, in the General section, go to the Visible attribute.
  3. Select the runtime expression mode.

    The visible attribute switches from normal to expression mode.

  4. Enter your expression.

You can now use the preview mode in the form editor to see that the text input component is visible only if the second radio button item is selected.

Checkbox

The Checkbox component provides a choice between two Boolean values: true and false. If your select the checkbox, the stored value is true, otherwise the stored value is false. If the component is marked as required, you must select the true value for the form to be valid.

For example, if you want a user to confirm they have read and agreed with a policy, you would add a required checkbox like the one below:

When the user completing the form selects this checkbox, it is then marked as true, and they can submit the form.

Attributes: General

Attribute Description
ID The unique ID of the component.
Label The label of the component.
Label tooltip Used to provide additional help or information to the user. When it is defined, a question mark icon appears in the component label. The text displays when the user hovers their pointer over the icon.

The tooltip supports plain text only.

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, {{root.foo}} 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: Validation

Attribute Description
Required Used to determine if the user must enter a value for this component.

Attributes: Documentation

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

Checkbox group

The Checkbox group component allows you to select multiple options from a list of predefined options.

Attributes: General

Attribute Description
ID The unique ID of the component.
Label The label of the component.
Label tooltip Used to provide additional help or information to the user. When it is defined, a question mark icon appears in the component label. The text displays when the user hovers their pointer over the icon.

The tooltip supports plain text only.

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, {{root.foo}} 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
Items When the data source is static, this determines the data that is shown. If you want to use dynamic values, provide an object that is declared as a list of maps which contain text and value elements. For example, def myDynamicOptions = [[text: "text1", value: "value1"],[text: "text2", value: "value2"]].
Storage

Specifies how the selected data is stored in the variable:

Choose ID if you want to only save the value of the selected entry in the variable. You can then retrieve the value by using a form expression with the variable defined for the Value attribute, for example {{myVariableName}}.

Choose Full value if you want to save the whole object. This enables you to retrieve other values of the selected element in the form, such as the name of the selected option by using a form expression with the variable defined for the Value attribute and the name of the field, for example {{myVariableName.text}} or {{myVariableName.value}}.

Format An expression used to generate the label for each item. For example, the expression Mr. {{$item.name}} {{$item.surname}} is evaluated against the current work object and the selected item is available as $item.

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.

You can add the label and value ID for the radio button component from the attribute bar.

To add your checkbox group options:

  1. Select the component on the canvas.
  2. In the attribute bar, select Items.

    The Items dialog box appears.


  3. Click an empty space below the column header to add an item.
  4. Click OK to save the items and close the dialog box.

You can also connect the selected checkbox group option to another component to build a dynamic dependency between them.

Select (single)

The Select (single) component allows you to select a single option from a drop-down menu.

Attributes: General

Attribute Description
ID The unique ID of the component.
Label The label of the component.
Label tooltip Used to provide additional help or information to the user. When it is defined, a question mark icon appears in the component label. The text displays when the user hovers their pointer over the icon.

The tooltip supports plain text only.

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, {{root.foo}} 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
Items When the data source is static, this determines the data that is shown. If you want to use dynamic values, provide an object that is declared as a list of maps which contain text and value elements. For example, def myDynamicOptions = [[text: "text1", value: "value1"],[text: "text2", value: "value2"]].
Storage

Specifies how the selected data is stored in the variable:

Choose ID if you want to only save the value of the selected entry in the variable. You can then retrieve the value by using a form expression with the variable defined for the Value attribute, for example {{myVariableName}}.

Choose Full value if you want to save the whole object. This enables you to retrieve other values of the selected element in the form, such as the name of the selected option by using a form expression with the variable defined for the Value attribute and the name of the field, for example {{myVariableName.text}} or {{myVariableName.value}}.

Format An expression used to generate the label for each item. For example, the expression Mr. {{$item.name}} {{$item.surname}} is evaluated against the current work object and the selected item is available as $item.

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.

To add your drop-down options:

  1. Select the component on the canvas.
  2. In the attribute bar, select Items.

    The Items dialog box appears.


  3. Click an empty space below the column header to add an item.
  4. Click OK to save the items and close the dialog box.

Select (multiple)

The Select (multiple) component allows you to choose more than one option from a drop-down menu.

Attributes: General

Attribute Description
ID The unique ID of the component.
Label The label of the component.
Label tooltip Used to provide additional help or information to the user. When it is defined, a question mark icon appears in the component label. The text displays when the user hovers their pointer over the icon.

The tooltip supports plain text only.

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, {{root.foo}} 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
Items When the data source is static, this determines the data that is shown. If you want to use dynamic values, provide an object that is declared as a list of maps which contain text and value elements. For example, def myDynamicOptions = [[text: "text1", value: "value1"],[text: "text2", value: "value2"]].
Storage

Specifies how the selected data is stored in the variable:

Choose ID if you want to only save the value of the selected entry in the variable. You can then retrieve the value by using a form expression with the variable defined for the Value attribute, for example {{myVariableName}}.

Choose Full value if you want to save the whole object. This enables you to retrieve other values of the selected element in the form, such as the name of the selected option by using a form expression with the variable defined for the Value attribute and the name of the field, for example {{myVariableName.text}} or {{myVariableName.value}}.

Format An expression used to generate the label for each item. For example, the expression Mr. {{$item.name}} {{$item.surname}} is evaluated against the current work object and the selected item is available as $item.

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.
Minimum elements When multi-selection is enabled, this component specifies the minimum number of items to be selected.
Maximum elements When multi-selection is enabled, this component specifies the maximum number of items to be selected.

Attributes: Error messages

Attribute Description
Minimum elements When multi-select is enabled, this determines the error message that displays if the number of items selected is less than the minimum specified in validation.
Maximum elements When multi-select is enabled, this determines the error message that displays if the number of items selected is bigger than the maximum specified in validation.

Attributes: Documentation

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

To add your drop-down options:

  1. Select the component on the canvas.
  2. In the attribute bar, select Items.

    The Items dialog box appears.


  3. Click an empty space below the column header to add an item.
  4. Click OK to save the items and close the dialog box.