sbv.wiki - User contributions [en]

Custom Configuration

2026-08-06T21:03:38Z

Joel: /* Other */

{{Advanced}}

The Custom configuration screen allows system configuration settings that would typically apply to the software as a whole to be applied based on criteria. Custom configuration settings use a text based identifier combined with a value that can be a true/false, a string, a number or a date. Each custom configuration settings will use some or all of the following criteria:

* Labor Levels (home or worked based on the setting)
* Pay Rule
* Base Schedule Group
* Holiday Group
* Accrual Group
* Pay Type
* Accrual Pay Type
* Shift (home or worked based on the setting)
* Employed Date Range
* Effective Date Range
* Employee Shift Count
* Employee Shift Type

Each custom configuration settings uses a Custom Configuration ID that uniquely identifies the setting. Each setting will use either the true/false, string, numerical or date value. The following are the current custom configuration settings supported:

==Settings==

===Payroll===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| ADP payroll export group by week number option is used when there is a biweekly payroll and using weighted overtime
| ADPPayrollExportGroupByWeekNumber
| True / False value
| False
|

|-
| David Klein # 1 payroll interface option to group hours by pay date
| DavidKleinPayrollExportGroupByPayDate
| True / False Value
| True
| If true (default) then it will export separate rows for each pay date for each employee. If false (check box unselected) then it will export just a total for the whole pay period.

|-
| David Klein # 1 payroll interface option to group hours by shift
| DavidKleinPayrollExportGroupByShift
| True / False Value
| False
|

|-
| Evolution payroll interface option to place the department in a different column
| EvolutionDepartmentColumn
| String Value
| "C"
| Use any of these to indicate the column: "B", "C", "D", "E", "G", "H". Enter "NONE" to not show the department at all. Only the labor level filters will work with this custom configuration.

|-
| Kronos payroll interface option to put the hours value for a pay type in the amount column
| KronosPayrollExportAsAmount
| True / False Value
| False
| The pay type column should NOT be empty

|-
| Kronos payroll interface option to group hours by shift
| KronosPayrollExportGroupByShift
| True / False Value
| False
| The E Shift column will contain the first letter of the Shift ID

|-
| Kronos payroll interface option to consider pay types that do not add to totals to not be differentials
| KronosPayrollExportIsNotDifferential
| True / False Value
| False
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for custom E/D/T External ID for differential pay types
| KronosExportEDTExternalID
| String Value
| "Differential"
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for custom Pay Statement Type
| KronosExportPayStatementType
| String Value
| "Regular"
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for duplicate entry using a different payroll pay code
| KronosExportDuplicateEntry
| String Value
| No additional line added if not present
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Millennium payroll interface (single company) option to group hours by shift
| MillenniumPayrollSingleCompanyGroupByShift
| True / False Value
| False
| This adds an additional column named Shift

|-
| Millennium payroll interface (single company) always show department
| MillenniumPayrollSingleCompanyAlwaysShowDepartment
| True / False Value
| False
| Department is only placed by default when the worked department does not equal the home department

|-
| Millennium payroll interface (single company) CC1 column labor level level
| MillenniumPayrollSingleCompanyExportCC1LaborLevelLevel
| Integer Value
| Department Level
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC2 column labor level level
| MillenniumPayrollSingleCompanyExportCC2LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC3 column labor level level
| MillenniumPayrollSingleCompanyExportCC3LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC4 column labor level level
| MillenniumPayrollSingleCompanyExportCC4LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC5 column labor level level
| MillenniumPayrollSingleCompanyExportCC5LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Viventium Payroll Export option to group hours by pay date
| ViventiumPayrollExportGroupByPayDate
| True / False Value
| True
| If true (default) then it will export separate rows for each pay date for each employee. If false (check box unselected) then it will export just a total for the whole pay period for each employee. This is a whole software-wide setting and can't use any filters.

|-
| Viventium Payroll Export 1st Additional Labor Level level
| ViventiumPayrollExport1stAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium Payroll Export 2nd Additional Labor Level level
| ViventiumPayrollExport2ndAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium Payroll Export 3rd Additional Labor Level level
| ViventiumPayrollExport3rdAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium payroll export Accrual Balances as Memo
| ViventiumUseMemoForAccrualBalances
| True / False Value
| False
| This will export the accrual balances in the last column which will go on the pay stub as a memo, instead of the accrual balances getting exported as an extra line deduction (D).

|-
| Viventium payroll export hours format
| ViventiumPayrollExportHoursFormat
| String Value
| 0.0000
|

|-
| Viventium payroll export rate format
| ViventiumPayrollExportRateFormat
| String Value
| 0.0000
|
|}

===Scheduling===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Daily Staffing sheet employee sort order
| DailyStaffingSheetEmployeeSortOrder
| String Value
| FullName
| FullName or Seniority are the current 2 options

|-
| Monthly Schedule Area Acceptor determines how schedules match to the areas defined on the monthly schedule
| MonthlyScheduleAreaAcceptor
| String Value
| WorkedShiftWorkedBudgetGroupWorkedFloor
| Format is _____Shift_____BudgetGroup____Floor with options of Any, Home or Worked. E.g. AnyShiftWorkedBudgetGroupWorkedFloor

|-
| Time Restriction Early In Allowance
| TimeRestrictionEarlyInAllowance
| Integer Value
| 7
|

|-
| Time Restriction Late Out Allowance
| TimeRestrictionLateOutAllowance
| Integer Value
| 7
|
|}

===Pay Types===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Specify pay types that will be treated like worked hours for the worked days in week / pay period qualifier on holiday calculation
| ConsideredWorkedForHolidayWorkedDaysQualifier
| True / False value
| False
| On or after holiday is supported

|-
| Override pay type configuration Punches Count Towards Daily Overtime rule
| PunchesCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Period Overtime rule
| PunchesCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Premium rule
| PunchesCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Holiday Overtime rule
| PunchesCountTowardsHolidayOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Accrual rule
| PunchesCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Daily Overtime rule
| OtherHoursWorkedCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Period Overtime rule
| OtherHoursWorkedCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Premium rule
| OtherHoursWorkedCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Holiday Overtime rule
| OtherHoursWorkedCountTowardsHolidayOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Accrual rule
| OtherHoursWorkedCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Daily Overtime rule
| OtherHoursUnworkedCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Period Overtime rule
| OtherHoursUnworkedCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Actual Date Towards Period Overtime rule
| OtherHoursUnworkedCountActualDateTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Premium rule
| OtherHoursUnworkedCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Actual Date Towards Premium rule
| OtherHoursUnworkedCountActualDateTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Accrual rule
| OtherHoursUnworkedCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Accrual rule
| PremiumCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Period Overtime rule
| PremiumCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Premium rule
| PremiumCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Do not allow use of a pay type until the employee has been employed for X number of days
| PayTypeSenorityDays
| Integer value
| 0
| Actual date of other hours must be greater than or equal to hire date plus seniority days. E.g. if employed on January 1 and seniority days is 7 then actual date must be January 8th or later. Effectively we are saying that the 7 days have been completed and so on the 8th you can use this pay type.

|-
| Count all pay types that Add-To-Total, for specific differential ID "CAPTATTFDI"
| CountAllPayTypesAddToTotalForDifferentialIdCAPTATTFDI
| True / False value
| False
| This will override the setting on pay types if they are set to not count for premiums. Fill in the special code "CAPTATTFDI" anywhere in the Premium ID/name, and it will count all pay types that Add-To-Total for this differential. Filters are not in effect for this custom configuration and is in effect for the whole software (use the premium worked labor level filters instead if needed). This custom configuration only works for differentials.

|}

===Time Clocks===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| When using multi facility punching it will set the facility on the punch the same as the time clock's facility.
| OverrideFacilityLaborLevelSameAsTimeClock
| True / False value
| False
| This is a global setting for the entire software and does not use any filters.

|-
| Fingercheck Clock Download Punches Look Back Days
| FingercheckPollLookBackDays
| Integer Value
| 3
| Even though duplicates are discarded, it will still be slow to go back to much. This is a global setting for the entire software and does not use any filters.

|-
| Wdms Time Clock Supervisor Code
| WdmsTimeClockSupervisorCode
| Integer Value
| 2
| The code that will be sent to WDMS for the employees that are marked in TA as a clock supervisor. 2 = Register, 6 = System Administrator, 14 = Super Administrator. Before setting this value make sure that the role exists in the clock. The facility labor level filter can be used to set it for a specific facility in a Multi-Facility software. Minimum TA version required: 4.6.8446.1937

|-
| Time Restriction Early In Allowance
| TimeRestrictionEarlyInAllowance
| Integer Value
| 7
|

|-
| Time Restriction Late Out Allowance
| TimeRestrictionLateOutAllowance
| Integer Value
| 7
|
|}

===Accruals===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Pretend that the employee worked the number of hours in their shift history for accrual proposes.
| AccrueAtShiftCountTimesDailyHoursLevel
| True / False value
| False
| The Employee could have not worked at all, or worked less, or worked more, but will still pretend that the employee actually worked the exact shift history hours (shift count x daily hours). This number of pretend worked hours will then be used to calculate the accruals. Any other accrual calculation settings will apply afterward on top of this number.

|-
| Employee accrues without any limit in the accrual period. This allows a more fine-grained approach than the accrual group provides.
| AccrualNoMaximumContributingMinutes
| True / False value
| False
|

|-
| Employee accrues their full-time shift count if they worked less or even if they didn't actually work at all. This allows a more fine-grained approach than the accrual group provides.
| CalculateFullAccrualEarning
| True / False value
| False
|

|-
| Minimum worked hours in 2 weeks required to get accrual annual entitlements
| AccrualAnnualEntitlementsMinimumWorkedHoursIn2Weeks
| Decimal value
| 0
| Employee has to work this minimum amount of hours in 2 weeks to be eligible to earn any accrual annual entitlements for the current accrual period. For a bi-weekly accrual period, it's the hours worked in the current accrual period. For a weekly accrual period, it's the total hours worked in the current week and the previous week. (Maryland Sick law).

|-
| Minimum worked hours required in current accrual period to get accrual annual entitlements
| AccrualAnnualEntitlementsMinimumWorkedHoursInCurrentAccrualPeriod
| Decimal value
| 0
| Employee has to work this minimum amount of hours in the in current accrual period to be eligible to earn any accrual annual entitlements for the current accrual period.

|-
| Add custom date field to use for Employee Accruals Seniority. This date field will override default accruals configuration if filled out.
| UseEmployeeDate3ForAccrualStartDate
| True / False value
| False
| You can use either the Date 3 field or Date 4 field (if you use the Date 4 field you need to change the custom configuration to UseEmployeeDate4ForAccrualStartDate). To change the text displayed next to the date field you would go to Configuration-->Setup-->System-->Employment.

|-
| Override Use Hire Date For Seniority.
| UseHireDateForSeniority
| True / False value
| False
| This can be used to set it for each facility in a Multi-facility software.

|-
| Override Accrual Period Group Full Time Shift Count.
| AccrualPeriodGroupFullTimeShiftCount
| Decimal value
| Full Time Shift Count on the Accrual Period Group
| This can be used to override the Full Time Shift Count for a specific date range when switching accrual periods from weekly to biweekly or vise versa. Use the current Full Time Shift Count in the accrual period group and override for the past with the custom config using the effective to date. Filter for a specific accrual group.

|}

===Other===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Override the pay type that the schedule displays and uses for the initial calculation of hours
| BaseSchedulePayTypeID
| String Value - enter the pay type ID
| Ignored
| This is an intercept and does not change the underlying value. When using the scheduler and a schedule is given to an employee without this override in place, the original pay type will be used.

|-
| Do not deduct lunch when the lunch question at the time clock was answered "Not Taken"
| DoNotDeductLunchWhenLunchQuestionAnsweredNotTaken
| True / False Value
| False
|

|-
| Do not deduct lunch when the lunch question at the time clock was not answered i.e. "Unknown"
| DoNotDeductLunchWhenLunchQuestionNotAnswered
| True / False Value
| False
|

|-
| In a multi-facility configuration, if employees have worked hours in another facility then this will put those hours into the PBJ file of the worked facility.
| EmployeesHavePBJHoursInMultipleFacilities
| True / False Value
| False
| The PBJ file has to be created for all facilities that any employee in a selected facility has worked in. E.g., if you are running PBJ for facility A and facility A employees worked in facility B then you must create the file for facility B at the same time. If employees in facility B worked in facility C then facility C must be included. Also, if there are employees not in facility A, B or C that have hours in A, B or C then you must also include those facilities.

|-
| Maximum hours that will calculate from a "Time" differential premium used on the worked holiday tab of holiday configuration
| WorkedHolidayDifferentialMaximumMinutes
| IntegerValue
| 9999
| This is the number of minutes so multiple an hour maximum by 60. This only works with Time Premiums or Time & Shift Premiums.

|-
| Phantom punches are temporary punches added between shifts so as to calculate double shifts correctly. This setting will calculate the time cards in a similar manner as if Out/In punches were added manually.
| CalculatePhantomPunchesLikeActualPunches
| True / False value
| False
| This does not split shifts to different pay dates as pay date determination is done prior to the adding of phantom punches.

|-
| Department Of Labor Weighted Overtime Pay Rate Calculations for specific labor levels only
| DepartmentOfLaborPayRateCalculations
| True / False value
| False
|

|-
| HHSOIG report requires birth dates to match (both must exist)
| HHSOIGBirthDateMatch
| True / False value
| False
|

|-
| SAM report requires zip codes to match (both must exist)
| SAMZipCodeMatch
| True / False value
| False
|

|-
| 6th pay date overtime level minimum minutes.
| SixthPayDateOvertimeLevelMinimumMinutes
| Integer value
| 0
| It will only pay the 6th Pay Date OT if they already have the minimum minutes in the period. A common example is to set the minimum to 37.5 hours so that it only starts paying the 6th Pay Date OT after they already have 37.5. If the 37.5 is reached in the middle of the 6th pay date, it will pay the OT partially from 37.5 till the end of the day. The Fixed Hour Level in overtime configuration is the maximum overtime level.

|-
| Disregards any Is Hire Date on employee status and the global rule about first / last active status as hire date such that the latest active status is ALWAYS the hire date.
| LatestActiveStatusAlwaysConsideredHireDate
| True / False value
| False
|

|-
| If shift count times daily hours is less than this number than employee shift type is changed to PD when adding employee shifts
| PartTimeShiftTypeMinimumShiftCountTimesDailyHours
| Decimal value
| -1 (ignored)
|

|-
| If shift count times daily hours is greater than this number than employee shift type is changed to FT when adding employee shifts
| PartTimeShiftTypeMaximumShiftCountTimesDailyHours
| Decimal value
| -1 (ignored)
| E.g. if 30 hours is considered full time then enter 29.99

|-
| Enable Software to export data to In-House Health FTP Site
| InHouseHealthExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software (filtering not applicable) and does not need a separate entry for each facility in a Multi-Facility software.

|-
| Enable Software to export data to Keeper FTP Site
| KeeperExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software (filtering not applicable) and does not need a separate entry for each facility in a Multi-Facility software. Will also need to provide the IP of the software server as Keeper uses whitelisting.

|-
| Enable Software to export data to Stafflion FTP Site
| StafflionPunchExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software (filtering not applicable) and does not need a separate entry for each facility in a Multi-Facility software.

|-
| Enable Software to export data to TapCheck FTP Site
| TapcheckExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software (filtering not applicable) and does not need a separate entry for each facility in a Multi-Facility software.

|-
| Add custom date field to use for Holiday and Worked Holiday Seniority. This date field will override the default (Hire Date) if filled out.
| UseEmployeeDate3ForHolidaySeniority
| True / False value
| False
| You can use either the Date 3 field or Date 4 field (if you use the Date 4 field you need to change the custom configuration to UseEmployeeDate4ForHolidaySeniority). To change the text displayed next to the date field you would go to Configuration-->Setup-->System-->Employment.

|-
| Offset for Premium Qualifier Worked Hours Summary Type Required On Each Day to Use Night, Day, Eve.
| WorkedHoursSummaryEachDayInPeriodQualifierOffset
| True / False value
| False
| If False, it will use the shift sort order. If True, it will use the prior day for shift 3.

|}

System Configuration

2026-06-11T16:14:18Z

Joel: /* Pictures / Signatures */

{{Advanced}}

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

== General ==

[[File:System.png]]

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 - determines what information to display on the Main tab using the information from the [[Employee History|employee's history]] tab. If the date of a change occurs on or before the date that is selected in this setting, then that change would be considered to be the employee's current setting and displays on the Main tab.

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 decreases the load time as you navigate from employee to employee.

Pay Holidays – 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 for determining seniority unless this is selected. Once selected, the first non-zero shift count entry in the employee's [[Employee Work Pattern|work pattern]] tab is used.

Use Non Zero Shift Count for Worked Holiday Seniority - as above but for the worked holiday calculation.

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 more because 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 generally required to be taken per schedule worked. 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 multiple 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 ==

[[image:System_Defaults.png]]

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.

''Latest Active Status is considered Hire Date'' - If having multiple Active Statuses on a single employee, the software will assume that the hire date is the last Active Status. By default the software assumes that the hire date is the earliest Active Status. (An employee can have only one real Hire Date even if they get rehired multiple times). As soon as an Is Hire Date check box gets selected on the Shift History it overrides any software assumptions and forces the software to use that as the hire date.

== Time Clocks ==

[[image:System_Time_Clocks.png]]

''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). (As an example, if this is set to 1, then the 2nd punch that has the same time as the first punch will be hidden. If the 2nd punch is 1 minute later then it will not be considered duplicate and will be displayed). 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 Minute'' - clock [[tasks]] that run hourly will run when they start in the same minute as this setting.

''Allow Multiple Clock IDs'' - used if it's required for an employee to punch with 2 clock ID's for the same time card. The 2nd clock ID can be used to automatically assign those hours with a different department or other labor level. On the Clock Info tab it will show a number on the top right corner which indicates 1st clock ID or 2nd Clock ID.

''Allow Multi Facility All Time Clocks'' - used if it's required for an employee to punch in another facility which is not their home-facility. On the Clock Info tab it will show a check-box which can be used to display time clocks from other facilities. Please note that the software will not check for duplicate clock ID's accrues facilities. You will need to keep track on your own to make sure that these multi-facility employees have unique Clock ID's which no one else is using.

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

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

''Remove Unlicensed Employee'' - will check the License 1 if the expire date is older then today or empty. It will ignore the expire date if the license is set to Not Applicable. This setting only works for a Hand Punch.

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

''Show Lunch Taken Exceptions'' - calculates exceptions on out punches for the Lunch questions asked at the HandPunch.

''Lunch Not taken Exception When No Lunch Deduction'' - Generates the Lunch-Not-Taken exception anytime the employee answered at the clock Lunch-Not-Taken even if the software didn't deduct lunch automatically, (the grace minutes below will also be ignored). This is useful if the software is customized to not deduct lunch automatically depending on the employee's answer at the clock.

''Lunch Unknown Exception'' - gets generated if the employee didn't answer at the clock the lunch question.

''Lunch Not Taken Exception'' - gets generated only if both are true, the employee answered at the clock Lunch-Not-Taken AND the software deducted lunch automatically.

''Lunch Taken exception'' - gets generated if the employee answered at the clock Lunch-Taken.

''Lunch Not Required Exception'' - gets generated only if a software user manually sets Lunch-Not-Required on the Punch.

== Labor Levels ==

[[image:System_Labor_Levels.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 ==

[[image:System_Labor_Levels_Destinations.png]]

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

[[image:System_Labor_Levels_Assignments.png]]

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

[[image:System_Pictures_Signatures.png]]

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

Picture Folder – the folder where all pictures are placed so that they are visible for all users for on-premises software (\\Server\Ta... etc). For Cloud software, it should be blank, and pictures will only be enabled when opening the software from the webpage.

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

== Shift Count Lookup ==

[[image:System_Shift_Count_Lookup.png]]

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

[[image:System_Health.png]]

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

[[image:System_Exceptions.png]]

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

== Payroll ==

[[image:System_Payroll.png]]

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

[[image:System_Scheduling.png]]

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

[[image:System_Scheduler.png]]

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.

== Census ==

[[image:System_Census.png]]

== Prior Scheduler ==

[[image:System_Prior_Scheduler.png]]

== Accruals ==

[[image:System_Accruals.png]]

''Projected Months'' - How far in advance the software should display projected accruals on the employee's Accrual Detail tab automatically. This affects the software speed when making time card edits, as for every edit all these future accrual months have to be recalculated. To speed up the software, lower the months and instead use the Recalculate-Accruals + Shift button to project a year in advance when needed.

======Days In Accrual Year======

* ''Accrual Periods in Accrual Period Group'' - This option will take all accrual periods associated with a specific accrual year and then count up the number of days in each period and then sums the total to get the number of days in the accrual year. Using this option will cause your weekly entitlements to potentially change from year to year since it is possible to have an extra period every few years. (Most years will be 52-weeks/26-biweeks or 364 days, but once in a while a year will be 53-weeks/27-biweeks or 371/378 days).

* ''Actual days In Calendar Year'' - This option will count the number of days in that specific calendar year and divide your annual entitlement by that number. Most years will be 365, however a leap year will have 366. Selecting this option will mean that the period entitlement can change from year to year even though the annual entitlement is the same for each year.

* ''364 Days'' - This option will take your annual entitlement and divide it by 364 days every year. Your period entitlement will never change with this method.

* ''365 1/4 Days'' - This option will take your annual entitlement and divide it by 365.25 days every year. Your period entitlement will never change with this method.

* ''Employee's Accrual Year (Anniv. to Anniv.)'' - This option is used if you want to see the full entitlement earned as of the employee anniversary (an employee who used no time, will have their exact annual entitlement on the day of the anniversary). When selecting this, the software will release each period's earnings in the next period. The accrual year is obtained by counting the number of accrual periods that are in the employee anniversary year and then dividing the annual entitlement by that number to get the amount earned per period. Using this option will cause your weekly entitlements to potentially change from anniversary-year to anniversary-year since it is possible to have an extra period every few anniversary-years. (Most anniversary-years will be 52-weeks/26-biweeks or 364 days, but once in a while an anniversary-year will be 53-weeks/27-biweeks or 371/378 days). If you are using this method you can never switch between bi-weekly and weekly periods at any point in time.

''Do Not Project Current accrual Period'' - Displays the actual balance for the current accrual period according to what the employee already worked so far in the period even though the period has not ended yet so we don't know what it will actually be on the end of the period. Unlike future periods which show a projected balance. This is useful to be able to see how much the employee accrued so far in the period.

== Scheduled Tasks ==

[[image:System_Scheduled_Tasks.png]]

== Text Messaging ==

[[image:System_Text_Messaging.png]]

== Remote Server ==

[[image:System_Remote_Server.png]]

== See also ==

* [[Configuration]]

System Configuration

2026-06-11T16:12:49Z

Joel: /* Pictures / Signatures */

{{Advanced}}

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

== General ==

[[File:System.png]]

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 - determines what information to display on the Main tab using the information from the [[Employee History|employee's history]] tab. If the date of a change occurs on or before the date that is selected in this setting, then that change would be considered to be the employee's current setting and displays on the Main tab.

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 decreases the load time as you navigate from employee to employee.

Pay Holidays – 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 for determining seniority unless this is selected. Once selected, the first non-zero shift count entry in the employee's [[Employee Work Pattern|work pattern]] tab is used.

Use Non Zero Shift Count for Worked Holiday Seniority - as above but for the worked holiday calculation.

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 more because 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 generally required to be taken per schedule worked. 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 multiple 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 ==

[[image:System_Defaults.png]]

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.

''Latest Active Status is considered Hire Date'' - If having multiple Active Statuses on a single employee, the software will assume that the hire date is the last Active Status. By default the software assumes that the hire date is the earliest Active Status. (An employee can have only one real Hire Date even if they get rehired multiple times). As soon as an Is Hire Date check box gets selected on the Shift History it overrides any software assumptions and forces the software to use that as the hire date.

== Time Clocks ==

[[image:System_Time_Clocks.png]]

''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). (As an example, if this is set to 1, then the 2nd punch that has the same time as the first punch will be hidden. If the 2nd punch is 1 minute later then it will not be considered duplicate and will be displayed). 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 Minute'' - clock [[tasks]] that run hourly will run when they start in the same minute as this setting.

''Allow Multiple Clock IDs'' - used if it's required for an employee to punch with 2 clock ID's for the same time card. The 2nd clock ID can be used to automatically assign those hours with a different department or other labor level. On the Clock Info tab it will show a number on the top right corner which indicates 1st clock ID or 2nd Clock ID.

''Allow Multi Facility All Time Clocks'' - used if it's required for an employee to punch in another facility which is not their home-facility. On the Clock Info tab it will show a check-box which can be used to display time clocks from other facilities. Please note that the software will not check for duplicate clock ID's accrues facilities. You will need to keep track on your own to make sure that these multi-facility employees have unique Clock ID's which no one else is using.

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

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

''Remove Unlicensed Employee'' - will check the License 1 if the expire date is older then today or empty. It will ignore the expire date if the license is set to Not Applicable. This setting only works for a Hand Punch.

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

''Show Lunch Taken Exceptions'' - calculates exceptions on out punches for the Lunch questions asked at the HandPunch.

''Lunch Not taken Exception When No Lunch Deduction'' - Generates the Lunch-Not-Taken exception anytime the employee answered at the clock Lunch-Not-Taken even if the software didn't deduct lunch automatically, (the grace minutes below will also be ignored). This is useful if the software is customized to not deduct lunch automatically depending on the employee's answer at the clock.

''Lunch Unknown Exception'' - gets generated if the employee didn't answer at the clock the lunch question.

''Lunch Not Taken Exception'' - gets generated only if both are true, the employee answered at the clock Lunch-Not-Taken AND the software deducted lunch automatically.

''Lunch Taken exception'' - gets generated if the employee answered at the clock Lunch-Taken.

''Lunch Not Required Exception'' - gets generated only if a software user manually sets Lunch-Not-Required on the Punch.

== Labor Levels ==

[[image:System_Labor_Levels.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 ==

[[image:System_Labor_Levels_Destinations.png]]

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

[[image:System_Labor_Levels_Assignments.png]]

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

[[image:System_Pictures_Signatures.png]]

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

Picture Folder – the folder where all pictures are placed so that they are visible for all users for on-premises software. For Cloud software, it should be blank, and pictures will only be enabled when opening the software from the webpage.

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

== Shift Count Lookup ==

[[image:System_Shift_Count_Lookup.png]]

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

[[image:System_Health.png]]

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

[[image:System_Exceptions.png]]

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

== Payroll ==

[[image:System_Payroll.png]]

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

[[image:System_Scheduling.png]]

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

[[image:System_Scheduler.png]]

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.

== Census ==

[[image:System_Census.png]]

== Prior Scheduler ==

[[image:System_Prior_Scheduler.png]]

== Accruals ==

[[image:System_Accruals.png]]

''Projected Months'' - How far in advance the software should display projected accruals on the employee's Accrual Detail tab automatically. This affects the software speed when making time card edits, as for every edit all these future accrual months have to be recalculated. To speed up the software, lower the months and instead use the Recalculate-Accruals + Shift button to project a year in advance when needed.

======Days In Accrual Year======

* ''Accrual Periods in Accrual Period Group'' - This option will take all accrual periods associated with a specific accrual year and then count up the number of days in each period and then sums the total to get the number of days in the accrual year. Using this option will cause your weekly entitlements to potentially change from year to year since it is possible to have an extra period every few years. (Most years will be 52-weeks/26-biweeks or 364 days, but once in a while a year will be 53-weeks/27-biweeks or 371/378 days).

* ''Actual days In Calendar Year'' - This option will count the number of days in that specific calendar year and divide your annual entitlement by that number. Most years will be 365, however a leap year will have 366. Selecting this option will mean that the period entitlement can change from year to year even though the annual entitlement is the same for each year.

* ''364 Days'' - This option will take your annual entitlement and divide it by 364 days every year. Your period entitlement will never change with this method.

* ''365 1/4 Days'' - This option will take your annual entitlement and divide it by 365.25 days every year. Your period entitlement will never change with this method.

* ''Employee's Accrual Year (Anniv. to Anniv.)'' - This option is used if you want to see the full entitlement earned as of the employee anniversary (an employee who used no time, will have their exact annual entitlement on the day of the anniversary). When selecting this, the software will release each period's earnings in the next period. The accrual year is obtained by counting the number of accrual periods that are in the employee anniversary year and then dividing the annual entitlement by that number to get the amount earned per period. Using this option will cause your weekly entitlements to potentially change from anniversary-year to anniversary-year since it is possible to have an extra period every few anniversary-years. (Most anniversary-years will be 52-weeks/26-biweeks or 364 days, but once in a while an anniversary-year will be 53-weeks/27-biweeks or 371/378 days). If you are using this method you can never switch between bi-weekly and weekly periods at any point in time.

''Do Not Project Current accrual Period'' - Displays the actual balance for the current accrual period according to what the employee already worked so far in the period even though the period has not ended yet so we don't know what it will actually be on the end of the period. Unlike future periods which show a projected balance. This is useful to be able to see how much the employee accrued so far in the period.

== Scheduled Tasks ==

[[image:System_Scheduled_Tasks.png]]

== Text Messaging ==

[[image:System_Text_Messaging.png]]

== Remote Server ==

[[image:System_Remote_Server.png]]

== See also ==

* [[Configuration]]

Employee Employment Folder

2026-06-11T16:08:08Z

Joel:

The Employee Folder can be used to attach external files and folders to the employee.

For cloud software, it is only available as an additional module on the software license for a fee.

For on-premises software, it's available at no extra cost.

== See also ==

* [[Employee]]

* [[Employee Employment]]

Raw Punch Import

2026-04-21T17:46:32Z

Joel:

This imports raw punches, typically from an existing system where the punch information matches the employee’s clock ID.

{| class="wikitable"

|-
! Column Type
! Identifiers
! Required

|-
| Clock ID
| Clock ID
| Yes

|-
| Punch Date Time
| Punch Date, Punch Time, Punch Date Time
| Yes

|-
| Time Clock
| Time Clock
| Yes

|-
| Punch Type
| Punch Type
| No

|}

==See Also==

* [[Import]]

Custom Configuration

2026-02-17T15:36:17Z

Joel: /* Other */

Custom Configuration

2026-02-17T15:34:13Z

Joel: /* Other */

{{Advanced}}

The Custom configuration screen allows system configuration settings that would typically apply to the software as a whole to be applied based on criteria. Custom configuration settings use a text based identifier combined with a value that can be a true/false, a string, a number or a date. Each custom configuration settings will use some or all of the following criteria:

* Labor Levels (home or worked based on the setting)
* Pay Rule
* Base Schedule Group
* Holiday Group
* Accrual Group
* Pay Type
* Accrual Pay Type
* Shift (home or worked based on the setting)
* Employed Date Range
* Effective Date Range
* Employee Shift Count
* Employee Shift Type

Each custom configuration settings uses a Custom Configuration ID that uniquely identifies the setting. Each setting will use either the true/false, string, numerical or date value. The following are the current custom configuration settings supported:

==Settings==

===Payroll===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| ADP payroll export group by week number option is used when there is a biweekly payroll and using weighted overtime
| ADPPayrollExportGroupByWeekNumber
| True / False value
| False
|

|-
| David Klein # 1 payroll interface option to group hours by pay date
| DavidKleinPayrollExportGroupByPayDate
| True / False Value
| True
| If true (default) then it will export separate rows for each pay date for each employee. If false (check box unselected) then it will export just a total for the whole pay period.

|-
| David Klein # 1 payroll interface option to group hours by shift
| DavidKleinPayrollExportGroupByShift
| True / False Value
| False
|

|-
| Evolution payroll interface option to place the department in a different column
| EvolutionDepartmentColumn
| String Value
| "C"
| Use any of these to indicate the column: "B", "C", "D", "E", "G", "H". Enter "NONE" to not show the department at all. Only the labor level filters will work with this custom configuration.

|-
| Kronos payroll interface option to put the hours value for a pay type in the amount column
| KronosPayrollExportAsAmount
| True / False Value
| False
| The pay type column should NOT be empty

|-
| Kronos payroll interface option to group hours by shift
| KronosPayrollExportGroupByShift
| True / False Value
| False
| The E Shift column will contain the first letter of the Shift ID

|-
| Kronos payroll interface option to consider pay types that do not add to totals to not be differentials
| KronosPayrollExportIsNotDifferential
| True / False Value
| False
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for custom E/D/T External ID for differential pay types
| KronosExportEDTExternalID
| String Value
| "Differential"
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for custom Pay Statement Type
| KronosExportPayStatementType
| String Value
| "Regular"
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for duplicate entry using a different payroll pay code
| KronosExportDuplicateEntry
| String Value
| No additional line added if not present
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Millennium payroll interface (single company) option to group hours by shift
| MillenniumPayrollSingleCompanyGroupByShift
| True / False Value
| False
| This adds an additional column named Shift

|-
| Millennium payroll interface (single company) always show department
| MillenniumPayrollSingleCompanyAlwaysShowDepartment
| True / False Value
| False
| Department is only placed by default when the worked department does not equal the home department

|-
| Millennium payroll interface (single company) CC1 column labor level level
| MillenniumPayrollSingleCompanyExportCC1LaborLevelLevel
| Integer Value
| Department Level
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC2 column labor level level
| MillenniumPayrollSingleCompanyExportCC2LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC3 column labor level level
| MillenniumPayrollSingleCompanyExportCC3LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC4 column labor level level
| MillenniumPayrollSingleCompanyExportCC4LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC5 column labor level level
| MillenniumPayrollSingleCompanyExportCC5LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Viventium Payroll Export option to group hours by pay date
| ViventiumPayrollExportGroupByPayDate
| True / False Value
| True
| If true (default) then it will export separate rows for each pay date for each employee. If false (check box unselected) then it will export just a total for the whole pay period for each employee. This is a whole software-wide setting and can't use any filters.

|-
| Viventium Payroll Export 1st Additional Labor Level level
| ViventiumPayrollExport1stAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium Payroll Export 2nd Additional Labor Level level
| ViventiumPayrollExport2ndAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium Payroll Export 3rd Additional Labor Level level
| ViventiumPayrollExport3rdAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium payroll export Accrual Balances as Memo
| ViventiumUseMemoForAccrualBalances
| True / False Value
| False
| This will export the accrual balances in the last column which will go on the pay stub as a memo, instead of the accrual balances getting exported as an extra line deduction (D).

|-
| Viventium payroll export hours format
| ViventiumPayrollExportHoursFormat
| String Value
| 0.0000
|

|-
| Viventium payroll export rate format
| ViventiumPayrollExportRateFormat
| String Value
| 0.0000
|
|}

===Scheduling===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Daily Staffing sheet employee sort order
| DailyStaffingSheetEmployeeSortOrder
| String Value
| FullName
| FullName or Seniority are the current 2 options

|-
| Monthly Schedule Area Acceptor determines how schedules match to the areas defined on the monthly schedule
| MonthlyScheduleAreaAcceptor
| String Value
| WorkedShiftWorkedBudgetGroupWorkedFloor
| Format is _____Shift_____BudgetGroup____Floor with options of Any, Home or Worked. E.g. AnyShiftWorkedBudgetGroupWorkedFloor

|-
| Time Restriction Early In Allowance
| TimeRestrictionEarlyInAllowance
| Integer Value
| 7
|

|-
| Time Restriction Late Out Allowance
| TimeRestrictionLateOutAllowance
| Integer Value
| 7
|
|}

===Pay Types===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Specify pay types that will be treated like worked hours for the worked days in week / pay period qualifier on holiday calculation
| ConsideredWorkedForHolidayWorkedDaysQualifier
| True / False value
| False
| On or after holiday is supported

|-
| Override pay type configuration Punches Count Towards Daily Overtime rule
| PunchesCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Period Overtime rule
| PunchesCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Premium rule
| PunchesCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Holiday Overtime rule
| PunchesCountTowardsHolidayOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Accrual rule
| PunchesCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Daily Overtime rule
| OtherHoursWorkedCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Period Overtime rule
| OtherHoursWorkedCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Premium rule
| OtherHoursWorkedCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Holiday Overtime rule
| OtherHoursWorkedCountTowardsHolidayOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Accrual rule
| OtherHoursWorkedCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Daily Overtime rule
| OtherHoursUnworkedCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Period Overtime rule
| OtherHoursUnworkedCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Actual Date Towards Period Overtime rule
| OtherHoursUnworkedCountActualDateTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Premium rule
| OtherHoursUnworkedCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Actual Date Towards Premium rule
| OtherHoursUnworkedCountActualDateTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Accrual rule
| OtherHoursUnworkedCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Accrual rule
| PremiumCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Period Overtime rule
| PremiumCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Premium rule
| PremiumCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Do not allow use of a pay type until the employee has been employed for X number of days
| PayTypeSenorityDays
| Integer value
| 0
| Actual date of other hours must be greater than or equal to hire date plus seniority days. E.g. if employed on January 1 and seniority days is 7 then actual date must be January 8th or later. Effectively we are saying that the 7 days have been completed and so on the 8th you can use this pay type.

|-
| Count all pay types that Add-To-Total, for specific differential ID "CAPTATTFDI"
| CountAllPayTypesAddToTotalForDifferentialIdCAPTATTFDI
| True / False value
| False
| This will override the setting on pay types if they are set to not count for premiums. Fill in the special code "CAPTATTFDI" anywhere in the Premium ID/name, and it will count all pay types that Add-To-Total for this differential. Filters are not in effect for this custom configuration and is in effect for the whole software (use the premium worked labor level filters instead if needed). This custom configuration only works for differentials.

|}

===Time Clocks===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| When using multi facility punching it will set the facility on the punch the same as the time clock's facility.
| OverrideFacilityLaborLevelSameAsTimeClock
| True / False value
| False
| This is a global setting for the entire software and does not use any filters.

|-
| Fingercheck Clock Download Punches Look Back Days
| FingercheckPollLookBackDays
| Integer Value
| 3
| Even though duplicates are discarded, it will still be slow to go back to much. This is a global setting for the entire software and does not use any filters.

|-
| Wdms Time Clock Supervisor Code
| WdmsTimeClockSupervisorCode
| Integer Value
| 2
| The code that will be sent to WDMS for the employees that are marked in TA as a clock supervisor. 2 = Register, 6 = System Administrator, 14 = Super Administrator. Before setting this value make sure that the role exists in the clock. The facility labor level filter can be used to set it for a specific facility in a Multi-Facility software. Minimum TA version required: 4.6.8446.1937

|-
| Time Restriction Early In Allowance
| TimeRestrictionEarlyInAllowance
| Integer Value
| 7
|

|-
| Time Restriction Late Out Allowance
| TimeRestrictionLateOutAllowance
| Integer Value
| 7
|
|}

===Accruals===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Pretend that the employee worked the number of hours in their shift history for accrual proposes.
| AccrueAtShiftCountTimesDailyHoursLevel
| True / False value
| False
| The Employee could have not worked at all, or worked less, or worked more, but will still pretend that the employee actually worked the exact shift history hours (shift count x daily hours). This number of pretend worked hours will then be used to calculate the accruals. Any other accrual calculation settings will apply afterward on top of this number.

|-
| Employee accrues without any limit in the accrual period. This allows a more fine-grained approach than the accrual group provides.
| AccrualNoMaximumContributingMinutes
| True / False value
| False
|

|-
| Employee accrues their full-time shift count if they worked less or even if they didn't actually work at all. This allows a more fine-grained approach than the accrual group provides.
| CalculateFullAccrualEarning
| True / False value
| False
|

|-
| Minimum worked hours in 2 weeks required to get accrual annual entitlements
| AccrualAnnualEntitlementsMinimumWorkedHoursIn2Weeks
| Decimal value
| 0
| Employee has to work this minimum amount of hours in 2 weeks to be eligible to earn any accrual annual entitlements for the current accrual period. For a bi-weekly accrual period, it's the hours worked in the current accrual period. For a weekly accrual period, it's the total hours worked in the current week and the previous week. (Maryland Sick law).

|-
| Minimum worked hours required in current accrual period to get accrual annual entitlements
| AccrualAnnualEntitlementsMinimumWorkedHoursInCurrentAccrualPeriod
| Decimal value
| 0
| Employee has to work this minimum amount of hours in the in current accrual period to be eligible to earn any accrual annual entitlements for the current accrual period.

|-
| Add custom date field to use for Employee Accruals Seniority. This date field will override default accruals configuration if filled out.
| UseEmployeeDate3ForAccrualStartDate
| True / False value
| False
| You can use either the Date 3 field or Date 4 field (if you use the Date 4 field you need to change the custom configuration to UseEmployeeDate4ForAccrualStartDate). To change the text displayed next to the date field you would go to Configuration-->Setup-->System-->Employment.

|-
| Override Use Hire Date For Seniority.
| UseHireDateForSeniority
| True / False value
| False
| This can be used to set it for each facility in a Multi-facility software.

|-
| Override Accrual Period Group Full Time Shift Count.
| AccrualPeriodGroupFullTimeShiftCount
| Decimal value
| Full Time Shift Count on the Accrual Period Group
| This can be used to override the Full Time Shift Count for a specific date range when switching accrual periods from weekly to biweekly or vise versa. Use the current Full Time Shift Count in the accrual period group and override for the past with the custom config using the effective to date. Filter for a specific accrual group.

|}

===Other===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Override the pay type that the schedule displays and uses for the initial calculation of hours
| BaseSchedulePayTypeID
| String Value - enter the pay type ID
| Ignored
| This is an intercept and does not change the underlying value. When using the scheduler and a schedule is given to an employee without this override in place, the original pay type will be used.

|-
| Do not deduct lunch when the lunch question at the time clock was answered "Not Taken"
| DoNotDeductLunchWhenLunchQuestionAnsweredNotTaken
| True / False Value
| False
|

|-
| Do not deduct lunch when the lunch question at the time clock was not answered i.e. "Unknown"
| DoNotDeductLunchWhenLunchQuestionNotAnswered
| True / False Value
| False
|

|-
| In a multi-facility configuration, if employees have worked hours in another facility then this will put those hours into the PBJ file of the worked facility.
| EmployeesHavePBJHoursInMultipleFacilities
| True / False Value
| False
| The PBJ file has to be created for all facilities that any employee in a selected facility has worked in. E.g., if you are running PBJ for facility A and facility A employees worked in facility B then you must create the file for facility B at the same time. If employees in facility B worked in facility C then facility C must be included. Also, if there are employees not in facility A, B or C that have hours in A, B or C then you must also include those facilities.

|-
| Maximum hours that will calculate from a "Time" differential premium used on the worked holiday tab of holiday configuration
| WorkedHolidayDifferentialMaximumMinutes
| IntegerValue
| 9999
| This is the number of minutes so multiple an hour maximum by 60. This only works with Time Premiums or Time & Shift Premiums.

|-
| Phantom punches are temporary punches added between shifts so as to calculate double shifts correctly. This setting will calculate the time cards in a similar manner as if Out/In punches were added manually.
| CalculatePhantomPunchesLikeActualPunches
| True / False value
| False
| This does not split shifts to different pay dates as pay date determination is done prior to the adding of phantom punches.

|-
| Department Of Labor Weighted Overtime Pay Rate Calculations for specific labor levels only
| DepartmentOfLaborPayRateCalculations
| True / False value
| False
|

|-
| HHSOIG report requires birth dates to match (both must exist)
| HHSOIGBirthDateMatch
| True / False value
| False
|

|-
| SAM report requires zip codes to match (both must exist)
| SAMZipCodeMatch
| True / False value
| False
|

|-
| 6th pay date overtime level minimum minutes.
| SixthPayDateOvertimeLevelMinimumMinutes
| Integer value
| 0
| It will only pay the 6th Pay Date OT if they already have the minimum minutes in the period. A common example is to set the minimum to 37.5 hours so that it only starts paying the 6th Pay Date OT after they already have 37.5. If the 37.5 is reached in the middle of the 6th pay date, it will pay the OT partially from 37.5 till the end of the day. The Fixed Hour Level in overtime configuration is the maximum overtime level.

|-
| Disregards any Is Hire Date on employee status and the global rule about first / last active status as hire date such that the latest active status is ALWAYS the hire date.
| LatestActiveStatusAlwaysConsideredHireDate
| True / False value
| False
|

|-
| If shift count times daily hours is less than this number than employee shift type is changed to PD when adding employee shifts
| PartTimeShiftTypeMinimumShiftCountTimesDailyHours
| Decimal value
| -1 (ignored)
|

|-
| If shift count times daily hours is greater than this number than employee shift type is changed to FT when adding employee shifts
| PartTimeShiftTypeMaximumShiftCountTimesDailyHours
| Decimal value
| -1 (ignored)
| E.g. if 30 hours is considered full time then enter 29.99

|-
| Enable Software to export data to In-House Health FTP Site
| InHouseHealthExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software (filtering not applicable) and does not need a separate entry for each facility in a Multi-Facility software. The software will also potentially require an update if it hasn't been updated since 2/17/2026.

|-
| Enable Software to export data to Keeper FTP Site
| KeeperExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software (filtering not applicable) and does not need a separate entry for each facility in a Multi-Facility software. The software will also potentially require an update if it hasn't been updated since 2/20/2024. Will also need to provide the IP of the software server as Keeper uses whitelisting.

|-
| Enable Software to export data to Stafflion FTP Site
| StafflionPunchExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software (filtering not applicable) and does not need a separate entry for each facility in a Multi-Facility software. The software will also potentially require an update if it hasn't been updated since 8/14/2025.

|-
| Enable Software to export data to TapCheck FTP Site
| TapcheckExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software (filtering not applicable) and does not need a separate entry for each facility in a Multi-Facility software. The software will also potentially require an update if it hasn't been updated since 12/21/2021.

|-
| Add custom date field to use for Holiday and Worked Holiday Seniority. This date field will override the default (Hire Date) if filled out.
| UseEmployeeDate3ForHolidaySeniority
| True / False value
| False
| You can use either the Date 3 field or Date 4 field (if you use the Date 4 field you need to change the custom configuration to UseEmployeeDate4ForHolidaySeniority). To change the text displayed next to the date field you would go to Configuration-->Setup-->System-->Employment.

|}

Custom Configuration

2026-02-10T16:25:06Z

Joel: /* Other */

{{Advanced}}

The Custom configuration screen allows system configuration settings that would typically apply to the software as a whole to be applied based on criteria. Custom configuration settings use a text based identifier combined with a value that can be a true/false, a string, a number or a date. Each custom configuration settings will use some or all of the following criteria:

* Labor Levels (home or worked based on the setting)
* Pay Rule
* Base Schedule Group
* Holiday Group
* Accrual Group
* Pay Type
* Accrual Pay Type
* Shift (home or worked based on the setting)
* Employed Date Range
* Effective Date Range
* Employee Shift Count
* Employee Shift Type

Each custom configuration settings uses a Custom Configuration ID that uniquely identifies the setting. Each setting will use either the true/false, string, numerical or date value. The following are the current custom configuration settings supported:

==Settings==

===Payroll===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| ADP payroll export group by week number option is used when there is a biweekly payroll and using weighted overtime
| ADPPayrollExportGroupByWeekNumber
| True / False value
| False
|

|-
| David Klein # 1 payroll interface option to group hours by pay date
| DavidKleinPayrollExportGroupByPayDate
| True / False Value
| True
| If true (default) then it will export separate rows for each pay date for each employee. If false (check box unselected) then it will export just a total for the whole pay period.

|-
| David Klein # 1 payroll interface option to group hours by shift
| DavidKleinPayrollExportGroupByShift
| True / False Value
| False
|

|-
| Evolution payroll interface option to place the department in a different column
| EvolutionDepartmentColumn
| String Value
| "C"
| Use any of these to indicate the column: "B", "C", "D", "E", "G", "H". Enter "NONE" to not show the department at all. Only the labor level filters will work with this custom configuration.

|-
| Kronos payroll interface option to put the hours value for a pay type in the amount column
| KronosPayrollExportAsAmount
| True / False Value
| False
| The pay type column should NOT be empty

|-
| Kronos payroll interface option to group hours by shift
| KronosPayrollExportGroupByShift
| True / False Value
| False
| The E Shift column will contain the first letter of the Shift ID

|-
| Kronos payroll interface option to consider pay types that do not add to totals to not be differentials
| KronosPayrollExportIsNotDifferential
| True / False Value
| False
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for custom E/D/T External ID for differential pay types
| KronosExportEDTExternalID
| String Value
| "Differential"
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for custom Pay Statement Type
| KronosExportPayStatementType
| String Value
| "Regular"
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for duplicate entry using a different payroll pay code
| KronosExportDuplicateEntry
| String Value
| No additional line added if not present
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Millennium payroll interface (single company) option to group hours by shift
| MillenniumPayrollSingleCompanyGroupByShift
| True / False Value
| False
| This adds an additional column named Shift

|-
| Millennium payroll interface (single company) always show department
| MillenniumPayrollSingleCompanyAlwaysShowDepartment
| True / False Value
| False
| Department is only placed by default when the worked department does not equal the home department

|-
| Millennium payroll interface (single company) CC1 column labor level level
| MillenniumPayrollSingleCompanyExportCC1LaborLevelLevel
| Integer Value
| Department Level
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC2 column labor level level
| MillenniumPayrollSingleCompanyExportCC2LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC3 column labor level level
| MillenniumPayrollSingleCompanyExportCC3LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC4 column labor level level
| MillenniumPayrollSingleCompanyExportCC4LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC5 column labor level level
| MillenniumPayrollSingleCompanyExportCC5LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Viventium Payroll Export option to group hours by pay date
| ViventiumPayrollExportGroupByPayDate
| True / False Value
| True
| If true (default) then it will export separate rows for each pay date for each employee. If false (check box unselected) then it will export just a total for the whole pay period for each employee. This is a whole software-wide setting and can't use any filters.

|-
| Viventium Payroll Export 1st Additional Labor Level level
| ViventiumPayrollExport1stAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium Payroll Export 2nd Additional Labor Level level
| ViventiumPayrollExport2ndAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium Payroll Export 3rd Additional Labor Level level
| ViventiumPayrollExport3rdAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium payroll export Accrual Balances as Memo
| ViventiumUseMemoForAccrualBalances
| True / False Value
| False
| This will export the accrual balances in the last column which will go on the pay stub as a memo, instead of the accrual balances getting exported as an extra line deduction (D).

|-
| Viventium payroll export hours format
| ViventiumPayrollExportHoursFormat
| String Value
| 0.0000
|

|-
| Viventium payroll export rate format
| ViventiumPayrollExportRateFormat
| String Value
| 0.0000
|
|}

===Scheduling===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Daily Staffing sheet employee sort order
| DailyStaffingSheetEmployeeSortOrder
| String Value
| FullName
| FullName or Seniority are the current 2 options

|-
| Monthly Schedule Area Acceptor determines how schedules match to the areas defined on the monthly schedule
| MonthlyScheduleAreaAcceptor
| String Value
| WorkedShiftWorkedBudgetGroupWorkedFloor
| Format is _____Shift_____BudgetGroup____Floor with options of Any, Home or Worked. E.g. AnyShiftWorkedBudgetGroupWorkedFloor

|-
| Time Restriction Early In Allowance
| TimeRestrictionEarlyInAllowance
| Integer Value
| 7
|

|-
| Time Restriction Late Out Allowance
| TimeRestrictionLateOutAllowance
| Integer Value
| 7
|
|}

===Pay Types===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Specify pay types that will be treated like worked hours for the worked days in week / pay period qualifier on holiday calculation
| ConsideredWorkedForHolidayWorkedDaysQualifier
| True / False value
| False
| On or after holiday is supported

|-
| Override pay type configuration Punches Count Towards Daily Overtime rule
| PunchesCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Period Overtime rule
| PunchesCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Premium rule
| PunchesCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Holiday Overtime rule
| PunchesCountTowardsHolidayOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Accrual rule
| PunchesCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Daily Overtime rule
| OtherHoursWorkedCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Period Overtime rule
| OtherHoursWorkedCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Premium rule
| OtherHoursWorkedCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Holiday Overtime rule
| OtherHoursWorkedCountTowardsHolidayOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Accrual rule
| OtherHoursWorkedCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Daily Overtime rule
| OtherHoursUnworkedCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Period Overtime rule
| OtherHoursUnworkedCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Actual Date Towards Period Overtime rule
| OtherHoursUnworkedCountActualDateTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Premium rule
| OtherHoursUnworkedCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Actual Date Towards Premium rule
| OtherHoursUnworkedCountActualDateTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Accrual rule
| OtherHoursUnworkedCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Accrual rule
| PremiumCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Period Overtime rule
| PremiumCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Premium rule
| PremiumCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Do not allow use of a pay type until the employee has been employed for X number of days
| PayTypeSenorityDays
| Integer value
| 0
| Actual date of other hours must be greater than or equal to hire date plus seniority days. E.g. if employed on January 1 and seniority days is 7 then actual date must be January 8th or later. Effectively we are saying that the 7 days have been completed and so on the 8th you can use this pay type.

|-
| Count all pay types that Add-To-Total, for specific differential ID "CAPTATTFDI"
| CountAllPayTypesAddToTotalForDifferentialIdCAPTATTFDI
| True / False value
| False
| This will override the setting on pay types if they are set to not count for premiums. Fill in the special code "CAPTATTFDI" anywhere in the Premium ID/name, and it will count all pay types that Add-To-Total for this differential. Filters are not in effect for this custom configuration and is in effect for the whole software (use the premium worked labor level filters instead if needed). This custom configuration only works for differentials.

|}

===Time Clocks===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| When using multi facility punching it will set the facility on the punch the same as the time clock's facility.
| OverrideFacilityLaborLevelSameAsTimeClock
| True / False value
| False
| This is a global setting for the entire software and does not use any filters.

|-
| Fingercheck Clock Download Punches Look Back Days
| FingercheckPollLookBackDays
| Integer Value
| 3
| Even though duplicates are discarded, it will still be slow to go back to much. This is a global setting for the entire software and does not use any filters.

|-
| Wdms Time Clock Supervisor Code
| WdmsTimeClockSupervisorCode
| Integer Value
| 2
| The code that will be sent to WDMS for the employees that are marked in TA as a clock supervisor. 2 = Register, 6 = System Administrator, 14 = Super Administrator. Before setting this value make sure that the role exists in the clock. The facility labor level filter can be used to set it for a specific facility in a Multi-Facility software. Minimum TA version required: 4.6.8446.1937

|-
| Time Restriction Early In Allowance
| TimeRestrictionEarlyInAllowance
| Integer Value
| 7
|

|-
| Time Restriction Late Out Allowance
| TimeRestrictionLateOutAllowance
| Integer Value
| 7
|
|}

===Accruals===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Pretend that the employee worked the number of hours in their shift history for accrual proposes.
| AccrueAtShiftCountTimesDailyHoursLevel
| True / False value
| False
| The Employee could have not worked at all, or worked less, or worked more, but will still pretend that the employee actually worked the exact shift history hours (shift count x daily hours). This number of pretend worked hours will then be used to calculate the accruals. Any other accrual calculation settings will apply afterward on top of this number.

|-
| Employee accrues without any limit in the accrual period. This allows a more fine-grained approach than the accrual group provides.
| AccrualNoMaximumContributingMinutes
| True / False value
| False
|

|-
| Employee accrues their full-time shift count if they worked less or even if they didn't actually work at all. This allows a more fine-grained approach than the accrual group provides.
| CalculateFullAccrualEarning
| True / False value
| False
|

|-
| Minimum worked hours in 2 weeks required to get accrual annual entitlements
| AccrualAnnualEntitlementsMinimumWorkedHoursIn2Weeks
| Decimal value
| 0
| Employee has to work this minimum amount of hours in 2 weeks to be eligible to earn any accrual annual entitlements for the current accrual period. For a bi-weekly accrual period, it's the hours worked in the current accrual period. For a weekly accrual period, it's the total hours worked in the current week and the previous week. (Maryland Sick law).

|-
| Minimum worked hours required in current accrual period to get accrual annual entitlements
| AccrualAnnualEntitlementsMinimumWorkedHoursInCurrentAccrualPeriod
| Decimal value
| 0
| Employee has to work this minimum amount of hours in the in current accrual period to be eligible to earn any accrual annual entitlements for the current accrual period.

|-
| Add custom date field to use for Employee Accruals Seniority. This date field will override default accruals configuration if filled out.
| UseEmployeeDate3ForAccrualStartDate
| True / False value
| False
| You can use either the Date 3 field or Date 4 field (if you use the Date 4 field you need to change the custom configuration to UseEmployeeDate4ForAccrualStartDate). To change the text displayed next to the date field you would go to Configuration-->Setup-->System-->Employment.

|-
| Override Use Hire Date For Seniority.
| UseHireDateForSeniority
| True / False value
| False
| This can be used to set it for each facility in a Multi-facility software.

|-
| Override Accrual Period Group Full Time Shift Count.
| AccrualPeriodGroupFullTimeShiftCount
| Decimal value
| Full Time Shift Count on the Accrual Period Group
| This can be used to override the Full Time Shift Count for a specific date range when switching accrual periods from weekly to biweekly or vise versa. Use the current Full Time Shift Count in the accrual period group and override for the past with the custom config using the effective to date. Filter for a specific accrual group.

|}

===Other===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Override the pay type that the schedule displays and uses for the initial calculation of hours
| BaseSchedulePayTypeID
| String Value - enter the pay type ID
| Ignored
| This is an intercept and does not change the underlying value. When using the scheduler and a schedule is given to an employee without this override in place, the original pay type will be used.

|-
| Do not deduct lunch when the lunch question at the time clock was answered "Not Taken"
| DoNotDeductLunchWhenLunchQuestionAnsweredNotTaken
| True / False Value
| False
|

|-
| Do not deduct lunch when the lunch question at the time clock was not answered i.e. "Unknown"
| DoNotDeductLunchWhenLunchQuestionNotAnswered
| True / False Value
| False
|

|-
| In a multi-facility configuration, if employees have worked hours in another facility then this will put those hours into the PBJ file of the worked facility.
| EmployeesHavePBJHoursInMultipleFacilities
| True / False Value
| False
| The PBJ file has to be created for all facilities that any employee in a selected facility has worked in. E.g., if you are running PBJ for facility A and facility A employees worked in facility B then you must create the file for facility B at the same time. If employees in facility B worked in facility C then facility C must be included. Also, if there are employees not in facility A, B or C that have hours in A, B or C then you must also include those facilities.

|-
| Maximum hours that will calculate from a "Time" differential premium used on the worked holiday tab of holiday configuration
| WorkedHolidayDifferentialMaximumMinutes
| IntegerValue
| 9999
| This is the number of minutes so multiple an hour maximum by 60. This only works with Time Premiums or Time & Shift Premiums.

|-
| Phantom punches are temporary punches added between shifts so as to calculate double shifts correctly. This setting will calculate the time cards in a similar manner as if Out/In punches were added manually.
| CalculatePhantomPunchesLikeActualPunches
| True / False value
| False
| This does not split shifts to different pay dates as pay date determination is done prior to the adding of phantom punches.

|-
| Department Of Labor Weighted Overtime Pay Rate Calculations for specific labor levels only
| DepartmentOfLaborPayRateCalculations
| True / False value
| False
|

|-
| HHSOIG report requires birth dates to match (both must exist)
| HHSOIGBirthDateMatch
| True / False value
| False
|

|-
| SAM report requires zip codes to match (both must exist)
| SAMZipCodeMatch
| True / False value
| False
|

|-
| 6th pay date overtime level minimum minutes.
| SixthPayDateOvertimeLevelMinimumMinutes
| Integer value
| 0
| It will only pay the 6th Pay Date OT if they already have the minimum minutes in the period. A common example is to set the minimum to 37.5 hours so that it only starts paying the 6th Pay Date OT after they already have 37.5. If the 37.5 is reached in the middle of the 6th pay date, it will pay the OT partially from 37.5 till the end of the day. The Fixed Hour Level in overtime configuration is the maximum overtime level.

|-
| Disregards any Is Hire Date on employee status and the global rule about first / last active status as hire date such that the latest active status is ALWAYS the hire date.
| LatestActiveStatusAlwaysConsideredHireDate
| True / False value
| False
|

|-
| If shift count times daily hours is less than this number than employee shift type is changed to PD when adding employee shifts
| PartTimeShiftTypeMinimumShiftCountTimesDailyHours
| Decimal value
| -1 (ignored)
|

|-
| If shift count times daily hours is greater than this number than employee shift type is changed to FT when adding employee shifts
| PartTimeShiftTypeMaximumShiftCountTimesDailyHours
| Decimal value
| -1 (ignored)
| E.g. if 30 hours is considered full time then enter 29.99

|-
| Enable Software to export data to Keeper FTP Site
| KeeperExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software (filtering not applicable) and does not need a separate entry for each facility in a Multi-Facility software. The software will also potentially require an update if it hasn't been updated since 2/20/2024. Will also need to provide the IP of the software server as Keeper uses whitelisting.

|-
| Enable Software to export data to Stafflion FTP Site
| StafflionPunchExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software (filtering not applicable) and does not need a separate entry for each facility in a Multi-Facility software. The software will also potentially require an update if it hasn't been updated since 8/14/2025.

|-
| Enable Software to export data to TapCheck FTP Site
| TapcheckExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software (filtering not applicable) and does not need a separate entry for each facility in a Multi-Facility software. The software will also potentially require an update if it hasn't been updated since 12/21/2021.

|-
| Add custom date field to use for Holiday and Worked Holiday Seniority. This date field will override the default (Hire Date) if filled out.
| UseEmployeeDate3ForHolidaySeniority
| True / False value
| False
| You can use either the Date 3 field or Date 4 field (if you use the Date 4 field you need to change the custom configuration to UseEmployeeDate4ForHolidaySeniority). To change the text displayed next to the date field you would go to Configuration-->Setup-->System-->Employment.

|}

Custom Configuration

2025-08-14T21:10:43Z

Joel: /* Other */

{{Advanced}}

The Custom configuration screen allows system configuration settings that would typically apply to the software as a whole to be applied based on criteria. Custom configuration settings use a text based identifier combined with a value that can be a true/false, a string, a number or a date. Each custom configuration settings will use some or all of the following criteria:

* Labor Levels (home or worked based on the setting)
* Pay Rule
* Base Schedule Group
* Holiday Group
* Accrual Group
* Pay Type
* Accrual Pay Type
* Shift (home or worked based on the setting)
* Employed Date Range
* Effective Date Range
* Employee Shift Count
* Employee Shift Type

Each custom configuration settings uses a Custom Configuration ID that uniquely identifies the setting. Each setting will use either the true/false, string, numerical or date value. The following are the current custom configuration settings supported:

==Settings==

===Payroll===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| ADP payroll export group by week number option is used when there is a biweekly payroll and using weighted overtime
| ADPPayrollExportGroupByWeekNumber
| True / False value
| False
|

|-
| David Klein # 1 payroll interface option to group hours by pay date
| DavidKleinPayrollExportGroupByPayDate
| True / False Value
| True
| If true (default) then it will export separate rows for each pay date for each employee. If false (check box unselected) then it will export just a total for the whole pay period.

|-
| David Klein # 1 payroll interface option to group hours by shift
| DavidKleinPayrollExportGroupByShift
| True / False Value
| False
|

|-
| Evolution payroll interface option to place the department in a different column
| EvolutionDepartmentColumn
| String Value
| "C"
| Use any of these to indicate the column: "B", "C", "D", "E", "G", "H". Enter "NONE" to not show the department at all. Only the labor level filters will work with this custom configuration.

|-
| Kronos payroll interface option to put the hours value for a pay type in the amount column
| KronosPayrollExportAsAmount
| True / False Value
| False
| The pay type column should NOT be empty

|-
| Kronos payroll interface option to group hours by shift
| KronosPayrollExportGroupByShift
| True / False Value
| False
| The E Shift column will contain the first letter of the Shift ID

|-
| Kronos payroll interface option to consider pay types that do not add to totals to not be differentials
| KronosPayrollExportIsNotDifferential
| True / False Value
| False
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for custom E/D/T External ID for differential pay types
| KronosExportEDTExternalID
| String Value
| "Differential"
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for custom Pay Statement Type
| KronosExportPayStatementType
| String Value
| "Regular"
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for duplicate entry using a different payroll pay code
| KronosExportDuplicateEntry
| String Value
| No additional line added if not present
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Millennium payroll interface (single company) option to group hours by shift
| MillenniumPayrollSingleCompanyGroupByShift
| True / False Value
| False
| This adds an additional column named Shift

|-
| Millennium payroll interface (single company) always show department
| MillenniumPayrollSingleCompanyAlwaysShowDepartment
| True / False Value
| False
| Department is only placed by default when the worked department does not equal the home department

|-
| Millennium payroll interface (single company) CC1 column labor level level
| MillenniumPayrollSingleCompanyExportCC1LaborLevelLevel
| Integer Value
| Department Level
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC2 column labor level level
| MillenniumPayrollSingleCompanyExportCC2LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC3 column labor level level
| MillenniumPayrollSingleCompanyExportCC3LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC4 column labor level level
| MillenniumPayrollSingleCompanyExportCC4LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC5 column labor level level
| MillenniumPayrollSingleCompanyExportCC5LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Viventium Payroll Export option to group hours by pay date
| ViventiumPayrollExportGroupByPayDate
| True / False Value
| True
| If true (default) then it will export separate rows for each pay date for each employee. If false (check box unselected) then it will export just a total for the whole pay period for each employee. This is a whole software-wide setting and can't use any filters.

|-
| Viventium Payroll Export 1st Additional Labor Level level
| ViventiumPayrollExport1stAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium Payroll Export 2nd Additional Labor Level level
| ViventiumPayrollExport2ndAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium Payroll Export 3rd Additional Labor Level level
| ViventiumPayrollExport3rdAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium payroll export Accrual Balances as Memo
| ViventiumUseMemoForAccrualBalances
| True / False Value
| False
| This will export the accrual balances in the last column which will go on the pay stub as a memo, instead of the accrual balances getting exported as an extra line deduction (D).

|-
| Viventium payroll export hours format
| ViventiumPayrollExportHoursFormat
| String Value
| 0.0000
|

|-
| Viventium payroll export rate format
| ViventiumPayrollExportRateFormat
| String Value
| 0.0000
|
|}

===Scheduling===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Daily Staffing sheet employee sort order
| DailyStaffingSheetEmployeeSortOrder
| String Value
| FullName
| FullName or Seniority are the current 2 options

|-
| Monthly Schedule Area Acceptor determines how schedules match to the areas defined on the monthly schedule
| MonthlyScheduleAreaAcceptor
| String Value
| WorkedShiftWorkedBudgetGroupWorkedFloor
| Format is _____Shift_____BudgetGroup____Floor with options of Any, Home or Worked. E.g. AnyShiftWorkedBudgetGroupWorkedFloor

|-
| Time Restriction Early In Allowance
| TimeRestrictionEarlyInAllowance
| Integer Value
| 7
|

|-
| Time Restriction Late Out Allowance
| TimeRestrictionLateOutAllowance
| Integer Value
| 7
|
|}

===Pay Types===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Specify pay types that will be treated like worked hours for the worked days in week / pay period qualifier on holiday calculation
| ConsideredWorkedForHolidayWorkedDaysQualifier
| True / False value
| False
| On or after holiday is supported

|-
| Override pay type configuration Punches Count Towards Daily Overtime rule
| PunchesCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Period Overtime rule
| PunchesCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Premium rule
| PunchesCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Holiday Overtime rule
| PunchesCountTowardsHolidayOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Accrual rule
| PunchesCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Daily Overtime rule
| OtherHoursWorkedCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Period Overtime rule
| OtherHoursWorkedCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Premium rule
| OtherHoursWorkedCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Holiday Overtime rule
| OtherHoursWorkedCountTowardsHolidayOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Accrual rule
| OtherHoursWorkedCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Daily Overtime rule
| OtherHoursUnworkedCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Period Overtime rule
| OtherHoursUnworkedCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Actual Date Towards Period Overtime rule
| OtherHoursUnworkedCountActualDateTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Premium rule
| OtherHoursUnworkedCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Actual Date Towards Premium rule
| OtherHoursUnworkedCountActualDateTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Accrual rule
| OtherHoursUnworkedCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Accrual rule
| PremiumCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Period Overtime rule
| PremiumCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Premium rule
| PremiumCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Do not allow use of a pay type until the employee has been employed for X number of days
| PayTypeSenorityDays
| Integer value
| 0
| Actual date of other hours must be greater than or equal to hire date plus seniority days. E.g. if employed on January 1 and seniority days is 7 then actual date must be January 8th or later. Effectively we are saying that the 7 days have been completed and so on the 8th you can use this pay type.

|-
| Count all pay types that Add-To-Total, for specific differential ID "CAPTATTFDI"
| CountAllPayTypesAddToTotalForDifferentialIdCAPTATTFDI
| True / False value
| False
| This will override the setting on pay types if they are set to not count for premiums. Fill in the special code "CAPTATTFDI" anywhere in the Premium ID/name, and it will count all pay types that Add-To-Total for this differential. Filters are not in effect for this custom configuration and is in effect for the whole software (use the premium worked labor level filters instead if needed). This custom configuration only works for differentials.

|}

===Time Clocks===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| When using multi facility punching it will set the facility on the punch the same as the time clock's facility.
| OverrideFacilityLaborLevelSameAsTimeClock
| True / False value
| False
| This is a global setting for the entire software and does not use any filters.

|-
| Fingercheck Clock Download Punches Look Back Days
| FingercheckPollLookBackDays
| Integer Value
| 3
| Even though duplicates are discarded, it will still be slow to go back to much. This is a global setting for the entire software and does not use any filters.

|-
| Wdms Time Clock Supervisor Code
| WdmsTimeClockSupervisorCode
| Integer Value
| 2
| The code that will be sent to WDMS for the employees that are marked in TA as a clock supervisor. 2 = Register, 6 = System Administrator, 14 = Super Administrator. Before setting this value make sure that the role exists in the clock. The facility labor level filter can be used to set it for a specific facility in a Multi-Facility software. Minimum TA version required: 4.6.8446.1937

|-
| Time Restriction Early In Allowance
| TimeRestrictionEarlyInAllowance
| Integer Value
| 7
|

|-
| Time Restriction Late Out Allowance
| TimeRestrictionLateOutAllowance
| Integer Value
| 7
|
|}

===Accruals===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Pretend that the employee worked the number of hours in their shift history for accrual proposes.
| AccrueAtShiftCountTimesDailyHoursLevel
| True / False value
| False
| The Employee could have not worked at all, or worked less, or worked more, but will still pretend that the employee actually worked the exact shift history hours (shift count x daily hours). This number of pretend worked hours will then be used to calculate the accruals. Any other accrual calculation settings will apply afterward on top of this number.

|-
| Employee accrues without any limit in the accrual period. This allows a more fine-grained approach than the accrual group provides.
| AccrualNoMaximumContributingMinutes
| True / False value
| False
|

|-
| Employee accrues their full-time shift count if they worked less or even if they didn't actually work at all. This allows a more fine-grained approach than the accrual group provides.
| CalculateFullAccrualEarning
| True / False value
| False
|

|-
| Minimum worked hours in 2 weeks required to get accrual annual entitlements
| AccrualAnnualEntitlementsMinimumWorkedHoursIn2Weeks
| Decimal value
| 0
| Employee has to work this minimum amount of hours in 2 weeks to be eligible to earn any accrual annual entitlements for the current accrual period. For a bi-weekly accrual period, it's the hours worked in the current accrual period. For a weekly accrual period, it's the total hours worked in the current week and the previous week. (Maryland Sick law).

|-
| Minimum worked hours required in current accrual period to get accrual annual entitlements
| AccrualAnnualEntitlementsMinimumWorkedHoursInCurrentAccrualPeriod
| Decimal value
| 0
| Employee has to work this minimum amount of hours in the in current accrual period to be eligible to earn any accrual annual entitlements for the current accrual period.

|-
| Add custom date field to use for Employee Accruals Seniority. This date field will override default accruals configuration if filled out.
| UseEmployeeDate3ForAccrualStartDate
| True / False value
| False
| You can use either the Date 3 field or Date 4 field (if you use the Date 4 field you need to change the custom configuration to UseEmployeeDate4ForAccrualStartDate). To change the text displayed next to the date field you would go to Configuration-->Setup-->System-->Employment.

|-
| Override Use Hire Date For Seniority.
| UseHireDateForSeniority
| True / False value
| False
| This can be used to set it for each facility in a Multi-facility software.

|-
| Override Accrual Period Group Full Time Shift Count.
| AccrualPeriodGroupFullTimeShiftCount
| Decimal value
| Full Time Shift Count on the Accrual Period Group
| This can be used to override the Full Time Shift Count for a specific date range when switching accrual periods from weekly to biweekly or vise versa. Use the current Full Time Shift Count in the accrual period group and override for the past with the custom config using the effective to date. Filter for a specific accrual group.

|}

===Other===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Override the pay type that the schedule displays and uses for the initial calculation of hours
| BaseSchedulePayTypeID
| String Value - enter the pay type ID
| Ignored
| This is an intercept and does not change the underlying value. When using the scheduler and a schedule is given to an employee without this override in place, the original pay type will be used.

|-
| Do not deduct lunch when the lunch question at the time clock was answered "Not Taken"
| DoNotDeductLunchWhenLunchQuestionAnsweredNotTaken
| True / False Value
| False
|

|-
| Do not deduct lunch when the lunch question at the time clock was not answered i.e. "Unknown"
| DoNotDeductLunchWhenLunchQuestionNotAnswered
| True / False Value
| False
|

|-
| In a multi-facility configuration, if employees have worked hours in another facility then this will put those hours into the PBJ file of the worked facility.
| EmployeesHavePBJHoursInMultipleFacilities
| True / False Value
| False
| The PBJ file has to be created for all facilities that any employee in a selected facility has worked in. E.g., if you are running PBJ for facility A and facility A employees worked in facility B then you must create the file for facility B at the same time. If employees in facility B worked in facility C then facility C must be included. Also, if there are employees not in facility A, B or C that have hours in A, B or C then you must also include those facilities.

|-
| Maximum hours that will calculate from a "Time" differential premium used on the worked holiday tab of holiday configuration
| WorkedHolidayDifferentialMaximumMinutes
| IntegerValue
| 9999
| This is the number of minutes so multiple an hour maximum by 60. This only works with Time Premiums or Time & Shift Premiums.

|-
| Phantom punches are temporary punches added between shifts so as to calculate double shifts correctly. This setting will calculate the time cards in a similar manner as if Out/In punches were added manually.
| CalculatePhantomPunchesLikeActualPunches
| True / False value
| False
| This does not split shifts to different pay dates as pay date determination is done prior to the adding of phantom punches.

|-
| Department Of Labor Weighted Overtime Pay Rate Calculations for specific labor levels only
| DepartmentOfLaborPayRateCalculations
| True / False value
| False
|

|-
| HHSOIG report requires birth dates to match (both must exist)
| HHSOIGBirthDateMatch
| True / False value
| False
|

|-
| SAM report requires zip codes to match (both must exist)
| SAMZipCodeMatch
| True / False value
| False
|

|-
| 6th pay date overtime level minimum minutes.
| SixthPayDateOvertimeLevelMinimumMinutes
| Integer value
| 0
| The Fixed Hour Level in overtime configuration is the maximum overtime level.

|-
| Disregards any Is Hire Date on employee status and the global rule about first / last active status as hire date such that the latest active status is ALWAYS the hire date.
| LatestActiveStatusAlwaysConsideredHireDate
| True / False value
| False
|

|-
| If shift count times daily hours is less than this number than employee shift type is changed to PD when adding employee shifts
| PartTimeShiftTypeMinimumShiftCountTimesDailyHours
| Decimal value
| -1 (ignored)
|

|-
| If shift count times daily hours is greater than this number than employee shift type is changed to FT when adding employee shifts
| PartTimeShiftTypeMaximumShiftCountTimesDailyHours
| Decimal value
| -1 (ignored)
| E.g. if 30 hours is considered full time then enter 29.99

|-
| Enable Software to export data to Keeper FTP Site
| KeeperExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software (filtering not applicable) and does not need a separate entry for each facility in a Multi-Facility software. The software will also potentially require an update if it hasn't been updated since 2/20/2024. Will also need to provide the IP of the software server as Keeper uses whitelisting.

|-
| Enable Software to export data to Stafflion FTP Site
| StafflionPunchExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software (filtering not applicable) and does not need a separate entry for each facility in a Multi-Facility software. The software will also potentially require an update if it hasn't been updated since 8/14/2025.

|-
| Enable Software to export data to TapCheck FTP Site
| TapcheckExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software (filtering not applicable) and does not need a separate entry for each facility in a Multi-Facility software. The software will also potentially require an update if it hasn't been updated since 12/21/2021.

|-
| Add custom date field to use for Holiday and Worked Holiday Seniority. This date field will override the default (Hire Date) if filled out.
| UseEmployeeDate3ForHolidaySeniority
| True / False value
| False
| You can use either the Date 3 field or Date 4 field (if you use the Date 4 field you need to change the custom configuration to UseEmployeeDate4ForHolidaySeniority). To change the text displayed next to the date field you would go to Configuration-->Setup-->System-->Employment.

|}

Custom Configuration

2025-07-08T22:04:06Z

Joel:

{{Advanced}}

The Custom configuration screen allows system configuration settings that would typically apply to the software as a whole to be applied based on criteria. Custom configuration settings use a text based identifier combined with a value that can be a true/false, a string, a number or a date. Each custom configuration settings will use some or all of the following criteria:

* Labor Levels (home or worked based on the setting)
* Pay Rule
* Base Schedule Group
* Holiday Group
* Accrual Group
* Pay Type
* Accrual Pay Type
* Shift (home or worked based on the setting)
* Employed Date Range
* Effective Date Range
* Employee Shift Count
* Employee Shift Type

Each custom configuration settings uses a Custom Configuration ID that uniquely identifies the setting. Each setting will use either the true/false, string, numerical or date value. The following are the current custom configuration settings supported:

==Settings==

===Payroll===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| ADP payroll export group by week number option is used when there is a biweekly payroll and using weighted overtime
| ADPPayrollExportGroupByWeekNumber
| True / False value
| False
|

|-
| David Klein # 1 payroll interface option to group hours by pay date
| DavidKleinPayrollExportGroupByPayDate
| True / False Value
| True
| If true (default) then it will export separate rows for each pay date for each employee. If false (check box unselected) then it will export just a total for the whole pay period.

|-
| David Klein # 1 payroll interface option to group hours by shift
| DavidKleinPayrollExportGroupByShift
| True / False Value
| False
|

|-
| Evolution payroll interface option to place the department in a different column
| EvolutionDepartmentColumn
| String Value
| "C"
| Use any of these to indicate the column: "B", "C", "D", "E", "G", "H". Enter "NONE" to not show the department at all. Only the labor level filters will work with this custom configuration.

|-
| Kronos payroll interface option to put the hours value for a pay type in the amount column
| KronosPayrollExportAsAmount
| True / False Value
| False
| The pay type column should NOT be empty

|-
| Kronos payroll interface option to group hours by shift
| KronosPayrollExportGroupByShift
| True / False Value
| False
| The E Shift column will contain the first letter of the Shift ID

|-
| Kronos payroll interface option to consider pay types that do not add to totals to not be differentials
| KronosPayrollExportIsNotDifferential
| True / False Value
| False
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for custom E/D/T External ID for differential pay types
| KronosExportEDTExternalID
| String Value
| "Differential"
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for custom Pay Statement Type
| KronosExportPayStatementType
| String Value
| "Regular"
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for duplicate entry using a different payroll pay code
| KronosExportDuplicateEntry
| String Value
| No additional line added if not present
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Millennium payroll interface (single company) option to group hours by shift
| MillenniumPayrollSingleCompanyGroupByShift
| True / False Value
| False
| This adds an additional column named Shift

|-
| Millennium payroll interface (single company) always show department
| MillenniumPayrollSingleCompanyAlwaysShowDepartment
| True / False Value
| False
| Department is only placed by default when the worked department does not equal the home department

|-
| Millennium payroll interface (single company) CC1 column labor level level
| MillenniumPayrollSingleCompanyExportCC1LaborLevelLevel
| Integer Value
| Department Level
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC2 column labor level level
| MillenniumPayrollSingleCompanyExportCC2LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC3 column labor level level
| MillenniumPayrollSingleCompanyExportCC3LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC4 column labor level level
| MillenniumPayrollSingleCompanyExportCC4LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC5 column labor level level
| MillenniumPayrollSingleCompanyExportCC5LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Viventium Payroll Export option to group hours by pay date
| ViventiumPayrollExportGroupByPayDate
| True / False Value
| True
| If true (default) then it will export separate rows for each pay date for each employee. If false (check box unselected) then it will export just a total for the whole pay period for each employee. This is a whole software-wide setting and can't use any filters.

|-
| Viventium Payroll Export 1st Additional Labor Level level
| ViventiumPayrollExport1stAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium Payroll Export 2nd Additional Labor Level level
| ViventiumPayrollExport2ndAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium Payroll Export 3rd Additional Labor Level level
| ViventiumPayrollExport3rdAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium payroll export Accrual Balances as Memo
| ViventiumUseMemoForAccrualBalances
| True / False Value
| False
| This will export the accrual balances in the last column which will go on the pay stub as a memo, instead of the accrual balances getting exported as an extra line deduction (D).

|-
| Viventium payroll export hours format
| ViventiumPayrollExportHoursFormat
| String Value
| 0.0000
|

|-
| Viventium payroll export rate format
| ViventiumPayrollExportRateFormat
| String Value
| 0.0000
|
|}

===Scheduling===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Daily Staffing sheet employee sort order
| DailyStaffingSheetEmployeeSortOrder
| String Value
| FullName
| FullName or Seniority are the current 2 options

|-
| Monthly Schedule Area Acceptor determines how schedules match to the areas defined on the monthly schedule
| MonthlyScheduleAreaAcceptor
| String Value
| WorkedShiftWorkedBudgetGroupWorkedFloor
| Format is _____Shift_____BudgetGroup____Floor with options of Any, Home or Worked. E.g. AnyShiftWorkedBudgetGroupWorkedFloor

|-
| Time Restriction Early In Allowance
| TimeRestrictionEarlyInAllowance
| Integer Value
| 7
|

|-
| Time Restriction Late Out Allowance
| TimeRestrictionLateOutAllowance
| Integer Value
| 7
|
|}

===Pay Types===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Specify pay types that will be treated like worked hours for the worked days in week / pay period qualifier on holiday calculation
| ConsideredWorkedForHolidayWorkedDaysQualifier
| True / False value
| False
| On or after holiday is supported

|-
| Override pay type configuration Punches Count Towards Daily Overtime rule
| PunchesCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Period Overtime rule
| PunchesCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Premium rule
| PunchesCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Holiday Overtime rule
| PunchesCountTowardsHolidayOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Accrual rule
| PunchesCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Daily Overtime rule
| OtherHoursWorkedCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Period Overtime rule
| OtherHoursWorkedCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Premium rule
| OtherHoursWorkedCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Holiday Overtime rule
| OtherHoursWorkedCountTowardsHolidayOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Accrual rule
| OtherHoursWorkedCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Daily Overtime rule
| OtherHoursUnworkedCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Period Overtime rule
| OtherHoursUnworkedCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Actual Date Towards Period Overtime rule
| OtherHoursUnworkedCountActualDateTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Premium rule
| OtherHoursUnworkedCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Actual Date Towards Premium rule
| OtherHoursUnworkedCountActualDateTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Accrual rule
| OtherHoursUnworkedCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Accrual rule
| PremiumCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Period Overtime rule
| PremiumCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Premium rule
| PremiumCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Do not allow use of a pay type until the employee has been employed for X number of days
| PayTypeSenorityDays
| Integer value
| 0
| Actual date of other hours must be greater than or equal to hire date plus seniority days. E.g. if employed on January 1 and seniority days is 7 then actual date must be January 8th or later. Effectively we are saying that the 7 days have been completed and so on the 8th you can use this pay type.

|-
| Count all pay types that Add-To-Total, for specific differential ID "CAPTATTFDI"
| CountAllPayTypesAddToTotalForDifferentialIdCAPTATTFDI
| True / False value
| False
| This will override the setting on pay types if they are set to not count for premiums. Fill in the special code "CAPTATTFDI" anywhere in the Premium ID/name, and it will count all pay types that Add-To-Total for this differential. Filters are not in effect for this custom configuration and is in effect for the whole software (use the premium worked labor level filters instead if needed). This custom configuration only works for differentials.

|}

===Time Clocks===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| When using multi facility punching it will set the facility on the punch the same as the time clock's facility.
| OverrideFacilityLaborLevelSameAsTimeClock
| True / False value
| False
| This is a global setting for the entire software and does not use any filters.

|-
| Fingercheck Clock Download Punches Look Back Days
| FingercheckPollLookBackDays
| Integer Value
| 3
| Even though duplicates are discarded, it will still be slow to go back to much. This is a global setting for the entire software and does not use any filters.

|-
| Wdms Time Clock Supervisor Code
| WdmsTimeClockSupervisorCode
| Integer Value
| 2
| The code that will be sent to WDMS for the employees that are marked in TA as a clock supervisor. 2 = Register, 6 = System Administrator, 14 = Super Administrator. Before setting this value make sure that the role exists in the clock. The facility labor level filter can be used to set it for a specific facility in a Multi-Facility software. Minimum TA version required: 4.6.8446.1937

|-
| Time Restriction Early In Allowance
| TimeRestrictionEarlyInAllowance
| Integer Value
| 7
|

|-
| Time Restriction Late Out Allowance
| TimeRestrictionLateOutAllowance
| Integer Value
| 7
|
|}

===Accruals===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Pretend that the employee worked the number of hours in their shift history for accrual proposes.
| AccrueAtShiftCountTimesDailyHoursLevel
| True / False value
| False
| The Employee could have not worked at all, or worked less, or worked more, but will still pretend that the employee actually worked the exact shift history hours (shift count x daily hours). This number of pretend worked hours will then be used to calculate the accruals. Any other accrual calculation settings will apply afterward on top of this number.

|-
| Employee accrues without any limit in the accrual period. This allows a more fine-grained approach than the accrual group provides.
| AccrualNoMaximumContributingMinutes
| True / False value
| False
|

|-
| Employee accrues their full-time shift count if they worked less or even if they didn't actually work at all. This allows a more fine-grained approach than the accrual group provides.
| CalculateFullAccrualEarning
| True / False value
| False
|

|-
| Minimum worked hours in 2 weeks required to get accrual annual entitlements
| AccrualAnnualEntitlementsMinimumWorkedHoursIn2Weeks
| Decimal value
| 0
| Employee has to work this minimum amount of hours in 2 weeks to be eligible to earn any accrual annual entitlements for the current accrual period. For a bi-weekly accrual period, it's the hours worked in the current accrual period. For a weekly accrual period, it's the total hours worked in the current week and the previous week. (Maryland Sick law).

|-
| Minimum worked hours required in current accrual period to get accrual annual entitlements
| AccrualAnnualEntitlementsMinimumWorkedHoursInCurrentAccrualPeriod
| Decimal value
| 0
| Employee has to work this minimum amount of hours in the in current accrual period to be eligible to earn any accrual annual entitlements for the current accrual period.

|-
| Add custom date field to use for Employee Accruals Seniority. This date field will override default accruals configuration if filled out.
| UseEmployeeDate3ForAccrualStartDate
| True / False value
| False
| You can use either the Date 3 field or Date 4 field (if you use the Date 4 field you need to change the custom configuration to UseEmployeeDate4ForAccrualStartDate). To change the text displayed next to the date field you would go to Configuration-->Setup-->System-->Employment.

|-
| Override Use Hire Date For Seniority.
| UseHireDateForSeniority
| True / False value
| False
| This can be used to set it for each facility in a Multi-facility software.

|-
| Override Accrual Period Group Full Time Shift Count.
| AccrualPeriodGroupFullTimeShiftCount
| Decimal value
| Full Time Shift Count on the Accrual Period Group
| This can be used to override the Full Time Shift Count for a specific date range when switching accrual periods from weekly to biweekly or vise versa. Use the current Full Time Shift Count in the accrual period group and override for the past with the custom config using the effective to date. Filter for a specific accrual group.

|}

===Other===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Override the pay type that the schedule displays and uses for the initial calculation of hours
| BaseSchedulePayTypeID
| String Value - enter the pay type ID
| Ignored
| This is an intercept and does not change the underlying value. When using the scheduler and a schedule is given to an employee without this override in place, the original pay type will be used.

|-
| Do not deduct lunch when the lunch question at the time clock was answered "Not Taken"
| DoNotDeductLunchWhenLunchQuestionAnsweredNotTaken
| True / False Value
| False
|

|-
| Do not deduct lunch when the lunch question at the time clock was not answered i.e. "Unknown"
| DoNotDeductLunchWhenLunchQuestionNotAnswered
| True / False Value
| False
|

|-
| In a multi-facility configuration, if employees have worked hours in another facility then this will put those hours into the PBJ file of the worked facility.
| EmployeesHavePBJHoursInMultipleFacilities
| True / False Value
| False
| The PBJ file has to be created for all facilities that any employee in a selected facility has worked in. E.g., if you are running PBJ for facility A and facility A employees worked in facility B then you must create the file for facility B at the same time. If employees in facility B worked in facility C then facility C must be included. Also, if there are employees not in facility A, B or C that have hours in A, B or C then you must also include those facilities.

|-
| Maximum hours that will calculate from a "Time" differential premium used on the worked holiday tab of holiday configuration
| WorkedHolidayDifferentialMaximumMinutes
| IntegerValue
| 9999
| This is the number of minutes so multiple an hour maximum by 60. This only works with Time Premiums or Time & Shift Premiums.

|-
| Phantom punches are temporary punches added between shifts so as to calculate double shifts correctly. This setting will calculate the time cards in a similar manner as if Out/In punches were added manually.
| CalculatePhantomPunchesLikeActualPunches
| True / False value
| False
| This does not split shifts to different pay dates as pay date determination is done prior to the adding of phantom punches.

|-
| Department Of Labor Weighted Overtime Pay Rate Calculations for specific labor levels only
| DepartmentOfLaborPayRateCalculations
| True / False value
| False
|

|-
| HHSOIG report requires birth dates to match (both must exist)
| HHSOIGBirthDateMatch
| True / False value
| False
|

|-
| SAM report requires zip codes to match (both must exist)
| SAMZipCodeMatch
| True / False value
| False
|

|-
| 6th pay date overtime level minimum minutes.
| SixthPayDateOvertimeLevelMinimumMinutes
| Integer value
| 0
| The Fixed Hour Level in overtime configuration is the maximum overtime level.

|-
| Disregards any Is Hire Date on employee status and the global rule about first / last active status as hire date such that the latest active status is ALWAYS the hire date.
| LatestActiveStatusAlwaysConsideredHireDate
| True / False value
| False
|

|-
| If shift count times daily hours is less than this number than employee shift type is changed to PD when adding employee shifts
| PartTimeShiftTypeMinimumShiftCountTimesDailyHours
| Decimal value
| -1 (ignored)
|

|-
| If shift count times daily hours is greater than this number than employee shift type is changed to FT when adding employee shifts
| PartTimeShiftTypeMaximumShiftCountTimesDailyHours
| Decimal value
| -1 (ignored)
| E.g. if 30 hours is considered full time then enter 29.99

|-
| Enable Software to export data to Keeper FTP Site
| KeeperExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software and does not need a separate entry for each facility in a Multi-Facility software. The software will also potentially require an update if it hasn't been updated since 2/20/2024. Will also need to provide the IP of the software server as Keeper uses whitelisting.

|-
| Enable Software to export data to TapCheck FTP Site
| TapcheckExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software and does not need a separate entry for each facility in a Multi-Facility software. The software will also potentially require an update if it hasn't been updated since 12/21/2021.

|-
| Add custom date field to use for Holiday and Worked Holiday Seniority. This date field will override the default (Hire Date) if filled out.
| UseEmployeeDate3ForHolidaySeniority
| True / False value
| False
| You can use either the Date 3 field or Date 4 field (if you use the Date 4 field you need to change the custom configuration to UseEmployeeDate4ForHolidaySeniority). To change the text displayed next to the date field you would go to Configuration-->Setup-->System-->Employment.

|}

Custom Configuration

2025-05-28T22:49:14Z

Joel: /* Other */

{{Advanced}}

The Custom configuration screen allows system configuration settings that would typically apply to the software as a whole to be applied based on criteria. Custom configuration settings use a text based identifier combined with a value that can be a true/false, a string, a number or a date. Each custom configuration settings will use some or all of the following criteria:

* Labor Levels (home or worked based on the setting)
* Pay Rule
* Base Schedule Group
* Holiday Group
* Accrual Group
* Pay Type
* Accrual Pay Type
* Shift (home or worked based on the setting)
* Employed Date Range
* Effective Date Range
* Employee Shift Count
* Employee Shift Type

Each custom configuration settings uses a Custom Configuration ID that uniquely identifies the setting. Each setting will use either the true/false, string, numerical or date value. The following are the current custom configuration settings supported:

==Settings==

===Payroll===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| ADP payroll export group by week number option is used when there is a biweekly payroll and using weighted overtime
| ADPPayrollExportGroupByWeekNumber
| True / False value
| False
|

|-
| David Klein # 1 payroll interface option to group hours by pay date
| DavidKleinPayrollExportGroupByPayDate
| True / False Value
| True
| If true (default) then it will export separate rows for each pay date for each employee. If false (check box unselected) then it will export just a total for the whole pay period.

|-
| David Klein # 1 payroll interface option to group hours by shift
| DavidKleinPayrollExportGroupByShift
| True / False Value
| False
|

|-
| Evolution payroll interface option to place the department in a different column
| EvolutionDepartmentColumn
| String Value
| "C"
| Use any of these to indicate the column: "B", "C", "D", "E", "G", "H". Enter "NONE" to not show the department at all. Only the labor level filters will work with this custom configuration.

|-
| Kronos payroll interface option to put the hours value for a pay type in the amount column
| KronosPayrollExportAsAmount
| True / False Value
| False
| The pay type column should NOT be empty

|-
| Kronos payroll interface option to group hours by shift
| KronosPayrollExportGroupByShift
| True / False Value
| False
| The E Shift column will contain the first letter of the Shift ID

|-
| Kronos payroll interface option to consider pay types that do not add to totals to not be differentials
| KronosPayrollExportIsNotDifferential
| True / False Value
| False
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for custom E/D/T External ID for differential pay types
| KronosExportEDTExternalID
| String Value
| "Differential"
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for custom Pay Statement Type
| KronosExportPayStatementType
| String Value
| "Regular"
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for duplicate entry using a different payroll pay code
| KronosExportDuplicateEntry
| String Value
| No additional line added if not present
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Millennium payroll interface (single company) option to group hours by shift
| MillenniumPayrollSingleCompanyGroupByShift
| True / False Value
| False
| This adds an additional column named Shift

|-
| Millennium payroll interface (single company) always show department
| MillenniumPayrollSingleCompanyAlwaysShowDepartment
| True / False Value
| False
| Department is only placed by default when the worked department does not equal the home department

|-
| Millennium payroll interface (single company) CC1 column labor level level
| MillenniumPayrollSingleCompanyExportCC1LaborLevelLevel
| Integer Value
| Department Level
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC2 column labor level level
| MillenniumPayrollSingleCompanyExportCC2LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC3 column labor level level
| MillenniumPayrollSingleCompanyExportCC3LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC4 column labor level level
| MillenniumPayrollSingleCompanyExportCC4LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC5 column labor level level
| MillenniumPayrollSingleCompanyExportCC5LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Viventium Payroll Export option to group hours by pay date
| ViventiumPayrollExportGroupByPayDate
| True / False Value
| True
| If true (default) then it will export separate rows for each pay date for each employee. If false (check box unselected) then it will export just a total for the whole pay period for each employee. This is a whole software-wide setting and can't use any filters.

|-
| Viventium Payroll Export 1st Additional Labor Level level
| ViventiumPayrollExport1stAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium Payroll Export 2nd Additional Labor Level level
| ViventiumPayrollExport2ndAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium Payroll Export 3rd Additional Labor Level level
| ViventiumPayrollExport3rdAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium payroll export Accrual Balances as Memo
| ViventiumUseMemoForAccrualBalances
| True / False Value
| False
| This will export the accrual balances in the last column which will go on the pay stub as a memo, instead of the accrual balances getting exported as an extra line deduction (D).

|-
| Viventium payroll export hours format
| ViventiumPayrollExportHoursFormat
| String Value
| 0.0000
|

|-
| Viventium payroll export rate format
| ViventiumPayrollExportRateFormat
| String Value
| 0.0000
|
|}

===Scheduling===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Daily Staffing sheet employee sort order
| DailyStaffingSheetEmployeeSortOrder
| String Value
| FullName
| FullName or Seniority are the current 2 options

|-
| Monthly Schedule Area Acceptor determines how schedules match to the areas defined on the monthly schedule
| MonthlyScheduleAreaAcceptor
| String Value
| WorkedShiftWorkedBudgetGroupWorkedFloor
| Format is _____Shift_____BudgetGroup____Floor with options of Any, Home or Worked. E.g. AnyShiftWorkedBudgetGroupWorkedFloor

|-
| Time Restriction Early In Allowance
| TimeRestrictionEarlyInAllowance
| Integer Value
| 7
|

|-
| Time Restriction Late Out Allowance
| TimeRestrictionLateOutAllowance
| Integer Value
| 7
|
|}

===Pay Types===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Specify pay types that will be treated like worked hours for the worked days in week / pay period qualifier on holiday calculation
| ConsideredWorkedForHolidayWorkedDaysQualifier
| True / False value
| False
| On or after holiday is supported

|-
| Override pay type configuration Punches Count Towards Daily Overtime rule
| PunchesCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Period Overtime rule
| PunchesCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Premium rule
| PunchesCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Holiday Overtime rule
| PunchesCountTowardsHolidayOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Accrual rule
| PunchesCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Daily Overtime rule
| OtherHoursWorkedCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Period Overtime rule
| OtherHoursWorkedCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Premium rule
| OtherHoursWorkedCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Holiday Overtime rule
| OtherHoursWorkedCountTowardsHolidayOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Accrual rule
| OtherHoursWorkedCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Daily Overtime rule
| OtherHoursUnworkedCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Period Overtime rule
| OtherHoursUnworkedCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Actual Date Towards Period Overtime rule
| OtherHoursUnworkedCountActualDateTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Premium rule
| OtherHoursUnworkedCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Actual Date Towards Premium rule
| OtherHoursUnworkedCountActualDateTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Accrual rule
| OtherHoursUnworkedCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Accrual rule
| PremiumCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Period Overtime rule
| PremiumCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Premium rule
| PremiumCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Do not allow use of a pay type until the employee has been employed for X number of days
| PayTypeSenorityDays
| Integer value
| 0
| Actual date of other hours must be greater than or equal to hire date plus seniority days. E.g. if employed on January 1 and seniority days is 7 then actual date must be January 8th or later. Effectively we are saying that the 7 days have been completed and so on the 8th you can use this pay type.

|-
| Count all pay types that Add-To-Total, for specific differential ID "CAPTATTFDI"
| CountAllPayTypesAddToTotalForDifferentialIdCAPTATTFDI
| True / False value
| False
| This will override the setting on pay types if they are set to not count for premiums. Fill in the special code "CAPTATTFDI" anywhere in the Premium ID/name, and it will count all pay types that Add-To-Total for this differential. Filters are not in effect for this custom configuration and is in effect for the whole software (use the premium worked labor level filters instead if needed). This custom configuration only works for differentials.

|}

===Time Clocks===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| When using multi facility punching it will set the facility on the punch the same as the time clock's facility.
| OverrideFacilityLaborLevelSameAsTimeClock
| True / False value
| False
| This is a global setting for the entire software and does not use any filters.

|-
| Fingercheck Clock Download Punches Look Back Days
| FingercheckPollLookBackDays
| Integer Value
| 3
| Even though duplicates are discarded, it will still be slow to go back to much. This is a global setting for the entire software and does not use any filters.

|-
| Wdms Time Clock Supervisor Code
| WdmsTimeClockSupervisorCode
| Integer Value
| 2
| The code that will be sent to WDMS for the employees that are marked in TA as a clock supervisor. 2 = Register, 6 = System Administrator, 14 = Super Administrator. Before setting this value make sure that the role exists in the clock. The facility labor level filter can be used to set it for a specific facility in a Multi-Facility software. Minimum TA version required: 4.6.8446.1937

|-
| Time Restriction Early In Allowance
| TimeRestrictionEarlyInAllowance
| Integer Value
| 7
|

|-
| Time Restriction Late Out Allowance
| TimeRestrictionLateOutAllowance
| Integer Value
| 7
|
|}

===Accruals===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Pretend that the employee worked the number of hours in their shift history for accrual proposes.
| AccrueAtShiftCountTimesDailyHoursLevel
| True / False value
| False
| The Employee could have not worked at all, or worked less, or worked more, but will still pretend that the employee actually worked the exact shift history hours (shift count x daily hours). This number of pretend worked hours will then be used to calculate the accruals. Any other accrual calculation settings will apply afterward on top of this number.

|-
| Employee accrues without any limit in the accrual period. This allows a more fine-grained approach than the accrual group provides.
| AccrualNoMaximumContributingMinutes
| True / False value
| False
|

|-
| Employee accrues their full-time shift count if they worked less or even if they didn't actually work at all. This allows a more fine-grained approach than the accrual group provides.
| CalculateFullAccrualEarning
| True / False value
| False
|

|-
| Minimum worked hours in 2 weeks required to get accrual annual entitlements
| AccrualAnnualEntitlementsMinimumWorkedHoursIn2Weeks
| Decimal value
| 0
| Employee has to work this minimum amount of hours in 2 weeks to be eligible to earn any accrual annual entitlements for the current accrual period. For a bi-weekly accrual period, it's the hours worked in the current accrual period. For a weekly accrual period, it's the total hours worked in the current week and the previous week. (Maryland Sick law).

|-
| Minimum worked hours required in current accrual period to get accrual annual entitlements
| AccrualAnnualEntitlementsMinimumWorkedHoursInCurrentAccrualPeriod
| Decimal value
| 0
| Employee has to work this minimum amount of hours in the in current accrual period to be eligible to earn any accrual annual entitlements for the current accrual period.

|-
| Add custom date field to use for Employee Accruals Seniority. This date field will override default accruals configuration if filled out.
| UseEmployeeDate3ForAccrualStartDate
| True / False value
| False
| You can use either the Date 3 field or Date 4 field (if you use the Date 4 field you need to change the custom configuration to UseEmployeeDate4ForAccrualStartDate). To change the text displayed next to the date field you would go to Configuration-->Setup-->System-->Employment.

|-
| Override Use Hire Date For Seniority.
| UseHireDateForSeniority
| True / False value
| False
| This can be used to set it for each facility in a Multi-facility software.

|-
| Override Accrual Period Group Full Time Shift Count.
| AccrualPeriodGroupFullTimeShiftCount
| Decimal value
| Full Time Shift Count on the Accrual Period Group
| This can be used to override the Full Time Shift Count for a specific date range when switching accrual periods from weekly to biweekly or vise versa. Use the current Full Time Shift Count in the accrual period group and override for the past with the custom config using the effective to date. Filter for a specific accrual group.

|}

===Other===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Override the pay type that the schedule displays and uses for the initial calculation of hours
| BaseSchedulePayTypeID
| String Value - enter the pay type ID
| Ignored
| This is an intercept and does not change the underlying value. When using the scheduler and a schedule is given to an employee without this override in place, the original pay type will be used.

|-
| Do not deduct lunch when the lunch question at the time clock was answered "Not Taken"
| DoNotDeductLunchWhenLunchQuestionAnsweredNotTaken
| True / False Value
| False
|

|-
| Do not deduct lunch when the lunch question at the time clock was not answered i.e. "Unknown"
| DoNotDeductLunchWhenLunchQuestionNotAnswered
| True / False Value
| False
|

|-
| In a multi-facility configuration, if employees have worked hours in another facility then this will put those hours into the PBJ file of the worked facility.
| EmployeesHavePBJHoursInMultipleFacilities
| True / False Value
| False
| The PBJ file has to be created for all facilities that any employee in a selected facility has worked in. E.g., if you are running PBJ for facility A and facility A employees worked in facility B then you must create the file for facility B at the same time. If employees in facility B worked in facility C then facility C must be included. Also, if there are employees not in facility A, B or C that have hours in A, B or C then you must also include those facilities.

|-
| Maximum hours that will calculate from a "Time" differential premium used on the worked holiday tab of holiday configuration
| WorkedHolidayDifferentialMaximumMinutes
| IntegerValue
| 9999
| This is the number of minutes so multiple an hour maximum by 60. This only works with Time Premiums or Time & Shift Premiums.

|-
| Phantom punches are temporary punches added between shifts so as to calculate double shifts correctly. This setting will calculate the time cards in a similar manner as if Out/In punches were added manually.
| CalculatePhantomPunchesLikeActualPunches
| True / False value
| False
| This does not split shifts to different pay dates as pay date determination is done prior to the adding of phantom punches.

|-
| Department Of Labor Weighted Overtime Pay Rate Calculations for specific labor levels only
| DepartmentOfLaborPayRateCalculations
| True / False value
| False
|

|-
| HHSOIG report requires birth dates to match (both must exist)
| HHSOIGBirthDateMatch
| True / False value
| False
|

|-
| SAM report requires zip codes to match (both must exist)
| SAMZipCodeMatch
| True / False value
| False
|

|-
| 6th pay date overtime level minimum minutes.
| SixthPayDateOvertimeLevelMinimumMinutes
| Integer value
| 0
| The Fixed Hour Level in overtime configuration is the maximum overtime level.

|-
| Disregards any Is Hire Date on employee status and the global rule about first / last active status as hire date such that the latest active status is ALWAYS the hire date.
| LatestActiveStatusAlwaysConsideredHireDate
| True / False value
| False
|

|-
| If shift count times daily hours is less than this number than employee shift type is changed to PD when adding employee shifts
| PartTimeShiftTypeMinimumShiftCountTimesDailyHours
| Decimal value
| -1 (ignored)
|

|-
| If shift count times daily hours is greater than this number than employee shift type is changed to FT when adding employee shifts
| PartTimeShiftTypeMaximumShiftCountTimesDailyHours
| Decimal value
| -1 (ignored)
| E.g. if 30 hours is considered full time then enter 29.99

|-
| Enable Software to export data to Keeper FTP Site
| KeeperExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software and does not need a separate entry for each facility in a Multi-Facility software. The software will also potentially require an update if it hasn't been updated since 2/20/2024.

|-
| Enable Software to export data to TapCheck FTP Site
| TapcheckExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software and does not need a separate entry for each facility in a Multi-Facility software. The software will also potentially require an update if it hasn't been updated since 12/21/2021.

|-
| Add custom date field to use for Holiday and Worked Holiday Seniority. This date field will override the default (Hire Date) if filled out.
| UseEmployeeDate3ForHolidaySeniority
| True / False value
| False
| You can use either the Date 3 field or Date 4 field (if you use the Date 4 field you need to change the custom configuration to UseEmployeeDate4ForHolidaySeniority). To change the text displayed next to the date field you would go to Configuration-->Setup-->System-->Employment.

|}

Employment Reports

2024-12-18T14:46:53Z

Joel:

[[image:EmploymentReports.png|right]]

===CPR Expiration dates===

Displays employees who have a CPR expiration date within the selected date range.

===Drug Screen Report===

Displays employee with missing drug screen information.

===EEO-1 Report===

When completing the EEO-1, use data from only one pay period and include both part-time and full-time employees. See this link for more details: [https://www.eeocdata.org/EEO1/home/index]

(If running it for the current pay period then filter for Active employees on the Current Status tab. If running it for a prior pay period then select all on the Current Status tab and filter instead on the Advanced/Status By Date Range tab).

The EEO-1 will only count employees that have all 3 filled in:

*EEOC Category
*Gender
*Race

All employees that are ''not'' counted are listed by name on the bottom of the report.

===EOC Report===

The EEOC report displays all employees to show their EEOC category or if it's not filled in.

===Expiring and Due Dates===

Reports on employees with expiring and due dates in their Licensing, Health and I9 information within a selected date range. The Options tab allows you to select what information to report on. This report does NOT perform missing date checking. You should use this report in conjunction with the Missing Dates report. Otherwise, use the individual Health Due, I9 Expiration Dates, and License Expiration Dates, which check BOTH missing and expiring/due dates.

===Employee Expiring and Due Dates Letter===

This is a template form letter that is printed one page per employee and allows you to customize the letter content. The following placeholders can be used when composing your form letter:

<Image>d:\pictures\<nowiki>logo.bm</nowiki>p</Image> allows for an image to be placed at the top and center of the page. Provide the full path to the image.

<Employee> will print the employee's first and last name.

<Date> will print the current date.

<EarliestDate> will print the earliest of the expiring/due dates.

<DateDescriptions> will print the expiring/due descriptions.

<LastDates> will print the previous descriptions and dates (if applicable).

<NextDates> will print the expiring/due descriptions and dates.

Line breaks are made with the Enter key. Tabs are not currently supported.

===Employees With CPR Certification===

Displays employees who have a CPR date entered.

===Employees With IV Certification===

Displays employees who have IV certification date entered.

===Employment Dates===

Displays employees that have license, health, employment, and custom dates, within the selected date range. Including checking for missing dates. Choose the date types you want to check in the Options tab.

===Health Dates===

Displays health dates within the selected date range. Including checking for missing dates.

===Health Due Dates===

Reports on employees with Health due dates within a selected date range. There is a dedicated column for each health due date and employees that do not have their date information entered will show up as **MISSING** on the report. Although the Rubella and Measles do not have a due date (only a received date), this report will still check that these dates are not missing.

===HHS OIG Search===

U.S Department of Health and Human Services, Office of the Inspector General search. This report compares the employees in the software with an Excel list that needs to get downloaded into the Tools/Folders/Download Folder. There is already an old Excel list in that location, but it will need to be manually refreshed to keep it up to date. See the readme file in that location for instructions on how to refresh it. When running this report, it could take a few minutes to finish until it displays the results.

===I9 Expiration Dates===

Reports on employees with I9 expiration dates within a selected date range. There is a dedicated column for each I9 expiration date and employees that do not have their date information entered will show up as **MISSING** on the report.

===Influenza Report===

This report will provide a list of all employees indicating if they got the Influenza shot. Select a Date-Range and choose on the Options tab if you want the report to show all who got it in the date-range or all who didn't get it in the date-range.

===Licenses Expiration Dates===

Reports on employees with license expiration dates within a selected date range. There is a dedicated column for each license expiration date and employees that do not have their date information entered will show up as **MISSING** on the report.

===Missing Dates===

Reports on employees with missing dates in their Licensing, Health and I9 information. The Options tab allows you to select what information to report on. Note that the Health Due, I9 Expiration Dates and License Expiration Dates reports also check for missing dates. This report is used in conjunction with the Expiring and Due Dates report.

===Missing Document IDs===

Displays employees who have missing documents IDs in their license or employment information.

===Pneumococcal Report===

Displays employees with their Pneumococcal Vaccination status.

===SAM Search===

System for Award Management search which replaced EPLS. This report compares the employees in the software with an Excel list that needs to get downloaded into the Tools/Folders/Download Folder. There is already an old Excel list in that location, but it will need to be manually refreshed to keep it up to date. See the readme file in that location for instructions on how to refresh it. When running this report, it could take a few minutes to finish until it displays the results.

===SSN Not Verified===

Displays employees who have not had their SSN verified.

===Turnover Report===

Turnover is calculated as Terminated divided by the average of Starting and Ending.

Terminated / [(Starting + Ending) / 2]

All employees that have a status that is not displayed by default when opening the software are considered terminated.

===Union Report===

Displays employees who have their Union date within the selected date range.

== See Also ==

* [[Reports]]

Employment Reports

2024-12-18T14:41:34Z

Joel:

[[image:EmploymentReports.png|right]]

===CPR Expiration dates===

Displays employees who have a CPR expiration date within the selected date range.

===Drug Screen Report===

Displays employee with missing drug screen information.

===EEO-1 Report===

When completing the EEO-1, use data from only one pay period and include both part-time and full-time employees. See this link for more details: [https://www.eeocdata.org/EEO1/home/index]

(If running it for the current pay period then filter for Active employees on the Current Status tab. If running it for a prior pay period then select all on the Current Status tab and filter instead on the Advanced/Status By Date Range tab).

The EEO-1 will only count employees that have all 3 filled in:

*EEOC Category
*Gender
*Race

All employees that are ''not'' counted are listed by name on the bottom of the report.

===EOC Report===

The EEOC report displays all employees to show their EEOC category or if it's not filled in.

===Expiring and Due Dates===

Reports on employees with expiring and due dates in their Licensing, Health and I9 information within a selected date range. The Options tab allows you to select what information to report on. This report does NOT perform missing date checking. You should use this report in conjunction with the Missing Dates report. Otherwise, use the individual Health Due, I9 Expiration Dates, and License Expiration Dates, which check BOTH missing and expiring/due dates.

===Employee Expiring and Due Dates Letter===

This is a template form letter that is printed one page per employee and allows you to customize the letter content. The following placeholders can be used when composing your form letter:

<Image>d:\pictures\<nowiki>logo.bm</nowiki>p</Image> allows for an image to be placed at the top and center of the page. Provide the full path to the image.

<Employee> will print the employee's first and last name.

<Date> will print the current date.

<EarliestDate> will print the earliest of the expiring/due dates.

<DateDescriptions> will print the expiring/due descriptions.

<LastDates> will print the previous descriptions and dates (if applicable).

<NextDates> will print the expiring/due descriptions and dates.

Line breaks are made with the Enter key. Tabs are not currently supported.

===Employees With CPR Certification===

Displays employees who have a CPR date entered.

===Employees With IV Certification===

Displays employees who have IV certification date entered.

===Employment Dates===

Displays employees that have license, health, employment, and custom dates, within the selected date range. Including checking for missing dates. Choose the date types you want to check in the Options tab.

===Health Dates===

Displays health dates within the selected date range. Including checking for missing dates.

===Health Due Dates===

Reports on employees with Health due dates within a selected date range. There is a dedicated column for each health due date and employees that do not have their date information entered will show up as **MISSING** on the report. Although the Rubella and Measles do not have a due date (only a received date), this report will still check that these dates are not missing.

===HHS OIG Search===

U.S Department of Health and Human Services, Office of the Inspector General search. This report compares the employees in the software with an Excel list that needs to get downloaded into the Tools/Folders/Download Folder. There is already an old Excel list in that location but it will need to be manually refreshed to keap it up to date. See the readme file in that location for instructions on how to refresh it.

===I9 Expiration Dates===

Reports on employees with I9 expiration dates within a selected date range. There is a dedicated column for each I9 expiration date and employees that do not have their date information entered will show up as **MISSING** on the report.

===Influenza Report===

This report will provide a list of all employees indicating if they got the Influenza shot. Select a Date-Range and choose on the Options tab if you want the report to show all who got it in the date-range or all who didn't get it in the date-range.

===Licenses Expiration Dates===

Reports on employees with license expiration dates within a selected date range. There is a dedicated column for each license expiration date and employees that do not have their date information entered will show up as **MISSING** on the report.

===Missing Dates===

Reports on employees with missing dates in their Licensing, Health and I9 information. The Options tab allows you to select what information to report on. Note that the Health Due, I9 Expiration Dates and License Expiration Dates reports also check for missing dates. This report is used in conjunction with the Expiring and Due Dates report.

===Missing Document IDs===

Displays employees who have missing documents IDs in their license or employment information.

===Pneumococcal Report===

Displays employees with their Pneumococcal Vaccination status.

===SAM Search===

System for Award Management search which replaced EPLS. This report compares the employees in the software with an Excel list that needs to get downloaded into the Tools/Folders/Download Folder. There is already an old Excel list in that location but it will need to be manually refreshed to keap it up to date. See the readme file in that location for instructions on how to refresh it.

===SSN Not Verified===

Displays employees who have not had their SSN verified.

===Turnover Report===

Turnover is calculated as Terminated divided by the average of Starting and Ending.

Terminated / [(Starting + Ending) / 2]

All employees that have a status that is not displayed by default when opening the software are considered terminated.

===Union Report===

Displays employees who have their Union date within the selected date range.

== See Also ==

* [[Reports]]

Pay Types Configuration

2024-09-05T01:32:34Z

Joel:

{{Advanced}}

==Pay Types==

[[File:MainPayTypes.png]]

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

'''Main'''

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

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

''Type'' – OT should be set as Overtime. (This is used tell the software what pay types to look at when creating the Approaching-Overtime report).

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

''Alternate Sort Order'' -

''Facilities'' -

''Color'' -

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

''Do Not Calculate Hours'' - Punches for this pay type will not give any hours (If the schedule is set to pay this pay type).

''Schedule Auto Punch / Auto Hours'' – 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. If the schedule has Auto Hours filled in, it will give hours only without punches.

''Display At Scheduler Level'' -

''Default Other Hours Type'' -

''Hours Amount Type'' -

''Fixed Hours Amount'' -

''Pay Type Tag'' -

'''Overtime'''

[[File:PayOvertime.png]]

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

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

'''Premium'''

[[File:PayPremium.png]]

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

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

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

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

'''Holiday Overtime'''

[[File:PayHolidayOvertime.png]]

'''Lookups'''

[[File:PayLookups.png]]

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

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

'''Accruals'''

[[File:PayAccruals.png]]

''Accrual Pay Type'' –

''Accrual Contributing Pay Type'' –

''Contribute Proportioned Hours As Daily Hours'' –

''Punches Count Towards Accrual'' –

''Other Hours Unworked Count Towards Accrual'' –

''Other Hours Worked Count Towards accrual'' –

''Premium Counts Towards accrual'' –

''Hours Disqualify Date entitlements'' –

''Date Entitlement Disqualification Level'' –

'''Tags'''

[[File:PayTags.png]]

'''Rates and Payroll'''

[[File:PayRatesAndPayroll.png]]

''Rate Addition'' -

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

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

''Rate Number'' -

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

''Payroll Rate Multiplier'' -

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

''Export As Negative'' -

''DOL - Rate Multiplier'' - the rate to use when summing up the total amount to get the total regular pay. For almost all pay types this should be the same as the Rate Multiplier above. Only for OT pay types it should be different than above so that we only include in the total regular pay the base portion of the OT and not the extra half. This is only applicable to pay types that are Count Amount below and don't use fixed rate. (A fixed rate OT pay type is not compatible with these DOL settings). You may also choose a Rate Multiplier of 1 for pay types that are paying a premium that is 0.5 or more (Daily OT, HOT, etc.) as this may be considered a discretionary bonus but verify with a labor lawyer.

''DOL - Count Hours'' - if pay type is for actual worked hours (Reg, OT, HOT, etc.). Unselect if it's an add-on pay type like diff or bonus. This is used to sum up all worked hours so that we can divide the total regular pay by the total number of hours to get the average regular pay per hour.

''DOL - Count Amount'' - For almost all pay types this should be selected. Unselect it for pay types that don't go to payroll (Call Out, etc.), or pay types that are unrelated to the work period (Reimbursement, Benefit Hours, Retro?). Select it for discretionary bonuses (considered OT) even if using a DOL Rate Multiplier of 0, so that it will be considered OT pay to help satisfy the added OT pay required for the DOL weighted average overtime.

''DOL - Increase Rate'' - For the legal OT pay types that should get the higher DOL overtime rate.

''Is PBJ Pay Type'' - if pay type is for actual worked hours (Reg, OT, HOT, etc.). Unselect if it's a benefit pay type (PTO, Vac, Sick, etc.), or if it's an add on pay type like diff or bonus.

''Union Report ID'' -

'''Attendance Calendar'''

[[File:PayAttendanceCalendar.png]]

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

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

== See also ==

* [[Configuration]]

Pay Types Configuration

2024-09-03T22:17:37Z

Joel:

{{Advanced}}

==Pay Types==

[[File:MainPayTypes.png]]

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

'''Main'''

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

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

''Type'' – OT should be set as Overtime. (This is used tell the software what pay types to look at when creating the Approaching-Overtime report).

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

''Alternate Sort Order'' -

''Facilities'' -

''Color'' -

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

''Do Not Calculate Hours'' - Punches for this pay type will not give any hours (If the schedule is set to pay this pay type).

''Schedule Auto Punch / Auto Hours'' – 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. If the schedule has Auto Hours filled in, it will give hours only without punches.

''Display At Scheduler Level'' -

''Default Other Hours Type'' -

''Hours Amount Type'' -

''Fixed Hours Amount'' -

''Pay Type Tag'' -

'''Overtime'''

[[File:PayOvertime.png]]

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

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

'''Premium'''

[[File:PayPremium.png]]

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

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

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

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

'''Holiday Overtime'''

[[File:PayHolidayOvertime.png]]

'''Lookups'''

[[File:PayLookups.png]]

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

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

'''Accruals'''

[[File:PayAccruals.png]]

''Accrual Pay Type'' –

''Accrual Contributing Pay Type'' –

''Contribute Proportioned Hours As Daily Hours'' –

''Punches Count Towards Accrual'' –

''Other Hours Unworked Count Towards Accrual'' –

''Other Hours Worked Count Towards accrual'' –

''Premium Counts Towards accrual'' –

''Hours Disqualify Date entitlements'' –

''Date Entitlement Disqualification Level'' –

'''Tags'''

[[File:PayTags.png]]

'''Rates and Payroll'''

[[File:PayRatesAndPayroll.png]]

''Rate Addition'' -

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

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

''Rate Number'' -

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

''Payroll Rate Multiplier'' -

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

''Export As Negative'' -

''DOL - Rate Multiplier'' - the rate to use when summing up the total amount to get the total regular pay. For almost all pay types this should be the same as the Rate Multiplier above. Only for OT pay types it should be different than above so that we only include in the total regular pay the base portion of the OT and not the extra half. This is only applicable to pay types that are Count Amount below and don't use fixed rate. (A fixed rate OT pay type is not compatible with these DOL settings). You may also choose a Rate Multiplier of 1 for pay types that are paying a premium that is 0.5 or more (Daily OT, HOT, etc.) as this may be considered a discretionary bonus but verify with a labor lawyer.

''DOL - Count Hours'' - if pay type is for actual worked hours (Reg, OT, HOT, etc.). Unselect if it's an add-on pay type like diff or bonus. This is used to sum up all worked hours so that we can divide the total regular pay by the total number of hours to get the average regular pay per hour.

''DOL - Count Amount'' - For almost all pay types this should be selected. Unselect it for pay types that don't go to payroll (Call Out, etc.), or pay types that are unrelated to the work period (Reimbursement, Benefit Hours, Retro?), or discretionary bonuses.

''DOL - Increase Rate'' - For the legal OT pay types that should get the higher DOL overtime rate.

''Is PBJ Pay Type'' - if pay type is for actual worked hours (Reg, OT, HOT, etc.). Unselect if it's a benefit pay type (PTO, Vac, Sick, etc.), or if it's an add on pay type like diff or bonus.

''Union Report ID'' -

'''Attendance Calendar'''

[[File:PayAttendanceCalendar.png]]

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

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

== See also ==

* [[Configuration]]

Pay Types Configuration

2024-09-03T20:56:43Z

Joel:

{{Advanced}}

==Pay Types==

[[File:MainPayTypes.png]]

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

'''Main'''

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

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

''Type'' – OT should be set as Overtime. (This is used tell the software what pay types to look at when creating the Approaching-Overtime report).

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

''Alternate Sort Order'' -

''Facilities'' -

''Color'' -

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

''Do Not Calculate Hours'' - Punches for this pay type will not give any hours (If the schedule is set to pay this pay type).

''Schedule Auto Punch / Auto Hours'' – 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. If the schedule has Auto Hours filled in, it will give hours only without punches.

''Display At Scheduler Level'' -

''Default Other Hours Type'' -

''Hours Amount Type'' -

''Fixed Hours Amount'' -

''Pay Type Tag'' -

'''Overtime'''

[[File:PayOvertime.png]]

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

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

'''Premium'''

[[File:PayPremium.png]]

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

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

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

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

'''Holiday Overtime'''

[[File:PayHolidayOvertime.png]]

'''Lookups'''

[[File:PayLookups.png]]

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

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

'''Accruals'''

[[File:PayAccruals.png]]

''Accrual Pay Type'' –

''Accrual Contributing Pay Type'' –

''Contribute Proportioned Hours As Daily Hours'' –

''Punches Count Towards Accrual'' –

''Other Hours Unworked Count Towards Accrual'' –

''Other Hours Worked Count Towards accrual'' –

''Premium Counts Towards accrual'' –

''Hours Disqualify Date entitlements'' –

''Date Entitlement Disqualification Level'' –

'''Tags'''

[[File:PayTags.png]]

'''Rates and Payroll'''

[[File:PayRatesAndPayroll.png]]

''Rate Addition'' -

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

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

''Rate Number'' -

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

''Payroll Rate Multiplier'' -

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

''Export As Negative'' -

''DOL - Rate Multiplier'' - the rate to use when summing up the total amount to get the total regular pay. For almost all pay types this should be the same as the Rate Multiplier above. Only for OT pay types it should be different than above so that we only include in the total regular pay the base portion of the OT and not the extra half. This is only applicable to pay types that are Count Amount below and don't use fixed rate. (A fixed rate OT pay type is not compatible with these DOL settings).

''DOL - Count Hours'' - if pay type is for actual worked hours (Reg, OT, HOT, etc.). Unselect if it's an add-on pay type like diff or bonus. This is used to sum up all worked hours so that we can divide the total regular pay by the total number of hours to get the average regular pay per hour.

''DOL - Count Amount'' - For almost all pay types this should be selected. Unselect it for pay types that don't go to payroll (Call Out, etc.), or pay types that are unrelated to the work period (Reimbursement, Benefit Hours?, Retro?).

''DOL - Increase Rate'' - For the OT pay types that should get the higher DOL overtime rate.

''Is PBJ Pay Type'' - if pay type is for actual worked hours (Reg, OT, HOT, etc.). Unselect if it's a benefit pay type (PTO, Vac, Sick, etc.), or if it's an add on pay type like diff or bonus.

''Union Report ID'' -

'''Attendance Calendar'''

[[File:PayAttendanceCalendar.png]]

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

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

== See also ==

* [[Configuration]]

Pay Types Configuration

2024-09-03T19:41:16Z

Joel: /* Pay Types */

{{Advanced}}

==Pay Types==

[[File:MainPayTypes.png]]

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

'''Main'''

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

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

''Type'' – OT should be set as Overtime. (This is used tell the software what pay types to look at when creating the Approaching-Overtime report).

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

''Alternate Sort Order'' -

''Facilities'' -

''Color'' -

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

''Do Not Calculate Hours'' - Punches for this pay type will not give any hours (If the schedule is set to pay this pay type).

''Schedule Auto Punch / Auto Hours'' – 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. If the schedule has Auto Hours filled in, it will give hours only without punches.

''Display At Scheduler Level'' -

''Default Other Hours Type'' -

''Hours Amount Type'' -

''Fixed Hours Amount'' -

''Pay Type Tag'' -

'''Overtime'''

[[File:PayOvertime.png]]

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

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

'''Premium'''

[[File:PayPremium.png]]

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

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

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

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

'''Holiday Overtime'''

[[File:PayHolidayOvertime.png]]

'''Lookups'''

[[File:PayLookups.png]]

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

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

'''Accruals'''

[[File:PayAccruals.png]]

''Accrual Pay Type'' –

''Accrual Contributing Pay Type'' –

''Contribute Proportioned Hours As Daily Hours'' –

''Punches Count Towards Accrual'' –

''Other Hours Unworked Count Towards Accrual'' –

''Other Hours Worked Count Towards accrual'' –

''Premium Counts Towards accrual'' –

''Hours Disqualify Date entitlements'' –

''Date Entitlement Disqualification Level'' –

'''Tags'''

[[File:PayTags.png]]

'''Rates and Payroll'''

[[File:PayRatesAndPayroll.png]]

''Rate Addition'' -

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

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

''Rate Number'' -

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

''Payroll Rate Multiplier'' -

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

''Export As Negative'' -

''DOL - Rate Multiplier'' - the rate to use when summing up the total amount to get the total regular pay. For almost all pay types this should be the same as the Rate Multiplier above. Only for OT pay types it should be different than above so that we only include in the total reguler pay the base portion of the OT and not the extra half. (This setting will not work for a fixed rate OT pay type).

''DOL - Count Hours'' -

''DOL - Count Amount'' -

''DOL - Increase Rate'' -

''Is PBJ Pay Type'' - if pay type is for actual worked hours (Reg, OT, HOT, etc.). Unselect if it's a benefit pay type (PTO, Vac, Sick, etc.), or if it's an add on pay type like diff or bonus.

''Union Report ID'' -

'''Attendance Calendar'''

[[File:PayAttendanceCalendar.png]]

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

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

== See also ==

* [[Configuration]]

Pay Types Configuration

2024-09-03T19:32:24Z

Joel:

{{Advanced}}

==Pay Types==

[[File:MainPayTypes.png]]

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

'''Main'''

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

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

''Type'' – OT should be set as Overtime. (This is used tell the software what pay types to look at when creating the Approaching-Overtime report).

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

''Alternate Sort Order'' -

''Facilities'' -

''Color'' -

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

''Do Not Calculate Hours'' - Punches for this pay type will not give any hours (If the schedule is set to pay this pay type).

''Schedule Auto Punch / Auto Hours'' – 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. If the schedule has Auto Hours filled in, it will give hours only without punches.

''Display At Scheduler Level'' -

''Default Other Hours Type'' -

''Hours Amount Type'' -

''Fixed Hours Amount'' -

''Pay Type Tag'' -

'''Overtime'''

[[File:PayOvertime.png]]

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

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

'''Premium'''

[[File:PayPremium.png]]

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

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

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

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

'''Holiday Overtime'''

[[File:PayHolidayOvertime.png]]

'''Lookups'''

[[File:PayLookups.png]]

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

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

'''Accruals'''

[[File:PayAccruals.png]]

''Accrual Pay Type'' –

''Accrual Contributing Pay Type'' –

''Contribute Proportioned Hours As Daily Hours'' –

''Punches Count Towards Accrual'' –

''Other Hours Unworked Count Towards Accrual'' –

''Other Hours Worked Count Towards accrual'' –

''Premium Counts Towards accrual'' –

''Hours Disqualify Date entitlements'' –

''Date Entitlement Disqualification Level'' –

'''Tags'''

[[File:PayTags.png]]

'''Rates and Payroll'''

[[File:PayRatesAndPayroll.png]]

''Rate Addition'' -

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

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

''Rate Number'' -

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

''Payroll Rate Multiplier'' -

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

''Export As Negative'' -

''DOL - Rage Multiplier'' -

''DOL - Rage Multiplier'' -

''DOL - Rage Multiplier'' -

''DOL - Rage Multiplier'' -

''Is PBJ Pay Type'' - if pay type is for actual worked hours (Reg, OT, HOT, etc.). Unselect if it's a benefit pay type (PTO, Vac, Sick, etc.), or if it's an add on pay type like diff or bonus.

''Union Report ID'' -

'''Attendance Calendar'''

[[File:PayAttendanceCalendar.png]]

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

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

== See also ==

* [[Configuration]]

Custom Configuration

2024-08-26T23:31:43Z

Joel: /* Time Clocks */

{{Advanced}}

The Custom configuration screen allows system configuration settings that would typically apply to the software as a whole to be applied based on criteria. Custom configuration settings use a text based identifier combined with a value that can be a true/false, a string, a number or a date. Each custom configuration settings will use some or all of the following criteria:

* Labor Levels (home or worked based on the setting)
* Pay Rule
* Base Schedule Group
* Holiday Group
* Accrual Group
* Pay Type
* Accrual Pay Type
* Shift (home or worked based on the setting)
* Employed Date Range
* Effective Date Range
* Employee Shift Count
* Employee Shift Type

Each custom configuration settings uses a Custom Configuration ID that uniquely identifies the setting. Each setting will use either the true/false, string, numerical or date value. The following are the current custom configuration settings supported:

==Settings==

===Payroll===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| ADP payroll export group by week number option is used when there is a biweekly payroll and using weighted overtime
| ADPPayrollExportGroupByWeekNumber
| True / False value
| False
|

|-
| David Klein # 1 payroll interface option to group hours by pay date
| DavidKleinPayrollExportGroupByPayDate
| True / False Value
| True
| If true (default) then it will export separate rows for each pay date for each employee. If false (check box unselected) then it will export just a total for the whole pay period.

|-
| David Klein # 1 payroll interface option to group hours by shift
| DavidKleinPayrollExportGroupByShift
| True / False Value
| False
|

|-
| Evolution payroll interface option to place the department in a different column
| EvolutionDepartmentColumn
| String Value
| "C"
| Use any of these to indicate the column: "B", "C", "D", "E", "G", "H". Enter "NONE" to not show the department at all. Only the labor level filters will work with this custom configuration.

|-
| Kronos payroll interface option to put the hours value for a pay type in the amount column
| KronosPayrollExportAsAmount
| True / False Value
| False
| The pay type column should NOT be empty

|-
| Kronos payroll interface option to group hours by shift
| KronosPayrollExportGroupByShift
| True / False Value
| False
| The E Shift column will contain the first letter of the Shift ID

|-
| Kronos payroll interface option to consider pay types that do not add to totals to not be differentials
| KronosPayrollExportIsNotDifferential
| True / False Value
| False
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for custom E/D/T External ID for differential pay types
| KronosExportEDTExternalID
| String Value
| "Differential"
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for custom Pay Statement Type
| KronosExportPayStatementType
| String Value
| "Regular"
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for duplicate entry using a different payroll pay code
| KronosExportDuplicateEntry
| String Value
| No additional line added if not present
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Millennium payroll interface (single company) option to group hours by shift
| MillenniumPayrollSingleCompanyGroupByShift
| True / False Value
| False
| This adds an additional column named Shift

|-
| Millennium payroll interface (single company) always show department
| MillenniumPayrollSingleCompanyAlwaysShowDepartment
| True / False Value
| False
| Department is only placed by default when the worked department does not equal the home department

|-
| Millennium payroll interface (single company) CC1 column labor level level
| MillenniumPayrollSingleCompanyExportCC1LaborLevelLevel
| Integer Value
| Department Level
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC2 column labor level level
| MillenniumPayrollSingleCompanyExportCC2LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC3 column labor level level
| MillenniumPayrollSingleCompanyExportCC3LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC4 column labor level level
| MillenniumPayrollSingleCompanyExportCC4LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC5 column labor level level
| MillenniumPayrollSingleCompanyExportCC5LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Viventium Payroll Export option to group hours by pay date
| ViventiumPayrollExportGroupByPayDate
| True / False Value
| True
| If true (default) then it will export separate rows for each pay date for each employee. If false (check box unselected) then it will export just a total for the whole pay period for each employee. This is a whole software-wide setting and can't use any filters.

|-
| Viventium Payroll Export 1st Additional Labor Level level
| ViventiumPayrollExport1stAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium Payroll Export 2nd Additional Labor Level level
| ViventiumPayrollExport2ndAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium Payroll Export 3rd Additional Labor Level level
| ViventiumPayrollExport3rdAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium payroll export Accrual Balances as Memo
| ViventiumUseMemoForAccrualBalances
| True / False Value
| False
| This will export the accrual balances in the last column which will go on the pay stub as a memo, instead of the accrual balances getting exported as an extra line deduction (D).

|-
| Viventium payroll export hours format
| ViventiumPayrollExportHoursFormat
| String Value
| 0.0000
|

|-
| Viventium payroll export rate format
| ViventiumPayrollExportRateFormat
| String Value
| 0.0000
|
|}

===Scheduling===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Daily Staffing sheet employee sort order
| DailyStaffingSheetEmployeeSortOrder
| String Value
| FullName
| FullName or Seniority are the current 2 options

|-
| Monthly Schedule Area Acceptor determines how schedules match to the areas defined on the monthly schedule
| MonthlyScheduleAreaAcceptor
| String Value
| WorkedShiftWorkedBudgetGroupWorkedFloor
| Format is _____Shift_____BudgetGroup____Floor with options of Any, Home or Worked. E.g. AnyShiftWorkedBudgetGroupWorkedFloor

|-
| Time Restriction Early In Allowance
| TimeRestrictionEarlyInAllowance
| Integer Value
| 7
|

|-
| Time Restriction Late Out Allowance
| TimeRestrictionLateOutAllowance
| Integer Value
| 7
|
|}

===Pay Types===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Specify pay types that will be treated like worked hours for the worked days in week / pay period qualifier on holiday calculation
| ConsideredWorkedForHolidayWorkedDaysQualifier
| True / False value
| False
| On or after holiday is supported

|-
| Override pay type configuration Punches Count Towards Daily Overtime rule
| PunchesCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Period Overtime rule
| PunchesCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Premium rule
| PunchesCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Holiday Overtime rule
| PunchesCountTowardsHolidayOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Accrual rule
| PunchesCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Daily Overtime rule
| OtherHoursWorkedCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Period Overtime rule
| OtherHoursWorkedCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Premium rule
| OtherHoursWorkedCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Holiday Overtime rule
| OtherHoursWorkedCountTowardsHolidayOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Accrual rule
| OtherHoursWorkedCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Daily Overtime rule
| OtherHoursUnworkedCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Period Overtime rule
| OtherHoursUnworkedCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Actual Date Towards Period Overtime rule
| OtherHoursUnworkedCountActualDateTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Premium rule
| OtherHoursUnworkedCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Actual Date Towards Premium rule
| OtherHoursUnworkedCountActualDateTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Accrual rule
| OtherHoursUnworkedCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Accrual rule
| PremiumCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Period Overtime rule
| PremiumCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Premium rule
| PremiumCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Do not allow use of a pay type until the employee has been employed for X number of days
| PayTypeSenorityDays
| Integer value
| 0
| Actual date of other hours must be greater than or equal to hire date plus seniority days. E.g. if employed on January 1 and seniority days is 7 then actual date must be January 8th or later. Effectively we are saying that the 7 days have been completed and so on the 8th you can use this pay type.

|-
| Count all pay types that Add-To-Total, for specific differential ID "CAPTATTFDI"
| CountAllPayTypesAddToTotalForDifferentialIdCAPTATTFDI
| True / False value
| False
| This will override the setting on pay types if they are set to not count for premiums. Fill in the special code "CAPTATTFDI" anywhere in the Premium ID/name, and it will count all pay types that Add-To-Total for this differential. Filters are not in effect for this custom configuration and is in effect for the whole software (use the premium worked labor level filters instead if needed). This custom configuration only works for differentials.

|}

===Time Clocks===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| When using multi facility punching it will set the facility on the punch the same as the time clock's facility.
| OverrideFacilityLaborLevelSameAsTimeClock
| True / False value
| False
| This is a global setting for the entire software and does not use any filters.

|-
| Fingercheck Clock Download Punches Look Back Days
| FingercheckPollLookBackDays
| Integer Value
| 3
| Even though duplicates are discarded, it will still be slow to go back to much. This is a global setting for the entire software and does not use any filters.

|-
| Wdms Time Clock Supervisor Code
| WdmsTimeClockSupervisorCode
| Integer Value
| 2
| The code that will be sent to WDMS for the employees that are marked in TA as a clock supervisor. 2 = Register, 6 = System Administrator, 14 = Super Administrator. Before setting this value make sure that the role exists in the clock. The facility labor level filter can be used to set it for a specific facility in a Multi-Facility software. Minimum TA version required: 4.6.8446.1937

|-
| Time Restriction Early In Allowance
| TimeRestrictionEarlyInAllowance
| Integer Value
| 7
|

|-
| Time Restriction Late Out Allowance
| TimeRestrictionLateOutAllowance
| Integer Value
| 7
|
|}

===Accruals===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Pretend that the employee worked the number of hours in their shift history for accrual proposes.
| AccrueAtShiftCountTimesDailyHoursLevel
| True / False value
| False
| The Employee could have not worked at all, or worked less, or worked more, but will still pretend that the employee actually worked the exact shift history hours (shift count x daily hours). This number of pretend worked hours will then be used to calculate the accruals. Any other accrual calculation settings will apply afterward on top of this number.

|-
| Employee accrues without any limit in the accrual period. This allows a more fine-grained approach than the accrual group provides.
| AccrualNoMaximumContributingMinutes
| True / False value
| False
|

|-
| Employee accrues their full-time shift count if they worked less or even if they didn't actually work at all. This allows a more fine-grained approach than the accrual group provides.
| CalculateFullAccrualEarning
| True / False value
| False
|

|-
| Minimum worked hours in 2 weeks required to get accrual annual entitlements
| AccrualAnnualEntitlementsMinimumWorkedHoursIn2Weeks
| Decimal value
| 0
| Employee has to work this minimum amount of hours in 2 weeks to be eligible to earn any accrual annual entitlements for the current accrual period. For a bi-weekly accrual period, it's the hours worked in the current accrual period. For a weekly accrual period, it's the total hours worked in the current week and the previous week. (Maryland Sick law).

|-
| Minimum worked hours required in current accrual period to get accrual annual entitlements
| AccrualAnnualEntitlementsMinimumWorkedHoursInCurrentAccrualPeriod
| Decimal value
| 0
| Employee has to work this minimum amount of hours in the in current accrual period to be eligible to earn any accrual annual entitlements for the current accrual period.

|-
| Add custom date field to use for Employee Accruals Seniority. This date field will override default accruals configuration if filled out.
| UseEmployeeDate3ForAccrualStartDate
| True / False value
| False
| You can use either the Date 3 field or Date 4 field (if you use the Date 4 field you need to change the custom configuration to UseEmployeeDate4ForAccrualStartDate). To change the text displayed next to the date field you would go to Configuration-->Setup-->System-->Employment.

|-
| Override Use Hire Date For Seniority.
| UseHireDateForSeniority
| True / False value
| False
| This can be used to set it for each facility in a Multi-facility software.

|-
| Override Accrual Period Group Full Time Shift Count.
| AccrualPeriodGroupFullTimeShiftCount
| Decimal value
| Full Time Shift Count on the Accrual Period Group
| This can be used to override the Full Time Shift Count for a specific date range when switching accrual periods from weekly to biweekly or vise versa. Use the current Full Time Shift Count in the accrual period group and override for the past with the custom config using the effective to date. Filter for a specific accrual group.

|}

===Other===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Override the pay type that the schedule displays and uses for the initial calculation of hours
| BaseSchedulePayTypeID
| String Value - enter the pay type ID
| Ignored
| This is an intercept and does not change the underlying value. When using the scheduler and a schedule is given to an employee without this override in place, the original pay type will be used.

|-
| Do not deduct lunch when the lunch question at the time clock was answered "Not Taken"
| DoNotDeductLunchWhenLunchQuestionAnsweredNotTaken
| True / False Value
| False
|

|-
| Do not deduct lunch when the lunch question at the time clock was not answered i.e. "Unknown"
| DoNotDeductLunchWhenLunchQuestionNotAnswered
| True / False Value
| False
|

|-
| In a multi-facility configuration, if employees have worked hours in another facility then this will put those hours into the PBJ file of the worked facility.
| EmployeesHavePBJHoursInMultipleFacilities
| True / False Value
| False
| The PBJ file has to be created for all facilities that any employee in a selected facility has worked in. E.g., if you are running PBJ for facility A and facility A employees worked in facility B then you must create the file for facility B at the same time. If employees in facility B worked in facility C then facility C must be included. Also, if there are employees not in facility A, B or C that have hours in A, B or C then you must also include those facilities.

|-
| Maximum hours that will calculate from a "Time" differential premium used on the worked holiday tab of holiday configuration
| WorkedHolidayDifferentialMaximumMinutes
| IntegerValue
| 9999
| This is the number of minutes so multiple an hour maximum by 60. This only works with Time Premiums or Time & Shift Premiums.

|-
| Phantom punches are temporary punches added between shifts so as to calculate double shifts correctly. This setting will calculate the time cards in a similar manner as if Out/In punches were added manually.
| CalculatePhantomPunchesLikeActualPunches
| True / False value
| False
| This does not split shifts to different pay dates as pay date determination is done prior to the adding of phantom punches.

|-
| Department Of Labor Weighted Overtime Pay Rate Calculations for specific labor levels only
| DepartmentOfLaborPayRateCalculations
| True / False value
| False
|

|-
| HHSOIG report requires birth dates to match (both must exist)
| HHSOIGBirthDateMatch
| True / False value
| False
|

|-
| SAM report requires zip codes to match (both must exist)
| SAMZipCodeMatch
| True / False value
| False
|

|-
| 6th pay date overtime level minimum minutes.
| SixthPayDateOvertimeLevelMinimumMinutes
| Integer value
| 0
| The Fixed Hour Level in overtime configuration is the maximum overtime level.

|-
| Disregards any Is Hire Date on employee status and the global rule about first / last active status as hire date such that the latest active status is ALWAYS the hire date.
| LatestActiveStatusAlwaysConsideredHireDate
| True / False value
| False
|

|-
| If shift count times daily hours is less than this number than employee shift type is changed to PD when adding employee shifts
| PartTimeShiftTypeMinimumShiftCountTimesDailyHours
| Decimal value
| -1 (ignored)
|

|-
| If shift count times daily hours is greater than this number than employee shift type is changed to FT when adding employee shifts
| PartTimeShiftTypeMaximumShiftCountTimesDailyHours
| Decimal value
| -1 (ignored)
| E.g. if 30 hours is considered full time then enter 29.99

|-
| Enable Software to export data to Keeper FTP Site
| KeeperExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software and does not need a separate entry for each facility in a Multi-Facility software. The software will also potentially require an update if it hasn't been updated since 2/20/2024.

|-
| Enable Software to export data to TapCheck FTP Site
| TapcheckExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software and does not need a separate entry for each facility in a Multi-Facility software. The software will also potentially require an update if it hasn't been updated since 12/21/2021.

|}

Pay Date Comment Import

2024-07-11T19:29:47Z

Joel: Created page with "This imports Pay Date Comments into the employee's timecard. A Pay Date Comment import is identified by the sheet name or file name containing the word "Pay Date Comment". {|..."

This imports Pay Date Comments into the employee's timecard. A Pay Date Comment import is identified by the sheet name or file name containing the word "Pay Date Comment".

{| class="wikitable"

|-
! Column Type
! Identifiers
! Notes
! Required

|-
| Employee Identifier
| Employee ID, Emp ID, ID, Employee Number, Clock_ID, Payroll_ID, SSN_ID
| This is used to uniquely identify the employee. Note the distinction with the clock ID, SSN, and Payroll ID fields is the “_”. With a multi-facility configuration you must also provide the Facility column.
| Yes

|-
| Pay Date
| Pay Date
|
| Yes

|-
| Comment
| Comment
|
| Yes
|}

== See also ==

* [[Import]]

Import

2024-07-11T19:26:14Z

Joel:

Import is available in the Tools tab.

The software supports the import of information from an Excel file (xls – Excel 97-2003 format and xlsx Excel 2007-2010 format) or from a comma separated values file (csv). The extension on the filename must be csv if using a comma separated values file. Otherwise, the import will open the file as an Excel file.

The import will read data from multiple sheets within one Excel file. The filename takes precedence over the sheetname in identifying the import type. Each import has a different behavior regarding the adding, replacing or updating of data. An import may only add data to the software, update existing data, remove existing data and replace it, or both add and update data.

The information provided in the import file identifies the data. The file name, sheet names (Excel only) and column headers (the first row) identify the information. There is not a fixed column format. Specifically:

* Spaces and case are ignored so "Pay Rule", "pay rule", and "payrule" identify the same data.
* The name of the file can identify the import type for all sheets in the file, e.g. if the name of the file contains "employee," then all information in the file will be assumed to be employee information.
* The sheet names can identify the import type. This allows one Excel file to contain different types of information, e.g. both employee and planned absence information.

Upon identifying the import type, the next step is identifying the data contained in each column. The column headers used in the first row of each sheet identify the specific data within that column. For example, when importing budgets, the column header of "Shift" identifies the shift information. Therefore, in this example, the information provided in each row for this column must match to one of the existing shift IDs, shift descriptions, or scheduler IDs.

Every row imports if the correct row data is provided in each column. Each import type has required columns that must be provided.

The following import types are available:

{| class="wikitable"
|-
! Import Type
! Filename / sheet name Identifier

|-
| [[Accrual Adjustment Import|Accrual Adjustment (Employee)]]
| Accrual Adjustment

|-
| [[Accrual Balances Import|Accrual Balances (Employee)]]
| Accrual Balances

|-
| [[Accrual Date Entitlements Import|Accrual Date Entitlements (Configuration)]]
| Accrual Date

|-
| [[Employee Annual Entitlement Overrides Import|Accrual Entitlement Overrides (Employee)]]
| Employee Entitlement

|-
| [[Accrual Year End Adjustments Import|Accrual Year End Adjustments (Employee)]]
| Accrual Year End

|-
| [[Base Schedule Import|Base Schedules]]
| Base Schedules

|-
| [[Budget Import|Budget]]
| Budget

|-
| [[Casamaba Punch Import|Casamba Punch]]
| Casamba

|-
| [[Employee Import|Employee]]
| Employee

|-
| [[Hours Import|Hours]]
| Hours

|-
| [[In Service Import|In Service]]
| In Service

|-
| [[Labor Levels Import|Labor Levels]]
| Labor Level name, e.g. Department

|-
| [[Pay Rates Import|Pay Rates]]
| Pay Rates

|-
| [[Pay Rate Lookup Import|Pay Rate Lookup]]
| Pay Rate Lookup

|-
| [[Pay Date Comment Import|Pay Date Comment]]
| Pay Date Comment

|-
| [[Planned Absence Import|Planned Absence]]
| Planned Absence

|-
| [[Punch Import|Punch]]
| Punch

|-
| [[Raw Punch Import|Raw Punch]]
| Raw Punch

|-
| [[Schedule Import|Schedule]]
| Schedule

|-
| [[Schedule Pattern Import|Schedule Pattern]]
| Schedule Pattern

|-
| [[Slotting Import|Slotting]]
| Slotting

|-
| [[Time Clock Assignment Import|Time Clock Assignment]]
| Time Clock Assignment

|}

== See also ==

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

* [[Employees]]

* [[Employee]]

* [[Reports]]

* [[Scheduler]]

* [[Tools]]

* [[Configuration]]

Import

2024-07-11T19:20:42Z

Joel:

Import is available in the Tools tab.

The software supports the import of information from an Excel file (xls – Excel 97-2003 format and xlsx Excel 2007-2010 format) or from a comma separated values file (csv). The extension on the filename must be csv if using a comma separated values file. Otherwise, the import will open the file as an Excel file.

The import will read data from multiple sheets within one Excel file. The filename takes precedence over the sheetname in identifying the import type. Each import has a different behavior regarding the adding, replacing or updating of data. An import may only add data to the software, update existing data, remove existing data and replace it, or both add and update data.

The information provided in the import file identifies the data. The file name, sheet names (Excel only) and column headers (the first row) identify the information. There is not a fixed column format. Specifically:

* Spaces and case are ignored so "Pay Rule", "pay rule", and "payrule" identify the same data.
* The name of the file can identify the import type for all sheets in the file, e.g. if the name of the file contains "employee," then all information in the file will be assumed to be employee information.
* The sheet names can identify the import type. This allows one Excel file to contain different types of information, e.g. both employee and planned absence information.

Upon identifying the import type, the next step is identifying the data contained in each column. The column headers used in the first row of each sheet identify the specific data within that column. For example, when importing budgets, the column header of "Shift" identifies the shift information. Therefore, in this example, the information provided in each row for this column must match to one of the existing shift IDs, shift descriptions, or scheduler IDs.

Every row imports if the correct row data is provided in each column. Each import type has required columns that must be provided.

The following import types are available:

{| class="wikitable"
|-
! Import Type
! Filename / sheet name Identifier

|-
| [[Employee Annual Entitlement Overrides Import|Accrual Entitlement Overrides (Employee)]]
| Employee Entitlement

|-
| [[Accrual Adjustment Import|Accrual Adjustment (Employee)]]
| Accrual Adjustment

|-
| [[Accrual Balances Import|Accrual Balances (Employee)]]
| Accrual Balances

|-
| [[Accrual Date Entitlements Import|Accrual Date Entitlements (Configuration)]]
| Accrual Date

|-
| [[Accrual Year End Adjustments Import|Accrual Year End Adjustments (Employee)]]
| Accrual Year End

|-
| [[Base Schedule Import|Base Schedules]]
| Base Schedules

|-
| [[Budget Import|Budget]]
| Budget

|-
| [[Casamaba Punch Import|Casamba Punch]]
| Casamba

|-
| [[Employee Import|Employee]]
| Employee

|-
| [[Hours Import|Hours]]
| Hours

|-
| [[In Service Import|In Service]]
| In Service

|-
| [[Labor Levels Import|Labor Levels]]
| Labor Level name, e.g. Department

|-
| [[Planned Absence Import|Planned Absence]]
| Planned Absence

|-
| [[Pay Rates Import|Pay Rates]]
| Pay Rates

|-
| [[Pay Rate Lookup Import|Pay Rate Lookup]]
| Pay Rate Lookup

|-
| [[Raw Punch Import|Raw Punch]]
| Raw Punch

|-
| [[Punch Import|Punch]]
| Punch

|-
| [[Schedule Import|Schedule]]
| Schedule

|-
| [[Schedule Pattern Import|Schedule Pattern]]
| Schedule Pattern

|-
| [[Slotting Import|Slotting]]
| Slotting

|-
| [[Time Clock Assignment Import|Time Clock Assignment]]
| Time Clock Assignment

|}

== See also ==

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

* [[Employees]]

* [[Employee]]

* [[Reports]]

* [[Scheduler]]

* [[Tools]]

* [[Configuration]]

Payroll Export

2024-06-27T18:50:09Z

Joel:

[[image:PayrollExports.png|right]]
[[File:Payroll_Export_Report_3.png|right]]
The Payroll Export menu provides a selection of file exports that have been created to interface with various payroll software, therefore eliminating the need to key enter your employee payroll data. The selection screen for the payroll exports is the same as that used when running reports. Unlike reports, you will not necessarily see any form of output unless you are viewing the folder where the payroll file is created.

The following is a list of available payroll exports:

* [[Adaptasoft Export|Adaptasoft]]

* [[ADP Export|ADP]]

* [[BDB pcInterpay Export|BDB pcInterpay]]

* [[Budget Payroll Export|Budget Payroll Export]]

* [[Charts Export|Charts]]

* [[David Klein Payroll #1 (National Care) Export|David Klein Payroll #1 (National Care)]]

* [[David Klein Payroll #2 (National Care) Export|David Klein Payroll #2 (National Care)]]

* [[David Klein Payroll #3 (National Care) Export|David Klein Payroll #3 (National Care)]]

* [[Dynamics GP Export|Dynamics GP]]

* [[Empeon Accrual Export|Empeon Accrual]]

* [[Engage Payroll Export|Engage]]

* [[Evolution Payroll Export|Evolution]]

* [[Execupay (Excel Format) Export|Execupay (Excel Format)]]

* [[Execupay (Execupay Format) Export|Execupay (Execupay Format)]]

* [[Execupay (Swipe Clock Format) Export|Execupay (Swipe Clock Format)]]

* [[EZ Pay Plus Export|EZ Pay Plus]]

* [[Kronos Export|Kronos]]

* [[Kronos (With Punches) Export|Kronos (With Punches)]]

* [[Matrix (Time Express) Export|Matrix (Time Express)]]

* [[Millenium Accrual Export|Millenium Accrual]]

* [[Millenium Accrual (Multi-Company) Export|Millenium Accrual (Multi-Company)]]

* [[Millenium Payroll Export|Millenium Payroll]]

* [[Millenium Payroll (Multi-Company) Export|Millenium Payroll (Multi-Company)]]

* [[OneSource Export|OneSource]]

* [[PayChex Export|PayChex]]

* [[Paycom Export|Paycom]]

* [[Paylocity Export|Paylocity]]

* [[Paylocity Accrual Export|PaylocityAccrual]]

* [[Preliminary Payroll File Export|Preliminary Payroll File]]

* [[Proliant Export|Proliant]]

* [[QuickBooks Export|QuickBooks]]

* [[Rehab Optima Export|Rehab Optima]]

* [[Shlomo Klein Payroll Export|Shlomo Klein Payroll]]

* [[StaffPro Export|StaffPro]]

* [[Visual Export|Visual]]

* [[Viventium Export|Viventium]]

* [[Viventium Accrual Balances Export|Viventium Accrual Balances]]

* [[Viventium API Export|Viventium API Export]]

* [[Viventium Integration Update and Report|Viventium Integration (available on request)]]

<noinclude>== See Also ==

* [[Reports]]</noinclude>

Payroll Export

2024-06-27T18:48:25Z

Joel:

[[image:PayrollExports.png|right]]
[[File:Payroll_Export_Report_3.png|right]]
The Payroll Export menu provides a selection of file exports that have been created to interface with various payroll software, therefore eliminating the need to key enter your employee payroll data. The selection screen for the payroll exports is the same as that used when running reports. Unlike reports, you will not necessarily see any form of output unless you are viewing the folder where the payroll file is created.

The following is a list of available payroll exports:

* [[Adaptasoft Export|Adaptasoft]]

* [[ADP Export|ADP]]

* [[BDB pcInterpay Export|BDB pcInterpay]]

* [[Budget Payroll Export|Budget Payroll Export]]

* [[Charts Export|Charts]]

* [[David Klein Payroll #1 (National Care) Export|David Klein Payroll #1 (National Care)]]

* [[David Klein Payroll #2 (National Care) Export|David Klein Payroll #2 (National Care)]]

* [[David Klein Payroll #3 (National Care) Export|David Klein Payroll #3 (National Care)]]

* [[Dynamics GP Export|Dynamics GP]]

* [[Empeon Accrual Export|Empeon Accrual]]

* [[Engage Payroll Export|Engage]]

* [[Evolution Payroll Export|Evolution]]

* [[Execupay (Excel Format) Export|Execupay (Excel Format)]]

* [[Execupay (Execupay Format) Export|Execupay (Execupay Format)]]

* [[Execupay (Swipe Clock Format) Export|Execupay (Swipe Clock Format)]]

* [[EZ Pay Plus Export|EZ Pay Plus]]

* [[Kronos Export|Kronos]]

* [[Kronos (With Punches) Export|Kronos (With Punches)]]

* [[Matrix (Time Express) Export|Matrix (Time Express)]]

* [[Millenium Accrual Export|Millenium Accrual]]

* [[Millenium Accrual (Multi-Company) Export|Millenium Accrual (Multi-Company)]]

* [[Millenium Payroll Export|Millenium Payroll]]

* [[Millenium Payroll (Multi-Company) Export|Millenium Payroll (Multi-Company)]]

* [[OneSource Export|OneSource]]

* [[PayChex Export|PayChex]]

* [[Paycom Export|Paycom]]

* [[Paylocity Export|Paylocity]]

* [[Paylocity Accrual Export|PaylocityAccrual]]

* [[Preliminary Payroll File Export|Preliminary Payroll File]]

* [[Proliant Export|Proliant]]

* [[QuickBooks Export|QuickBooks]]

* [[Rehab Optima Export|Rehab Optima]]

* [[Shlomo Klein Payroll Export|Shlomo Klein Payroll]]

* [[StaffPro Export|StaffPro]]

* [[Viventium Export|Viventium]]

* [[Viventium Accrual Balances Export|Viventium Accrual Balances]]

* [[Viventium API Export|Viventium API Export]]

* [[Viventium Integration Update and Report|Viventium Integration (available on request)]]

<noinclude>== See Also ==

* [[Reports]]</noinclude>

Custom Configuration

2024-06-19T21:50:16Z

Joel: /* Accruals */

{{Advanced}}

The Custom configuration screen allows system configuration settings that would typically apply to the software as a whole to be applied based on criteria. Custom configuration settings use a text based identifier combined with a value that can be a true/false, a string, a number or a date. Each custom configuration settings will use some or all of the following criteria:

* Labor Levels (home or worked based on the setting)
* Pay Rule
* Base Schedule Group
* Holiday Group
* Accrual Group
* Pay Type
* Accrual Pay Type
* Shift (home or worked based on the setting)
* Employed Date Range
* Effective Date Range
* Employee Shift Count
* Employee Shift Type

Each custom configuration settings uses a Custom Configuration ID that uniquely identifies the setting. Each setting will use either the true/false, string, numerical or date value. The following are the current custom configuration settings supported:

==Settings==

===Payroll===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| ADP payroll export group by week number option is used when there is a biweekly payroll and using weighted overtime
| ADPPayrollExportGroupByWeekNumber
| True / False value
| False
|

|-
| David Klein # 1 payroll interface option to group hours by pay date
| DavidKleinPayrollExportGroupByPayDate
| True / False Value
| True
| If true (default) then it will export separate rows for each pay date for each employee. If false (check box unselected) then it will export just a total for the whole pay period.

|-
| David Klein # 1 payroll interface option to group hours by shift
| DavidKleinPayrollExportGroupByShift
| True / False Value
| False
|

|-
| Evolution payroll interface option to place the department in a different column
| EvolutionDepartmentColumn
| String Value
| "C"
| Use any of these to indicate the column: "B", "C", "D", "E", "G", "H". Enter "NONE" to not show the department at all. Only the labor level filters will work with this custom configuration.

|-
| Kronos payroll interface option to put the hours value for a pay type in the amount column
| KronosPayrollExportAsAmount
| True / False Value
| False
| The pay type column should NOT be empty

|-
| Kronos payroll interface option to group hours by shift
| KronosPayrollExportGroupByShift
| True / False Value
| False
| The E Shift column will contain the first letter of the Shift ID

|-
| Kronos payroll interface option to consider pay types that do not add to totals to not be differentials
| KronosPayrollExportIsNotDifferential
| True / False Value
| False
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for custom E/D/T External ID for differential pay types
| KronosExportEDTExternalID
| String Value
| "Differential"
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for custom Pay Statement Type
| KronosExportPayStatementType
| String Value
| "Regular"
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for duplicate entry using a different payroll pay code
| KronosExportDuplicateEntry
| String Value
| No additional line added if not present
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Millennium payroll interface (single company) option to group hours by shift
| MillenniumPayrollSingleCompanyGroupByShift
| True / False Value
| False
| This adds an additional column named Shift

|-
| Millennium payroll interface (single company) always show department
| MillenniumPayrollSingleCompanyAlwaysShowDepartment
| True / False Value
| False
| Department is only placed by default when the worked department does not equal the home department

|-
| Millennium payroll interface (single company) CC1 column labor level level
| MillenniumPayrollSingleCompanyExportCC1LaborLevelLevel
| Integer Value
| Department Level
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC2 column labor level level
| MillenniumPayrollSingleCompanyExportCC2LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC3 column labor level level
| MillenniumPayrollSingleCompanyExportCC3LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC4 column labor level level
| MillenniumPayrollSingleCompanyExportCC4LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC5 column labor level level
| MillenniumPayrollSingleCompanyExportCC5LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Viventium Payroll Export option to group hours by pay date
| ViventiumPayrollExportGroupByPayDate
| True / False Value
| True
| If true (default) then it will export separate rows for each pay date for each employee. If false (check box unselected) then it will export just a total for the whole pay period for each employee. This is a whole software-wide setting and can't use any filters.

|-
| Viventium Payroll Export 1st Additional Labor Level level
| ViventiumPayrollExport1stAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium Payroll Export 2nd Additional Labor Level level
| ViventiumPayrollExport2ndAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium Payroll Export 3rd Additional Labor Level level
| ViventiumPayrollExport3rdAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium payroll export Accrual Balances as Memo
| ViventiumUseMemoForAccrualBalances
| True / False Value
| False
| This will export the accrual balances in the last column which will go on the pay stub as a memo, instead of the accrual balances getting exported as an extra line deduction (D).

|-
| Viventium payroll export hours format
| ViventiumPayrollExportHoursFormat
| String Value
| 0.0000
|

|-
| Viventium payroll export rate format
| ViventiumPayrollExportRateFormat
| String Value
| 0.0000
|
|}

===Scheduling===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Daily Staffing sheet employee sort order
| DailyStaffingSheetEmployeeSortOrder
| String Value
| FullName
| FullName or Seniority are the current 2 options

|-
| Monthly Schedule Area Acceptor determines how schedules match to the areas defined on the monthly schedule
| MonthlyScheduleAreaAcceptor
| String Value
| WorkedShiftWorkedBudgetGroupWorkedFloor
| Format is _____Shift_____BudgetGroup____Floor with options of Any, Home or Worked. E.g. AnyShiftWorkedBudgetGroupWorkedFloor

|-
| Time Restriction Early In Allowance
| TimeRestrictionEarlyInAllowance
| Integer Value
| 7
|

|-
| Time Restriction Late Out Allowance
| TimeRestrictionLateOutAllowance
| Integer Value
| 7
|
|}

===Pay Types===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Specify pay types that will be treated like worked hours for the worked days in week / pay period qualifier on holiday calculation
| ConsideredWorkedForHolidayWorkedDaysQualifier
| True / False value
| False
| On or after holiday is supported

|-
| Override pay type configuration Punches Count Towards Daily Overtime rule
| PunchesCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Period Overtime rule
| PunchesCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Premium rule
| PunchesCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Holiday Overtime rule
| PunchesCountTowardsHolidayOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Accrual rule
| PunchesCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Daily Overtime rule
| OtherHoursWorkedCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Period Overtime rule
| OtherHoursWorkedCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Premium rule
| OtherHoursWorkedCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Holiday Overtime rule
| OtherHoursWorkedCountTowardsHolidayOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Accrual rule
| OtherHoursWorkedCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Daily Overtime rule
| OtherHoursUnworkedCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Period Overtime rule
| OtherHoursUnworkedCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Actual Date Towards Period Overtime rule
| OtherHoursUnworkedCountActualDateTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Premium rule
| OtherHoursUnworkedCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Actual Date Towards Premium rule
| OtherHoursUnworkedCountActualDateTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Accrual rule
| OtherHoursUnworkedCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Accrual rule
| PremiumCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Period Overtime rule
| PremiumCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Premium rule
| PremiumCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Do not allow use of a pay type until the employee has been employed for X number of days
| PayTypeSenorityDays
| Integer value
| 0
| Actual date of other hours must be greater than or equal to hire date plus seniority days. E.g. if employed on January 1 and seniority days is 7 then actual date must be January 8th or later. Effectively we are saying that the 7 days have been completed and so on the 8th you can use this pay type.

|-
| Count all pay types that Add-To-Total, for specific differential ID "CAPTATTFDI"
| CountAllPayTypesAddToTotalForDifferentialIdCAPTATTFDI
| True / False value
| False
| This will override the setting on pay types if they are set to not count for premiums. Fill in the special code "CAPTATTFDI" anywhere in the Premium ID/name, and it will count all pay types that Add-To-Total for this differential. Filters are not in effect for this custom configuration and is in effect for the whole software (use the premium worked labor level filters instead if needed). This custom configuration only works for differentials.

|}

===Time Clocks===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| When using multi facility punching it will set the facility on the punch the same as the time clock's facility.
| OverrideFacilityLaborLevelSameAsTimeClock
| True / False value
| False
| This is a global setting for the entire software and does not use any filters.

|-
| Wdms Time Clock Supervisor Code
| WdmsTimeClockSupervisorCode
| Integer Value
| 2
| The code that will be sent to WDMS for the employees that are marked in TA as a clock supervisor. 2 = Register, 6 = System Administrator, 14 = Super Administrator. Before setting this value make sure that the role exists in the clock. The facility labor level filter can be used to set it for a specific facility in a Multi-Facility software. Minimum TA version required: 4.6.8446.1937

|-
| Time Restriction Early In Allowance
| TimeRestrictionEarlyInAllowance
| Integer Value
| 7
|

|-
| Time Restriction Late Out Allowance
| TimeRestrictionLateOutAllowance
| Integer Value
| 7
|
|}

===Accruals===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Pretend that the employee worked the number of hours in their shift history for accrual proposes.
| AccrueAtShiftCountTimesDailyHoursLevel
| True / False value
| False
| The Employee could have not worked at all, or worked less, or worked more, but will still pretend that the employee actually worked the exact shift history hours (shift count x daily hours). This number of pretend worked hours will then be used to calculate the accruals. Any other accrual calculation settings will apply afterward on top of this number.

|-
| Employee accrues without any limit in the accrual period. This allows a more fine-grained approach than the accrual group provides.
| AccrualNoMaximumContributingMinutes
| True / False value
| False
|

|-
| Employee accrues their full-time shift count if they worked less or even if they didn't actually work at all. This allows a more fine-grained approach than the accrual group provides.
| CalculateFullAccrualEarning
| True / False value
| False
|

|-
| Minimum worked hours in 2 weeks required to get accrual annual entitlements
| AccrualAnnualEntitlementsMinimumWorkedHoursIn2Weeks
| Decimal value
| 0
| Employee has to work this minimum amount of hours in 2 weeks to be eligible to earn any accrual annual entitlements for the current accrual period. For a bi-weekly accrual period, it's the hours worked in the current accrual period. For a weekly accrual period, it's the total hours worked in the current week and the previous week. (Maryland Sick law).

|-
| Minimum worked hours required in current accrual period to get accrual annual entitlements
| AccrualAnnualEntitlementsMinimumWorkedHoursInCurrentAccrualPeriod
| Decimal value
| 0
| Employee has to work this minimum amount of hours in the in current accrual period to be eligible to earn any accrual annual entitlements for the current accrual period.

|-
| Add custom date field to use for Employee Accruals Seniority. This date field will override default accruals configuration if filled out.
| UseEmployeeDate3ForAccrualStartDate
| True / False value
| False
| You can use either the Date 3 field or Date 4 field (if you use the Date 4 field you need to change the custom configuration to UseEmployeeDate4ForAccrualStartDate). To change the text displayed next to the date field you would go to Configuration-->Setup-->System-->Employment.

|-
| Override Use Hire Date For Seniority.
| UseHireDateForSeniority
| True / False value
| False
| This can be used to set it for each facility in a Multi-facility software.

|-
| Override Accrual Period Group Full Time Shift Count.
| AccrualPeriodGroupFullTimeShiftCount
| Decimal value
| Full Time Shift Count on the Accrual Period Group
| This can be used to override the Full Time Shift Count for a specific date range when switching accrual periods from weekly to biweekly or vise versa. Use the current Full Time Shift Count in the accrual period group and override for the past with the custom config using the effective to date. Filter for a specific accrual group.

|}

===Other===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Override the pay type that the schedule displays and uses for the initial calculation of hours
| BaseSchedulePayTypeID
| String Value - enter the pay type ID
| Ignored
| This is an intercept and does not change the underlying value. When using the scheduler and a schedule is given to an employee without this override in place, the original pay type will be used.

|-
| Do not deduct lunch when the lunch question at the time clock was answered "Not Taken"
| DoNotDeductLunchWhenLunchQuestionAnsweredNotTaken
| True / False Value
| False
|

|-
| Do not deduct lunch when the lunch question at the time clock was not answered i.e. "Unknown"
| DoNotDeductLunchWhenLunchQuestionNotAnswered
| True / False Value
| False
|

|-
| In a multi-facility configuration, if employees have worked hours in another facility then this will put those hours into the PBJ file of the worked facility.
| EmployeesHavePBJHoursInMultipleFacilities
| True / False Value
| False
| The PBJ file has to be created for all facilities that any employee in a selected facility has worked in. E.g., if you are running PBJ for facility A and facility A employees worked in facility B then you must create the file for facility B at the same time. If employees in facility B worked in facility C then facility C must be included. Also, if there are employees not in facility A, B or C that have hours in A, B or C then you must also include those facilities.

|-
| Maximum hours that will calculate from a "Time" differential premium used on the worked holiday tab of holiday configuration
| WorkedHolidayDifferentialMaximumMinutes
| IntegerValue
| 9999
| This is the number of minutes so multiple an hour maximum by 60. This only works with Time Premiums or Time & Shift Premiums.

|-
| Phantom punches are temporary punches added between shifts so as to calculate double shifts correctly. This setting will calculate the time cards in a similar manner as if Out/In punches were added manually.
| CalculatePhantomPunchesLikeActualPunches
| True / False value
| False
| This does not split shifts to different pay dates as pay date determination is done prior to the adding of phantom punches.

|-
| Department Of Labor Weighted Overtime Pay Rate Calculations for specific labor levels only
| DepartmentOfLaborPayRateCalculations
| True / False value
| False
|

|-
| HHSOIG report requires birth dates to match (both must exist)
| HHSOIGBirthDateMatch
| True / False value
| False
|

|-
| SAM report requires zip codes to match (both must exist)
| SAMZipCodeMatch
| True / False value
| False
|

|-
| 6th pay date overtime level minimum minutes.
| SixthPayDateOvertimeLevelMinimumMinutes
| Integer value
| 0
| The Fixed Hour Level in overtime configuration is the maximum overtime level.

|-
| Disregards any Is Hire Date on employee status and the global rule about first / last active status as hire date such that the latest active status is ALWAYS the hire date.
| LatestActiveStatusAlwaysConsideredHireDate
| True / False value
| False
|

|-
| If shift count times daily hours is less than this number than employee shift type is changed to PD when adding employee shifts
| PartTimeShiftTypeMinimumShiftCountTimesDailyHours
| Decimal value
| -1 (ignored)
|

|-
| If shift count times daily hours is greater than this number than employee shift type is changed to FT when adding employee shifts
| PartTimeShiftTypeMaximumShiftCountTimesDailyHours
| Decimal value
| -1 (ignored)
| E.g. if 30 hours is considered full time then enter 29.99

|-
| Enable Software to export data to Keeper FTP Site
| KeeperExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software and does not need a separate entry for each facility in a Multi-Facility software. The software will also potentially require an update if it hasn't been updated since 2/20/2024.

|-
| Enable Software to export data to TapCheck FTP Site
| TapcheckExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software and does not need a separate entry for each facility in a Multi-Facility software. The software will also potentially require an update if it hasn't been updated since 12/21/2021.

|}

Accrual Groups Configuration

2024-06-19T19:25:46Z

Joel:

{{Advanced}}

The accrual group serves as the connection between an employee and a set of accrual entitlements, for both date-based and annual accruals.

[[File:AccrualGroups.png]]

''Threshold Hours'' - Accrual Group will only allow earnings if both, the employee worked at a minimum this amount of hours in the period, and their work pattern is at a minimum this amount.

''Use Employee Shift Count as Full Time Shift Count'' - this allows part-time employees to earn at a higher rate than full-time employees so they both end up with the same amount of accrued days for the year. (Only used if earning days instead of fractions).

''Accrue Up To Full-Time Shift Count Level'' - this will allow the employee to accrue more than their personal shift count if they worked more hours. As an example, if their personal shift count is 30 hours a week but they worked one week 40 hours, they will accrue on 40 hours. (It removes the cap that is normally set at personal shift count X daily hours). The Full-Time Shift Count Level is set on each ''Accrual Period Group''.

''Accrue On All Hours'' - this will allow the employee to accrue more than the full-time shift count if they worked more hours. As an example, if the full-time shift count is 40 hours a week but they worked one week 50 hours, they will accrue on 50 hours. (It removes the cap that is normally set at full-time shift count X daily hours). This will still only accrue on pay types that count towards accruals. If a pay type like OT needs to count for sick law for a specific accrual group (PD) then also use a custom config to have OT count for accruals for that specific accrual group.

''Calculate Full Accrual Earning'' - this will allow the employee to accrue their full-time shift count if they worked less or even if they didn't actually work at all. This is similar to a date-based entitlement in that it gives a flat amount that does not depend on actual worked hours. It's given each period and is calculated as if the employee actually worked the whole shift count X daily hours.

== See also ==

* [[Configuration]]

Schedule Based Restrictions

2024-05-20T20:43:00Z

Joel:

When Schedule Based Restrictions are turned on, employee schedules are downloaded to the HandPunch to restrict the times that an employee can punch. This can reduce unauthorized overtime as well as early “in” and late “out” punches. An employee’s individual schedule is used to restrict access. A separate schedule is defined for each employee providing the ultimate in flexibility. The software synchronizes with the HandPunch approximately every 5-10 minutes, to provide the HandPunch with the most accurate and live scheduling updates.

By default, the HandPunch will not accept “in” punches earlier than 7 minutes to the start of the schedule and “out” punches after 7 minutes to the end of the schedule. If an employee attempts to punch in earlier than 7 minutes, or late out after 7 minutes, they will get an error at the HandPunch which will read, '''“TIME RESTRICTION”'''.

If a schedule is set to Open-Start or Open-End then the clock will allow an extra 4 hours at the start/end.

Clock Supervisors cannot be restricted at the clock and are able to punch at any time.

For a fingerprint clock, you will get one of the following three options when trying to punch:

*When an employee goes to a clock and punches in successfully, the screen of the clock will have a green box on it that says Punch Verified and it will have your name, Clock ID, and time that you punched. The clock will also have a voice say "Verified. Thank You"

*When an employee is trying to punch and is restricted, the clock will display an Orange box which will say "Can't clock you in yet" and will also say "You are not authorized to punch at this time". The clock will also have a voice that will say "Previously Verified". This means you are attempting to punch out of your zone and are being restricted.

*If you attempt to punch and you do not have a schedule within 8 hours of when you are trying to punch the clock will display an Orange box which will say "Can't clock you in yet" and will also say "You do not have a schedule for today". The clock will also have a voice that will say "Previously Verified"

If the employee was supposed to be at the facility but their schedule has not been updated yet in the scheduler (i.e. on a weekend), the employee should notify a higher authority, or someone with time card access, of the exact time of their arrival or departure. This person can then add the restricted punch manually on their time card.

To avoid the above scenario, staffing coordinators should make schedule changes in the scheduler as soon as they are aware a change, to minimize time zone restrictions at the clock. Once the employee punches and gets restricted at the clock, their punch will need to be added manually.

Even after an employee’s punch has been restricted, it is a good practice to have the staffing coordinator update the employee’s schedule in the scheduler for accuracy’s sake.

A report can be run to see all punches that have been rejected due to the time zone restriction. This report displays verified punches made at the time clock that were outside of an allowable punching time zone. See image below:

[[File:Ruth.png]]

[[File:TZR.png]]

[[File:Report.png]]

Custom Configuration

2024-02-19T22:57:33Z

Joel: /* Other */

{{Advanced}}

The Custom configuration screen allows system configuration settings that would typically apply to the software as a whole to be applied based on criteria. Custom configuration settings use a text based identifier combined with a value that can be a true/false, a string, a number or a date. Each custom configuration settings will use some or all of the following criteria:

* Labor Levels (home or worked based on the setting)
* Pay Rule
* Base Schedule Group
* Holiday Group
* Accrual Group
* Pay Type
* Accrual Pay Type
* Shift (home or worked based on the setting)
* Employed Date Range
* Effective Date Range
* Employee Shift Count
* Employee Shift Type

Each custom configuration settings uses a Custom Configuration ID that uniquely identifies the setting. Each setting will use either the true/false, string, numerical or date value. The following are the current custom configuration settings supported:

==Settings==

===Payroll===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| ADP payroll export group by week number option is used when there is a biweekly payroll and using weighted overtime
| ADPPayrollExportGroupByWeekNumber
| True / False value
| False
|

|-
| David Klein # 1 payroll interface option to group hours by pay date
| DavidKleinPayrollExportGroupByPayDate
| True / False Value
| True
| If true (default) then it will export separate rows for each pay date for each employee. If false (check box unselected) then it will export just a total for the whole pay period.

|-
| David Klein # 1 payroll interface option to group hours by shift
| DavidKleinPayrollExportGroupByShift
| True / False Value
| False
|

|-
| Evolution payroll interface option to place the department in a different column
| EvolutionDepartmentColumn
| String Value
| "C"
| Use any of these to indicate the column: "B", "C", "D", "E", "G", "H". Enter "NONE" to not show the department at all. Only the labor level filters will work with this custom configuration.

|-
| Kronos payroll interface option to put the hours value for a pay type in the amount column
| KronosPayrollExportAsAmount
| True / False Value
| False
| The pay type column should NOT be empty

|-
| Kronos payroll interface option to group hours by shift
| KronosPayrollExportGroupByShift
| True / False Value
| False
| The E Shift column will contain the first letter of the Shift ID

|-
| Kronos payroll interface option to consider pay types that do not add to totals to not be differentials
| KronosPayrollExportIsNotDifferential
| True / False Value
| False
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for custom E/D/T External ID for differential pay types
| KronosExportEDTExternalID
| String Value
| "Differential"
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for custom Pay Statement Type
| KronosExportPayStatementType
| String Value
| "Regular"
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for duplicate entry using a different payroll pay code
| KronosExportDuplicateEntry
| String Value
| No additional line added if not present
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Millennium payroll interface (single company) option to group hours by shift
| MillenniumPayrollSingleCompanyGroupByShift
| True / False Value
| False
| This adds an additional column named Shift

|-
| Millennium payroll interface (single company) always show department
| MillenniumPayrollSingleCompanyAlwaysShowDepartment
| True / False Value
| False
| Department is only placed by default when the worked department does not equal the home department

|-
| Millennium payroll interface (single company) CC1 column labor level level
| MillenniumPayrollSingleCompanyExportCC1LaborLevelLevel
| Integer Value
| Department Level
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC2 column labor level level
| MillenniumPayrollSingleCompanyExportCC2LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC3 column labor level level
| MillenniumPayrollSingleCompanyExportCC3LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC4 column labor level level
| MillenniumPayrollSingleCompanyExportCC4LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC5 column labor level level
| MillenniumPayrollSingleCompanyExportCC5LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Viventium Payroll Export option to group hours by pay date
| ViventiumPayrollExportGroupByPayDate
| True / False Value
| True
| If true (default) then it will export separate rows for each pay date for each employee. If false (check box unselected) then it will export just a total for the whole pay period for each employee. This is a whole software-wide setting and can't use any filters.

|-
| Viventium Payroll Export 1st Additional Labor Level level
| ViventiumPayrollExport1stAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium Payroll Export 2nd Additional Labor Level level
| ViventiumPayrollExport2ndAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium Payroll Export 3rd Additional Labor Level level
| ViventiumPayrollExport3rdAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium payroll export Accrual Balances as Memo
| ViventiumUseMemoForAccrualBalances
| True / False Value
| False
| This will export the accrual balances in the last column which will go on the pay stub as a memo, instead of the accrual balances getting exported as an extra line deduction (D).

|-
| Viventium payroll export hours format
| ViventiumPayrollExportHoursFormat
| String Value
| 0.0000
|

|-
| Viventium payroll export rate format
| ViventiumPayrollExportRateFormat
| String Value
| 0.0000
|
|}

===Scheduling===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Daily Staffing sheet employee sort order
| DailyStaffingSheetEmployeeSortOrder
| String Value
| FullName
| FullName or Seniority are the current 2 options

|-
| Monthly Schedule Area Acceptor determines how schedules match to the areas defined on the monthly schedule
| MonthlyScheduleAreaAcceptor
| String Value
| WorkedShiftWorkedBudgetGroupWorkedFloor
| Format is _____Shift_____BudgetGroup____Floor with options of Any, Home or Worked. E.g. AnyShiftWorkedBudgetGroupWorkedFloor

|-
| Time Restriction Early In Allowance
| TimeRestrictionEarlyInAllowance
| Integer Value
| 7
|

|-
| Time Restriction Late Out Allowance
| TimeRestrictionLateOutAllowance
| Integer Value
| 7
|
|}

===Pay Types===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Specify pay types that will be treated like worked hours for the worked days in week / pay period qualifier on holiday calculation
| ConsideredWorkedForHolidayWorkedDaysQualifier
| True / False value
| False
| On or after holiday is supported

|-
| Override pay type configuration Punches Count Towards Daily Overtime rule
| PunchesCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Period Overtime rule
| PunchesCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Premium rule
| PunchesCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Holiday Overtime rule
| PunchesCountTowardsHolidayOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Accrual rule
| PunchesCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Daily Overtime rule
| OtherHoursWorkedCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Period Overtime rule
| OtherHoursWorkedCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Premium rule
| OtherHoursWorkedCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Holiday Overtime rule
| OtherHoursWorkedCountTowardsHolidayOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Accrual rule
| OtherHoursWorkedCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Daily Overtime rule
| OtherHoursUnworkedCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Period Overtime rule
| OtherHoursUnworkedCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Actual Date Towards Period Overtime rule
| OtherHoursUnworkedCountActualDateTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Premium rule
| OtherHoursUnworkedCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Actual Date Towards Premium rule
| OtherHoursUnworkedCountActualDateTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Accrual rule
| OtherHoursUnworkedCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Accrual rule
| PremiumCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Period Overtime rule
| PremiumCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Premium rule
| PremiumCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Do not allow use of a pay type until the employee has been employed for X number of days
| PayTypeSenorityDays
| Integer value
| 0
| Actual date of other hours must be greater than or equal to hire date plus seniority days. E.g. if employed on January 1 and seniority days is 7 then actual date must be January 8th or later. Effectively we are saying that the 7 days have been completed and so on the 8th you can use this pay type.

|-
| Count all pay types that Add-To-Total, for specific differential ID "CAPTATTFDI"
| CountAllPayTypesAddToTotalForDifferentialIdCAPTATTFDI
| True / False value
| False
| This will override the setting on pay types if they are set to not count for premiums. Fill in the special code "CAPTATTFDI" anywhere in the Premium ID/name, and it will count all pay types that Add-To-Total for this differential. Filters are not in effect for this custom configuration and is in effect for the whole software (use the premium worked labor level filters instead if needed). This custom configuration only works for differentials.

|}

===Time Clocks===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| When using multi facility punching it will set the facility on the punch the same as the time clock's facility.
| OverrideFacilityLaborLevelSameAsTimeClock
| True / False value
| False
| This is a global setting for the entire software and does not use any filters.

|-
| Wdms Time Clock Supervisor Code
| WdmsTimeClockSupervisorCode
| Integer Value
| 2
| The code that will be sent to WDMS for the employees that are marked in TA as a clock supervisor. 2 = Register, 6 = System Administrator, 14 = Super Administrator. Before setting this value make sure that the role exists in the clock. The facility labor level filter can be used to set it for a specific facility in a Multi-Facility software. Minimum TA version required: 4.6.8446.1937

|-
| Time Restriction Early In Allowance
| TimeRestrictionEarlyInAllowance
| Integer Value
| 7
|

|-
| Time Restriction Late Out Allowance
| TimeRestrictionLateOutAllowance
| Integer Value
| 7
|
|}

===Accruals===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Employee accrues as if worked the number of hours in their shift history
| AccrueAtShiftCountTimesDailyHoursLevel
| True / False value
| False
|

|-
| Employee accrues without any limit in the accrual period. This allows a more fine-grained approach than the accrual group provides.
| AccrualNoMaximumContributingMinutes
| True / False value
| False
|

|-
| Employee accrues their full-time shift count if they worked less or even if they didn't actually work at all. This allows a more fine-grained approach than the accrual group provides.
| CalculateFullAccrualEarning
| True / False value
| False
|

|-
| Minimum worked hours in 2 weeks required to get accrual annual entitlements
| AccrualAnnualEntitlementsMinimumWorkedHoursIn2Weeks
| Decimal value
| 0
| Employee has to work this minimum amount of hours in 2 weeks to be eligible to earn any accrual annual entitlements for the current accrual period. For a bi-weekly accrual period, it's the hours worked in the current accrual period. For a weekly accrual period, it's the total hours worked in the current week and the previous week. (Maryland Sick law).

|-
| Minimum worked hours required in current accrual period to get accrual annual entitlements
| AccrualAnnualEntitlementsMinimumWorkedHoursInCurrentAccrualPeriod
| Decimal value
| 0
| Employee has to work this minimum amount of hours in the in current accrual period to be eligible to earn any accrual annual entitlements for the current accrual period.

|-
| Add custom date field to use for Employee Accruals Seniority. This date field will override default accruals configuration if filled out.
| UseEmployeeDate3ForAccrualStartDate
| True / False value
| False
| You can use either the Date 3 field or Date 4 field (if you use the Date 4 field you need to change the custom configuration to UseEmployeeDate4ForAccrualStartDate). To change the text displayed next to the date field you would go to Configuration-->Setup-->System-->Employment.

|-
| Override Use Hire Date For Seniority.
| UseHireDateForSeniority
| True / False value
| False
| This can be used to set it for each facility in a Multi-facility software.

|-
| Override Accrual Period Group Full Time Shift Count.
| AccrualPeriodGroupFullTimeShiftCount
| Decimal value
| Full Time Shift Count on the Accrual Period Group
| This can be used to override the Full Time Shift Count for a specific date range when switching accrual periods from weekly to biweekly or vise versa. Use the current Full Time Shift Count in the accrual period group and override for the past with the custom config using the effective to date. Filter for a specific accrual group.

|}

===Other===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Override the pay type that the schedule displays and uses for the initial calculation of hours
| BaseSchedulePayTypeID
| String Value - enter the pay type ID
| Ignored
| This is an intercept and does not change the underlying value. When using the scheduler and a schedule is given to an employee without this override in place, the original pay type will be used.

|-
| Do not deduct lunch when the lunch question at the time clock was answered "Not Taken"
| DoNotDeductLunchWhenLunchQuestionAnsweredNotTaken
| True / False Value
| False
|

|-
| Do not deduct lunch when the lunch question at the time clock was not answered i.e. "Unknown"
| DoNotDeductLunchWhenLunchQuestionNotAnswered
| True / False Value
| False
|

|-
| In a multi-facility configuration, if employees have worked hours in another facility then this will put those hours into the PBJ file of the worked facility.
| EmployeesHavePBJHoursInMultipleFacilities
| True / False Value
| False
| The PBJ file has to be created for all facilities that any employee in a selected facility has worked in. E.g., if you are running PBJ for facility A and facility A employees worked in facility B then you must create the file for facility B at the same time. If employees in facility B worked in facility C then facility C must be included. Also, if there are employees not in facility A, B or C that have hours in A, B or C then you must also include those facilities.

|-
| Maximum hours that will calculate from a "Time" differential premium used on the worked holiday tab of holiday configuration
| WorkedHolidayDifferentialMaximumMinutes
| IntegerValue
| 9999
| This is the number of minutes so multiple an hour maximum by 60. This only works with Time Premiums or Time & Shift Premiums.

|-
| Phantom punches are temporary punches added between shifts so as to calculate double shifts correctly. This setting will calculate the time cards in a similar manner as if Out/In punches were added manually.
| CalculatePhantomPunchesLikeActualPunches
| True / False value
| False
| This does not split shifts to different pay dates as pay date determination is done prior to the adding of phantom punches.

|-
| Department Of Labor Weighted Overtime Pay Rate Calculations for specific labor levels only
| DepartmentOfLaborPayRateCalculations
| True / False value
| False
|

|-
| HHSOIG report requires birth dates to match (both must exist)
| HHSOIGBirthDateMatch
| True / False value
| False
|

|-
| SAM report requires zip codes to match (both must exist)
| SAMZipCodeMatch
| True / False value
| False
|

|-
| 6th pay date overtime level minimum minutes.
| SixthPayDateOvertimeLevelMinimumMinutes
| Integer value
| 0
| The Fixed Hour Level in overtime configuration is the maximum overtime level.

|-
| Disregards any Is Hire Date on employee status and the global rule about first / last active status as hire date such that the latest active status is ALWAYS the hire date.
| LatestActiveStatusAlwaysConsideredHireDate
| True / False value
| False
|

|-
| If shift count times daily hours is less than this number than employee shift type is changed to PD when adding employee shifts
| PartTimeShiftTypeMinimumShiftCountTimesDailyHours
| Decimal value
| -1 (ignored)
|

|-
| If shift count times daily hours is greater than this number than employee shift type is changed to FT when adding employee shifts
| PartTimeShiftTypeMaximumShiftCountTimesDailyHours
| Decimal value
| -1 (ignored)
| E.g. if 30 hours is considered full time then enter 29.99

|-
| Enable Software to export data to Keeper FTP Site
| KeeperExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software and does not need a separate entry for each facility in a Multi-Facility software. The software will also potentially require an update if it hasn't been updated since 2/20/2024.

|-
| Enable Software to export data to TapCheck FTP Site
| TapcheckExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software and does not need a separate entry for each facility in a Multi-Facility software. The software will also potentially require an update if it hasn't been updated since 12/21/2021.

|}

Custom Configuration

2024-02-19T22:57:06Z

Joel: /* Other */

{{Advanced}}

The Custom configuration screen allows system configuration settings that would typically apply to the software as a whole to be applied based on criteria. Custom configuration settings use a text based identifier combined with a value that can be a true/false, a string, a number or a date. Each custom configuration settings will use some or all of the following criteria:

* Labor Levels (home or worked based on the setting)
* Pay Rule
* Base Schedule Group
* Holiday Group
* Accrual Group
* Pay Type
* Accrual Pay Type
* Shift (home or worked based on the setting)
* Employed Date Range
* Effective Date Range
* Employee Shift Count
* Employee Shift Type

Each custom configuration settings uses a Custom Configuration ID that uniquely identifies the setting. Each setting will use either the true/false, string, numerical or date value. The following are the current custom configuration settings supported:

==Settings==

===Payroll===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| ADP payroll export group by week number option is used when there is a biweekly payroll and using weighted overtime
| ADPPayrollExportGroupByWeekNumber
| True / False value
| False
|

|-
| David Klein # 1 payroll interface option to group hours by pay date
| DavidKleinPayrollExportGroupByPayDate
| True / False Value
| True
| If true (default) then it will export separate rows for each pay date for each employee. If false (check box unselected) then it will export just a total for the whole pay period.

|-
| David Klein # 1 payroll interface option to group hours by shift
| DavidKleinPayrollExportGroupByShift
| True / False Value
| False
|

|-
| Evolution payroll interface option to place the department in a different column
| EvolutionDepartmentColumn
| String Value
| "C"
| Use any of these to indicate the column: "B", "C", "D", "E", "G", "H". Enter "NONE" to not show the department at all. Only the labor level filters will work with this custom configuration.

|-
| Kronos payroll interface option to put the hours value for a pay type in the amount column
| KronosPayrollExportAsAmount
| True / False Value
| False
| The pay type column should NOT be empty

|-
| Kronos payroll interface option to group hours by shift
| KronosPayrollExportGroupByShift
| True / False Value
| False
| The E Shift column will contain the first letter of the Shift ID

|-
| Kronos payroll interface option to consider pay types that do not add to totals to not be differentials
| KronosPayrollExportIsNotDifferential
| True / False Value
| False
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for custom E/D/T External ID for differential pay types
| KronosExportEDTExternalID
| String Value
| "Differential"
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for custom Pay Statement Type
| KronosExportPayStatementType
| String Value
| "Regular"
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Kronos payroll interface option for duplicate entry using a different payroll pay code
| KronosExportDuplicateEntry
| String Value
| No additional line added if not present
| Pay Type(s) most likely needed unless applies to all pay types

|-
| Millennium payroll interface (single company) option to group hours by shift
| MillenniumPayrollSingleCompanyGroupByShift
| True / False Value
| False
| This adds an additional column named Shift

|-
| Millennium payroll interface (single company) always show department
| MillenniumPayrollSingleCompanyAlwaysShowDepartment
| True / False Value
| False
| Department is only placed by default when the worked department does not equal the home department

|-
| Millennium payroll interface (single company) CC1 column labor level level
| MillenniumPayrollSingleCompanyExportCC1LaborLevelLevel
| Integer Value
| Department Level
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC2 column labor level level
| MillenniumPayrollSingleCompanyExportCC2LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC3 column labor level level
| MillenniumPayrollSingleCompanyExportCC3LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC4 column labor level level
| MillenniumPayrollSingleCompanyExportCC4LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Millennium payroll interface (single company) CC5 column labor level level
| MillenniumPayrollSingleCompanyExportCC5LaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9

|-
| Viventium Payroll Export option to group hours by pay date
| ViventiumPayrollExportGroupByPayDate
| True / False Value
| True
| If true (default) then it will export separate rows for each pay date for each employee. If false (check box unselected) then it will export just a total for the whole pay period for each employee. This is a whole software-wide setting and can't use any filters.

|-
| Viventium Payroll Export 1st Additional Labor Level level
| ViventiumPayrollExport1stAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium Payroll Export 2nd Additional Labor Level level
| ViventiumPayrollExport2ndAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium Payroll Export 3rd Additional Labor Level level
| ViventiumPayrollExport3rdAdditionalLaborLevelLevel
| Integer Value
| -1
| Valid values are from 0 to 9. This will export the specified labor level as the last column in addition to the department labor level.

|-
| Viventium payroll export Accrual Balances as Memo
| ViventiumUseMemoForAccrualBalances
| True / False Value
| False
| This will export the accrual balances in the last column which will go on the pay stub as a memo, instead of the accrual balances getting exported as an extra line deduction (D).

|-
| Viventium payroll export hours format
| ViventiumPayrollExportHoursFormat
| String Value
| 0.0000
|

|-
| Viventium payroll export rate format
| ViventiumPayrollExportRateFormat
| String Value
| 0.0000
|
|}

===Scheduling===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Daily Staffing sheet employee sort order
| DailyStaffingSheetEmployeeSortOrder
| String Value
| FullName
| FullName or Seniority are the current 2 options

|-
| Monthly Schedule Area Acceptor determines how schedules match to the areas defined on the monthly schedule
| MonthlyScheduleAreaAcceptor
| String Value
| WorkedShiftWorkedBudgetGroupWorkedFloor
| Format is _____Shift_____BudgetGroup____Floor with options of Any, Home or Worked. E.g. AnyShiftWorkedBudgetGroupWorkedFloor

|-
| Time Restriction Early In Allowance
| TimeRestrictionEarlyInAllowance
| Integer Value
| 7
|

|-
| Time Restriction Late Out Allowance
| TimeRestrictionLateOutAllowance
| Integer Value
| 7
|
|}

===Pay Types===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Specify pay types that will be treated like worked hours for the worked days in week / pay period qualifier on holiday calculation
| ConsideredWorkedForHolidayWorkedDaysQualifier
| True / False value
| False
| On or after holiday is supported

|-
| Override pay type configuration Punches Count Towards Daily Overtime rule
| PunchesCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Period Overtime rule
| PunchesCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Premium rule
| PunchesCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Holiday Overtime rule
| PunchesCountTowardsHolidayOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Punches Count Towards Accrual rule
| PunchesCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Daily Overtime rule
| OtherHoursWorkedCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Period Overtime rule
| OtherHoursWorkedCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Premium rule
| OtherHoursWorkedCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Holiday Overtime rule
| OtherHoursWorkedCountTowardsHolidayOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Worked Count Towards Accrual rule
| OtherHoursWorkedCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Daily Overtime rule
| OtherHoursUnworkedCountTowardsDailyOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Period Overtime rule
| OtherHoursUnworkedCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Actual Date Towards Period Overtime rule
| OtherHoursUnworkedCountActualDateTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Premium rule
| OtherHoursUnworkedCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Actual Date Towards Premium rule
| OtherHoursUnworkedCountActualDateTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Other Hours Unworked Count Towards Accrual rule
| OtherHoursUnworkedCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Accrual rule
| PremiumCountTowardsAccrual
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Period Overtime rule
| PremiumCountTowardsPeriodOvertime
| True / False value
| Pay type configuration
|

|-
| Override pay type configuration Premium Count Towards Premium rule
| PremiumCountTowardsPremium
| True / False value
| Pay type configuration
|

|-
| Do not allow use of a pay type until the employee has been employed for X number of days
| PayTypeSenorityDays
| Integer value
| 0
| Actual date of other hours must be greater than or equal to hire date plus seniority days. E.g. if employed on January 1 and seniority days is 7 then actual date must be January 8th or later. Effectively we are saying that the 7 days have been completed and so on the 8th you can use this pay type.

|-
| Count all pay types that Add-To-Total, for specific differential ID "CAPTATTFDI"
| CountAllPayTypesAddToTotalForDifferentialIdCAPTATTFDI
| True / False value
| False
| This will override the setting on pay types if they are set to not count for premiums. Fill in the special code "CAPTATTFDI" anywhere in the Premium ID/name, and it will count all pay types that Add-To-Total for this differential. Filters are not in effect for this custom configuration and is in effect for the whole software (use the premium worked labor level filters instead if needed). This custom configuration only works for differentials.

|}

===Time Clocks===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| When using multi facility punching it will set the facility on the punch the same as the time clock's facility.
| OverrideFacilityLaborLevelSameAsTimeClock
| True / False value
| False
| This is a global setting for the entire software and does not use any filters.

|-
| Wdms Time Clock Supervisor Code
| WdmsTimeClockSupervisorCode
| Integer Value
| 2
| The code that will be sent to WDMS for the employees that are marked in TA as a clock supervisor. 2 = Register, 6 = System Administrator, 14 = Super Administrator. Before setting this value make sure that the role exists in the clock. The facility labor level filter can be used to set it for a specific facility in a Multi-Facility software. Minimum TA version required: 4.6.8446.1937

|-
| Time Restriction Early In Allowance
| TimeRestrictionEarlyInAllowance
| Integer Value
| 7
|

|-
| Time Restriction Late Out Allowance
| TimeRestrictionLateOutAllowance
| Integer Value
| 7
|
|}

===Accruals===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Employee accrues as if worked the number of hours in their shift history
| AccrueAtShiftCountTimesDailyHoursLevel
| True / False value
| False
|

|-
| Employee accrues without any limit in the accrual period. This allows a more fine-grained approach than the accrual group provides.
| AccrualNoMaximumContributingMinutes
| True / False value
| False
|

|-
| Employee accrues their full-time shift count if they worked less or even if they didn't actually work at all. This allows a more fine-grained approach than the accrual group provides.
| CalculateFullAccrualEarning
| True / False value
| False
|

|-
| Minimum worked hours in 2 weeks required to get accrual annual entitlements
| AccrualAnnualEntitlementsMinimumWorkedHoursIn2Weeks
| Decimal value
| 0
| Employee has to work this minimum amount of hours in 2 weeks to be eligible to earn any accrual annual entitlements for the current accrual period. For a bi-weekly accrual period, it's the hours worked in the current accrual period. For a weekly accrual period, it's the total hours worked in the current week and the previous week. (Maryland Sick law).

|-
| Minimum worked hours required in current accrual period to get accrual annual entitlements
| AccrualAnnualEntitlementsMinimumWorkedHoursInCurrentAccrualPeriod
| Decimal value
| 0
| Employee has to work this minimum amount of hours in the in current accrual period to be eligible to earn any accrual annual entitlements for the current accrual period.

|-
| Add custom date field to use for Employee Accruals Seniority. This date field will override default accruals configuration if filled out.
| UseEmployeeDate3ForAccrualStartDate
| True / False value
| False
| You can use either the Date 3 field or Date 4 field (if you use the Date 4 field you need to change the custom configuration to UseEmployeeDate4ForAccrualStartDate). To change the text displayed next to the date field you would go to Configuration-->Setup-->System-->Employment.

|-
| Override Use Hire Date For Seniority.
| UseHireDateForSeniority
| True / False value
| False
| This can be used to set it for each facility in a Multi-facility software.

|-
| Override Accrual Period Group Full Time Shift Count.
| AccrualPeriodGroupFullTimeShiftCount
| Decimal value
| Full Time Shift Count on the Accrual Period Group
| This can be used to override the Full Time Shift Count for a specific date range when switching accrual periods from weekly to biweekly or vise versa. Use the current Full Time Shift Count in the accrual period group and override for the past with the custom config using the effective to date. Filter for a specific accrual group.

|}

===Other===

{| class="wikitable"
|-
! Custom Configuration Setting
! Custom Configuration ID
! Value Used
! Default Value
! Notes

|-
| Override the pay type that the schedule displays and uses for the initial calculation of hours
| BaseSchedulePayTypeID
| String Value - enter the pay type ID
| Ignored
| This is an intercept and does not change the underlying value. When using the scheduler and a schedule is given to an employee without this override in place, the original pay type will be used.

|-
| Do not deduct lunch when the lunch question at the time clock was answered "Not Taken"
| DoNotDeductLunchWhenLunchQuestionAnsweredNotTaken
| True / False Value
| False
|

|-
| Do not deduct lunch when the lunch question at the time clock was not answered i.e. "Unknown"
| DoNotDeductLunchWhenLunchQuestionNotAnswered
| True / False Value
| False
|

|-
| In a multi-facility configuration, if employees have worked hours in another facility then this will put those hours into the PBJ file of the worked facility.
| EmployeesHavePBJHoursInMultipleFacilities
| True / False Value
| False
| The PBJ file has to be created for all facilities that any employee in a selected facility has worked in. E.g., if you are running PBJ for facility A and facility A employees worked in facility B then you must create the file for facility B at the same time. If employees in facility B worked in facility C then facility C must be included. Also, if there are employees not in facility A, B or C that have hours in A, B or C then you must also include those facilities.

|-
| Maximum hours that will calculate from a "Time" differential premium used on the worked holiday tab of holiday configuration
| WorkedHolidayDifferentialMaximumMinutes
| IntegerValue
| 9999
| This is the number of minutes so multiple an hour maximum by 60. This only works with Time Premiums or Time & Shift Premiums.

|-
| Phantom punches are temporary punches added between shifts so as to calculate double shifts correctly. This setting will calculate the time cards in a similar manner as if Out/In punches were added manually.
| CalculatePhantomPunchesLikeActualPunches
| True / False value
| False
| This does not split shifts to different pay dates as pay date determination is done prior to the adding of phantom punches.

|-
| Department Of Labor Weighted Overtime Pay Rate Calculations for specific labor levels only
| DepartmentOfLaborPayRateCalculations
| True / False value
| False
|

|-
| HHSOIG report requires birth dates to match (both must exist)
| HHSOIGBirthDateMatch
| True / False value
| False
|

|-
| SAM report requires zip codes to match (both must exist)
| SAMZipCodeMatch
| True / False value
| False
|

|-
| 6th pay date overtime level minimum minutes.
| SixthPayDateOvertimeLevelMinimumMinutes
| Integer value
| 0
| The Fixed Hour Level in overtime configuration is the maximum overtime level.

|-
| Disregards any Is Hire Date on employee status and the global rule about first / last active status as hire date such that the latest active status is ALWAYS the hire date.
| LatestActiveStatusAlwaysConsideredHireDate
| True / False value
| False
|

|-
| If shift count times daily hours is less than this number than employee shift type is changed to PD when adding employee shifts
| PartTimeShiftTypeMinimumShiftCountTimesDailyHours
| Decimal value
| -1 (ignored)
|

|-
| If shift count times daily hours is greater than this number than employee shift type is changed to FT when adding employee shifts
| PartTimeShiftTypeMaximumShiftCountTimesDailyHours
| Decimal value
| -1 (ignored)
| E.g. if 30 hours is considered full time then enter 29.99

|-
| Enable Software to export data to Keeper FTP Site
| KeeperExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software and does not need a separate entry for each facility in a Multi-Facility software. The software will also potentially require an update if it hasn't been updated since 2/20/2024.

|-
| Enable Software to export data to TapCheck FTP Site
| TapcheckExportUploadToSFTP
| True / False value
| False
| This is a global setting for the entire software and does not need a separate entry for each facility in a Multi-Facility software. The software will also potentially require an update if it hasn't been updated since 12/21/2021.

|}

Installation

2024-02-18T23:12:10Z

Joel:

{{Advanced}}

===Documentation Overview===

This is the technical documentation on the installation of the Time and Attendance software. This documentation is based on the software version 3.5 using SQL Server 2008 R2, but using SQL Server 2012, 2014 or 2016 is similar.

Topics covered are:

* Installing and configuring the Time and Attendance software.

* Installing and configuring the Microsoft SQL Server instance.

* Creating the starting database.

===Software Overview===

Time and Attendance is a 100% Microsoft .Net software product. The minimum required version is .Net 4.6.1 and can be used with any higher version. The .Net framework needs to be installed on any computer that will use the software. Traditional installation of the software is not required as it is an xcopy application in that the software can be copied to a folder and run without any installation, component registration or registry modifications.

'''SQL Server'''

The installation of the .Net framework also installs the files required to connect to the data in Microsoft SQL Server. Time and Attendance 3.5 can use an existing instance of SQL Server, or you can install a new instance if you are not already running SQL Server. The minimum supported version of SQL Server is 2008.

'''Other Applications'''

Time and Attendance creates reports in both Adobe PDF format and in Microsoft Excel format (.xls and .xlsx). Free viewers are available for both of these file formats.

===Installation===

The installation of your Time and Attendance 3.5 system requires you to setup and configure your software, a Windows Service, the database, and the HandPunches. The following is a list of the required items to get the Time and Attendance 3.5 software up and running.

# Install the .Net 4.6.1 or higher framework on your server and on each client.
# Create a folder for the software on your server that all the clients can access.
# Create a shortcut to the main executable for each client.
# Install the Windows service.
# Install SQL Server if needed.
# Create a database and restore to an empty starting database.
# Edit the configuration file to reflect settings such as the database server name, the database name and your license key.
# Use the database utility to bring the database up to the version that matches the software.
# Start the Windows service.
# Start the software and configure the Configuration/Setup/System/Scheduled Tasks
# Start the software and configure it to your rules, add the employees etc.
# Install the HandPunches and test communications.
# Configure tasks on your server to poll and process the punches, as well as perform maintenance tasks like the backup of the data.

===.Net Framework===

Installation of the .Net framework version 4.6.1 or higher is required on any computer that wants to run the Time and Attendance 3.5 software. The .Net 4.6.1 framework is supported on Windows 7 SP1, Windows Server 2008 R2, Windows 8, Server 2012, Windows 10 and Server 2016.

===Files and Folders===

'''Dedicated Folder'''

Create a folder dedicated to the Time and Attendance 3.5 software on the server. Extract / copy the files to this folder.

'''Permissions'''

The users require the ability to read and execute the application. If there is a need for the user to poll the HandPunches manually, then the ability to write to a subdirectory named punchlog will be required. This folder is created automatically the first time that a HandPunch is polled.

'''Top Level Folder'''

The top level folder is commonly named “Ta”, but you can name it as you want. This folder will contain all of the software executables:

* Ta.WinAdmin.exe – the Windows main executable. The main entry point into the software.
* Ta.WinAdmin.exe.config – the configuration file for Ta.WinAdmin.exe.
* Ta.DBU.exe – The database utility to manage the database. This is primarily used for the updating of your database to the version that matches the executable. The login is Ta and the password is fixed, but is not contained in the help files for security reasons. The database utility would be run on your server and not on the client.
* Ta.DBU.exe.config – the configuration file for Ta.DBU.exe.
* SBV.Ta.Windows.Server.exe – the Windows Service executable that provides communications services between the clients.
* SBV.Ta.Windows.Service.exe.config – the configuration file for SBV.Ta.Windows.Service.exe.
* Ta.config – the configuration file that contains your application configuration such as database and license information.
* SBV.* – the core application (DLL) components of the software that handle the business logic, time clocks, database, reporting and payroll interfaces.
* Atalasoft.* – third party imaging components.
* cete.* – third party components used for the creation of PDFs.
* DevExpress.* – third party pivot grid control.
* FarPoint.* – third party Excel style spreadsheet control.
* Janus.* – third party Office style UI controls.
* nsoftware.* – third party internet components. Used for FTP, NTP, HTTP, POP and SMTP.
* PureComponents.* – third party tree view component.
* rsidll*.dll – these are the communication DLLs to the HandPunch supplied by the HandPunch manufacturer. They are the only files that are unmanaged, because they are written in C++. However, there is no installation requirement for these files.

'''Install Folder'''

Contains a readme to links to download the .Net framework and other files that may be required to install the .Net framework. Also included are caspol.bat and installsvc.bat. The caspol.bat file provides information and samples about the security policy mechanism used by the .Net framework. Use the installsvc.bat file to install the Windows service.

'''Config Folder'''

The config files contains sample configuration files. These should be copied to the Ta folder and then the Ta.config edited as required.

'''Database Folder'''

This folder is typically named database. It is not a requirement to have the database files reside in a subdirectory of the Ta folder, but this is commonly done when the SQL Server is running on the same server as the Ta files are located. Supplied in the database folder is Ta.bak which is used as a starting database (empty of data).

'''Help Folder'''

The help folder contains the help documentation in PDF format (Ta.pdf) and the help index file (Ta.idx) which is a topic to page number index that provides context sensitive help in the software. HandPunch manuals for the different HandPunch models are also included.

===Shortcut===

Create a [[Create_Shortcut|shortcut]] to the Ta.WinAdmin.exe application file for each of your users, naming the shortcut “Time and Attendance”.

===Windows Service===

The Windows service runs on your server and provides communication between the clients and the server. Since this is duplex (two-way) messaging, client to client messaging is provided with the service acting as the intermediary.

Install the service at the command line using InstallUtil provided by the .Net framework:

"C:\Windows\Microsoft.NET\Framework\v2.0.50727\InstallUtil.exe" "F:\Ta\SBV.Ta.Windows.Service.exe"

Refer to the installsvc.bat file in the install folder for examples.

===SQL Server===

The software runs on SQL Server 2008 or higher. We recommend SQL Server 2014 for new installations.

'''SQL Server 2014 Express with Tools'''

This is a free download from Microsoft and is used by clients with over 10 users and over 500 employees. There is a database size limit of 10 Gb that will eventually be reached after approximately 10 years, depending on the number of employees that you have. SQL Server Express will use only one processor and up to 1 Gb of memory. However, the software design is very efficient and does not tax the server with heavy queries. When installing, please follow these guidelines.

* Unless you have a large amount of free space on your C drive (> 10 Gb), then we recommend that you install the SQL Server on a different drive.
* Keep the default instance name of "SQLExpress” unless there is a reason to use another instance name.
* The database engine and the management tools are the only 2 features required.
* Authentication Mode – the software can connect using SQL Server Authentication or Windows Authentication. We recommend using SQL Server Authentication. If you choose "Mixed Mode”, you will need to enter a password of your choosing.

'''Allow Remote Connections'''

After SQL Server is installed, allow TCP/IP and Named Pipes connections from the client computers.

# Open "SQL Server Configuration Manager." (‪C:\Windows\System32\SQLServerManager??.msc)
# Expand the "SQL Server Network Configuration" node and select “Protocols for [Instance Name].”, e.g. “Protocols for SQLExpress.”
# Right click on “TCP/IP” and select Enable. Repeat this for “Named Pipes.”
# A message informs you that these changes do not apply until the SQL Server service is restarted.
# Select the "SQL Server Services" node.
# Right click the SQL Server ([Instance Name]) node and select Restart.

'''Authentication'''

Using Windows Authentication requires that new users of the software are added to the security group that has access to the SQL Server. We recommend the use of SQL Authentication because users are incapable of connecting to the database directly. If you choose to use Windows Authentication, then you take responsibility for your users exploiting their Windows identity to obtain access to the data through other software.

===Creating the Database===

Once SQL Server is configured and installed, you need to create a new database and then restore from the supplied backup file.

By convention, the database is named Ta, but you can name as you wish. Use the following database settings:

* Version 10.0 (SQL Server 2008) – Required.
* Auto Close – False (highly recommended). If not set to False, then the database can be backed up like a file by any backup software. However, during backup, the database files are locked and will not be able to be opened (i.e. reconnected) to SQL Server. If you choose to use Auto Close so that you can back up the mdf/ldf files, you must ensure that the software will not be used at any time during your backup process. We recommend that you use the backup task provided with the database utility to create a backup file to disk.
* Auto Shrink – False (highly recommended). We recommend that you do not auto shrink your data or log files. and that you perform manual shrink of your files as part of your database maintenance.
* Logging – Simple (recommended). Simple is generally considered sufficient but you may elect to use the Full recovery model if you feel that the software contains critical data that would result in catastrophe upon restoration to the last daily backup. Please note that you are completely responsible for the off disk or off site backup of your data. The software provides a mechanism for creating a zipped daily backup of your data to any location on your network. The backup is not designed to be a disaster recovery mechanism but to represent your data in a point in time. Additionally, the punch information from the HandPunches is logged to disk, and can be reprocessed by our software.

Once the database is created, restore the Ta.bak file in the database folder to create you starting database.

====Database Login====

The software requires a login with the login ID of Ta. This login needs the server role as a sysadmin, and the user mapping to the Ta database as db_owner. The password is fixed and is not supplied in this help file for security reasons. You will need to contact technical support for this password.

===Configuration File===

The Ta.config configuration file is used by the following executables; Ta.WinAdmin.exe, Ta.DBU.exe and SBV.Ta.Windows.Service.exe. The configuration file is an XML fragment that starts and ends with the appSettings node. A sample is included in the config folder.

Here is a sample Ta.config file:
<nowiki><appSettings>
<add key="databaseServerName" value="MyServer\MySqlInstance"/>
<add key="databaseName" value="Ta"/>
<add key="namedPipes" value="true"/>
<add key="sharedMemoryClient" value="MyServer"/>
<add key="duplexMessaging" value="true" />
<add key="duplexMessagingAddress" value="MyServer:9000" />
<add key="duplexMessagingNamedPipeClient" value="MyServer" />
<add key="license" value="your license string goes here"/>
<add key="offline" value="false"/>
</appSettings></nowiki>

===Database Settings===

You need to set the database server name and the database name. Additional connection options allow you to set how the clients and the server will connect to the database. By default, the TCP/IP protocol is used for the clients, and Shared Memory is used for the server (assuming the software and SQL Server are running on the same machine). We recommend that you use Named Pipes for all clients. As the namedPipes setting will affect all computers, you should use the sharedMemoryClient setting to allow the server to connect using this protocol.

{| class="wikitable"

|-
| databaseServerName
| The database server name including the SQL instance name. The server name needs to be resolved by the client. The IP address of the server can be used as an alternate setting.

|-
| databaseName
| The name of the database.

|-
| namedPipes
| When set to true, all clients will connect to the database using Named Pipes.

|-
| sharedMemoryClient
| The name of the computer where SQL Server is installed is the only computer that can use shared memory.

|-
| namedPipesClients
| A comma separated list of computers as an alternative to the global namedPipes setting.

|-
| tcpIpClients
| A comma separated list of computers that will use TCP/IP to connect to the database.

|}

===Messaging===

{| class="wikitable"
|-
|
duplexMessaging

|
When set to true, duplex messaging between all clients is used.
|-
|
duplexMessagingAddress

|
The name of the server and the port that the duplex messaging will use.
|-
|
duplexMessagingNamedPipeClient
|
The name of the server that the service is running on. Connections made from the server will use the faster named pipe connection rather than TCP/IP.

|}

===Email===

{| class="wikitable"

|-
| mailServer
| The address of the SMTP mail server for communication and support emails.

|-
| mailPort
| The port to connect to the SMTP server for communication and support emails.

|-
| mailUser
| The user account for communication and support emails.

|-
| mailPassword
| The password as an encrypted string for communication and support emails. Use the Utility provided to encrypt the password.

|-
| mailFrom
| The From address of the communication and support emails.

|-
| communicationErrorSendTo
| The address(es) that emails are sent to when there is a communication error to the HandPunch.

|-
| supportSendTo
| The address(es) that all non HandPunch errors are sent to. This includes the Email Support form, and the Exception Form when the user clicks Email Support.

|-
| reportsMailServer
| The address of the SMTP mail server for reports.

|-
| reportsMailPort
| The port to connect to the SMTP server for reports.

|-
| reportsMailUser
| The user account for reports.

|-
| reportsMailPassword
| The password as an encrypted string for reports. Use the Utility provided to encrypt the password.

|-
| reportsMailFrom
| The From address of the email for reports.

|}

===License===

The license is an encrypted string that contains the name of the licensee (the company name), address, modules licensed, and the employee count.

{| class="wikitable"
|-
|
license
|
The encrypted license key.

|}

===Other Settings===

The offline setting stops clients from running the software, while you are performing updates.

{| class="wikitable"
|-
|
offline
|
true or false.

|}

==Database Utility==

After restoring the starting database from the backup, bring the database version up to the same version as the software. You login into the database utility with the Ta login and the password (which is not provided in the help documentation) and perform the Update action.

Updating the database with the database utility is supported on the server that has SQL Server installed. The database utility uses the osql utility, which is part of the installation of SQL Server 2000, 2005 and 2008. If you wish to run the database utility from a computer that does not have SQL Server installed, then you will need to get osql working correctly. However, we cannot provide support for this scenario.

All changes that have been made to the database structure are maintained in sequentially numbered scripts. These scripts are embedded into the database utility. The scripts are extracted to your Ta folder, and then executed. After performing an update, you will see numbered files like 101001.sql in the Ta folder as well as sp_udf.sql. These files can be safely deleted after a successful update.

Always create a backup before running the database utility.

The database utility can also be used to import old data from TCSData.mdb files.

==Start the Windows Service==

The Windows service is set to start automatically when Windows starts. You need to start it manually the first time in the Services management console.

==Start the Software==

Upon completion of the installation, the software can be started. As the database is empty, no login ID or password is required.

Refer to the [[Configuration]] chapter for setting up the software.

==[[Tasks]]==

There are tasks that need to be performed frequently and daily that are best set up to run on your server automatically, rather than be remembered to be done by users.

== See also ==

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

* [[HandPunch|Using the HandPunch time clock]]

* [[SBV|Contact Us]]

Tapcheck Export

2024-01-18T17:29:29Z

Joel: Replaced content with "See setup instructions on Sharepoint."

See setup instructions on Sharepoint.

Viventium Integration Update and Report

2024-01-03T19:12:20Z

Joel: /* Setup */

This is an optional feature that can be added to the software upon request. It allows to automatically add/update the fields below in Time & Attendance from Viventium's API so that the data only has to be added/changed in Viventim and not in TA.

{| class="wikitable"
|-
! Field
! Add (new employee)
! Update (existing employee)

|-
| Employee ID
| Yes
| No

|-
| Employee Clock ID
| Yes (Only if the Viventium Clock ID is not already used by another TA employee. If it is, then it will be left blank)
| No

|-
| First Name
| Yes
| Yes

|-
| Middle Name
| Yes
| Yes

|-
| Last Name
| Yes
| Yes

|-
| Address
| No
| Yes

|-
| Phone
| No
| Yes

|-
| Email
| No
| Yes

|-
| Birth Date
| Yes
| Yes

|-
| Gender
| No
| Yes

|-
| Facility
| Yes (for a multi facility software)
| No

|-
| Company
| Yes (The TA company that has the Viventium Code in the company's payroll ID or the In House company if no payroll ID)
| No

|-
| Department
| Yes
| Yes

|-
| SSN
| Yes
| No

|-
| Hire Date
| Yes
| Only if missing (There isn't a hire date in the software yet)

|-
| Termination Date
| No
| Only if missing (If not currently terminated)

|-
| Re-Hire Date
| N/A
| Yes - If employee is currently inactive in TA, the automatic integration report will need to include all employees (Active and Inactive)

|-
| Pay Rate
| No
| Yes (Salaried employees will need their salaried hours filled in on their Pay Rates tab in TA)

|-
| Employee Licenses
| No
| Yes

|-
| Viventium Accrual Balances
| No
| Yes - Please note that the Accrual Pay Type ID must match the Earning Code in Viventium in order to Sync Accrual Balances.
|}

The Add (new employee) is done by clicking on the Refresh Employees button. It will then connect to the Viventium website and check if there are any new employees that were hired within the last 30 days that are not yet in TA (this may take a few seconds). If there are any new employees, it will display the Add Employee popup with the employee's data prefilled so that it can easily be added.

[[File:EmployeesGroupRefreshEmployees.png]]

The Update (existing employee) can be scheduled for all employees to run at a regular interval even multiple times a day. To do it manually at any time for a single employee, click on the Update From Viventium button on the employee.

[[File:EmployeeMainTabUpdateFromViventium.png]]

Update Employee will only update employees that have the same Employee ID and the same SSN as in Viventium. The employee will also need to be in a In-House company.

==Troubleshooting==

To test that the software can see employee data changes on the api, select an employee and temporarily change their name (add a letter to their name), then click the Update From Viventium button to see if it changes it back to the original correct name.

To test that the software can see new employees on the api, select an employee that was recently hired (within the last 30 days) and temporarily change their Employee ID (add a letter to their ID), then click the Refresh Employees button to see if it pops up this employee as a new employee.

If the error is that it can't find the employee on viventium then check if your IP address is whitelisted with Viventium.

If syncing accrual balances and the effective date after the update/sync is an old date, check the pay period on the last issued check if it wasn't an old pay period (retro pay).

==Setup==

You will need the Viventium api login username and password, company code, and division code. This info will be hard coded in the software and will require a software update. Also add the company code to the facility and in-house company labor level as the payroll ID. In addition to providing the api login, viventium may also need to enable the login in the backend.

After the connection is set up and tested, this report can then be saved and scheduled to run (overnight) so that employee changes are automatically applied. Make sure to include all employees (Active and Inactive).

To sync accrual balances from Vivnetium, add the Viventium Pay Type code on the TA accrual pay type.

Employee Annual Entitlement Overrides Import

2023-12-18T21:05:39Z

Joel:

The Employee Annual Entitlement Overrides import adds an Entitlement Override to the accrual Employee Annual Entitlement Overrides.

An Employee Annual Entitlement Overrides import is identified by the sheet name or file name containing the words "Employee Entitlement".

{| class="wikitable"
|-
! Column Type
! Identifiers
! Notes
! Required

|-
| Employee ID
| Employee ID, Emp ID, ID
| This is used to uniquely identify the employee. With a multi-facility configuration you must also provide the Facility column.
| Yes

|-
| Annual Entitlement Type
| Type, Entitlement Type
| Use Date or Month.
| Yes

|-
| Accrual Pay Type / Days
| Accrual Pay Type ID
| The column header identifies the accrual pay type. The data in each row represents the number of entitlement days for the accrual pay type. To import into Bank 2, add a " 2" to the column header, e.g. "SICK 2".
| Yes

|-
| Start Date
| Start Date
|
| No

|-
| End Date
| End Date
|
| No

|-
| From Month
| From, From Month, Employed From Month
| 0 - 9999
| No

|-
| To Month
| To, To Month, Employed To Month
| 0 - 9999
| No

|}
== See also ==

* [[Import]]

Employee Annual Entitlement Overrides Import

2023-12-18T21:05:24Z

Joel:

The Employee Annual Entitlement Overrides import adds an Entitlement Override to the accrual Employee Annual Entitlement Overrides.

An Employee Annual Entitlement Overrides import is identified by the sheet name or file name containing the words "Employee Entitlement".

{| class="wikitable"
|-
! Column Type
! Identifiers
! Notes
! Required

|-
| Employee ID
| Employee ID, Emp ID, ID
| This is used to uniquely identify the employee. With a multi-facility configuration you must also provide the Facility column.
| Yes

|-
| Annual Entitlement Type
| Type, EntitlementType
| Use Date or Month.
| Yes

|-
| Accrual Pay Type / Days
| Accrual Pay Type ID
| The column header identifies the accrual pay type. The data in each row represents the number of entitlement days for the accrual pay type. To import into Bank 2, add a " 2" to the column header, e.g. "SICK 2".
| Yes

|-
| Start Date
| Start Date
|
| No

|-
| End Date
| End Date
|
| No

|-
| From Month
| From, From Month, Employed From Month
| 0 - 9999
| No

|-
| To Month
| To, To Month, Employed To Month
| 0 - 9999
| No

|}
== See also ==

* [[Import]]

Employee Annual Entitlement Overrides Import

2023-12-18T20:54:21Z

Joel:

The Employee Annual Entitlement Overrides import adds an Entitlement Override to the accrual Employee Annual Entitlement Overrides.

An Employee Annual Entitlement Overrides import is identified by the sheet name or file name containing the words "Employee Entitlement".

{| class="wikitable"
|-
! Column Type
! Identifiers
! Notes
! Required

|-
| Employee ID
| Employee ID, Emp ID, ID
| This is used to uniquely identify the employee. With a multi-facility configuration you must also provide the Facility column.
| Yes

|-
| Annual Entitlement Type
| Type
| Use Date or Month.
| Yes

|-
| Accrual Pay Type / Days
| Accrual Pay Type ID
| The column header identifies the accrual pay type. The data in each row represents the number of entitlement days for the accrual pay type. To import into Bank 2, add a " 2" to the column header, e.g. "SICK 2".
| Yes

|-
| Start Date
| Start Date
|
| No

|-
| End Date
| End Date
|
| No

|-
| From Month
| From Month
| 0 - 9999
| No

|-
| To Month
| To Month
| 0 - 9999
| No

|}
== See also ==

* [[Import]]

Employee Annual Entitlement Overrides Import

2023-12-18T20:51:43Z

Joel:

The Employee Annual Entitlement Overrides import adds an Entitlement Override to the accrual Employee Annual Entitlement Overrides.

An Employee Annual Entitlement Overrides import is identified by the sheet name or file name containing the words "Employee Entitlement".

{| class="wikitable"
|-
! Column Type
! Identifiers
! Notes
! Required

|-
| Employee ID
| Employee ID, Emp ID, ID
| This is used to uniquely identify the employee. With a multi-facility configuration you must also provide the Facility column.
| Yes

|-
| Annual Entitlement Type
| Type
| Use Date or Month.
| Yes

|-
| Accrual Pay Type / Days
| Accrual Pay Type ID
| The column header identifies the accrual pay type. The data in each row represents the number of entitlement days for the accrual pay type. To import into Bank 2, add a " 2" to the column header, e.g. "SICK 2".
| Yes

|-
| Start Date
| Start Date
|
| No

|-
| End Date
| End Date
|
| No

|-
| From Month
| From Month
|
| No

|-
| To Month
| To Month
|
| No

|}
== See also ==

* [[Import]]

Employee Annual Entitlement Overrides Import

2023-12-18T20:48:50Z

Joel: Created page with "The Employee Annual Entitlement Overrides import adds an Entitlement Override to the accrual Employee Annual Entitlement Overrides. An Employee Annual Entitlement Overrides i..."

The Employee Annual Entitlement Overrides import adds an Entitlement Override to the accrual Employee Annual Entitlement Overrides.

An Employee Annual Entitlement Overrides import is identified by the sheet name or file name containing the words "Employee Entitlement".

{| class="wikitable"
|-
! Column Type
! Identifiers
! Notes
! Required

|-
| Employee ID
| Employee ID, Emp ID, ID
| This is used to uniquely identify the employee. With a multi-facility configuration you must also provide the Facility column.
| Yes

|-
| Annual Entitlement Type
| Type
| Use Date or Month.
| Yes

|-
| Start Date
| Start Date
|
| No

|-
| End Date
| End Date
|
| No

|-
| From Month
| From Month
|
| No

|-
| To Month
| To Month
|
| No

|-
| Accrual Pay Type / Days
| Accrual Pay Type ID
| The column header identifies the accrual pay type. The data in each row represents the number of entitlement days for the accrual pay type. To import into Bank 2, add a " 2" to the column header, e.g. "SICK 2".
| No

|}
== See also ==

* [[Import]]

Import

2023-12-18T20:36:20Z

Joel:

Import is available in the Tools tab.

The software supports the import of information from an Excel file (xls – Excel 97-2003 format and xlsx Excel 2007-2010 format) or from a comma separated values file (csv). The extension on the filename must be csv if using a comma separated values file. Otherwise, the import will open the file as an Excel file.

The import will read data from multiple sheets within one Excel file. The filename takes precedence over the sheetname in identifying the import type. Each import has a different behavior regarding the adding, replacing or updating of data. An import may only add data to the software, update existing data, remove existing data and replace it, or both add and update data.

The information provided in the import file identifies the data. The file name, sheet names (Excel only) and column headers (the first row) identify the information. There is not a fixed column format. Specifically:

* Spaces and case are ignored so "Pay Rule", "pay rule", and "payrule" identify the same data.
* The name of the file can identify the import type for all sheets in the file, e.g. if the name of the file contains "employee," then all information in the file will be assumed to be employee information.
* The sheet names can identify the import type. This allows one Excel file to contain different types of information, e.g. both employee and planned absence information.

Upon identifying the import type, the next step is identifying the data contained in each column. The column headers used in the first row of each sheet identify the specific data within that column. For example, when importing budgets, the column header of "Shift" identifies the shift information. Therefore, in this example, the information provided in each row for this column must match to one of the existing shift IDs, shift descriptions, or scheduler IDs.

Every row imports if the correct row data is provided in each column. Each import type has required columns that must be provided.

The following import types are available:

{| class="wikitable"
|-
! Import Type
! Filename / sheet name Identifier

|-
| [[Employee Annual Entitlement Overrides Import|Accrual Entitlement Overrides (Employee)]]
| Employee Entitlement

|-
| [[Accrual Adjustment Import|Accrual Adjustment (Employee)]]
| Accrual Adjustment

|-
| [[Accrual Balances Import|Accrual Balances (Employee)]]
| Accrual Balances

|-
| [[Accrual Date Entitlements Import|Accrual Date Entitlements (Configuration)]]
| Accrual Date

|-
| [[Accrual Year End Adjustments Import|Accrual Year End Adjustments (Employee)]]
| Accrual Year End

|-
| [[Base Schedule Import|Base Schedules]]
| Base Schedules

|-
| [[Budget Import|Budget]]
| Budget

|-
| [[Casamaba Punch Import|Casamba Punch]]
| Casamba

|-
| [[Employee Import|Employee]]
| Employee

|-
| [[Hours Import|Hours]]
| Hours

|-
| [[In Service Import|In Service]]
| In Service

|-
| [[Labor Levels Import|Labor Levels]]
| Labor Level name, e.g. Department

|-
| [[Schedule Pattern Import|Schedule Pattern]]
| Schedule Pattern

|-
| [[Planned Absence Import|Planned Absence]]
| Planned Absence

|-
| [[Pay Rates Import|Pay Rates]]
| Pay Rates

|-
| [[Pay Rate Lookup Import|Pay Rate Lookup]]
| Pay Rate Lookup

|-
| [[Raw Punch Import|Raw Punch]]
| Raw Punch

|-
| [[Punch Import|Punch]]
| Punch

|-
| [[Schedule Import|Schedule]]
| Schedule

|-
| [[Slotting Import|Slotting]]
| Slotting

|-
| [[Time Clock Assignment Import|Time Clock Assignment]]
| Time Clock Assignment

|}

== See also ==

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

* [[Employees]]

* [[Employee]]

* [[Reports]]

* [[Scheduler]]

* [[Tools]]

* [[Configuration]]

Import

2023-12-18T20:35:43Z

Joel:

Import is available in the Tools tab.

The software supports the import of information from an Excel file (xls – Excel 97-2003 format and xlsx Excel 2007-2010 format) or from a comma separated values file (csv). The extension on the filename must be csv if using a comma separated values file. Otherwise, the import will open the file as an Excel file.

The import will read data from multiple sheets within one Excel file. The filename takes precedence over the sheetname in identifying the import type. Each import has a different behavior regarding the adding, replacing or updating of data. An import may only add data to the software, update existing data, remove existing data and replace it, or both add and update data.

The information provided in the import file identifies the data. The file name, sheet names (Excel only) and column headers (the first row) identify the information. There is not a fixed column format. Specifically:

* Spaces and case are ignored so "Pay Rule", "pay rule", and "payrule" identify the same data.
* The name of the file can identify the import type for all sheets in the file, e.g. if the name of the file contains "employee," then all information in the file will be assumed to be employee information.
* The sheet names can identify the import type. This allows one Excel file to contain different types of information, e.g. both employee and planned absence information.

Upon identifying the import type, the next step is identifying the data contained in each column. The column headers used in the first row of each sheet identify the specific data within that column. For example, when importing budgets, the column header of "Shift" identifies the shift information. Therefore, in this example, the information provided in each row for this column must match to one of the existing shift IDs, shift descriptions, or scheduler IDs.

Every row imports if the correct row data is provided in each column. Each import type has required columns that must be provided.

The following import types are available:

{| class="wikitable"
|-
! Import Type
! Filename / sheet name Identifier

|-
| [[Employee Annual Entitlement Overrides Import|Employee Entitlement Overrides (Employee)]]
| Employee Entitlement

|-
| [[Accrual Adjustment Import|Accrual Adjustment (Employee)]]
| Accrual Adjustment

|-
| [[Accrual Balances Import|Accrual Balances (Employee)]]
| Accrual Balances

|-
| [[Accrual Date Entitlements Import|Accrual Date Entitlements (Configuration)]]
| Accrual Date

|-
| [[Accrual Year End Adjustments Import|Accrual Year End Adjustments (Employee)]]
| Accrual Year End

|-
| [[Base Schedule Import|Base Schedules]]
| Base Schedules

|-
| [[Budget Import|Budget]]
| Budget

|-
| [[Casamaba Punch Import|Casamba Punch]]
| Casamba

|-
| [[Employee Import|Employee]]
| Employee

|-
| [[Hours Import|Hours]]
| Hours

|-
| [[In Service Import|In Service]]
| In Service

|-
| [[Labor Levels Import|Labor Levels]]
| Labor Level name, e.g. Department

|-
| [[Schedule Pattern Import|Schedule Pattern]]
| Schedule Pattern

|-
| [[Planned Absence Import|Planned Absence]]
| Planned Absence

|-
| [[Pay Rates Import|Pay Rates]]
| Pay Rates

|-
| [[Pay Rate Lookup Import|Pay Rate Lookup]]
| Pay Rate Lookup

|-
| [[Raw Punch Import|Raw Punch]]
| Raw Punch

|-
| [[Punch Import|Punch]]
| Punch

|-
| [[Schedule Import|Schedule]]
| Schedule

|-
| [[Slotting Import|Slotting]]
| Slotting

|-
| [[Time Clock Assignment Import|Time Clock Assignment]]
| Time Clock Assignment

|}

== See also ==

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

* [[Employees]]

* [[Employee]]

* [[Reports]]

* [[Scheduler]]

* [[Tools]]

* [[Configuration]]

Import

2023-12-18T20:29:35Z

Joel:

Import is available in the Tools tab.

The software supports the import of information from an Excel file (xls – Excel 97-2003 format and xlsx Excel 2007-2010 format) or from a comma separated values file (csv). The extension on the filename must be csv if using a comma separated values file. Otherwise, the import will open the file as an Excel file.

The import will read data from multiple sheets within one Excel file. The filename takes precedence over the sheetname in identifying the import type. Each import has a different behavior regarding the adding, replacing or updating of data. An import may only add data to the software, update existing data, remove existing data and replace it, or both add and update data.

The information provided in the import file identifies the data. The file name, sheet names (Excel only) and column headers (the first row) identify the information. There is not a fixed column format. Specifically:

* Spaces and case are ignored so "Pay Rule", "pay rule", and "payrule" identify the same data.
* The name of the file can identify the import type for all sheets in the file, e.g. if the name of the file contains "employee," then all information in the file will be assumed to be employee information.
* The sheet names can identify the import type. This allows one Excel file to contain different types of information, e.g. both employee and planned absence information.

Upon identifying the import type, the next step is identifying the data contained in each column. The column headers used in the first row of each sheet identify the specific data within that column. For example, when importing budgets, the column header of "Shift" identifies the shift information. Therefore, in this example, the information provided in each row for this column must match to one of the existing shift IDs, shift descriptions, or scheduler IDs.

Every row imports if the correct row data is provided in each column. Each import type has required columns that must be provided.

The following import types are available:

{| class="wikitable"
|-
! Import Type
! Filename / sheet name Identifier

|-
| [[Accrual Annual Entitlement Import|Employee Entitlement (Employee)]]
| Employee Entitlement

|-
| [[Accrual Adjustment Import|Accrual Adjustment (Employee)]]
| Accrual Adjustment

|-
| [[Accrual Balances Import|Accrual Balances (Employee)]]
| Accrual Balances

|-
| [[Accrual Date Entitlements Import|Accrual Date Entitlements (Configuration)]]
| Accrual Date

|-
| [[Accrual Year End Adjustments Import|Accrual Year End Adjustments (Employee)]]
| Accrual Year End

|-
| [[Base Schedule Import|Base Schedules]]
| Base Schedules

|-
| [[Budget Import|Budget]]
| Budget

|-
| [[Casamaba Punch Import|Casamba Punch]]
| Casamba

|-
| [[Employee Import|Employee]]
| Employee

|-
| [[Hours Import|Hours]]
| Hours

|-
| [[In Service Import|In Service]]
| In Service

|-
| [[Labor Levels Import|Labor Levels]]
| Labor Level name, e.g. Department

|-
| [[Schedule Pattern Import|Schedule Pattern]]
| Schedule Pattern

|-
| [[Planned Absence Import|Planned Absence]]
| Planned Absence

|-
| [[Pay Rates Import|Pay Rates]]
| Pay Rates

|-
| [[Pay Rate Lookup Import|Pay Rate Lookup]]
| Pay Rate Lookup

|-
| [[Raw Punch Import|Raw Punch]]
| Raw Punch

|-
| [[Punch Import|Punch]]
| Punch

|-
| [[Schedule Import|Schedule]]
| Schedule

|-
| [[Slotting Import|Slotting]]
| Slotting

|-
| [[Time Clock Assignment Import|Time Clock Assignment]]
| Time Clock Assignment

|}

== See also ==

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

* [[Employees]]

* [[Employee]]

* [[Reports]]

* [[Scheduler]]

* [[Tools]]

* [[Configuration]]

Import

2023-12-18T20:27:21Z

Joel:

Import is available in the Tools tab.

The software supports the import of information from an Excel file (xls – Excel 97-2003 format and xlsx Excel 2007-2010 format) or from a comma separated values file (csv). The extension on the filename must be csv if using a comma separated values file. Otherwise, the import will open the file as an Excel file.

The import will read data from multiple sheets within one Excel file. The filename takes precedence over the sheetname in identifying the import type. Each import has a different behavior regarding the adding, replacing or updating of data. An import may only add data to the software, update existing data, remove existing data and replace it, or both add and update data.

The information provided in the import file identifies the data. The file name, sheet names (Excel only) and column headers (the first row) identify the information. There is not a fixed column format. Specifically:

* Spaces and case are ignored so "Pay Rule", "pay rule", and "payrule" identify the same data.
* The name of the file can identify the import type for all sheets in the file, e.g. if the name of the file contains "employee," then all information in the file will be assumed to be employee information.
* The sheet names can identify the import type. This allows one Excel file to contain different types of information, e.g. both employee and planned absence information.

Upon identifying the import type, the next step is identifying the data contained in each column. The column headers used in the first row of each sheet identify the specific data within that column. For example, when importing budgets, the column header of "Shift" identifies the shift information. Therefore, in this example, the information provided in each row for this column must match to one of the existing shift IDs, shift descriptions, or scheduler IDs.

Every row imports if the correct row data is provided in each column. Each import type has required columns that must be provided.

The following import types are available:

{| class="wikitable"
|-
! Import Type
! Filename / sheet name Identifier

|-
| [[Accrual Annual Entitlement Import (Employee)|Employee Entitlement]]
| Employee Entitlement

|-
| [[Accrual Adjustment Import (Employee)|Accrual Adjustment]]
| Accrual Adjustment

|-
| [[Accrual Balances Import (Employee)|Accrual Balances]]
| Accrual Balances

|-
| [[Accrual Date Entitlements Import (Configuration)|Accrual Date Entitlements]]
| Accrual Date

|-
| [[Accrual Year End Adjustments Import (Employee)|Accrual Year End Adjustments]]
| Accrual Year End

|-
| [[Base Schedule Import|Base Schedules]]
| Base Schedules

|-
| [[Budget Import|Budget]]
| Budget

|-
| [[Casamaba Punch Import|Casamba Punch]]
| Casamba

|-
| [[Employee Import|Employee]]
| Employee

|-
| [[Hours Import|Hours]]
| Hours

|-
| [[In Service Import|In Service]]
| In Service

|-
| [[Labor Levels Import|Labor Levels]]
| Labor Level name, e.g. Department

|-
| [[Schedule Pattern Import|Schedule Pattern]]
| Schedule Pattern

|-
| [[Planned Absence Import|Planned Absence]]
| Planned Absence

|-
| [[Pay Rates Import|Pay Rates]]
| Pay Rates

|-
| [[Pay Rate Lookup Import|Pay Rate Lookup]]
| Pay Rate Lookup

|-
| [[Raw Punch Import|Raw Punch]]
| Raw Punch

|-
| [[Punch Import|Punch]]
| Punch

|-
| [[Schedule Import|Schedule]]
| Schedule

|-
| [[Slotting Import|Slotting]]
| Slotting

|-
| [[Time Clock Assignment Import|Time Clock Assignment]]
| Time Clock Assignment

|}

== See also ==

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

* [[Employees]]

* [[Employee]]

* [[Reports]]

* [[Scheduler]]

* [[Tools]]

* [[Configuration]]

Schedule Based Restrictions

2023-12-11T21:36:54Z

Joel:

When Schedule Based Restrictions are turned on, employee schedules are downloaded to the HandPunch to restrict the times that an employee can punch. This can reduce unauthorized overtime as well as early “in” and late “out” punches. An employee’s individual schedule is used to restrict access. A separate schedule is defined for each employee providing the ultimate in flexibility. The software synchronizes with the HandPunch approximately every 5-10 minutes, to provide the HandPunch with the most accurate and live scheduling updates.

By default, the HandPunch will not accept “in” punches earlier than 7 minutes to the start of the schedule and “out” punches after 7 minutes to the end of the schedule. It will If an employee attempts to punch in earlier than 7 minutes, or late out after 7 minutes, they will get an error at the HandPunch which will read, '''“TIME RESTRICTION”'''.

Clock Supervisors cannot be restricted at the clock and are able to punch at any time.

For a fingerprint clock, you will get one of the following three options when trying to punch:

*When an employee goes to a clock and punches in successfully, the screen of the clock will have a green box on it that says Punch Verified and it will have your name, Clock ID, and time that you punched. The clock will also have a voice say "Verified. Thank You"

*When an employee is trying to punch and is restricted, the clock will display an Orange box which will say "Can't clock you in yet" and will also say "You are not authorized to punch at this time". The clock will also have a voice that will say "Previously Verified". This means you are attempting to punch out of your zone and are being restricted.

*If you attempt to punch and you do not have a schedule within 8 hours of when you are trying to punch the clock will display an Orange box which will say "Can't clock you in yet" and will also say "You do not have a schedule for today". The clock will also have a voice that will say "Previously Verified"

If the employee was supposed to be at the facility but their schedule has not been updated yet in the scheduler (i.e. on a weekend), the employee should notify a higher authority, or someone with time card access, of the exact time of their arrival or departure. This person can then add the restricted punch manually on their time card.

To avoid the above scenario, staffing coordinators should make schedule changes in the scheduler as soon as they are aware a change, to minimize time zone restrictions at the clock. Once the employee punches and gets restricted at the clock, their punch will need to be added manually.

Even after an employee’s punch has been restricted, it is a good practice to have the staffing coordinator update the employee’s schedule in the scheduler for accuracy’s sake.

A report can be run to see all punches that have been rejected due to the time zone restriction. This report displays verified punches made at the time clock that were outside of an allowable punching time zone. See image below:

[[File:Ruth.png]]

[[File:TZR.png]]

[[File:Report.png]]

Accrual Date Entitlements Configuration

2023-12-07T20:53:06Z

Joel:

{{Advanced}}

The date entitlements configuration provides a table based view of the date-based accrual entitlement levels. Each accrual entitlement is comprised of an accrual group, an accrual pay type, an entitlement type, and the date of the entitlement.

The date of the entitlement is used in different ways, based upon the entitlement type:

* Fixed Date – the complete date is used.
* Recurring Fixed Date – only the Month and Day is used. The year is only used to start it and will then repeat automatically every year afterwards.
* Anniversary (Month) - the date is not used. The date will be calculated based on the Month # column, e.g. if Month # is 6 then the date will be the 6 month anniversary of the employee’s first non-zero shift count history date.
* Every Nth Month - use the (Nth From / Nth To) instead of the (From Month / To Month). Month # is required as an interval (use 12 for a yearly interval). This setting requires a software restart to take effect.
* Anniversary (For Year) - the year portion of the date is used, with the month and day coming from the first non-zero shift count entry in the employee’s shift history.
* Recurring Anniversary (From Year) - the year portion of the date is used to start it and will then repeat automatically every year afterwards. The month and day will be taken from the first non-zero shift count entry in the employee’s shift history.
* Birthday (For Year) – the year portion of the date is used, with the month and day coming from the employee’s birth date.
* Recurring Birthday (From Year) – the year portion of the date is used to start it and will then repeat automatically every year afterwards, with the month and day coming from the employee’s birth date.
* Birthday Or Fixed Date –
* 90 Worked Days – On the date that the employee reaches 90 worked days since their hire date, it will give them the entitlement.
* Each Accrual Period - Will give the entitlement at the end of each accrual period.

Amount Type:

* Days X Proportioned Daily hours - proportioned accrual based off their shift count. (The length of a Day is (Employee Shift Count / Fulltime Shift Count) x Employee Daily Hours).
* Days X Daily hours - calculates the accrual as if the employee is a full timer, instead of a proportioned accrual based off their shift count.
* Days X Proportioned Daily hours (Rounded) - rounds the proportioned accrual to the nearest quarter hour (15/8).
* Days X Holiday Rule -
* Hours -

Minimum/Maximum Worked Hours columns will count the total worked hours of the employee from prior accrual periods. The number of prior accrual periods to look back to calculate the combined total is entered in the "# of Periods" column. If "# of Periods" is 0 then this filter is not in effect. If it's 1 it will only use the previous period. If it's 2 it will use the prior 2 periods.

Union Only column requires that the employee has an union date, or is in a union department.

Minimum/Maximum shift count columns are provided to filter an entitlement based on the employee’s shift history, e.g. only full timers accrue their birthday.

Effective From and Effective To columns will limit the time frame of the entitlement that it will only be applied to accrual periods where the accrual period start date is within the from-to dates.

Qualification/Disqualification Level columns are used to indicate which Schedule Status Types or Pay Types will qualify/disqualify this accrual date entitlements. (Requires turning it on in System settings, Accruals Pay Type settings, Schedule Status Type, and Pay Type).

[[File:AccrualDateEntitlements.png]]

== See also ==

* [[Configuration]]

Accrual Date Entitlements Configuration

2023-12-07T20:52:47Z

Joel:

{{Advanced}}

The date entitlements configuration provides a table based view of the date-based accrual entitlement levels. Each accrual entitlement is comprised of an accrual group, an accrual pay type, an entitlement type, and the date of the entitlement.

The date of the entitlement is used in different ways, based upon the entitlement type:

* Fixed Date – the complete date is used.
* Recurring Fixed Date – only the Month and Day is used. The year is only used to start it and will then repeat automatically every year afterwards.
* Anniversary (Month) - the date is not used. The date will be calculated based on the Month # column, e.g. if Month # is 6 then the date will be the 6 month anniversary of the employee’s first non-zero shift count history date.
* Every Nth Month - use the (Nth From / Nth To) instead of the (From Month / To Month). Month # is required as an interval (use 12 for a yearly interval). This setting requires a software restart to take effect.
* Anniversary (For Year) - the year portion of the date is used, with the month and day coming from the first non-zero shift count entry in the employee’s shift history.
* Recurring Anniversary (From Year) - the year portion of the date is used to start it and will then repeat automatically every year afterwards. The month and day will be taken from the first non-zero shift count entry in the employee’s shift history.
* Birthday (For Year) – the year portion of the date is used, with the month and day coming from the employee’s birth date.
* Recurring Birthday (From Year) – the year portion of the date is used to start it and will then repeat automatically every year afterwards, with the month and day coming from the employee’s birth date.
* Birthday Or Fixed Date –
* 90 Worked Days – On the date that the employee reaches 90 worked days since their hire date, it will give them the entitlement.
* Each Accrual Period - Will give the entitlement at the end of each accrual period.

Amount Type:

* Days X Proportioned Daily hours - proportioned accrual based off their shift count. (The length of a Day is (Employee Shift Count / Fulltime Shift Count) x Employee Daily Hours)
* Days X Daily hours - calculates the accrual as if the employee is a full timer, instead of a proportioned accrual based off their shift count.
* Days X Proportioned Daily hours (Rounded) - rounds the proportioned accrual to the nearest quarter hour (15/8).
* Days X Holiday Rule -
* Hours -

Minimum/Maximum Worked Hours columns will count the total worked hours of the employee from prior accrual periods. The number of prior accrual periods to look back to calculate the combined total is entered in the "# of Periods" column. If "# of Periods" is 0 then this filter is not in effect. If it's 1 it will only use the previous period. If it's 2 it will use the prior 2 periods.

Union Only column requires that the employee has an union date, or is in a union department.

Minimum/Maximum shift count columns are provided to filter an entitlement based on the employee’s shift history, e.g. only full timers accrue their birthday.

Effective From and Effective To columns will limit the time frame of the entitlement that it will only be applied to accrual periods where the accrual period start date is within the from-to dates.

Qualification/Disqualification Level columns are used to indicate which Schedule Status Types or Pay Types will qualify/disqualify this accrual date entitlements. (Requires turning it on in System settings, Accruals Pay Type settings, Schedule Status Type, and Pay Type).

[[File:AccrualDateEntitlements.png]]

== See also ==

* [[Configuration]]

Employment Reports

2023-11-23T18:04:59Z

Joel:

[[image:EmploymentReports.png|right]]

===CPR Expiration dates===

Displays employees who have a CPR expiration date within the selected date range.

===Drug Screen Report===

Displays employee with missing drug screen information.

===EEO-1 Report===

When completing the EEO-1, use data from only one pay period and include both part-time and full-time employees. See this link for more details: [https://www.eeocdata.org/EEO1/home/index]

(If running it for the current pay period then filter for Active employees on the Current Status tab. If running it for a prior pay period then select all on the Current Status tab and filter instead on the Advanced/Status By Date Range tab).

The EEO-1 will only count employees that have all 3 filled in:

*EEOC Category
*Gender
*Race

All employees that are ''not'' counted are listed by name on the bottom of the report.

===EOC Report===

The EEOC report displays all employees to show their EEOC category or if it's not filled in.

===Expiring and Due Dates===

Reports on employees with expiring and due dates in their Licensing, Health and I9 information within a selected date range. The Options tab allows you to select what information to report on. This report does NOT perform missing date checking. You should use this report in conjunction with the Missing Dates report. Otherwise, use the individual Health Due, I9 Expiration Dates, and License Expiration Dates, which check BOTH missing and expiring/due dates.

===Employee Expiring and Due Dates Letter===

This is a template form letter that is printed one page per employee and allows you to customize the letter content. The following placeholders can be used when composing your form letter:

<Image>d:\pictures\<nowiki>logo.bm</nowiki>p</Image> allows for an image to be placed at the top and center of the page. Provide the full path to the image.

<Employee> will print the employee's first and last name.

<Date> will print the current date.

<EarliestDate> will print the earliest of the expiring/due dates.

<DateDescriptions> will print the expiring/due descriptions.

<LastDates> will print the previous descriptions and dates (if applicable).

<NextDates> will print the expiring/due descriptions and dates.

Line breaks are made with the Enter key. Tabs are not currently supported.

===Employees With CPR Certification===

Displays employees who have a CPR date entered.

===Employees With IV Certification===

Displays employees who have IV certification date entered.

===Employment Dates===

Displays employees that have license, health, employment, and custom dates, within the selected date range. Including checking for missing dates. Choose the date types you want to check in the Options tab.

===Health Dates===

Displays health dates within the selected date range. Including checking for missing dates.

===Health Due Dates===

Reports on employees with Health due dates within a selected date range. There is a dedicated column for each health due date and employees that do not have their date information entered will show up as **MISSING** on the report. Although the Rubella and Measles do not have a due date (only a received date), this report will still check that these dates are not missing.

===HHS OIG Search===

U.S Department of Health and Human Services, Office of the Inspector General search.

===I9 Expiration Dates===

Reports on employees with I9 expiration dates within a selected date range. There is a dedicated column for each I9 expiration date and employees that do not have their date information entered will show up as **MISSING** on the report.

===Influenza Report===

This report will provide a list of all employees indicating if they got the Influenza shot. Select a Date-Range and choose on the Options tab if you want the report to show all who got it in the date-range or all who didn't get it in the date-range.

===Licenses Expiration Dates===

Reports on employees with license expiration dates within a selected date range. There is a dedicated column for each license expiration date and employees that do not have their date information entered will show up as **MISSING** on the report.

===Missing Dates===

Reports on employees with missing dates in their Licensing, Health and I9 information. The Options tab allows you to select what information to report on. Note that the Health Due, I9 Expiration Dates and License Expiration Dates reports also check for missing dates. This report is used in conjunction with the Expiring and Due Dates report.

===Missing Document IDs===

Displays employees who have missing documents IDs in their license or employment information.

===Pneumococcal Report===

Displays employees with their Pneumococcal Vaccination status.

===SAM Search===

System for Award Management search which replaced EPLS.

===SSN Not Verified===

Displays employees who have not had their SSN verified.

===Turnover Report===

Turnover is calculated as Terminated divided by the average of Starting and Ending.

Terminated / [(Starting + Ending) / 2]

All employees that have a status that is not displayed by default when opening the software are considered terminated.

===Union Report===

Displays employees who have their Union date within the selected date range.

== See Also ==

* [[Reports]]

Tasks

2023-10-30T18:04:25Z

Joel:

Below is a list of tasks that can be automated to run on a schedule:

* ? – will show you the available command line arguments.
* A - calculates the accruals.
* AD1 - recalculate all accruals from Day One.
* B - backup the database to the default location of \application folder\database\backup.
* DI - defragment the database indexes.
* DP - sets the default printer. Second parameter is the name or share name of the printer.
* DST - update DST information in the software then sends the configuration settings to the handpunches.
* EM - send employee messages to the time clocks. Optional next parameter of time clock key (PkTimeClockID)
* ERROR - Generates error to test automatic emailing of error messages.
* I - Import. Second parameter is the name of the file.
* L - Releases all locks (for lock troubleshooting only).
* LOG - as the last parameter, it will log the messages displayed in the tasks form.
* LP - Lists the printers (use to troubleshoot issues that a record is not going to a particular printer).
* OFF - Update Ta.config file offline setting value to true.
* ON - Update Ta.config file offline setting value to false.
* P – polling and processing of active employees. This is the same as selecting Poll and All Employees in the Tools / [ Processing] screen. This gets all the punches from the time clocks, processes them and then performs all the calculations for the previous (if open), current and next pay periods regardless of whether or not the employee punches. This includes building schedules, checking holidays, checking auto punches as well as calculating hours for any punches. This is recommended as a daily task, especially if you have auto punching or auto hours employees.
* PA - Processing of all employees (without polling).
* PP – polling and processing of employees with punches. This is the same as selecting Poll and Employees With Punches in the Tools / Processing screen. It is recommended that this be done at least every hour and is typically run every few minutes if you are using Ethernet communications. If you are using modem communications and paying for each phone call, then you will want to limit the number of times you poll per day.
* PO – polling only. This is the same as selecting Poll and No Processing in the Tools / Processing screen. If the computer doing the polling is used by an employee, then this is the least intrusive method. However, punches will not show in the time cards until the processing is done through the P or PP task or from the Tools/ Processing screen.
* PZ - Send punching zones to the time clocks. Optional next parameter of time clock key (PkTimeClockID).
* PZH - Send punching zones to the time clocks once an hour. Optional next parameter of time clock key (PkTimeClockID).
* QS – quick synch. This synchronizes the hand templates in the same manner as Synch Users (see below), but not to any HandPunches marked as “No Quick Task Synching.”
* QSH - Synchronizes once an hour the employees in the HandPunches that are not marked as "No Quick Task Synching".
* S – synch users. This synchronizes the hand templates in the best possible manner. New templates will be distributed, existing templates will be updated, and employees no longer required to be punching will be removed. Recommended as a daily task, and more frequently if using multiple HandPunches.
* SH - Synchronizes the employees in all HandPunches once an hour.
* SL - SmartLinx integration query (current and next week).
* SLP - SmarLinx integration query (previous day).
* R – report. The report ID/Name is the second argument, with an optional third argument:
** VIEWER will open the report on screen. This allows a user who does not directly use the software to be given a shortcut to run and view a report “live”.
** PRINTER will send the report directly to the default printer. An optional fourth argument allows the printer name to be provided.
** EMAIL will have the report emailed as an attachment to the list of email recipients supplied on the Schedule tab, when the saved report was created.
** A list of email addresses will have the report emailed as an attachment. An “@” in the third argument is the identifier that this as a list of email address.
** A path and file name will have the report saved to disk. A “\” in the third argument is the identifier that this is a path and file name.
** If the third argument is not specified, then it will default to EMAIL.
* T – set time (if successfully updated from NIST). If the computer successfully connects to the NIST atomic clock service, then this time will be sent to all time clocks as well as setting the time on the computer. Recommended as a daily task.
* TH - Sets the time once per hour on all HandPunches if the computer time is successfully updated from NIST (atomic clock) and updates the system time.
* TO - Set the time on all HandPunches if the computer time is successfully updated from NIST (atomic clock). This is done WITHOUT updating the system time.
* TOH - Set the time once per hour on all Handpunches if the computer time is successfully updated from NIST (atomic clock). This is done WITHOUT updating the system time.
* TCA - Assigns the HandPunches to each employee based on the assignments between labor levels and timeclocks.
* TCAH - Once an hour it assigns the HandPunches to each employee based on the assignments between labor levels and timeclocks.
* TS - Updates Team Support system with information.
* US – update the employee settings based on the current date. This primarily inactivates employees once the pay period in which they were made inactive has been processed and paid but also determines the current employee settings for the date based settings provided as part of the employee’s history. Recommended as a daily task.
* X - issues the exit application message to all users.
* XO - issues the exit application message to all users including when the application is offline.

==See Also==
*[[System Configuration]]

*[[Installation]]

Tapcheck Export

2023-10-25T22:01:20Z

Joel:

This report will create csv files in the Tools/Export Folder that can be used for Tapcheck. To have these files uploaded automatically to the Tapcheck SFTP, add the custom configuration "TapcheckExportUploadToSFTP" as true. Tapcheck uses the same login for all sbv clients so login info is not required from the client.

Single facility software: The export file will be named with the facility's software license name.

Multi facility software: Use one saved report for the whole software. It will automatically create a separate export file for each facility. Each file will be named with the facility's labor level description.

The below fields will go in the file:

* Facility: For a single facility it will fill in the software license name. For a multi facility it will fill in the facility labor level description.
* Employee ID:
* Date: Pay Date.
* In: In Punch.
* Out: Put Punch.
* Hours: (All Add-to-Total pay types including Vac, Sick etc.. Does not include pay types excluded from payroll).

Run/save the Tapcheck Export report (Reports-->File Export-->Tapcheck Export) for In-House employees only as it's only for payroll employees.
Date range should be current pay period and prior 1. If the software/facility has multiple pay periods then use current day and prior 28. Schedule this to run every day.
Make sure when testing that the file is being uploaded from the software/schedule Tasks that you are on the server where the software is installed. This is because your local machine can be blocked by the firewall, while the server is whitelisted.

Employees that are set on their misc tab to be excluded from payroll will also be excluded from this export.

Exception Types Configuration

2023-10-23T17:59:31Z

Joel: /* Exception Types */

{{Advanced}}

==Exception Types==

[[File:ExceptionTypes.png]]

Exception types come built-in with the exceptions that are needed by the system. Additional exception types can be added.

''Exception Type ID'' – the identifier for the exception type, typically the initials of the description.

''Description'' – the description, if changed, must still be descriptive of the actual exception type for the built-in exception types. For example, the Late In exception type could be renamed to Tardy In.

''Display In Attendance Calendar'' – exceptions of this type will display appear in the Attendance Calendar reports.

- No Calculated Hours: Employee has an in and out punch and the in and out punch both pick up a schedule and there are no hours that have the same shift and actual date as the punch shift and the punch schedule date.

== See also ==

* [[Configuration]]

Employee Miscellaneous

2023-09-27T17:43:57Z

Joel:

[[image:EmployeeMiscellaneousTab.png]]

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

[[image:EmployeeMiscellaneousTabPage.png]]

''Payroll ID'' – an alternate ID used by your payroll or another external system. This ID can appear on any report. (For the payroll exports it's currently only implemented for David Klein 2, David Klein 3, and Charts).

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

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

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

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

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

The other settings shown here are examples of custom settings.

== See also ==

* [[Employee]]

Employee Miscellaneous

2023-09-27T17:43:31Z

Joel:

[[image:EmployeeMiscellaneousTab.png]]

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

[[image:EmployeeMiscellaneousTabPage.png]]

''Payroll ID'' – an alternate ID used by your payroll or another external system. This ID can appear on any report. (For the payroll exports it's currently only implemented for David Klein 2, David Klein 3 and Charts).

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

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

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

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

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

The other settings shown here are examples of custom settings.

== See also ==

* [[Employee]]

Employee Import

2023-09-19T14:44:19Z

Joel:

The employee import allows you to add or update existing employee information. You can use the Employee Detail (Excel) report as a starting point by exporting the existing employee information.

Employees are added if “Add Employee If Not Found” is checked off in the Options tab on the Import form. Other options are “Only Update Empty Fields” which enables the import to fill in empty information, while leaving existing information. The “Effective Date” field is used for changes that appear in the [[Employee History]] tab.

An employee import is identified by the sheet name or file name containing the word "Employee".

{| class="wikitable"
|-
! Column Type
! Identifiers
! Notes
! Required

|-
| Employee Identifier
| Employee ID, Emp ID, ID, Employee Number, Clock_ID, Payroll_ID, SSN_ID
| This is used to uniquely identify the employee. Note the distinction with the clock ID, SSN, and Payroll ID fields is the “_”. With a multi-facility configuration you must also provide the Facility column.
| Yes

|-
| New Employee ID
| New Employee ID, New Emp. ID, New Emp ID, New Employee Number
| The employee’s ID will be changed to this new ID
| No

|-
| Payroll ID
| Payroll ID
| The payroll ID is in the Misc tab. If you are wanting to use the Payroll ID as the employee identifier then use “Payroll_ID”.
| No

|-
| PBJ ID
| Payroll Based Journal ID
| The PBJ ID is in the Misc tab. The PBJ ID is used when you have previously submitted information to CMS using another ID. Please note that PBJ ID will NOT work.
| No

|-
| First Name
| First, First Name
| Main tab
| No

|-
| Initial
| Initial, Middle Name
| Main tab
| No

|-
| Last Name
| Last, Last Name
| Main tab
| No

|-
| Tag
| Tag
| Main tab
| No

|-
| Scheduler Tag
| Scheduler Tag, Sch Tag, Sch. Tag
| Scheduling / Other tab
| No

|-
| Labor levels
| The ID or name of the labor level, e.g. Department
| The labor level ID, labor level description or the scheduler ID, e.g. Office
| No

|-
| Pay Rule
| Pay Rule
| Main tab
| No

|-
| Base Schedule Group
| Schedule, Base Schedule, Base Schedule Group or Schedule Group
| Main tab
| No

|-
| Holiday Group
| Holiday Group
| Main tab
| No

|-
| Accrual Group
| Accrual Group
| Main tab
| No

|-
| History Table Effective Date
| Effective Date, Employee History Effective Date
| Can be used to import an effective date on the Employee History table for the following items: Labor Levels, Pay Rules, Base Schedule Groups, Holiday Groups and Accrual Groups. Should be used when importing a different effective date for each employee. If effective date is the same for all employees, just use the effective date field on the options tab of the import window. If effective date is not not provided for an employee it will use the import options effective date for that employee.
| No

|-
| Clock ID
| Clock ID
| Clock Info tab. If you wanting to use this as an employee identifier then use “Clock_ID”
| No

|-
| HandPunch Supervisor
| HandPunch Supervisor, Supervisor
| Clock Info tab
| No

|-
| Active Date
| Active Date, Active Pay Date, Active Status Date, Active Status Pay Date
| Adds an Active status entry to the Employee Status History using the date value in the column but only if the employee doesn't have any status at all in the software.
| No

|-
| Inactive Date
| Inactive Date, Inactive Pay Date, Inactive Status Date, Inactive Status Pay Date
| Adds an Inactive status entry to the Employee Status History using the date value in the column. It will add the Inactive status regardless of any statuses that the employee already has in the software.
| No

|-
| Shift Date
| Shift Date, Shift Pay Date
| Adds an employee shift history entry in the Work Pattern tab if the employee has no current shift history, or updates the employee shift history of the same date. The following two columns must also be supplied: Shift Count and Daily Hours. Shift and Shift Type are optional columns and will be automatically filled out based on default settings.
| No

|-
| Shift Count
| Shift Count
| See Shift Date information above
| No

|-
| Daily Hours
| Daily Hours
| See Shift Date information above
| No

|-
| Shift
| Shift
| See Shift Date information above
| No

|-
| Shift Type
| Shift Type
| See Shift Date information above
| No

|-
| Work Pattern Date
| Work Pattern Date, Work Pattern Pay Date
| Adds an employee work pattern entry in the Work Pattern tab. The following column must also be supplied.
| No

|-
| Work Pattern Type
| Work Pattern Type
| Use the values as in the drop down on the Work Pattern tab
| No

|-
| Social Security Number
| Social Security Number, SSN
| Employment / General tab. If you are wanting to use this as an employee identifier then use “Social Security Number_ID” or “SSN_ID”
| No

|-
| Union Date
| Union Date
| Employment / General tab
| No

|-
| Birth Date
| Birth Date
| Employment / General tab
| No

|-
| Address 1
| Address, Address 1
| Contact Info tab
| No

|-
| Address 2
| Address 2
| Contact Info tab
| No

|-
| City
| City
| Contact Info tab
| No

|-
| State
| State
| Contact Info tab
| No

|-
| Zip
| Zip
| Contact Info tab
| No

|-
| Emergency Contact Name
| Emergency Contact, Emergency Contact Name
| Contact Info tab
| No

|-
| Emergency Contact Phone Number
| Emergency Contact Phone Number, Emergency Phone Number, Emergency Phone
| Contact Info tab
| No

|-
| Emergency Contact Relationship
| Emergency Contact Relationship
| Contact Info tab
| No

|-
| License Type 1
| License Type, License Type 1
| Licensing tab - an exact match to what is displayed in the dropdown must be provided
| No

|-
| License State 1
| License State, License State 1
| Licensing tab - State name or Abbreviation
| No

|-
| License Number 1
| License Number, License #, License Number 1, License #1
| Licensing tab
| No

|-
| License Expiration Date 1
| License Exp, License Exp., License Exp Date, License Exp. Date, License Expiration Date, License Exp 1, License Exp. 1, License Exp Date 1, License Exp. Date 1, License Expiration Date 1
| Licensing tab
| No

|-
| License Issued Date 1
| License Issued, License Issued 1, License Issued Date, License Issued Date 1
| Licensing tab
| No

|-
| License Type 2
| License Type 2
| Licensing tab - an exact match to what is displayed in the dropdown must be provided
| No

|-
| License State 2
| License State, License State 2
| Licensing tab - State name or Abbreviation
| No

|-
| License Number 2
| License Number 2, License # 2
| Licensing tab
| No

|-
| License Expiration Date 2
| License Exp 2, License Exp. 2, License Exp Date 2, License Exp. Date 2, License Expiration Date 2
| Licensing tab
| No

|-
| License Issued Date 2
| License Issued 2, License Issued Date 2
| Licensing tab
| No

|-
| CPR Expiration Date
| Cpr Exp, Cpr Exp., Cpr Exp Date, Cpr Exp. Date, Cpr Expiration Date
| Licensing tab
| No

|-
| Physical Received Date
| Physical Received Date
| Health tab
| No

|-
| Physical Due Date
| Physical Due Date
| Health tab
| No

|-
| PPD History Positive
| PPD History, PPD Positive, Positive PPD, PPD+
| Health tab
| No

|-
| PPD Received Date
| PPD Received Date
| Health tab
| No

|-
| PPD Due Date
| PPD Due Date
| Health tab
| No

|-
| CXR Received Date
| CXR Received Date
| Health tab
| No

|-
| CXR Due Date
| CXR Due Date
| Health tab
| No

|-
| TB Screen Received Date
| TB Screen Received Date
| Health tab
| No

|-
| TB Screen Due Date
| TB Screen Due Date
| Health tab
| No

|-
| Measles Not Applicable
| Measles Not Applicable
| Health tab
| No

|-
| Measles Received Date
| Measles Received Date
| Health tab
| No

|-
| Rubella Received Date
| Rubella Received Date
| Health tab
| No

|-
| Influenza Date
| Influenza Date
| Health tab
| No

|-
| Influenza Type
| Influenza Type
| Employment tab. Use "Not" for Not Received, "Received" for Received, "Facility" for Received Out of Facility, and "Declined" for Declined.
| No

|-
| I9 List A Document Type
| I9 List A Document Type
| Employment tab
| No

|-
| I9 List A Document ID
| I9 List A Document ID
| Employment tab
| No

|-
| I9 List A Expiration Date
| I9 List A Expiration Date
| Employment tab
| No

|-
| I9 List B Document Type
| I9 List B Document Type
| Employment tab
| No

|-
| I9 List B Document ID
| I9 List B Document ID
| Employment tab
| No

|-
| I9 List B Expiration Date
| I9 List B Expiration Date
| Employment tab
| No

|-
| I9 List C Document Type
| I9 List C Document Type
| Employment tab
| No

|-
| I9 List C Document ID
| I9 List C Document ID
| Employment tab
| No

|-
| I9 List C Expiration Date
| I9 List C Expiration Date
| Employment tab
| No

|-
| Gender
| Gender
| M/F, Male/Female
| No

|-
| Race
| Race
| Partial matching is used so if the cell contains any of the following text then it will match: white, caucasian, black, african, asian, pacific, hawaii, hispanic, latin, native, alaska, indian
| No

|-
| EEOC Category
| EEOC, EEOC Category
| Partial matching is used so if the cell contains any of the following text then it will match: admin, prof, tech, service, sales, executive, first, mid
| No

|-
| CHRC Prints Submitted Date
| CHRC Prints Submitted, Prints Submitted
| Criminal History Record Check
| No

|-
| CHRC Response Received Date
| CHRC Response Received, Response Received
| Criminal History Record Check
| No

|-
| CHRC Notes
| CHRC Notes
| Criminal History Record Check
| No

|-
| CHRC Not Applicable
| CHRC Not Applicable
| Criminal History Record Check
| No

|-
| Employee Contact
| The Employee Contact Type
|
| No

|-
| Employee Custom
| The Employee Custom Type
|
| No

|}

Clear Out Fields - some of the fields above can be cleared/deleted by using the word <delete> in a cell (in lowercase). This will make the field blank and clear out any info that was already there.

== See also ==

* [[Import]]