sbv.wiki - User contributions [en]

Custom Configuration

2021-01-18T17:17:01Z

Stage: /* 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
|

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

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

|}

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

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

|-
| 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 more fine grained approach than the accrual group provides.
| AccrualNoMaximumContributingMinutes
| 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

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

|}

Accrual Adjustment Import

2021-01-04T15:49:40Z

Stage:

The accrual adjustment import adds an adjustment to the accrual balance.

An accrual adjustment import is identified by the sheet name or file name containing the words "Accrual Adjustment".

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

|-
| Accrual Pay Type / Hours
| Accrual Pay Type ID
| The column header identifies the accrual pay type. The data in each row represents the starting balance for the accrual pay type. To import into Bank 2, add a " 2" to the column header, e.g. "SICK 2".
| Yes

|-
| Pay Date
| Date, Pay Date
|
| Yes

|-
| Adjustment Type
| Type
| Values for this column could be any of these 4 adjustment types with the necessary identifier in quotes. Starting-Balance: "balance", Hours Earned: "earned", Hours Used: "used" and Maximum Balance: "maximum".
| Yes

|-
| Note
| Note
|
| No

|}
== See also ==

* [[Import]]

Custom Configuration

2020-12-23T01:40:26Z

Stage: /* Pay Types */

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

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

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

|}

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

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

|-
| Employee accrues as if worked the number of hours in their shift history
| AccrueAtShiftCountTimesDailyHoursLevel
| 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

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

|}

Internal SekureID Communication

2020-07-04T15:43:03Z

Stage: /* Resend Time Logs */

This document an internal document for SBV to troubleshoot communication issues with SekureID clocks.

Typically, the client will notify SBV that punches are not showing in the software. Please be aware that a clock could be sending new punches, but there was an issue within the last few days and although the clock has now reconnected, these older punches are not appearing. This issue can also manifest as new employees not appearing in the clock because the clock is sending information but is not receiving information. Before getting the client involved you need to determine if there is (or was) a communication issue. For example, if tasks were not running then punches will not be in the software. Punches could also be unassigned and not on the time cards.

You will be using the SekureID utility and advanced troubleshooting can use SQL Server Management Studio. Avoid using queries that are SELECT * and instead use TOP N where N is the number of records that you need and use ORDER BY so that the information you are looking for appears first.

[[File:sekureidshortcut.png|100px]]

You will always want to select the Company (#1) and the Serial Number (#2) that you are troubleshooting.

[[File:sekureidutility.png|600px]]

==Review Logs==

From the Communication / Time Logs tab, click on Get Latest Punch Received button (#3). This is equivalent to this SQL:

<nowiki>
SELECT TOP 1 * from TimeLog where SerialNumber = 'serial number' ORDER BY LocalPunchDateTime DESC</nowiki>

Another query that can be helpful is:

<nowiki>
SELECT TOP 100 * from TimeLog where SerialNumber = 'serial number' ORDER BY LogID DESC</nowiki>

but when a clock has been reset, the LogID of the latest punch can be less than the highest LogID ever used in that clock.

The punch date and time will be displayed and whether it has been processed by the software. You can also click on Get Latest Processed Punch Received (#4) to see what the latest punch in the software should be. This is equivalent to this SQL:

<nowiki>
SELECT TOP 1 * from TimeLog where SerialNumber = 'serial number' AND Processed = 1 ORDER BY LocalPunchDateTime DESC</nowiki>

If there is a significant time gap between these 2 punches then the software may not be processing the punches. See the Software Not Processing section.

Even if it is confirmed that the latest punch received is the latest punch made on the time clock, you will still check to see when the clock last communicated to the server. Click Get Latest Device Connection Changed Log (#5) and note when this was. Now click Request Connection Status From Single Clock (#6), wait a few seconds, then click Get Latest Device Connection Changed Log (#5) again. If the clock displays a log that indicates that it was just created and the value is true then the clock is communicating and responding. Refer to the Resend Time Logs section as the clock is communicating but the punches are not up to date. If there was no change from the first and second log, or the logs always have a false value then the clock is not communicating.

The equivalent SQL is:

<nowiki>
SELECT TOP 1 * FROM AdminLog WHERE SerialNumber = 'serial number' AND MessageType = 'DeviceConnectionChanged' ORDER BY CreatedDateTime DESC</nowiki>

==Client Involvement==

Once it is determined that the clock is not communicating and that there are no recent punches, we now need to involve the client.

Ask the client is if there are any X’s on either of the icons in the top right corner of the time clock's main screen. You can refer to this [[Fingerprint_Connection_Issues|page]]. Multiple reboots or removing the power for a few minutes and plugging back in may also need to be done by the client.

If after rebooting there are no X’s, punches will start to upload and you can use the Get Latest Punch Received button to confirm this. There may be a need to resend punches if the clock was offline for a long time. Refer to the Resend Time Logs section.

==Resend Time Logs==

A clock can be instructed to resend punches. This uses the GMT Time and a maximum time span of 24 hours. Punches that are already sent will not be duplicated, but there is nothing to be gained from resending punches that have already been received.

After the client reboots you can look at the TimeLog and determine if new punches are being received. By looking at the LogID and CreatedDateTime columns you can determine if there is a gap in the LogIDs at the point that punches started coming into the software. Using this SQL, scroll down to the records where the new punches were receieved.

<nowiki>
SELECT TOP 1000 * from TimeLog WHERE SerialNumber = 'serial number' ORDER BY LocalPunchDateTime DESC</nowiki>

In this example, there is no gap in the LogIDs.

[[File:PunchesAfterReboot.png]]

Another way to determine if there is a gap is to use the row number and compare the LogID at 2 different places:

In this example, LogID of 26619 is in row number 428. The expectation is that at row number 28, the LogID should be 26619 + 400.

[[File:LogIDCreatedDateTime1.png]]

And scrolling up to row number 28 we see that the LogID is 27019. This confirms that there is no gap from the first TimeLog received after the reboot to the more recent punches made at the time clock.

[[File:LogIDCreatedDateTime2.png]]

==Removing Session from the Hive (Advanced)==

If the admin response is true and resending time logs was unsuccessful then removing the HiveMQ session may resolve the issue. Keep in mind, this is VERY rare and does not happen often so this is a “last result” thing to do. Doing this will not do any harm but shouldn't be done until you have exhausted all other possibilities.

Open a browser on SBV26 and go to http://localhost:8080

Enter the username of "admin" and enter the password of "hivemq".

Click on Clients on the left-hand side of the page and under Client ID, type in the serial number of the clock you are having an issue with.

[[File:hive.png|600px]]

Once you have the client open, you will see an option that says Remove Session. Click on that and click Yes to the question that it asks. Redo the admin and time log steps.

[[File:removesession.png|600px]]

==Final Troubleshooting (Advanced) ==

If after multiple reboots and removing the HiveMQ session, there is still no communication then it could be a firewall issue. You will need to get IT involved. The clocks communicate on port 8883. As the clocks generally use DHCP then any device specific rules will need to use the MAC address which is found under menu / Settings / About device.

==Software Not Processing==

Search for locks using the SQL Server Management Studio on the server that the client's software is located on using the following query;

<nowiki>
SELECT * FROM Lock</nowiki>

[[File:sqllock.png|600px]]

In the column that says LockableObjectType, you will have two types of numbers. One will be 134 and one will be 10. The 134 means that someone, either the automatic polling or a user is polling the one or multiple time clocks. The 10 is the task that processes the punches which makes a clock punch into a punch on the employee's time card.

Look at the LockDateTime column to see when the lock was actually taken. If it was within the last few minutes then chances are it is the automatic polling and processing from the task scheduler. If it was more than a few hours ago then it could be when the software doing the overnight task it lost connection or communication to the clock and it created a lock which holds for about 12 hours. In order to release this lock you can copy and paste the query below into SQL.

<nowiki>
DELETE FROM Lock where PkLockID = "The ID of the lock you want to release"</nowiki>

[[File:deletelock.png|600px]]

If we have latest punches and they are processed then there is no issue – we give client an example “We see punches, e.g. # 12345, is there a specific employee that you do not see punches for?” as it could be that they didn’t check since the punches came in.

If we have latest punches and they are not processed (there is a ‘0’ under the Processed column) then resolution is in the software, e.g. lock on processing, or lock on employee – “the clock is communicating successfully. The punches had not been processed onto the time cards”.

==Case Studies==

This is a record of actual communication issues and how they were resolved. These case studies will use 4 markers:
* Local Network / Wifi status on clock - Y = clock shows as connected to the network
* Database icon status on clock - Y means there is NOT an X on the database icon
* Request Status - Y means we are getting a response from the clock
* HiveMQ session - Y means that the session shows as connected

7/2/2020 - New Grove Manor - initial status YNNN - removing disconnected session changed nothing - client rebooted clock - now status is YYYY. All punches came in without needing to resend. Conclusion reached - database shows not connected = HiveMQ disconnected.

7/4/2020 - CareCore at Lima - initial status YYNY - Last punch received 6/28 2:04 PM (LogID 26619) - HiveMQ shows Connected Since 7/1 08:19 - removed session and disconnected client, in both cases the HiveMQ session went back to connected but still no response from the clock - despite sending requests the Offline Message Queue Size was still zero so it looks like messages are being sent and not being received - also tried a company change. Will have them reboot. After reboot all punches came in without any resend required. Conclusion reached - database icon shows connected = HiveMQ connected but Request = false still requires a reboot.

Internal SekureID Communication

Stage:

The hours import allows you to add hours or amounts to the employee’s time card.

An hours import is identified by the sheet name or file name containing the word "Hours".

{| 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, Date
|
| Yes

|-
| Pay Type / Hours
| The pay type ID
| The column header identifies the pay type. The data in each row represents the number of hours or the amount for the pay type. Please note that the Pay Type ID, the Pay Type Description and the Pay Type Payroll Code # 1 will all be used to find the pay type. Please ensure you use an identifier that will UNIQUELY identify the pay type. To identify that you want to import amounts, format the cell such that it starts with a $ sign. The Currency or Accounting formats will do this.
| Yes

|-
| Shift
| Shift
| Use the Shift ID for the data in this column. If this column is not provided then the shift based on the employee's shift history for the pay date is used.
| No

|-
| Hours Comment
| Comment
|
| No

|}

== See also ==

* [[Import]]

2020-04-06T18:12:05Z

Stage: /* Biometric Issues */

[[image:HandPunch.png|right]]

== Punching issues ==

At some point you may encounter employees having issues punching at the HandPunch. Issues at the HandPunch can be categorized as being biometric or non-biometric. Non-biometric issues are easiest to diagnose because the employee is not asked to place their hand.

After the employee enters their clock ID and presses Enter, the HandPunch should display '''PLACE HAND''' in the display. If the HandPunch beeps twice and the display returns to '''ENTER ID''' then the clock ID entered by the employee is NOT in the HandPunch. Reasons for this may be:

* The employee has not been enrolled

* The employee is mistakenly using a number that is different from the number that they were enrolled with

* The employee is not assigned to this time clock in their [[Employee Clock Info|Clock Info]] tab

* The employee is [[Employee Status|inactive]] in the software and so the software is removing their clock ID from the HandPunch

* The employee was enrolled with a clock ID that was previously used by an employee that is inactive and so the software is removing their clock ID from the HandPunch

* The clock is full and so not all employees that are assigned to the clock are able to be stored in the clock

If the HandPunch displays '''TIME RESTRICTION''' then the clock ID entered by the employee is in the HandPunch but the employee is restricted from punching. Reasons for this may be:

* The employee is in a restricted work pattern type (Work Pattern tab) and the employee is trying to punch outside of the allowable punching zone. The punching zone is determined by the employee's schedules (Schedules tab)

* The employee is in a punching zone (Clock Info tab) and they are trying to punch outside of the punching zone

== Biometric Issues ==

If the HandPunch displays '''PLACE HAND''' after the employee enters their clock ID and presses enter, but the HandPunch displays '''TRY AGAIN''' after placing their hand and eventually says '''TEMPORARILY INVALID''', these are the items that you can check:

* Is the issue limited to this employee, to a few employees, or to most employees? If you as the supervisor can punch and you are getting a '''SCORE''' in the same range that you normally get then this would indicate that the issue is isolated.

* Is the employee using the correct clock ID? If the employee is using the incorrect clock ID but this clock ID belongs to another employee, then it is not a biometric issue at all (in fact the HandPunch is doing exactly what it should be doing - eliminating buddy punching).

* Is the employee using the correct hand placement. This is critical to successful punching. The hand should be placed flat on the platen, with the fingers touching the pins. If a red light is on, then the person punching is not touching that pin with their finger.

* Is the wrist visible when punching? If the wrist is not visible then clothing might block the camera from successfully scanning the hand.

* Has something changed about the employee's hand? Although the HandPunch adapts to small changes in the hand such as weight loss or gain, major changes such as lengthened or shortened nails may require the employee to be re-enrolled.

* If the employee is getting '''TEMPORARILY INVALID''' when they try to punch, another employee or yourself needs to punch first before this employee can punch again. If they can now punch successfully then there is nothing to do.

* If the employee still has an issue, then you should [[HandPunch Enrollment|remove and re-enroll]] the employee.

* Some employees will be what is known as a "bad puncher" in that they are very inconsistent in their use of the HandPunch. You can raise the Threshold in the [[Employee Clock Info|Clock Info]] tab in the range of 200 to 250.

* If the employee cannot punch because they cannot place their hand flat and make the lights go out (injury, something about their hand limits their movement, missing finger) then you will need to use the No Biometric Verification option in the employee's [[Employee Clock Info|Clock Info]] tab.

== HandPunch Issues ==

If the issue with enrolling is not limited to a few employees then it could be the HandPunch that is causing the issues:

* The HandPunch needs to be kept clean. See [[HandPunch Maintenance]] for maintenance and cleaning instructions. If the platen, or the mirror, or the area above the hand is not clean then this can affect all employees.

* Removing the power to the HandPunch for 10 seconds then plugging back in should next be done. You may need the key so as to be able to remove the power from the back of the HandPunch, if the access to the power supply is not easily obtained.

* Get the calibration from the HandPunch by pressing the No (*) key 11 (eleven) times. The calibration will show in the top line of the display such as r0 c-1 e123 s. The numbers to the right of the r and the c should be either -1, 0 or 1.

== Warm Boot / Cold Boot ==

* ''Warm Boot'' - a warm boot of the HandPunch is performed by removing the power and then plugging back in. It does not delete any hand or punch information from the HandPunch. The camera will recalibrate when powering up so this may resolve a biometric issue.

* ''Cold Boot'' - a cold boot of the clock is performed by removing the power and then plugging back in while the reset switch is held down.

== Re-enrollment Issue ==

Please note that the hand templates are typically distributed between all of your HandPunches once an hour. There is a small chance that during the re-enrollment process, you may remove a person from the HandPunch while the hands templates are being distributed back to the HandPunch and by the time you get back to the '''ADD EMPLOYEE''' menu, the hand template of the person that you removed has now been restored back to the HandPunch. When you go to enroll, if the displays says '''SORRY, CAN'T ADD''', this indicates that the hand template has been restored. You will need to remove the employee again.

== Communication Issues==

Communication issues occur when the software cannot communicate to the HandPunch. These troubleshooting steps are for Ethernet communications. The Ethernet unit can be an external Ethernet unit (Lantronix UDS-1100), or an internal Ethernet unit.

=== Network Issue ===

You first need to establish if the communication error is network based, i.e. there is no communication to the Ethernet. The software error for network based issues is "Failed to get channel". If you are receiving the error from an email then the email will contain both the host name and the port number being used. If the error occurred when trying to communicate in the software then you can get the Ethernet address and port number from the [[Time_Clocks_Configuration#Ethernet|Ethernet]] tab in Time Clocks Configuration.

* Is the host name an IP address?

* If it is not then the HandPunch is remote to the software. At a command prompt use tracert to determine the IP address that the host name is resolving to. If it does not resolve then the host name has either not been updated, or the internet may be down at the remote location.

* Is the IP address a public IP address? If it is then the HandPunch is remote to the software.

* If it is not a public IP address then you will only be able to tell if it is a local address by comparing it to an address from a computer in the network where the software is. If it is not local then a WAN or VPN is being used.

The 3 options for the network connectivity are therefore:

# The HandPunch and the software are in the same network
# The HandPunch is in another network which is connected via a WAN or VPN. Check the WAN is up by pinging the other network's gateway?
# The HandPunch is in another network accessed through the other network's public IP address. In this scenario, port forwarding has been setup. Is the internet working at the remote location?

If you have access to the local network of the HandPunch then you should do a ping test, followed by telnet to the listening port. If these both work then there is no issue with local connectivity, so the issue is with the WAN / VPN or the port forwarding. A firewall may also be causing an issue on anything but the local network connectivity.

On the local network side, the following can be checked if you are using the external Ethernet Lantronix UDS-1100 (referred to as UDS):

* Does the UDS have power?

* Is the Link light lit on the UDS? If the Diagnostics light is flashing then this can indicate an issue with the UDS or the local network. Count the number of times that the Diagnostic light flashes between pauses. Refer to the [http://www.lantronix.com/pdf/UDS1100_UG.pdf#page=67 UDS manual]

* Power cycling the UDS might resolve issues if the network had been down and the UDS did not reconnect to the network

* Are users having issues connecting to other items on the network. If the network equipment that the UDS is connected to, is itself not connected to anything then you can have a Link light but still not be "on the network"

* If you take the UDS to a known good network cable, does the "Failed to get channel" error go away, and you know get COM_TIMEOUT?

On the local network side, the following can be checked if you are using the internal Ethernet:

Is the light on the Ethernet unit red or flashing yellow? This indicates that the Ethernet cable is not plugged in, or no network is detected.

=== HandPunch Issue ===

If you are not getting the "Failed to get channel" error then you are getting a COM_TIMEOUT error. This error means that there is a communication problem somewhere between the UDS and the HandPunch. This error is only typical with the external Ethernet. Check the following:

* Does the HandPunch have power?

* Is the HandPunch on the wall or looks like it had been knocked off the wall. It is possible that the cable is not connnected to the HandPunch

* The cable might also be detached at the UDS end (not likely but worth checking)

* You can power cycle the UDS for good measure

* The serial cable could be damaged. If you more than one HandPunch then you can swap 2 HandPunches and then depending on what HandPunch now is not communicating will help you determine if it is the UDS / cable or the HandPunch.

* The clock number may have been changed in the HandPunch (not likely but worth checking)

== See also ==

* [[HandPunch]]

HandPunch Troubleshooting

2020-04-06T18:10:17Z

Stage: /* Biometric Issues */

[[image:HandPunch.png|right]]

== Punching issues ==

At some point you may encounter employees having issues punching at the HandPunch. Issues at the HandPunch can be categorized as being biometric or non-biometric. Non-biometric issues are easiest to diagnose because the employee is not asked to place their hand.

After the employee enters their clock ID and presses Enter, the HandPunch should display '''PLACE HAND''' in the display. If the HandPunch beeps twice and the display returns to '''ENTER ID''' then the clock ID entered by the employee is NOT in the HandPunch. Reasons for this may be:

* The employee has not been enrolled

* The employee is mistakenly using a number that is different from the number that they were enrolled with

* The employee is not assigned to this time clock in their [[Employee Clock Info|Clock Info]] tab

* The employee is [[Employee Status|inactive]] in the software and so the software is removing their clock ID from the HandPunch

* The employee was enrolled with a clock ID that was previously used by an employee that is inactive and so the software is removing their clock ID from the HandPunch

* The clock is full and so not all employees that are assigned to the clock are able to be stored in the clock

If the HandPunch displays '''TIME RESTRICTION''' then the clock ID entered by the employee is in the HandPunch but the employee is restricted from punching. Reasons for this may be:

* The employee is in a restricted work pattern type (Work Pattern tab) and the employee is trying to punch outside of the allowable punching zone. The punching zone is determined by the employee's schedules (Schedules tab)

* The employee is in a punching zone (Clock Info tab) and they are trying to punch outside of the punching zone

== Biometric Issues ==

If the HandPunch displays '''PLACE HAND''' after the employee enters their clock ID and presses enter, but the HandPunch displays '''TRY AGAIN''' after placing their hand and eventually says '''TEMPORARILY INVALID''', these are the items that you can check:

* Is the issue limited to this employee, to a few employees, or to most employees? If you as the supervisor can punch and you are getting a '''SCORE''' in the same range that you normally get then this would indicate that the issue is isolated

* Is the employee using the correct clock ID? If the employee is using the incorrect clock ID but this clock ID belongs to another employee, then it is not a biometric issue at all (in fact the HandPunch is doing exactly what it should be doing - eliminating buddy punching)

* Is the employee using the correct hand placement. This is critical to successful punching. The hand should be placed flat on the platen, with the fingers touching the pins. If a red light is lit, then the person being enrolled is not touching that pin with their finger

* Is the wrist visible when punching? If the wrist is not visible then clothing might block the camera from successfully scanning the hand

* Has something changed about the employee's hand? Although the HandPunch adapts to small changes in the hand such as weight loss or gain, major changes such as lengthened or shortened nails may require the employee to be re-enrolled.

* If the employee is getting '''TEMPORARILY INVALID''' when they try to punch, another employee or yourself needs to punch first before this employee can punch again. If they can now punch successfully then there is nothing to do.

* If the employee still has an issue, then you should [[HandPunch Enrollment|remove and re-enroll]] the employee.

* Some employees will be what is known as a "bad puncher" in that they are very inconsistent in their use of the HandPunch. You can raise the Threshold in the [[Employee Clock Info|Clock Info]] tab in the range of 200 to 250.

* If the employee cannot punch because they cannot place their hand flat and make the lights go out (injury, something about their hand limits their movement, missing finger) then you will need to use the No Biometric Verification option in the employee's [[Employee Clock Info|Clock Info]] tab.

== HandPunch Issues ==

If the issue with enrolling is not limited to a few employees then it could be the HandPunch that is causing the issues:

* The HandPunch needs to be kept clean. See [[HandPunch Maintenance]] for maintenance and cleaning instructions. If the platen, or the mirror, or the area above the hand is not clean then this can affect all employees.

* Removing the power to the HandPunch for 10 seconds then plugging back in should next be done. You may need the key so as to be able to remove the power from the back of the HandPunch, if the access to the power supply is not easily obtained.

* Get the calibration from the HandPunch by pressing the No (*) key 11 (eleven) times. The calibration will show in the top line of the display such as r0 c-1 e123 s. The numbers to the right of the r and the c should be either -1, 0 or 1.

== Warm Boot / Cold Boot ==

* ''Warm Boot'' - a warm boot of the HandPunch is performed by removing the power and then plugging back in. It does not delete any hand or punch information from the HandPunch. The camera will recalibrate when powering up so this may resolve a biometric issue.

* ''Cold Boot'' - a cold boot of the clock is performed by removing the power and then plugging back in while the reset switch is held down.

== Re-enrollment Issue ==

Please note that the hand templates are typically distributed between all of your HandPunches once an hour. There is a small chance that during the re-enrollment process, you may remove a person from the HandPunch while the hands templates are being distributed back to the HandPunch and by the time you get back to the '''ADD EMPLOYEE''' menu, the hand template of the person that you removed has now been restored back to the HandPunch. When you go to enroll, if the displays says '''SORRY, CAN'T ADD''', this indicates that the hand template has been restored. You will need to remove the employee again.

== Communication Issues==

Communication issues occur when the software cannot communicate to the HandPunch. These troubleshooting steps are for Ethernet communications. The Ethernet unit can be an external Ethernet unit (Lantronix UDS-1100), or an internal Ethernet unit.

=== Network Issue ===

You first need to establish if the communication error is network based, i.e. there is no communication to the Ethernet. The software error for network based issues is "Failed to get channel". If you are receiving the error from an email then the email will contain both the host name and the port number being used. If the error occurred when trying to communicate in the software then you can get the Ethernet address and port number from the [[Time_Clocks_Configuration#Ethernet|Ethernet]] tab in Time Clocks Configuration.

* Is the host name an IP address?

* If it is not then the HandPunch is remote to the software. At a command prompt use tracert to determine the IP address that the host name is resolving to. If it does not resolve then the host name has either not been updated, or the internet may be down at the remote location.

* Is the IP address a public IP address? If it is then the HandPunch is remote to the software.

* If it is not a public IP address then you will only be able to tell if it is a local address by comparing it to an address from a computer in the network where the software is. If it is not local then a WAN or VPN is being used.

The 3 options for the network connectivity are therefore:

# The HandPunch and the software are in the same network
# The HandPunch is in another network which is connected via a WAN or VPN. Check the WAN is up by pinging the other network's gateway?
# The HandPunch is in another network accessed through the other network's public IP address. In this scenario, port forwarding has been setup. Is the internet working at the remote location?

If you have access to the local network of the HandPunch then you should do a ping test, followed by telnet to the listening port. If these both work then there is no issue with local connectivity, so the issue is with the WAN / VPN or the port forwarding. A firewall may also be causing an issue on anything but the local network connectivity.

On the local network side, the following can be checked if you are using the external Ethernet Lantronix UDS-1100 (referred to as UDS):

* Does the UDS have power?

* Is the Link light lit on the UDS? If the Diagnostics light is flashing then this can indicate an issue with the UDS or the local network. Count the number of times that the Diagnostic light flashes between pauses. Refer to the [http://www.lantronix.com/pdf/UDS1100_UG.pdf#page=67 UDS manual]

* Power cycling the UDS might resolve issues if the network had been down and the UDS did not reconnect to the network

* Are users having issues connecting to other items on the network. If the network equipment that the UDS is connected to, is itself not connected to anything then you can have a Link light but still not be "on the network"

* If you take the UDS to a known good network cable, does the "Failed to get channel" error go away, and you know get COM_TIMEOUT?

On the local network side, the following can be checked if you are using the internal Ethernet:

Is the light on the Ethernet unit red or flashing yellow? This indicates that the Ethernet cable is not plugged in, or no network is detected.

=== HandPunch Issue ===

If you are not getting the "Failed to get channel" error then you are getting a COM_TIMEOUT error. This error means that there is a communication problem somewhere between the UDS and the HandPunch. This error is only typical with the external Ethernet. Check the following:

* Does the HandPunch have power?

* Is the HandPunch on the wall or looks like it had been knocked off the wall. It is possible that the cable is not connnected to the HandPunch

* The cable might also be detached at the UDS end (not likely but worth checking)

* You can power cycle the UDS for good measure

* The serial cable could be damaged. If you more than one HandPunch then you can swap 2 HandPunches and then depending on what HandPunch now is not communicating will help you determine if it is the UDS / cable or the HandPunch.

* The clock number may have been changed in the HandPunch (not likely but worth checking)

== See also ==

* [[HandPunch]]