Boolean User Profile Item
Description
A configurable user profile item of type boolean. This will be represented as a checkbox in input form. The selected value is added to the user's context data, provided that the property name matches the property name in the configured user data. If the item is configured as not optional, the user is forced to check the field before they are allowed to continue. This can be used to require the user to accept terms and conditions.
May be used by
Properties
Format As Boolean Object (
formatAsBooleanObject) Description
Determines whether the value should be saved as a java.lang.Boolean object. If this is not selected, the value is saved as a String.
Attributes
Boolean
Optional
Default value
true
String Resource Key (
stringResourceKey) Description
String identifier for the language-specific string tables.
Attributes
String
Mandatory
Example
userdata.label.salutation
Example
userdata.label.firstname
Example
userdata.label.lastname
Example
userdata.label.email
Example
userdata.label.nationality
Example
userdata.label.birthdate
Example
userdata.label.street
Example
userdata.label.street-number
Example
userdata.label.address2
Example
userdata.label.zipcode
Example
userdata.label.town
Example
userdata.label.state
Example
userdata.label.country
Example
userdata.label.company
Example
userdata.label.department
Example
userdata.label.office-phone
Example
userdata.label.mobile-phone
Example
userdata.label.language
Example
userdata.label.correspondence-language
Property Name (
propertyName) Description
Name of the context-data field in which the value is stored.
Attributes
String
Mandatory
Example
surname
Example
givenname
Example
email
Example
mtan_number
Optional (
optional) Description
If this field is optional or mandatory for the user.
Attributes
Boolean
Optional
Default value
true
Modifiable (
modifiable) Description
Indicates if the user is allowed to change this property once it is set. Specifically, if this flag is set to false, then during self-registration the property could be set, but when editing the user data, this property would be read-only.
Attributes
Boolean
Optional
Default value
true
Validate Only Changed Values (
validateOnlyChangedValues) Description
If enabled, only values that have been changed by the user (compared to the data loaded from the data layer) are validated.
Attributes
Boolean
Optional
Default value
true
Sortable (
sortable) Description
If enabled, the attribute is sortable in the user list if the underlying user iterator supports sorting.
Attributes
Boolean
Optional
Default value
true
YAML Template (with default values)
type: BooleanUserProfileItem
id: BooleanUserProfileItem-xxxxxx
displayName:
comment:
properties:
formatAsBooleanObject: true
modifiable: true
optional: true
propertyName:
sortable: true
stringResourceKey:
validateOnlyChangedValues: true