TracCloudGuideBasicsPayroll: Difference between revisions

From Redrock Wiki

No edit summary
No edit summary
Line 35: Line 35:
==1. Pay Codes==
==1. Pay Codes==


The first step towards utilizing TracCloud's payroll features is setting up Pay Codes. Each consultant can be assigned to one Pay Code, we will then be utilizing these Pay Code values to determine Pay Rates in our Work Types.
The first step towards utilizing TracCloud's payroll features is setting up <b>Pay Codes</b>. Each consultant can be assigned to one pay code, we will then be utilizing these pay code values to determine pay rates in our Work Types (step 3).


<span style="color:grey"><i>Other > Other Options > Preferences > Pay Codes. This is only accessible to SysAdmin accounts.</i></span>
<span style="color:grey"><i>Other > Other Options > Preferences > Pay Codes.</i></span>
[[File:2709632.png|900px]]
[[File:5752124.png|900px]]


<hr>
<hr>
==2. Pay Basis==
==2. Pay Basis==


This setting determines how we're tracking work hours. Each Profile can be set to use a different Pay Basis.<br>
Your <b>Pay Basis</b> (found immediately beneath your pay codes) determines how we're tracking work hours. Each profile can be set to use a different pay basis.<br>
<b>Schedule</b> will calculate work hours based on the consultant's scheduled availabilities and appointments.<br>
<b>Schedule</b> will calculate work hours based on the consultant's scheduled availabilities and appointments.<br>
<b>Consultant Work Time</b> will calculate work hours based on the actual time the consultant logs in and out for work visits.<br>
<b>Consultant Work Time</b> will calculate work hours based on the actual time the consultant logs in and out for work visits.<br>
Line 49: Line 49:


<span style="color:grey"><i>Other > Other Options > Preferences > Payroll > Pay Basis for [Profile].</i></span>
<span style="color:grey"><i>Other > Other Options > Preferences > Payroll > Pay Basis for [Profile].</i></span>
[[File:2135910.png|900px]]<br><br>
[[File:4426996.png|900px]]<br><br>


If you're utilizing <b>Consultant Work Time</b> as your Pay Basis, you may prefer to have the consultant login button visible on kiosks. To enable this, check <b>Show Consultant Login Button</b> in your <i>Log In/Out</i> prefs.
If you're utilizing <b>Consultant Work Time</b> as your Pay Basis, you may prefer to have the consultant login button visible on kiosks (and [[TracCloudGuideProfilePrefsLogEtc#Custom_KIOSK_Options|custom kiosks]]). To enable this, check <b>Show Consultant Login Button</b> (and <b>Allow Consultant Login for Custom KIOSKs as well</b>) in your [[TracCloudGuideProfilePrefsLogInOut|<i>Log In/Out</i> prefs]].


<span style="color:grey"><i>Other > Other Options > Profiles > [Your Profile] > Prefs > Log In/Out.</i></span>
<span style="color:grey"><i>Other > Other Options > Profiles > [Your Profile] > Prefs > Log In/Out.</i></span>
[[File:1939821.png|900px]]<br><br>
[[File:4621076.png|900px]]<br><br>


In the same menu, and again relevant for those using <b>Consultant Work Time</b>, you have <b>Only show Consultants that are logged in to Work during KIOSK visit login</b>. If enabled, this will filter down the list of available consultants when students are logging in to only those who are logged in for work. This is primarily utilized for Drop-in-focused environments.
In the same menu, and again relevant for those using <b>Consultant Work Time</b>, you have <b>Only show Consultants that are logged in to Work during KIOSK visit login</b>. If enabled, this will filter down the list of available consultants when students are logging in to only those who are logged in for work. Additionally, you can further filter the results to only consultants logged in for work *and* available for a drop-in, and/or only show consultants who are logged in for work in the same center that the student is currently logging into.


<span style="color:grey"><i>Other > Other Options > Profiles > [Your Profile] > Prefs > Log In/Out.</i></span>
<span style="color:grey"><i>Other > Other Options > Profiles > [Your Profile] > Prefs > Log In/Out.</i></span>
[[File:7588159.png|900px]]
[[File:9719054.png|900px]]


<hr>
<hr>
==3. Work Types==
==3. Work Types==


Next up is Work Types, you can think of these as a form of Pay Rate condition. You'll end up creating multiple of them in a typically configuration to cover each possible condition where a Pay Rate needs to be defined.
Next up is <b>Work Types</b>, you can think of these as a form of pay rate condition. How many you'll need is entirely dependent on how your pay rates change based on center, reason, and fund. You may end up creating only one generic work type, or multiple to cover each possible condition where a unique pay rate needs to be defined.


<span style="color:grey"><i>Other > Listings > Work Types.</i></span>
<span style="color:grey"><i>Other > Listings > Work Types.</i></span>
[[File:9158623.png|900px]]<br><br>
[[File:3139175.png|900px]]<br><br>


To create new Work Type, click the Hamburger icon ([[File:Hamburger.png|17px]]) and select <i>New Work Type</i>. This will bring you to the following screen.
To create new Work Type, click the Hamburger icon {{#fas:bars}} and select <i>New Work Type</i>. This will bring you to the following screen.


[[File:5994383.png|900px]]<br><br>
[[File:4318372.png|900px]]<br><br>


* <b>Active From</b> & <b>Active To</b>
* <b>Active From</b> & <b>Active To</b>
::This work type applies to your [[TracCloudGuideBasicsPayroll#2. Pay Basis|Pay Basis]] within this date range.
::This work type applies to your [[TracCloudGuideBasicsPayroll#2. Pay Basis|Pay Basis]] within this date range.<br><br>


* <b>Pay Basis</b>
* <b>Pay Basis</b>
::This determines which Pay Basis this Work Type applies to. This should always match your Profile's Pay Basis.
::This determines which pay basis this work type applies to. This should always match your profile's pay basis as configured in step 2.<br><br>


* <b>Disposition</b>
* <b>Disposition</b>
::This allows you to differentiate Pay Rates based on how many students the consultant is meeting with.<br><b>No Students</b> - This Work Type is used when the consultant is logged in/has available hours but is not currently meeting with a student. If this is the only Work Type available, Consultant Work Time will still use this type.<br><b>1-on-1</b> - This Work Type applies to consultants who are meeting with a single student.<br><b>Group</b> - This applies if the consultant is meeting with 2 or more students at once.
::This allows you to differentiate pay rates based on how many students the consultant is meeting with.<br><b>No Students</b> - This work type is used when the consultant is logged in/has available hours but is not currently meeting with a student. If this is the only Work Type available, Consultant Work Time will still use this type.<br><b>1-on-1</b> - This work type applies to consultants who are meeting with a single student.<br><b>Group</b> - This applies if the consultant is meeting with 2 or more students at once.<br><br>


* <b>Fund</b>
* <b>Fund</b>
::This lets you assign this work type to a particular fund.
::This lets you assign this work type to a particular fund, so that only visits/appointments/availabilities assigned to that fund will apply to this work type.<br><br>
 
* <b>Center</b>
::This lets you assign this work type to a particular [[TracCloudGuideProfileCenters|center]], so that only visits/appointments/availabilities assigned to that center will apply to this work type.<br><br>
 
* <b>Work Reason</b>
::This lets you assign this work type to a particular work [[TracCloudGuideProfileReasons|reason]], so that only visits/appointments/availabilities assigned to that reason will apply to this work type.<br><br>


* <b>Consultant Pay Code Rates</b>
* <b>Consultant Pay Code Rates</b>
::These are the Pay Rates for each of your Pay Codes if the conditions of this work type are met.<br><br>
::These are the pay rates for each of your pay codes, used if the conditions of this work type are met.<br><br>


To provide a Permission Group the ability to view/modify Work Types, it can be added to the relevant Group's table access settings.
To provide a [[TracCloudGuideProfileGroups|permission group]] the ability to view/modify work types, it can be added to the relevant group's table access settings.


<span style="color:grey"><i>Other > Other Options > Groups > [The Group you want to modify] > Admin / Modules > Table Access.</i></span>
<span style="color:grey"><i>Other > Other Options > Groups > [The Group you want to modify] > Admin / Modules > Table Access.</i></span>

Revision as of 16:08, 16 May 2023


Payroll Contents

1. Pay Codes
2. Pay Basis
3. Work Types
4. Tutor Pay Codes
5. Work Reasons
6. Work Visits
7. Funds
8. Payroll Reports
Tracking Staff Payroll in TracCloud
TracCloud provides the ability to track hours and pay rates of your consultants based on different work types and pay bases. You can then base other system functionality on whether or not a consultant is logged in for work, and report on this payroll data after the fact. Funds can also be used to define pay rates and to group data in reports.

1. Pay Codes

The first step towards utilizing TracCloud's payroll features is setting up Pay Codes. Each consultant can be assigned to one pay code, we will then be utilizing these pay code values to determine pay rates in our Work Types (step 3).

Other > Other Options > Preferences > Pay Codes. 5752124.png


2. Pay Basis

Your Pay Basis (found immediately beneath your pay codes) determines how we're tracking work hours. Each profile can be set to use a different pay basis.
Schedule will calculate work hours based on the consultant's scheduled availabilities and appointments.
Consultant Work Time will calculate work hours based on the actual time the consultant logs in and out for work visits.
Visits will calculate work hours based on the actual time the consultant is meeting with any logged-in student.

Other > Other Options > Preferences > Payroll > Pay Basis for [Profile]. 4426996.png

If you're utilizing Consultant Work Time as your Pay Basis, you may prefer to have the consultant login button visible on kiosks (and custom kiosks). To enable this, check Show Consultant Login Button (and Allow Consultant Login for Custom KIOSKs as well) in your Log In/Out prefs.

Other > Other Options > Profiles > [Your Profile] > Prefs > Log In/Out. 4621076.png

In the same menu, and again relevant for those using Consultant Work Time, you have Only show Consultants that are logged in to Work during KIOSK visit login. If enabled, this will filter down the list of available consultants when students are logging in to only those who are logged in for work. Additionally, you can further filter the results to only consultants logged in for work *and* available for a drop-in, and/or only show consultants who are logged in for work in the same center that the student is currently logging into.

Other > Other Options > Profiles > [Your Profile] > Prefs > Log In/Out. 9719054.png


3. Work Types

Next up is Work Types, you can think of these as a form of pay rate condition. How many you'll need is entirely dependent on how your pay rates change based on center, reason, and fund. You may end up creating only one generic work type, or multiple to cover each possible condition where a unique pay rate needs to be defined.

Other > Listings > Work Types. 3139175.png

To create new Work Type, click the Hamburger icon and select New Work Type. This will bring you to the following screen.

4318372.png

  • Active From & Active To
This work type applies to your Pay Basis within this date range.

  • Pay Basis
This determines which pay basis this work type applies to. This should always match your profile's pay basis as configured in step 2.

  • Disposition
This allows you to differentiate pay rates based on how many students the consultant is meeting with.
No Students - This work type is used when the consultant is logged in/has available hours but is not currently meeting with a student. If this is the only Work Type available, Consultant Work Time will still use this type.
1-on-1 - This work type applies to consultants who are meeting with a single student.
Group - This applies if the consultant is meeting with 2 or more students at once.

  • Fund
This lets you assign this work type to a particular fund, so that only visits/appointments/availabilities assigned to that fund will apply to this work type.

  • Center
This lets you assign this work type to a particular center, so that only visits/appointments/availabilities assigned to that center will apply to this work type.

  • Work Reason
This lets you assign this work type to a particular work reason, so that only visits/appointments/availabilities assigned to that reason will apply to this work type.

  • Consultant Pay Code Rates
These are the pay rates for each of your pay codes, used if the conditions of this work type are met.

To provide a permission group the ability to view/modify work types, it can be added to the relevant group's table access settings.

Other > Other Options > Groups > [The Group you want to modify] > Admin / Modules > Table Access. File:6838667.png


4. Tutor Pay Codes

Next up, we need to assign a Pay Code to our consultants. The is as simple as going to their profile and choosing the correct Pay Code from the drop-down menu. Save after making changes.

Other > Listings > Staff > [Your Consultant] > Pay Code. File:5481492.png



5. Work Reasons (If Pay Basis is Work Time)

If Consultants are logging in for work hours (via kiosk or dashboard), work Reasons can be created to better categorize their hours. Simply create a reason as you normally would, and make sure to check the Work Reason checkbox.

Other > Other Options > Profiles > [Your Profile] > Reasons > New Reason. File:6556093.png

The next time a consultant logs into a center, they will see the available work reasons to select.

8281618.png


6. Work Visits (If Pay Basis is Work Time)

There are two ways a consultant can start their work visit.

1. From a Kiosk or Log Listing

If your Profile Prefs allow it (see 2. Pay Basis), consultants can login for work from a Kiosk or on the Log Listing by clicking the first highlighted icon below. This will prompt them to choose a center and work reason for their visit. The second icon opens a window that displays currently logged in consultants.
File:7062494.png

2. From the dashboard

Consultants can be given the ability to log themselves in from the dashboard if their Permission Group allows it.
Other > Other Options > Groups > [The Group you want to edit] > Log In/Out.
File:6402937.png

  • Allow consultant to login for work at their main menu
Provides consultant accounts the ability to login for work visits.
  • Allow consultant to login for work on KIOSK where the user logged in is themself
Prevents consultants in this group from logging themselves in for work visits on kiosks.

Once the first option is enabled, consultants will have the ability to log themselves in for work directly from their dashboard.
8893534.png

7. Funds

Funds can be entered in several locations, from the student profile to the consultant. The order in which these are prioritized is Student > Visit > Appointment > Availability > Consultant > Center, with the Consultant Fund only being utilized if the other 4 funds for a particular scenario are blank. Information on enabling each of these fund fields can be found below. Consultant Fund is enabled by default.


Student Fund can be enabled in your System Preferences.

Other > Other Options > Preferences > Student Entry Choices > Display Fund. 4701914.png

Appointment and Availability Fund can be found in your Profile Preferences. The Appointment Preference also applies to Visit Fund.

Other > Other Options > Profiles > Prefs > Scheduling > Special Fields. 2212277.png


8. Payroll Reports

There are two Payroll reports available for this information, found in the Navigation Bar, under Reports > Payroll. Access to these reports does require Allow user to access payroll reports to be enabled in the relevant permission group.

Other > Other Options > Groups > [The group you want to modify] > Center Access. 7312954.png

Once enabled, the following reports will be available.


Consultant Additional Detail Listing

This report will pull all active staff into a report with their name, email, assigned group, linked centers, and if they are a consultant (have a schedule on the calendar).

4410803.png


  • Centers
Filter report data by center. You can select all centers or only a specific few to narrow down your results. At least one center must be selected.


  • Sort by
Choose how the selected data is sorted.


  • Pay Code
Filter report results by consultant pay code.


  • Additional Search
Filter your results by a selected field.
Use * as a wildcard (Subject: MAT*)
| as "or" (Major: Mathematics|Biology)
# as "Not" (Status: #Inactive)
&& as "And" (Major: #Mathematics&&#Biology)
blankornull as a keyword to find records where the field is blank (Reason: blankornull)
Multiple fields can be added to further narrow down your results.


  • Additional fields to show
This can be used to add additional data fields to the report results. For example, you could use this to add a student's email address in a visit report.


  • Output format
Use HTML to view report data in your browser, or export this report to a CSV file (available for most reports). Some reports offer additional CSV options depending on if you want to include totals and/or data grouping in your export.


  • Deliver to
Display this report immediately in your browser ("Screen"), or send the report to a specified email address ("Email"). Multiple email addresses can be specified, use ; to separate them (example@example.edu;sample@example.edu).



HTML
2487749.png

CSV
1414791.png



Payroll

This report will show you payroll grouped by the center. Consultant, hourly rate, total hours, and total compensation will be displayed.

3329537.png


  • Centers
Filter report data by center. You can select all centers or only a specific few to narrow down your results. At least one center must be selected.


  • Time Frame
The date range for the data in this report. Beyond entering a date range manually, you can also choose a preset date range (Today, This Month, This Semester, etc) from the dropdown list above.


  • Group by
Group records by the selected field. Some reports allow you to add secondary and tertiary groupings as well.


  • Show Totals Bar Chart
Adds a visual bar chart of totals to your report data.


  • Show Email, Mailbox, Notes
Additional consultant fields that can be included in report results if needed.


  • Recompute Data
This will recalculate your consultant work times to retrieve the most up to date information, but can slightly slow down processing time.


  • Show Summary
Only show data totals, excluding details of individual records.


  • Show Student Visits
Include Student Visit data in report results, to view who the consultant was working with during their work hours.


  • Show Consultants without Hours
Display all consultants in payroll report, those without work time will simply display as having 0.00 hours.


  • Show Work Visits
Include data on the individual visits in the report itself. If enabled, you will also be able to include notes from the work visit record in the report results by checking Show Work Notes.


  • Show Daily Payroll Hours
Shows a day-by-day breakdown of work hours within the overall date range that you selected.


  • Show Funds
Include fund source in results.


  • Page Break
Separate consultants onto different pages when printing the HTML version of this report. Requires 'Group by' options to be unchecked.


  • Time Format
This determines the format of duration, a 90-minute session could display as 1.50, 01:30:00, or 01:30.


  • Round to Nearest & Round individual visits first
Round total visit time to the nearest X-minutes. You also have the ability to round individual visit durations first.


  • Additional Search
Filter your results by a selected field.
Use * as a wildcard (Subject: MAT*)
| as "or" (Major: Mathematics|Biology)
# as "Not" (Status: #Inactive)
&& as "And" (Major: #Mathematics&&#Biology)
blankornull as a keyword to find records where the field is blank (Reason: blankornull)
Multiple fields can be added to further narrow down your results.


  • Output format
Use HTML to view report data in your browser, or export this report to a CSV file (available for most reports). Some reports offer additional CSV options depending on if you want to include totals and/or data grouping in your export.


  • Deliver to
Display this report immediately in your browser ("Screen"), or send the report to a specified email address ("Email"). Multiple email addresses can be specified, use ; to separate them (example@example.edu;sample@example.edu).



HTML
8640374.png

CSV
3358839.png