sbv.wiki - User contributions [en]

Tools

2017-08-22T19:20:51Z

Tami:

The Tools ribbon tab contains an assortment of functions and utilities that apply to the employees as a whole.

[[image:ToolsTabGroups.png]]

''Processing'' – communicate to the time clocks to get the punch information (polling), then process and calculate the punches into the time cards. This is typically performed as a scheduled task on the server.

''Clock Communications'' – provides clock functionality other than polling, such as template management, setting the time, and configuration of the time clocks.

''Power Edit'' – provides a grid based view of the employees allowing you to change the labor levels, pay rules, base schedules and holiday groups for employees. This is quicker than going from employee to employee when you have bulk changes to perform. The grid allows you to group employees.

''[[Import]]'' – add or update information in the software by providing Excel files.

''Close Pay Period'' – closes the pay period(s) to stop further editing. Use the pay period configuration to close the pay periods automatically.

==Processing==

Processing comprises communicating to the time clocks to get new punches, and the calculation of the time cards and accruals.

[[image:ToolsProcessingForm.png]]

'''Clock Communications'''

''Poll'' – retrieves the punches from the selected time clocks.

''Select Clocks'' – selects the time clocks that you want to poll.

'''Time Card Calculation'''

''No Calculation'' – no punch processing or time card calculation will be performed.

''Employees With Unprocessed Punches'' – any new punches from polling the time clock, or any existing punches that match either a new employee or an existing employee with a new or changed clock ID, will be matched to the employee and their time cards calculated.

''All Employees'' – this is a complete calculation of every employee's time card.

'''Accrual Calculation'''

''All Employees'' – this is a complete calculation of every employee's accruals.

'''Facility Calculation'''

In a multi facility software, you can select to calculate a single facility, or all facilites.

==Clock Communications==

Perform template management and clock configuration in Clock Communications.

[[Image:ToolsClockCommunicationForm.png]]

'''Clock Communications'''

''Set Time (uses NIST time server)'' – updates the computer's time from the atomic clock and if successful, the correct time is sent to the time clock. This is the recommended way of setting the time.

''Synch Employees'' – synchronizes the hand templates between time clocks. This gets a list of employees from each clock, deletes employees who should not be at a particular clock, updates the clock with the employee’s latest hand template, and adds any new employees. This is the recommended way to manage hand templates.

''Synch Employees (Update Supervisors)'' - same as Synch Employees except that any users in the HandPunch that are supervisors will update the employee as a supervisor. Normally the software controls who is a supervisor at the time clock and not the time clock itself.

''Configure'' – sends the configuration information to the time clocks.

''Get Status'' – retrieves information about the time clock including the model number and the number of users enrolled.

''Send Punching Zones'' – sends the information that restricts employees from punching at the time clock. This is based on the employee punching zone in their Clock Info tab or the employee's schedules if using schedule based restrictions (Work Pattern tab).

''Send Employee Messages'' – sends the custom per employee messages to the time clocks.

''Select Clocks'' – select the clocks to communicate to.

'''Misc.'''

'''[[image:ToolsClockCommunicationsMisc.png]]'''

The miscellaneous tab contains less commonly used clock communication methods, which should be used with caution and only on the advice of tech support.

''Get Employees'' – gets all hand templates from the time clocks, ignoring any information about when the template was acquired. Use this to get the hand templates from one HandPunch when switching from another system, when you know that one HandPunch has the best hand templates for the employees.

''Send Employees'' – deletes all the hand templates then sends the hands in the software. If there are no hand templates in the software, then this will wipe the clock empty.

''Set Time (uses computer time)'' – sends the computer's time to the clocks without verifying that the time is correct.

''Get Configuration'' – use an existing HandPunch as the source of the configuration settings in the software. This is very handy when switching from an existing system to this software and you do not know what the settings in the time clock are.

''Send Tech ID / Remove Tech ID'' – this sends a no verification hand template with supervisor authorization to the time clock so that a technician can gain access to the HandPunch configuration menus. You MUST follow these guidelines before using:

* Make sure another employee does not use the clock ID that you are going to use unless they are the supervisor and they are going to re-enroll themselves.

* Stop all communications to the HandPunch otherwise you will have this tech ID floating around in your time clocks.

* Once the technician has access to the HandPunch, they should remove and re-enroll their hand so that a biometric verifcation is required.

''Calibrate'' – performs the calibration of the time clock. This command is of a limited value with the newer HandPunches as they perform a calibrate on powering up.

== See also ==

* [[Software|Using the Time and Attendance software]]

* [[Employees]]

* [[Employee]]

* [[Reports]]

* [[Scheduler]]

* [[Import]]

* [[Configuration]]

Time Card Reports

2017-08-22T19:11:55Z

Tami:

[[image:TimeCardReports.png|right]]]]

===Daily Time Cards===

A time card report grouped by each pay date. This report is useful to look at time card activity over a date range but seeing the activity within each date together.

===Exception Time Card===

This report displays the same information as the time card report, but only includes employees who have the selected exceptions ([[Report Options Tab|Options]] tab).

===Missing Shifts Time Card===

The missing shifts time card report displays the same information as the time card report, but only includes employees who have worked fewer shifts than their current shift count level ([[Employee Work Pattern|Work Pattern tab]]).

===Over Shifts Time Card===

The over shifts time card report displays the same information as the time card report, but only includes employees who have worked more shifts than their current shift count level ([[Employee Work Pattern|Work Pattern tab]]). Per Diem employees are not included in the report.

===Punch Versus Paid===

Time card punch report that compares the minute to minute calculation with paid hours.

===Time Cards===

The time card report is one of the most commonly run reports. It provides all the punch and hours information for the employee as well as optional information like exception and shift counts. There are a large number of options available on this report ([[Report Options Tab|Options]] tab).

===Time Cards Excel===

A time card report in Excel format.

===Time Cards with Schedules===

Displays the punches, daily totals, schedules and hours summary.

== See Also ==

* [[Reports]]

Time Card Reports

2017-08-22T19:08:05Z

Tami:

[[image:TimeCardReports.png]]

===Daily Time Cards===

A time card report grouped by each pay date. This report is useful to look at time card activity over a date range but seeing the activity within each date together.

===Exception Time Card===

This report displays the same information as the time card report, but only includes employees who have the selected exceptions ([[Report Options Tab|Options]] tab).

===Missing Shifts Time Card===

The missing shifts time card report displays the same information as the time card report, but only includes employees who have worked fewer shifts than their current shift count level ([[Employee Work Pattern|Work Pattern tab]]).

===Over Shifts Time Card===

The over shifts time card report displays the same information as the time card report, but only includes employees who have worked more shifts than their current shift count level ([[Employee Work Pattern|Work Pattern tab]]). Per Diem employees are not included in the report.

===Punch Versus Paid===

Time card punch report that compares the minute to minute calculation with paid hours.

===Time Cards===

The time card report is one of the most commonly run reports. It provides all the punch and hours information for the employee as well as optional information like exception and shift counts. There are a large number of options available on this report ([[Report Options Tab|Options]] tab).

===Time Cards Excel===

A time card report in Excel format.

===Time Cards with Schedules===

Displays the punches, daily totals, schedules and hours summary.

== See Also ==

* [[Reports]]

User Preferences

2017-08-22T19:07:19Z

Tami:

The User Preferences allow you to customize and personalize how information is visually organized and displayed.

[[Image:EmployeesGroupUserPreferences.png]]

==Employee Grouping==

[[Image:EmployeeGroupingTabPage.png|300px]]

Employee grouping lets you organize the employees into a hierarchical based view, grouped by one or more of the labor levels. You can choose to display the labor level ID and/or the labor level description in the group headers, and sort by the labor level ID, the description, or the sort order assigned to the labor level.

==Employee Name Format==

'''Employee List Name Format'''

Display the employee name with the employee ID before or after the employee name. The name format will affect how the employees sort, so choose the format that presents the employees in the order that you find easier to work with.

'''Employee Info Text'''

[[Image:EmployeeNameFormatTabPage.png|300px]]

The employee information shown in the caption bar can be customized (the caption bar in the picture below is where "User Preferences" is displayed). It uses merge fields like you do when making merge letters. Position your cursor in the text box and from the arrow on the Employee Info Text button, select one of the merge fields. The merge fields are replaced by the selected employee's information.

For example "Emp # <EmployeeID> - <FirstName> <LastName>." will display as "Emp # 12345 - Joe Smith." when you click on the employee Joe Smith.

A list of all available merge fields is [[Merge Fields|here]].

==Employee Filtering==

'''Labor Level Filtering'''

You can filter the employee list to one labor level item within a particular labor level. For example, if you have a large number of employees across many companies, then you can filter the employee list to a single company.

'''Employee Status Filtering'''

[[Image:EmployeeFilteringTabPage.png|300px]]

Every employee has a current status. A status is configured to either display or not display by default. For example, the Active status typically displays by default, while the Inactive status typically does not display by default. Click the Apply button after selecting the Employee Statuses you wish to view.

==Time Cards Preferences==

[[Image:TimeCards.png|300px]]

There are four different formats for displaying the hour totals on screen and in the time card reports. These are:

* Total Hours, e.g. 14.00
* Total Hours by Pay Type, e.g. 7.00 REG 7.00 OT
* Total Hours by Shift, e.g. 7.00 (AM) 7.00 (PM)
* Total Hours by Pay Type and Shift, e.g. 7.00 REG (AM) 7.00 OT (PM)

You can select a different format for on screen and for the time card reports format.

''Show Worked Hours Only'' – this will eliminate pay types like holiday and vacation from the hour totals. The employee totals will show all pay types.

''Show Add To Totals Hours Only'' – this will eliminate pay types like differentials (if the differential matches regular hours) from being in the hour totals. The employee totals will show all pay types.

''Do Not Display Pre Paid Hours'' – this will eliminate Other Hours that were marked as Pre Paid from appearing in the hours totals. The employee totals will show all pay types.

''Display Actual Date In Daily Summary'' – allows the actual date to be displayed in the daily totals in a column next to the pay date.

==Main Screen Preferences==

[[Image:MainScreenTabPage.png|300px]]

''Color Scheme ''– the software allows you to use the three color schemes of Blue, Silver and Black in addition to selecting your own custom color.

''Hide Status Bar'' – the status bar can be hidden, e.g. you have a smaller screen and screen space is tight.

''Quick Access Commands –'' sort and delete the Quick Access commands. A separator can be inserted between commands to organize them.

==See Also==
*[[Employees]]
*[[Frequently Asked Questions (FAQ)]]

User Preferences

2017-08-22T19:07:05Z

Tami:

[[Image:EmployeesGroupUserPreferences.png]]

The User Preferences allow you to customize and personalize how information is visually organized and displayed.

==Employee Grouping==

[[Image:EmployeeGroupingTabPage.png|300px]]

Employee grouping lets you organize the employees into a hierarchical based view, grouped by one or more of the labor levels. You can choose to display the labor level ID and/or the labor level description in the group headers, and sort by the labor level ID, the description, or the sort order assigned to the labor level.

==Employee Name Format==

'''Employee List Name Format'''

Display the employee name with the employee ID before or after the employee name. The name format will affect how the employees sort, so choose the format that presents the employees in the order that you find easier to work with.

'''Employee Info Text'''

[[Image:EmployeeNameFormatTabPage.png|300px]]

The employee information shown in the caption bar can be customized (the caption bar in the picture below is where "User Preferences" is displayed). It uses merge fields like you do when making merge letters. Position your cursor in the text box and from the arrow on the Employee Info Text button, select one of the merge fields. The merge fields are replaced by the selected employee's information.

For example "Emp # <EmployeeID> - <FirstName> <LastName>." will display as "Emp # 12345 - Joe Smith." when you click on the employee Joe Smith.

A list of all available merge fields is [[Merge Fields|here]].

==Employee Filtering==

'''Labor Level Filtering'''

You can filter the employee list to one labor level item within a particular labor level. For example, if you have a large number of employees across many companies, then you can filter the employee list to a single company.

'''Employee Status Filtering'''

[[Image:EmployeeFilteringTabPage.png|300px]]

Every employee has a current status. A status is configured to either display or not display by default. For example, the Active status typically displays by default, while the Inactive status typically does not display by default. Click the Apply button after selecting the Employee Statuses you wish to view.

==Time Cards Preferences==

[[Image:TimeCards.png|300px]]

There are four different formats for displaying the hour totals on screen and in the time card reports. These are:

* Total Hours, e.g. 14.00
* Total Hours by Pay Type, e.g. 7.00 REG 7.00 OT
* Total Hours by Shift, e.g. 7.00 (AM) 7.00 (PM)
* Total Hours by Pay Type and Shift, e.g. 7.00 REG (AM) 7.00 OT (PM)

You can select a different format for on screen and for the time card reports format.

''Show Worked Hours Only'' – this will eliminate pay types like holiday and vacation from the hour totals. The employee totals will show all pay types.

''Show Add To Totals Hours Only'' – this will eliminate pay types like differentials (if the differential matches regular hours) from being in the hour totals. The employee totals will show all pay types.

''Do Not Display Pre Paid Hours'' – this will eliminate Other Hours that were marked as Pre Paid from appearing in the hours totals. The employee totals will show all pay types.

''Display Actual Date In Daily Summary'' – allows the actual date to be displayed in the daily totals in a column next to the pay date.

==Main Screen Preferences==

[[Image:MainScreenTabPage.png|300px]]

''Color Scheme ''– the software allows you to use the three color schemes of Blue, Silver and Black in addition to selecting your own custom color.

''Hide Status Bar'' – the status bar can be hidden, e.g. you have a smaller screen and screen space is tight.

''Quick Access Commands –'' sort and delete the Quick Access commands. A separator can be inserted between commands to organize them.

==See Also==
*[[Employees]]
*[[Frequently Asked Questions (FAQ)]]

Employees

2017-08-22T19:06:41Z

Tami:

The employees list displays down the left side of the screen. Select the Home tab to return to this employees based view, if you have displayed the Scheduler or one of the Configuration screens. The top row of the employees list is a filter row. Type in part of an [[Employee|employee's]] name or their employee ID and press Enter to filter the list to employees that contain any part of the entered text.

Customize the employees list to display the employees with grouping and in the desired order in [[User Preferences]].

You can [[Employees Highlighter|highlight]] employees based on the employee have hours, exceptions or placeholders.

[[image:EmployeesGrid.png]]

==Employees Group==

[[image:EmployeesGroup.png]]

The employees group is the first group in the Home tab. You access the following employee-based commands from this group.

* ''Add Employee'' – add a new employee.

* ''Find Employee'' – search for an employee based on various criteria including clock ID and Social Security Number.

* ''[[Employees Highlighter|Highlight]]'' – highlight employees based on exceptions and placeholders.

* ''Collapse'' – collapse the employee list to display only the group headers while keeping the currently selected employee visible.

* ''Expand'' – expand all groups so as to display all employees.

* ''Refresh'' – retrieve an up to date list of the employees if other users have added employees.

* ''Display Older Data'' – toggles the date based filtering of older time card and schedule information.

* ''[[User Preferences]]'' – change the way that employees are grouped or filtered, plus other display options.

==Add Employee==

[[image:AddEmployeeForm.png]]

Click on Add Employee to open the Add Employee screen.

''Employee ID'' – this must be unique and is validated to ensure that another employee is not already using this ID.

''Next Available ID'' – provides the next higher numbered ID, or use the drop down button to enter an ID as a starting point.

''Clock ID'' – the ID used at the time clock. If the employee is non-punching, then uncheck the checkbox. The clock ID must be unique and is validated, so if the software finds a duplicate clock ID, it will add the employee, but will not add the clock ID. A popup message will inform you of this.

''First Name'' – enter the employee's first name here.

''Last Name'' – enter the employee's last name here.

''SSN'' – enter it here if you want to validate the uniqueness of an employee by their SSN.

''Labor Levels'' – the employee’s home labor levels. Entered in the Main tab if not entered on this screen. If your authorization only allows you to add employees into certain labor levels, then you will need to enter the labor levels in order to enable the Add button. Click on the [[image:LaborLevelsButton.png]] button for the labor levels selection screen.

''Copy settings from currently selected employee'' – this will copy the labor levels, pay rule, base schedule, holiday group, accrual group and work pattern information settings from the currently selected employee, and assign the next available ID. Please note that no personal information will copy to the new employee.

''Duplicate Employee Check'' – performs a check by name and SSN to identify possible duplicate entry of an existing employee. If the software finds a matching employee, but it is not a duplicate (for example, two employees have identical names), then you will need to uncheck this before clicking the Add button.

''Starting Date'' – used as the date for the status, shift history and work pattern information.

''Add Active Status Entry'' – adds an Active entry into the employee's status information using the Starting Date.

''Add Shift Entry'' – adds an entry into the employee's shift history using the Shift Count, Daily Hours, Shift and Starting Date information.

''Add Work Pattern Entry'' – adds an entry into the employee's Work Pattern information using the Starting Date. If an employee is part of the Scheduler, then select "Soft Scheduler" or "Scheduler".

'''Add Button'''

The Add button enables once you have entered the required employee information. The Employee ID and Clock ID are validated to ensure that they are both unique. The employee will not be added if another employee already uses this Employee ID. The employee will be added, but the clock ID will not be added if the clock ID is already used by another employee. In this situation, a popup message displays.

After adding the employee, the Add Employee screen will close and the employee is added to the employee list, and is automatically selected. Enter any additional employee information that you are maintaining.

==Find Employee==

[[image:FindEmployeeForm.png]]

The Find Employee screen searches for employees in various ways and with various criteria.

'''Find'''

''Filtered List''

Based on the Find value and the Look In type selected, a filtered list of employees displays. Clicking on an employee selects that employee in the employee list.

''Find First / Find Next''

Based on the Find value and the Look In type selected, you can move sequentially through the employee list until no more employees match the criteria.

''Highlight All/ Unhighlight''

Based on the Find value and the Look In type selected, highlight all employees that match the criteria.

'''Options'''

''Employee Status Filtering'' – only employees in a status that is set to display by default will be included in searching unless you select other status types. If the found employee is not currently displayed in the employee list, then you will need to make them visible first.

''Sort Order'' – sorts the list of employees by the employee ID, the employee name, or the best matching value. The best matching value sorts those employees that start with the value you are looking for, before employees that contain or end with the value you are looking for. For example, when looking for "berg," Bergman would come before Goldberg.

''Default On Enter Key'' – pressing the Enter key can be set to be the equivalent of clicking the Filtered List button or clicking the Find First button.

== See also ==

* [[Software|Using the Time and Attendance software]]

* [[Employee]]

* [[Reports]]

* [[Scheduler]]

* [[Tools]]

* [[Import]]

* [[Configuration]]

Employees

2017-08-22T19:06:20Z

Tami:

[[image:EmployeesGrid.png]]

The employees list displays down the left side of the screen. Select the Home tab to return to this employees based view, if you have displayed the Scheduler or one of the Configuration screens. The top row of the employees list is a filter row. Type in part of an [[Employee|employee's]] name or their employee ID and press Enter to filter the list to employees that contain any part of the entered text.

Customize the employees list to display the employees with grouping and in the desired order in [[User Preferences]].

You can [[Employees Highlighter|highlight]] employees based on the employee have hours, exceptions or placeholders.

==Employees Group==

[[image:EmployeesGroup.png]]

The employees group is the first group in the Home tab. You access the following employee-based commands from this group.

* ''Add Employee'' – add a new employee.

* ''Find Employee'' – search for an employee based on various criteria including clock ID and Social Security Number.

* ''[[Employees Highlighter|Highlight]]'' – highlight employees based on exceptions and placeholders.

* ''Collapse'' – collapse the employee list to display only the group headers while keeping the currently selected employee visible.

* ''Expand'' – expand all groups so as to display all employees.

* ''Refresh'' – retrieve an up to date list of the employees if other users have added employees.

* ''Display Older Data'' – toggles the date based filtering of older time card and schedule information.

* ''[[User Preferences]]'' – change the way that employees are grouped or filtered, plus other display options.

==Add Employee==

[[image:AddEmployeeForm.png]]

Click on Add Employee to open the Add Employee screen.

''Employee ID'' – this must be unique and is validated to ensure that another employee is not already using this ID.

''Next Available ID'' – provides the next higher numbered ID, or use the drop down button to enter an ID as a starting point.

''Clock ID'' – the ID used at the time clock. If the employee is non-punching, then uncheck the checkbox. The clock ID must be unique and is validated, so if the software finds a duplicate clock ID, it will add the employee, but will not add the clock ID. A popup message will inform you of this.

''First Name'' – enter the employee's first name here.

''Last Name'' – enter the employee's last name here.

''SSN'' – enter it here if you want to validate the uniqueness of an employee by their SSN.

''Labor Levels'' – the employee’s home labor levels. Entered in the Main tab if not entered on this screen. If your authorization only allows you to add employees into certain labor levels, then you will need to enter the labor levels in order to enable the Add button. Click on the [[image:LaborLevelsButton.png]] button for the labor levels selection screen.

''Copy settings from currently selected employee'' – this will copy the labor levels, pay rule, base schedule, holiday group, accrual group and work pattern information settings from the currently selected employee, and assign the next available ID. Please note that no personal information will copy to the new employee.

''Duplicate Employee Check'' – performs a check by name and SSN to identify possible duplicate entry of an existing employee. If the software finds a matching employee, but it is not a duplicate (for example, two employees have identical names), then you will need to uncheck this before clicking the Add button.

''Starting Date'' – used as the date for the status, shift history and work pattern information.

''Add Active Status Entry'' – adds an Active entry into the employee's status information using the Starting Date.

''Add Shift Entry'' – adds an entry into the employee's shift history using the Shift Count, Daily Hours, Shift and Starting Date information.

''Add Work Pattern Entry'' – adds an entry into the employee's Work Pattern information using the Starting Date. If an employee is part of the Scheduler, then select "Soft Scheduler" or "Scheduler".

'''Add Button'''

The Add button enables once you have entered the required employee information. The Employee ID and Clock ID are validated to ensure that they are both unique. The employee will not be added if another employee already uses this Employee ID. The employee will be added, but the clock ID will not be added if the clock ID is already used by another employee. In this situation, a popup message displays.

After adding the employee, the Add Employee screen will close and the employee is added to the employee list, and is automatically selected. Enter any additional employee information that you are maintaining.

==Find Employee==

[[image:FindEmployeeForm.png]]

The Find Employee screen searches for employees in various ways and with various criteria.

'''Find'''

''Filtered List''

Based on the Find value and the Look In type selected, a filtered list of employees displays. Clicking on an employee selects that employee in the employee list.

''Find First / Find Next''

Based on the Find value and the Look In type selected, you can move sequentially through the employee list until no more employees match the criteria.

''Highlight All/ Unhighlight''

Based on the Find value and the Look In type selected, highlight all employees that match the criteria.

'''Options'''

''Employee Status Filtering'' – only employees in a status that is set to display by default will be included in searching unless you select other status types. If the found employee is not currently displayed in the employee list, then you will need to make them visible first.

''Sort Order'' – sorts the list of employees by the employee ID, the employee name, or the best matching value. The best matching value sorts those employees that start with the value you are looking for, before employees that contain or end with the value you are looking for. For example, when looking for "berg," Bergman would come before Goldberg.

''Default On Enter Key'' – pressing the Enter key can be set to be the equivalent of clicking the Filtered List button or clicking the Find First button.

== See also ==

* [[Software|Using the Time and Attendance software]]

* [[Employee]]

* [[Reports]]

* [[Scheduler]]

* [[Tools]]

* [[Import]]

* [[Configuration]]

Employee Authorizations

2017-08-22T18:26:55Z

Tami:

[[image:EmployeeAuthorizationsTab.png]]

Enable an employee’s Authorization to make them a user of the software. Define the level of authorization through the combination of labor levels and roles.

'''Main Tab'''

[[image:EmployeeAuthorizationsMainTab.png]]

Authorizations are turned on and off in the Main tab. A Login ID and a Password is required. Only Administrators can enable the Authorizations on employees. Additionally, the pay rates authorization needs to be explicitly set at the user level, even for administrators. A user that administers the software does not necessarily see the pay rates.

[[image:EmployeeAuthorizationsMainTabPage.png]]

Upon checking Enable Authorizations, the Login ID and Password is set to a random eight characters. Change the Login ID to something more familiar to the user and you can choose either to keep the password or to change it. Users can change their own password once they have logged on.

The Role selected in the Main tab will be the Role that applies to all non-employee related authorizations, such as the ability to make changes with the configuration. It is also the Role used when adding labor level authorizations.

If the Default Role is Administrator (Built In), then there is no need to define roles under the Labor Levels tab, because an Administrator sees all employees and has the administrative role on all employees.

'''Labor Levels Tab'''

[[image:EmployeeAuthorizationsLaborLevelsTab.png]]

The Labor Levels tab is where you assign the non-administrative user access to view and work with employees based on the assigned labor levels combinations. The user will not see any employees until an entry is added. Each entry allows you to specify the Role that the user has when working on employees who match the labor level combination. This allows you to define a different level of authorizations for different employees.

[[image:EmployeeAuthorizationsLaborLevelsTabPage.png]]

All columns will display a drop down list upon clicking in any cell. The drop down list contains all the labor level entries for that column plus an additional entry of * (Authorization), which is the wildcard. The use of the wildcard implies that all of the labor level selections within that column are included.

'''Add'''

The top row of the grid is where you add entries to the grid. Upon making the labor level selections, press Enter to add the new row.

'''Delete'''

Select a row using the mouse by clicking on the row header. Press Delete on the keyboard to remove the row.

'''Edit'''

Select any existing cell and change the labor level or role.

== See also ==

* [[Employee]]

Employee Authorizations

2017-08-22T18:26:10Z

Tami:

[[image:EmployeeAuthorizationsTab.png]]

Enable an employee’s Authorization to make them a user of the software. Define the level of authorization through the combination of labor levels and roles.

'''Main Tab'''

[[image:EmployeeAuthorizationsMainTab.png]]

Authorizations are turned on and off in the Main tab. A Login ID and a Password is required. Only Administrators can enable the Authorizations on employees. Additionally, the pay rates authorization needs to be explicitly set at the user level, even for administrators. A user that administers the software does not necessarily see the pay rates.

[[image:EmployeeAuthorizationsMainTabPage.png]]

Upon checking Enable Authorizations, the Login ID and Password is set to a random eight characters. Change the Login ID to something more familiar to the user and you can choose either to keep the password or to change it. Users can change their own password once they have logged on.

The Role selected in the Main tab will be the Role that applies to all non-employee related authorizations, such as the ability to make changes with the configuration. It is also the Role used when adding labor level authorizations.

If the Default Role is Administrator (Built In), then there is no need to define roles under the Labor Levels tab, because an Administrator sees all employees and has the administrative role on all employees.

'''Labor Levels Tab'''

[[image:EmployeeAuthorizationsLaborLevelsTab.png]]

[[image:EmployeeAuthorizationsLaborLevelsTabPage.png|right|400px]]

The Labor Levels tab is where you assign the non-administrative user access to view and work with employees based on the assigned labor levels combinations. The user will not see any employees until an entry is added. Each entry allows you to specify the Role that the user has when working on employees who match the labor level combination. This allows you to define a different level of authorizations for different employees.

All columns will display a drop down list upon clicking in any cell. The drop down list contains all the labor level entries for that column plus an additional entry of * (Authorization), which is the wildcard. The use of the wildcard implies that all of the labor level selections within that column are included.

'''Add'''

The top row of the grid is where you add entries to the grid. Upon making the labor level selections, press Enter to add the new row.

'''Delete'''

Select a row using the mouse by clicking on the row header. Press Delete on the keyboard to remove the row.

'''Edit'''

Select any existing cell and change the labor level or role.

== See also ==

* [[Employee]]

Employee Miscellaneous

2017-08-22T18:25:48Z

Tami:

[[image:EmployeeMiscellaneousTab.png]]

These are miscellaneous settings that are used in a varying manner. Some of these settings allow the override of one part of pay rule. Settings customized to your company for the handling of special rules may be found here.

[[image:EmployeeMiscellaneousTabPage.png]]

''Payroll ID'' – an alternate ID used by your payroll or another external system. This ID can appear on any report.

''Early In Offsets Early Out Minutes'' – if the employee's pay rule is set to "Use Offset Minutes From Employee Level," then this value will be used instead of the value at the pay rule level. Refer to the [ pay rule configuration] for a description of what this setting does.

''Late Out Offsets Late In Minutes'' – if the employee's pay rule is set to "Use Offset Minutes From Employee Level," then this value will be used instead of the value at the pay rule level. Refer to the [ pay rule configuration] for a description of what this setting does.

''Ignore Shift Cut Off Rule''– if Shift Cut Off is being used in the employee's pay rule, then overrides its use.

''Use Default Shift For Differential Calculations''– uses the default shift instead of the employee’s shift when calculating the differentials.

''No Break Deduction Exceptions'' – if an employee is not expected to punch for breaks or lunches, then this stops the calculation of the Break Deduction exception.

The other settings shown here are examples of custom settings.

== See also ==

* [[Employee]]

Employee Journal

2017-08-22T18:25:21Z

Tami:

[[image:EmployeeJournalTab.png]]

The journal tab provides a place to keep date based notes on an employee.

There is an [[Employee Reports#Employee Journal|Employee Journal]] report that you can filter by employees and date range.

[[image:EmployeeJournalTabPage.png]]

== See also ==

* [[Employee]]

Employee Employment In Service

2017-08-22T18:24:54Z

Tami:

[[image:EmployeeEmploymentInServiceTab.png]]

In services completed by the employee are maintained in the In Service tab.

An employee is assigned to an In Service Group. The In Service Group will typically have some mandatory in services that are required to be completed annually.

The list of In Services displayed will indicate if the in service is mandatory, and if the in service has been completed in the calendar year (based on the date selected). The legend at the bottom of the completed in services shows the colors used to identify the in service status.

An In Service history report for the current calendar year is also available for the current employee.

The In Service reports alert you to employees with incomplete in services.

[[image:EmployeeEmploymentInServiceTabPage.png]]

== See also ==

* [[Employee]]

* [[Employee Employment]]

Employee Employment Licensing

2017-08-22T18:24:38Z

Tami:

[[image:EmployeeEmploymentLicensingTab.png]]

Enter employee primary and secondary license/certification information including the license/certification number, expiration date, verification date and disciplinary action search date in the Licensing tab.

Online lookup of information is available for New York State based certifications and licenses. Select license numbers and expiration dates in the browser window and copy to the clipboard (right click and choose Copy or press Ctrl + C) and then click on the License Number or Expiration Date button and the information will transfer into the software.

The Employment reports alert you to employees with missing or expired licenses.

[[image:EmployeeEmploymentLicensingTabPage.png]]

== See also ==

* [[Employee]]

* [[Employee Employment]]

Employee Employment Health

2017-08-22T18:24:20Z

Tami:

[[image:EmployeeEmploymentHealthTab.png]]

Enter employee physical and vaccination information here. The [[Employment Reports]] alert you to employees with missing or due dates.

The Due dates will automatically update based on the settings in the Health tab configuration.

[[image:EmployeeEmploymentHealthTabPage.png]]

== See also ==

* [[Employee]]

* [[Employee Employment]]

Employee Employment I-9 Documents

2017-08-22T18:23:55Z

Tami:

[[image:EmployeeEmploymentI-9DocumentsTab.png]]

Maintain List A or List B / List C documents in the I-9 Documents tab.

The Employment reports alert you to employees with missing documents, and missing or due dates.

[[image:EmployeeEmploymentI-9DocumentsTabPage.png]]

== See also ==

* [[Employee]]

* [[Employee Employment]]

Employee Employment General

2017-08-22T18:23:30Z

Tami:

[[image:EmployeeEmploymentGeneralTab.png]]

General employment information such as SSN and Gender is maintained in the General tab. If an employee is paid their birthday automatically, then maintain their Birth Date in this tab.

[[image:EmployeeEmploymentGeneralTabPage.png]]

== See also ==

* [[Employee]]

* [[Employee Employment]]

Employee Contact Info

2017-08-22T18:23:04Z

Tami:

[[image:EmployeeContactInfoTab.png]]

The Contact Info tab allows you to keep address and contact information such as phone numbers and email addresses, including the employee’s emergency contact information.

[[image:EmployeeContactInfoTabPage.png]]

== See also ==

* [[Employee]]

Employee Contact Info

2017-08-22T18:22:54Z

Tami:

Employee Scheduling

2017-08-22T18:22:25Z

Tami: /* Other */

[[image:EmployeeSchedulingTab.png]]

Enter the employee’s schedule patterns and planned absences in the Scheduling tab.

==Schedule Patterns==

[[image:EmployeeSchedulingSchedulePatternsTab.png]]

The schedule pattern, sometimes referred to as the employee’s master schedule, defines when and where an employee works on a regular basis. The schedule pattern allows you to set what days the employee works and what shifts they are working. Additionally, all labor levels defined as being "scheduling" levels are required, for example, the floor that the employee is working on.

[[image:EmployeeSchedulingSchedulePatternsTabPage.png]]

The employee's home labor levels are used when you add a schedule pattern. Change the employee's labor level(s) by clicking on the labor levels button (to the left of the Delete All button). Changes made to the home labor levels can be applied to all schedule patterns.

Define a multi-week pattern if the schedule pattern varies from week to week. Set the Schedule Pattern Weeks to the required number of weeks.

==Planned Absences ==

[[image:EmployeeSchedulingPlannedAbsencesTab.png]]

Enter planned days off like vacation or leave of absences in the Planned Absences tab. This eliminates the need to make manual changes to the schedules after they are created through the [[Build Schedules]] process.

Unapproved planned absences can be entered as a record of the request, but will not have any effect on the schedules.

[[image:EmployeeSchedulingPlannedAbsencesTabPage.png]]

==Other==

[[image:EmployeeSchedulingOtherTab.png]]

Miscellaneous information about the employee that is used on reports.

The Planned Absence Group provides the ability to enter global planned absences.

[[image:EmployeeSchedulingOtherTabPage.png]]

== See also ==

* [[Employee]]

Employee Scheduling

2017-08-22T18:17:21Z

Tami:

[[image:EmployeeSchedulingTab.png]]

Enter the employee’s schedule patterns and planned absences in the Scheduling tab.

==Schedule Patterns==

[[image:EmployeeSchedulingSchedulePatternsTab.png]]

The schedule pattern, sometimes referred to as the employee’s master schedule, defines when and where an employee works on a regular basis. The schedule pattern allows you to set what days the employee works and what shifts they are working. Additionally, all labor levels defined as being "scheduling" levels are required, for example, the floor that the employee is working on.

[[image:EmployeeSchedulingSchedulePatternsTabPage.png]]

The employee's home labor levels are used when you add a schedule pattern. Change the employee's labor level(s) by clicking on the labor levels button (to the left of the Delete All button). Changes made to the home labor levels can be applied to all schedule patterns.

Define a multi-week pattern if the schedule pattern varies from week to week. Set the Schedule Pattern Weeks to the required number of weeks.

==Planned Absences ==

[[image:EmployeeSchedulingPlannedAbsencesTab.png]]

Enter planned days off like vacation or leave of absences in the Planned Absences tab. This eliminates the need to make manual changes to the schedules after they are created through the [[Build Schedules]] process.

Unapproved planned absences can be entered as a record of the request, but will not have any effect on the schedules.

[[image:EmployeeSchedulingPlannedAbsencesTabPage.png]]

==Other==

[[image:EmployeeSchedulingOtherTabPage.png|right|250px]]

[[image:EmployeeSchedulingOtherTab.png]]

Miscellaneous information about the employee that is used on reports.

The Planned Absence Group provides the ability to enter global planned absences.

== See also ==

* [[Employee]]

Employee Scheduling

2017-08-22T18:16:26Z

Tami:

[[image:EmployeeSchedulingTab.png]]

Enter the employee’s schedule patterns and planned absences in the Scheduling tab.

==Schedule Patterns==

[[image:EmployeeSchedulingSchedulePatternsTab.png]]

[[image:EmployeeSchedulingSchedulePatternsTabPage.png]]

The schedule pattern, sometimes referred to as the employee’s master schedule, defines when and where an employee works on a regular basis. The schedule pattern allows you to set what days the employee works and what shifts they are working. Additionally, all labor levels defined as being "scheduling" levels are required, for example, the floor that the employee is working on.

The employee's home labor levels are used when you add a schedule pattern. Change the employee's labor level(s) by clicking on the labor levels button (to the left of the Delete All button). Changes made to the home labor levels can be applied to all schedule patterns.

Define a multi-week pattern if the schedule pattern varies from week to week. Set the Schedule Pattern Weeks to the required number of weeks.

==Planned Absences ==

[[image:EmployeeSchedulingPlannedAbsencesTabPage.png|right|200px]]

[[image:EmployeeSchedulingPlannedAbsencesTab.png]]

Enter planned days off like vacation or leave of absences in the Planned Absences tab. This eliminates the need to make manual changes to the schedules after they are created through the [[Build Schedules]] process.

Unapproved planned absences can be entered as a record of the request, but will not have any effect on the schedules.

==Other==

[[image:EmployeeSchedulingOtherTabPage.png|right|250px]]

[[image:EmployeeSchedulingOtherTab.png]]

Miscellaneous information about the employee that is used on reports.

The Planned Absence Group provides the ability to enter global planned absences.

== See also ==

* [[Employee]]

Employee Work Pattern

2017-08-22T18:14:40Z

Tami:

[[image:EmployeeWorkPatternTab.png]]

The Work Pattern tab contains information about the frequency and length of the employee’s workday, and how the employee’s schedules creation is controlled.

[[image:EmployeeWorkPatternTabPage.png]]

===Employee Shift History===

The Shifts table contains the shift count, daily hours, shift assignment and the date that this shift information started. This allows you to keep a history of the employee, for example, as they change from an on call to a part time, to a full time employee.

''Shift Count'' – the number of shifts an employee generally works in a pay period. The shift count is used in calculations based on being on call, part time or full time.

''Daily Hours'' – the number of hours an employee works in a regular day. The daily hours is used for calculations based on the length of their day.

''Shift'' – the employee's primary shift. When a holiday is calculated automatically, it will use this shift for the hours.

''Add To Shift History / Delete From Shift History ''– to encourage the maintenance of shift information, you can only add a new entry or delete an existing entry. You cannot edit an existing entry.

===Employee Work Pattern===

The employee’s work pattern determines the level of control for the employee schedule creation.

''Work Pattern Type'' – the work pattern determines how the employee's schedules are created, and what the schedule status for the schedules is. Each work pattern type enforces a different level of schedule control.

'''Not specified''' – the employee's schedules generate automatically with the schedule status determined directly from the base schedule.

'''One Shift''' – the employee's schedules generate automatically. Schedules that match the employee's shift information are considered "Scheduled" while all other schedules considered "Unscheduled."

'''Multi Shift''' – the employee's schedules generate automatically. Schedules that match the employee's schedule pattern are considered "Scheduled" while all other schedules considered "Unscheduled."

'''Soft Scheduler''' – the employee's schedules are not generated automatically, but created as part of the scheduling process. All schedules are considered "Scheduled," however, for calculation purposes "ghost" schedules are created when the employee works and does not have a corresponding schedule, so that hours are calculated.

'''Scheduler '''– the employee's schedules are only generated as part of the scheduling process. All schedules are considered "Scheduled." An employee needs a schedule for hours calculation.

'''Scheduler (Restricted)''' – same as Scheduler, but with schedule based restrictions at the HandPunch (HP4000 only).

== See also ==

* [[Employee]]

Employee Pay Rates

2017-08-22T18:08:48Z

Tami:

[[image:EmployeePayRatesTab.png]]

Maintain an employee's pay rate information such as starting date and rate in the Pay Rates tab. The department defaults to the employee's current department. If employees are working across departments, then specify the rates for each worked department. An "override" rate is also available to specify an alternate rate used, for example, at weekends.

[[image:EmployeePayRatesTabPage.png]]

Select the starting date and the pay rate and click on the Add To Pay Rates button. To remove a pay rate, select the row in the pay rates table and click on the Delete From Pay Rates button or press the Delete key.

There is no ability to edit a pay rate to encourage the maintenance of pay rate history.

== See also ==

* [[Employee]]

Employee History

2017-08-22T18:07:09Z

Tami:

[[image:EmployeeHistoryTab.png]]

The History tab displays the employee’s historical pay rule, base schedule group, holiday group, accrual group, and labor level changes.

[[image:EmployeeHistoryTabPage.png]]

Changes made in the [[Employee Main|Main]] tab to the pay rule, base schedule group, holiday group, accrual group, and labor levels will automatically create an entry in the History. You can make the identical changes in this screen if you find it more convenient.

== See also ==

* [[Employee]]

Employee Main

2017-08-22T18:05:31Z

Tami:

[[image:EmployeeMainTab.png]]

The Main tab contains the employee information needed to identify an employee and to ensure that the calculations will be correct.

[[image:EmployeeMainTabPage.png]]

''Employee ID'' – this is generally the ID used in your payroll system. All employees must have a unique ID. A popup screen appears when you edit this field, and you cannot leave the popup screen until the ID is validated.

''First Name, Middle Name, Last Name'' – these are editable fields for entering the employee’s full name.

''Tag'' – a field to further identify or "tag" the employee, (useful when you have two employees with the same name).

''Full Name'' – a display only field that displays the first name, initial, last name and tag fields, and is not editable.

''Labor Levels'' – the employee's placement within each labor level defined in the software.

''Pay Rule'' – a drop down list of pay rules. The pay rule determines the employee’s pay period, their rounding rules and how to calculate punches in relation to their schedule.

''Base Schedule'' – a drop down list of base schedule groups. The base schedules include the start and end times, the break and lunch rules and the pay types to pay.

''Holiday Group'' – a drop down list of holiday groups. The holiday group contains the list of holidays paid to the employee.

''Accrual Group'' – a drop down list of accrual groups. The accrual group determines the number of hours that the employee accumulates based on the rules of that group.

''Status'' – the employee’s current status. This is determined from the [[Employee Status|employee status history]].

== See also ==

* [[Employee]]

Employee Main

2017-08-22T18:04:11Z

Tami:

[[image:EmployeeMainTab.png]]

The Main tab contains the employee information needed to identify an employee and to ensure that the calculations will be correct.

[[image:EmployeeMainTabPage.png]]

''Employee ID'' – this is generally the ID used in your payroll system. All employees must have a unique ID. A popup screen appears when you edit this field, and you cannot leave the popup screen until the ID is validated.

''First Name, Middle Name, Last Name'' – these are editable fields for entering the employee’s full name.

''Tag'' – this is an additional field to further identify or "tag" the employee, (useful when you have two employees with the same name).

''Full Name'' – this is a display only field that displays the first name, initial, last name and tag fields, and is not editable.

''Labor Levels'' – the employee's placement within each labor level defined in the software.

''Pay Rule'' – a drop down list of pay rules. The pay rule determines the employee’s pay period, their rounding rules and how to calculate punches in relation to their schedule.

''Base Schedule'' – a drop down list of base schedule groups. The base schedules include the start and end times, the break and lunch rules and the pay types to pay.

''Holiday Group'' – a drop down list of holiday groups. The holiday group contains the list of holidays paid to the employee.

''Accrual Group'' – a drop down list of accrual groups. The accrual group determines the number of hours that the employee accumulates based on the rules of that group.

''Status'' – the employee’s current status. This is determined from the [[Employee Status|employee status history]].

== See also ==

* [[Employee]]

Employee Main

2017-08-22T18:03:53Z

Tami:

[[image:EmployeeMainTab.png]]

The Main tab contains the employee information needed to identify an employee and to ensure that the calculations will be correct.

[[image:EmployeeMainTabPage.png]]

''Employee ID'' – this is generally the ID used in your payroll system. All employees must have a unique ID. A popup screen appears when you edit this field, and you cannot leave the popup screen until the ID is validated.

''First Name, Initial, Last Name'' – these are editable fields for entering the employee’s full name.

''Tag'' – this is an additional field to further identify or "tag" the employee, (useful when you have two employees with the same name).

''Full Name'' – this is a display only field that displays the first name, initial, last name and tag fields, and is not editable.

''Labor Levels'' – the employee's placement within each labor level defined in the software.

''Pay Rule'' – a drop down list of pay rules. The pay rule determines the employee’s pay period, their rounding rules and how to calculate punches in relation to their schedule.

''Base Schedule'' – a drop down list of base schedule groups. The base schedules include the start and end times, the break and lunch rules and the pay types to pay.

''Holiday Group'' – a drop down list of holiday groups. The holiday group contains the list of holidays paid to the employee.

''Accrual Group'' – a drop down list of accrual groups. The accrual group determines the number of hours that the employee accumulates based on the rules of that group.

''Status'' – the employee’s current status. This is determined from the [[Employee Status|employee status history]].

== See also ==

* [[Employee]]

Employee

2017-08-22T18:03:21Z

Tami:

Select the employee from the employee list and click on the Employee tab to display an employee's information.

[[image:EmployeesTab.png]]

The employee information is organized into tabs.

[[image:EmployeeTab.png]]

* [[Employee Main|Main]] – contains the information necessary to calculate an employee’s time which includes their pay rule, base schedule, holiday group and accrual group

* [[Employee Clock Info|Clock Info]] – the clock ID and clock assignment to match an employee with a user at the time clock

* [[Employee Status|Status]] – contains employment (hires / terminations) history

* [[Employee History|History]] – maintain historical information on employee’s labor levels, pay rule, base schedule, holiday, and accrual settings

* [[Employee Pay Rates|Pay Rates]] – maintain historical gross pay rate information on the employee.

* [[Employee Work Pattern|Work Pattern]] – information about the frequency and length of an employee’s regularly worked days and shifts

* [[Employee Scheduling|Scheduling]] – information about the employee’s master schedule, and planned absences

* [[Employee Contact Info|Contact Info]] – address, phone numbers, and emergency contact information

* [[Employee Employment|Employment]] – human resource information, such as I-9, health, licensing and in services

* [[Employee Journal|Journal]] – maintain date based notes on an employee

* [[Employee Miscellaneous|Misc.]] – miscellaneous information that does not apply to the other tabs

* [[Employee Authorizations|Authorizations]] – control what an employee can do within the software, from no access to full administrative access

* [[Employee Custom|Custom Tabs]] – additional tabs displayed that are custom to your software installation

[[image:EmployeeTimeCardsTab.png]]

* [[Employee Time Cards|Time Cards]]

[[image:EmployeeSchedulesTab.png]]

* [[Employee Schedules|Schedules]]

[[image:EmployeeAccrualsTab.png]]

* [[Employee Accruals|Accruals]]

==Red Tabs==

Employee tabs that are in red are locked and their information cannot be changed, only viewed. This happens when another software user was on the employee before you and only they are able to edit the employee. You can hover with your mouse on the red tab to see which user is locking the employee, and you can ask that user to click off from the employee, allowing to unlock it. If that other user is not currently on the employee but it still appears locked, you can force the software to release the lock with the Time and Attendance button (top-left corner). Please note that forcing the software to release the lock when another user is in the middle of editing the employee, might damage the information on that employee. Only release locks when you are sure that the user who is locking it is not in the middle of editing.

== See also ==

* [[Software|Using the Time and Attendance software]]

* [[Employees]]

* [[Reports]]

* [[Scheduler]]

* [[Tools]]

* [[Import]]

* [[Configuration]]

Employee Status

2017-08-22T17:46:29Z

Tami:

[[image:EmployeeStatusTab.png]]

The status information maintained here determines the employee's current status as displayed on the Main tab. The current status is highlighted in yellow. The software comes with Active and Inactive as the built-in status types. Additional status types can be added, e.g. LOA.

[[image:EmployeeStatusTabPage.png]]

* An employee with no status entries is considered Active but the software does not know the Hire Date, e.g. for seniority purposes.

* Only changes in the employee's status should be entered. For example, an employee changing from a part timer to a full timer is NOT a status change. Previously entered statuses cannot be edited to encourage the maintenance of employee status history. The Is Hire Date is the only edit available on an existing status entry.

* The software has a setting to determine if the first or last Active status entry should be considered the Hire Date. The default settings is that the latest Active status entry is used as the Hire Date.

* Adding an Inactive status entry will not make the employee's current status immediately inactive. The general rule is that an employee becomes Inactive once the pay period they became inactive in is prior to the previous pay period.

== See also ==

* [[Employee]]

Employee Main

2017-08-22T17:42:17Z

Tami:

[[image:EmployeeMainTabPage.png|right|300px]]

[[image:EmployeeMainTab.png]]

The Main tab contains the Employee information needed to identify an Employee and to ensure that the calculations will be correct.

''Employee ID'' – this is generally the ID used in your payroll system. All employees must have a unique ID. A popup screen appears when you edit this field, and you cannot leave the popup screen until the ID is validated.

''First Name, Initial, Last Name'' – these are editable fields for entering the employee’s full name.

''Tag'' – this is an additional field to further identify or "tag" the employee, (useful when you have two employees with the same name).

''Full Name'' – this is a display only field that displays the first name, initial, last name and tag fields, and is not editable.

''Labor Levels'' – the employee's placement within each labor level defined in the software.

''Pay Rule'' – a drop down list of pay rules. The pay rule determines the employee’s pay period, their rounding rules and how to calculate punches in relation to their schedule.

''Base Schedule'' – a drop down list of base schedule groups. The base schedules include the start and end times, the break and lunch rules and the pay types to pay.

''Holiday Group'' – a drop down list of holiday groups. The holiday group contains the list of holidays paid to the employee.

''Accrual Group'' – a drop down list of accrual groups. The accrual group determines the number of hours that the employee accumulates based on the rules of that group.

''Status'' – the employee’s current status. This is determined from the [[employee status history]].

== See also ==

* [[Employee]]

Employee Main

2017-08-22T17:42:00Z

Tami:

[[image:EmployeeMainTabPage.png|right|300px]]

[[image:EmployeeMainTab.png]]

The Main tab contains the Employee information needed to identify an Employee and to ensure that the calculations will be correct.

''Employee ID'' – this is generally the ID used in your payroll system. All employees must have a unique ID. A popup screen appears when you edit this field, and you cannot leave the popup screen until the ID is validated.

''First Name, Initial, Last Name'' – these are editable fields for entering the employee’s full name.

''Tag'' – this is an additional field to further identify or "tag" the employee, (useful when you have two employees with the same name).

''Full Name'' – this is a display only field that displays the first name, initial, last name and tag fields, and is not editable.

''Labor Levels'' – the employee's placement within each labor level defined in the software.

''Pay Rule'' – a drop down list of pay rules. The pay rule determines the employee’s pay period, their rounding rules and how to calculate punches in relation to their schedule.

''Base Schedule'' – a drop down list of base schedule groups. The base schedules include the start and end times, the break and lunch rules and the pay types to pay.

''Holiday Group'' – a drop down list of holiday groups. The holiday group contains the list of holidays paid to the employee.

''Accrual Group'' – a drop down list of accrual groups. The accrual group determines the number of hours that the employee accumulates based on the rules of that group.

''Status'' – the employee’s current status. This is determined from the [employee status history].

== See also ==

* [[Employee]]

Employee

2017-08-22T17:35:35Z

Tami: /* Red Tabs (Locked) */

Select the employee from the employee list and click on the Employee tab to display an employee's information.

[[image:EmployeesTab.png]]

The employee information is further organized into tabs.

[[image:EmployeeTab.png]]

* [[Employee Main|Main]] – contains the information necessary to calculate an employee’s time which includes their pay rule, base schedule, holiday group and accrual group

* [[Employee Clock Info|Clock Info]] – the clock ID and clock assignment to match an employee with a user at the time clock

* [[Employee Status|Status]] – contains employment (hires / terminations) history

* [[Employee History|History]] – maintain historical information on employee’s labor levels, pay rule, base schedule, holiday, and accrual settings

* [[Employee Pay Rates|Pay Rates]] – maintain historical gross pay rate information on the employee.

* [[Employee Work Pattern|Work Pattern]] – information about the frequency and length of an employee’s regularly worked days and shifts

* [[Employee Scheduling|Scheduling]] – information about the employee’s master schedule, and planned absences

* [[Employee Contact Info|Contact Info]] – address, phone numbers, and emergency contact information

* [[Employee Employment|Employment]] – human resource information, such as I-9, health, licensing and in services

* [[Employee Journal|Journal]] – maintain date based notes on an employee

* [[Employee Miscellaneous|Misc.]] – miscellaneous information that does not apply to the other tabs

* [[Employee Authorizations|Authorizations]] – control what an employee can do within the software, from no access to full administrative access

* [[Employee Custom|Custom Tabs]] – additional tabs displayed that are custom to your software installation

[[image:EmployeeTimeCardsTab.png]]

* [[Employee Time Cards|Time Cards]]

[[image:EmployeeSchedulesTab.png]]

* [[Employee Schedules|Schedules]]

[[image:EmployeeAccrualsTab.png]]

* [[Employee Accruals|Accruals]]

==Red Tabs==

Employee tabs that are in red are locked and can only be viewed. This happens when another software user was on the employee before you. Only that first user is able to edit the employee. You can hover with your mouse on the red tab to see which user is locking the employee. You can ask that user to click off from the employee so as to unlock it. If that other user is not currently on the employee but it still appears locked, you can force the software to release the lock with the Time and Attendance button (top-left corner). Please note that forcing the software to release the lock when another user is in the middle of editing the employee, might damage the information on that employee. Only release locks when you are sure that the user who is locking it is not in the middle of editing.

== See also ==

* [[Software|Using the Time and Attendance software]]

* [[Employees]]

* [[Reports]]

* [[Scheduler]]

* [[Tools]]

* [[Import]]

* [[Configuration]]

Schedule Status Types Configuration

2017-08-16T19:38:44Z

Tami:

{{Advanced}}

Schedule status types allow you to modify or add statuses that are used in the base schedules, the employee's schedules and the employee placeholders.

== Main ==

[[File:MainStatusTypes.png]]

''Schedule Status Type ID'' – the identifier for this schedule status type

''Display At Base Schedule Configuration Level'' – this schedule status type will be available in the base schedule screens.

''Display At Employee Schedule Level'' – this schedule status type will be available in the schedule screens.

''Display At Planned Absence Level'' – this schedule status type will be available in the planned absence screens for use in the placeholders, e.g. Vacation

''Display At Scheduler Level'' – this status will be available to select when adding a placeholder in the Scheduler, e.g. Sick

== Calculation ==

[[File:STCalculation.png]]

''Considered Scheduled'' – generally used to mark schedules that should be worked.

''Default Scheduled'' –the status regarded by the software as the default scheduled status type.

''Default Unscheduled'' –the status regarded by the software as the default unscheduled status type.

''Default Schedule Status Type'' – when the schedule status type is not specified, then it is assumed that this is the schedule status type to use.

''Update Status From Work Pattern'' – if the base schedule status has this set, then the schedule status will be updated to the default scheduled status, when using the One Shift work pattern type

''Exception If No Hours'' – if the punches are not calculating any hours, then an exception can be generated.

''Exception If No Punches'' – if the schedule has not been used for calculating by one or more punches, then the schedule will generate a Schedule Without Punches (SWP) exception.

''Exception If Hours'' – if this is the schedule status type for the schedule used for calculating, then a Punches Without Schedules exception is generated. This would generally be used to flag hours earned in an unscheduled shift when using the One Shift work pattern type.

''Do Not Calculate Hours'' – will stop the calculation of hours for this schedule status type.

''Pay Holiday'' – holidays are only ever paid if the employee's schedule is using a schedule status type that is marked as Pay Holiday.

== Scheduler ==

[[File:STScheduler.png]]

''Display In Scheduler'' – show this schedule status type in the Scheduler.

''Display In Daily'' – show this schedule status type in the daily staffing reports.

''Display Text'' – the text that displays in the Scheduler.

''Text Display Type'' – what to display as the text.

''Text Color Display Type'' – the color of the text displayed in the scheduler window.

''Text Color'' – a color picker when Specific is selected in Text Color Display Type.

''Cell Color Display Type'' – the background color of the cell in the scheduler window.

''Cell Color'' – a color picker when Specific is selected in Cell Color Display Type

== Other Hours ==

[[File:STOtherHours.png]]

''Payable With Other Hours'' – this schedule status type when used in a placeholder is eligible for possible payment of other hours, e.g. Sick is paid with Sick hours.

''Pay Type'' – the default pay type to use as the pay type for the other hours.

== Misc. ==

[[File:STMisc.png]]

== See also ==

* [[Configuration]]

Pay Types Configuration

2017-08-16T19:38:13Z

Tami:

{{Advanced}}

==Pay Types==

[[File:MainPayTypes.png]]

Pay types configuration is where you setup the pay types and create the associations with your payroll or HR system pay codes.

'''Main'''

''Pay Type ID'' – the unique identifier for this pay type. This may be the same that is used in your payroll system.

''Description'' – a longer text based description of the pay type.

''Default Pay Type'' – if no pay type is specified, then this pay type is assumed to be the one to use.

''Pay Type Sort Order'' – the order this pay type appears on screen and in reports.

''Adds To Totals'' – this pay type's hours will be accumulated into any totals.

''Schedule Auto Punch'' – if a pay type is specified as a Schedule Auto Punch type, then any schedule that uses this pay type will generate an In and Out punch using the schedule start and end times.

'''Overtime'''

[[File:PayOvertime.png]]

''Allocation Order'' – the order in which pay types become daily, period or consecutive overtime. Pay types with lower allocation order become overtime before those with higher allocation. Pay types with an allocation order of 9 will count towards overtime, but will never become overtime.

Count Towards – if certain types of hours (punches, other hours worked, other hours unworked, and premium hours) can contribute towards the calculation of overtime (daily, period or consecutive), then select the correct combination of hours type and overtime.

'''Premium'''

[[File:PayPremium.png]]

''Allocate to Premium'' – if hours are needed to move to premium, then they will be taken from pay types that have this setting. Allocation Order - see above.

''Punches Count Towards Premium'' – punches that calculate hours with this pay type will be considered for premium calculation.

''Other Hours Count Towards Premium'' – other hours added using this pay type will be considered for premium calculation.

''Premium Counts Towards Premium'' – calculated premium hours of this pay type will be considered for further premium calculation.

'''Holiday Overtime'''

[[File:PayHolidayOvertime.png]]

'''Lookups'''

[[File:PayLookups.png]]

The pay type to use for calculation of overtime and premium rules does not always use the same pay type. Some rules require that the pay type of the hours causing overtime or premium to calculate, should affect the pay type that is used for the calculation of these overtime or premium hours.

For example, if you wish to calculate shift differential for regular hours worked but pay overtime shift differential for overtime hours worked, then the use of a lookup is required. You would add a lookup to both Regular and Overtime, using the same Lookup Number, and specifying Shift Differential as the Lookup Pay Type on Regular, and specifying Overtime Shift Differential as the Lookup Pay Type on Overtime. The Lookup Number used in both the Regular and Overtime pay types would be used in the Overtime or Premium rules as the Pay Type Lookup number.

'''Accruals'''

[[File:PayAccruals.png]]

'''Tags'''

[[File:PayTags.png]]

'''Rates and Payroll'''

[[File:PayRatesAndPayroll.png]]

''Rate Multiplier'' – the multiplier used when calculating hours X rate.

''Fixed Rate'' – allows the same rate to be used for all employees for this pay type.

''Payroll Pay Code'' – the code as used in your payroll system. This is required if you are using a payroll interface.

''Payroll Sort Order'' – when the payroll code is displayed in the software, it will be displayed in this order.

''Add To Totals'' – this pay type's hours will be accumulated into any payroll based totals.

'''Attendance Calendar'''

[[File:PayAttendanceCalendar.png]]

''Display In Attendance Calendar'' – this allows this type to appear in the Attendance Calendar report.

''Attendance Calendar ID'' – the text that will appear in the Attendance Calendar report. Keep this as short as possible.

== See also ==

* [[Configuration]]

Breaks Configuration

2017-08-16T19:37:41Z

Tami:

{{Advanced}}

===Breaks===

The breaks are comprised of a break group containing break rules. The break rules can be assigned to multiple break groups. Breaks represent both breaks and lunches, paid or unpaid, punched or unpunched.

Break rules are applied to a punched break, if it matches the rules of when the break should be taken..

== Break Groups ==

[[File:BreakGroups1.png]]

''Break Group ID'' – an identifier clearly identifies the break group. This is seen in the Break drop-down in the base schedule and employee schedule.

When a Break Group is selected, the Breaks assigned to this group are checked.

== Breaks ==

[[File:Breaks1.png]]

'''Main'''

''Break ID'' – an identifier for the specific break rule, e.g. 60 Minute Lunch

''Break Type'' – if using paid and unpaid breaks (break and lunch) in one break group.

''Break Minutes'' – the length of the break. If the break rule is not satisfied through punching, then this is the number of minutes that will be deducted.

''Pay Back Break Deduction / Pay Back Pay Type'' – the break minutes deducted are paid back using another pay type, e.g. Paid Lunch, which does not count towards overtime.

''Paid Break Minutes'' – this number of minutes is paid back to the employee. When an employee is punched out, they will be reimbursed up to this number of minutes, but they will not be paid back time they did not take, e.g. a 15 minute paid break on a 10 minute punched break will calculate as if the employee did not punch out at all. It will NOT give the employee 5 minutes extra time.

''Rounding Unit'' – the unit to round the punched break to.

''Break Point'' – the point at which the punches break will move forward. For example, if the Rounding Unit is 15 and the Break Point is 8, then a 37 minute break is rounded to 30 minutes, while a 38 minute break is rounded to 45 minutes.

''Minimum Break Pair Minutes'' – the break must be at least this number of minutes in length to be considered for this rule

'''Break Window'''

[[File:BreakWindow.png]]

''Break Window Type'' – this allows qualification of the break by requiring that the break be taken within a designated time window.

* No Window – the break window rule is not used.
* Offset From In Punch – the break window starts at the first punch plus the Minimum Offset Minutes, and ends at the last punch plus the Maximum Offset Minutes.
* Offset From Schedule Start – the break window starts at the schedule start time plus the Minimum Offset Minutes, and ends at the schedule start time plus the Maximum Offset Minutes.
* Time Window – the break must occur in the time window specified in Time Window Start and Time Window End.

''Minimum Offset Minutes'' – see Break Window Type.

''Maximum Offset Minutes'' – see Break Window Type.

''Time Window Start'' – see Break Window Type.

''Time Window End'' – see Break Window Type.

'''Applies To'''

[[File:BreakAppliesTo.png]]

''Minimum / Maximum Employee Shift Count'' – the break only applies to employees based on their employee shift history shift count value.

''Minimum / Maximum Employee Daily Hours'' – the break only applies to employees based on their employee shift history daily hours value.

'''Home Labor Levels'''

[[File:BreakHomeLaborlevels.png]]

'''Qualifiers'''

[[File:BreakQualifiers.png]]

''Minimum Break Pair Minutes'' – the break length must be equal to or exceed this number of minutes to be considered for this break rule.

''Maximum Break Pair Minutes'' – the break length cannot exceed this number of minutes to be considered for this rule.

''Minimum Worked Minutes'' – the employee has to have worked this number of minutes to be considered for this break.

''Maximum Worked Minutes'' – the employees cannot have exceeded this number of minutes to be considered for this break.

'''Calculation'''

[[File:BreakCalculation.png]]

''Start Deducting At Minutes'' – the point at which an unpunched break starts to deduct.

''Short Break Grace Minutes'' – this will only apply if the employee takes a break that is less than the Break Minutes setting. For example, if the Break Minutes setting is 30, and the Short Break Grace Minutes is 5, then a break that is from 25 to 29 minutes in length is calculated as if it was 30 minutes in length.

''Long Break Grace Minutes'' – this will only apply if the employee takes a break that is greater than the Break Minutes setting. For example, if the Break Minutes setting is 30, and the Long Break Grace Minutes is 5, then a break that is from 31 to 35 minutes in length is calculated as if it was 30 minutes in length.

''Short Break Grace Exception Minutes'' – if the break minutes taken are less than the Break Minutes, and greater than or equal to the Break Minutes minus the Short Break Grace Minutes setting, then the break will not generate a Short Break (SB) exception.

''Long Break Grace Exception Minutes'' – if the break minutes taken are greater than the Break Minutes, and less than or equal to the Break Minutes plus the Long Break Grace Minutes setting, then the break will not generate a Long Break (LB) exception.

== See also ==

* [[Configuration]]

Premiums Configuration

2017-08-16T19:37:01Z

Tami:

{{Advanced}}

Use Premiums as part of the pay rules to pay hours using a different pay code, give additional hours such as bonuses and guarantees, or cap hours based on maximum allowable hours.

== Main ==

[[File:Premiums.png]]

''Premium ID'' – an identifier for the premium rule.

''Premium Type''

* None – does not calculate any premium.
* Consecutive Shift – pays the premium when consecutive shifts are worked.
* Daily Bonus –adds additional hours for the day.
* Daily Guarantee – adds hours so as to increase the daily total to the guaranteed amount.
* Daily Hours Averager – treats all scheduled days as contributing evenly to the hours for the pay period. This rule is used to allow employees to leave early one day for religious observance, while making up the time on other days in the week.
* Daily Maximum – caps the total hours for the day.
* Differential – pays hours based on working in a differential zone.
* Negative Differential – deducts hours worked in a differential zone.
* Pay Period Maximum – caps the total hours for the pay period.
* Premium Period Maximum – caps the total hours for the premium period. Use this if you need a weekly maximum when the employee has a bi-weekly pay period.
* Schedule Bonus –adds additional hours per schedule.
* Schedule Guarantee – adds hours so as to increase the schedule total to the guaranteed amount.
* Schedule Maximum – caps the total hours for the schedule.

Note: as there can be more than one schedule for the pay date, the daily based premiums use the premiums associated with the employee's pay rule, while the schedule based premiums use the pay rule associated with the schedule.

== Applies To ==

[[File:AppliesTo.png]]

Applies To represents filtering of the premium based on criteria that is already known when configuring the premium.

''Applies To Days Of Week'' – is only used if you specify at least one day of the week. This is the easiest way to setup a premium rule for specific days of the week.

''Minimum/Maximum Employee Shift Count'' – the employee’s shift count must be between the minimum and maximum settings, e.g. differential applies to full time employees only.

''Employee Shifts'' –the shift designation from the employee’s shift history must match one of the selected shifts, e.g. only day employees get a bonus.

''Schedule Shifts'' – the premium applies only to worked schedules with this shift designation, e.g. differential is paid on evening and night schedules.

''Pay Types'' –the premium only applies to the selected pay types.

''Worked Hours Type'' –the premium applies only to hours designated as worked.

''Unworked Hours Type'' – the premium applies only to hours designated as unworked.

== Qualifiers ==

[[File:Qualifiers.png]]

Qualifiers use worked information to determine if the premium will be used.

''Minimum / Maximum Worked Hours'' – if the employee works within the minimum and maximum hours, the premium will apply. The total hours is based off the premium type. E.g. a schedule based rule uses hours calculated from one schedule, while a daily type rules uses total hours for the complete day.

''Minimum / Maximum Punch Count'' – this is the punch count for the pay date, e.g. the employee is guaranteed 8 hours if they punch twice.

''Required Worked Days Of Week'' – the employee must work each day of the week that is selected.

''Minimum / Maximum Shits Worked In Pay Period'' – the employee must work a certain number of shifts within the pay period for this premium to apply.

''Worked Labor Levels'' – the employee must work in the selected labor levels for this premium to apply.

== Worked Labor Levels ==

[[File:WorkedLaborLevels.png]]

== Differential ==

[[File:Differential.png]]

''Zone Type''

* Schedule Shifts – hours worked in the shifts selected from Schedule Shifts in the Applies To will be paid differential. This allows for a dynamic time window based on the schedule start and end times, rather than a fixed time window.
* Time Window – the differential zone occurs in a fixed time window. Any hours that calculate in this zone are paid differential.
* Time Window and Schedule Shifts – the hours worked need to satisfy both of the above rules, e.g. evening schedules after 3pm get differential. This prevents a day schedule that ends at 4pm from getting any differential, and does not pay the one hour of differential on an evening schedule that starts at 2pm.
* Zone Start / Zone End – used with the zone type of Time Window. Specify the start and end of the differential zone, in relation to the pay date.

== Premium Paid ==

[[File:PremiumPaid.png]]

''Pay Type'' – the pay type to use for the calculation of the premium hours.

* Fixed Pay Type – select this if the pay type remains constant regardless of the pay type causing the premium to calculate, and select the pay type.

* Pay Type Lookup – If the pay type for paying the premium changes based on the pay type of the hours causing the premium to calculate, then you need to use a pay type lookup. Pay Type Lookups are set inthe [[Pay Type Configuration|pay type configuration]]. The pay type you want to pay for the premium is set on the pay type that is causing the premium to calculate. The lookup number that you specify on the pay type is what you enter here.

* Scheduled Pay Type – pay type used in the schedule will be used to calculate the premium.

* Pay Rate 2, 3, 4 - the premium will affect what pay rate number is used for calculating the employee's hours.

* Move Hours to Shift – the pay type remains unchanged, but the hours are paid in this shift.

* Pay Date to Actual Date Offset - used with Move Hours to Shift above, this allows you to pay the premium on the shift from the day before or day after.

''Hours'' – the number of hours that the premium uses for calculation. This is used for bonuses, guarantees and maximums.

* Fixed Hours – the hours amount remains constant using the number you set here.

* Scheduled Hours – the hours amount is taken from the Scheduled Hours field in the employee's schedule.

* Daily Hours – the hours amount is taken from the employee’s shift history.

* Worked Shift Count x Fixed Hours – the hours amount is the number of worked shifts multiplied by the Fixed Hours amount entered above.

* Worked Shift Count x Daily Hours – the hours amount is the number of worked shifts multiplied by the daily hours from the employee’s shift history.

* Employee Shift Count x Fixed Hours – the hours amount is the shift count from the employee's shift history multiplied by the Fixed Hours amount entered above.

* Employee Shift Count x Daily Hours – the hours amount is the shift count from the employee's shift history multiplied by the daily hours from the employee’s shift history.

* Full Time Shift Count x Daily Hours – the hours amount is the full time shift count from the employee’s pay rule multiplied by the daily hours from the employee’s shift history.

''Multiplier'' – performs a multiplication of the hours when calculating the premium.

''Move Hours'' – the hours that cause the premium to calculate will be deducted, and the hours that calculate will be added. If you are matching hours with a premium then do not check this.

== See also ==

* [[Configuration]]

Premiums Configuration

2017-08-16T19:36:42Z

Tami: /* Premium Paid */

Premiums Configuration

2017-08-16T19:36:19Z

Tami:

{{Advanced}}

Use Premiums as part of the pay rules to pay hours using a different pay code, give additional hours such as bonuses and guarantees, or cap hours based on maximum allowable hours.

== Main ==

[[File:Premiums.png]]

''Premium ID'' – an identifier for the premium rule.

''Premium Type''

* None – does not calculate any premium.
* Consecutive Shift – pays the premium when consecutive shifts are worked.
* Daily Bonus –adds additional hours for the day.
* Daily Guarantee – adds hours so as to increase the daily total to the guaranteed amount.
* Daily Hours Averager – treats all scheduled days as contributing evenly to the hours for the pay period. This rule is used to allow employees to leave early one day for religious observance, while making up the time on other days in the week.
* Daily Maximum – caps the total hours for the day.
* Differential – pays hours based on working in a differential zone.
* Negative Differential – deducts hours worked in a differential zone.
* Pay Period Maximum – caps the total hours for the pay period.
* Premium Period Maximum – caps the total hours for the premium period. Use this if you need a weekly maximum when the employee has a bi-weekly pay period.
* Schedule Bonus –adds additional hours per schedule.
* Schedule Guarantee – adds hours so as to increase the schedule total to the guaranteed amount.
* Schedule Maximum – caps the total hours for the schedule.

Note: as there can be more than one schedule for the pay date, the daily based premiums use the premiums associated with the employee's pay rule, while the schedule based premiums use the pay rule associated with the schedule.

== Applies To ==

[[File:AppliesTo.png]]

Applies To represents filtering of the premium based on criteria that is already known when configuring the premium.

''Applies To Days Of Week'' – is only used if you specify at least one day of the week. This is the easiest way to setup a premium rule for specific days of the week.

''Minimum/Maximum Employee Shift Count'' – the employee’s shift count must be between the minimum and maximum settings, e.g. differential applies to full time employees only.

''Employee Shifts'' –the shift designation from the employee’s shift history must match one of the selected shifts, e.g. only day employees get a bonus.

''Schedule Shifts'' – the premium applies only to worked schedules with this shift designation, e.g. differential is paid on evening and night schedules.

''Pay Types'' –the premium only applies to the selected pay types.

''Worked Hours Type'' –the premium applies only to hours designated as worked.

''Unworked Hours Type'' – the premium applies only to hours designated as unworked.

== Qualifiers ==

[[File:Qualifiers.png]]

Qualifiers use worked information to determine if the premium will be used.

''Minimum / Maximum Worked Hours'' – if the employee works within the minimum and maximum hours, the premium will apply. The total hours is based off the premium type. E.g. a schedule based rule uses hours calculated from one schedule, while a daily type rules uses total hours for the complete day.

''Minimum / Maximum Punch Count'' – this is the punch count for the pay date, e.g. the employee is guaranteed 8 hours if they punch twice.

''Required Worked Days Of Week'' – the employee must work each day of the week that is selected.

''Minimum / Maximum Shits Worked In Pay Period'' – the employee must work a certain number of shifts within the pay period for this premium to apply.

''Worked Labor Levels'' – the employee must work in the selected labor levels for this premium to apply.

== Worked Labor Levels ==

[[File:WorkedLaborLevels.png]]

== Differential ==

[[File:Differential.png]]

''Zone Type''

* Schedule Shifts – hours worked in the shifts selected from Schedule Shifts in the Applies To will be paid differential. This allows for a dynamic time window based on the schedule start and end times, rather than a fixed time window.
* Time Window – the differential zone occurs in a fixed time window. Any hours that calculate in this zone are paid differential.
* Time Window and Schedule Shifts – the hours worked need to satisfy both of the above rules, e.g. evening schedules after 3pm get differential. This prevents a day schedule that ends at 4pm from getting any differential, and does not pay the one hour of differential on an evening schedule that starts at 2pm.
* Zone Start / Zone End – used with the zone type of Time Window. Specify the start and end of the differential zone, in relation to the pay date.

== Premium Paid ==

[[File:PremiumPaid.png|right|275px]]

''Pay Type'' – the pay type to use for the calculation of the premium hours.

* Fixed Pay Type – select this if the pay type remains constant regardless of the pay type causing the premium to calculate, and select the pay type.

* Pay Type Lookup – If the pay type for paying the premium changes based on the pay type of the hours causing the premium to calculate, then you need to use a pay type lookup. Pay Type Lookups are set inthe [[Pay Type Configuration|pay type configuration]]. The pay type you want to pay for the premium is set on the pay type that is causing the premium to calculate. The lookup number that you specify on the pay type is what you enter here.

* Scheduled Pay Type – pay type used in the schedule will be used to calculate the premium.

* Pay Rate 2, 3, 4 - the premium will affect what pay rate number is used for calculating the employee's hours.

* Move Hours to Shift – the pay type remains unchanged, but the hours are paid in this shift.

* Pay Date to Actual Date Offset - used with Move Hours to Shift above, this allows you to pay the premium on the shift from the day before or day after.

''Hours'' – the number of hours that the premium uses for calculation. This is used for bonuses, guarantees and maximums.

* Fixed Hours – the hours amount remains constant using the number you set here.

* Scheduled Hours – the hours amount is taken from the Scheduled Hours field in the employee's schedule.

* Daily Hours – the hours amount is taken from the employee’s shift history.

* Worked Shift Count x Fixed Hours – the hours amount is the number of worked shifts multiplied by the Fixed Hours amount entered above.

* Worked Shift Count x Daily Hours – the hours amount is the number of worked shifts multiplied by the daily hours from the employee’s shift history.

* Employee Shift Count x Fixed Hours – the hours amount is the shift count from the employee's shift history multiplied by the Fixed Hours amount entered above.

* Employee Shift Count x Daily Hours – the hours amount is the shift count from the employee's shift history multiplied by the daily hours from the employee’s shift history.

* Full Time Shift Count x Daily Hours – the hours amount is the full time shift count from the employee’s pay rule multiplied by the daily hours from the employee’s shift history.

''Multiplier'' – performs a multiplication of the hours when calculating the premium.

''Move Hours'' – the hours that cause the premium to calculate will be deducted, and the hours that calculate will be added. If you are matching hours with a premium then do not check this.

== See also ==

* [[Configuration]]

Overtime Configuration

2017-08-16T19:35:48Z

Tami: /* Hour Levels */

{{Advanced}}

Overtime configuration is where the overtime rules, that will be associated with the pay rules, are configured.

== Main ==

[[File:Overtime.png]]

''Overtime ID'' – a unique identifier for the overtime rule, e.g. Weekly 40

''Type''

* Schedule Pay Date – overtime calculates based on hours worked within the same schedule pay date. For example, if the 3 shifts for a pay date are Day, Evening, and Night, then overtime will calculate on the following double shifts:
** Day / Evening
** Day / Night
** Evening / Night
* Pay Date – overtime calculates on hours paid in the same pay date. Unlike the Schedule Pay Date overtime example above, overtime will calculate on a Night / Day double shift if the employee does not punch between shifts. There are different versions of the Pay Date overtime that will make the rule apply / not apply based on the number of shifts worked. For example, the Pay Date (Single Shift) overtime will calculate overtime when a small number of hours are worked past a single shift, but will not calculate overtime on a double shift.
* Consecutive Shifts – overtime calculates on two schedules that are back to back. For example, Day / Evening, Evening / Night, and Night / Day. There are 2 versions of this overtime. One version does not allow consecutive shifts to calculate from the last schedule of one pay period combined with the first schedule of the new pay period.
* Punch Group – overtime can only occur within one punch group. For example, an employee can work a Day shift and a Night shift and get “daily” overtime for working hours past the end of each shift.
* Consecutive Days – overtime calculates on the 6th and 7th consecutive day.
* Overtime Period – overtime calculates on hours within the overtime period, as defined by the Overtime Period Group. There are versions of this overtime type that will sort the hours so that the employees “regular” hours will be less likely to become overtime. For example, the Sorted By Default Shift rule will make Evening and Night hours become overtime before Day hours for Day employees, while Day hours become overtime before Evening / Night hours for Evening and Night employees. The Sorted By Employee Shift will make all hours worked in the shifts that are NOT the employee’s current shift become overtime first.
''Overtime Period Group'' – required for overtime period overtime.

== Applies To ==

[[File:AppliesTo.png]]

== Qualifiers ==

[[File:Qualifiers.png]]

== Home Labor Levels ==

[[File:OvertimeHomeLaborLevels.png]]

== Hour Levels ==

[[File:HoursLevels.png]]

''Level Type – ''the overtime levels are based on a fixed unchanging level or a dynamic level based on the employee’s shift history or pay rule.

* Fixed Hour Level – select this if the overtime level remains constant.
* Daily Hours – the daily hours specified in the employee’s shift history is the overtime level.
* Employee Shift Count x Hours – the overtime level is the number of shifts from the employee’s shift history multiplied by the daily hours from their shift history. Use this when hours that exceed the employee's regular amount of hours worked are paid as overtime, i.e. some form of “daily” overtime
* Full Time Shift Count x Daily Hours – the overtime level is the full time shift count from the employee’s pay rule times the daily hours from their shift history. Typically used for a weekly or pay period based overtime.
* 6th Shift – the overtime level is the total hours worked from the first five shifts. Therefore, anything worked in the 6th or any additional shift will calculate as overtime.
* Custom – this is a client specific rule.

''Pay Type'' – If the pay type to use for paying overtime is fixed, then set here. If the pay type for paying overtime changes based on pay type of the hours counting towards the overtime, then set the lookup level, e.g. employees earning REG as their base pay type are paid OT for their overtime pay type, while employees earning SAL are paid SAL-OT.

== See also ==

* [[Configuration]]

Overtime Configuration

2017-08-16T19:35:39Z

Tami:

{{Advanced}}

Overtime configuration is where the overtime rules, that will be associated with the pay rules, are configured.

== Main ==

[[File:Overtime.png]]

''Overtime ID'' – a unique identifier for the overtime rule, e.g. Weekly 40

''Type''

* Schedule Pay Date – overtime calculates based on hours worked within the same schedule pay date. For example, if the 3 shifts for a pay date are Day, Evening, and Night, then overtime will calculate on the following double shifts:
** Day / Evening
** Day / Night
** Evening / Night
* Pay Date – overtime calculates on hours paid in the same pay date. Unlike the Schedule Pay Date overtime example above, overtime will calculate on a Night / Day double shift if the employee does not punch between shifts. There are different versions of the Pay Date overtime that will make the rule apply / not apply based on the number of shifts worked. For example, the Pay Date (Single Shift) overtime will calculate overtime when a small number of hours are worked past a single shift, but will not calculate overtime on a double shift.
* Consecutive Shifts – overtime calculates on two schedules that are back to back. For example, Day / Evening, Evening / Night, and Night / Day. There are 2 versions of this overtime. One version does not allow consecutive shifts to calculate from the last schedule of one pay period combined with the first schedule of the new pay period.
* Punch Group – overtime can only occur within one punch group. For example, an employee can work a Day shift and a Night shift and get “daily” overtime for working hours past the end of each shift.
* Consecutive Days – overtime calculates on the 6th and 7th consecutive day.
* Overtime Period – overtime calculates on hours within the overtime period, as defined by the Overtime Period Group. There are versions of this overtime type that will sort the hours so that the employees “regular” hours will be less likely to become overtime. For example, the Sorted By Default Shift rule will make Evening and Night hours become overtime before Day hours for Day employees, while Day hours become overtime before Evening / Night hours for Evening and Night employees. The Sorted By Employee Shift will make all hours worked in the shifts that are NOT the employee’s current shift become overtime first.
''Overtime Period Group'' – required for overtime period overtime.

== Applies To ==

[[File:AppliesTo.png]]

== Qualifiers ==

[[File:Qualifiers.png]]

== Home Labor Levels ==

[[File:OvertimeHomeLaborLevels.png]]

== Hour Levels ==

[[File:HoursLevels.png|right|275px]]

''Level Type – ''the overtime levels are based on a fixed unchanging level or a dynamic level based on the employee’s shift history or pay rule.

* Fixed Hour Level – select this if the overtime level remains constant.
* Daily Hours – the daily hours specified in the employee’s shift history is the overtime level.
* Employee Shift Count x Hours – the overtime level is the number of shifts from the employee’s shift history multiplied by the daily hours from their shift history. Use this when hours that exceed the employee's regular amount of hours worked are paid as overtime, i.e. some form of “daily” overtime
* Full Time Shift Count x Daily Hours – the overtime level is the full time shift count from the employee’s pay rule times the daily hours from their shift history. Typically used for a weekly or pay period based overtime.
* 6th Shift – the overtime level is the total hours worked from the first five shifts. Therefore, anything worked in the 6th or any additional shift will calculate as overtime.
* Custom – this is a client specific rule.

''Pay Type'' – If the pay type to use for paying overtime is fixed, then set here. If the pay type for paying overtime changes based on pay type of the hours counting towards the overtime, then set the lookup level, e.g. employees earning REG as their base pay type are paid OT for their overtime pay type, while employees earning SAL are paid SAL-OT.

== See also ==

* [[Configuration]]

Pay Periods Configuration

2017-08-16T19:35:27Z

Tami:

{{Advanced}}

This configures the pay periods that will be used by the pay rules. The pay periods are a table of dates that are used to determine the start date and end date of each pay period, the previous, current and next pay periods as well as settings to determine the pay period currently being used for payroll.

== Pay Period Group ==

===Main===

[[image:PayPeriodGroups.png]]

''Pay Period Group ID'' – the identifier for the pay period group.

''Start Date'' – the date to start building the pay periods from.

''Period Type'' – the basis for building the pay periods. If you have a custom pay period, then select the best match and then edit the pay periods that are incorrect.

''Week Starts On'' – the starting day of the week. This is used to provide weekly grouping in pay period longer than one week in length.

''Payroll Start Date Offset'' – the day that payroll processing starts for this pay period. The payroll start and end range is used in reports when specifying a payroll date as the date based criteria.

''Payroll End Date Offset'' – the day that payroll is completed for this pay period. The previous pay period closes on the following day.

''Pay Period Move After Date Offset'' – the number of days after the end of the pay period, when the pay period should move. If this is set to 0 when the pay periods are built, then today's date will always be in the current pay period. If you consider the current pay period to be the pay period you are paying, then you need to set this figure to the number of days you require to do payroll.

===Home Labor Levels===

[[image:HomeLaborLevels.png]]

== Pay Periods ==

[[image:PayPeriodsSplit.png]]

''Year'' – the year to build the pay periods for.

''Build'' – generates the pay periods for the selected year. This clears any dates on or after the start date.

''Clear Year'' – this will clear the entire year.

== See also ==

* [[Configuration]]

Time Clocks Configuration

2017-08-16T18:30:00Z

Tami: /* Daylight Savings */

{{Advanced}}

Enter the time clocks in Time Clocks configuration. The time clocks are organized under a time clock group that represents the method of communication, with the time clock representing the physical time clock.

= Time Clock Group =

== Main ==

[[File:TimeClockTop.png]]

''Time Clock Group ID'' – a way to identify the physical location or connection used to communicate with single or multiple time clocks.

''Time Clock Type'' – currently we only support the HandPunch time clock (HPX000 series). The software can also import the information from the PNETG format that is generated by the Recognition Systems PNETG software. This format is also used by the HPunch32 software.

== Communication Type ==

* RS-485 – the software communicates via the serial port using a RS-232 to RS-485 converter.
* RS-232 – the software communicates directly via the serial port.
* Modem – the software uses a modem to dial out to the time clock.
* Ethernet – the software communicates using the TCP/IP protocol to the time clock.
* File – this allows re-processing of the punch log file created by the software.

== Ethernet ==

[[File:TCEthernet.png]]

''IP Address'' – the IP address of the time clock. Do not zero fill the IP address, e.g. 192.168.1.100.

''MAC Address'' – the software will use DNS to get the MAC address from the IP address. It is not necessary to set the MAC Address to communicate to the time clock. This is an informational field that may be useful in network diagnostics.

''Port Number'' – the port used by the time clock.

== Serial ==

[[File:TCSerial.png]]

''Baud Rate'' – this must match the rate that the time clock is configured at. With RS-232 and RS-485, this is generally 9600 or 19200. With a modem connection, it is generally 2400 or 9600.

''Parity'' – Odd, Even or None

''Data Bits'' – 7 or 8

''Stop Bits'' – 0 or 1

''Comm Port'' – the comm port (serial port) that the time clock or modem is using.

''Phone #'' – the number to dial for a modem connection.

== File ==

[[File:TCFile.png]]

''File Path'' – the full path to the file.

== Email ==

[[File:TCEmail.png]]

= Time Clocks =

== Main ==

[[File:TimeClockBottom.png]]

''Time Clock ID'' – an identifier for the time clock. This displays in the Clock Info tab. Users need to be able to identify the Time Clock from this ID.

''Usage Type''

* Punch – punches made at the clock will apply to the time cards
* Access – punches made at the clock are considered access or entry punches and only go into the access log
* Both – punches are considered both "punches" and "access"

''Clock Number'' – this must match the clock number that the time clock is set to.

''Model'' – the software will get the model when it communicates to the time clock. It is not necessary to set this to communicate to the time clock.

''Serial Number'' – the software will get the serial number when it communicates to the time clock.

== Daylight Savings ==

[[File:TCDaylightSavings.png]]

''Daylight Savings'' – check this if you want the time on the clock to change automatically for daylight savings. If you do not want the clock to do it automatically, then you will need to have a user change the time manually or schedule a task to do it.

''Daylight Savings On'' – the date and time at which the clock will move one hour ahead.

''Daylight Savings Off'' – the date and time at which the clock will move one hour back.

Note – the HandPunch only uses the month, date, hour and minute portion of the daylight savings dates.

== Configuration ==

[[File:TCConfiguration.png]]

''Keypad Beeper'' – a beep is emitted when the keypad is used on the time clock.

''12 Hour Time Format'' – time does not display AM and PM on a HandPunch, if you want to be assured that the time shown is correct (and not 12 hours off), then do not check this and the time will display in military format.

''Explicit Punching'' – the HandPunch will display the standard explicit punching menu after entering the clock ID (1 – IN 2 – OUT 3 – BACK)

''Department Code'' – the HandPunch will prompt for the department after the clock ID is entered.

''Threshold'' – the default on a “cold-booted” HandPunch is 100. Typical values are from 100 to 150. It is generally raised to compensate for the calibration having changed slightly from the factory calibration.

''ID Length'' – if all employees are using the same length clock ID, then setting this to the length of the IDs will eliminate the need to press Enter after the last digit.

''Number of Tries'' – when the hand validation fails, the HandPunch will prompt the employee to “TRY AGAIN.” This setting determines how many times they will be prompted, before getting rejected.

''Exposure'' – camera information gathered from the HandPunch.

''Function Key File'' – if you are using a custom menu at the HandPunch, then this is where you specify the path and name of the function key file.

''Send Function Key File'' – communicates to the HandPunch and uploads the function key file.

== Passwords ==

[[File:TCPasswords.png]]

''Service'' – this is the menu that is accessed via the 1 key on a "cold-booted" HandPunch. The main function ever required in this menu is Calibrate, which provides information on the camera alignment.

''Setup'' – this is the menu that is accessed via the 2 key on a "cold-booted" HandPunch. It allows the time to be changed on the HandPunch and although this information is logged, it may not be desirable to allow access to this menu.

''Management'' – this is the menu that is accessed via the 3 key on a "cold-booted" HandPunch. This menu provides supervisor override functions when you have implemented restrictions at the clock based on time or location.

''Enrollment'' – this is the menu that is accessed via the 4 key on a "cold-booted" HandPunch. This is the main enrollment menu.

''Security'' – this is the menu that is accessed via the 5 key on a "cold-booted" HandPunch. This menu provides Special Enrollment for employees who are unable to use the HandPunch in a regular manner, because they do not have all fingers or cannot straighten their fingers sufficiently.

== Misc. ==

[[File:TCMisc.png]]

== See also ==

* [[Configuration]]
* [[HandPunch Network Configuration]]

Time Clocks Configuration

2017-08-16T18:29:46Z

Tami:

{{Advanced}}

Enter the time clocks in Time Clocks configuration. The time clocks are organized under a time clock group that represents the method of communication, with the time clock representing the physical time clock.

= Time Clock Group =

== Main ==

[[File:TimeClockTop.png]]

''Time Clock Group ID'' – a way to identify the physical location or connection used to communicate with single or multiple time clocks.

''Time Clock Type'' – currently we only support the HandPunch time clock (HPX000 series). The software can also import the information from the PNETG format that is generated by the Recognition Systems PNETG software. This format is also used by the HPunch32 software.

== Communication Type ==

* RS-485 – the software communicates via the serial port using a RS-232 to RS-485 converter.
* RS-232 – the software communicates directly via the serial port.
* Modem – the software uses a modem to dial out to the time clock.
* Ethernet – the software communicates using the TCP/IP protocol to the time clock.
* File – this allows re-processing of the punch log file created by the software.

== Ethernet ==

[[File:TCEthernet.png]]

''IP Address'' – the IP address of the time clock. Do not zero fill the IP address, e.g. 192.168.1.100.

''MAC Address'' – the software will use DNS to get the MAC address from the IP address. It is not necessary to set the MAC Address to communicate to the time clock. This is an informational field that may be useful in network diagnostics.

''Port Number'' – the port used by the time clock.

== Serial ==

[[File:TCSerial.png]]

''Baud Rate'' – this must match the rate that the time clock is configured at. With RS-232 and RS-485, this is generally 9600 or 19200. With a modem connection, it is generally 2400 or 9600.

''Parity'' – Odd, Even or None

''Data Bits'' – 7 or 8

''Stop Bits'' – 0 or 1

''Comm Port'' – the comm port (serial port) that the time clock or modem is using.

''Phone #'' – the number to dial for a modem connection.

== File ==

[[File:TCFile.png]]

''File Path'' – the full path to the file.

== Email ==

[[File:TCEmail.png]]

= Time Clocks =

== Main ==

[[File:TimeClockBottom.png]]

''Time Clock ID'' – an identifier for the time clock. This displays in the Clock Info tab. Users need to be able to identify the Time Clock from this ID.

''Usage Type''

* Punch – punches made at the clock will apply to the time cards
* Access – punches made at the clock are considered access or entry punches and only go into the access log
* Both – punches are considered both "punches" and "access"

''Clock Number'' – this must match the clock number that the time clock is set to.

''Model'' – the software will get the model when it communicates to the time clock. It is not necessary to set this to communicate to the time clock.

''Serial Number'' – the software will get the serial number when it communicates to the time clock.

== Daylight Savings ==

[[File:TCDaylighSavings.png]]

''Daylight Savings'' – check this if you want the time on the clock to change automatically for daylight savings. If you do not want the clock to do it automatically, then you will need to have a user change the time manually or schedule a task to do it.

''Daylight Savings On'' – the date and time at which the clock will move one hour ahead.

''Daylight Savings Off'' – the date and time at which the clock will move one hour back.

Note – the HandPunch only uses the month, date, hour and minute portion of the daylight savings dates.

== Configuration ==

[[File:TCConfiguration.png]]

''Keypad Beeper'' – a beep is emitted when the keypad is used on the time clock.

''12 Hour Time Format'' – time does not display AM and PM on a HandPunch, if you want to be assured that the time shown is correct (and not 12 hours off), then do not check this and the time will display in military format.

''Explicit Punching'' – the HandPunch will display the standard explicit punching menu after entering the clock ID (1 – IN 2 – OUT 3 – BACK)

''Department Code'' – the HandPunch will prompt for the department after the clock ID is entered.

''Threshold'' – the default on a “cold-booted” HandPunch is 100. Typical values are from 100 to 150. It is generally raised to compensate for the calibration having changed slightly from the factory calibration.

''ID Length'' – if all employees are using the same length clock ID, then setting this to the length of the IDs will eliminate the need to press Enter after the last digit.

''Number of Tries'' – when the hand validation fails, the HandPunch will prompt the employee to “TRY AGAIN.” This setting determines how many times they will be prompted, before getting rejected.

''Exposure'' – camera information gathered from the HandPunch.

''Function Key File'' – if you are using a custom menu at the HandPunch, then this is where you specify the path and name of the function key file.

''Send Function Key File'' – communicates to the HandPunch and uploads the function key file.

== Passwords ==

[[File:TCPasswords.png]]

''Service'' – this is the menu that is accessed via the 1 key on a "cold-booted" HandPunch. The main function ever required in this menu is Calibrate, which provides information on the camera alignment.

''Setup'' – this is the menu that is accessed via the 2 key on a "cold-booted" HandPunch. It allows the time to be changed on the HandPunch and although this information is logged, it may not be desirable to allow access to this menu.

''Management'' – this is the menu that is accessed via the 3 key on a "cold-booted" HandPunch. This menu provides supervisor override functions when you have implemented restrictions at the clock based on time or location.

''Enrollment'' – this is the menu that is accessed via the 4 key on a "cold-booted" HandPunch. This is the main enrollment menu.

''Security'' – this is the menu that is accessed via the 5 key on a "cold-booted" HandPunch. This menu provides Special Enrollment for employees who are unable to use the HandPunch in a regular manner, because they do not have all fingers or cannot straighten their fingers sufficiently.

== Misc. ==

[[File:TCMisc.png]]

== See also ==

* [[Configuration]]
* [[HandPunch Network Configuration]]

File:TimeClockTop.png

2017-08-16T18:26:37Z

Tami:

File:TimeClockBottom.png

2017-08-16T18:26:31Z

Tami:

File:TCSerial.png

2017-08-16T18:26:24Z

Tami:

File:TCPasswords.png

2017-08-16T18:26:19Z

Tami:

File:TCMisc.png

2017-08-16T18:26:08Z

Tami: Tami uploaded a new version of "File:TCMisc.png"

File:TCMisc.png

2017-08-16T18:26:03Z

Tami:

File:TCFile.png

2017-08-16T18:25:59Z

Tami:

File:TCEthernet.png

2017-08-16T18:25:50Z

Tami: