Form property types

You should only use form properties to set configuration variables. While the Workflow Designer supports form properties for backwards compatibility, use form references when designing user tasks. Form references offer enhanced configuration options. If you prefer to use a form property instead of the recommended form reference to display a user task dialog box, you can choose between:

• Regular form property types.

• Drop-down form property types.

  You can determine how the drop-down form property is used by setting a form value.

The Type field lists the default form property types: String, Long, Boolean, Date, and Enum. To define any other type, choose Custom and specify the Custom type as listed below, in combination with Form values where applicable.

Start event form property types in Workflow Designer Collibra

Regular form property types

Form type	Responsibilities / Custom type	Purpose	Class of stored value
activity button	activityButton	Replaces the default Done button label on tasks with the value of the Name from property field. The button completes the task and sets its value to true. This form type only works for user tasks that have no additional forms.	Boolean
boolean	boolean	Only accepts boolean: true or false (not case sensitive).	Boolean
button	button	Replaces the default Submit button on a form with the value of the Name from property field. The button submits the whole form and sets its value to true.	Boolean
checkbox	checkbox	Allows users to select one or more values from a predefined list. You define the values in the Form values section by entering the Id and the Name for each check-box item.	String
dynamicCheckbox	Same as checkbox. You define the values as a map in a variable by providing the Id and the Name for each check-box item: [<Id1>:"<Name1>",<Id2>:"<Name2>",...]. You call the variable in the Form values section by entering dynamicValuesExpression as the Id and the variable as the Name: ${<variable_name>}.
date and time	datetime	Allows users to select the date or the date and the time form a calendar. Accepts timestamp values in long format. You define the format in the Form values section by entering dateTimeType as the Id and date or datetime as the Name for each check-box item.	Date
enumeration	enum	Allows users to select one value from a predefined drop-down list. You define the values in the Form values section by entering the Id and the Name for each list item.	String
dynamicEnum	Same as enum. You define the values as a map in a variable by providing the Id and the Name for each list item: [<Id1>:"<Name1>",<Id2>:"<Name2>",...]. You call the variable in the Form values section by entering dynamicValuesExpression as the Id and the variable as the Name: ${<variable_name>}.
upload	fileUpload	Creates a temporary file and stores the UUID in the variable of the workflow, so that the user can import or attach a file later on in the workflow.	String
number	long	Saves whole numbers. Decimal values are not accepted, they will be truncated to whole numbers. If you want to enter numbers with decimals, use a string type.	Long
plain text	plainText	Allows users to enter simple text. Similar to string with a larger text box, with the same height as text area.	TextArea
radio button	radiobox	Allows users to select one value from a predefined list. You define the values in the Form values section by entering the Id and the Name for each list item.	String
dynamicRadiobox	Same as radiobox. You define the values as a map in a variable by providing the Id and the Name for each list item: [<Id1>:"<Name1>",<Id2>:"<Name2>",...]. You call the variable in the Form values section by entering dynamicValuesExpression as the Id and the variable as the Name: ${<variable_name>}.
string	string	Allows users to enter simple text. Values exceeding 4,000 characters are automatically cut off, with '...' appended to the end. If you need to store more than 4,000 characters, use the textarea form type.	String
task button	taskButton	This form property type is deprecated and has no effect in the Latest UI. In the Classic UI, it replaces the default View task button label with the value of the Name from property field. This behavior occurs only when you select multiple similar tasks on the Tasks page, or when the task sidebar is disabled and tasks appear in the task bar. The button opens the task dialog box and sets its own value to true. This form type only works for user tasks that include additional forms.	Boolean
text area	textarea	Same as string, but indicates that the input has to be a text area field. There is no character limit. Use this type for large text content.	TextArea

Drop-down form property types

Type	Custom type	Description	Class of stored value
asset	asset term (legacy terminology, still supported)	Only allows assets as input. Checks whether the assets that are entered exist.	UUID
asset type	assetType	Only allows asset types as input.	UUID
attribute type	attributeType	Only allows attribute types as input.	UUID
community	community	Only allows communities as input. Checks whether the communities that are entered exist. This form property shows all communities, including the ones the user does not have permission to view. This allows them to use the workflow to request view access.	UUID
domain type	domainType	Only allows domain types as input.	UUID
group	group	Only allows groups as input. Checks whether the groups that are entered exist.	String The values are stored as a comma-separated list of group names.
relation type	relationType	Only allows relation types as entry values.	String in Collibra version 5.7.6 and newer. The values are stored as a comma-separated list of relation type UUIDs concatenated with the relation direction. The relation directions are: S or s for source, when the resource is the head of the relation. T or t for target, when the resource is the tail of the relation. Example 00000000-0000-0000-0000-000000007030S for has acronym [Acronym]. UUID in Collibra version 5.7.5 and older.
role	role	Only allows roles as input. Checks whether the roles that are entered exist.	String
role and community	roleInCommunity	Displays two side by side input boxes in which users can specify a role and an optional community. Checks whether the roles and communities that are entered exist.	String The values are stored as user expressions {role(<roleName>)} or {role (<roleName>,<communityName>)}.
user	user	Only allows users as input. Checks whether the users that are entered exist. User accounts that have been disabled are also included in the drop-down list.	String The values are stored as a comma-separated list of user names.
domain	domain vocabulary (legacy terminology, still supported)	Only allows domains as input. Checks whether the domains that are entered exist. This form property shows all domains, including the ones the user does not have permission to view. This allows them to use the workflow to request view access.	UUID

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