Checkbox Group

The Checkbox Group component adds a collection of independent options from which users can select none, one, or multiple items. Use this component when you need users to choose one or more items from a predefined list, and each choice is independent of the others. All available options are immediately visible on the form, making it suitable for short to medium-length lists.

Use the Radio Buttons component when users must select only one option from a list. Use the Select (Multiple) component when the list of options is long or when screen space is limited.

The class of the stored value is ArrayList. This allows for straightforward access to the elements of the list for further processing.

General properties

Property Description
ID The identifier of the component, primarily used for client-side interactions and identification in the HTML structure of the form. When you add a component, an ID is automatically generated to ensure it is unique in the form.
Label Text that appears above the form component in Collibra, briefly describing its purpose. This is the main title or question for the field.
Label tooltip

Additional help or information about the field. If defined, a question mark icon appears after the label, showing the tooltip when users hover their pointer over the icon.

The tooltip supports plain text only.
Documentation A text field for internal design notes or future reference about this specific component. This information is not visible in Collibra.
Value

The name of the variable that stores the data entered into this field in Collibra. Use a variable name enclosed in double curly braces, for example {{variableName}}. Since this is a process variable, you can then use it throughout your workflow processes, such as in scripts, other forms, or service tasks.

You can also specify where the variable is saved:

  • {{variableName}}: Stores the value as a process variable in the current workflow.
  • {{parent.variableName}}: Stores the value in a variable that belongs to the immediate parent process of the current workflow.
  • {{root.variableName}}: Stores the value in a variable that belongs to the root process, which is the top-level workflow that started the current one.
Default value The pre-filled value for the component when the form first appears. A filed shows the default value if the Value property does note set a value explicitly.
Tab Index The tabbing order of this component in a user task form. When navigating through the form by pressing the Tab key, the cursor moves from one component to another based on their assigned tab index numbers. The component with the lowest tab index number receives focus first. The focus then moves sequentially to the component with the next highest number. For example, a component with a tab index of 1 receives focus before a component with a tab index of 2.

The tab index is ignored if the component is inside a subform.

Datasource properties

Datasource properties are common to the components that accept a list of items or options.

Property Description
Items A list of text labels and values for the items or options shown in Collibra.

If you want to use dynamic values, provide an object that is declared as a list of maps that contain text and value elements, for example def myDynamicOptions = [[text:"text1", value:"value1"],[text:{{textVariable}}, value:{{valueVariable}}]].
Storage Specifies how the component variable stores the input data:
  • ID: The variable stores the selected value or comma-separated list of selected values.
  • Full value: The variable stores a Map or list of maps for multiple selection components. The value represents the full selection, containing both the text and value elements, such as [text:text1, value:value1]. This makes it possible to display other values of the selected element within the form as well.

Storing the full value could lead to variables full of unnecessary information.
Format Currently not in use.

Validation properties

Attribute Description
Required Whether the component must have a value for the form to be submitted.
Custom validations A list of additional validations for the component. Each custom validation consists of two parts:
  • Expression: A rule that must evaluate to true for the form to be submitted.
  • Error message: The message that shows if the expression evaluates to false.

For example, you can create a validation with the expression {{experience>2}}. This expression evaluates to true only if the value of the experience variable is greater than 2.

Rendering properties

Property Description
Ignored Whether the component is be hidden in the form and any value it might hold is not included in the submission data.
Visible Whether the component is shown or hidden on the form. You can controlled this unconditionally or through an expression. For example, you can set an expression that hides or shows the component based on a user selection in another component. This property is enabled by default.
Enabled Whether the component is interactive or read-only on the form. When disabled, users cannot change the component value. This property is enabled by default.
Description Additional information shown in Collibra below the form field, providing detailed instructions, examples, or essential guidance.

To add your checkbox group options:

  1. Select the component on the canvas.
  2. In the property bar, select Database icon Datasource → Items.

    The Items dialog box appears.

  3. Click Add Add icon to insert items consisting of a text label and associated value.
  4. Click Finish 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.