TracCloudGuideProfilePrefsLogEtc: Difference between revisions

From Redrock Wiki

No edit summary
No edit summary
Line 4: Line 4:
| 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; "
<big><b>Log Listing Message, KIOSK Notices, and Custom KIOSKs</b></big><br><br>
<big><b>Log Listing Message, KIOSK Notices, and Custom KIOSKs</b></big><br>
 
This portion of your preferences contains additional options relating to the Log Listing, KIOSKs, and more.
This portion of your preferences contains additional options relating to the Log Listing, KIOSKs, and more.


Line 21: Line 22:
<hr>
<hr>
==Kiosk Login Welcome / Goodbye Messages==
==Kiosk Login Welcome / Goodbye Messages==
These are custom, Twig & HTML-supported messages that can be displayed during the login/logout process on the KIOSK or Log Listing. This allows you to display information to the student while they’re logging in, maybe their upcoming appointment information or contact info for the consultant, this is up to you. For more information on Twig, take a look at our dedicated Twig article.
These are custom, [[TracCloudGuideProfilePrefsTwig|Twig]] & HTML-supported messages that can be displayed during the login/logout process on the [[TracCloudGuideBasicsVisits|KIOSK or Log Listing]]. This allows you to display information to the student while they’re logging in, maybe their upcoming appointment information or contact info for the consultant, this is up to you. For more information on Twig, take a look at our dedicated [[TracCloudGuideProfilePrefsTwig|Twig article]].
<br>
<br>
[[File:G35h35jh634j3j34.png|800px]]
[[File:G35h35jh634j3j34.png|800px]]
Line 42: Line 43:


* <b>Terminate all still logged in</b>
* <b>Terminate all still logged in</b>
::If enabled, any on-going visits by <b>Time for Nightly Termination</b> will be concluded and set to your defined duration.
::If enabled, any on-going visits by <b>Time for Nightly Termination</b> will be concluded and set to your defined duration.<br><br>
 


* <b>Auto set these visits time to (minutes)</b>
* <b>Auto set these visits time to (minutes)</b>
::If an on-going visit is terminated, this is the duration it will be set to.
::If an on-going visit is terminated, this is the duration it will be set to in minutes.<br><br>
 


* <b>Open visit terminations applies to Work Visits</b>
* <b>Open visit terminations applies to Work Visits</b>
::Also apply the above logic to consultant Work Visits as well.
::Also apply the above logic to consultant [[TracCloudGuideBasicsPayroll|Work Visits]] as well.<br><br>
 


* <b>Auto terminate visits longer than (minutes)</b>
* <b>Auto terminate visits longer than (minutes)</b>
::This part of the process will also affect concluded visits as described earlier. This should be set to your maximum possible visit duration to prevent accurate visits from being adjusted. Leave this and <b>Auto set visits time to</b> blank to disable this part of Auto Termination.
::This part of the process will also affect concluded visits as described earlier. This should be set to your maximum possible visit duration to prevent accurate visits from being adjusted. Leave this and <b>Auto set visits time to</b> blank to disable this part of Auto Termination.<br><br>
 


* <b>Auto set visits time to (minutes)</b>
* <b>Auto set visits time to (minutes)</b>
::This is the duration visits will be changed to in the above scenario. Leave this and <b>Auto terminate visits longer than</b> blank to disable this part of Auto Termination.
::This is the duration visits will be changed to in the above scenario. Leave this and <b>Auto terminate visits longer than</b> blank to disable this part of Auto Termination.<br><br>
 


* <b>Time for Nightly Termination</b>
* <b>Time for Nightly Termination</b>
::This is the specific time the Auto Termination process runs each day. This process only applies to visits on the current day, so it should not be set later than 11:59pm.
::This is the specific time the Auto Termination process runs each day. This should be set to a later time in the day (e.g., 11:30pm) to prevent actual in-progress visits from being affected.<br><br>
 


* <b>Send Email Notification to Student / Center Admin</b>
* <b>Send Email Notification to Student / Center Admin</b>
::Toggling these options will send an email to the student and/or center admin letting them know that the student wasn’t logged out. If <i>Center Admin</i> is chosen, additional email addresses can be CC'd in the box below. "Center Admin" refers to the email address entered in <i>[Your Profile] > Prefs > Emails > Profile Email Address</i>.
::Toggling these options will send an email to the student and/or center admin letting them know that the student wasn’t logged out. If <i>Center Admin</i> is chosen, additional email addresses can be CC'd in the box below. "Center Admin" refers to the email address entered in <i>[Your Profile] > Prefs > Emails > Profile Email Address</i>.<br><br>
 


* <b>Delete visits waiting (not started)</b>
* <b>Delete visits waiting (not started)</b>
::If a 'Waiting' status visit reaches the auto-termination window, you can choose if it's terminated normally (unchecked) or deleted (checked).
::If a '[[TracCloudGuideProfilePrefsLogInOut|Waiting]]' status visit reaches the auto-termination window, you can choose if it's terminated normally (unchecked) or deleted (checked).<br><br>
 


* <b>Terminations apply to Work Visits</b>
* <b>Terminations apply to Work Visits</b>
Line 78: Line 71:
<hr>
<hr>
==Other Log In/Out Preferences==
==Other Log In/Out Preferences==
[[File:2918493.png|800px]]
[[File:8628603.png|800px]]
<br><br>
<br><br>
* <b>KIOSK Enter ID label</b>
* <b>KIOSK Enter ID label</b>
::Changes the text shown on the Log Listing/Kiosk “Enter ID” box.
::Changes the text shown on the [[TracCloudGuideBasicsVisits|Log Listing/Kiosk]] “Enter ID” box.
::[[File:H3j4j4j4h45g45.png|500px]]
::[[File:H3j4j4j4h45g45.png|500px]]<br><br>
 


* <b>Log out of this profile when student logs in to another profile</b>
* <b>Log out of this profile when student logs in to another profile</b>
::When a student logs into Profile 1, then logs into Profile 2, their visit in Profile 1 will be automatically concluded.
::If enabled, when a student logs into Center 1, then logs into Center 2, their visit in Center 1 will be automatically concluded.<br><br>
 


* <b>Show total visit minutes when logging out</b>
* <b>Show total visit minutes when logging out</b>
::This will show the visit duration in the relevant center during logout.
::This will show the visit duration in the relevant center during logout.
::[[File:7559462.png|400px]]
::[[File:7559462.png|400px]]<br><br>


* <b>Show Other Choice when logging in to single center even with appointment</b>
::If enabled, students will be able to login to the center for a purpose other than their appointment during the login process. Otherwise, TracCloud will assume they are logging in for their appointment (i.e. selecting the first option in the screenshot below automatically).
::[[File:8873308.png|500px]]<br><br>


* <b>Warn user if visit time is less than (minutes) & Warning message to display</b>
* <b>Warn user if visit time is less than (minutes) & Warning message to display</b>
::If enabled, the staff member logging a student out of a visit that hasn’t lasted the specified amount of time will receive a notice as seen in the screenshot below. This message also supports Twig tags for displaying student data (see our dedicated Twig article), and can be previewed with the “Preview” button so you know what your changes will look like.
::If enabled, the staff member logging a student out of a visit that hasn’t lasted the specified amount of time will receive a notice as seen in the screenshot below. This message also supports Twig tags for displaying student data (see our dedicated [[TracCloudGuideProfilePrefsTwig|Twig article]]), and can be previewed with the “Preview” button so you know what your changes will look like.
::[[File:Jt5kj5k56j6h4.png|500px]]
::[[File:Jt5kj5k56j6h4.png|500px]]<br><br>
 


* <b>Allow user to cancel logout</b>
* <b>Allow user to cancel logout</b>
::Provides the ability to cancel during the student logout process, to keep the student logged in.
::Provides the ability to cancel during the student logout process, to keep the student logged in. This only applies when trying to logout within the time limit set for <b>Warn user if visit timeless than (minutes) when logging out</b>.<br><br>
 


* <b>Obscure student ID (***) on login</b>
* <b>Obscure student ID (***) on login</b>
::If enabled, IDs entered on the log listing will be obscured.
::If enabled, IDs entered on the log listing will be obscured.
::[[File:354j6h4g4g5.png|250px]]
::[[File:354j6h4g4g5.png|250px]]<br><br>
 


* <b>Auto lock visits older than (days)</b>
* <b>Auto lock visits older than (days)</b>
::This preference allows you to prevent visit records from being modified after a specified period of time. This applies to all user groups modifying visits in this profile, with the exception of SysAdmin users.
::This preference allows you to prevent visit records from being modified after a specified period of time. This applies to all user groups modifying visits in this profile, with the exception of [[TracCloudNewsUserLevel|SysAdmin users]].


<hr>
<hr>
==Custom KIOSK Options==
==Custom KIOSK Options==
Custom kiosks can be configured for specific visit scenarios. For example, if one of your kiosks is only going to be used for a specific Center/Reason combination, you can use a Custom Kiosks to make sure students are logging in with those fields predetermined. You can also select a Location, Consultant, Section, and even IP address zone.
Custom kiosks can be configured for specific [[TracCloudGuideBasicsVisits|visit]] scenarios. For example, if one of your kiosks is only going to be used for a specific Center/Reason combination, you can use a Custom Kiosks to make sure students are logging in with those fields predetermined. You can also select a Location, Consultant, Section, and even IP address zone.
<br>
<br>
[[File:5165851.png|800px]]
[[File:5165851.png|800px]]
Line 122: Line 113:
<br>
<br>
[[File:46j46j4h3g3h53j3.png|500px]]
[[File:46j46j4h3g3h53j3.png|500px]]
<hr>
<hr>
==Time Check Preferences==
==Time Check Preferences==


When students log in or out of a center, Time Check will allow them to view how many visit hours they have accumulated within a given time frame. This feature is typically utilized in athletic centers, where students may have a required hours per week or semester. Within these settings, you will be able to manage and adjust the date range of the required hours as well as what totals are displayed to the student, and even a custom message.
When students log in or out of a center, Time Check will allow them to view how many [[TracCloudGuideBasicsVisits|visit]] hours they have accumulated within a given time frame. This feature is typically utilized in athletic centers, where students may have a required hours per week or semester. Within these settings, you will be able to manage and adjust the date range of the required hours as well as what totals are displayed to the student, and even a custom message.


[[File:2963531.png|800px]]<br><br>
[[File:2963531.png|800px]]<br><br>
Line 133: Line 123:
::If checked, will enable the time check option for the profile. This adds an additional “Time Check” button to the Kiosk login page, which allows users to quickly check their past visit time from a Kiosk.
::If checked, will enable the time check option for the profile. This adds an additional “Time Check” button to the Kiosk login page, which allows users to quickly check their past visit time from a Kiosk.
::[[File:75o86l67l6877l.png|400px]]
::[[File:75o86l67l6877l.png|400px]]
::[[File:75k57k65j56j5k5k.png|400px]]
::[[File:75k57k65j56j5k5k.png|400px]]<br><br>
 


* <b>Show Semester totals</b>
* <b>Show Semester totals</b>
::Will display the students total time based on the current terms active date range.
::Will display the students total time based on the current terms active date range.<br><br>
 


* <b>Show Week Totals</b>
* <b>Show Week Totals</b>
::Will display the students total time based on a week date range. If checked, an additional drop down will appear to the right titled <b>Week Starts On</b>. This option will allow you to adjust the day of week that the Time Check utility will calculate the hours for. As an example, selecting Tuesday from the drop down will calculate hours from Tuesday to Monday.
::Will display the students total time based on a week date range. If checked, an additional drop down will appear to the right titled <b>Week Starts On</b>. This option will allow you to adjust the day of week that the Time Check utility will calculate the hours for. As an example, selecting Tuesday from the drop down will calculate hours from Tuesday to Monday.<br><br>
 


* <b>Show Required Time Per</b>
* <b>Show Required Time Per</b>
::There are three options available:<br>None – Will not display Required Hours or difference<br>Weekly – Will show Required Hours and difference based on a one-week time frame.<br>Semester - Will show Required Hours and difference based on the active semesters term date range.
::There are three options available:<br>None – Will not display Required Hours or difference<br>Weekly – Will show Required Hours and difference based on a one-week time frame.<br>Semester - Will show Required Hours and difference based on the active semesters term date range.<br><br>
 


* <b>Required Time Field</b>
* <b>Required Time Field</b>
::The Required Hours utility will point to a custom field in the student’s profile. In order to use Required Hours, you will need to point to the Custom Field designated on the student's profile where their required hours are stored. Required hours can be added to a list of students, or manually added to each individual student’s account. If needed, we can also create a batch process that uploads the required hours to student profiles from your information system.
::The Required Hours utility will point to a [[TracCloudGuideGlobalCustom|custom field]] in the student’s profile. In order to use Required Hours, you will need to point to the custom field designated on the student's profile where their required hours are stored. Required hours can be added to a list of students, or manually added to each individual student’s account. If needed, required time can also be included in your [[TracCloudTechImport|data import]].<br><br>
 


* <b>Required Time in</b>
* <b>Required Time in</b>
::Select the format of the Required Hours field selected, hours or minutes.
::Select the format of the Required Hours field selected, hours or minutes.<br><br>


[[File:7230105.png|800px]]<br><br>
[[File:7230105.png|800px]]<br><br>

Revision as of 14:07, 27 April 2023


Log Listing Message, KIOSK Notices, and Custom KIOSKs
This portion of your preferences contains additional options relating to the Log Listing, KIOSKs, and more.

Notices

A notice can be configured to display on KIOSKs and the Log Listing page. This message can display information that may be useful to staff and students who are trying to login. This message also supports HTML, so you can use bold or italics tags to adjust the visibility of your message.

Here’s an example of a message we can include.
98ok4j5h4mj34h64.png

Which displays as:
4h5346j46hg4j46.png


Kiosk Login Welcome / Goodbye Messages

These are custom, Twig & HTML-supported messages that can be displayed during the login/logout process on the KIOSK or Log Listing. This allows you to display information to the student while they’re logging in, maybe their upcoming appointment information or contact info for the consultant, this is up to you. For more information on Twig, take a look at our dedicated Twig article.
G35h35jh634j3j34.png

Before these messages can be saved, you will need to select the “Preview” button. This will show you how your message will be displayed using a recent appointment/visit as an example. If there are any errors, you will be notified so you can correct them before saving.
5j35j43jj43j35yhge.png

Here’s an example of how the Welcome/Goodbye messages can display:
7k5k75k5h44g4.png
64kj46k4k54j45.png


Auto Terminate Visits Longer Than:

The Auto Termination process can automatically conclude ongoing visits at the end of the night and/or correct visits that have a longer-than-intended duration. There are two parts of this process. The first, Terminate all still logged in, will only conclude visits that are still in-progress by your Time for Nightly Termination. The second, Auto terminate visits longer than, also applies to on-going visits that meet this criteria, however, this additionally applies to concluded visits. For example, if a user created a 10-hour visit for one of your students, this process will change it back to your defined time.
File:1712481.png

  • Terminate all still logged in
If enabled, any on-going visits by Time for Nightly Termination will be concluded and set to your defined duration.

  • Auto set these visits time to (minutes)
If an on-going visit is terminated, this is the duration it will be set to in minutes.

  • Open visit terminations applies to Work Visits
Also apply the above logic to consultant Work Visits as well.

  • Auto terminate visits longer than (minutes)
This part of the process will also affect concluded visits as described earlier. This should be set to your maximum possible visit duration to prevent accurate visits from being adjusted. Leave this and Auto set visits time to blank to disable this part of Auto Termination.

  • Auto set visits time to (minutes)
This is the duration visits will be changed to in the above scenario. Leave this and Auto terminate visits longer than blank to disable this part of Auto Termination.

  • Time for Nightly Termination
This is the specific time the Auto Termination process runs each day. This should be set to a later time in the day (e.g., 11:30pm) to prevent actual in-progress visits from being affected.

  • Send Email Notification to Student / Center Admin
Toggling these options will send an email to the student and/or center admin letting them know that the student wasn’t logged out. If Center Admin is chosen, additional email addresses can be CC'd in the box below. "Center Admin" refers to the email address entered in [Your Profile] > Prefs > Emails > Profile Email Address.

  • Delete visits waiting (not started)
If a 'Waiting' status visit reaches the auto-termination window, you can choose if it's terminated normally (unchecked) or deleted (checked).

  • Terminations apply to Work Visits
If you would like to also terminate work visits, you can check this box and define a different threshold and adjusted time.

Other Log In/Out Preferences

File:8628603.png

  • KIOSK Enter ID label
Changes the text shown on the Log Listing/Kiosk “Enter ID” box.
H3j4j4j4h45g45.png

  • Log out of this profile when student logs in to another profile
If enabled, when a student logs into Center 1, then logs into Center 2, their visit in Center 1 will be automatically concluded.

  • Show total visit minutes when logging out
This will show the visit duration in the relevant center during logout.
7559462.png

  • Show Other Choice when logging in to single center even with appointment
If enabled, students will be able to login to the center for a purpose other than their appointment during the login process. Otherwise, TracCloud will assume they are logging in for their appointment (i.e. selecting the first option in the screenshot below automatically).
8873308.png

  • Warn user if visit time is less than (minutes) & Warning message to display
If enabled, the staff member logging a student out of a visit that hasn’t lasted the specified amount of time will receive a notice as seen in the screenshot below. This message also supports Twig tags for displaying student data (see our dedicated Twig article), and can be previewed with the “Preview” button so you know what your changes will look like.
Jt5kj5k56j6h4.png

  • Allow user to cancel logout
Provides the ability to cancel during the student logout process, to keep the student logged in. This only applies when trying to logout within the time limit set for Warn user if visit timeless than (minutes) when logging out.

  • Obscure student ID (***) on login
If enabled, IDs entered on the log listing will be obscured.
354j6h4g4g5.png

  • Auto lock visits older than (days)
This preference allows you to prevent visit records from being modified after a specified period of time. This applies to all user groups modifying visits in this profile, with the exception of SysAdmin users.

Custom KIOSK Options

Custom kiosks can be configured for specific visit scenarios. For example, if one of your kiosks is only going to be used for a specific Center/Reason combination, you can use a Custom Kiosks to make sure students are logging in with those fields predetermined. You can also select a Location, Consultant, Section, and even IP address zone.
File:5165851.png

These custom kiosks can be accessed from the same menu as your standard center kiosks. They will appear in the bottom half of the list, separated by a horizontal line. The only visual difference within the kiosk is that any fields preselected in the custom kiosk menu won’t show up during student logins, as the visits will already be assigned to that Center/Reason/Consultant/Location.
Allow Only Custom KIOSKs for Logging disables the preset center kiosk options that you would see by default.
46j46j4h3g3h53j3.png


Time Check Preferences

When students log in or out of a center, Time Check will allow them to view how many visit hours they have accumulated within a given time frame. This feature is typically utilized in athletic centers, where students may have a required hours per week or semester. Within these settings, you will be able to manage and adjust the date range of the required hours as well as what totals are displayed to the student, and even a custom message.

2963531.png

  • Time check Available
If checked, will enable the time check option for the profile. This adds an additional “Time Check” button to the Kiosk login page, which allows users to quickly check their past visit time from a Kiosk.
75o86l67l6877l.png
75k57k65j56j5k5k.png

  • Show Semester totals
Will display the students total time based on the current terms active date range.

  • Show Week Totals
Will display the students total time based on a week date range. If checked, an additional drop down will appear to the right titled Week Starts On. This option will allow you to adjust the day of week that the Time Check utility will calculate the hours for. As an example, selecting Tuesday from the drop down will calculate hours from Tuesday to Monday.

  • Show Required Time Per
There are three options available:
None – Will not display Required Hours or difference
Weekly – Will show Required Hours and difference based on a one-week time frame.
Semester - Will show Required Hours and difference based on the active semesters term date range.

  • Required Time Field
The Required Hours utility will point to a custom field in the student’s profile. In order to use Required Hours, you will need to point to the custom field designated on the student's profile where their required hours are stored. Required hours can be added to a list of students, or manually added to each individual student’s account. If needed, required time can also be included in your data import.

  • Required Time in
Select the format of the Required Hours field selected, hours or minutes.

7230105.png

  • Show On Login, Show On LogOut, Show On Student Dashboard
Determines where the Time Check utility will appear for students.


  • Compute totals for all profiles
By default, Time Check will only compute the total time in centers related to the linked profile. If this option is checked, that search will be expanded to all profiles.


  • Timecheck Message Footer
This will allow the profile to customize the message that displays across the bottom of the Time Check screen. This footer can utilize Twig to personalize the message and add in important information as seen below.

6184132.png