Date form control

A form control that lets a form user select or enter a date.


Date form control

Configure the Date form control

To configure the Date Date icon control, do the procedure in this topic.

Video: Add a Date Control to an eForm

Video: Common Configuration Settings in eForm Controls

Examples

Good to Know

How to Start

  1. Open eForm Builder.

    For information about how to open this screen, refer to eForm Builder screen.


    Eform Builder screen
  2. On the eForm Builder screen, in the Tool Box, open the Commmon Controls tab.

    Common Controls tab
  3. On the Common Controls tab, drag a Date Date icon form control onto your eForm.

    Date Form Control

Procedure

  1. Complete the settings on the configuration screens.

    You can use the Data screen screen to specify a variable.

General

Specifies the basic configuration for the Date form control.

Figure: General tab

General tab

Fields

Field NameDefinition

Label
Description:
Specifies the text label that shows on your form for the control.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Different for different controls.
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Internal Name
Description:
Specifies a unique, technical name for your control.
Allowed Values:
One line of text (a string).

Not Accepted:

  • Spaces
Default Value:
Different for different controls.
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Default Value
Description:
Specifies what date to show in the field by default.
Allowed Values:
  • Current Date
  • Specific Date
  • Days After Current Date
  • Days Before Current Date
  • Variable - Any variable in date-time format.
Default Value:
None
Example:
Refer to:

System Variable
Description:
Spcifies the system data variable to use in a field.
To Open this Field:
  1. In the Default Value field, select Variable.
Allowed Values:
A process data variable.
Default Value:
None
Example:
  • Refer to:
  • Examples of system variables you can use in this field:
    • Process Started Date
    • Process Started Date (ISO)
    • Task Assigned Date
    • Task Assigned Date(ISO)

Date
Description:
Specifies the date that shows in your field.
To Open this Field:
  1. In the Default Value field, select Specific Date from the list.
Allowed Values:
A valid date.
Default Value:
None
Example:
Refer to:

Number of Days
Description:
Specifies the number of days before or after the current date to show in your field.
To Open this Field:
  1. In the Default Value field, select one of these from the list:
    • Days After Current Date
    • Days Before Current Date
Allowed Values:
An integer.

Range

  • 0-99999
Default Value:
None
Example:
Refer to:

Help Text
Description:
Specifies the text to shows when a runtime app user hovers their cursor over the form control.
Allowed Values:
More than one line of text.
Default Value:
None
Example:
Refer to:

Help Text Display
Description:
Specifies if the field shows the text in the Help Text field when the runtime app user hovers over the label or field.
Allowed Values:
  • None - Does not show the help text.
  • Hover On Label - Shows the help text when you put your mouse on the label.
  • Hover On Field - Shows the help text when you put your mouse on the field.
  • Hover On Both - Shows the help text when you put your mouse on the label and Field.
Default Value:
None
Example:
Refer to:

Configure

Configures advanced settings for your form control.

Figure: Configure tab

Configure tab

Fields

Field NameDefinition

Required
Description:
Specifies if the field is mandatory.
Allowed Values:
  • Deselected - The field is not mandatory.
  • Selected - The field is mandatory.
Default Value:
Deselected
Example:
Refer to:

Validation Message for Required Field
Description:
Specifies the message to show if the form user does not enter data in a mandatory form control.
Allowed Values:
More than one line of text.
Default Value:
Enter the ${L}

${L} is a variable that shows the name of the form control.

Example:
Refer to:

Date Format
Description:
Specifies the date format that the form control shows.

The control stores the date value in ISO 8601 format.

Allowed Values:
  • dd/MM/yyyy - Shows the date in the format day/Month/year.
  • MM/dd/yyyy - Shows the date in the format Month/day/year.
  • dd MMM yyyy - Shows the date in the format day Month year.
  • MMM dd yyyy - Shows the date in the format Month day year.
  • yyyy-MM-dd - Shows the date in the format year-Month-day.
  • dd.MM.yyyy - Shows the date in the format day.Month.year.
Default Value:
MM/dd/yyyy
Example:
  • 09/21/1978
  • 21/09/1978
  • 1978/09/21

Also refer to:

Minimum Date
Description:
Specifies what date to show in the field as a first date.
Allowed Values:
  • Current Date
  • Specific Date
  • Days After Current Date
  • Days Before Current Date
  • Variable - Any variable in date-time format.
Default Value:
None
Example:
Refer to:
Limitations:

The Current Date, Specific Date, Days After Current Date, Days Before Current Date, and Token options are available in these releases:

Maximum Date
Description:
Specifies what date to show in the field a last date.
Allowed Values:
  • Current Date
  • Specific Date
  • Days After Current Date
  • Days Before Current Date
  • Variable - Any variable in date-time format.
Default Value:
None
Example:
Refer to:
Limitations:

The Current Date, Specific Date, Days After Current Date, Days Before Current Date, and Token options are available in these releases:

Date
Description:
Specifies the date that shows in your field.
To Open this Field:
Do one of these:
  • In the Minimum Date field, select Specific Date.
  • In the Maximum Date field, select Specific Date.
Allowed Values:
A valid date.
Default Value:
None
Example:
Refer to:
Limitations:

This field is available in these releases:

Number of days
Description:
Specifies the number of days before or after the current date to show in your field.
To Open this Field:
  • In the Minimum Date field, do one of these.
    • Select Days After Current Date.
    • Select Days Before Current Date.
  • In the Maximum Date field, do one of these.
    • Select Days After Current Date.
    • Select Days Before Current Date.
Allowed Values:
An integer.

Range

  • 0-99999
Default Value:
None
Example:
Refer to:
Limitations:

This field is available in these releases:

System Token
Description:
Spcifies the system data variable to use in a field.
To Open this Field:
Do one of these:
  • In the Minimum Date field, select Token.
  • In the Maximum Date field, select Token.
Allowed Values:
A process data variable.
Default Value:
None
Example:
Refer to:
Limitations:

This field is available in these releases:

Show Dates In Other Months
Description:
Specifies if the form control shows the dates in other months to the form user.
Allowed Values:
  • Selected - Shows the dates in other months.
  • Deselected - Does not show the dates in other months.
Default Value:
Deselected
Example:
Refer to:

Show Multiple Months
Description:
Specifies if the form control shows the dates in multiple months to the form user.
Allowed Values:
  • Selected - Shows the dates in multiple months.
  • Deselected - Does not show the dates in multiple months.
Default Value:
Deselected
Example:
Refer to:

Show Week Of The Year Number
Description:
Specifies if week number of the year is shown on the form control.
Allowed Values:
  • Deselected - The week number is not shown.
  • Selected - The week number is shown.
Default Value:
Deselected
Example:
Refer to:

Allow Manual Entry
Description:
Specifies if the form user can enter the date as text.
Allowed Values:
  • Selected - Lets the form user enters the date as text.

    The form user can only enter the date as text in year/month/day or month/day/year formats. The format day/month/year is not accepted.

  • Deselected - The form user can not enter the date as text.
Default Value:
Deselected
Example:
  • 09/21/1978
  • 1978/09/21

Also refer to:

Appearance

Specifies the look and feel for your form control.

Figure: Appearance tab

Appearance tab

Fields

Field NameDefinition

Font Family
Description:
Specifies the font family of the input text and label.
Allowed Values:
A font name from the list.
Default Value:
  • Modern theme - Roboto
  • Classic theme - Arial
Example:
Refer to:

Font Style
Description:
Specifies the style of the font for the input text and label.
Allowed Values:
  • Bold - Shows the input text and label in bold.
  • Underline - Shows the label underlined.
  • Italic - Shows the label in italic.
Default Value:
None
Example:
Refer to:

Background Color
Description:
Specifies the background color for your control.
Allowed Values:
A color value using a hex code, RGB code, or RGBA code.

You can enter a color code, or select a color from the palette.

Default Value:
#ff0000
Example:
Refer to:

Border Color
Description:
Specifies the border color for your control.
Allowed Values:
A color value using a hex code, RGB code, or RGBA code.

You can enter a color code, or select a color from the palette.

Default Value:
#ff0000
Example:
Refer to:

Foreground Color
Description:
Specifies the foreground color for your control.
Allowed Values:
A color value using a hex code, RGB code, or RGBA code.

You can enter a color code, or select a color from the palette.

Default Value:
#ff0000
Example:
Refer to:

Apply Font Properties To Control
Description:
Specifies if the control gets the font properties from the properties set in the form settings.
Allowed Values:
  • Selected - The control gets the font properties from the properties set in the form settings.
  • Deselected - The control does not get the font properties from the properties set in the form settings.
Default Value:
Deselected
Example:
Refer to:

Label CSS Class
Description:
Specifies a CSS class for the label of your control.
Allowed Values:
A valid CSS class.
Default Value:
None

If you specify your CSS CSS icon on the top menu, the CSS is populated.

Example:
Refer to:

Field CSS Class
Description:
Specifies a CSS class for the field in your control.
Allowed Values:
A valid CSS class.
Default Value:
None

If you specify your CSS CSS icon on the top menu, the CSS is populated.

Example:
Refer to:

Container CSS Class
Description:
Specifies a CSS class for the container of your control.
Allowed Values:
A valid CSS class.
Default Value:
None

If you specify your CSS CSS icon on the top menu, the CSS is populated.

Example:
Refer to:

Font Size (px)
Description:
Specifies the size of the input text and label for your form control.
Allowed Values:
An integer.

Range

  • Greater than 0
Default Value:
  • Classic theme - 12
  • Modern theme - 14
Example:
Refer to:

Behavior

Specifies how the control shows on your form.

Figure: Behavior tab

Behavior tab

Fields

Field NameDefinition

Enabled
Description:
Specifies if the form user can change the value of a field.
Allowed Values:
  • Selected - The form user can change the value.
  • Deselected - The input cannot change the value.
Default Value:
Selected
Example:
Refer to:

Right To Left
Description:
Specifies if the text for this control, including user input, shows from right to left.
Allowed Values:
  • Deselected - The text shows from left to right.
  • Selected - The text shows from right to left.
Default Value:
Deselected
Example:
Refer to:

Visible
Description:
Specifies if the runtime app user sees the field.
Allowed Values:
  • Selected - The runtime app user sees the field.
  • Deselected - The runtime app user does not see the field.
Default Value:
Selected
Example:
Refer to:

Text Align
Description:
Specifies the horizontal alignment of user input for this control.
Allowed Values:
  • Left - Aligns the text to the left.
  • Center - Centers the text.
  • Right - Aligns the text to the right.
Default Value:
Left
Example:
Refer to:

Label Position
Description:
Specifies the position of the text label that shows on your form for the control.
Allowed Values:
  • Inherit - The position of the label is as specified in the form settings.
  • Left - Specifies that the position of the label is to the left of the container.
  • Top - Specifies that the position of the label is to the top of the container.
Default Value:
Inherit
Example:
Refer to:

Advanced

Specifies advanced settings for your form control.

Figure: Advanced tab

Advanced tab

Fields

Field NameDefinition

Field ID
Description:
Shows an ID of the control.
Allowed Values:
Read only.
Default Value:
Different for different controls.
Example:
Refer to:

JavaScript Event
Description:
Specifies the JavaScript event that causes an effect.
Allowed Values:
  • None - No action.
  • Blur - When a form user leaves an input field.
  • Change - When a form user changes the content of an input field or selects a value.
  • Click - When the form user clicks a button.
  • Double Click - When the form user double-clicks text.
  • Focus - When an input field gets focus.
  • Keydown - When a form user holds down a key.
  • Keypress - When the form user presses a key.
  • Keyup - When the form user releases a key.
Default Value:
None
Example:
Refer to:

JavaScript Function
Description:
Specifies the name of a JavaScript function to complete the activity.
Allowed Values:
The name of a Javascript function that exists in your app.

For more information, refer to (Example) Use Custom JavaScript in an eForm.

Default Value:
None
Example:

ConfirmSubmission where one of these is your function:

function ConfirmSubmission()
  {
    alert ('Are you sure to submit this form?');
    return true;
  }
function ConfirmSubmission(parameter1,parameter2)
  {
    window.alert ( parameter1 * parameter2);
    
  }

Also refer to:

Data Security Settings
Description:
Specifies whether to store information from the field in the process schema, so the app can use it again, or to simply pass on the information after the form is submitted without storing the information. This option helps to protect sensitive user information.
Allowed Values:
  • Persist - Stores the data from the field in the process schema, so the app can use it again.
  • Do Not Persist - Does not store the data from the field in the process schema. This option provides greater security for sensitive user information.
Default Value:
Persist
Example:
Refer to:

Store Date as Plain Text, and not ISO format
Description:
Specifies if the date information is stored in plain text or in ISO 8601 date format.
Allowed Values:
  • Selected - The date information is stored in yyyy-mm-dd format as plain text.
  • Deselected - The date information is stored in ISO 8601 date format, and the time is stored as 12:00 a.m.
Default Value:
Selected
Example:
Refer to:
Limitations:

By default, this field is selected in these releases:

Capture Time
Description:
Specifies whether to store the time from your local machine when you select a date.
Allowed Values:
  • Selected - The time information of your local machine is stored.

    To enable this field, you must deselect Store Date as Plain Text, and not ISO format.

  • Deselected - The date information is stored in ISO 8601 date format, and the time is stored as 12:00 a.m.
Default Value:
Deselected
Limitations:

This field is available in these releases:

Show On Tablet Devices
Description:
Specifies if the form field shows on a tablet.
Allowed Values:
  • Selected - The form field shows on a tablet.
  • Deselected - The form field does not show on a tablet.
Default Value:
Selected
Example:
Refer to:

Show On Mobile Phone Devices
Description:
Specifies if the form field shows on a mobile device.
Allowed Values:
  • Selected - The form field shows on a mobile device.
  • Deselected - The form field does not show on a mobile device.
Default Value:
Selected
Example:
Refer to: