Versions Compared

Old Version 2

changes.mady.by.user Sze Kun Yan

Saved on

compared with

New Version Current

changes.mady.by.user Hugo

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Introduction

This UTC Date Pack contains a date picker form element as well as a date formatter that offers a range of versatile date-saving functions, including the ability to convert a date value to a custom timezone.


Installing The Plugin

In the Joget DX platform, go to settings > click on manage plugin > click on upload plugin > select the .jar file > upload

Plugin Usage

in the form builder, drag and drop the UTC Date Picker element into the form just like as shown in Figure 1.

Image Added
Figure 1: Usage of UTC date picker in the form builder


UTC Date Picker

Image Added
Figure 2: UTC Date Picker Properties


NameDescription
LabelElement Label to be displayed to the end-user.
ID

Element ID (By declaring as "date", a corresponding database table column "c_date" will be created)

Please see Form Element for more information about defining the ID and list of reserved IDs.

Allow Manual InputRather than using the calendar picker, a user may key in the date directly if checked.
Type

New date picker property to define the field type as:

  • Date Only
  • Date and Time
  • Time Only

Advanced Options

Data

Image Added
Figure 3: Data


NameDescription
Default Value

Default Value when there's no existing value found/selected.

The hash variable is accepted here. For example, you may key in the following.

#date.yyyy-MM-dd#

Data Format

The Data Format uses the Java date syntax. For example, the yyyy-MM-dd for 2019-10-23.

Read the Date Format Pattern Syntax documentation for a list of date formats you can use.

Using 24hr format

Checked for 24 Hours format.

Unchecked for 12 Hours format.

Store Date in UTCStores the date In UTC format.
Show User Time ZoneShows the time zone of the date and time.

Validation

Image Added
Figure 4: Validation


Name

Description

Validator

Attach a Validator plugin to validate the input value. Please see Form Validator.

Info
titleWhen will validation takes place?

Validation will take place whenever a form is submitted except when it is submitted as "Save as Draft"

Start Date Field IDThis option should be used in conjunction with "Set Current Date As".
End Date Field IDThis option should be used in conjunction with "Set Current Date As".
Set Current Date As

Choices of:-

  • Minimum Date
  • Maximum Date

UI

Image Added
Figure 5: UI


NameDescription
Display Format

The Display Format uses the jQuery date syntax. For example, the yy-M-dd displays as 2019-10-23.
Reference: https://github.com/phstc/jquery-dateFormat

When this field is left empty, the following will be considered.

  1. If the current locale starts with "zh", the format will be set as "yy-mm-dd".
  2. If "Using Locate Date Format" is set in General Settings, date format based on current user's locale will be used.
  3. Otherwise, it will use "M/dd/yy".
Date Picker Year Range

Range of years to be shown

In essence, the value left of the colon ":" must be a negative number and on the right must be a positive number. It indicates to Joget Workflow how many years earlier and how many years forward to display in the year select box based on the selected year.

A value of "c-0:c+0" is also valid, this indicates to the user that he cannot change the year value (it will default to the current system year).

Info
iconfalse
titleSample - Show 10 years before and after

c-10:c+10


Info
iconfalse
titleSample - Show specific year range

2000:2020

ReadonlyDetermines if the element is editable.
Display field as Label when readonly?

Displays the value of the element as plain text when an element is set to "Readonly".

Workflow

Image Added
Figure 6: Workflow Variable


NameDescription
Workflow Variable

If the form is part of a workflow process, upon saving of the form (by clicking on "Save as Draft" or "Complete" button). The value in this input field will be saved into the corresponding workflow variable named here.

Info
titleUsing a non-existent Workflow Variable name

You will get the following warning with the name printed out (e.g. status) in the server log if you attempt to map to a non-existent Workflow Variable.

Info
iconfalse
title

context attribute status does not exist in process context - adding new attributes to the process context is not allowed


UTC Date Formatter

Image Added
Figure 7: UTC Date Formatter Properties


NameDescription
Data Date Format

Set to follow your Joget System Settings > System Date Format, for example "dd-MM-yyyy hh:mm aa".

Use the Java date format. (Example: "yyyy-MM-dd" for "2011-06-11")
Read the Date Format Pattern Syntax documentation for a list of date formats you can use.

Display Date Format

Use Java date format. (Example: "dd/MM/yyyy" for "11/06/2011")
Read the Date Format Pattern Syntax documentation for a list of date formats you can use.

When this field is left empty, the following will be considered.

  1. If current locale starts with "zh", the format will be set as "yyyy-MM-dd".
  2. If "Using Locate Date Format" is set in General Settings, date format based on current user's locale will be used.
  3. Otherwise, it will use "MM/dd/yyyy".
Conversion 

Display a list of options that will change the date format based on the option chosen.

Available options:

  • change format
  • Value Stored in UTC, convert to current user's timezone
  • Value Stored in UTC, convert to custom timezone 
  • Value stored in server timezone, convert to UTC timezone
Timezone 

Components within this category are only visible when the "value stored in UTC, convert to custom timezone" option is chosen.

Timezone options are dynamically populated through the List of Time Zones


Example

In Figure 8, the UTC Date Picker will open with the current month and year preselected by default. Users can choose their desired date, hour, and minute.

Image Added
Figure 8: UTC Date Picker Example


Additionally, Users can also click on the "now" button which will get the current date and time of the User's timezone

Image Added
Figure 9: UTC Date Picker Example 2


Download Sample App