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