Rich Text

The Rich Text component adds an input field for multiple lines of stylized text. This component allows users to enter and format text for capturing detailed descriptions, comments, or any information that benefits from more than plain text.

The class of the stored value is String.

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}} or {{self.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.
Text format	The language used to format the input text. The only allowed value is HTML.
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.
Minimum length	The minimum number of characters required for this component.
Maximum length	The maximum number of characters required for this component.
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.

Validation messages

Attribute	Description
Minimum length	The error message that shows if the input contains fewer characters than the required minimum length.
Maximum length	The error message that shows if the input contains more characters than the allowed maximum length.

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.