TracCloudGuideGlobalSearchAvail and TracCloudGuideProfilePrefsSchedule: Difference between pages

From Redrock Wiki

(Difference between pages)
No edit summary
 
No edit summary
 
Line 1: Line 1:
{{TracCloudGuideTabs}}
{{TracCloudGuideTabs}}
{| style="width:100%; vertical-align:top; "
{| style="width:100%; vertical-align:top; "
| style="width:250px; vertical-align:top; padding:2px 15px 2px 2px;" | {{TracCloudGuideGlobalTOC}}
| style="width:250px; vertical-align:top; padding:2px 15px 2px 2px;" | {{TracCloudGuideProfileTOC}}
| style="vertical-align:top; padding:20px 20px 20px 2px;" |
| style="vertical-align:top; padding:20px 20px 20px 2px;" |
{| style="width:100%; vertical-align:top; "
{| style="width:100%; vertical-align:top; "
<b><big>Search Availability Options</b></big><br>
<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.
<hr>
==Time Restrictions==
[[File:1611978.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.


These preferences allow you to modify the behavior of the Search Availability widget on the dashboard. There are 5 sets of settings, as you can have up to 5 Search Availability widgets at once. For example, if you had an AdvisorTrac and a TutorTrac profile in the same instance, you may want reason to be a required search criteria for Advising, but only require Subject for Tutoring. These options allow you to offer a separate widget for each profile.


[[File:5627594.png|800px|Screenshot: Search Availability Options.]]<br><br>
* <b>No Cancellation within</b>
::Determines how late the student can cancel an appointment.


* <b>Activate primary/secondary/tertiary search availability option</b>
::This allows you to enable additional search widgets when needed. The primary option is enabled by default.<br><br>


* <b>Search Availability Title</b>
* <b>Minimum and Maximum Appointment Duration</b>
::This allows you to modify the name of the Search Availability widget on the dashboard. Also displays within the header of the subsequent search results page.<br><br>
::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.


* <b>Default Search Option</b>
::This determines whether the Schedule an Appointment dashboard utility defaults to “First Available” or “Choose Date.” The latter will prompt staff and students to select a Profile, Center, and Date Range for their search results.<br><br>


* <b>Show Profile Option to Student</b>
* <b>Default appointment duration</b>
::When “Choose Date” Is used when searching for availabilities, the user is asked which Profile and Center they want to search in. This option provides the ability to disable the Profile choice for students.<br><br>
::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.


* <b>Allow Search Subject/Reasons</b>
::Allows you to disable the Subject or Reason search options within the Schedule an Appointment utility.<br><br>


* <b>Search Subject/Reason Prompt</b>
* <b>Appointment start in increments of</b>
::Allows you to modify the phrasing of these drop-down fields in the Search Availability box on the dashboard. <b>Search Conjunction</b> determines whether the two fields are separated by an <i>And</i> or an <i>Or</i>.<br><br>
::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.


* <b>Do Not Require Reason on Search</b>
::This determines if Reason is a required field to search for availabilities. If so, all profiles within your Trac Instance will also need to require reason to find availabilities. See [[TracCloudGuideProfilePrefsSchedule|Scheduling Preferences]] for more information.<br><br>


* <b>Search Availability Instructions</b>
* <b>Appointment duration in increments of</b>
::A custom message that displays during the Search Availability process for staff/students.<br><br>
::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.


* <b>Hide Dropins from Students</b>
::If enabled, Drop-in-type availabilities will not appear in availability search results for students.<br><br>


* <b>Linked Profiles</b>
* <b>Restrict duration to intervals</b>
::Which profiles this Search Availability widget is linked to. Defaults to blank (all).<br><br>
::The durations specified here will control the appointment durations shown during the appointment booking process.
::[[File:4u3j4h1232rf23.png|400px]]


* <b>For Students on List</b>
::This allows you to only display this search widget to this List of Students. Leave blank to disable.<br><br>


Towards the bottom of this menu, you'll find <b>Additional Settings</b>. These settings apply to all Search Availability widgets.
[[File:6313465.png|800px]]


[[File:6715579.png|800px|Screenshot: Additional settings.]]<br><br>
* <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).


* <b>Master List for Search Availabilities Subject</b>
::Allows you to restrict Search Availability to a specific list of sections, overriding the Center and Consultant course lists.<br><br>


* <b>Name for...</b>
* <b>Allow entry into online appointment session</b>
::These options allow you to change the phrasing of availabilities types in your Trac System. For example, if your students find 'Multi-person' more clear than 'Group', it can be changed here. Default phrasing will be used if these are left blank.<br><br>
::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>Format to display Search Subject</b>
::Allows you to modify the format of subjects within the Search Availability widget. E.g., including or excluding Title, Section, Faculty, etc.<br><br>


* <b>Allow Course Lists to be assigned to availabilities</b>
* <b>QR Codes expire after</b>
::Allows you to choose a course list as an availability subject as a form of section group.<br><br>
::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.
<hr>
==Special Fields==
[[File:9967198.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>
<b>Enter in avail</b> determines whether or not the field shows up within the availability entry window.<br>
<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>Allow move appointment to earlier time</b>
::Provide staff the ability to move appointments to an earlier time, and how much earlier is allowed.<br><br>


[[File:2347346.png|800px]]<br><br>
* <b>Appointment Location Choices</b>
::Allows to you to customize the locations available to choose from on Availability and Appointment entry.


* <b>Additional Instructions</b>
::Optional text that appears for those using the 'Choose a Date & Center' option for availability search. "Appointments must be scheduled at least 12 hours in advance" in the example screenshot below.<br><br>


* <b>Prompt for choosing which profile/center of services</b> and <b>Title for All Profiles/Centers option</b>
* <b>Appointment Fund Choices</b>
::Change the phrasing of these choices within the 'Choose a Date & Center' option.<br><br>
::Allows you to customize the funds available to choose from on Availability and Appointment entry.


* <b>Default search availability date choice</b>
::Sets the default date choice within the 'Choose a Date & Center' option.<br><br>


[[File:2795031.png|600px]]<br><br>
* <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:5482424.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.)


* <b>Unbooked availabilities become dropins to students on search availability</b>
::If checked, in the event that an in-person availability block is not booked within the allowed limit of your profile scheduling restrictions, the availability block will continue to be shown to students as an in-person drop-in to allow the time slot to still be utilized.<br><br>


[[File:3933292.png|800px]]<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).


* <b>Setting for Report Unable to Find Appointment</b>
::This adds a utility to the <i>Search for Availability</i> screen allowing staff and students to report that they weren’t able to find an availability that works for them. <b>Button Label</b> can be used to change the student-facing phrasing of this option.<br>


::* <b>Off</b> disables this functionality.<br>
* <b>Display consultant email/phone/photo on appointment entry</b>
::Displays the consultant’s specified information within appointment records.


::* <b>Standard</b> provides a standard form where students can write out what they searched for and what they did (or didn’t) find. These reports can later be reviewed and managed by staff with the appropriate permissions.<br>


::* <b>Custom</b> lets you enter a custom URL that students will be taken to after selecting the “Report Unable to Find an Appointment” button.<br><br>
* <b>Allow group online/in-person per time slot determined by first person that day and time</b>
::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.
 
 
* <b>Allow sessions to be marked as ‘live doc’ sessions</b>
::If the [[TracCloudWB|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.
 
 
* <b>Allow student to upload documents to the appointment</b>
::Controls whether or not students can upload documents to the appointment record.
 
 
* <b>Allow staff to upload documents to the appointment</b>
::Controls whether or not staff can upload documents to the appointment record.
 
 
* <b>Block students from booking recurring appointments</b>
::Prevents students from booking recurring appointments.
 
 
* <b>Cancel recurring appointments after 2 consecutive misses/cancellations</b>
::These options only apply to recurring appointments. In the event that a student misses/cancels 2 appointments in a row in their appointment series, the Trac System will automatically cancel the remaining sessions.
 
<hr>
==Appointment Status and Management==
[[File:75kl5k75577557757557.png|800px]]
<br><br>
* <b>Appointment Status Choices</b>
::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.)
 
 
* <b>Status for attended</b>
::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.
 
 
* <b>Status for missed</b>
::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.
 
 
* <b>Calc Missed Appointments Since</b>
::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.
<hr>
==Max Appointment Rules and Blocks==
[[File:755745578hf65l5675.png|800px]]
<br><br>
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 outright remove access to TracCloud features based whether or not the student is on a specified List.
 
==Max Appointment Rules==
[[File:9940690.png|600px]]
<br><br>
* <b>Allow a maximum of X [hours/appointments] with:</b>
::Choose how many appointments/total hours a student can book within the restrictions assigned below.
 
 
* <b>Same: [Consultant / Reason / Center / Subject / Location]</b>
::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.
 
 
* <b>add a search clause…</b>
::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.
 
 
* <b>in X [Days / Weeks / Months / Terms / Years]</b>
::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”.
 
 
* <b>Appointment dates in the time period</b>
::The date range that this rule is effective for. Maybe the start of the semester, or a yearly period.
 
 
* <b>This rule applies to</b>
::<b>This Student</b> 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.
::<b>All Students</b> applies to every student. Jane Smith (a tutor) can’t be booked more than 3 appointments per day (by students).
 
 
*<b>For student</b>
::Allows you to only apply this rule to a certain list of students (or students not on a specific list).
 
 
* <b>And also applies to</b>
::Which appointment types should this apply do? If left blank, this rule is applied to all courses. However, you can also only apply this rule to one-on-one or in-person appointments if needed.
 
 
==Block Students to this Profile==
* <b>Prevent Scheduling</b> is where you will select a list of students that you want to prevent from booking appointments.
* <b>Message to Display to a Blocked Student</b> is the message displayed when a student on that list tries to book an appointment.
:[[File:Oinwouigng2482y5.png|400px]]
 
 
* <b>Prevent Login</b> prevents the student from being logged in on the Log Listing or a Kiosk.
* <b>Message to Display to a Blocked Student</b> 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.
:[[File:35j35j43k46k4k4635g.png|400px]]


* <b>Button Label</b>
::Changes the label of the button that students would click when using this utility. <i>Report Unable to Find Appointment</i> by default.


|}
|}

Revision as of 15:23, 6 September 2022


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

File:1611978.png

  • Schedule no sooner than...And no later than
This preference controls how early or late a student can book an appointment.


  • No Cancellation within
Determines how late the student can cancel an appointment.


  • Minimum and Maximum Appointment Duration
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.


  • 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.


  • 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.


  • Restrict duration to intervals
The durations specified here will control the appointment durations shown during the appointment booking process.
4u3j4h1232rf23.png


File:6313465.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).


  • 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).


  • 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 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.

Special Fields

File:9967198.png

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.


  • Appointment Fund Choices
Allows you to customize the funds available to choose from on Availability and Appointment entry.


  • Quick Visit: Consultant Required
This makes the Consultant field in Visit records required (i.e., you can't save without selecting a consultant).

Other Schedule Options

File:5482424.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/staff are searching for availabilities. An alias can also be automatically generated based on your System Preferences (e.g., First Name Last Initial).


  • Display consultant email/phone/photo on appointment entry
Displays the consultant’s specified information 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 2 consecutive misses/cancellations
These options only apply to recurring appointments. In the event that a student misses/cancels 2 appointments in a row in their appointment series, the Trac System will automatically cancel the remaining sessions.

Appointment Status and Management

File:75kl5k75577557757557.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.

Max Appointment Rules and Blocks

File:755745578hf65l5675.png

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 outright remove access to TracCloud features based whether or not the student is on a specified List.

Max Appointment Rules

File:9940690.png

  • Allow a maximum of X [hours/appointments] with:
Choose how many appointments/total hours a student can book within the restrictions assigned below.


  • 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 courses. However, you can also only apply this rule to one-on-one or in-person appointments if needed.


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.
Oinwouigng2482y5.png


  • 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.
35j35j43k46k4k4635g.png