TracCloudGuideProfilePrefsSchedule: Difference between revisions
From Redrock Wiki
No edit summary |
No edit summary |
||
Line 18: | Line 18: | ||
|- | |- | ||
| | [[TracCloudGuideProfilePrefsSchedule#Max Appointment Rules and Blocks|Max Appt Rules]] | | | [[TracCloudGuideProfilePrefsSchedule#Max Appointment Rules and Blocks|Max Appt Rules]] | ||
|- | |||
| | [[TracCloudGuideProfilePrefsScheduleDisplay|Appointment Display]] | |||
|- | |- | ||
| | [[TracCloudGuideProfilePrefsSchedule#Search Availability Badges|Search Availability Badges]] | | | [[TracCloudGuideProfilePrefsSchedule#Search Availability Badges|Search Availability Badges]] | ||
Line 135: | Line 137: | ||
[[File:1693361.png|800px]] | [[File:1693361.png|800px]] | ||
<br><br> | <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 block access to logging in for visits or booking appointments based whether or not the student is on a specific [[TracCloudGuideGlobalLists|list]]. | 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 specific [[TracCloudGuideGlobalLists|list]].<br><br> | ||
<big>Max Appointment Rules</big><br> | |||
[[File:5494722.png|600px]] | [[File:5494722.png|600px]] | ||
<br><br> | <br><br> | ||
* <b>Allow a maximum of X [hours/appointments] with:</b> | * <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. | ::Choose how many appointments/total hours a student can book within the restrictions assigned below.<br><br> | ||
* <b>ID Number</b> (#1234ABCD) | * <b>ID Number</b> (#1234ABCD) | ||
::Unique identifier for this rule, used for | ::Unique identifier for this rule, used for [[TracCloudGuideProfilePrefsTwig|twig logic]] in failure message.<br><br> | ||
* <b>Same: [Consultant / Reason / Center / Subject / Location]</b> | * <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. | ::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.<br><br> | ||
* <b>add a search clause…</b> | * <b>add a search clause…</b> | ||
:: | ::These clauses allow you to be more specific in where this rule applies. For example, you could add a search clause for Appointment Status and set it to "*Missed*" to apply max appointment rules to missed appointments, where a student wouldn't be able to book additional appointments once the limit is reached. You can also select specific Reasons, Centers, or Subjects where the rule should apply, to not affect unrelated appointments.<br><br> | ||
* <b>in X [Days / Weeks / Months / Terms / Years]</b> | * <b>in X [Days / Weeks / Months / Terms / Years]</b> | ||
::The time period for this rule. | ::The time period for this rule. For example, you may 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 | ::If “X week” is used, you can choose the start day of the week to count from. If “X 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”.<br><br> | ||
* <b>This rule is active for appointment dates in the time period</b> | |||
::The date range that this rule is effective for. Maybe your current semester, or a monthly period.<br><br> | |||
* <b>This rule applies to</b> | * <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>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>All Students</b> applies to every student. Jane Smith (a tutor) can’t be booked more than 3 appointments per day (by students).<br><br> | ||
*<b>For student</b> | *<b>For student</b> | ||
::Allows you to only apply this rule to a certain list of students (or students not on a specific list). | ::Allows you to only apply this rule to a certain [[TracCloudGuideGlobalLists||list of students]] (or students not on a specific list).<br><br> | ||
* <b>And also applies to</b> | * <b>And also applies to</b> | ||
::Which appointment types should this apply do? If left blank, this rule is applied to all appointment types. | ::Which appointment types should this apply do? E.g., only in-person 1-on-1 appointments. If left blank, this rule is applied to all appointment types.<br><br> | ||
* <b>Students that fail this rule may be optionally added to a list</b> | |||
::This option requires that <b>Same:</b> and <b>In X time period</b> are both disabled. When the student attempts to book an appointment and is blocked by this rule, they will be added to the [[TracCloudGuideGlobalLists|student list]] that you select.<br><br> | |||
* <b>Rule Failure Message</b> | * <b>Rule Failure Message</b> | ||
Line 188: | Line 184: | ||
Sorry, you can only have one upcoming appointment at a time. Please try again later. | Sorry, you can only have one upcoming appointment at a time. Please try again later. | ||
{% elseif failRule.id == "HKIEAATS" %} | {% elseif failRule.id == "HKIEAATS" %} | ||
You can only book 4 appointments per week | 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 %} | {% endif %} | ||
{% endfor %} | {% endfor %} | ||
</syntaxhighlight> | </syntaxhighlight><br><br> | ||
In addition to standard maximum appointment rules, you can also utilize these rules to set maximum tutoring/advising hours for your consultants.<br><br> | |||
In the [[TracCloudGuideProfileStaff| consultant profile]], set 'Max Hours' to your desired limit, e.g., "10".<BR> | |||
[[File:9093257.png|700px]]<br><br> | |||
In your Maximum Appointment Rules, use the phrase "MaxHours" in the "Allow a maximum of [____]" field. When an appointment is booked, TracCloud will check the relevant consultant's maximum hours for use with this rule. If the newly scheduled appointment would be over the maximum number of hours set, it will be blocked.<BR> | |||
[[File:1919234.png|700px]]<br><br> | |||
<big>Block Students to this Profile</big><br> | |||
* <b>Prevent Scheduling</b> is where you will select a list of students that you want to prevent from booking appointments. | * <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. | * <b>Message to Display to a Blocked Student</b> is the message displayed when a student on that list tries to book an appointment. | ||
Line 202: | Line 207: | ||
* <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. | * <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]] | :[[File:35j35j43k46k4k4635g.png|400px]] | ||
<hr> | |||
==Appointment Display== | |||
[[TracCloudGuideProfilePrefsScheduleDisplay|Appointment Display has its own wiki article which can be found here.]] | |||
<hr> | <hr> | ||
==Search Availability Badges== | ==Search Availability Badges== |
Revision as of 11:39, 26 April 2023
Profile Preferences
Prefs
|
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
Special Fields
Other Schedule Options
Appointment Status and Management
Max Appointment Rules and Blocks
Max Appointment Rules
In addition to standard maximum appointment rules, you can also utilize these rules to set maximum tutoring/advising hours for your consultants. In the consultant profile, set 'Max Hours' to your desired limit, e.g., "10". In your Maximum Appointment Rules, use the phrase "MaxHours" in the "Allow a maximum of [____]" field. When an appointment is booked, TracCloud will check the relevant consultant's maximum hours for use with this rule. If the newly scheduled appointment would be over the maximum number of hours set, it will be blocked. Block Students to this Profile
Appointment DisplayAppointment Display has its own wiki article which can be found here. Search Availability BadgesSearch 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. Click New Availability Badge to begin creating your new badge. 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. |