widgets.pbDateTimePicker.help.html Maven / Gradle / Ivy
Show all versions of ui-designer-artifact-builder-generator-angularjs Show documentation
Use this widget to select a date and a time (e.g., to schedule a meeting).
To select only a date (e.g., a date of birth), use the Date picker widget instead.
Date and time can reflect the user time zone (e.g., a meeting day and time) or be absolute, identical everywhere (e.g., opening hours of a store somewhere).
This is controlled by the property Handle time zone.
This widget can be used to display/update business variable attributes defined in the Business Data Model (BDM) with the following types:
- DATE-TIME (TIME ZONE) (based on
java.time.OffsetDateTime
): set the property Handle time zone to "Yes"
- DATE-TIME (NO TIME ZONE) (based on
java.time.LocalDateTime
): set the property Handle time zone to "No"
Value Format
The input/output of the widget (its Value) is an ISO 8601 formatted String variable.
With Handle time zone set to "yes": the Value of the widget is in UTC (e.g., yyyy-MM-ddTHH:mm:ssZ).
The display of dates and times relies on the user's browser time zone. Therefore, displayed values are different from stored values (except in the GMT time zone).
With Handle time zone set to "no": User time zone is ignored and the value of the widget does not contain any time zone information (e.g., yyyy-MM-ddTHH:mm:ss).
Technical Format
The Technical date format and Technical time format properties define the format of the values displayed in the date and time inputs.
They should be valid AngularJS date/time formats.
Today button sets the selected date to the current date for the user.
It doesn't change the selected time, except when the time is not set.
In that case, it's rounded up or down to the closest 5 min value.
Now button sets the selected date and time to the current date and time for the user.
For the time, it is rounded up or down to the closest 5 min value.
To display (and not update) a date and a time retrieved from the BDM API (or another API), you can either use this Date time picker widget with Read-only property set to "yes" or use a Text, Title or a Table widget and format the value using the provided uiDate filter.
The content of Label, Technical date formats, Placeholder properties, as well as the labels of buttons Today/Now are localized by default. Localized formats can be edited in the asset localization.json.
The values of all properties are also used as translation keys. As a result, if you choose not to keep the default values, update the asset localization.json accordingly.
Make sure the technical format values and their translations are valid date/time formats.
For more information, refer to the localization help section.