The Scheduler Field is used to allow users to view and schedule events on a calendar display.
Events are configured as separate, existing concepts. Multiple concepts can be configured to be allowed to be added as event types. The list of concepts added will be the list of events that a user can chose from to schedule.
New events can be added by double clicking on an available timeslot. If there are multiple scheduler events allowed, the user will be asked to specify the event type.
The scheduler data can be set to auto refresh after a specified period of time. This is useful for ensuring the display of accurate data when frequent updates occur.
Business hours can be configured on the scheduler to display to the user when are appropriate times to schedule events.
Note: When configuring the field’s position, it is recommended to use the full width of the page to be able to display the scheduler calendar appropriately.
Where Do We Get the Data for This Control?
Contains the target information of the target that will be called to populate the scheduler with events.
Enable Data Auto Refreshing
Determines if the scheduler data will refresh automatically after a specified period of time. It’s recommended to enable this if the data is frequently updated.
Every How Many Minutes Should the Data Refresh?
Only applicable when “Enable Data Auto Refreshing” is set to “Yes”.
Specifies the interval in minutes for automatically refreshing the scheduler data.
Allowed Scheduler Concepts
Determines the type of events a user can create in the scheduler when double clicking an empty timeslot. The concepts added to this list will be the event options available to users when scheduling a new event. If left empty, the user will not be able to create new events.
Each event type is simply a concept – the concept must already exist and contain the required fields below.
The minimum field requirements for a concept to be displayed in the scheduler are as follows:
- A String Field with the XML Element Name “Title“ – this will be the title used for the event.
- A List of Options Field with the possible options Yes and No with the XML Element Name “AllDayEvent“ – this will be used to determine if the event is an all-day event.
- A Period field with the XML Element Name “EventDateTime“ – this will be used as the events start/end date.
Business Hours Start
Specifies the start time for business hours on each weekday, Monday through Friday, on the scheduler.
Business hours will be highlighted in a different color on the scheduler to clearly indicate to users when these hours are. When the “Show Business Hours” button is selected at the bottom of the scheduler, the display will be condensed to show only the specified business hours.
If left empty, the business hours will start at 9am.
Business Hours End
Specifies the end time for business hours on each weekday, Monday through Friday, on the scheduler.
Business hours will be highlighted in a different color on the scheduler to clearly indicate to users when these hours are. When the “Show Business Hours” button is selected at the bottom of the scheduler, the display will be condensed to show only the specified business hours.
If left empty, the business hours will end at 5pm.
Custom Instance Window Title
Determines if a custom title will be applied to the instance window when an event is opened in a popup window.
If set to “No”, the window title will be the event name.
Instance Window Title
Only applicable when “Custom Instance Window Title” is set to “Yes”.
Contains the title that will be displayed when an event is opened in a popup window.