Date User Profile Item
Description
Plugin to hold a configurable user profile item of type date (potentially including time information). This will correspond to a text input field is added to the user's context data, provided that the property name matches the property name in the configured user data. The date format can be configured as well acceptable date ranges. These can be absolute dates or in number of days relative to the current day.
May be used by
Properties
Date Format (
dateFormat) Description
Defines the date format of this item. The format is used for server-side validations and must correspond to other config options, such as "Earliest Date" and "Latest Date".
Attributes
String
Optional
Default value
dd.MM.yyyy
Allowed values
dd.MM.yyyy, dd-MM-yyyy, MM-dd-yyyy
Minimum Relative [days] (
minRelative) Description
The "minimum relative value" is the lower limit (earliest possible) for allowed difference in days to the current date.
Examples: A value of 1 means that tomorrow is the earliest possible day to enter, a value of -365 means that the entered date can be at most one year in the past.
Attributes
Integer
Optional
Earliest Date (
minDate) Description
The earliest date allowed to be filled in. This cannot be used together with "Minimum Relative" and must be in the same format as specified in "Date Format".
Attributes
String
Optional
Maximum Relative [days] (
maxRelative) Description
The "maximum relative value" is the upper limit (last possible) for allowed difference in days to the current date. This cannot be used together with "Max Date".
Examples: A value of 1 means that tomorrow is the latest possible day to enter, a value of -365 means that the entered date has to be at least one year in the past. Use this property to configure a minimal required age.
Attributes
Integer
Optional
Latest Date (
maxDate) Description
The latest date allowed to be filled in. This cannot be used together with "Maximum Relative" and it must be in the same format as specified in "Date Format".
Attributes
String
Optional
Date Transformation (
dateTransformation) Description
Defines how the date value should be transformed before it is persisted.
- DATE: the date value is transformed to a java.util.Date object (date with time, where all time values are set to 0).
Use 'Date And Time Context Data Item Config' for the corresponding context data item in the persister. - LOCAL_DATE: the date value is transformed to a java.time.LocalDate object (date only).
Use 'Local Date Context Data Item Config' for the corresponding context data item in the persister. - STRING: the date value is transformed to a String as defined by "Date Format".
Use 'String Context Data Item Config' for the corresponding context data item in the persister.
Attributes
Enum
Optional
Default value
LOCAL_DATE
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: DateUserProfileItem
id: DateUserProfileItem-xxxxxx
displayName:
comment:
properties:
dateFormat: dd.MM.yyyy
dateTransformation: LOCAL_DATE
maxDate:
maxRelative:
minDate:
minRelative:
modifiable: true
optional: true
propertyName:
sortable: true
stringResourceKey:
validateOnlyChangedValues: true