Loading...

CRM Date/Time

Properties API

Widget Type:
Form Widgets
TPC Version:
  • 3.3 +
date-time-
The CRM Date/Time widget grants the option to easily enter dates and times to submit through a form. This allows users to select a date and/or time, which will then be automatically entered into the accompanying text box. By default it comes with a built in calendar and time picker buttons to make entering a date user friendly.

Configuration

Basic Setup

  1. rom the Portal Connector widget list, click and drag the CRM Date/Time widget into the body of your form.

  2. In order for the widget to function properly, it must be configured. Click on the edit button to display the prompt. It should look like this: 

    CRM Date Time Properties

Appearance

  1. When you are finished configuring the basic settings of the widget, click on the Appearance tab. It should look like this: 

    Date Time Appearance Tab

  2. When you are finished configuring the widget, click the save button to save it.

Widget Properties

Basic Properties

Select a Template

The Select a Template drop down list will allow you to select a template for your product to use with the option of creating a new template. If a template is selected, you will be given the additional option of editing the selected template.

Title

The Title text box will allow you to set the label of your widget. The title will usually appear above the associated widget.

Make Required

The Make Required checkbox will not allow a user to successfully submit the form until there is data within it. Upon selecting the checkbox you will be prompted to enter an error message for invalid input.

Read Only

The Read Only checkbox will not allow the user to interact with the widget when checked.

CRM Field

The CRM Field drop down list allows you to change what options will appear in a particular widget. For example, in a CRM Picklist, a CRM Field of Marital Status would contain the options: Single, married, divorced, and widowed. The CRM Fields available are dependant upon which CRM Entity has been chosen. Please note that some selections have a grey backdrop. This means that the CRM Field is a read-only field. Upon selection, the Read-Only checkbox will be automatically selected.

Date Format

The Format dropdown list allows you to choose between date, date & time, time, or a custom format. This will adjust the widget accordingly. If a custom format is selected, you will be provided with a textfield to set a custom format. More information on DateTime formats can be found here.

Use Blackout Dates

The Use Blackout Dates checkbox will allow you to apply Blackout Dates, which are dates and/or times that cannot be selected.

Include Weekends as Blackout Dates

The Include Weekends as Blackout Dates checkbox will automatically black out weekends from selection.

Allow User to Select Blackout Dates

The Allow User to Select Blackout Dates will allow the user to select their own blackout dates.

Hour Override

The Hour Override advanced property allows you to offset the submitted time of a CRM Date/Time widget. This property will accept any decimal number. Please note that this only works when the aforementioned widget is set to Date mode.

For example: You can use an Hour Override of -3 to set back the submitted date by three hours for those who are in a different time zone - like from EST to PDT. You may also use an Hour Override of 48 to offset the date by two days into the future.

Enable Typing

The Enable Typing advanced property will allow users to input their own dates without having to use the date and/or time picker. By default, this is set to true. The CRM Date/Time Picker is also able to parse different date formats as well; entries such as 'June 10th 1992' will work as will '12 09 10' which would be parsed as '2012-09-10'.

Advanced Properties

Advanced properties provide additional functionality. They can be accessed by clicking on the "Advanced" Button in the bottom right corner of the widget designer.

Select a Template

The Select a Template drop down list will allow you to select a template for your product to use with the option of creating a new template. If a template is selected, you will be given the additional option of editing the selected template.

Title

The Title text box will allow you to set the label of your widget. The title will usually appear above the associated widget.

Make Required

The Make Required checkbox will not allow a user to successfully submit the form until there is data within it. Upon selecting the checkbox you will be prompted to enter an error message for invalid input.

Read Only

The Read Only checkbox will not allow the user to interact with the widget when checked.

CRM Field

The CRM Field drop down list allows you to change what options will appear in a particular widget. For example, in a CRM Picklist, a CRM Field of Marital Status would contain the options: Single, married, divorced, and widowed. The CRM Fields available are dependant upon which CRM Entity has been chosen. Please note that some selections have a grey backdrop. This means that the CRM Field is a read-only field. Upon selection, the Read-Only checkbox will be automatically selected.

Date Format

The Format dropdown list allows you to choose between date, date & time, time, or a custom format. This will adjust the widget accordingly. If a custom format is selected, you will be provided with a textfield to set a custom format. More information on DateTime formats can be found here.

Use Blackout Dates

The Use Blackout Dates checkbox will allow you to apply Blackout Dates, which are dates and/or times that cannot be selected.

Include Weekends as Blackout Dates

The Include Weekends as Blackout Dates checkbox will automatically black out weekends from selection.

Allow User to Select Blackout Dates

The Allow User to Select Blackout Dates will allow the user to select their own blackout dates.

Hour Override

The Hour Override advanced property allows you to offset the submitted time of a CRM Date/Time widget. This property will accept any decimal number. Please note that this only works when the aforementioned widget is set to Date mode.

For example: You can use an Hour Override of -3 to set back the submitted date by three hours for those who are in a different time zone - like from EST to PDT. You may also use an Hour Override of 48 to offset the date by two days into the future.

Enable Typing

The Enable Typing advanced property will allow users to input their own dates without having to use the date and/or time picker. By default, this is set to true. The CRM Date/Time Picker is also able to parse different date formats as well; entries such as 'June 10th 1992' will work as will '12 09 10' which would be parsed as '2012-09-10'.

API

get_dateTimePicker()

Returns the DOM of the widgets' input element. 

Returns

HTML Element 

get_lblReadOnly()

Returns the DOM element of the label if the widget is in read-only mode.

Returns

String

get_readOnly()

Returns true if the widget is in read only mode.

Returns

Boolean

get_readOnlyValue()

Returns the date object of a widget set to read only mode.  

Returns

Object

get_dataFieldName()

Returns developer name for the control. 

Returns

String

get_value()

Returns the date object of the widget. 

Returns

Object

set_value()

Sets the date of a date/time widget. 

Returns

none

get_dateText()

Returns the selected date as a string. 

Returns

String

set_dateText()

Sets the date of the widget. Values must be formatted specifically, such as MM/DD/YYYY.

Returns

none

enable()

Enables the widget. 

Returns

none

disable()

Disables the widget. 

Returns

none

Full API With Examples

How to's

Examples of CRM Date/Time Configuration