Description

Allows editing of dates with a date picker pop-up menu, or via keying in directly into the fixed format field.

See the Collecting and Displaying Data in a Structured Way guide as an example of how to use this macro.

Parameters

Name

Required

Migratable to Cloud?

Default Value

Description

[default] / name (Field Name)

  • (/)

  • NO

 

The name of the date data field. Must be unique.

required

  • (/)

  • NO

false/unchecked

If checked, this field cannot be empty.

minDate (Minimum Date)

  • (X)

  • NO

 

The minimum date that is allowed, format of date entered here must follow the format parameter. Default format is 'yyyy-MM-dd'.

maxDate (Maximum Date)

  • (X)

  • NO

 

The maximum date that is allowed, format of date entered here must follow the format parameter. Default format is 'yyyy-MM-dd'.

format (Display Format)

  • (X)

  • NO

yyyy-MM-dd

The format to display the date in. May contain any of the following special characters:

  • y - The year (eg. 'yy' = '05', 'yyyy' = '2005').

  • M - The month (eg. 'MMMM' = 'April', 'MMM' = 'Apr', 'MM' = '04').

  • d - The day (eg. 'dd' = '09', 'd' = '9').

  • H - The hour - 24 hour time (eg. 'HH' = '13').

  • h - The hour - 12 hour time (eg. 'h' = '1', 'hh' = '01').

  • m - The minute (eg. 'mm' = '23').

  • s - The second (eg. 'ss' = '14').

  • a - AM/PM (eg. 'a' = 'PM').

Editor View

Not applicable.

Macro Edit View

Not applicable.

Notes

  1. For version 8.21.9 and below, the date and time is saved and viewed as server time.

  2. For version 8.22.0 and above, Date data macro saves and displays the date and time according to the user's timezone. When users from different timezones view the saved date and time, it will be displayed as per the viewers' timezone.
    The default view for Date data macro will include the time zone.

  3. Scaffolding Date Data macro body can accept keywords to pre-populate the datetime during input. Supported Keywords are:

    Keyword

    Description

    Today / Now

    The datetime when the Scaffolding editor is opened.

    Yesterday

    The datetime when the Scaffolding editor is opened -24 hours.

    Tomorrow

    The datetime when the Scaffolding editor is opened +24 hours.

    1. The keywords don’t save/set default values for the date data macro.

    2. They only work as suggested/default input when the editor is opened.

    3. The keyword datetime will only display during input for new/empty macros. Once a value has been saved/set for a date data macro, the keyword in the body of that same macro is ignored when the editor is opened the next time.

    4. Pre-populated date inputs use server time.

Tutorial Examples