TracCloudGuideProfilePrefsLogEtc: Difference between revisions

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.

Which displays as:

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.

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.

Here’s an example of how the Welcome/Goodbye messages can display:

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, will also conclude on-going visits that meet the criteria you set, but primarily it's used to correct visits that have an incorrect duration that day. 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.

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.

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 process only applies to visits on the current day, so it should not be set later than 11:59pm.

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.

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:2918493.png

KIOSK Enter ID label

Changes the text shown on the Log Listing/Kiosk “Enter ID” box.

Log out of this profile when student logs in to another profile

When a student logs into Profile 1, then logs into Profile 2, their visit in Profile 1 will be automatically concluded.

Show total visit minutes when logging out

This will show the visit duration in the relevant center during logout.

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.

Allow user to cancel logout

Provides the ability to cancel during the student logout process, to keep the student logged in.

Obscure student ID (***) on login

If enabled, IDs entered on the log listing will be obscured.

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. If all students logging into a certain center are visiting for a specific reason, you can assign the Kiosk to the reason instead of each individual student visit. The same applies to Consultant and Location.
File:2430244.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.

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.

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.

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, we can also create a batch process that uploads the required hours to student profiles from your information system.

Required Time in

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

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.

@@ Line 36: / Line 36: @@
 <hr>
 ==Auto Terminate Visits Longer Than:==
-If students forget to log out, an automatic process that runs overnight can end these visits and set them to a predetermined duration. For example, any student who is still logged in by 1am probably isn’t actually in the center anymore, so let’s go ahead and end their visit and set it to 60 minutes instead.
+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, <b>Terminate all still logged in</b>, will only conclude visits that are still in-progress by your Time for Nightly Termination. The second, <b>Auto terminate visits longer than</b>, will also conclude on-going visits that meet the criteria you set, but primarily it's used to correct visits that have an incorrect duration that day. 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.
 <br>
-[[File:9604298.png|800px]]
+[[File:9337503.png|800px]]
 <br><br>
+* <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.
+* <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.
+* <b>Open visit terminations applies to Work Visits</b>
+::Also apply the above logic to consultant Work Visits as well.
 * <b>Auto terminate visits longer than (minutes)</b>
-::This process will only affect visits that are longer than this duration. Set this to your maximum possible visit duration.
+::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.
 * <b>Auto set visits time to (minutes)</b>
-::This is the duration the above visits will be set to. For example, if you typically hold 1-hour appointments, you may want to set this to 60. Alternatively, if you plan on going back and correcting these visits with accurate times, you can set the visits to something like 5-hours or 5-minutes. That way the visit has been concluded, but the records stand out and can be easily found and corrected later.
+::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.
 * <b>Time for Nightly Termination</b>
-::This is the specific time the process runs each day, typically set to 11pm.
+::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.

TracCloudGuideProfilePrefsLogEtc: Difference between revisions

From Redrock Wiki

Revision as of 10:02, 9 November 2022