Widget Type:
Page Widgets
TPC Version:
  • 5.1
scheduler-logo

The new TPC Scheduler allows you to schedule and display events using any CRM entity data. This page level widget also can create recurring appointments using Appointment entity. One of the other key functionalities of this widget is that you can inline edit any of the events or event recurring appointment.  It very straight forward to setup this widget please follow these steps.

scheduler

Configuration

Basic Setting 

Drag and drop a scheduler widget to your page and click on the edit, it will open the widget designer. In the designer you have few options to choose from. First let’s walk through the basic settings. In the basic tab it allows you to enable add, edit, delete, export records and allow reschedule events.  If you want to enable editing you will have to select inline option on add and edit modes.

Settings

On the settings tab it will allow you to select the default view for the scheduler loads. Also, you can select the scheduler views that you would like to allow to select from the frontend of the widget.

Data

The data tab is use for defining the FetchXML, which will define what sort of records you want to show on your scheduler. You have the option of working with the primary entity or any other entity that the one has a relationship with.

Load Default: Will load the default FetchXML that set to the selected CRM entity. Build: Will let you build the FetchXML, and you will be able to select what fields that you want to display, filter the data, group the data.

Please refer to FetchXML Builder How-to for more information about the Fetch XML builder.

Please note:

An order for scheduler widget to work as intended it needs to have a two date fields, one numeric field, one bool and two string fields selected in your FetchXML

Fields

In the fields tab you will have to map the FetchXML attributes to each field from each dropdown. All the data you are setting on this tab will use towards setting the scheduler.  

Filters

The Filters tab contains a myriad of options to filter the records that the widget fetches. For example, you can filter records by the logged-in contacts' ID or by a query string value.

Widget Properties

Basic Properties

SchedulerSettings

SchedulerSettings can be found under Advanced > Model > SchedulerSettings

Property

Description

StartTime

The start time of the week and day views. The scheduler will display events starting after thestartTime. You have the options to set the current date for this property by simply typing “currentDate”

 

EndTime

The end time of the week and day views. The scheduler will display events ending before theendTime. You have the options to set the current date for this property by simply typing “currentDate”.

WorkDayStart

Sets the start of the work day when the "Show business hours" button is clicked. You have the options to set the current date for this property by simply typing “currentDate”

WorkDayEnd

Sets the end of the work day when the "Show business hours" button is clicked. You have the options to set the current date for this property by simply typing “currentDate”

Mobile

If set totrueand the scheduler is viewed on mobile browser it will use adaptive rendering.

Can be set to a stringphoneortabletwhich will force the widget to use adaptive rendering regardless of browser type.

 

SchedulerHeight

The height of the widget. Numeric values are treated as pixels.

SchedulerWidth

The width of the widget. Numeric values are treated as pixels.

ShowFooter

If set tofalsethe footer of the scheduler would not be displayed.

ShowWorkHours

If set to true the view will be initially shown in business hours mode. By default view is displayed in full day mode.

UseCurrentDate

Scheduler will use the current date .

Date

The current date of the scheduler. Used to determine the period which is displayed by the widget.

PdfExportFileName

Specifies the file name of the exported PDF file.

ServerPaging

If set totrue, the data source will leave the data item paging implementation to the remote service.


Allow Adding Records

The Allow Adding Records checkbox allows users to add records to theCRM Entity that the widget is configured to use. When checked, you will be prompted to choose a page or a form from which the widget will use to add records.

Allow Editing Records

The Allow Editing Records checkbox allows users to edit existing records from the CRM Entity that the widget is configured to use. When checked, you will be prompted to choose a page or a form from which the record will be edited from.

Allow Deleting Records

The Allow Deleting Records checkbox allows users to delete existing records from the CRM Entity that the widget is configured to use.

Allow Exporting Records

The Allow Exporting Records checkbox allows you to export and download the entirety of a CRM Entity in spreadsheet (.xls) format. Please note that this spreadsheet will include all selected data fields as per the BuildXML even if they don't physically appear on the widget.

Fetch XML

The FetchXML text area determines what sort of data a widget will be populated with. 

Clicking the Load Default Fetch option will populate the FetchXML area with a default fetch based on the CRM Entity chosen. By clicking the Build button, we will be sent to another page in order to determine what the widget will look up. For more information on how to use the FetchXML function.

AllowInlineEditing

The Allow Inline Editing checkbox allows users to inline edit the scheduler. When checked,you can just simply double click on any of the events or on the scheduler to add or edit records.

EnableBootstrapStyles

The EnableBootstrapStyles property gives the user the ability to enable or disable the Boostap style  that added in to the current form. By default, this property is set to True 

EnableKendoRtlSupport

The EnableKendoRtlSupport property gives the user the ability to enable or disable the Right to Left Support on the current form. By default, this property is set to False.

More Information about Kendo right to left support can be found in

 http://docs.telerik.com/kendo-ui/accessibility/supporting-rtl-languages

EnableKendoThemes

The EnableKendoThemes property gives the user the ability to enable or disable Kendo themes provided by Kendo. Kendo themes are applied to all the TPC widgets that uses Kendo UI Widgets.

More Information about kendo Themes can be found in : http://docs.telerik.com/kendo-ui/styles-and-layout/appearance-styling.

KendoTheme

The Kendo Theme property enables you to set a kendo theme to the form. Here are the list of kendo Themes that you set for this property;

  • Black
  • BlueOpal
  • Bootstrap
  • Default
  • Fiori
  • Flat
  • HighContrast
  • Material
  • MaterialBlack
  • Metro
  • MetroBlack
  • Moonlight
  • Nova
  • Office365
  • Silver
  • Uniform

More Information about kendo Themes can be found in 

http://docs.telerik.com/kendo-ui/styles-and-layout/appearance-styling

ExcelExportFileName

You can change the Excel Export file name and the file extension by changing the value of ExcelExportFileName property.

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.

SchedulerSettings

SchedulerSettings can be found under Advanced > Model > SchedulerSettings

Property

Description

StartTime

The start time of the week and day views. The scheduler will display events starting after thestartTime. You have the options to set the current date for this property by simply typing “currentDate”

 

EndTime

The end time of the week and day views. The scheduler will display events ending before theendTime. You have the options to set the current date for this property by simply typing “currentDate”.

WorkDayStart

Sets the start of the work day when the "Show business hours" button is clicked. You have the options to set the current date for this property by simply typing “currentDate”

WorkDayEnd

Sets the end of the work day when the "Show business hours" button is clicked. You have the options to set the current date for this property by simply typing “currentDate”

Mobile

If set totrueand the scheduler is viewed on mobile browser it will use adaptive rendering.

Can be set to a stringphoneortabletwhich will force the widget to use adaptive rendering regardless of browser type.

 

SchedulerHeight

The height of the widget. Numeric values are treated as pixels.

SchedulerWidth

The width of the widget. Numeric values are treated as pixels.

ShowFooter

If set tofalsethe footer of the scheduler would not be displayed.

ShowWorkHours

If set to true the view will be initially shown in business hours mode. By default view is displayed in full day mode.

UseCurrentDate

Scheduler will use the current date .

Date

The current date of the scheduler. Used to determine the period which is displayed by the widget.

PdfExportFileName

Specifies the file name of the exported PDF file.

ServerPaging

If set totrue, the data source will leave the data item paging implementation to the remote service.


Allow Adding Records

The Allow Adding Records checkbox allows users to add records to theCRM Entity that the widget is configured to use. When checked, you will be prompted to choose a page or a form from which the widget will use to add records.

Allow Editing Records

The Allow Editing Records checkbox allows users to edit existing records from the CRM Entity that the widget is configured to use. When checked, you will be prompted to choose a page or a form from which the record will be edited from.

Allow Deleting Records

The Allow Deleting Records checkbox allows users to delete existing records from the CRM Entity that the widget is configured to use.

Allow Exporting Records

The Allow Exporting Records checkbox allows you to export and download the entirety of a CRM Entity in spreadsheet (.xls) format. Please note that this spreadsheet will include all selected data fields as per the BuildXML even if they don't physically appear on the widget.

Fetch XML

The FetchXML text area determines what sort of data a widget will be populated with. 

Clicking the Load Default Fetch option will populate the FetchXML area with a default fetch based on the CRM Entity chosen. By clicking the Build button, we will be sent to another page in order to determine what the widget will look up. For more information on how to use the FetchXML function.

AllowInlineEditing

The Allow Inline Editing checkbox allows users to inline edit the scheduler. When checked,you can just simply double click on any of the events or on the scheduler to add or edit records.

EnableBootstrapStyles

The EnableBootstrapStyles property gives the user the ability to enable or disable the Boostap style  that added in to the current form. By default, this property is set to True 

EnableKendoRtlSupport

The EnableKendoRtlSupport property gives the user the ability to enable or disable the Right to Left Support on the current form. By default, this property is set to False.

More Information about Kendo right to left support can be found in

 http://docs.telerik.com/kendo-ui/accessibility/supporting-rtl-languages

EnableKendoThemes

The EnableKendoThemes property gives the user the ability to enable or disable Kendo themes provided by Kendo. Kendo themes are applied to all the TPC widgets that uses Kendo UI Widgets.

More Information about kendo Themes can be found in : http://docs.telerik.com/kendo-ui/styles-and-layout/appearance-styling.

KendoTheme

The Kendo Theme property enables you to set a kendo theme to the form. Here are the list of kendo Themes that you set for this property;

  • Black
  • BlueOpal
  • Bootstrap
  • Default
  • Fiori
  • Flat
  • HighContrast
  • Material
  • MaterialBlack
  • Metro
  • MetroBlack
  • Moonlight
  • Nova
  • Office365
  • Silver
  • Uniform

More Information about kendo Themes can be found in 

http://docs.telerik.com/kendo-ui/styles-and-layout/appearance-styling

ExcelExportFileName

You can change the Excel Export file name and the file extension by changing the value of ExcelExportFileName property.

API

show()

Shows the widget on the page.

Returns

None

get_element()

Returns the element of the widget.

Returns

jQuery Object

get_windowPlaceHolder()

Returns the modal window associated with the widget.

Returns

JQuery Object

get_model()

Returns the model object of the widget, which contains several useful properties related to the widget.

Returns

Object

get_kendoWindow()

Returns the kendo window of the widget (add/edit set to popup window).     

Returns

None

get_scheduler()

Returns the kendo Scheduler object.     

Returns

Kendo Grid Object  : kendo.ui.Grid

get_container()

Returns the container element of the widget.     

Returns

JQuery Object     

get_type()

Returns the widget type

Returns

string

toggle()

toggle the visibility of the widget on the page.

Returns

None

hide()

Hides the widget from the page.

Returns

None