Date time type

The Date time type dynamic enumeration (DateTimeValueType) specifies choices for the 'type' in the Relative date with time value resolver:

All options except the 'Custom' type are predefined time specifications for which a Pattern (highlighted in blue by selection in the screenshot below) can be stored for the date calculation, which is applied relative to the current system time.
For the 'Custom' (CUSTOM) option, the Pattern is ignored (it is empty by default) because a pattern in the 'Time value' parameter in the Relative date with time value resolver is used instead (see Relative date with time for details).

images/download/attachments/212896301/image2022-9-12_7-46-30-version-1-modificationdate-1751627106937-api-v2.png

The following definitions for default values are predefined at delivery:

Name	Localization (English)	Pattern (Syntax see Relative date with time)	Comments
*System time*
`NOW`	Now	<empty>	no pattern necessary ('Now' = system time without offset)
*Timeline*
`LAST_HOUR`	Last Hour	`-60m`	... the time 3,600,000 milliseconds before 'Now' (= '60 minutes ago')
`NEXT_HOUR`	Next Hour	`+60m`	... the time 3,600,000 milliseconds after 'Now' (= 'in 60 minutes')
*Calendar day (period)*
`START_TODAY`	Start of today	`0h 0m 0s 0S`	... the first millisecond of the current calendar day
`END_TODAY`	End of today	`23h 59m 59s 999S`	... the last millisecond of the current calendar day
`START_TOMORROW`	Start of next day	`0h 0m 0s 0S +1d`	.... the first millisecond of the next calendar day (`+1d`)
`END_TOMORROW`	End of next day	`23h 59m 59s 999S +1d`	... the last millisecond of the next calendar day (`+1d`)
`START_YESTERDAY`	Start of previous day	`0h 0m 0s 0S -1d`	... the first millisecond of the previous calendar day (`-1d`)
`END_YESTERDAY`	End of previous day	`23h 59m 59s 999S -1d`	... the last millisecond of the previous calendar day (`-1d`)
*Calendar week (period)*
`START_THIS_WEEK`	Start of current week	`0h 0m 0s 0S 1E`	... the first millisecond of the first day of the week (`1E`)
`END_THIS_WEEK`	End of current week	`23h 59m 59s 999S 7E`	... the last millisecond of the last day of the week (`7E`)
`START_LAST_WEEK`	Start of previous week	`0h 0m 0s 0S -7d 1E`	... the first millisecond of the first day (`1E`) of the previous week (`-7d`)
`END_LAST_WEEK`	End of previous week	`23h 59m 59s 999S -7d 7E`	... the last millisecond of the last day (`7E`) of the previous week (`-7d`)
`START_NEXT_WEEK`	Start of next week	`0h 0m 0s 0S +7d 1E`	... the first millisecond of the first day (`1E`) of the next week (`+7d`)
`END_NEXT_WEEK`	End of next week	`23h 59m 59s 999S +7d 7E`	... the last millisecond of the last day (`7E`) of the next week. (`+7d`)
*Calendar month (period)*
`START_THIS_MONTH`	Start of current month	`0h 0m 0s 0S 1d`	... the first millisecond of the first day of the current month (`1d`)
`END_THIS_MONTH`	End of current month	`23h 59m 59s 999S 1d +1M 0d`	... the last millisecond of the day before the first day (`0d`) of the next month. (`+1M`) ►NOTE◄ Because of the variable number of days per month, it is necessary to jump to the first day (`1d`) of the current month, and then move to the first of the following month (`+1M`). From there `0d` (or alternatively `-1d`) addresses the previous calendar day.
`START_LAST_MONTH`	Start of previous month	`0h 0m 0s 0S 1d -1M`	... the first millisecond of the first day (`1d`) of the previous month (`-1M`)
`END_LAST_MONTH`	End of previous month	`23h 59m 59s 999S 0d`	... the last millisecond of the day before the first day (`0d`) of the current month
`START_NEXT_MONTH`	Start of next month	`0h 0m 0s 0S 1d +1M`	... the first millisecond of the first day (`1d`) of the next month (`-1M`)
`END_LAST_MONTH`	End of next month	`23h 59m 59s 999S 1d +2M 0d`	... the last millisecond of the day before the first day (`0d`) of the month after next (`+2M`). ►NOTE◄ Because of the number of days per month variable, it is necessary to jump to the first day (`1d`) of the current month and then move to the first of the month after next (`+2M`). From there `0d` (or alternatively `-1d`) addresses the previous calendar day.
*Calendar year (period)*
`START_THIS_YEAR`	Start of current year	`0h 0m 0s 0S 1d 1M`	... the first millisecond of the first day of the current year (`1d 1M`)
`END_THIS_YEAR`	End of current year	`23h 59m 59s 999S 12M 31d`	... the last millisecond of the last day of the current year (`12M 31d`)
`START_LAST_YEAR`	Start of previous year	`0h 0m 0s 0S 1d 1M -1y`	... the first millisecond of the first day of the year (`1d 1M`) in the previous year (`-1y`)
`END_LAST_YEAR`	End of previous year	`23h 59m 59s 999S 12M 31d -1y`	... the last millisecond of the last day of the year (`12M 31d`) in the previous year (`-1y`)
`START_NEXT_YEAR`	Start of next year	`0h 0m 0s 0S 1d 1M +1y`	... the first millisecond of the first day of the year (`1d 1M`) in the next year (`+1y`)
`END_NEXT_YEAR`	End of next year	`23h 59m 59s 999S 12M 31d +1y`	... the last millisecond of the last day of the year (`12M 31d`) in the next year (`+1y`)
*Quarter (period)*
`START_THIS_QUARTER`	Start of current quarter	`0h 0m 0s 0S +0q`	... the first millisecond of the first day of the current quarter (`+0q`)
`END_THIS_QUARTER`	End of current quarter	`23h 59m 59s 999S +0Q`	... the last millisecond of the last day of the current quarter (`+0Q`)
`START_LAST_QUARTER`	Start of previous quarter	`0h 0m 0s 0S -1q`	... the first millisecond of the first day of the previous quarter (`-1q`)
`END_LAST_QUARTER`	End of previous quarter	`23h 59m 59s 999S -1Q`	... the last millisecond of the last day of the previous quarter (`-1Q`).
`START_NEXT_QUARTER`	Start of next quarter	`0h 0m 0s 0S +1q`	... the first millisecond of the first day of the next quarter (`+1q`)
`END_NEXT_QUARTER`	End of next quarter	`23h 59m 59s 999S +1Q`	... the last millisecond of the last day of the next quarter (`+1Q`)
*Special times*
`IN_THE_PAST`	In the past	`0y 1M 1d 0H 0m 0s 0S`	... first millisecond of the first day of the year 0 (`0y 1M 1d`) 'Beginning of the calendar'
`IN_THE_FUTURE`	In the future	`9999y 12M 31d 23H 59m 59s 999S`	... last millisecond of the last day of the year (`9999y 12M 31d`) 'End of the calendar'
*Freely definable*
`CUSTOM`	Custom	<empty>	... enables the definition of a 'custom' pattern via the 'Custom time' parameter in the Relative date with time value resolver

If required, custom 'time types' with a specific Pattern can be added or, if necessary, existing ones can be removed.

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/warning.svg CAUTION The Pattern for predefined entries can basically be edited and so customized. However, any change to a predefined Pattern immediately and globally affects all existing references, e.g. even if the Relative date with time value resolver is used in criteria in the context of the Search API. This can have far-reaching consequences for the runtime behaviour of Lobster Data Platform / Orchestration as well as all Lobster_data profiles that use the Search API. If necessary, it is therefore advisable to assign alternative definitions from the default to specially added values for the calculation logic. Then, for each reference, there is a choice between the 'factory default' and a 'custom default'. If required, Enumeration filters can be used to restrict this selection, e.g. depending on Association criteria.