TracCloud: System Preferences: Difference between revisions

System Preferences
These preferences are global and affect all profiles within your TracCloud instance. The System Preferences tab contains basic information about your campus and a couple default values that profiles can fall back to if needed.

Center Name

This is the campus name for your Trac System. Appears in the top-right corner of your dashboard and will be used as the contact name for emails sent from the Trac System.

Center Email

Effectively a fallback email address. If an email needs to be sent, but the account/profile doesn’t have an email address configured, this will be used instead.

Name for your Client

Determines the phrasing of clients in TracCloud, “Student,” “Tutee,” “Client,” etc.

Colors

Determines the color of your navigation bar and accent colors, allowing you to match the color-scheme of your campus website. Clicking on these fields also brings up an interactive color picker if you don’t have the hex value available.

Image

Upload your campus logo here. This will display faded into the background of TracCloud.

Main Login Instructions

This text appears on the local account login screen for your Trac System. This can be ignored if you don't use local accounts.

Screenshot: Withdraw Codes and Appointment Statuses.

Withdraw Codes

This is where you can specify the withdrawn/dropped statuses for student enrollments. During the import process, if a student’s registration contains one of these codes, the enrollment will be deactivated. Withdraw via Which Field determines where the drop code is stored/imported, grade or registration status.

Keep Enrolled Codes

This is the opposite of Withdraw Codes. Any values entered here will be set to active during the import process.

Deactivate when not imported

Deactivates registrations in the event that they’re not found in the most recent import file.

Deactivate after x Days not Imported

This is an optional buffer that can be used in combination with Deactivate when not imported. By default, registrations will be deactivated when they were not provided in the current day's files. This preference can be used to add a buffer for when the registration will be set to inactive, e.g., 5 days after it was last imported.

Appointment Statuses

These statuses are used when a profile doesn’t already have appointment statuses defined.

Cancellation reasons a student can choose from

This is a preset list of cancellation reasons a student can choose from, in addition to the standard text field offered when a student attempts to cancel their appointment.

Student cancellation reason required

If checked, a student will not be able to cancel without providing a reason (written or from the preset list above).

Delete Status

Appointments that are deleted ("X" button on staff schedule) are changed to this status automatically. The default of CANCELED - DELETED is recommended.

Calc Missed Appointments Since

Calculate total missed appointments since this date, used for blocking students from booking appointments if they’ve excessively missed past appointments. This preference is only used if the profile doesn’t already have a Calc Missed Appointments Since value defined.

File:3433565.png

Default Online Options

When an appointment/availability is designated as Online, you’re provided the option of choosing a URL for the appointment to take place in. This would typically be the consultant’s assigned static link (found in their profile), but you can also have a few preset options as defined in this field. This could be used for breakout rooms, or placeholder URLs with example session IDs. This is additionally used for the Whiteboard and Q2 modules, if applicable.

Text to display when appointment is NOT online

Text entered here is displayed within appointment records (to both students and staff) if an appointment is in-person. This text is entirely hidden if the appointment is online.

Keep physical Location for online visits (not recommended)

If checked, for online optional availabilities, when a student attends an online session, the in-person location will carry through to the visit record rather than the online location. This option is almost always disabled except for very specific use-cases.

Default start time on calendar and number of hours to show on calendar

This allows you to set default visible calendar hours for new staff accounts. This can be overridden by individual staff accounts setting their own calendar time.

Default sticky drag minutes

When you click and drag an availability/appointment on the staff schedule, it will snap to 15-minute increments by default. This is so you don't end up with availabilities running from 9:01 to 9:56am, for example. This preference allows you to change those increments. Start time minutes affects your initial click (before you start dragging the time slot), while Duration minutes affects the length of the block that you create. This can always be overridden within the availability options.

Allow students to see cancelled appointments on dashboard

Cancelled appointments are not shown to students in their Upcoming Appointments menu by default. Enabling this option changes that, including cancelled appointments in the list. If enabled, you may need to make an adjustment to your Upcoming Appointment Preferences as described, otherwise there will be no visual difference between an upcoming and a cancelled appointment. This is included in the default appointment display out of the box.

Default view for students/consultants on dashboard

Both of these user types can view their upcoming and past appointments on the main menu. This option determines the default setting of this widget, showing the current day's appointments, the week, or list (which allows them to continuously load future appointments). Regardless of which option is chosen, users will still be able to manually choose any of these three options.

File:8312296.png

Lock Course Lists to Consultants

This effectively puts all Course Lists in a "Lock to SysAdmin [or other staff admin]" state, preventing Consultant-type accounts from making further changes.

Allow Consultant Time Check on Dashboard

Allows staff members to view a Time Check-style menu on their dashboard, showing a quick summary of their recent work visits. If enabled, you can also choose the number of weeks shown in the Time Check window.

Activate Consultant Enter Notes on Work Visit Log Out

If checked, consultants will see a pop-up asking them to enter notes when they log out of their work visits.

Consultant Alias Format

If your Profile is set to use Consultant Alias rather than full name, this preference determines the format of that Alias. The default value of 'Use Consultant Alias Field' will use each consultant's personal 'Alias' value, or generic 'Consultant' phrasing if blank. You can also use other automatically generated options, such as First Name Only, First Initial Last Name, etc.

(First Name Last Initial pictured below)

Activate Location Filtering

This enables a search bar on the 'All Staff' Schedule that allows you to filter visible Consultants by their assigned in-person location.

File:6222386.png

Activate Save And Split button for Availabilities

Adds a new option on Availability Entry allowing you to split your single block (e.g., 9 to 12, 60 minute times slots) into multiple blocks (9 to 10, 10 to 11, 11 to 12). This is typically left disabled unless you specifically need to manage individual time slots after creating your schedules. If this option is enabled, Show warning message regarding this feature not recommend will display a warning pop-up every time someone uses this utility to confirm their choice.

Registration Listing Custom Fields

If a Custom Field is selected here, it will be displayed as an additional column on the Registrations Listing and Student Registrations pages. This is typically used for custom fields like midterm grade.

Show Tip of the Week

If enabled, SysAdmins will receive occasional newsletters on the dashboard providing information about various TracCloud features.

@@ Line 29: / Line 29: @@
 * <b>Main Login Instructions</b>
 ::This text appears on the local account login screen for your Trac System. This can be ignored if you [[TracCloudTechSSO|don't use local accounts.]]
 <hr>
 [[File:1073129.png|800px|Screenshot: Withdraw Codes and Appointment Statuses.]]<br><br>
 * <b>Withdraw Codes</b>
-::This is where you can specify the withdrawn/dropped statuses for student enrollments. During the import process, if a student’s registration contains one of these codes, the enrollment will be deactivated. <b>Withdraw via Which Field</b> determines where the drop code is stored/imported, grade or registration status.<br><br>
+::This is where you can specify the withdrawn/dropped statuses for [[TracCloudGuideListingsRegistrations|student enrollments]]. During the [[TracCloudTechImport|import process]], if a student’s registration contains one of these codes, the enrollment will be deactivated. <b>Withdraw via Which Field</b> determines where the drop code is stored/imported, grade or registration status.<br><br>
 * <b>Keep Enrolled Codes</b>
@@ Line 40: / Line 41: @@
 * <b>Deactivate when not imported</b>
 ::Deactivates registrations in the event that they’re not found in the most recent import file.<br><br>
+* <b>Deactivate after x Days not Imported</b>
+::This is an optional buffer that can be used in combination with <b>Deactivate when not imported</b>. By default, registrations will be deactivated when they were not provided in the current day's files. This preference can be used to add a buffer for when the registration will be set to inactive, e.g., 5 days after it was last imported.<br><br>
 * <b>Appointment Statuses</b>
-::These statuses are used when a profile doesn’t already have appointment statuses defined.<br><br>
+::These statuses are used when a [[TracCloudGuideProfilePrefsSchedule#Appointment_Status_and_Management|profile doesn’t already have appointment statuses defined]].<br><br>
 * <b>Cancellation reasons a student can choose from</b>
-::This is a preset list of cancellation reasons a student can choose from, in addition to the standard text field.<br><br>
+::This is a preset list of cancellation reasons a student can choose from, in addition to the standard text field offered when a student attempts to cancel their appointment.<br><br>
 * <b>Student cancellation reason required</b>
@@ Line 51: / Line 55: @@
 * <b>Delete Status</b>
-::Appointments that are deleted are changed to this status automatically.<br><br>
+::Appointments that are deleted ("X" button on staff schedule) are changed to this status automatically. The default of <b>CANCELED - DELETED</b> is recommended.<br><br>
 * <b>Calc Missed Appointments Since</b>
-::Calculate total missed appointments since this date, used for blocking students from booking appointments if they’ve excessively missed past sessions. This preference is only used if the profile doesn’t already have a <b>Calc Missed Appointments Since</b> value defined (Profile Prefs > Scheduling).<br><br>
+::Calculate total missed appointments since this date, used for blocking students from booking appointments if they’ve excessively missed past appointments. This preference is only used if the [[TracCloudGuideProfilePrefsSchedule#Appointment_Status_and_Management|profile doesn’t already have a <b>Calc Missed Appointments Since</b> value defined]].<br><br>
+<hr>
-[[File:8342453.png|800px]]<br><br>
+[[File:3433565.png|800px]]<br><br>
 * <b>Default Online Options</b>
-::When an appointment/availability is designated as Online, you’re provided the option of choosing a URL for the appointment to take place in. This would typically be the staff member’s assigned static link (found in their profile), but you can also have a few preset options as defined in this field. A staff member selecting one of these options can then easily swap out the “SESSIONID” with their actual session ID.
+::When an [[TracCloudGuideBasicsSchedule|appointment/availability]] is designated as Online, you’re provided the option of choosing a URL for the appointment to take place in. This would typically be the [[TracCloudGuideProfileStaff|consultant’s assigned static link]] (found in their profile), but you can also have a few preset options as defined in this field. This could be used for breakout rooms, or placeholder URLs with example session IDs. This is additionally used for the [[TracCloudWB|Whiteboard]] and [[TracCloudQ2|Q2]] modules, if applicable.
-::“Whiteboard” is used for our Whiteboard module and shouldn’t be changed if the module is in use. <b>Reset to Default Values</b> can be used to quickly return to the values seen in the screenshot above.
 ::[[File:2097257.png|500px]]<br><br>
 * <b>Text to display when appointment is NOT online</b>
 ::Text entered here is displayed within appointment records (to both students and staff) if an appointment is in-person. This text is entirely hidden if the appointment is online.
-::[[File:1808995.png|300px]]
+::[[File:2092782.png|300px]]<br><br>
-<br>
 * <b>Keep physical Location for online visits (not recommended)</b>
@@ Line 76: / Line 78: @@
 * <b>Default sticky drag minutes</b>
-::When you click and drag an availability/appointment on the staff schedule, it will snap to 15-minute increments by default. This is so you don't end up with availabilities running from 9:01 to 9:56am, for example. This preference allows you to change those increments. <b>Start time minutes</b> affects your initial click (before you start dragging the time slot), while <b>Duration minutes</b> affects the length of the block that you create.
+::When you click and drag an availability/appointment on the staff schedule, it will snap to 15-minute increments by default. This is so you don't end up with availabilities running from 9:01 to 9:56am, for example. This preference allows you to change those increments. <b>Start time minutes</b> affects your initial click (before you start dragging the time slot), while <b>Duration minutes</b> affects the length of the block that you create. This can always be overridden within the availability options.<br><br>
-[[File:1665312.png|800px]]<br><br>
 * <b>Allow students to see cancelled appointments on dashboard</b>
-::Cancelled appointments are not shown to students in their Upcoming Appointments menu by default. Enabling this option changes that, including cancelled appointments in the list. If enabled, you will need to make an adjustment to your Upcoming Appointment Preferences as described, otherwise there will be no visual difference between an upcoming and a cancelled appointment.<br><br>
+::Cancelled appointments are not shown to students in their [[TracCloudGuideProfilePrefsScheduleDisplay|Upcoming Appointments]] menu by default. Enabling this option changes that, including cancelled appointments in the list. If enabled, you may need to make an adjustment to your Upcoming Appointment Preferences as described, otherwise there will be no visual difference between an upcoming and a cancelled appointment. This is included in the default appointment display out of the box.<br><br>
 * <b>Default view for students/consultants on dashboard</b>
-::Both of these user types can view their upcoming and past appointments on the main menu. This option determines the default setting of this widget, showing the current day's appointments, the week, or list (which allows them to continuously load future appointments). Regardless of which option is chosen, users will still be able to manually choose any of these three options.<br><br>
+::Both of these user types can view their upcoming and past appointments on the main menu. This option determines the <i>default</i> setting of this widget, showing the current day's appointments, the week, or list (which allows them to continuously load future appointments). Regardless of which option is chosen, users will still be able to manually choose any of these three options.<br><br>
+<hr>
+[[File:8312296.png|800px]]<br><br>
 * <b>Lock Course Lists to Consultants</b>
-::This effectively puts all Course Lists in a "Lock to SysAdmin [or other staff admin]" state, preventing Consultant-type accounts from making further changes.<br><br>
+::This effectively puts all [[TracCloudGuideBasicsCourses|Course Lists]] in a "Lock to SysAdmin [or other staff admin]" state, preventing Consultant-type accounts from making further changes.<br><br>
 * <b>Allow Consultant Time Check on Dashboard</b>
-::Allows staff members to view a Time Check-style menu on their dashboard, showing a quick summary of their recent work visits. If enabled, you can also choose the number of weeks shown in the Time Check window.<br><br>
+::Allows staff members to view a Time Check-style menu on their dashboard, showing a quick summary of their recent [[TracCloudGuideBasicsPayroll|work visits]]. If enabled, you can also choose the number of weeks shown in the Time Check window.<br><br>
 * <b>Activate Consultant Enter Notes on Work Visit Log Out</b>
-::If checked, consultants will see a pop-up asking them to enter notes when they log out of their work visits.<br>
+::If checked, consultants will see a pop-up asking them to enter notes when they log out of their work visits.<br><br>
-[[File:8798618.png|800px]]<br><br>
 * <b>Consultant Alias Format</b>
-::If your Profile is set to use Consultant Alias rather than full name, this preference determines the format of that Alias. The default value of 'Use Consultant Alias Field' will use each consultant's personal 'Alias' field contents, or generic 'Consultant' phrasing if blank. You can also use other automatically generated options, such as First Name Only, First Initial Last Name, etc.
+::If your [[TracCloudGuideProfilePrefsSchedule#Other_Schedule_Options|Profile is set to use Consultant Alias]] rather than full name, this preference determines the format of that Alias. The default value of 'Use Consultant Alias Field' will use each [[TracCloudGuideProfileStaff|consultant's personal 'Alias' value]], or generic 'Consultant' phrasing if blank. You can also use other automatically generated options, such as First Name Only, First Initial Last Name, etc.
 ::(<i>First Name Last Initial</i> pictured below)
 ::[[File:1277642.png|650px]]<br><br>
@@ Line 105: / Line 106: @@
 ::This enables a search bar on the 'All Staff' Schedule that allows you to filter visible Consultants by their assigned in-person location.
 ::[[File:4965114.png|650px]]<br><br>
+<hr>
+[[File:6222386.png|800px]]<br><br>
 * <b>Activate Save And Split button for Availabilities</b>
-::Adds a new option on Availability Entry allowing you to split your single block (e.g., 9 to 12, 60 minute times slots) into multiple blocks (9 to 10, 10 to 11, 11 to 12). This is typically left disabled unless you specifically need to manage individual time slots after creating your schedules. If this option is enabled, <b>Show warning message regarding this feature not recommend</b> will display a warning pop-up every time someone uses this utility to confirm their choice.
+::Adds a new option on [[TracCloudGuideBasicsSchedule|Availability Entry]] allowing you to split your single block (e.g., <i>9 to 12</i>, 60 minute times slots) into multiple blocks (<i>9 to 10</i>, <i>10 to 11</i>, <i>11 to 12</i>). This is typically left disabled unless you specifically need to manage individual time slots after creating your schedules. If this option is enabled, <b>Show warning message regarding this feature not recommend</b> will display a warning pop-up every time someone uses this utility to confirm their choice.
 ::[[File:8842183.png|600px]]<br><br>
 * <b>Registration Listing Custom Fields</b>
-::If a Custom Field is selected here, it will be displayed as an additional column on the Registrations Listing and Student Registrations pages. This is typically used for custom fields like midterm grade.
+::If a Custom Field is selected here, it will be displayed as an additional column on the [[TracCloudGuideListingsRegistrations|Registrations Listing]] and Student Registrations pages. This is typically used for custom fields like midterm grade.<br><br>
+* <b>Show Tip of the Week</b>
+::If enabled, SysAdmins will receive occasional [[TracCloudNews01|newsletters]] on the dashboard providing information about various TracCloud features.
 |}
 [[Category:TracCloud]]

TracCloud: System Preferences: Difference between revisions

From Redrock Wiki

Revision as of 11:00, 27 April 2023

Global Preferences