Date Supplier

Overview

Provides information about dates.

Details

Name:

Date Supplier

Prefix:

date

(optional)

Supported Content:

Dates

Provided By:

Supported Keys

The following are the list of keys which this supplier will return a value for.

Key

Content Types

Return Type

Description

milliseconds

Date

The number of milliseconds between the date and midnight, January 1, 1970.

at midnight

Date

Date

(Since 3.3.0) The supplied date, shifted to midnight at the beginning of the day, in the current user's timezone.

year

Date

(Since 3.3.0) The year value for the date.

month of year

Date

(Since 3.3.0) The month the year, with the first month starting at 1.

day of month

Date

(Since 3.3.0) The day of the month, with the first day starting at 1.

day of year

Date

(Since 3.3.0) The day of the year, with the first day starting at 1.

hour of day

Date

(Since 3.3.0) The hour of the day, from 0 to 23.

minute of hour

Date

(Since 3.3.0) The minute of the hour, from 0 to 59.

second of minute

Date

(Since 3.3.0) The second of the minute, from 0 to 59.

milli of second

Date

(Since 3.3.0) The millisecond within the second, from 0 to 999.

shift \ /-X

Date

Date

(Since 3.3.0) Shifts the date the specified time period 'X'. This is a combination of a digit/letter pairs representing a particular amount of time. Eg. "shift \ 1d 2m 3y" will shift the date forward 1 day, 2 months and 3 years.

Valid time periods are:

  • y - Year
  • m - Month
  • w - Week
  • d - Day
  • h - Hour
  • min - Minute
  • s - Second

round to X

Date

Date

(Since 3.4.0) Rounds the date to the specified time period. It is a combination of an amount and a time period. If you specify " " or "-", it will round up or down, respectively, otherwise it is to the nearest value.

e.g.:

  • "round to 1d" - round to the nearest day.
  • "round to -15min" - round down to the previous 15 minute block.
  • "round to \ 1h" - round up to the next hour.
  • "round to -1y" - round down to the first day of the current year.

[date format]

Date

Attempts to convert the date to a text value using the key as a date format, as defined by SimpleDateFormat.

e.g.:

  • "dd-MMM-yyyy"
  • "hh:mm:ss a"