Scheduler Web Control Scheduler Web Control

Scheduler Web Control

Adam Evans Adam Evans

Overview

The Scheduler Web Control allows users to schedule appointments by selecting blocks of time from pre-specified options defined in the Calendar Builder.

2021-09-16_15-09-37__1_.gif

Control Properties

calendarRestriction

A string corresponding to a key tied to an Availability Schedule (created in the Calendar Builder). To be correctly parsed, this key must be written with quotation marks around it.

Defining a value for calendarRestriction is optional, but if a value is defined, the designated Availability Schedule serves to restrict what blocks of time can be selected within a Scheduler. Only blocks of time encompassed by the Availability Schedule specified in calendarRestriction will be available for users to select.

minimumDaysOut

A Number defining the earliest day a user can select a time block in relation to the day they are accessing the scheduler.

For example, if minimumDaysOut is defined as 0, a user might select a time block on that very day, whereas if minimumDaysOut is defined as 3, the earliest a user might be able to select a time is three days in the future.

maximumDaysOut

A Number defining the earliest day a user can select a time block in relation to the day they are accessing the scheduler.

For example, if maximumDaysOut is defined as 3, the latest a user might be able to select a time is three days in the future. It is not recommended but technically possible to define maximumDaysOut so that its numerical value is less than the numerical value of minimumDaysOut; in such a case, users will be barred from making any appointments at all.

Schedule

Calendar

Set the Availability Schedule that will define the blocks of time available for users to select. See the documentation on Calendar Builder for a deeper diving into how to create an Availability Schedule that serves your needs.

Schedule Data Object

Set the Schedule Object that will store the information your Scheduler Web Control collects from users. If you have not yet made a Schedule Object, you will need to define one in Data Builder in order for information collected from users by the scheduler to be automatically saved. It is possible but not recommended to forgo associating a Scheduler Web Control with a Scheduler Object; in such cases, information entered by users will be lost unless explicitly saved elsewhere. See Actions section for more on how this might be done.

Placeholder

Define the placeholder text that will be displayed if a user selects a day in which there are no blocks of time available. By default – that is, if this section is left blank – the placeholder will display as "No Available Times".

Layout

Define the layout of the calendar portion of the Scheduler Web Control. Options are:

  • 1 week - Display seven days at a time.
  • 2 weeks - Display fourteen days at a time.
  • 1 month - Display the entire month.

Style

By default, there is only a single variant, default, associated with the Scheduler Web Control, although more can be added and edited in the Theme Builder

The Scheduler Web Control is a compound web control; styling requires making changes to individual components, themselves individual Web Controls. This can be done either in the Theme Builder (by changing which variant of the component Web Controls will be used to make up the scheduler) or in the Activity Builder (by selecting component Web Controls nested under the styling section of the Tree).

Actions

Value Changed

Actions associated with a Scheduler Web Control are triggered when a user selects an available time slot. This condition is designated as Value Changed within the Action Builder because when a user selects an available time slot the value of event.value changes.

event.value

When working with Scheduler Web Controls, event.value is the event-level variable associated with the Scheduler Web Control. When a user selects an available time slot, the value of event.value is set to a Schedule Object that reflects the user's selection. Assuming a particular Schedule Object in AirData has been associated with this scheduler, it will automatically be updated. That is, there will be no need to explicitly update the associated Schedule Object via an AirData query; that is already handled under the hood.

Due to the nature of variable scopes, this value of event.value will only be accessible to actions taken within the Scheduler Web Control. To access it downstream, the immediate value of event.value will need to be passed to another variable of a broader scope. This can be done by using the Set Variable Action.