sbv.wiki - User contributions [en]

Scheduler Configuration

2017-02-20T14:16:50Z

Deb:

{{Under Construction}}



This is a step by step guide for configuring the [[Scheduler]]. Detailed instructions on setting up the items needed for scheduling will be on the page dedicated to the configuration of that item. This step by step guide provides the links between each step.

== Labor Levels ==

You need to define labor levels that represent the divisions between the type of job titles / position that employees work, and the different places that an employee can work within your facility. A very simple example is:

{| class="wikitable"

|-
! Nurse Type

|-
| RN

|-
| LPN

|-
| CNA

|}

{| class="wikitable"

|-
! Floor

|-
| 1st Floor

|-
| 2nd Floor

|-
| 3rd Floor

|}

You are defining two things:

# The names of the labor levels (Nurse Type and Floor)
# The items with each labor level (RN, LPN, CNA and 1st, 2nd and 3rd Floor).

In the software we would designate the Nurse Type to be the '''Budget Group Labor Level''', and the Floor to be the '''Floor / Unit Labor Level'''. This designation is done in the [[System Configuration#Labor Level Designations|System configuration, Labor Level Designation ]] tab. Two labor levels are the minimum required to use the scheduler. There is one more level that is required when you need more than one scheduler in your software. If for example you want to schedule your nursing, dietary and housekeeping staff in three distinct groups then you would need to add a labor level for this and define this as the Scheduler Labor Level in the [[System Configuration#Labor Level Designations|System configuration, Labor Level Designations]] tab.

=== Department ===

You may think that your department labor level is already defined in the software and your budgeted staffing levels can be based on your department. In most facilities, there is often more than one department that would be considered to be RNs, LPNs, CNAs etc. If you have separate departments for agency employees, or separate departments for Day, Evening and Night employees, or a separate Per Diem department, then you cannot use the department labor level as one of the two levels required for the scheduler.

=== Multi Facility ===

If your software contains multiple facilities then you automatically get a scheduler per facility by designating the facility labor level as the Scheduler Labor Level in the [[System Configuration#Labor Level Designations|System configuration, Labor Level Designations]] tab. If you want to have multiple schedulers per facility then you will need to add a labor level. The items within this labor level would be named in this manner:

{| class="wikitable"

|-
| Facility ABC Nursing

|-
| Facility ABC Dietary

|-
| Facility ABC Housekeeping

|-
| Facility XYZ Nursing

|-
| Facility XYZ Dietary and Housekeeping

|}

This allows you to groups your scheduled staff differently in each facility.

=== Budget or Scheduling Labor Level ===

When labor levels are defined in [[System Configuration#Labor Levels|System configuration, Labor Levels]] tab, you can designate the labor levels to be Budget based and/or Scheduling based. Budget based labor levels will show in the [[Budget Configuration]] screen. Scheduling based labor levels will show in the employee's [[Employee Scheduling #Schedule Patterns|Schedule Patterns]] tab, allowing you to schedule the employee.

==== Scheduler Labor Level ====

Despite it's name, because employees do not work outside of their scheduler labor level, this would be a Budget based labor level only.

==== Budget Group Labor Level ====

If employees will only work within their home Budget Group(e.g. an RN will not cover for a LPN position) then Budget Group labor level would be just a Scheduler based level. If you need to allow employees to work in one or more budget groups then you will need to make this labor level a Scheduling level, or make the Department level a Scheduling level. Whatever level you so use, you must also make this a Restricted scheduling labor level. Otherwise, all employees can accept any schedule, i.e. a CNA can accept a RN schedule. You will need to define the Allowable Budget Group Scheduling Labor Levels in [[System Configuration#Labor Level Assignments|System configuration / Labor Level Assignments]] tab.

==== Department Labor Level ====

If you want employees to be paid from a different department when they work in a different Budget Group then the Department labor level is defined as a Scheduling Labor Level. You must also make this a Restricted scheduling labor level otherwise all employees can accept any schedule. You will need to define the Allowable Department Scheduling Labor Levels in [[System Configuration#Labor Level Assignments|System configuration / Labor Level Assignments]] tab. There is one additional step required when you use departmental scheduling. Because the department labor level is not defined as a Budget labor level, but the Budget Group level is defined as a Budget labor level, you need to make the relationships between the departments and the budget group. This is done in [[System Configuration#Labor Level Assignments|System configuration / Labor Level Assignments]] tab, using the One to One Budget Group Labor Level Assingment table.

==== Floor / Unit Labor Level ====

This will always be a budget and scheduler based labor level.

== Scheduler Periods ==

Your scheduler periods will typically be from 1 week to 8 weeks in length. They can also be calendar month based. If you defined Scheduler Labor Levels then you can use different scheduler periods with each Scheduler Labor Level, e.g. Nursing schedules 4 weeks at a time, while Dietary works one week at a time. You create the relationship between a scheduler labor level and a scheduler period group in the [[System Configuration#Labor Level Assignments|System configuration / Labor Level Assignments]] tab.

== Base Schedules ==

You need to know the schedule choices required for each budget group. An identifier for each unique schedule choice is entered in [[Sub Shift Configuration]], within the [[Shift Configuration|shift]] that each sub shift falls under. In the [[Base Schedule Configuration|base schedules]] configuration, you define a base schedule group, and add the base schedules, assigning the shift / sub shift to each base schedule.

You now need to link the budgets groups to the base schedule groups. This is done in the [[System Configuration#Labor Level Assignments|System configuration / Labor Level Assignments]] tab. If using a Scheduler Labor Level then you need to link the Scheduler and Budget Group to the Base Schedule Group.

For example, Employee A is placed in the CNA budget group, the CNA budget group is linked to the Nursing base schedule group, the Nursing base schedule group has three schedules, each schedule is assigned to a different shift / sub shift. When you click on the Shift drop down in this employee's [[Employee Scheduling#Schedule Patterns|Schedule Patterns]] tab, the drop down will contain the same three choices that you see in the base schedules.

== Budget ==

To Be DELETED
The budget defines your desired staffing levels based on the day of week, the shift, and the labor levels that you defined to be the budgetary levels. Here is a sample budget:

{| class="wikitable" style="text-align: center;"

|-
! Days of Week
! Shift
! Budget Group
! Floor
! Count

|-
| All Days
| Day
| LPN
| Floor 1
|1

|-
| All Days
| Day
| LPN
| Floor 2
|1

|-
| All Days
| Evening
| LPN
| Floor 1
|1

|-
| All Days
| Evening
| LPN
| Floor 2
|1

|-
| All Days
| Night
| LPN
| Floor 1
|1

|-
| All Days
| Night
| LPN
| Floor 2
| 1

|}

For all but the smallest budgets, you would use the [[Budget Import]] to enter your budget into the software. After the budget is entered you must see that the Base Schedule Group and Scheduler Period Group columns are not blank.

== Schedule Patterns ==

Schedule patterns can be entered on an employee once the employee is assigned to a budget group. The base schedules that belong to the base schedule group thru the labor level assignment will appear as choices in the Shift column drop down.

== Planned Absences ==

In the [[Schedule Status Types Configuration]], you can add the choices that you want to see in the [[Employee Scheduling#Planned Absences|Planned Absences]] tab and in the [[Scheduler]] by selecting Display At Planned Absence Level and/or Display At Scheduler Level. Generally, you want to limit that the attendance issues that occur "day of" like Called Sick are not available to select in the planned absences, while the planned attendances like Vacation are not available to select in the [[Scheduler]].

You should encourage the users to enter the planned days off are entered as soon as they are known. This will also eliminate the scheduler user from forgetting to remove the employee off the schedule.

Scheduler

2016-07-29T15:21:35Z

Deb:

The Scheduler provides a budgetary controlled scheduling process. This is shift based scheduling designed to handle:

* your work day is divided into multiple shifts
* some employees may work more than one shift in the same work day
* you have a desired staffing level based on your full or current census, or a dynamic staffing level based on your daily census

Employees that are part of the scheduling process are indicated as such in their [[Employee Work Pattern|Work Pattern]] tab by having a work pattern type of either Scheduler or Soft Scheduler. As most employees will have a recurring fixed schedule, this is entered in the employee's [[Employee Scheduling#Schedule Patterns|Schedule Patterns]] tab. The schedule pattern allows for a rotating schedule, typically a 2 or 4 week pattern. Planned days off are also maintained in the employee's [[Employee Scheduling#Planned Absences|Planned Absences]] tab.

The scheduler periods maintain the start and end dates of each period of dates that you schedule within. When you get close to the start date of the next scheduler period, you will need to build the schedules. Schedules are assigned to the employees using their schedule pattern as a template, while not scheduling those that are in a planned absence. Schedules that remain unassigned are available to assign manually to your staff. As schedules are moved between employees and the available pool, a history of the transfers is maintained.

The scheduler grid displays the schedules for each employee. The grid uses color and text to provide information about where and when an employee is working. The grid includes totals of both scheduled and available schedules. You can move schedules between employees, or from/to the available pool. You can also filter, sort, and search the scheduler as well as run reports such as your daily staffing sheet.

==Build Schedules==

The Build Schedules command is available in the Scheduler ribbon tab.

'''Before Building the Schedules'''

Before building the schedules, all schedule pattern changes, and planned absences that affect the next scheduler period must be entered. You must also check that you are not exceeding your budget levels. You can exceed your budget in two ways.

* Placing an employee into an non-budgeted position
* Having too many employees assigned to a budgeted position

You check both of these items by running the following reports from the [[Reports]] tab in the [[Scheduling Reports|Scheduling]] drop down. They are also available in the Scheduler.

''Schedule Patterns Without Budget'' – the Schedule Patterns Without Budget report displays employees who have a schedule pattern that has no budget. If this report is not empty then you have missing information in the employee's schedule pattern, you have incorrect schedule patterns entered, or you have a new position that the software does not know about.

* Make sure that all the employees who are part of the scheduling process are selected

* Select the correct date range from the Date Range tab. This is generally the next scheduler period

''Budget Versus Schedule Pattern'' – the Budget Versus Schedule Pattern shows you where the totals of the schedule patterns exceeds the budget. You must use the “Over Budget – Monthly” version of this report as this version checks the budget levels against your schedule patterns in the exact order that schedules are created and assigned during the build schedules process.

* Make sure that all the employees who are part of the scheduling process are selected

* Select the correct date range from the Date Range tab. This is generally the next scheduler period

* In the Budget tab, select the budgets that correspond to the selected employees

* If you have an overage allowance, then you include this allowance in the Options tab by selecting Include Overages

Upon running the report, it must be empty. If it is not empty, then building the schedules would result in some employees not getting their schedules. This report gives you the employee details on where you are over budget. If you can not move employees to get this report to be empty then increasing the overage is your only option. You need access to the [[Budget Configuration]] to do this.

'''Building the Schedules'''

Once you have confirmed that you are within your budget (including overages), you can build your schedules.

The Build Schedules screen represents your budget with some additional information.

* The date range that schedules will be built for is shown in the Build Date and End Date columns.

* There is a check box column where you select the schedules to build. Selecting the check box in the column header will select all the budgets.

* There is a status column to provide feedback as the schedules are built.

[[image:SchedulerBuildSchedules.png]]

Click on the Build Schedules button.

[[image:SchedulerBuildSchedulesButton.png]

The status column will update as it builds and assigns the schedules for each budget item, and the build date will move to the start of the following scheduler period. When the building is completed, you will be able to click on the Close button.

==Scheduler Grid==

Display the scheduler grid from the Scheduler ribbon tab.

'''Date Range'''

The date range group provides a drop down of the scheduler period dates. Select from the drop down to fill in the start and end dates. Change these dates before clicking on the Display Schedules command to work with a different date range.

[[image:SchedulerGrid.png]

Make the day-to-day schedule changes in the scheduler grid. The scheduler grid allows the user to move schedules between employees or to/from the available schedules.

Cell color, text and text color help provide maximum schedule information while using the minimum amount of space. Hovering over a cell will provide more detailed information like schedule start and end times, labor levels, schedule history and punch information.

'''Scheduler Groups'''

The employees and the available schedules are grouped by their respective scheduler group. You can filter or collapse the scheduler groups.

Filtering the groups:

[[image:SchedulerGroupFiltering.png]]

Collapsing the groups:

[[image:SchedulerGroupCollapse.png]]

The filtering, collapsing and expanding of the scheduler groups applies to both the employee and the available's grid.

'''Schedule and Placeholder Display'''

Weekly schedule totals display and can be used to sort the employees (those with less schedules listed first).

[[image:SchedulerWeeklyTotals.png]]

'''Employee Display'''

Employee information displays in columns that can be filtered. Additionally, employee information needed only for filtering, displays above the column headers at the top of the scheduler grid.

[[image:SchedulerEmployeeFields.png]]

In the above screen shot, the department field filter is shown. Employees can be filtered by Name, Shift Count, and Company.

'''Context Menu'''

The right click menu provides management of the schedules and placeholders, and access to reports. When applicable, menu selections are provided for multiple days and/or multiple employees. For example, the Monthly Schedule for Employee report is available for all selected employees.

[[image:SchedulerEmployeeContextMenu.png]]

'''Sorting'''

Employees can be sorted by:

Employee Name – the default sorting, alphabetically by their name.

Employee ID – sorted by the employee’s ID.

Seniority – sorted by date of hire.

Weekly Shift Count – sorted by the total schedule count in the selected week.

[[image:SchedulerSortOrder.png]]

'''Available Schedules'''

The available are grouped to provide a clear visual distinction between availables from different shifts and floors. The number in the cell represents the count of the available schedules. If the text color is white, then you are over budget on the shift and floor.

[[image:SchedulerAvailables.png]]

'''Find and Filter'''

[[image:SchedulerFindAndFilter.png]]

The Filter button is like the Filter Row in the employee list on the main screen. Only employees that match part of the filter text will display. Pressing Enter keeps the currently shown employees visible while newly found employees are displayed.

Here is the result of entering Smith, clicking Filter, entering Brown and pressing Enter.

[[image:SchedulerFilterThenFind.png]]

Shift and floor filtering is available from the 2 drop downs. The Filter Availables option will apply the same shift and floor filtering to the availables. Here is a screen shot of the availables filtered to floor 2.

[[image:SchedulerAvailablesFiltering.png]]

Include Home Shift applies when using shift filtering and will include employees that are homed in the filtered shift, although they do not have any schedules.

With Placeholders Only filters the scheduler screen to employees that have one or more schedule placeholders.

'''Tool Tips'''

There is an employee tool tip and the schedule / placeholder tool tip.

The employee tool tip displays additional information about the employee.

[[image:SchedulerEmployeeToolTip.png]]

The schedule / placeholder tool tip displays detail on the schedule / placeholder and punch information for the day.

[[image:SchedulerScheduleToolTip.png]]

'''Employees Crossing Budget Groups'''

Employees with schedules that cross a budget group, when the budget groups are not displayed together (e.g. RNs and LPNs) will display twice and with the correct counting of schedules for the group.

An RN supervisor works a floor nurse position. The totals are correct.

[[image:SchedulerCrossBudgetGroup.png]]

'''Other'''

''Monthly Mode''

Make changes in the scheduler in Daily or Monthly mode.

Monthly mode changes are not considered to be a schedule change. Two employees swapping schedules is a typical example of a monthly change. Monthly mode changes do not add to the schedule history.

Daily changes are changes that occur on the "day of," and changes that you do before posting the schedule where you want the employee to have a placeholder, and/or the schedule to maintain history. Examples are a sick call or a last minute vacation request.

'''Tools'''

''Build Schedules''

See [ Build Schedules].

==Scheduler Grid Editing==

The scheduler grid allows you to manage the schedules assigned to the employees, restricted only by the authorizations of the user. Examples are:

* Move one or more schedules from one employee to another employee

* Move one or more schedules from the availables to an employee

* Move one or more schedules from an employee to the availables

* Add a schedule

* Add or delete placeholders

'''Moving Schedules'''

Schedule moves are a 2-part process. Schedules you are taking “from” (either an employee or the availables) and then giving “to” (either an employee or the availables).

After selecting the “from” schedule(s), press the F key. The selected cells have a red border to indicate that you are in the middle of a from/to action.

[[image:SchedulerFromAvailables.png]]

You can only select a single employee’s schedules (i.e. from the same row). Available schedules can be selected from different shifts and floors (i.e. different rows). Select cells that are not adjacent to each other using the Ctrl key.

Select the receiving employee (known as the “to” employee) from any of their cells and press the T key.

In the screen shot below, the schedules from the 11th and the 13th will move to the employee even though the cell from the 12th is the selected cell. Note: you cannot move schedules from one pay date to a different pay date.

[[image:SchedulerFromTo.png]]

Move schedules from an employee to the availables with the single keystroke of U.

'''Swapping Schedules'''

Schedule swapping occurs when the receiving employee already has a schedule in the same shift. The employee(s) keep their schedule start and end times.

You can combine swaps and moves at the same time.

[[image:SchedulerGiveAndSwap1.png]]

The two available schedules on the 5th floor are given to an employee. The 11th is an “available to employee” while the 12th is a schedule swap.

[[image:SchedulerGiveAndSwap2.png]]

'''Multiple Schedules in a Pay Date'''

If an employee has more than one schedule in a pay date, then you must provide the schedule number to take “from” this employee. The top left schedule is number 1 and the bottom right schedule is number 2. If there are 3 schedules, then they are numbered 1 to 3 from top to bottom. These alternate keys represent the keystroke and number combinations:

R = T and 1

E = T and 2

W = T and 3

I = U + 1

J = U + 2

K = U + 3

If you do not indicate the schedule number, the software will prompt you.

'''Placeholders'''

Add or edit placeholders for multiple days by selecting cells and using the [ Schedule Status Type] shortcut (Shift + Key).

'''Scheduler Type'''

Use the scheduler type for categorizing a schedule. The default scheduler type is Standard. Other scheduler types are Orientation, Light Duty and Make Up. Categorize schedules to provide indicators on the staffing reports. Pressing S, O, L or M on a selected schedule changes the scheduler type between Standard, Orientation, Light Duty and Make Up. The displayed text underlines for all scheduler types except Standard. Additionally, the text color can be configured for each scheduler type (Standard is always black).

== Reporting ==

Use reports throughout the scheduling process. Examples of reports include:

* Pinpoint where the employee's schedule patterns do not match the employee's shift level.

* Show where budgetary hours and schedule hours are not aligned.

* Highlight where schedule patterns exceed budget and therefore would leave some employees unscheduled although their schedule pattern defines them as working.

* Display the schedule pattern projected as a master schedule considering employee status and planned absences.

* Give employees a one-page calendar view of their schedules.

* Post monthly schedule reports, so that employees can see when they are working.

* Replacement and daily staffing reports.

* Placeholder reports.

* Employee contact information such as a phone list.

== See also ==

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

* [[Employees]]

* [[Employee]]

* [[Reports]]

* [[Tools]]

* [[Configuration]]

Shifts Configuration

2016-05-10T18:31:02Z

Deb:

Shifts are a simple, but powerful feature of the software. Shifts are used throughout the software to subdivide the pay date into segments. Typically there are 3 shifts in the day, Day, Evening and Night, but you can name them as you need, and define what the first shift of the day is.

''Shift ID'' – a unique identifier for this shift.

''Scheduler ID'' – a unique identifier for this shift as it is known by your scheduling staff and not by payroll.

''Sort Order ''– the order that the shifts should be displayed in. It is important to display your shifts in the order that they occur in. Not all facilities consider the Day shift to be the first shift of the day.

''Shift Cut Off Time'' – used in conjunction with the shift cut off feature in the pay rules, this is typically set to 4 hours before the start time of schedules that belong to that shift, e.g. 11 am for the Evening shift.

''Shift Color'' – the color that this shift is represented by in the scheduler, and in the employee's [[Employee Schedules|Schedules]] tab

''Pay Date to Actual Date Offset'' - the pay date and the actual date are generally the same (Day Of) for the Day and Evening shifts. The Night shift is often considered to be the day after the Pay Date, or to rephrase this, the Pay Date is the Day Before the Actual Date. When calculating Holiday Overtime, if this setting is Day Before, an employee that works the day before a holiday will be considered to be working on the holiday.

''Pay Type 1 through 5'' – the pay type to use for calculations can be delegated to the Shifts configuration. This allows a different pay type to be paid based upon the shift being used in the calculation.

''Move Hours 1 through 5'' – the hours calculated using the pay type can be moved or added (if not checked).

=== Sub Shifts ===

Sub shifts further subdivide the Shifts and act as an unique identifier of 2 or more objects that have the same shift, e.g. you often have more than one base schedule within the shift, so the sub shift allows you to identify each base schedule with both a shift and a sub shift.

== See also ==

* [[Configuration]]

System Configuration

2016-05-10T18:29:16Z

Deb:

The system configuration is a combination of system wide and feature specific settings.

== General ==

Hour Format – times are displayed either in 24-hour format (also known as [http://en.wikipedia.org/wiki/24-hour_clock#Military_time military time]) or in 12-hour format (AM/PM). The hour format is enforced across the complete system and is not changeable on a per user basis.

Employee Name Format – an employee's full name is a composite of the employee’s first name, initial and last name. This setting is used to specify if the full name should be in the format of Last, First or First, Last.

Effective Date Determination - provides a date reference in order to determine what the employee's current settings. This is used for all information that displays in the [[Employee History|employee's history]] tab. If the date of a historical change occurs on or before the date that is selected in this setting, then that would be considered to be the employee's current setting.

Employee Data Load Date – time card data before this date is not pulled from the database unless the Display Older Data button is selected (Home tab / Employees group). Limiting the amount of data loaded for each employee can decrease the load time as you navigate from employee to employee.

Pay Holidays – if turned off, then the software does not perform any holiday-based calculations of both worked and unworked time. This setting enables you to stop the calculation of all holidays for all employees without modifying the [[Holidays Configuration|Holidays configuration]].

Use Non Zero Shift Count for Holiday Seniority - when calculating holiday seniority, the employee's hire date is used unless this is selected, in which case it will use the first non-zero shift count entry in the employee's [[Employee Work Pattern|work pattern]] tab.

Use Non Zero Shift Count for Worked Holiday Seniority - when calculating worked holiday seniority, the employee's hire date is used unless this is selected, in which case it will use the first non-zero shift count entry in the employee's [[Employee Work Pattern|work pattern]] tab.

Enforce Reasons – users must select a [[Reasons Configuration|reason]] when they make changes to the punches, hours or schedules.

DST Calculation (Spring - minus 1 hour) - hours that pass through the daylight savings time change will calculate one hour less because the employee is not working the one hour between 2am and 3am.

DST Calculation (Fall - plus 1 hour) - hours that pass through the daylight savings time change will calculate one hour morebecause the employee is working the one hour between 1am and 2am twice.

Using Pay Rates – pay rates will be displayed throughout the software provided that the user has the authorizations to view pay rates. This is used for the gross calculation of dollars.

Close Pay Periods Past Pay Date – pay periods prior to the previous pay period are automatically closed to all users except those with the Administrator role.

Do Not Highlight / Underline Punch Edits - added or edited punches will display identically to punches that were made at the time clock.

Use Cumulative Break Calculator - punched breaks and lunches are commonly required to be taken per schedule. An employee cannot "double up" and take no lunch in their first schedule and then take a long lunch in their second schedule. This setting overrides this behavior allowing an employee to punch out for both lunches in either the first or second shift.

Use Pay Period Approval - users can approve the employee's time cards for the pay period. This stops any further calculation from occurring unless another user makes a change to the time card. Any change to the time card automatically removes the approval. A user can therefore be assured that the time card that they approved is unchanged if it still shows them as the approver.

== Defaults ==

Defaults for [[Pay Types Configuration|Pay Type]] and [[Shifts Configuration|Shift]] are required because calculations cannot be assigned to an unknown pay type or to an unknown shift. The other defaults are required on an “as needed” basis. For example, Available will not be a selection in Schedule Patterns if the Available Status Type has not been set.

== Time Clocks ==

Explicit Punching – explicit punching at the time clock and explicit punching in the software do not have to be identical. If explicit punching is turned on in the software, then punches entered in the software always require the designation of In, Out, Back from Break or Back from Lunch. This setting forces users to designate the punch type in the same manner as is required at the HandPunch.

Duplicate Punch Minutes – punches by the same employee that occur within this entered number of minutes from each other are considered to be "duplicate." The first punch of 2 or more punches that occur within this duplicate punch window is displayed, while the other punches are hidden (but not discarded). If explicit punching is being used, then the duplicate punch setting only applies to punches of the same punch type.

Unassigned Clock IDs Expiration Days – the number of days that you have to enter an employee into the software before the enrolled clock ID is considered unused and is removed from the clock. This stops the clock from getting filled up with incorrect numbers.

Unassigned Clock IDs Expiration Date – any clock ID that was last used prior to this date and does not belong to an employee entered into the software will be removed.

Hourly Tasks Minutes - clock [[tasks]] that run hourly will run when they start in the same minute as this setting.

Using Punching Zones – available when using the HandPunch 3000 and 4000 models, this enables punching restrictions using either schedule based restrictions or the punching zone drop-down on the employee's [[Employee Clock Info|Clock Info]] tab.

Use Multiple Threads – HandPunch communication occurs in a serial manner, in that the software communicates to one HandPunch followed by the next HandPunch and so on. This setting allows the software to communicate to all HandPunches at the same time. However, multiple copies of the RSI communication DLL are required.

No Communication Error Emails - when the software has an error communicating to a time clock, an automatic email is sent out. This setting turns this email notifications off.

Hourly Communication Emails - if the clock task gets an error and started in the same minute as the Hourly Tasks Minute, then an email will be sent.

Lunch Taken Exceptions - calculates exceptions on out punches where the employee did not answer Yes to the Lunch Taken question at the HandPunch.

== Labor Levels ==

Defines the labor levels being used in the software. If you need to add more labor levels and you wish to position them above existing labor levels, then use the Sort Order to make them appear in the desired order.

Labor Levels Used – the number of labor levels used in the software.

Labor Level ID – the short identifier or number for this labor level.

Labor Level Description – a longer description or name for this labor level.

T S R B Check boxes

Time based labor levels are the labor levels that will be used in the time cards and what the user working on time cards needs to see. Department is generally always a time based labor level.

Scheduling labor levels are the labor levels that are available in the employee's schedule pattern. The Unit or Floor labor level is generally always a scheduling labor level, and if cross-departmental scheduling is allowed, then Departmental would also be a scheduling labor level.

Restricted scheduling labor levels enforce that the choice of the available labor level items in the schedule patterns is restricted. For example, if Department is a scheduling labor level, then you most likely will have restrictions on what departments an employee can work in, based on their home department.

Budgeting labor levels are the labor levels that are visible when entering the [[Budget|budgets]]. Typically, these are a budgetary labor level, and the Floor/Unit labor level.

== Labor Level Designations ==

These settings are similar to the Defaults except that these apply to the labor levels. The software has the expectation that certain labor levels are defined as representing, for example, the departmental level. An example of this is payroll interface. The payroll file may require placing the department ID in the file, therefore the software needs to know explicitly what labor level represents the departments.

== Labor Level Assignments ==

Labor level assignments represent a relationship between a labor level combination and other objects in the software such as a base schedule group, a scheduler period group, or another labor level.

The base schedule group assignment is used to define the base schedules that will be available to choose from, when entering an employee's schedule pattern. The labor levels selected in the schedule pattern will link to a base schedule group, and this base schedule group provides the selection of base schedules.

The scheduler period group assignment is used to link a budget group to a scheduling period to accommodate employees being scheduled for different length periods.

The "allowable scheduling labor levels" are used in conjunction with the Restricted setting in the Labor Levels tab (see above). Based on the employee's home labor levels, the software can determine the allowable scheduling labor levels. For example, an RN can be scheduled to cover an LPN position.

The "one to one" assignment allows one labor level item to be linked to another labor level item (items from different labor levels). For example, a department can be linked to a budget group. If you change an employee's department, then you automatically change their budget group.

== Pictures / Signatures ==

Display Pictures – allows pictures to be selected and displayed on the employee main tab.

Display BadgeMaker Pictures – displays the pictures that are used by the BadgeMaker software in the employee main tab.

Picture Folder – the folder where all pictures are placed so that they are visible for all users.

Display Signatures – allows signature capture from signature pads from Topaz Systems.

== Shift Count Lookup ==

The values for the calculated or default amount of hours paid based on an employee’s shift count. This is used when there is not a proportioned sliding scale of hours paid based on the employee’s shift count.

== Health ==

These settings allow health requirements to be required on a repeating time frame such as annually, only required one time, or not required at all.

== Exceptions ==

Toggles exceptions on or off for Break Deductions, Under Shift and Over Shift count.

== Payroll ==

Payroll File Path – the default path and file name that the payroll file will be created in.

Alternate Payroll File Path – if you are using two different payroll interfaces, then for one payroll interface, you will need to select the option to use the alternate payroll settings. The payroll file will then be created using this path and file name.

External Payroll Import Date – if external payroll information is being imported into the software, then this is the date that the information has been imported to.

Company / Client ID – if your payroll file requires an ID based on your company, then this is where that ID is set.

Allow Pre Paid Hours – provides an additional checkbox when adding Other Hours that can be used for filtering a payroll file. This is typically used when a manual check is issued immediately and a record is required in the software. However, these hours will not be needed in a future payroll file, because this would result in a double payment.

Allow Check Number – provides a check number field when adding Other Hours. This field can then be used to filter a payroll file, pass the check number in a payroll file, or create multiple payroll files (based on the check number). The method of utilization depends on the payroll export being used.

== Scheduling ==

Start Date – The start date is used as the default start date for new employees that are assigned a schedule pattern type, instead of the employee’s hire date.

No Schedule Pattern Text – if an employee is not assigned to a schedule pattern, then that day will show as a blank line. This setting allows for some test to show rather than no text. After selecting the drop down in the Shift column in schedule patterns, pressing the first letter of this text will remove the schedule pattern. This can be quicker than selecting the first line from the schedule pattern drop down.

Sort Schedule Pattern Dropdown with Default Schedule First For Shift – when using keystrokes to select the schedule patterns, having the default schedule as the first for each shift will allow you to use a single keystroke to assign the default schedule for the shift.

== Scheduler ==

These settings are used in the layout and display of the Scheduler screen.

The color settings dictate the colors used for the cell borders or text, based on the schedule, punch or exception information.

The Scheduler column count determines how many employee information columns the Scheduler will display, and what the column uses for its caption, width, and the information it will display. The Filter setting allows this column to be used for filtering only and not display as a column.

The column widths for the employee information and availables should match so that the date columns are aligned.

== See also ==

* [[Configuration]]

System Configuration

2016-05-10T18:27:58Z

Deb: /* Labor Levels */

The system configuration is a combination of system wide and feature specific settings.

== General ==

Hour Format – times are displayed either in 24-hour format (also known as [http://en.wikipedia.org/wiki/24-hour_clock#Military_time military time]) or in 12-hour format (AM/PM). The hour format is enforced across the complete system and is not changeable on a per user basis.

Employee Name Format – an employee's full name is a composite of the employee’s first name, initial and last name. This setting is used to specify if the full name should be in the format of Last, First or First, Last.

Effective Date Determination - provides a date reference in order to determine what the employee's current settings. This is used for all information that displays in the [[Employee History|employee's history]] tab. If the date of a historical change occurs on or before the date that is selected in this setting, then that would be considered to be the employee's current setting.

Employee Data Load Date – time card data before this date is not pulled from the database unless the Display Older Data button is selected (Home tab / Employees group). Limiting the amount of data loaded for each employee can decrease the load time as you navigate from employee to employee.

Pay Holidays – if turned off, then the software does not perform any holiday-based calculations of both worked and unworked time. This setting enables you to stop the calculation of all holidays for all employees without modifying the [[Holidays Configuration|Holidays configuration]].

Use Non Zero Shift Count for Holiday Seniority - when calculating holiday seniority, the employee's hire date is used unless this is selected, in which case it will use the first non-zero shift count entry in the employee's [[Employee Work Pattern|work pattern]] tab.

Use Non Zero Shift Count for Worked Holiday Seniority - when calculating worked holiday seniority, the employee's hire date is used unless this is selected, in which case it will use the first non-zero shift count entry in the employee's [[Employee Work Pattern|work pattern]] tab.

Enforce Reasons – users must select a [[Reasons Configuration|reason]] when they make changes to the punches, hours or schedules.

DST Calculation (Spring - minus 1 hour) - hours that pass through the daylight savings time change will calculate one hour less because the employee is not working the one hour between 2am and 3am.

DST Calculation (Fall - plus 1 hour) - hours that pass through the daylight savings time change will calculate one hour morebecause the employee is working the one hour between 1am and 2am twice.

Using Pay Rates – pay rates will be displayed throughout the software provided that the user has the authorizations to view pay rates. This is used for the gross calculation of dollars.

Close Pay Periods Past Pay Date – pay periods prior to the previous pay period are automatically closed to all users except those with the Administrator role.

Do Not Highlight / Underline Punch Edits - added or edited punches will display identically to punches that were made at the time clock.

Use Cumulative Break Calculator - punched breaks and lunches are commonly required to be taken per schedule. An employee cannot "double up" and take no lunch in their first schedule and then take a long lunch in their second schedule. This setting overrides this behavior allowing an employee to punch out for both lunches in either the first or second shift.

Use Pay Period Approval - users can approve the employee's time cards for the pay period. This stops any further calculation from occurring unless another user makes a change to the time card. Any change to the time card automatically removes the approval. A user can therefore be assured that the time card that they approved is unchanged if it still shows them as the approver.

== Defaults ==

Defaults for [[Pay Types Configuration|Pay Type]] and [[Shifts Configuration|Shift]] are required because calculations cannot be assigned to an unknown pay type or to an unknown shift. The other defaults are required on an “as needed” basis. For example, Available will not be a selection in Schedule Patterns if the Available Status Type has not been set.

== Time Clocks ==

Explicit Punching – explicit punching at the time clock and explicit punching in the software do not have to be identical. If explicit punching is turned on in the software, then punches entered in the software always require the designation of In, Out, Back from Break or Back from Lunch. This setting forces users to designate the punch type in the same manner as is required at the HandPunch.

Duplicate Punch Minutes – punches by the same employee that occur within this entered number of minutes from each other are considered to be "duplicate." The first punch of 2 or more punches that occur within this duplicate punch window is displayed, while the other punches are hidden (but not discarded). If explicit punching is being used, then the duplicate punch setting only applies to punches of the same punch type.

Unassigned Clock IDs Expiration Days – the number of days that you have to enter an employee into the software before the enrolled clock ID is considered unused and is removed from the clock. This stops the clock from getting filled up with incorrect numbers.

Unassigned Clock IDs Expiration Date – any clock ID that was last used prior to this date and does not belong to an employee entered into the software will be removed.

Hourly Tasks Minutes - clock [[tasks]] that run hourly will run when they start in the same minute as this setting.

Using Punching Zones – available when using the HandPunch 3000 and 4000 models, this enables punching restrictions using either schedule based restrictions or the punching zone drop-down on the employee's [[Employee Clock Info|Clock Info]] tab.

Use Multiple Threads – HandPunch communication occurs in a serial manner, in that the software communicates to one HandPunch followed by the next HandPunch and so on. This setting allows the software to communicate to all HandPunches at the same time. However, multiple copies of the RSI communication DLL are required.

No Communication Error Emails - when the software has an error communicating to a time clock, an automatic email is sent out. This setting turns this email notifications off.

Hourly Communication Emails - if the clock task gets an error and started in the same minute as the Hourly Tasks Minute, then an email will be sent.

Lunch Taken Exceptions - calculates exceptions on out punches where the employee did not answer Yes to the Lunch Taken question at the HandPunch.

== Labor Levels ==

Defines the labor levels being used in the software. If you need to add more labor levels and you wish to position them above existing labor levels, then use the Sort Order to make them appear in the desired order.

Labor Levels Used – the number of labor levels used in the software.

Labor Level ID – the short identifier or number for this labor level.

Labor Level Description – a longer description or name for this labor level.

T S R B Check boxes

Time based labor levels are the labor levels that will be used in the time cards and what the user working on time cards needs to see. Department is generally always a time based labor level.

Scheduling labor levels are the labor levels that are available in the employee's schedule pattern. The Unit or Floor labor level is generally always a scheduling labor level, and if cross-departmental scheduling is allowed, then Departmental would also be a scheduling labor level.

Restricted scheduling labor levels enforce that the choice of the available labor level items in the schedule patterns is restricted. For example, if Department is a scheduling labor level, then you most likely will have restrictions on what departments an employee can work in, based on their home department.

Budgeting labor levels are the labor levels that are visible when entering the [[Budget|budgets]]. Typically, these are a budgetary labor level, and the Floor/Unit labor level.
[[image:LaborLevelSetup.png]]

== Labor Level Designations ==

These settings are similar to the Defaults except that these apply to the labor levels. The software has the expectation that certain labor levels are defined as representing, for example, the departmental level. An example of this is payroll interface. The payroll file may require placing the department ID in the file, therefore the software needs to know explicitly what labor level represents the departments.

== Labor Level Assignments ==

Labor level assignments represent a relationship between a labor level combination and other objects in the software such as a base schedule group, a scheduler period group, or another labor level.

The base schedule group assignment is used to define the base schedules that will be available to choose from, when entering an employee's schedule pattern. The labor levels selected in the schedule pattern will link to a base schedule group, and this base schedule group provides the selection of base schedules.

The scheduler period group assignment is used to link a budget group to a scheduling period to accommodate employees being scheduled for different length periods.

The "allowable scheduling labor levels" are used in conjunction with the Restricted setting in the Labor Levels tab (see above). Based on the employee's home labor levels, the software can determine the allowable scheduling labor levels. For example, an RN can be scheduled to cover an LPN position.

The "one to one" assignment allows one labor level item to be linked to another labor level item (items from different labor levels). For example, a department can be linked to a budget group. If you change an employee's department, then you automatically change their budget group.

== Pictures / Signatures ==

Display Pictures – allows pictures to be selected and displayed on the employee main tab.

Display BadgeMaker Pictures – displays the pictures that are used by the BadgeMaker software in the employee main tab.

Picture Folder – the folder where all pictures are placed so that they are visible for all users.

Display Signatures – allows signature capture from signature pads from Topaz Systems.

== Shift Count Lookup ==

The values for the calculated or default amount of hours paid based on an employee’s shift count. This is used when there is not a proportioned sliding scale of hours paid based on the employee’s shift count.

== Health ==

These settings allow health requirements to be required on a repeating time frame such as annually, only required one time, or not required at all.

== Exceptions ==

Toggles exceptions on or off for Break Deductions, Under Shift and Over Shift count.

== Payroll ==

Payroll File Path – the default path and file name that the payroll file will be created in.

Alternate Payroll File Path – if you are using two different payroll interfaces, then for one payroll interface, you will need to select the option to use the alternate payroll settings. The payroll file will then be created using this path and file name.

External Payroll Import Date – if external payroll information is being imported into the software, then this is the date that the information has been imported to.

Company / Client ID – if your payroll file requires an ID based on your company, then this is where that ID is set.

Allow Pre Paid Hours – provides an additional checkbox when adding Other Hours that can be used for filtering a payroll file. This is typically used when a manual check is issued immediately and a record is required in the software. However, these hours will not be needed in a future payroll file, because this would result in a double payment.

Allow Check Number – provides a check number field when adding Other Hours. This field can then be used to filter a payroll file, pass the check number in a payroll file, or create multiple payroll files (based on the check number). The method of utilization depends on the payroll export being used.

== Scheduling ==

Start Date – The start date is used as the default start date for new employees that are assigned a schedule pattern type, instead of the employee’s hire date.

No Schedule Pattern Text – if an employee is not assigned to a schedule pattern, then that day will show as a blank line. This setting allows for some test to show rather than no text. After selecting the drop down in the Shift column in schedule patterns, pressing the first letter of this text will remove the schedule pattern. This can be quicker than selecting the first line from the schedule pattern drop down.

Sort Schedule Pattern Dropdown with Default Schedule First For Shift – when using keystrokes to select the schedule patterns, having the default schedule as the first for each shift will allow you to use a single keystroke to assign the default schedule for the shift.

== Scheduler ==

These settings are used in the layout and display of the Scheduler screen.

The color settings dictate the colors used for the cell borders or text, based on the schedule, punch or exception information.

The Scheduler column count determines how many employee information columns the Scheduler will display, and what the column uses for its caption, width, and the information it will display. The Filter setting allows this column to be used for filtering only and not display as a column.

The column widths for the employee information and availables should match so that the date columns are aligned.

== See also ==

* [[Configuration]]

Pay Types Configuration

2016-05-10T18:27:44Z

Deb: /* Pay Types */

==Pay Types==

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'''

''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'''

''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.

'''Lookups'''

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'''

'''Attendance Calendar'''

''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.

'''Rates and Payroll'''

''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.

== See also ==

* [[Configuration]]

File:LaborLevelSetup.png

2016-05-10T18:12:02Z

Deb:

System Configuration

2016-05-10T18:11:46Z

Deb: /* Labor Levels */

The system configuration is a combination of system wide and feature specific settings.

== General ==

Hour Format – times are displayed either in 24-hour format (also known as [http://en.wikipedia.org/wiki/24-hour_clock#Military_time military time]) or in 12-hour format (AM/PM). The hour format is enforced across the complete system and is not changeable on a per user basis.

Employee Name Format – an employee's full name is a composite of the employee’s first name, initial and last name. This setting is used to specify if the full name should be in the format of Last, First or First, Last.

Effective Date Determination - provides a date reference in order to determine what the employee's current settings. This is used for all information that displays in the [[Employee History|employee's history]] tab. If the date of a historical change occurs on or before the date that is selected in this setting, then that would be considered to be the employee's current setting.

Employee Data Load Date – time card data before this date is not pulled from the database unless the Display Older Data button is selected (Home tab / Employees group). Limiting the amount of data loaded for each employee can decrease the load time as you navigate from employee to employee.

Pay Holidays – if turned off, then the software does not perform any holiday-based calculations of both worked and unworked time. This setting enables you to stop the calculation of all holidays for all employees without modifying the [[Holidays Configuration|Holidays configuration]].

Use Non Zero Shift Count for Holiday Seniority - when calculating holiday seniority, the employee's hire date is used unless this is selected, in which case it will use the first non-zero shift count entry in the employee's [[Employee Work Pattern|work pattern]] tab.

Use Non Zero Shift Count for Worked Holiday Seniority - when calculating worked holiday seniority, the employee's hire date is used unless this is selected, in which case it will use the first non-zero shift count entry in the employee's [[Employee Work Pattern|work pattern]] tab.

Enforce Reasons – users must select a [[Reasons Configuration|reason]] when they make changes to the punches, hours or schedules.

DST Calculation (Spring - minus 1 hour) - hours that pass through the daylight savings time change will calculate one hour less because the employee is not working the one hour between 2am and 3am.

DST Calculation (Fall - plus 1 hour) - hours that pass through the daylight savings time change will calculate one hour morebecause the employee is working the one hour between 1am and 2am twice.

Using Pay Rates – pay rates will be displayed throughout the software provided that the user has the authorizations to view pay rates. This is used for the gross calculation of dollars.

Close Pay Periods Past Pay Date – pay periods prior to the previous pay period are automatically closed to all users except those with the Administrator role.

Do Not Highlight / Underline Punch Edits - added or edited punches will display identically to punches that were made at the time clock.

Use Cumulative Break Calculator - punched breaks and lunches are commonly required to be taken per schedule. An employee cannot "double up" and take no lunch in their first schedule and then take a long lunch in their second schedule. This setting overrides this behavior allowing an employee to punch out for both lunches in either the first or second shift.

Use Pay Period Approval - users can approve the employee's time cards for the pay period. This stops any further calculation from occurring unless another user makes a change to the time card. Any change to the time card automatically removes the approval. A user can therefore be assured that the time card that they approved is unchanged if it still shows them as the approver.

== Defaults ==

Defaults for [[Pay Types Configuration|Pay Type]] and [[Shifts Configuration|Shift]] are required because calculations cannot be assigned to an unknown pay type or to an unknown shift. The other defaults are required on an “as needed” basis. For example, Available will not be a selection in Schedule Patterns if the Available Status Type has not been set.

== Time Clocks ==

Explicit Punching – explicit punching at the time clock and explicit punching in the software do not have to be identical. If explicit punching is turned on in the software, then punches entered in the software always require the designation of In, Out, Back from Break or Back from Lunch. This setting forces users to designate the punch type in the same manner as is required at the HandPunch.

Duplicate Punch Minutes – punches by the same employee that occur within this entered number of minutes from each other are considered to be "duplicate." The first punch of 2 or more punches that occur within this duplicate punch window is displayed, while the other punches are hidden (but not discarded). If explicit punching is being used, then the duplicate punch setting only applies to punches of the same punch type.

Unassigned Clock IDs Expiration Days – the number of days that you have to enter an employee into the software before the enrolled clock ID is considered unused and is removed from the clock. This stops the clock from getting filled up with incorrect numbers.

Unassigned Clock IDs Expiration Date – any clock ID that was last used prior to this date and does not belong to an employee entered into the software will be removed.

Hourly Tasks Minutes - clock [[tasks]] that run hourly will run when they start in the same minute as this setting.

Using Punching Zones – available when using the HandPunch 3000 and 4000 models, this enables punching restrictions using either schedule based restrictions or the punching zone drop-down on the employee's [[Employee Clock Info|Clock Info]] tab.

Use Multiple Threads – HandPunch communication occurs in a serial manner, in that the software communicates to one HandPunch followed by the next HandPunch and so on. This setting allows the software to communicate to all HandPunches at the same time. However, multiple copies of the RSI communication DLL are required.

No Communication Error Emails - when the software has an error communicating to a time clock, an automatic email is sent out. This setting turns this email notifications off.

Hourly Communication Emails - if the clock task gets an error and started in the same minute as the Hourly Tasks Minute, then an email will be sent.

Lunch Taken Exceptions - calculates exceptions on out punches where the employee did not answer Yes to the Lunch Taken question at the HandPunch.

== Labor Levels ==

[[image:LaborLevelConfig.png]]

Defines the labor levels being used in the software. If you need to add more labor levels and you wish to position them above existing labor levels, then use the Sort Order to make them appear in the desired order.

Labor Levels Used – the number of labor levels used in the software.

Labor Level ID – the short identifier or number for this labor level.

Labor Level Description – a longer description or name for this labor level.

T S R B Check boxes

Time based labor levels are the labor levels that will be used in the time cards and what the user working on time cards needs to see. Department is generally always a time based labor level.

Scheduling labor levels are the labor levels that are available in the employee's schedule pattern. The Unit or Floor labor level is generally always a scheduling labor level, and if cross-departmental scheduling is allowed, then Departmental would also be a scheduling labor level.

Restricted scheduling labor levels enforce that the choice of the available labor level items in the schedule patterns is restricted. For example, if Department is a scheduling labor level, then you most likely will have restrictions on what departments an employee can work in, based on their home department.

Budgeting labor levels are the labor levels that are visible when entering the [[Budget|budgets]]. Typically, these are a budgetary labor level, and the Floor/Unit labor level.
[[image:LaborLevelSetup.png]]

== Labor Level Designations ==

These settings are similar to the Defaults except that these apply to the labor levels. The software has the expectation that certain labor levels are defined as representing, for example, the departmental level. An example of this is payroll interface. The payroll file may require placing the department ID in the file, therefore the software needs to know explicitly what labor level represents the departments.

== Labor Level Assignments ==

Labor level assignments represent a relationship between a labor level combination and other objects in the software such as a base schedule group, a scheduler period group, or another labor level.

The base schedule group assignment is used to define the base schedules that will be available to choose from, when entering an employee's schedule pattern. The labor levels selected in the schedule pattern will link to a base schedule group, and this base schedule group provides the selection of base schedules.

The scheduler period group assignment is used to link a budget group to a scheduling period to accommodate employees being scheduled for different length periods.

The "allowable scheduling labor levels" are used in conjunction with the Restricted setting in the Labor Levels tab (see above). Based on the employee's home labor levels, the software can determine the allowable scheduling labor levels. For example, an RN can be scheduled to cover an LPN position.

The "one to one" assignment allows one labor level item to be linked to another labor level item (items from different labor levels). For example, a department can be linked to a budget group. If you change an employee's department, then you automatically change their budget group.

== Pictures / Signatures ==

Display Pictures – allows pictures to be selected and displayed on the employee main tab.

Display BadgeMaker Pictures – displays the pictures that are used by the BadgeMaker software in the employee main tab.

Picture Folder – the folder where all pictures are placed so that they are visible for all users.

Display Signatures – allows signature capture from signature pads from Topaz Systems.

== Shift Count Lookup ==

The values for the calculated or default amount of hours paid based on an employee’s shift count. This is used when there is not a proportioned sliding scale of hours paid based on the employee’s shift count.

== Health ==

These settings allow health requirements to be required on a repeating time frame such as annually, only required one time, or not required at all.

== Exceptions ==

Toggles exceptions on or off for Break Deductions, Under Shift and Over Shift count.

== Payroll ==

Payroll File Path – the default path and file name that the payroll file will be created in.

Alternate Payroll File Path – if you are using two different payroll interfaces, then for one payroll interface, you will need to select the option to use the alternate payroll settings. The payroll file will then be created using this path and file name.

External Payroll Import Date – if external payroll information is being imported into the software, then this is the date that the information has been imported to.

Company / Client ID – if your payroll file requires an ID based on your company, then this is where that ID is set.

Allow Pre Paid Hours – provides an additional checkbox when adding Other Hours that can be used for filtering a payroll file. This is typically used when a manual check is issued immediately and a record is required in the software. However, these hours will not be needed in a future payroll file, because this would result in a double payment.

Allow Check Number – provides a check number field when adding Other Hours. This field can then be used to filter a payroll file, pass the check number in a payroll file, or create multiple payroll files (based on the check number). The method of utilization depends on the payroll export being used.

== Scheduling ==

Start Date – The start date is used as the default start date for new employees that are assigned a schedule pattern type, instead of the employee’s hire date.

No Schedule Pattern Text – if an employee is not assigned to a schedule pattern, then that day will show as a blank line. This setting allows for some test to show rather than no text. After selecting the drop down in the Shift column in schedule patterns, pressing the first letter of this text will remove the schedule pattern. This can be quicker than selecting the first line from the schedule pattern drop down.

Sort Schedule Pattern Dropdown with Default Schedule First For Shift – when using keystrokes to select the schedule patterns, having the default schedule as the first for each shift will allow you to use a single keystroke to assign the default schedule for the shift.

== Scheduler ==

These settings are used in the layout and display of the Scheduler screen.

The color settings dictate the colors used for the cell borders or text, based on the schedule, punch or exception information.

The Scheduler column count determines how many employee information columns the Scheduler will display, and what the column uses for its caption, width, and the information it will display. The Filter setting allows this column to be used for filtering only and not display as a column.

The column widths for the employee information and availables should match so that the date columns are aligned.

== See also ==

* [[Configuration]]

Pay Types Configuration

2016-05-10T18:07:57Z

Deb: /* Pay Types */

==Pay Types==

[[image:PayTypeConfig.png|700px|Left]] [[image:PayTypeConfigScreen.png|850px|Right]]

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'''

''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'''

''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.

'''Lookups'''

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'''

'''Attendance Calendar'''

''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.

'''Rates and Payroll'''

''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.

== See also ==

* [[Configuration]]

Pay Types Configuration

2016-05-10T18:07:39Z

Deb: /* Pay Types */

==Pay Types==

[[image:PayTypeConfig.png|800px|Left]] [[image:PayTypeConfigScreen.png|800px|Right]]

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'''

''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'''

''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.

'''Lookups'''

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'''

'''Attendance Calendar'''

''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.

'''Rates and Payroll'''

''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.

== See also ==

* [[Configuration]]

File:PayTypeConfigScreen.png

2016-05-10T18:07:13Z

Deb:

File:PayTypeConfig.png

2016-05-10T18:05:54Z

Deb:

File:ShiftConfigScreen.png

2016-05-10T18:05:07Z

Deb: Deb uploaded a new version of "File:ShiftConfigScreen.png"

Pay Types Configuration

2016-05-10T18:03:36Z

Deb: /* Pay Types */

==Pay Types==

[[image:PayTypeConfig.png|850px|Left]] [[image:PayTypeConfigScreen.png|700px|Right]]

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'''

''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'''

''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.

'''Lookups'''

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'''

'''Attendance Calendar'''

''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.

'''Rates and Payroll'''

''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.

== See also ==

* [[Configuration]]

Shifts Configuration

2016-05-10T18:02:04Z

Deb:

[[image:ShiftConfig.png|850px|Left]] [[image:ShiftConfigScreen.png|700px|Right]]

Shifts are a simple, but powerful feature of the software. Shifts are used throughout the software to subdivide the pay date into segments. Typically there are 3 shifts in the day, Day, Evening and Night, but you can name them as you need, and define what the first shift of the day is.

''Shift ID'' – a unique identifier for this shift.

''Scheduler ID'' – a unique identifier for this shift as it is known by your scheduling staff and not by payroll.

''Sort Order ''– the order that the shifts should be displayed in. It is important to display your shifts in the order that they occur in. Not all facilities consider the Day shift to be the first shift of the day.

''Shift Cut Off Time'' – used in conjunction with the shift cut off feature in the pay rules, this is typically set to 4 hours before the start time of schedules that belong to that shift, e.g. 11 am for the Evening shift.

''Shift Color'' – the color that this shift is represented by in the scheduler, and in the employee's [[Employee Schedules|Schedules]] tab

''Pay Date to Actual Date Offset'' - the pay date and the actual date are generally the same (Day Of) for the Day and Evening shifts. The Night shift is often considered to be the day after the Pay Date, or to rephrase this, the Pay Date is the Day Before the Actual Date. When calculating Holiday Overtime, if this setting is Day Before, an employee that works the day before a holiday will be considered to be working on the holiday.

''Pay Type 1 through 5'' – the pay type to use for calculations can be delegated to the Shifts configuration. This allows a different pay type to be paid based upon the shift being used in the calculation.

''Move Hours 1 through 5'' – the hours calculated using the pay type can be moved or added (if not checked).

=== Sub Shifts ===

Sub shifts further subdivide the Shifts and act as an unique identifier of 2 or more objects that have the same shift, e.g. you often have more than one base schedule within the shift, so the sub shift allows you to identify each base schedule with both a shift and a sub shift.

== See also ==

* [[Configuration]]

Shifts Configuration

2016-05-10T18:01:52Z

Deb:

[[image:ShiftConfig.png|50px|Left]] [[image:ShiftConfigScreen.png|700px|Right]]

Shifts are a simple, but powerful feature of the software. Shifts are used throughout the software to subdivide the pay date into segments. Typically there are 3 shifts in the day, Day, Evening and Night, but you can name them as you need, and define what the first shift of the day is.

''Shift ID'' – a unique identifier for this shift.

''Scheduler ID'' – a unique identifier for this shift as it is known by your scheduling staff and not by payroll.

''Sort Order ''– the order that the shifts should be displayed in. It is important to display your shifts in the order that they occur in. Not all facilities consider the Day shift to be the first shift of the day.

''Shift Cut Off Time'' – used in conjunction with the shift cut off feature in the pay rules, this is typically set to 4 hours before the start time of schedules that belong to that shift, e.g. 11 am for the Evening shift.

''Shift Color'' – the color that this shift is represented by in the scheduler, and in the employee's [[Employee Schedules|Schedules]] tab

''Pay Date to Actual Date Offset'' - the pay date and the actual date are generally the same (Day Of) for the Day and Evening shifts. The Night shift is often considered to be the day after the Pay Date, or to rephrase this, the Pay Date is the Day Before the Actual Date. When calculating Holiday Overtime, if this setting is Day Before, an employee that works the day before a holiday will be considered to be working on the holiday.

''Pay Type 1 through 5'' – the pay type to use for calculations can be delegated to the Shifts configuration. This allows a different pay type to be paid based upon the shift being used in the calculation.

''Move Hours 1 through 5'' – the hours calculated using the pay type can be moved or added (if not checked).

=== Sub Shifts ===

Sub shifts further subdivide the Shifts and act as an unique identifier of 2 or more objects that have the same shift, e.g. you often have more than one base schedule within the shift, so the sub shift allows you to identify each base schedule with both a shift and a sub shift.

== See also ==

* [[Configuration]]

File:ShiftConfigScreen.png

2016-05-10T17:57:57Z

Deb:

Shifts Configuration

2016-05-10T17:57:45Z

Deb:

[[image:ShiftConfig.png|Left]] [[image:ShiftConfigScreen.png|Right]]

Shifts are a simple, but powerful feature of the software. Shifts are used throughout the software to subdivide the pay date into segments. Typically there are 3 shifts in the day, Day, Evening and Night, but you can name them as you need, and define what the first shift of the day is.

''Shift ID'' – a unique identifier for this shift.

''Scheduler ID'' – a unique identifier for this shift as it is known by your scheduling staff and not by payroll.

''Sort Order ''– the order that the shifts should be displayed in. It is important to display your shifts in the order that they occur in. Not all facilities consider the Day shift to be the first shift of the day.

''Shift Cut Off Time'' – used in conjunction with the shift cut off feature in the pay rules, this is typically set to 4 hours before the start time of schedules that belong to that shift, e.g. 11 am for the Evening shift.

''Shift Color'' – the color that this shift is represented by in the scheduler, and in the employee's [[Employee Schedules|Schedules]] tab

''Pay Date to Actual Date Offset'' - the pay date and the actual date are generally the same (Day Of) for the Day and Evening shifts. The Night shift is often considered to be the day after the Pay Date, or to rephrase this, the Pay Date is the Day Before the Actual Date. When calculating Holiday Overtime, if this setting is Day Before, an employee that works the day before a holiday will be considered to be working on the holiday.

''Pay Type 1 through 5'' – the pay type to use for calculations can be delegated to the Shifts configuration. This allows a different pay type to be paid based upon the shift being used in the calculation.

''Move Hours 1 through 5'' – the hours calculated using the pay type can be moved or added (if not checked).

=== Sub Shifts ===

Sub shifts further subdivide the Shifts and act as an unique identifier of 2 or more objects that have the same shift, e.g. you often have more than one base schedule within the shift, so the sub shift allows you to identify each base schedule with both a shift and a sub shift.

== See also ==

* [[Configuration]]

File:ShiftConfig.png

2016-05-10T17:56:02Z

Deb:

Shifts Configuration

2016-05-10T17:55:51Z

Deb:

[[image:ShiftConfig.png]]

Shifts are a simple, but powerful feature of the software. Shifts are used throughout the software to subdivide the pay date into segments. Typically there are 3 shifts in the day, Day, Evening and Night, but you can name them as you need, and define what the first shift of the day is.

''Shift ID'' – a unique identifier for this shift.

''Scheduler ID'' – a unique identifier for this shift as it is known by your scheduling staff and not by payroll.

''Sort Order ''– the order that the shifts should be displayed in. It is important to display your shifts in the order that they occur in. Not all facilities consider the Day shift to be the first shift of the day.

''Shift Cut Off Time'' – used in conjunction with the shift cut off feature in the pay rules, this is typically set to 4 hours before the start time of schedules that belong to that shift, e.g. 11 am for the Evening shift.

''Shift Color'' – the color that this shift is represented by in the scheduler, and in the employee's [[Employee Schedules|Schedules]] tab

''Pay Date to Actual Date Offset'' - the pay date and the actual date are generally the same (Day Of) for the Day and Evening shifts. The Night shift is often considered to be the day after the Pay Date, or to rephrase this, the Pay Date is the Day Before the Actual Date. When calculating Holiday Overtime, if this setting is Day Before, an employee that works the day before a holiday will be considered to be working on the holiday.

''Pay Type 1 through 5'' – the pay type to use for calculations can be delegated to the Shifts configuration. This allows a different pay type to be paid based upon the shift being used in the calculation.

''Move Hours 1 through 5'' – the hours calculated using the pay type can be moved or added (if not checked).

=== Sub Shifts ===

Sub shifts further subdivide the Shifts and act as an unique identifier of 2 or more objects that have the same shift, e.g. you often have more than one base schedule within the shift, so the sub shift allows you to identify each base schedule with both a shift and a sub shift.

== See also ==

* [[Configuration]]

File:LaborLevelConfig.png

2016-05-10T17:50:55Z

Deb:

System Configuration

2016-05-10T17:50:19Z

Deb: /* Labor Levels */

The system configuration is a combination of system wide and feature specific settings.

== General ==

Hour Format – times are displayed either in 24-hour format (also known as [http://en.wikipedia.org/wiki/24-hour_clock#Military_time military time]) or in 12-hour format (AM/PM). The hour format is enforced across the complete system and is not changeable on a per user basis.

Employee Name Format – an employee's full name is a composite of the employee’s first name, initial and last name. This setting is used to specify if the full name should be in the format of Last, First or First, Last.

Effective Date Determination - provides a date reference in order to determine what the employee's current settings. This is used for all information that displays in the [[Employee History|employee's history]] tab. If the date of a historical change occurs on or before the date that is selected in this setting, then that would be considered to be the employee's current setting.

Employee Data Load Date – time card data before this date is not pulled from the database unless the Display Older Data button is selected (Home tab / Employees group). Limiting the amount of data loaded for each employee can decrease the load time as you navigate from employee to employee.

Pay Holidays – if turned off, then the software does not perform any holiday-based calculations of both worked and unworked time. This setting enables you to stop the calculation of all holidays for all employees without modifying the [[Holidays Configuration|Holidays configuration]].

Use Non Zero Shift Count for Holiday Seniority - when calculating holiday seniority, the employee's hire date is used unless this is selected, in which case it will use the first non-zero shift count entry in the employee's [[Employee Work Pattern|work pattern]] tab.

Use Non Zero Shift Count for Worked Holiday Seniority - when calculating worked holiday seniority, the employee's hire date is used unless this is selected, in which case it will use the first non-zero shift count entry in the employee's [[Employee Work Pattern|work pattern]] tab.

Enforce Reasons – users must select a [[Reasons Configuration|reason]] when they make changes to the punches, hours or schedules.

DST Calculation (Spring - minus 1 hour) - hours that pass through the daylight savings time change will calculate one hour less because the employee is not working the one hour between 2am and 3am.

DST Calculation (Fall - plus 1 hour) - hours that pass through the daylight savings time change will calculate one hour morebecause the employee is working the one hour between 1am and 2am twice.

Using Pay Rates – pay rates will be displayed throughout the software provided that the user has the authorizations to view pay rates. This is used for the gross calculation of dollars.

Close Pay Periods Past Pay Date – pay periods prior to the previous pay period are automatically closed to all users except those with the Administrator role.

Do Not Highlight / Underline Punch Edits - added or edited punches will display identically to punches that were made at the time clock.

Use Cumulative Break Calculator - punched breaks and lunches are commonly required to be taken per schedule. An employee cannot "double up" and take no lunch in their first schedule and then take a long lunch in their second schedule. This setting overrides this behavior allowing an employee to punch out for both lunches in either the first or second shift.

Use Pay Period Approval - users can approve the employee's time cards for the pay period. This stops any further calculation from occurring unless another user makes a change to the time card. Any change to the time card automatically removes the approval. A user can therefore be assured that the time card that they approved is unchanged if it still shows them as the approver.

== Defaults ==

Defaults for [[Pay Types Configuration|Pay Type]] and [[Shifts Configuration|Shift]] are required because calculations cannot be assigned to an unknown pay type or to an unknown shift. The other defaults are required on an “as needed” basis. For example, Available will not be a selection in Schedule Patterns if the Available Status Type has not been set.

== Time Clocks ==

Explicit Punching – explicit punching at the time clock and explicit punching in the software do not have to be identical. If explicit punching is turned on in the software, then punches entered in the software always require the designation of In, Out, Back from Break or Back from Lunch. This setting forces users to designate the punch type in the same manner as is required at the HandPunch.

Duplicate Punch Minutes – punches by the same employee that occur within this entered number of minutes from each other are considered to be "duplicate." The first punch of 2 or more punches that occur within this duplicate punch window is displayed, while the other punches are hidden (but not discarded). If explicit punching is being used, then the duplicate punch setting only applies to punches of the same punch type.

Unassigned Clock IDs Expiration Days – the number of days that you have to enter an employee into the software before the enrolled clock ID is considered unused and is removed from the clock. This stops the clock from getting filled up with incorrect numbers.

Unassigned Clock IDs Expiration Date – any clock ID that was last used prior to this date and does not belong to an employee entered into the software will be removed.

Hourly Tasks Minutes - clock [[tasks]] that run hourly will run when they start in the same minute as this setting.

Using Punching Zones – available when using the HandPunch 3000 and 4000 models, this enables punching restrictions using either schedule based restrictions or the punching zone drop-down on the employee's [[Employee Clock Info|Clock Info]] tab.

Use Multiple Threads – HandPunch communication occurs in a serial manner, in that the software communicates to one HandPunch followed by the next HandPunch and so on. This setting allows the software to communicate to all HandPunches at the same time. However, multiple copies of the RSI communication DLL are required.

No Communication Error Emails - when the software has an error communicating to a time clock, an automatic email is sent out. This setting turns this email notifications off.

Hourly Communication Emails - if the clock task gets an error and started in the same minute as the Hourly Tasks Minute, then an email will be sent.

Lunch Taken Exceptions - calculates exceptions on out punches where the employee did not answer Yes to the Lunch Taken question at the HandPunch.

== Labor Levels ==

[[image:LaborLevelConfig.png]]

Defines the labor levels being used in the software. If you need to add more labor levels and you wish to position them above existing labor levels, then use the Sort Order to make them appear in the desired order.

Labor Levels Used – the number of labor levels used in the software.

Labor Level ID – the short identifier or number for this labor level.

Labor Level Description – a longer description or name for this labor level.

T S R B Check boxes

Time based labor levels are the labor levels that will be used in the time cards and what the user working on time cards needs to see. Department is generally always a time based labor level.

Scheduling labor levels are the labor levels that are available in the employee's schedule pattern. The Unit or Floor labor level is generally always a scheduling labor level, and if cross-departmental scheduling is allowed, then Departmental would also be a scheduling labor level.

Restricted scheduling labor levels enforce that the choice of the available labor level items in the schedule patterns is restricted. For example, if Department is a scheduling labor level, then you most likely will have restrictions on what departments an employee can work in, based on their home department.

Budgeting labor levels are the labor levels that are visible when entering the [[Budget|budgets]]. Typically, these are a budgetary labor level, and the Floor/Unit labor level.

== Labor Level Designations ==

These settings are similar to the Defaults except that these apply to the labor levels. The software has the expectation that certain labor levels are defined as representing, for example, the departmental level. An example of this is payroll interface. The payroll file may require placing the department ID in the file, therefore the software needs to know explicitly what labor level represents the departments.

== Labor Level Assignments ==

Labor level assignments represent a relationship between a labor level combination and other objects in the software such as a base schedule group, a scheduler period group, or another labor level.

The base schedule group assignment is used to define the base schedules that will be available to choose from, when entering an employee's schedule pattern. The labor levels selected in the schedule pattern will link to a base schedule group, and this base schedule group provides the selection of base schedules.

The scheduler period group assignment is used to link a budget group to a scheduling period to accommodate employees being scheduled for different length periods.

The "allowable scheduling labor levels" are used in conjunction with the Restricted setting in the Labor Levels tab (see above). Based on the employee's home labor levels, the software can determine the allowable scheduling labor levels. For example, an RN can be scheduled to cover an LPN position.

The "one to one" assignment allows one labor level item to be linked to another labor level item (items from different labor levels). For example, a department can be linked to a budget group. If you change an employee's department, then you automatically change their budget group.

== Pictures / Signatures ==

Display Pictures – allows pictures to be selected and displayed on the employee main tab.

Display BadgeMaker Pictures – displays the pictures that are used by the BadgeMaker software in the employee main tab.

Picture Folder – the folder where all pictures are placed so that they are visible for all users.

Display Signatures – allows signature capture from signature pads from Topaz Systems.

== Shift Count Lookup ==

The values for the calculated or default amount of hours paid based on an employee’s shift count. This is used when there is not a proportioned sliding scale of hours paid based on the employee’s shift count.

== Health ==

These settings allow health requirements to be required on a repeating time frame such as annually, only required one time, or not required at all.

== Exceptions ==

Toggles exceptions on or off for Break Deductions, Under Shift and Over Shift count.

== Payroll ==

Payroll File Path – the default path and file name that the payroll file will be created in.

Alternate Payroll File Path – if you are using two different payroll interfaces, then for one payroll interface, you will need to select the option to use the alternate payroll settings. The payroll file will then be created using this path and file name.

External Payroll Import Date – if external payroll information is being imported into the software, then this is the date that the information has been imported to.

Company / Client ID – if your payroll file requires an ID based on your company, then this is where that ID is set.

Allow Pre Paid Hours – provides an additional checkbox when adding Other Hours that can be used for filtering a payroll file. This is typically used when a manual check is issued immediately and a record is required in the software. However, these hours will not be needed in a future payroll file, because this would result in a double payment.

Allow Check Number – provides a check number field when adding Other Hours. This field can then be used to filter a payroll file, pass the check number in a payroll file, or create multiple payroll files (based on the check number). The method of utilization depends on the payroll export being used.

== Scheduling ==

Start Date – The start date is used as the default start date for new employees that are assigned a schedule pattern type, instead of the employee’s hire date.

No Schedule Pattern Text – if an employee is not assigned to a schedule pattern, then that day will show as a blank line. This setting allows for some test to show rather than no text. After selecting the drop down in the Shift column in schedule patterns, pressing the first letter of this text will remove the schedule pattern. This can be quicker than selecting the first line from the schedule pattern drop down.

Sort Schedule Pattern Dropdown with Default Schedule First For Shift – when using keystrokes to select the schedule patterns, having the default schedule as the first for each shift will allow you to use a single keystroke to assign the default schedule for the shift.

== Scheduler ==

These settings are used in the layout and display of the Scheduler screen.

The color settings dictate the colors used for the cell borders or text, based on the schedule, punch or exception information.

The Scheduler column count determines how many employee information columns the Scheduler will display, and what the column uses for its caption, width, and the information it will display. The Filter setting allows this column to be used for filtering only and not display as a column.

The column widths for the employee information and availables should match so that the date columns are aligned.

== See also ==

* [[Configuration]]

Scheduler Period

2015-12-01T20:48:13Z

Deb:

Your scheduler periods will typically be from 1 week to 8 weeks in length. They can also be calendar month based. If you defined Scheduler Labor Levels then you can use different scheduler periods with each Scheduler Labor Level, e.g. Nursing schedules 4 weeks at a time, while Dietary works one week at a time. You create the relationship between a scheduler labor level and a scheduler period group in the [[System Configuration#Labor Level Assignments|System configuration / Labor Level Assignments]] tab.

== See also ==

* [[Scheduler Implementation]]
* [[Configuration]]

Scheduler Period

2015-12-01T20:47:18Z

Deb: /* Scheduler Periods */

Scheduler Period

2015-12-01T20:44:28Z

Deb: Created page with "== Scheduler Periods == Your scheduler periods will typically be from 1 week to 8 weeks in length. They can also be calendar month based. If you defined Scheduler Labor Leve..."

== Scheduler Periods ==

Your scheduler periods will typically be from 1 week to 8 weeks in length. They can also be calendar month based. If you defined Scheduler Labor Levels then you can use different scheduler periods with each Scheduler Labor Level, e.g. Nursing schedules 4 weeks at a time, while Dietary works one week at a time. You create the relationship between a scheduler labor level and a scheduler period group in the [[System Configuration#Labor Level Assignments|System configuration / Labor Level Assignments]] tab.

Scheduler Implementation

2015-11-23T18:59:33Z

Deb:

Scheduler implementation is comprised of 4 main steps:

* Configuration
**Define [[Labor Levels]]
**Define [[Budget]]
**Create [[Scheduler Period]]
**Create [[Base Schedules]]

* Data Entry
** Entering [[Employee Work Pattern|Work Patterns]]
** Entering [[Employee Scheduling|Schedule Patterns]]
** Entering [[Employee Scheduling|Planned Absences]]
* Reports
** Daily Staffing Sheet
** Monthly Schedule
* Using the [[Scheduler]]

Labor Levels

2015-11-23T18:26:42Z

Deb:

== Labor Levels ==

You need to define labor levels that represent the divisions between the type of job titles / position that employees work, and the different places that an employee can work within your facility. A very simple example is:

{| class="wikitable"

|-
! Nurse Type

|-
| RN

|-
| LPN

|-
| CNA

|}

{| class="wikitable"

|-
! Floor

|-
| 1st Floor

|-
| 2nd Floor

|-
| 3rd Floor

|}

You are defining two things:

# The names of the labor levels (Nurse Type and Floor)
# The items with each labor level (RN, LPN, CNA and 1st, 2nd and 3rd Floor).

In the software we would designate the Nurse Type to be the Budget Group Labor Level, and the Floor to be the Floor / Unit Labor Level. This designation is done in the [[System Configuration#Labor Level Designations|System configuration, Labor Level Designation ]] tab. Two labor levels are the minimum required to use the scheduler. There is one more level that is required when you need more than one scheduler in your software. If for example you want to schedule your nursing, dietary and housekeeping staff in three distinct groups then you would need to add a labor level for this and define this as the Scheduler Labor Level in the [[System Configuration#Labor Level Designations|System configuration, Labor Level Designations]] tab.

=== Department ===

You may think that your department labor level is already defined in the software and your budgeted staffing levels can be based on your department. In most facilities, there is often more than one department that would be considered to be RNs, LPNs, CNAs etc. If you have separate departments for agency employees, or separate departments for Day, Evening and Night employees, or a separate Per Diem department, then you cannot use the department labor level as one of the two levels required for the scheduler.

=== Multi Facility ===

If your software contains multiple facilities then you automatically get a scheduler per facility by designating the facility labor level as the Scheduler Labor Level in the [[System Configuration#Labor Level Designations|System configuration, Labor Level Designations]] tab. If you want to have multiple schedulers per facility then you will need to add a labor level. The items within this labor level would be named in this manner:

{| class="wikitable"

|-
| Facility ABC Nursing

|-
| Facility ABC Dietary

|-
| Facility ABC Housekeeping

|-
| Facility XYZ Nursing

|-
| Facility XYZ Dietary and Housekeeping

|}

This allows you to groups your scheduled staff differently in each facility.

=== Budget or Scheduling Labor Level ===

When labor levels are defined in [[System Configuration#Labor Levels|System configuration, Labor Levels]] tab, you can designate the labor levels to be Budget based and/or Scheduling based. Budget based labor levels will show in the [[Budget Configuration]] screen. Scheduling based labor levels will show in the employee's [[Employee Scheduling #Schedule Patterns|Schedule Patterns]] tab, allowing you to schedule the employee.

==== Scheduler Labor Level ====

Despite it's name, because employees do not work outside of their scheduler labor level, this would be a Budget based labor level only.

==== Budget Group Labor Level ====

If employees will only work within their home Budget Group(e.g. an RN will not cover for a LPN position) then Budget Group labor level would be just a Scheduler based level. If you need to allow employees to work in one or more budget groups then you will need to make this labor level a Scheduling level, or make the Department level a Scheduling level. Whatever level you so use, you must also make this a Restricted scheduling labor level. Otherwise, all employees can accept any schedule, i.e. a CNA can accept a RN schedule. You will need to define the Allowable Budget Group Scheduling Labor Levels in [[System Configuration#Labor Level Assignments|System configuration / Labor Level Assignments]] tab.

==== Department Labor Level ====

If you want employees to be paid from a different department when they work in a different Budget Group then the Department labor level is defined as a Scheduling Labor Level. You must also make this a Restricted scheduling labor level otherwise all employees can accept any schedule. You will need to define the Allowable Department Scheduling Labor Levels in [[System Configuration#Labor Level Assignments|System configuration / Labor Level Assignments]] tab. There is one additional step required when you use departmental scheduling. Because the department labor level is not defined as a Budget labor level, but the Budget Group level is defined as a Budget labor level, you need to make the relationships between the departments and the budget group. This is done in [[System Configuration#Labor Level Assignments|System configuration / Labor Level Assignments]] tab, using the One to One Budget Group Labor Level Assingment table.

==== Floor / Unit Labor Level ====

This will always be a budget and scheduler based labor level.

== See also ==

* [[Scheduler Implementation]]
* [[Configuration]]

Budget

2015-11-23T18:25:20Z

Deb: /* See also */

The budget defines your desired staffing levels based on the day of week, the shift, and the labor levels that you defined to be the budgetary levels. Here is a sample budget:

{| class="wikitable" style="text-align: center;"

|-
! Days of Week
! Shift
! Budget Group
! Floor
! Count

|-
| All Days
| Day
| LPN
| Floor 1
|1

|-
| All Days
| Day
| LPN
| Floor 2
|1

|-
| All Days
| Evening
| LPN
| Floor 1
|1

|-
| All Days
| Evening
| LPN
| Floor 2
|1

|-
| All Days
| Night
| LPN
| Floor 1
|1

|-
| All Days
| Night
| LPN
| Floor 2
| 1

|}

For all but the smallest budgets, you would use the [[Budget Import]] to enter your budget into the software. After the budget is entered you must see that the Base Schedule Group and Scheduler Period Group columns are not blank.

== See also ==

* [[Scheduler Implementation]]
* [[Configuration]]

Labor Levels

2015-11-23T18:15:06Z

Deb: Created page with "== Labor Levels == You need to define labor levels that represent the divisions between the type of job titles / position that employees work, and the different places that ..."

Scheduler Configuration

2015-11-23T18:12:13Z

Deb: /* Base Schedules */

{{Under Construction}}



This is a step by step guide for configuring the [[Scheduler]]. Detailed instructions on setting up the items needed for scheduling will be on the page dedicated to the configuration of that item. This step by step guide provides the links between each step.

== Labor Levels ==

You need to define labor levels that represent the divisions between the type of job titles / position that employees work, and the different places that an employee can work within your facility. A very simple example is:

{| class="wikitable"

|-
! Nurse Type

|-
| RN

|-
| LPN

|-
| CNA

|}

{| class="wikitable"

|-
! Floor

|-
| 1st Floor

|-
| 2nd Floor

|-
| 3rd Floor

|}

You are defining two things:

# The names of the labor levels (Nurse Type and Floor)
# The items with each labor level (RN, LPN, CNA and 1st, 2nd and 3rd Floor).

In the software we would designate the Nurse Type to be the Budget Group Labor Level, and the Floor to be the Floor / Unit Labor Level. This designation is done in the [[System Configuration#Labor Level Designations|System configuration, Labor Level Designation ]] tab. Two labor levels are the minimum required to use the scheduler. There is one more level that is required when you need more than one scheduler in your software. If for example you want to schedule your nursing, dietary and housekeeping staff in three distinct groups then you would need to add a labor level for this and define this as the Scheduler Labor Level in the [[System Configuration#Labor Level Designations|System configuration, Labor Level Designations]] tab.

=== Department ===

You may think that your department labor level is already defined in the software and your budgeted staffing levels can be based on your department. In most facilities, there is often more than one department that would be considered to be RNs, LPNs, CNAs etc. If you have separate departments for agency employees, or separate departments for Day, Evening and Night employees, or a separate Per Diem department, then you cannot use the department labor level as one of the two levels required for the scheduler.

=== Multi Facility ===

If your software contains multiple facilities then you automatically get a scheduler per facility by designating the facility labor level as the Scheduler Labor Level in the [[System Configuration#Labor Level Designations|System configuration, Labor Level Designations]] tab. If you want to have multiple schedulers per facility then you will need to add a labor level. The items within this labor level would be named in this manner:

{| class="wikitable"

|-
| Facility ABC Nursing

|-
| Facility ABC Dietary

|-
| Facility ABC Housekeeping

|-
| Facility XYZ Nursing

|-
| Facility XYZ Dietary and Housekeeping

|}

This allows you to groups your scheduled staff differently in each facility.

=== Budget or Scheduling Labor Level ===

When labor levels are defined in [[System Configuration#Labor Levels|System configuration, Labor Levels]] tab, you can designate the labor levels to be Budget based and/or Scheduling based. Budget based labor levels will show in the [[Budget Configuration]] screen. Scheduling based labor levels will show in the employee's [[Employee Scheduling #Schedule Patterns|Schedule Patterns]] tab, allowing you to schedule the employee.

==== Scheduler Labor Level ====

Despite it's name, because employees do not work outside of their scheduler labor level, this would be a Budget based labor level only.

==== Budget Group Labor Level ====

If employees will only work within their home Budget Group(e.g. an RN will not cover for a LPN position) then Budget Group labor level would be just a Scheduler based level. If you need to allow employees to work in one or more budget groups then you will need to make this labor level a Scheduling level, or make the Department level a Scheduling level. Whatever level you so use, you must also make this a Restricted scheduling labor level. Otherwise, all employees can accept any schedule, i.e. a CNA can accept a RN schedule. You will need to define the Allowable Budget Group Scheduling Labor Levels in [[System Configuration#Labor Level Assignments|System configuration / Labor Level Assignments]] tab.

==== Department Labor Level ====

If you want employees to be paid from a different department when they work in a different Budget Group then the Department labor level is defined as a Scheduling Labor Level. You must also make this a Restricted scheduling labor level otherwise all employees can accept any schedule. You will need to define the Allowable Department Scheduling Labor Levels in [[System Configuration#Labor Level Assignments|System configuration / Labor Level Assignments]] tab. There is one additional step required when you use departmental scheduling. Because the department labor level is not defined as a Budget labor level, but the Budget Group level is defined as a Budget labor level, you need to make the relationships between the departments and the budget group. This is done in [[System Configuration#Labor Level Assignments|System configuration / Labor Level Assignments]] tab, using the One to One Budget Group Labor Level Assingment table.

==== Floor / Unit Labor Level ====

This will always be a budget and scheduler based labor level.

== Scheduler Periods ==

Your scheduler periods will typically be from 1 week to 8 weeks in length. They can also be calendar month based. If you defined Scheduler Labor Levels then you can use different scheduler periods with each Scheduler Labor Level, e.g. Nursing schedules 4 weeks at a time, while Dietary works one week at a time. You create the relationship between a scheduler labor level and a scheduler period group in the [[System Configuration#Labor Level Assignments|System configuration / Labor Level Assignments]] tab.

== Base Schedules ==

You need to know the schedule choices required for each budget group. An identifier for each unique schedule choice is entered in [[Sub Shift Configuration]], within the [[Shift Configuration|shift]] that each sub shift falls under. In the [[Base Schedule Configuration|base schedules]] configuration, you define a base schedule group, and add the base schedules, assigning the shift / sub shift to each base schedule.

You now need to link the budgets groups to the base schedule groups. This is done in the [[System Configuration#Labor Level Assignments|System configuration / Labor Level Assignments]] tab. If using a Scheduler Labor Level then you need to link the Scheduler and Budget Group to the Base Schedule Group.

For example, Employee A is placed in the CNA budget group, the CNA budget group is linked to the Nursing base schedule group, the Nursing base schedule group has three schedules, each schedule is assigned to a different shift / sub shift. When you click on the Shift drop down in this employee's [[Employee Scheduling#Schedule Patterns|Schedule Patterns]] tab, the drop down will contain the same three choices that you see in the base schedules.

== Budget ==

To Be DELETED
The budget defines your desired staffing levels based on the day of week, the shift, and the labor levels that you defined to be the budgetary levels. Here is a sample budget:

{| class="wikitable" style="text-align: center;"

|-
! Days of Week
! Shift
! Budget Group
! Floor
! Count

|-
| All Days
| Day
| LPN
| Floor 1
|1

|-
| All Days
| Day
| LPN
| Floor 2
|1

|-
| All Days
| Evening
| LPN
| Floor 1
|1

|-
| All Days
| Evening
| LPN
| Floor 2
|1

|-
| All Days
| Night
| LPN
| Floor 1
|1

|-
| All Days
| Night
| LPN
| Floor 2
| 1

|}

For all but the smallest budgets, you would use the [[Budget Import]] to enter your budget into the software. After the budget is entered you must see that the Base Schedule Group and Scheduler Period Group columns are not blank.

== Schedule Patterns ==

Schedule patterns can be entered on an employee once the employee is assigned to a budget group. The base schedules that belong to the base schedule group thru the labor level assignment will appear as choices in the Shift column drop down.

== Planned Absences ==

In the [[Schedule Status Types Configuration]], you can add the choices that you want to see in the [[Employee Scheduling#Planned Absences|Planned Absences]] tab and in the [[Scheduler]] by selecting Display At Planned Absence Level and/or Display At Scheduler Level. Generally, you want to limit that the attendance issues that occur "day of" like Called Sick are not available to select in the planned absences, while the planned attendances like Vacation are not available to select in the [[Scheduler]].

You should encourage the users to enter the planned days off are entered as soon as they are known. This will also eliminate the scheduler user from forgetting to remove the employee off the schedule.

Scheduler Configuration

2015-11-23T18:11:42Z

Deb: /* Budget */

{{Under Construction}}



This is a step by step guide for configuring the [[Scheduler]]. Detailed instructions on setting up the items needed for scheduling will be on the page dedicated to the configuration of that item. This step by step guide provides the links between each step.

== Labor Levels ==

You need to define labor levels that represent the divisions between the type of job titles / position that employees work, and the different places that an employee can work within your facility. A very simple example is:

{| class="wikitable"

|-
! Nurse Type

|-
| RN

|-
| LPN

|-
| CNA

|}

{| class="wikitable"

|-
! Floor

|-
| 1st Floor

|-
| 2nd Floor

|-
| 3rd Floor

|}

You are defining two things:

# The names of the labor levels (Nurse Type and Floor)
# The items with each labor level (RN, LPN, CNA and 1st, 2nd and 3rd Floor).

In the software we would designate the Nurse Type to be the Budget Group Labor Level, and the Floor to be the Floor / Unit Labor Level. This designation is done in the [[System Configuration#Labor Level Designations|System configuration, Labor Level Designation ]] tab. Two labor levels are the minimum required to use the scheduler. There is one more level that is required when you need more than one scheduler in your software. If for example you want to schedule your nursing, dietary and housekeeping staff in three distinct groups then you would need to add a labor level for this and define this as the Scheduler Labor Level in the [[System Configuration#Labor Level Designations|System configuration, Labor Level Designations]] tab.

=== Department ===

You may think that your department labor level is already defined in the software and your budgeted staffing levels can be based on your department. In most facilities, there is often more than one department that would be considered to be RNs, LPNs, CNAs etc. If you have separate departments for agency employees, or separate departments for Day, Evening and Night employees, or a separate Per Diem department, then you cannot use the department labor level as one of the two levels required for the scheduler.

=== Multi Facility ===

If your software contains multiple facilities then you automatically get a scheduler per facility by designating the facility labor level as the Scheduler Labor Level in the [[System Configuration#Labor Level Designations|System configuration, Labor Level Designations]] tab. If you want to have multiple schedulers per facility then you will need to add a labor level. The items within this labor level would be named in this manner:

{| class="wikitable"

|-
| Facility ABC Nursing

|-
| Facility ABC Dietary

|-
| Facility ABC Housekeeping

|-
| Facility XYZ Nursing

|-
| Facility XYZ Dietary and Housekeeping

|}

This allows you to groups your scheduled staff differently in each facility.

=== Budget or Scheduling Labor Level ===

When labor levels are defined in [[System Configuration#Labor Levels|System configuration, Labor Levels]] tab, you can designate the labor levels to be Budget based and/or Scheduling based. Budget based labor levels will show in the [[Budget Configuration]] screen. Scheduling based labor levels will show in the employee's [[Employee Scheduling #Schedule Patterns|Schedule Patterns]] tab, allowing you to schedule the employee.

==== Scheduler Labor Level ====

Despite it's name, because employees do not work outside of their scheduler labor level, this would be a Budget based labor level only.

==== Budget Group Labor Level ====

If employees will only work within their home Budget Group(e.g. an RN will not cover for a LPN position) then Budget Group labor level would be just a Scheduler based level. If you need to allow employees to work in one or more budget groups then you will need to make this labor level a Scheduling level, or make the Department level a Scheduling level. Whatever level you so use, you must also make this a Restricted scheduling labor level. Otherwise, all employees can accept any schedule, i.e. a CNA can accept a RN schedule. You will need to define the Allowable Budget Group Scheduling Labor Levels in [[System Configuration#Labor Level Assignments|System configuration / Labor Level Assignments]] tab.

==== Department Labor Level ====

If you want employees to be paid from a different department when they work in a different Budget Group then the Department labor level is defined as a Scheduling Labor Level. You must also make this a Restricted scheduling labor level otherwise all employees can accept any schedule. You will need to define the Allowable Department Scheduling Labor Levels in [[System Configuration#Labor Level Assignments|System configuration / Labor Level Assignments]] tab. There is one additional step required when you use departmental scheduling. Because the department labor level is not defined as a Budget labor level, but the Budget Group level is defined as a Budget labor level, you need to make the relationships between the departments and the budget group. This is done in [[System Configuration#Labor Level Assignments|System configuration / Labor Level Assignments]] tab, using the One to One Budget Group Labor Level Assingment table.

==== Floor / Unit Labor Level ====

This will always be a budget and scheduler based labor level.

== Scheduler Periods ==

Your scheduler periods will typically be from 1 week to 8 weeks in length. They can also be calendar month based. If you defined Scheduler Labor Levels then you can use different scheduler periods with each Scheduler Labor Level, e.g. Nursing schedules 4 weeks at a time, while Dietary works one week at a time. You create the relationship between a scheduler labor level and a scheduler period group in the [[System Configuration#Labor Level Assignments|System configuration / Labor Level Assignments]] tab.

== Base Schedules ==

You need to know the schedule choices required for each budget group. An identifier for each unique schedule choice is entered in [[Sub Shift Configuration]], within the [[Shift Configuration|shift]] that each sub shift falls under. In the [[Base Schedule Configuration|base schedules]] configuration, you define a base schedule group, and add the base schedules, assigning the shift / sub shift to each base schedule.

You now need to link the budgets groups to the base schedule groups. This is done in the [[System Configuration#Labor Level Assignments|System configuration / Labor Level Assignments]] tab. If using a Scheduler Labor Level then you need to link the Scheduler and Budget Group to the Base Schedule Group.

For example, Employee A is placed in the CNA budget group, the CNA budget group is linked to the Nursing base schedule group, the Nursing base schedule group has three schedules, each schedule is assigned to a different shift / sub shift. When you click on the Shift drop down in this employee's [[Employee Scheduling#Schedule Patterns|Schedule Patterns]] tab, the drop down will contain the same three choices that you see in the base schedules.

== Budget == To Be DELETED

The budget defines your desired staffing levels based on the day of week, the shift, and the labor levels that you defined to be the budgetary levels. Here is a sample budget:

{| class="wikitable" style="text-align: center;"

|-
! Days of Week
! Shift
! Budget Group
! Floor
! Count

|-
| All Days
| Day
| LPN
| Floor 1
|1

|-
| All Days
| Day
| LPN
| Floor 2
|1

|-
| All Days
| Evening
| LPN
| Floor 1
|1

|-
| All Days
| Evening
| LPN
| Floor 2
|1

|-
| All Days
| Night
| LPN
| Floor 1
|1

|-
| All Days
| Night
| LPN
| Floor 2
| 1

|}

For all but the smallest budgets, you would use the [[Budget Import]] to enter your budget into the software. After the budget is entered you must see that the Base Schedule Group and Scheduler Period Group columns are not blank.

== Schedule Patterns ==

Schedule patterns can be entered on an employee once the employee is assigned to a budget group. The base schedules that belong to the base schedule group thru the labor level assignment will appear as choices in the Shift column drop down.

== Planned Absences ==

In the [[Schedule Status Types Configuration]], you can add the choices that you want to see in the [[Employee Scheduling#Planned Absences|Planned Absences]] tab and in the [[Scheduler]] by selecting Display At Planned Absence Level and/or Display At Scheduler Level. Generally, you want to limit that the attendance issues that occur "day of" like Called Sick are not available to select in the planned absences, while the planned attendances like Vacation are not available to select in the [[Scheduler]].

You should encourage the users to enter the planned days off are entered as soon as they are known. This will also eliminate the scheduler user from forgetting to remove the employee off the schedule.

Budget

2015-11-23T18:07:38Z

Deb: /* Budget */

Budget

2015-11-23T18:07:26Z

Deb:

== Budget ==

The budget defines your desired staffing levels based on the day of week, the shift, and the labor levels that you defined to be the budgetary levels. Here is a sample budget:

{| class="wikitable" style="text-align: center;"

|-
! Days of Week
! Shift
! Budget Group
! Floor
! Count

|-
| All Days
| Day
| LPN
| Floor 1
|1

|-
| All Days
| Day
| LPN
| Floor 2
|1

|-
| All Days
| Evening
| LPN
| Floor 1
|1

|-
| All Days
| Evening
| LPN
| Floor 2
|1

|-
| All Days
| Night
| LPN
| Floor 1
|1

|-
| All Days
| Night
| LPN
| Floor 2
| 1

|}

For all but the smallest budgets, you would use the [[Budget Import]] to enter your budget into the software. After the budget is entered you must see that the Base Schedule Group and Scheduler Period Group columns are not blank.

== See also ==

* [[Configuration]]

HandPunch Enrollment

2015-11-23T17:02:55Z

Deb:

[[image:HandPunch.png|right]]

== Preparation ==

Here are a few guidelines to help you prepare for an enrollment session.

* You can enroll one person or a group of people during an enrollment session.
* Each user must have a unique personal identification (ID) number. It will save you considerable time if you assign the ID numbers in advance.
* The HandPunch will not accept two people with the same ID number.
* If you enroll people using the last four digits of their phone numbers or social security numbers, you may get duplicate numbers.

== Enrolling ==

To enroll an employee you need to access the supervisor menu.

# From the main screen ('''ENTER ID'''), press Clear then Enter.
# If you see '''ENTER PASSWORD''' in the display then there are no users currently enrolled in the HandPunch. You will first need to enroll yourself. Skip to step #7.
# You should be a star symbol ('''*''') on the bottom line of the display. If you do not then go back to step #1.
# Enter in your Clock ID and press Enter.
# The displays shows '''PLACE HAND'''. Place your hand.
# You should see '''ENTER PASSWORD''' in the display.
# Press 4 then press Enter.
# You will see '''ADD EMPLOYEE''' in the display. If you want to add an employee and NOT add a user that needs to enroll other people then answer Yes (#). If you are the first person being enrolled, or you want to enroll someone that will be enrolling other people, then answer No (*) and answer the next question ('''ADD SUPERVISOR''') with Yes (*).
# Enter in the clock ID of the person you are enrolling and press Enter. If you see '''SORRY CAN'T ADD''' in the display, the clock ID is already being used.
# You will see '''PLACE HAND''' in the display. The person being enrolled places their hand and the display shows '''REMOVE HAND'''. The person being enrolled will need to place and remove their hand 3 times to complete the enrollment.
# The display will return to the question ('''ADD EMPLOYEE''' / '''ADD SUPERVISOR'''). To get from the '''ADD SUPERVISOR''' menu to the '''ADD EMPLOYEE''' menu, press No (*) twice.
# Press Clear to exit from the supervisor menu.

==Un-Enrolling & Re-Enrolling==

To re-enroll a person, you first need to remove them from the HandPunch.

# From the main screen ('''ENTER ID'''), press Clear then Enter.
# You should be a star symbol ('''*''') on the bottom line of the display. If you do not then go back to step #1.
# Enter in your Clock ID and press Enter.
# The displays shows '''PLACE HAND'''. Place your hand.
# You should see '''ENTER PASSWORD''' in the display.
# Press 4 then press Enter.
# You will see '''ADD EMPLOYEE''' in the display.
# Answer No (*) twice.
# You will see '''REMOVE USER''' in the display.
# Answer Yes (#).
# You will see '''REMOVE ID''' # in the display.
# Enter the clock ID of the person you wish to remove and press Enter. *IMPORTANT* - do NOT enter your clock ID.
# You will see '''USER REMOVED''' in the screen briefly and then the display will return to '''REMOVE ID #'''.
# If you have another person that you want to remove then enter their clock ID, otherwise press Clear to get back to the '''REMOVE USER''' menu.
# Press No (*) and you will be at the '''ADD EMPLOYEE''' menu. You can now enroll the people that you removed.

== User Education ==
The HandPunch is easy to use and non-threatening. However, most people have never used a biometric HandPunch.
Training users on how the HandPunch works and how to use it will eliminate most fears and concerns before they occur. Inform the users of these facts.

* The HandPunch reads the shape of the hand, not the fingerprints or palmprints.
* It does not identify people. It confirms people’s identity.
* It scans with an invisible light of the type used in TV remote controls.
* It does not transfer germs any more than a doorknob or money.
* It does not invade privacy; it guarantees it.
* The enrollment process requires three or more reads to collect enough information to create a template.

== Proper Hand Placement ==

For correct and consistent hand reads, it is very important that your hand is placed on the platen in the same manner every time.
The following rules apply for proper hand placement on the platen.

* If you are wearing a ring, rotate the ring so the stone faces up in its normal position.
* Slide your right hand onto the platen rather like an airplane landing at the airport.
* Slide your hand forward until the web between your index and middle finger stops against the Web Pin.
* Keep your hand flat. You should feel the surface of the platen on your palm and the underside of your fingers.
* Close your fingers together until they touch the Finger Pins and watch the hand diagram light display on the top panel. See image below.
* The lights go out when you have properly placed your fingers. If a light remains on, a finger is not in proper contact with its Finger Pin.
[[File:Hand Placement.png]]

== Left Hand Enrollment ==

Some right hands cannot be used in the HandPunch due to disabilities such as missing fingers. You can enroll a user with the left hand facing palm side up.
The techniques for left hand enrollment are the same as for standard enrollment. The user should keep the back of the hand flat against the platen and move
the fingers against the web pin and the finger pins in the same manner as in standard enrollment. Users enrolled with the left hand must always verify with the left hand.
Extra practice on placing the hand on the platen may be required to ensure correct, consistent hand reads.

== Simple Troubleshooting ==

* Correct hand placement is critical to successful enrollment and punching. The hand should be placed flat on the platen, with the fingers touching the pins. If a red light is lit, then the person being enrolled is not touching that pin with their finger.
* The wrist should be visible when punching. If the wrist is not visible then clothing might block the camera from successfully scanning the hand.
* The HandPunch needs to be kept clean. See [[HandPunch Maintenance]] for maintenance and cleaning instructions.

== See also ==

* [[HandPunch]]
* [[HandPunch Maintenance]]
* [[HandPunch Troubleshooting]]

HandPunch Enrollment

2015-11-23T16:57:35Z

Deb: /* Proper Hand Placement */

[[image:HandPunch.png|right]]

== Preparation ==

Here are a few guidelines to help you prepare for an enrollment session.

* You can enroll one person or a group of people during an enrollment session.
* Each user must have a unique personal identification (ID) number. It will save you considerable time if you assign the ID numbers in advance.
* The HandPunch will not accept two people with the same ID number.
* If you enroll people using the last four digits of their phone numbers or social security numbers, you may get duplicate numbers.

== Enrolling ==

To enroll an employee you need to access the supervisor menu.

# From the main screen ('''ENTER ID'''), press Clear then Enter.
# If you see '''ENTER PASSWORD''' in the display then there are no users currently enrolled in the HandPunch. You will first need to enroll yourself. Skip to step #7.
# You should be a star symbol ('''*''') on the bottom line of the display. If you do not then go back to step #1.
# Enter in your Clock ID and press Enter.
# The displays shows '''PLACE HAND'''. Place your hand.
# You should see '''ENTER PASSWORD''' in the display.
# Press 4 then press Enter.
# You will see '''ADD EMPLOYEE''' in the display. If you want to add an employee and NOT add a user that needs to enroll other people then answer Yes (#). If you are the first person being enrolled, or you want to enroll someone that will be enrolling other people, then answer No (*) and answer the next question ('''ADD SUPERVISOR''') with Yes (*).
# Enter in the clock ID of the person you are enrolling and press Enter. If you see '''SORRY CAN'T ADD''' in the display, the clock ID is already being used.
# You will see '''PLACE HAND''' in the display. The person being enrolled places their hand and the display shows '''REMOVE HAND'''. The person being enrolled will need to place and remove their hand 3 times to complete the enrollment.
# The display will return to the question ('''ADD EMPLOYEE''' / '''ADD SUPERVISOR'''). To get from the '''ADD SUPERVISOR''' menu to the '''ADD EMPLOYEE''' menu, press No (*) twice.
# Press Clear to exit from the supervisor menu.

==Un-Enrolling & Re-Enrolling==

To re-enroll a person, you first need to remove them from the HandPunch.

# From the main screen ('''ENTER ID'''), press Clear then Enter.
# You should be a star symbol ('''*''') on the bottom line of the display. If you do not then go back to step #1.
# Enter in your Clock ID and press Enter.
# The displays shows '''PLACE HAND'''. Place your hand.
# You should see '''ENTER PASSWORD''' in the display.
# Press 4 then press Enter.
# You will see '''ADD EMPLOYEE''' in the display.
# Answer No (*) twice.
# You will see '''REMOVE USER''' in the display.
# Answer Yes (#).
# You will see '''REMOVE ID''' # in the display.
# Enter the clock ID of the person you wish to remove and press Enter. *IMPORTANT* - do NOT enter your clock ID.
# You will see '''USER REMOVED''' in the screen briefly and then the display will return to '''REMOVE ID #'''.
# If you have another person that you want to remove then enter their clock ID, otherwise press Clear to get back to the '''REMOVE USER''' menu.
# Press No (*) and you will be at the '''ADD EMPLOYEE''' menu. You can now enroll the people that you removed.

== User Education ==
The HandPunch is easy to use and non-threatening. However, most people have never used a biometric HandPunch.
Training users on how the HandPunch works and how to use it will eliminate most fears and concerns before they occur. Inform the users of these facts.

* The HandPunch reads the shape of the hand, not the fingerprints or palmprints.
* It does not identify people. It confirms people’s identity.
* It scans with an invisible light of the type used in TV remote controls.
* It does not transfer germs any more than a doorknob or money.
* It does not invade privacy; it guarantees it.
* The enrollment process requires three or more reads to collect enough information to create a template.

== Proper Hand Placement ==

For correct and consistent hand reads, it is very important that your hand is placed on the platen in the same manner every time.
The following rules apply for proper hand placement on the platen.

* If you are wearing a ring, rotate the ring so the stone faces up in its normal position.
* Slide your right hand onto the platen rather like an airplane landing at the airport.
* Slide your hand forward until the web between your index and middle finger stops against the Web Pin.
* Keep your hand flat. You should feel the surface of the platen on your palm and the underside of your fingers.
* Close your fingers together until they touch the Finger Pins and watch the hand diagram light display on the top panel. See image below.
* The lights go out when you have properly placed your fingers. If a light remains on, a finger is not in proper contact with its Finger Pin.
[[File:Hand Placement.png]]

== Simple Troubleshooting ==

* Correct hand placement is critical to successful enrollment and punching. The hand should be placed flat on the platen, with the fingers touching the pins. If a red light is lit, then the person being enrolled is not touching that pin with their finger.
* The wrist should be visible when punching. If the wrist is not visible then clothing might block the camera from successfully scanning the hand.
* The HandPunch needs to be kept clean. See [[HandPunch Maintenance]] for maintenance and cleaning instructions.

== See also ==

* [[HandPunch]]
* [[HandPunch Maintenance]]
* [[HandPunch Troubleshooting]]

HandPunch Enrollment

2015-11-23T16:57:24Z

Deb: /* Proper Hand Placement */

[[image:HandPunch.png|right]]

== Preparation ==

Here are a few guidelines to help you prepare for an enrollment session.

* You can enroll one person or a group of people during an enrollment session.
* Each user must have a unique personal identification (ID) number. It will save you considerable time if you assign the ID numbers in advance.
* The HandPunch will not accept two people with the same ID number.
* If you enroll people using the last four digits of their phone numbers or social security numbers, you may get duplicate numbers.

== Enrolling ==

To enroll an employee you need to access the supervisor menu.

# From the main screen ('''ENTER ID'''), press Clear then Enter.
# If you see '''ENTER PASSWORD''' in the display then there are no users currently enrolled in the HandPunch. You will first need to enroll yourself. Skip to step #7.
# You should be a star symbol ('''*''') on the bottom line of the display. If you do not then go back to step #1.
# Enter in your Clock ID and press Enter.
# The displays shows '''PLACE HAND'''. Place your hand.
# You should see '''ENTER PASSWORD''' in the display.
# Press 4 then press Enter.
# You will see '''ADD EMPLOYEE''' in the display. If you want to add an employee and NOT add a user that needs to enroll other people then answer Yes (#). If you are the first person being enrolled, or you want to enroll someone that will be enrolling other people, then answer No (*) and answer the next question ('''ADD SUPERVISOR''') with Yes (*).
# Enter in the clock ID of the person you are enrolling and press Enter. If you see '''SORRY CAN'T ADD''' in the display, the clock ID is already being used.
# You will see '''PLACE HAND''' in the display. The person being enrolled places their hand and the display shows '''REMOVE HAND'''. The person being enrolled will need to place and remove their hand 3 times to complete the enrollment.
# The display will return to the question ('''ADD EMPLOYEE''' / '''ADD SUPERVISOR'''). To get from the '''ADD SUPERVISOR''' menu to the '''ADD EMPLOYEE''' menu, press No (*) twice.
# Press Clear to exit from the supervisor menu.

==Un-Enrolling & Re-Enrolling==

To re-enroll a person, you first need to remove them from the HandPunch.

# From the main screen ('''ENTER ID'''), press Clear then Enter.
# You should be a star symbol ('''*''') on the bottom line of the display. If you do not then go back to step #1.
# Enter in your Clock ID and press Enter.
# The displays shows '''PLACE HAND'''. Place your hand.
# You should see '''ENTER PASSWORD''' in the display.
# Press 4 then press Enter.
# You will see '''ADD EMPLOYEE''' in the display.
# Answer No (*) twice.
# You will see '''REMOVE USER''' in the display.
# Answer Yes (#).
# You will see '''REMOVE ID''' # in the display.
# Enter the clock ID of the person you wish to remove and press Enter. *IMPORTANT* - do NOT enter your clock ID.
# You will see '''USER REMOVED''' in the screen briefly and then the display will return to '''REMOVE ID #'''.
# If you have another person that you want to remove then enter their clock ID, otherwise press Clear to get back to the '''REMOVE USER''' menu.
# Press No (*) and you will be at the '''ADD EMPLOYEE''' menu. You can now enroll the people that you removed.

== User Education ==
The HandPunch is easy to use and non-threatening. However, most people have never used a biometric HandPunch.
Training users on how the HandPunch works and how to use it will eliminate most fears and concerns before they occur. Inform the users of these facts.

* The HandPunch reads the shape of the hand, not the fingerprints or palmprints.
* It does not identify people. It confirms people’s identity.
* It scans with an invisible light of the type used in TV remote controls.
* It does not transfer germs any more than a doorknob or money.
* It does not invade privacy; it guarantees it.
* The enrollment process requires three or more reads to collect enough information to create a template.

== Proper Hand Placement ==

For correct and consistent hand reads it is very important that your hand is placed on the platen in the same manner every time.
The following rules apply for proper hand placement on the platen.

* If you are wearing a ring, rotate the ring so the stone faces up in its normal position.
* Slide your right hand onto the platen rather like an airplane landing at the airport.
* Slide your hand forward until the web between your index and middle finger stops against the Web Pin.
* Keep your hand flat. You should feel the surface of the platen on your palm and the underside of your fingers.
* Close your fingers together until they touch the Finger Pins and watch the hand diagram light display on the top panel. See image below.
* The lights go out when you have properly placed your fingers. If a light remains on, a finger is not in proper contact with its Finger Pin.
[[File:Hand Placement.png]]

== Simple Troubleshooting ==

* Correct hand placement is critical to successful enrollment and punching. The hand should be placed flat on the platen, with the fingers touching the pins. If a red light is lit, then the person being enrolled is not touching that pin with their finger.
* The wrist should be visible when punching. If the wrist is not visible then clothing might block the camera from successfully scanning the hand.
* The HandPunch needs to be kept clean. See [[HandPunch Maintenance]] for maintenance and cleaning instructions.

== See also ==

* [[HandPunch]]
* [[HandPunch Maintenance]]
* [[HandPunch Troubleshooting]]

HandPunch Enrollment

2015-11-23T16:56:09Z

Deb: /* Proper Hand Placement */

[[image:HandPunch.png|right]]

== Preparation ==

Here are a few guidelines to help you prepare for an enrollment session.

* You can enroll one person or a group of people during an enrollment session.
* Each user must have a unique personal identification (ID) number. It will save you considerable time if you assign the ID numbers in advance.
* The HandPunch will not accept two people with the same ID number.
* If you enroll people using the last four digits of their phone numbers or social security numbers, you may get duplicate numbers.

== Enrolling ==

To enroll an employee you need to access the supervisor menu.

# From the main screen ('''ENTER ID'''), press Clear then Enter.
# If you see '''ENTER PASSWORD''' in the display then there are no users currently enrolled in the HandPunch. You will first need to enroll yourself. Skip to step #7.
# You should be a star symbol ('''*''') on the bottom line of the display. If you do not then go back to step #1.
# Enter in your Clock ID and press Enter.
# The displays shows '''PLACE HAND'''. Place your hand.
# You should see '''ENTER PASSWORD''' in the display.
# Press 4 then press Enter.
# You will see '''ADD EMPLOYEE''' in the display. If you want to add an employee and NOT add a user that needs to enroll other people then answer Yes (#). If you are the first person being enrolled, or you want to enroll someone that will be enrolling other people, then answer No (*) and answer the next question ('''ADD SUPERVISOR''') with Yes (*).
# Enter in the clock ID of the person you are enrolling and press Enter. If you see '''SORRY CAN'T ADD''' in the display, the clock ID is already being used.
# You will see '''PLACE HAND''' in the display. The person being enrolled places their hand and the display shows '''REMOVE HAND'''. The person being enrolled will need to place and remove their hand 3 times to complete the enrollment.
# The display will return to the question ('''ADD EMPLOYEE''' / '''ADD SUPERVISOR'''). To get from the '''ADD SUPERVISOR''' menu to the '''ADD EMPLOYEE''' menu, press No (*) twice.
# Press Clear to exit from the supervisor menu.

==Un-Enrolling & Re-Enrolling==

To re-enroll a person, you first need to remove them from the HandPunch.

# From the main screen ('''ENTER ID'''), press Clear then Enter.
# You should be a star symbol ('''*''') on the bottom line of the display. If you do not then go back to step #1.
# Enter in your Clock ID and press Enter.
# The displays shows '''PLACE HAND'''. Place your hand.
# You should see '''ENTER PASSWORD''' in the display.
# Press 4 then press Enter.
# You will see '''ADD EMPLOYEE''' in the display.
# Answer No (*) twice.
# You will see '''REMOVE USER''' in the display.
# Answer Yes (#).
# You will see '''REMOVE ID''' # in the display.
# Enter the clock ID of the person you wish to remove and press Enter. *IMPORTANT* - do NOT enter your clock ID.
# You will see '''USER REMOVED''' in the screen briefly and then the display will return to '''REMOVE ID #'''.
# If you have another person that you want to remove then enter their clock ID, otherwise press Clear to get back to the '''REMOVE USER''' menu.
# Press No (*) and you will be at the '''ADD EMPLOYEE''' menu. You can now enroll the people that you removed.

== User Education ==
The HandPunch is easy to use and non-threatening. However, most people have never used a biometric HandPunch.
Training users on how the HandPunch works and how to use it will eliminate most fears and concerns before they occur. Inform the users of these facts.

* The HandPunch reads the shape of the hand, not the fingerprints or palmprints.
* It does not identify people. It confirms people’s identity.
* It scans with an invisible light of the type used in TV remote controls.
* It does not transfer germs any more than a doorknob or money.
* It does not invade privacy; it guarantees it.
* The enrollment process requires three or more reads to collect enough information to create a template.

== Proper Hand Placement ==

For correct and consistent hand reads it is very important that your hand is placed on the platen in the same manner every time.
The following rules apply for proper hand placement on the platen.

* If you are wearing a ring, rotate the ring so the stone faces up in its normal position. [[File:Hand Placement.png|Right]]
* Slide your right hand onto the platen rather like an airplane landing at the airport.
* Slide your hand forward until the web between your index and middle finger stops against the Web Pin.
* Keep your hand flat. You should feel the surface of the platen on your palm and the underside of your fingers.
* Close your fingers together until they touch the Finger Pins and watch the hand diagram light display on the top panel.
* The lights go out when you have properly placed your fingers. If a light remains on, a finger is not in proper contact with its Finger Pin.

== Simple Troubleshooting ==

* Correct hand placement is critical to successful enrollment and punching. The hand should be placed flat on the platen, with the fingers touching the pins. If a red light is lit, then the person being enrolled is not touching that pin with their finger.
* The wrist should be visible when punching. If the wrist is not visible then clothing might block the camera from successfully scanning the hand.
* The HandPunch needs to be kept clean. See [[HandPunch Maintenance]] for maintenance and cleaning instructions.

== See also ==

* [[HandPunch]]
* [[HandPunch Maintenance]]
* [[HandPunch Troubleshooting]]

File:Hand Placement.png

2015-11-23T16:54:57Z

Deb:

HandPunch Enrollment

2015-11-23T16:54:25Z

Deb: /* Proper Hand Placement */

[[image:HandPunch.png|right]]

== Preparation ==

Here are a few guidelines to help you prepare for an enrollment session.

* You can enroll one person or a group of people during an enrollment session.
* Each user must have a unique personal identification (ID) number. It will save you considerable time if you assign the ID numbers in advance.
* The HandPunch will not accept two people with the same ID number.
* If you enroll people using the last four digits of their phone numbers or social security numbers, you may get duplicate numbers.

== Enrolling ==

To enroll an employee you need to access the supervisor menu.

# From the main screen ('''ENTER ID'''), press Clear then Enter.
# If you see '''ENTER PASSWORD''' in the display then there are no users currently enrolled in the HandPunch. You will first need to enroll yourself. Skip to step #7.
# You should be a star symbol ('''*''') on the bottom line of the display. If you do not then go back to step #1.
# Enter in your Clock ID and press Enter.
# The displays shows '''PLACE HAND'''. Place your hand.
# You should see '''ENTER PASSWORD''' in the display.
# Press 4 then press Enter.
# You will see '''ADD EMPLOYEE''' in the display. If you want to add an employee and NOT add a user that needs to enroll other people then answer Yes (#). If you are the first person being enrolled, or you want to enroll someone that will be enrolling other people, then answer No (*) and answer the next question ('''ADD SUPERVISOR''') with Yes (*).
# Enter in the clock ID of the person you are enrolling and press Enter. If you see '''SORRY CAN'T ADD''' in the display, the clock ID is already being used.
# You will see '''PLACE HAND''' in the display. The person being enrolled places their hand and the display shows '''REMOVE HAND'''. The person being enrolled will need to place and remove their hand 3 times to complete the enrollment.
# The display will return to the question ('''ADD EMPLOYEE''' / '''ADD SUPERVISOR'''). To get from the '''ADD SUPERVISOR''' menu to the '''ADD EMPLOYEE''' menu, press No (*) twice.
# Press Clear to exit from the supervisor menu.

==Un-Enrolling & Re-Enrolling==

To re-enroll a person, you first need to remove them from the HandPunch.

# From the main screen ('''ENTER ID'''), press Clear then Enter.
# You should be a star symbol ('''*''') on the bottom line of the display. If you do not then go back to step #1.
# Enter in your Clock ID and press Enter.
# The displays shows '''PLACE HAND'''. Place your hand.
# You should see '''ENTER PASSWORD''' in the display.
# Press 4 then press Enter.
# You will see '''ADD EMPLOYEE''' in the display.
# Answer No (*) twice.
# You will see '''REMOVE USER''' in the display.
# Answer Yes (#).
# You will see '''REMOVE ID''' # in the display.
# Enter the clock ID of the person you wish to remove and press Enter. *IMPORTANT* - do NOT enter your clock ID.
# You will see '''USER REMOVED''' in the screen briefly and then the display will return to '''REMOVE ID #'''.
# If you have another person that you want to remove then enter their clock ID, otherwise press Clear to get back to the '''REMOVE USER''' menu.
# Press No (*) and you will be at the '''ADD EMPLOYEE''' menu. You can now enroll the people that you removed.

== User Education ==
The HandPunch is easy to use and non-threatening. However, most people have never used a biometric HandPunch.
Training users on how the HandPunch works and how to use it will eliminate most fears and concerns before they occur. Inform the users of these facts.

* The HandPunch reads the shape of the hand, not the fingerprints or palmprints.
* It does not identify people. It confirms people’s identity.
* It scans with an invisible light of the type used in TV remote controls.
* It does not transfer germs any more than a doorknob or money.
* It does not invade privacy; it guarantees it.
* The enrollment process requires three or more reads to collect enough information to create a template.

== Proper Hand Placement ==

For correct and consistent hand reads it is very important that your hand is placed on the platen in the same manner every time.
The following rules apply for proper hand placement on the platen.

* If you are wearing a ring, rotate the ring so the stone faces up in its normal position. [[File:Hand Placement.png]]
* Slide your right hand onto the platen rather like an airplane landing at the airport.
* Slide your hand forward until the web between your index and middle finger stops against the Web Pin.
* Keep your hand flat. You should feel the surface of the platen on your palm and the underside of your fingers.
* Close your fingers together until they touch the Finger Pins and watch the hand diagram light display on the top panel.
* The lights go out when you have properly placed your fingers. If a light remains on, a finger is not in proper contact with its Finger Pin.

== Simple Troubleshooting ==

* Correct hand placement is critical to successful enrollment and punching. The hand should be placed flat on the platen, with the fingers touching the pins. If a red light is lit, then the person being enrolled is not touching that pin with their finger.
* The wrist should be visible when punching. If the wrist is not visible then clothing might block the camera from successfully scanning the hand.
* The HandPunch needs to be kept clean. See [[HandPunch Maintenance]] for maintenance and cleaning instructions.

== See also ==

* [[HandPunch]]
* [[HandPunch Maintenance]]
* [[HandPunch Troubleshooting]]

File:Hand placement.png

2015-11-23T16:50:39Z

Deb:

HandPunch Enrollment

2015-11-23T16:46:37Z

Deb: /* Proper Hand Placement */

[[image:HandPunch.png|right]]

== Preparation ==

Here are a few guidelines to help you prepare for an enrollment session.

* You can enroll one person or a group of people during an enrollment session.
* Each user must have a unique personal identification (ID) number. It will save you considerable time if you assign the ID numbers in advance.
* The HandPunch will not accept two people with the same ID number.
* If you enroll people using the last four digits of their phone numbers or social security numbers, you may get duplicate numbers.

== Enrolling ==

To enroll an employee you need to access the supervisor menu.

# From the main screen ('''ENTER ID'''), press Clear then Enter.
# If you see '''ENTER PASSWORD''' in the display then there are no users currently enrolled in the HandPunch. You will first need to enroll yourself. Skip to step #7.
# You should be a star symbol ('''*''') on the bottom line of the display. If you do not then go back to step #1.
# Enter in your Clock ID and press Enter.
# The displays shows '''PLACE HAND'''. Place your hand.
# You should see '''ENTER PASSWORD''' in the display.
# Press 4 then press Enter.
# You will see '''ADD EMPLOYEE''' in the display. If you want to add an employee and NOT add a user that needs to enroll other people then answer Yes (#). If you are the first person being enrolled, or you want to enroll someone that will be enrolling other people, then answer No (*) and answer the next question ('''ADD SUPERVISOR''') with Yes (*).
# Enter in the clock ID of the person you are enrolling and press Enter. If you see '''SORRY CAN'T ADD''' in the display, the clock ID is already being used.
# You will see '''PLACE HAND''' in the display. The person being enrolled places their hand and the display shows '''REMOVE HAND'''. The person being enrolled will need to place and remove their hand 3 times to complete the enrollment.
# The display will return to the question ('''ADD EMPLOYEE''' / '''ADD SUPERVISOR'''). To get from the '''ADD SUPERVISOR''' menu to the '''ADD EMPLOYEE''' menu, press No (*) twice.
# Press Clear to exit from the supervisor menu.

==Un-Enrolling & Re-Enrolling==

To re-enroll a person, you first need to remove them from the HandPunch.

# From the main screen ('''ENTER ID'''), press Clear then Enter.
# You should be a star symbol ('''*''') on the bottom line of the display. If you do not then go back to step #1.
# Enter in your Clock ID and press Enter.
# The displays shows '''PLACE HAND'''. Place your hand.
# You should see '''ENTER PASSWORD''' in the display.
# Press 4 then press Enter.
# You will see '''ADD EMPLOYEE''' in the display.
# Answer No (*) twice.
# You will see '''REMOVE USER''' in the display.
# Answer Yes (#).
# You will see '''REMOVE ID''' # in the display.
# Enter the clock ID of the person you wish to remove and press Enter. *IMPORTANT* - do NOT enter your clock ID.
# You will see '''USER REMOVED''' in the screen briefly and then the display will return to '''REMOVE ID #'''.
# If you have another person that you want to remove then enter their clock ID, otherwise press Clear to get back to the '''REMOVE USER''' menu.
# Press No (*) and you will be at the '''ADD EMPLOYEE''' menu. You can now enroll the people that you removed.

== User Education ==
The HandPunch is easy to use and non-threatening. However, most people have never used a biometric HandPunch.
Training users on how the HandPunch works and how to use it will eliminate most fears and concerns before they occur. Inform the users of these facts.

* The HandPunch reads the shape of the hand, not the fingerprints or palmprints.
* It does not identify people. It confirms people’s identity.
* It scans with an invisible light of the type used in TV remote controls.
* It does not transfer germs any more than a doorknob or money.
* It does not invade privacy; it guarantees it.
* The enrollment process requires three or more reads to collect enough information to create a template.

== Proper Hand Placement ==

For correct and consistent hand reads it is very important that your hand is placed on the platen in the same manner every time.
The following rules apply for proper hand placement on the platen.

* If you are wearing a ring, rotate the ring so the stone faces up in its normal position.
* Slide your right hand onto the platen rather like an airplane landing at the airport.
* Slide your hand forward until the web between your index and middle finger stops against the Web Pin.
* Keep your hand flat. You should feel the surface of the platen on your palm and the underside of your fingers.
* Close your fingers together until they touch the Finger Pins and watch the hand diagram light display on the top panel.
* The lights go out when you have properly placed your fingers. If a light remains on, a finger is not in proper contact with its Finger Pin.

== Simple Troubleshooting ==

* Correct hand placement is critical to successful enrollment and punching. The hand should be placed flat on the platen, with the fingers touching the pins. If a red light is lit, then the person being enrolled is not touching that pin with their finger.
* The wrist should be visible when punching. If the wrist is not visible then clothing might block the camera from successfully scanning the hand.
* The HandPunch needs to be kept clean. See [[HandPunch Maintenance]] for maintenance and cleaning instructions.

== See also ==

* [[HandPunch]]
* [[HandPunch Maintenance]]
* [[HandPunch Troubleshooting]]

HandPunch Enrollment

2015-11-23T16:43:29Z

Deb:

[[image:HandPunch.png|right]]

== Preparation ==

Here are a few guidelines to help you prepare for an enrollment session.

* You can enroll one person or a group of people during an enrollment session.
* Each user must have a unique personal identification (ID) number. It will save you considerable time if you assign the ID numbers in advance.
* The HandPunch will not accept two people with the same ID number.
* If you enroll people using the last four digits of their phone numbers or social security numbers, you may get duplicate numbers.

== Enrolling ==

To enroll an employee you need to access the supervisor menu.

# From the main screen ('''ENTER ID'''), press Clear then Enter.
# If you see '''ENTER PASSWORD''' in the display then there are no users currently enrolled in the HandPunch. You will first need to enroll yourself. Skip to step #7.
# You should be a star symbol ('''*''') on the bottom line of the display. If you do not then go back to step #1.
# Enter in your Clock ID and press Enter.
# The displays shows '''PLACE HAND'''. Place your hand.
# You should see '''ENTER PASSWORD''' in the display.
# Press 4 then press Enter.
# You will see '''ADD EMPLOYEE''' in the display. If you want to add an employee and NOT add a user that needs to enroll other people then answer Yes (#). If you are the first person being enrolled, or you want to enroll someone that will be enrolling other people, then answer No (*) and answer the next question ('''ADD SUPERVISOR''') with Yes (*).
# Enter in the clock ID of the person you are enrolling and press Enter. If you see '''SORRY CAN'T ADD''' in the display, the clock ID is already being used.
# You will see '''PLACE HAND''' in the display. The person being enrolled places their hand and the display shows '''REMOVE HAND'''. The person being enrolled will need to place and remove their hand 3 times to complete the enrollment.
# The display will return to the question ('''ADD EMPLOYEE''' / '''ADD SUPERVISOR'''). To get from the '''ADD SUPERVISOR''' menu to the '''ADD EMPLOYEE''' menu, press No (*) twice.
# Press Clear to exit from the supervisor menu.

==Un-Enrolling & Re-Enrolling==

To re-enroll a person, you first need to remove them from the HandPunch.

# From the main screen ('''ENTER ID'''), press Clear then Enter.
# You should be a star symbol ('''*''') on the bottom line of the display. If you do not then go back to step #1.
# Enter in your Clock ID and press Enter.
# The displays shows '''PLACE HAND'''. Place your hand.
# You should see '''ENTER PASSWORD''' in the display.
# Press 4 then press Enter.
# You will see '''ADD EMPLOYEE''' in the display.
# Answer No (*) twice.
# You will see '''REMOVE USER''' in the display.
# Answer Yes (#).
# You will see '''REMOVE ID''' # in the display.
# Enter the clock ID of the person you wish to remove and press Enter. *IMPORTANT* - do NOT enter your clock ID.
# You will see '''USER REMOVED''' in the screen briefly and then the display will return to '''REMOVE ID #'''.
# If you have another person that you want to remove then enter their clock ID, otherwise press Clear to get back to the '''REMOVE USER''' menu.
# Press No (*) and you will be at the '''ADD EMPLOYEE''' menu. You can now enroll the people that you removed.

== User Education ==
The HandPunch is easy to use and non-threatening. However, most people have never used a biometric HandPunch.
Training users on how the HandPunch works and how to use it will eliminate most fears and concerns before they occur. Inform the users of these facts.

* The HandPunch reads the shape of the hand, not the fingerprints or palmprints.
* It does not identify people. It confirms people’s identity.
* It scans with an invisible light of the type used in TV remote controls.
* It does not transfer germs any more than a doorknob or money.
* It does not invade privacy; it guarantees it.
* The enrollment process requires three or more reads to collect enough information to create a template.

== Proper Hand Placement ==

== Simple Troubleshooting ==

* Correct hand placement is critical to successful enrollment and punching. The hand should be placed flat on the platen, with the fingers touching the pins. If a red light is lit, then the person being enrolled is not touching that pin with their finger.
* The wrist should be visible when punching. If the wrist is not visible then clothing might block the camera from successfully scanning the hand.
* The HandPunch needs to be kept clean. See [[HandPunch Maintenance]] for maintenance and cleaning instructions.

== See also ==

* [[HandPunch]]
* [[HandPunch Maintenance]]
* [[HandPunch Troubleshooting]]

HandPunch Enrollment

2015-11-23T16:38:57Z

Deb: /* Preparation */

HandPunch Enrollment

2015-11-23T16:38:32Z

Deb: /* Preparation */

[[image:HandPunch.png|right]]

== Preparation ==

Here are a few guidelines to help you prepare for an enrollment session.

# You can enroll one person or a group of people during an enrollment session.
# Each user must have a unique personal identification (ID) number. It will save you considerable time if you assign the ID numbers in advance.
# The HandPunch will not accept two people with the same ID number.
# If you enroll people using the last four digits of their phone numbers or social security numbers, you may get duplicate numbers.

== Enrolling ==

To enroll an employee you need to access the supervisor menu.

# From the main screen ('''ENTER ID'''), press Clear then Enter.
# If you see '''ENTER PASSWORD''' in the display then there are no users currently enrolled in the HandPunch. You will first need to enroll yourself. Skip to step #7.
# You should be a star symbol ('''*''') on the bottom line of the display. If you do not then go back to step #1.
# Enter in your Clock ID and press Enter.
# The displays shows '''PLACE HAND'''. Place your hand.
# You should see '''ENTER PASSWORD''' in the display.
# Press 4 then press Enter.
# You will see '''ADD EMPLOYEE''' in the display. If you want to add an employee and NOT add a user that needs to enroll other people then answer Yes (#). If you are the first person being enrolled, or you want to enroll someone that will be enrolling other people, then answer No (*) and answer the next question ('''ADD SUPERVISOR''') with Yes (*).
# Enter in the clock ID of the person you are enrolling and press Enter. If you see '''SORRY CAN'T ADD''' in the display, the clock ID is already being used.
# You will see '''PLACE HAND''' in the display. The person being enrolled places their hand and the display shows '''REMOVE HAND'''. The person being enrolled will need to place and remove their hand 3 times to complete the enrollment.
# The display will return to the question ('''ADD EMPLOYEE''' / '''ADD SUPERVISOR'''). To get from the '''ADD SUPERVISOR''' menu to the '''ADD EMPLOYEE''' menu, press No (*) twice.
# Press Clear to exit from the supervisor menu.

==Un-Enrolling & Re-Enrolling==

To re-enroll a person, you first need to remove them from the HandPunch.

# From the main screen ('''ENTER ID'''), press Clear then Enter.
# You should be a star symbol ('''*''') on the bottom line of the display. If you do not then go back to step #1.
# Enter in your Clock ID and press Enter.
# The displays shows '''PLACE HAND'''. Place your hand.
# You should see '''ENTER PASSWORD''' in the display.
# Press 4 then press Enter.
# You will see '''ADD EMPLOYEE''' in the display.
# Answer No (*) twice.
# You will see '''REMOVE USER''' in the display.
# Answer Yes (#).
# You will see '''REMOVE ID''' # in the display.
# Enter the clock ID of the person you wish to remove and press Enter. *IMPORTANT* - do NOT enter your clock ID.
# You will see '''USER REMOVED''' in the screen briefly and then the display will return to '''REMOVE ID #'''.
# If you have another person that you want to remove then enter their clock ID, otherwise press Clear to get back to the '''REMOVE USER''' menu.
# Press No (*) and you will be at the '''ADD EMPLOYEE''' menu. You can now enroll the people that you removed.

== Simple Troubleshooting ==

* Correct hand placement is critical to successful enrollment and punching. The hand should be placed flat on the platen, with the fingers touching the pins. If a red light is lit, then the person being enrolled is not touching that pin with their finger.
* The wrist should be visible when punching. If the wrist is not visible then clothing might block the camera from successfully scanning the hand.
* The HandPunch needs to be kept clean. See [[HandPunch Maintenance]] for maintenance and cleaning instructions.

== See also ==

* [[HandPunch]]
* [[HandPunch Maintenance]]
* [[HandPunch Troubleshooting]]

HandPunch Enrollment

2015-11-23T16:37:11Z

Deb: /* Preparation */

[[image:HandPunch.png|right]]

== Preparation ==

Here are a few guidelines to help you prepare for an enrollment session.
• You can enroll one person or a group of people during an enrollment session.
• Each user must have a unique personal identification (ID) number. It will save you
considerable time if you assign the ID numbers in advance.
• The HandPunch will not accept two people with the same ID number.
• If you enroll people using the last four digits of their phone numbers or social security
numbers, you may get duplicate numbers.

== Enrolling ==

To enroll an employee you need to access the supervisor menu.

# From the main screen ('''ENTER ID'''), press Clear then Enter.
# If you see '''ENTER PASSWORD''' in the display then there are no users currently enrolled in the HandPunch. You will first need to enroll yourself. Skip to step #7.
# You should be a star symbol ('''*''') on the bottom line of the display. If you do not then go back to step #1.
# Enter in your Clock ID and press Enter.
# The displays shows '''PLACE HAND'''. Place your hand.
# You should see '''ENTER PASSWORD''' in the display.
# Press 4 then press Enter.
# You will see '''ADD EMPLOYEE''' in the display. If you want to add an employee and NOT add a user that needs to enroll other people then answer Yes (#). If you are the first person being enrolled, or you want to enroll someone that will be enrolling other people, then answer No (*) and answer the next question ('''ADD SUPERVISOR''') with Yes (*).
# Enter in the clock ID of the person you are enrolling and press Enter. If you see '''SORRY CAN'T ADD''' in the display, the clock ID is already being used.
# You will see '''PLACE HAND''' in the display. The person being enrolled places their hand and the display shows '''REMOVE HAND'''. The person being enrolled will need to place and remove their hand 3 times to complete the enrollment.
# The display will return to the question ('''ADD EMPLOYEE''' / '''ADD SUPERVISOR'''). To get from the '''ADD SUPERVISOR''' menu to the '''ADD EMPLOYEE''' menu, press No (*) twice.
# Press Clear to exit from the supervisor menu.

==Un-Enrolling & Re-Enrolling==

To re-enroll a person, you first need to remove them from the HandPunch.

# From the main screen ('''ENTER ID'''), press Clear then Enter.
# You should be a star symbol ('''*''') on the bottom line of the display. If you do not then go back to step #1.
# Enter in your Clock ID and press Enter.
# The displays shows '''PLACE HAND'''. Place your hand.
# You should see '''ENTER PASSWORD''' in the display.
# Press 4 then press Enter.
# You will see '''ADD EMPLOYEE''' in the display.
# Answer No (*) twice.
# You will see '''REMOVE USER''' in the display.
# Answer Yes (#).
# You will see '''REMOVE ID''' # in the display.
# Enter the clock ID of the person you wish to remove and press Enter. *IMPORTANT* - do NOT enter your clock ID.
# You will see '''USER REMOVED''' in the screen briefly and then the display will return to '''REMOVE ID #'''.
# If you have another person that you want to remove then enter their clock ID, otherwise press Clear to get back to the '''REMOVE USER''' menu.
# Press No (*) and you will be at the '''ADD EMPLOYEE''' menu. You can now enroll the people that you removed.

== Simple Troubleshooting ==

* Correct hand placement is critical to successful enrollment and punching. The hand should be placed flat on the platen, with the fingers touching the pins. If a red light is lit, then the person being enrolled is not touching that pin with their finger.
* The wrist should be visible when punching. If the wrist is not visible then clothing might block the camera from successfully scanning the hand.
* The HandPunch needs to be kept clean. See [[HandPunch Maintenance]] for maintenance and cleaning instructions.

== See also ==

* [[HandPunch]]
* [[HandPunch Maintenance]]
* [[HandPunch Troubleshooting]]

HandPunch Enrollment

2015-11-23T16:35:31Z

Deb:

[[image:HandPunch.png|right]]

== Preparation ==

== Enrolling ==

To enroll an employee you need to access the supervisor menu.

# From the main screen ('''ENTER ID'''), press Clear then Enter.
# If you see '''ENTER PASSWORD''' in the display then there are no users currently enrolled in the HandPunch. You will first need to enroll yourself. Skip to step #7.
# You should be a star symbol ('''*''') on the bottom line of the display. If you do not then go back to step #1.
# Enter in your Clock ID and press Enter.
# The displays shows '''PLACE HAND'''. Place your hand.
# You should see '''ENTER PASSWORD''' in the display.
# Press 4 then press Enter.
# You will see '''ADD EMPLOYEE''' in the display. If you want to add an employee and NOT add a user that needs to enroll other people then answer Yes (#). If you are the first person being enrolled, or you want to enroll someone that will be enrolling other people, then answer No (*) and answer the next question ('''ADD SUPERVISOR''') with Yes (*).
# Enter in the clock ID of the person you are enrolling and press Enter. If you see '''SORRY CAN'T ADD''' in the display, the clock ID is already being used.
# You will see '''PLACE HAND''' in the display. The person being enrolled places their hand and the display shows '''REMOVE HAND'''. The person being enrolled will need to place and remove their hand 3 times to complete the enrollment.
# The display will return to the question ('''ADD EMPLOYEE''' / '''ADD SUPERVISOR'''). To get from the '''ADD SUPERVISOR''' menu to the '''ADD EMPLOYEE''' menu, press No (*) twice.
# Press Clear to exit from the supervisor menu.

==Un-Enrolling & Re-Enrolling==

To re-enroll a person, you first need to remove them from the HandPunch.

# From the main screen ('''ENTER ID'''), press Clear then Enter.
# You should be a star symbol ('''*''') on the bottom line of the display. If you do not then go back to step #1.
# Enter in your Clock ID and press Enter.
# The displays shows '''PLACE HAND'''. Place your hand.
# You should see '''ENTER PASSWORD''' in the display.
# Press 4 then press Enter.
# You will see '''ADD EMPLOYEE''' in the display.
# Answer No (*) twice.
# You will see '''REMOVE USER''' in the display.
# Answer Yes (#).
# You will see '''REMOVE ID''' # in the display.
# Enter the clock ID of the person you wish to remove and press Enter. *IMPORTANT* - do NOT enter your clock ID.
# You will see '''USER REMOVED''' in the screen briefly and then the display will return to '''REMOVE ID #'''.
# If you have another person that you want to remove then enter their clock ID, otherwise press Clear to get back to the '''REMOVE USER''' menu.
# Press No (*) and you will be at the '''ADD EMPLOYEE''' menu. You can now enroll the people that you removed.

== Simple Troubleshooting ==

* Correct hand placement is critical to successful enrollment and punching. The hand should be placed flat on the platen, with the fingers touching the pins. If a red light is lit, then the person being enrolled is not touching that pin with their finger.
* The wrist should be visible when punching. If the wrist is not visible then clothing might block the camera from successfully scanning the hand.
* The HandPunch needs to be kept clean. See [[HandPunch Maintenance]] for maintenance and cleaning instructions.

== See also ==

* [[HandPunch]]
* [[HandPunch Maintenance]]
* [[HandPunch Troubleshooting]]

Budget

2015-10-16T15:54:23Z

Deb: Created page with "Budget configuration shows the budgeted shift count and hours as defined for each day of the week, shift and labor level combination. Any labor level defined as a "budget" le..."

Budget configuration shows the budgeted shift count and hours as defined for each day of the week, shift and labor level combination.

Any labor level defined as a "budget" level in the [[System Configuration#Labor_Levels|System configuration]] is available from the labor level selection.

To delete a budget entry, select the row in the budget grid and press the Delete key or click on Delete Budget Entry.

== See also ==

* [[Configuration]]

Scheduler Implementation

2015-10-16T15:51:51Z

Deb:

Scheduler implementation is comprised of 4 main steps:

* Configuration
**Define [[Budget]]
**Create [[Labor Levels]]
**Create [[Scheduler Period]]
**Create [[Base Schedules]]

* Data Entry
** Entering [[Employee Work Pattern|Work Patterns]]
** Entering [[Employee Scheduling|Schedule Patterns]]
** Entering [[Employee Scheduling|Planned Absences]]
* Reports
** Daily Staffing Sheet
** Monthly Schedule
* Using the [[Scheduler]]

Scheduler Implementation

2015-10-14T15:16:52Z

Deb:

Scheduler implementation is comprised of 4 main steps:

* Configuration
* Data Entry
** Entering Work Patterns
** Entering Planned Absences
* Reports
** Daily Staffing Sheet
** Monthly Schedule
* Using the [[Scheduler]]

Pivot Grid

2015-06-29T14:39:50Z

Deb:

A pivot grid report allows you to summarize data into a table-based view with grouping by rows and/or by columns.

The pivot grid has four areas:

*'''Data area''' – the top left corner of the pivot grid is for the field(s) that will display in the data area. These are the fields that are summarized, e.g. the total hours, or the employee count.

*'''Row area and Column area''' – running down the left side, and across the top are the field(s) that affect how the data is grouped and summarized. The cell at the intersection of a row and a column represents the summary of the data that matches to both the row and the column values, e.g. the total of the REG hours for Department 3838.

*'''Filter area''' – the field(s) used in the filter area do not affect how the report data is grouped or summarized, but limits what data is being used in the pivot grid.

Run the pivot grid reports from the Reports ribbon tab. You are given the standard report selection screen where you can do an initial filtering of the employees and the date range. If you are running historical reports then you will most likely want to include inactive employees (Current Status tab). Click on the Run button and the pivot grid screen displays with the default layout.

[[image:PivotGridRibbon.png]]

The ribbon at the top of the screen provides you with the ability to output the report, modify the font and manage the layouts.

The pivot grid itself occupies the majority of the screen.

[[image:PivotGrid.png]]

Shown above is the Hours pivot grid. In this example, the Filter area does not contain any fields. Below the filter area is the "Hours" field. The field(s) in the corner area are the Data fields. In this example, we are summarizing the Hours.

Below the "Hours" field, there is the "Employee Name" field. This is the Row area. In this example, we are summarizing the Hours by the Employee Name.

To the right of the "Hours" field are two fields. This is the Column area. The fields are "Week Ending" and "Pay Type ID". The data is being summarized by the week ending date of the hours, and then by the pay type that was used to pay the hours.

At the intersection of a row value and a column value is the summary of the data. For example, in the week ending 5/12/2007, employee "Armitage, Erin" has 22.50 REG hours and 15.00 SIC hours.

You can modify the pivot grid by removing the "Week Ending" field from the column area. Place your mouse over the "Week Ending" field and right click to see the context menu. Click on Hide so that the field is removed from the Column area.

[[image:PivotGridFieldMenu.png]]

The pivot grid now looks like this:

[[image:PivotGrid2.png]]

The employee "Armitage, Erin" now has 96.75 REG hours because this is the total REG hours of all the data. Without the "Week Ending" field, we are seeing the hours summarized only by "Employee" and "Pay Type ID."

'''Adding Fields'''

If you right click anywhere outside of the Data area you will get a menu where you can select Show Fields List.

[[image:PivotGridFieldList.png]]

From the Fields List you can drag a field into the pivot grid. In this example, we will drag the Department Description field to the left of the Employee Name field. This will summarize the data by Department and then by Employee.

[[image:PivotGrid3.png]]

As well as grouping the data by department, it is also giving us departmental totals.

If we were to hide the Employee Name field, then we would be summarizing only by Department and Pay Type.

[[image:PivotGrid4.png]]

'''Sorting'''

If you click on a field name, the sorting will switch, from ascending to descending, or from descending to ascending. The arrow on the right of the field indicates if the field is ascending (up arrow), or descending (down arrow).

'''Filtering'''

When you place the mouse over a field, the filter icon appears in the top right corner. If you click on this icon, a drop down list appears. You can then select or unselect items to apply filtering on the data.

[[image:PivotGridFilter.png]]

[[image:PivotGridFilterDropDown.png]]

If you want to filter the data but do not want that field used to affect how the data is summarized, then place the field in the Filter area at the very top of the pivot grid.

'''Formatting'''

Columns can be resized so that you get more data across the screen. The font can be changed so that the pivot grid grows or shrinks with the font size.

'''Output'''

The pivot grid can be printed, saved or emailed as a PDF or an Excel file.
'''Layouts'''

After modifying the report, you can save the layout to a file. The layout does not include any data. It includes only the arrangement and formatting of the report. Layouts are safe to share with other users who are summarizing different employees' data. The layouts are saved to a common folder for each type of pivot grid report.

==See Also==
*[[Reports]]
*[[Hours Reports]]
*[[Attendance Reports]]
*[[Budget Reports]]
*[[Scheduling Reports]]

User Preferences

2015-06-29T14:34:44Z

Deb:

[[Image:EmployeesGroupUserPreferences.png|right]]

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

==Employee Grouping==

[[Image:EmployeeGroupingTabPage.png|right|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|right|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). Right click in the text box for a menu of tags that you can use to build the Employee Info Text. The tags are replaced by the selected employee's information.

For example "Emp # <EmployeeID> - <FirstName> <LastName>." will display as "Emp # 12345 - Joe Smith.".

==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|right|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|right|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|right|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)]]