Checkbox

The Checkbox component allows users to toggle a single Boolean option. Use this component when you need to capture a simple yes or no response to a question or to indicate a single independent setting, such as agreeing to terms and conditions.

Use the Checkbox Group component for a list of multiple independent options from which users can select one or more.

The class of the stored value is Boolean, representing true if the checkbox is selected and false if it is not.

You can show a pre-selected checkbox by setting the Default value property to true.

If you mark the component as required, users must select it to be able to submit the form.

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.

Validation properties

Attribute	Description
Required	Whether the component must have a value for the form to be submitted.

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.