TracCloudGuideProfilePrefsSchedule: Difference between revisions

Scheduling Preferences

Your scheduling preferences allow you to modify appointment booking rules, controlling exactly when a student can book appointments, how many appointments they can book, and much more. These preferences will apply to all centers within the profile.

Time Restrictions

Schedule no sooner than...And no later than

This preference controls how early or late a student can book an appointment. The example below visualizes how this preference works, but the time range would typically be larger for a production system (e.g., no later than 12 hours, no sooner than 14 days).

No Cancellation within

Determines how late the student can cancel an appointment. If a student attempts to cancel within this time limit, they will be informed that the appointment will be counted as a missed appointment instead. Internally, the status will be recorded as "Cancel - Missed" (by default).

Minimum and Maximum Appointment Duration

This preference controls the minimum/maximum possible appointment time. If you exclusively offer 30 or 60 minute availabilities, this should be set to match. If an availability is created with time slots outside of the limit specified here, it will not appear in search results to students.

Default appointment duration

The default duration of an appointment. Typically used in an open-schedule environment, where consultants are available for many hours at a time, this will be the default duration when a student goes to book an appointment.

Appointment start in increments of

Increments of time that booked appointments can start at. For example, if this preference is set to 15 minutes, appointments could be booked at 9:15, 9:30, 9:45, and so on. This is not commonly used outside of open-schedule environments.

Appointment duration in increments of

Increments of time that an appointment can be booked for. For example, if this is set to 10 minutes, appointments can be booked for 20 minutes, 30 minutes, 40, and so on. This is not commonly used outside of open-schedule environments.

Restrict duration to intervals

The durations specified here will control the appointment durations shown during the appointment booking process.

File:3037437.png

Prevent booking consecutive appointments same student / consultant:

This prevents students from booking consecutive appointments with a tutor. Prevent Student applies this rule to students booking their own appointments, and Prevent Staff applies this rule to staff members booking on behalf of students. If the staff member's permission group has override permissions, they can override this rule (a warning informs them of this). The default consecutive limit is 2 (no back-to-back appointments), but this can be modified if needed. For example, a limit of "3" would allow a student to book a 1pm to 2pm, and 2pm to 3pm, but not a 3pm to 4pm.

Allow entry into online appointment session

These preferences control how soon/late a student can join a remote tutoring session by restricting when the Join button is available. If you’d like the student to be able to join 5 minutes prior to the start time through to the end, you would need to set “No sooner than” to 00:05 and set “No later than” to a value such as “1:00” (assuming you’re holding 1-hour appointments). No later than before end of appt counts back from the end time of the appointment rather than the start, and is an alternate option to No later than after start of appt.

QR Codes expire after

This applies to Batch Visit QR Codes and Ad-hoc Drop-in QR codes. If this is left blank, these codes can be used up to the end time of the visit. By setting this to a higher value, you can allow students to retroactively create visits for themselves after the visit has already taken place (e.g., in a recording). This preference counts from the start time of the session.

Block student from booking appointments between # and #

This preference allows you to prevent students from booking appointments during a specific time of day. This is more commonly used if Schedule no later than is set to a low value, such as a few hours, allowing students to book close to the start time of the appointment. For example, if you want to prevent a student from booking a morning appointment in the middle of the night so that your tutors have more notice for their upcoming schedule, this is the preference you'll want to change. Default is blank, which does not apply any restrictions based on time of day.

Special Fields

Each group of settings—Reasons, Locations, Sections, Fund—can be precisely adjusted to control where they show up and whether or not they’re required.
Enter in avail determines whether or not the field shows up within the availability entry window.
Enter in appointment determines whether or not the field shows up within the appointment entry window.
Required for Search means that in order for appointments in this profile to appear in search results, this field must not be empty.
Required for Save marks the field as required, so it must be filled out prior to booking the appointment. This applies more-so to Staff, as the above option already requires a student to have this field selected before they have the chance to book.

Appointment Location Choices

Allows to you to customize the locations available to choose from on Availability and Appointment entry. If used, this would typically be a more specific location than what your centers already describe. E.g., "Room 42 (location) in Peer Tutoring (center)."

Appointment Fund Choices

Allows you to customize the funds available to choose from on Availability and Appointment entry. More information on funds and payroll tracking in general can be found here.

Other Schedule Options

File:3225384.png

Allow students to cancel appointments

Provides students the option to cancel appointments (as long as they’re outside the time range specified in the first menu.)

Display consultant alias on availability search

This will display the consultant’s alias (specified in their staff profile) rather than their full name when students are searching for availabilities. An alias can also be automatically generated based on your System Preferences if preferred (e.g., First Name Last Initial).

Display consultant email/phone/photo on appointment entry

Displays the specified consultant fields within appointment records.

Allow group online/in-person per time slot determined by first person that day and time

If this is enabled, the first student booking an Online-Optional Multi-Person Availability decides if the session will be online or in-person. If this is disabled, each student booking the same time slot can choose online/in-person independently.

Allow sessions to be marked as ‘live doc’ sessions

If the Whiteboard module is in use, this preference can be enabled to allow sessions to be marked as "Live doc." This allows consultants and students to join a virtual Whiteboard room with text-chat and a shared document.

Allow student to upload documents to the appointment

Controls whether or not students can upload documents to the appointment record.

Allow staff to upload documents to the appointment

Controls whether or not staff can upload documents to the appointment record.

Block students from booking recurring appointments

Prevents students from booking recurring appointments.

Cancel recurring appointments after # consecutive misses/cancellations

These options only apply to recurring appointments. In the event that a student consecutively misses/cancels your max number of appointments in their appointment series, the Trac System will automatically cancel the remaining sessions.

Appointment Status and Management

File:1760620.png

Appointment Status Choices

These are the statuses that appointments can be set to. Typically, this would be set to something similar to the above example, with an Attended, Missed, and Canceled status, however, you can modify the choices if needed. Statuses containing the phrase “Cancel” will always cancel the appointment, making it available for other users to book (provided they’re still within the “schedule no later than” time limit.)

Status for attended

This is the status that TracCloud views as “Attended.” When students log in and log out during their appointment time, this is the status that the appointment will be automatically set to. If a staff member manually marks an appointment as this Attended status, a visit record will be automatically created.

Status for missed

This is the status that TracCloud views as “Missed.” Just like the above preference, this is the status that appointments without matching visits will be automatically set to.

Calc Missed Appointments Since

A student’s total number of missed appointments can be utilized in emails via the Twig tag “CalcMissedAppointments(Student.Sequence, Center.ProfileID)”. This date determines how far back TracCloud searches for missed appointments. If this preference is blank, the global System Preferences date is used instead. More information on Twig can be found in our dedicated Twig document.

Status for late cancellation

If left blank, a late cancellation will be recorded as "CANCEL - MISSED" (or your Profile's version of the "Missed" phrasing). You can use this to change the phrasing of this status entirely, but make sure to include the word "Cancel" somewhere in the status otherwise TracCloud will not send a cancellation email or open the time slot for other students.

Additional text message for late cancellation prompt / warning

This is an optional additional message that displays to students when they are cancelling an appointment outside of your time restriction. This appears in addition to the standard "This will be marked as missed" notice.

Max Appointment Rules and Blocks

These preferences allow you to restrict students from booking excessive appointments, or prevent booking/logins altogether. “Max Appointment Rules” allow you to create restrictions that will dynamically block students from booking appointments if their appointment threshold his met, while “Block Students to this Profile” allows you to block access to logging in for visits or booking appointments based whether or not the student is on a specified List.

Max Appointment Rules

File:5494722.png

Allow a maximum of X [hours/appointments] with:

Choose how many appointments/total hours a student can book within the restrictions assigned below.

ID Number (#1234ABCD)

Unique identifier for this rule, used for Twig in failure message.

Same: [Consultant / Reason / Center / Subject / Location]

This allows you to narrow down the restriction to specific fields. Maybe you don’t want a student booking excessively with a specific consultant, or booking too many appointments for a specific reason, this is where you would apply these rules.

add a search clause…

Search clauses allow you to be much more specific beyond the “Same:” settings. Here you can add a specific Reason, rather than reasons as a whole. You can only apply this rule to a specific center by adding a center clause. You can even select Student fields here, such as Status, Grad, and Major, that way you can apply this rule to only a specific set of students.

in X [Days / Weeks / Months / Terms / Years]

The time period for this rule. This lets you choose when this rule is put into effect, maybe you want to restrict students from booking more than 3 appointments per week, or 10 appointments per month. This preference is where you’ll make that decision.

If “1 week” is used, this will be on a Sunday to Saturday schedule, if “1 month” is used, this will be the first to last day of the month. If you would prefer any 7 or 30-day window, you will need to use something like “7 Days” rather than “1 Week”.

Appointment dates in the time period

The date range that this rule is effective for. Maybe the start of the semester, or a yearly period.

This rule applies to

This Student applies to only the student booking the appointment. John Doe (a student) can’t book more than 3 appointments with the same consultant per week.

All Students applies to every student. Jane Smith (a tutor) can’t be booked more than 3 appointments per day (by students).

For student

Allows you to only apply this rule to a certain list of students (or students not on a specific list).

And also applies to

Which appointment types should this apply do? If left blank, this rule is applied to all appointment types. However, you can also only apply this rule to one-on-one or in-person appointments if needed.

Rule Failure Message

This is an optional custom message that can appear to students if they reach the limit of this rule.

Twig can also be used in this field to display student or consultant information. You can also modify the contents of the message based on which rule was broken. For example:

{% for failRule in failRules %}

{% if failRule.id == "1Y0GYPWS" %}

Sorry, you can only have one upcoming appointment at a time. Please try again later.

{% elseif failRule.id == "HKIEAATS" %}

You can only book 4 appointments per week, if you think an exception needs to be made, reach out to us at help@school.edu.

{% endif %}

{% endfor %}

Block Students to this Profile

Prevent Scheduling is where you will select a list of students that you want to prevent from booking appointments.
Message to Display to a Blocked Student is the message displayed when a student on that list tries to book an appointment.

Prevent Login prevents the student from being logged in on the Log Listing or a Kiosk.
Message to Display to a Blocked Student is the message displayed when the student tries to login on a Kiosk or a staff member tries to log them in on the Log Listing.

Search Availability Badges

Search Availability badges can be used to add information and indicators to availability slots. Each badge can appear in specific contexts, based on center, availability section/reason, location, skills/accommodations, etc.

File:7942458.png

Click New Availability Badge to begin creating your new badge.

File:8036271.png

Any fields left blank will not be considered for where this badge appears, you can be as specific or non-specific as needed. You can also create as many badges as you'd like, more than 1 tag can appear for the same availability. Info Text appears when a user hovers their mouse over the badge in the search availability menu.

File:3529335.png

@@ Line 5: / Line 5: @@
 {| style="width:100%; vertical-align:top; "
 <big><b>Scheduling Preferences</b></big><br><br>
-Your scheduling preferences allow you to modify appointment booking rules, controlling exactly when a student can book appointments, how many appointments they can book, and much more. These preferences will apply to all centers within the profile.
+Your scheduling preferences allow you to modify [[TracCloudGuideBasicsSchedule|appointment booking]] rules, controlling exactly when a student can book appointments, how many appointments they can book, and much more. These preferences will apply to all centers within the profile.
 <hr>
 ==Time Restrictions==
-[[File:1611978.png|800px]]
+[[File:7158731.png|800px]]
 <br><br>
 * <b>Schedule no sooner than...And no later than</b>
-::This preference controls how early or late a student can book an appointment.
+::This preference controls how early or late a student can book an appointment. The example below visualizes how this preference works, but the time range would typically be larger for a production system (e.g., no later than 12 hours, no sooner than 14 days).
+::[[File:4810828.png|600px]]<br><br>
 * <b>No Cancellation within</b>
-::Determines how late the student can cancel an appointment.
+::Determines how late the student can cancel an appointment. If a student attempts to cancel within this time limit, they will be informed that the appointment will be counted as a <i>missed</i> appointment instead. Internally, the status will be recorded as "Cancel - Missed" (by default).<br><br>
 * <b>Minimum and Maximum Appointment Duration</b>
-::This preference controls the minimum/maximum possible appointment time. If you exclusively offer 30 or 45-minute appointments, you can set these preferences to match that difference.
+::This preference controls the minimum/maximum possible appointment time. If you exclusively offer 30 or 60 minute availabilities, this should be set to match. If an availability is created with time slots outside of the limit specified here, it will not appear in search results to students.<br><br>
 * <b>Default appointment duration</b>
-::The default duration of an appointment. Typically used in an open-schedule environment, where consultants are available for many hours at a time, this will be the default duration when a student goes to book an appointment.
+::The default duration of an appointment. Typically used in an open-schedule environment, where consultants are available for many hours at a time, this will be the default duration when a student goes to book an appointment.<br><br>
 * <b>Appointment start in increments of</b>
-::Increments of time that booked appointments can start at. For example, if this preference is set to 15 minutes, appointments could be booked at 9:15, 9:30, 9:45, and so on.
+::Increments of time that booked appointments can start at. For example, if this preference is set to 15 minutes, appointments could be booked at 9:15, 9:30, 9:45, and so on. This is not commonly used outside of open-schedule environments.<br><br>
 * <b>Appointment duration in increments of</b>
-::Increments of time that an appointment can be booked for. For example, if this is set to 10 minutes, appointments can be booked for 20 minutes, 30 minutes, 40, and so on.
+::Increments of time that an appointment can be booked for. For example, if this is set to 10 minutes, appointments can be booked for 20 minutes, 30 minutes, 40, and so on. This is not commonly used outside of open-schedule environments.<br><br>
 * <b>Restrict duration to intervals</b>
@@ Line 38: / Line 33: @@
 ::[[File:4u3j4h1232rf23.png|400px]]
+<hr>
-[[File:6313465.png|800px]]
+[[File:3037437.png|800px]]
 * <b>Prevent booking consecutive appointments same student / consultant:</b>
-::This prevents students from booking consecutive appointments with a tutor. <b>Prevent Student</b> applies this rule to students booking their own appointments, and <b>Prevent Staff</b> applies this rule to staff members booking on behalf of students. If the staff member's permission group has override permissions, they can override this rule (a warning informs them of this).
+::This prevents students from booking consecutive appointments with a tutor. <b>Prevent Student</b> applies this rule to students booking their own appointments, and <b>Prevent Staff</b> applies this rule to staff members booking on behalf of students. If the staff member's permission group has override permissions, they can override this rule (a warning informs them of this). The default consecutive limit is 2 (no back-to-back appointments), but this can be modified if needed. For example, a limit of "3" would allow a student to book a <i>1pm to 2pm</i>, and <i>2pm to 3pm</i>, but not a <i>3pm to 4pm</i>.<br><br>
 * <b>Allow entry into online appointment session</b>
-::These preferences control how soon/late a student can join a remote tutoring session by restricting when the Join button is available. If you’d like the student to be able to join 5 minutes prior to the start time through to the end, you would need to set “No sooner than” to 00:05 and set “No later than” to a value such as “1:00” (assuming you’re holding 1-hour appointments).
+::These preferences control how soon/late a student can join a remote tutoring session by restricting when the Join button is available. If you’d like the student to be able to join 5 minutes prior to the start time through to the end, you would need to set “No sooner than” to 00:05 and set “No later than” to a value such as “1:00” (assuming you’re holding 1-hour appointments). <b>No later than before end of appt</b> counts back from the end time of the appointment rather than the start, and is an alternate option to <b>No later than after start of appt</b>.<br><br>
+* <b>QR Codes expire after</b>
+::This applies to Batch Visit QR Codes and Ad-hoc Drop-in QR codes. If this is left blank, these codes can be used up to the end time of the visit. By setting this to a higher value, you can allow students to retroactively create visits for themselves after the visit has already taken place (e.g., in a recording). This preference counts from the <i>start time</i> of the session.<br><br>
-* <b>QR Codes expire after</b>
+* <b>Block student from booking appointments between # and #</b>
-::This applies to Batch Visit QR Codes and Ad-hoc Drop-in QR codes. If this is left blank, these codes can be used at any time (but will only create a visit for the time they were originally set for). By setting this to a specific time, you can restrict students from scanning these QR codes too late, preventing them from retroactively creating a visit. This preference counts from the <i>start time</i> of the session.
+::This preference allows you to prevent students from booking appointments during a specific time of day. This is more commonly used if <b>Schedule no later than</b> is set to a low value, such as a few hours, allowing students to book close to the start time of the appointment. For example, if you want to prevent a student from booking a morning appointment in the middle of the night so that your tutors have more notice for their upcoming schedule, this is the preference you'll want to change. Default is blank, which does not apply any restrictions based on time of day.
 <hr>
 ==Special Fields==
-[[File:9967198.png|800px]]
+[[File:1169066.png|800px]]
 <br><br>
 Each group of settings—Reasons, Locations, Sections, Fund—can be precisely adjusted to control where they show up and whether or not they’re required.<br>
@@ Line 59: / Line 55: @@
 <b>Enter in appointment</b> determines whether or not the field shows up within the appointment entry window.<br>
 <b>Required for Search</b> means that in order for appointments in this profile to appear in search results, this field must not be empty.<br>
-<b>Required for Save</b> marks the field as required, so it must be filled out prior to booking the appointment. This applies more-so to Staff, as the above option already requires a student to have this field selected before they have the chance to book.<br>
+<b>Required for Save</b> marks the field as required, so it must be filled out prior to booking the appointment. This applies more-so to Staff, as the above option already requires a student to have this field selected before they have the chance to book.<br><br>
 * <b>Appointment Location Choices</b>
-::Allows to you to customize the locations available to choose from on Availability and Appointment entry.
+::Allows to you to customize the locations available to choose from on [[TracCloudGuideBasicsSchedule|Availability and Appointment entry]]. If used, this would typically be a more specific location than what your centers already describe. E.g., "Room 42 (location) in Peer Tutoring ([[TracCloudGuideProfileCenters|center]])."<br><br>
 * <b>Appointment Fund Choices</b>
-::Allows you to customize the funds available to choose from on Availability and Appointment entry.
+::Allows you to customize the funds available to choose from on Availability and Appointment entry. [[TracCloudGuideBasicsPayroll|More information on funds and payroll tracking in general can be found here.]]
-* <b>Quick Visit: Consultant Required</b>
-::This makes the Consultant field in visit records required (i.e., you can't save without selecting a consultant).
 <hr>
 ==Other Schedule Options==
-[[File:5148394.png|800px]]
+[[File:3225384.png|800px]]
 <br><br>
 * <b>Allow students to cancel appointments</b>
-::Provides students the option to cancel appointments (as long as they’re outside the time range specified in the first menu.)
+::Provides students the option to cancel appointments (as long as they’re outside the time range specified in the first menu.)<br><br>
 * <b>Display consultant alias on availability search</b>
-::This will display the consultant’s alias (specified in their staff profile) rather than their full name when students/staff are searching for availabilities. An alias can also be automatically generated based on your [[TracCloudGuideGlobalSystem|System Preferences]] (e.g., First Name Last Initial).
+::This will display the consultant’s alias (specified in their [[TracCloudGuideProfileStaff|staff profile]]) rather than their full name when students are searching for availabilities. An alias can also be automatically generated based on your [[TracCloudGuideGlobalSystem|System Preferences]] if preferred (e.g., First Name Last Initial).<br><br>
 * <b>Display consultant email/phone/photo on appointment entry</b>
-::Displays the consultant’s specified information within appointment records.
+::Displays the specified consultant fields within appointment records.<br><br>
 * <b>Allow group online/in-person per time slot determined by first person that day and time</b>

TracCloudGuideProfilePrefsSchedule: Difference between revisions

From Redrock Wiki

Revision as of 10:07, 26 April 2023

Profile Preferences

Prefs