ADP InTouch User s Guide How to use and administer the ADP InTouch data collection device. Document Revision: C
The information in this document is subject to change without notice and should not be construed as a commitment by ADP, Inc. ADP is not responsible for any technical inaccuracies or typographical errors which may be contained in this publication. Changes are periodically made to the information herein, and such changes will be incorporated in new editions of this publication. ADP may make improvements and/or changes in the product and/or the programs described in this publication at any time without notice. This document or any part thereof may not be reproduced in any form without the written permission of Kronos Incorporated. All rights reserved. 2012 Kronos Incorporated. ADP provides this publication "as is" without warranty of any kind, either express or implied, including, but not limited to, the implied warranties of merchantability or fitness for a particular purpose. The ADP Logo, Enterprise etime and QuickPunch are registered trademarks of ADP, Inc. CardSaver, Kronos, Kronos InTouch, Kronos Touch ID, the Kronos logo, TeleTime, Timekeeper, Timekeeper Central, Workforce Accruals, Workforce Central, Workforce Genie, and Workforce TeleTime are registered trademarks of Kronos Incorporated or a related company. "Experts at Improving the Performance of People and Business," HyperFind, Kronos 4500 Touch ID, Kronos 4500, Schedule Assistant, Smart View, Workforce Activities, Workforce Attendance, Workforce Central Portal, Workforce Connect, Workforce Employee, Workforce Leave, Workforce Manager, Workforce Record Manager, Workforce Scheduler, Workforce Timekeeper, and Workforce Worksheet are trademarks of Kronos Incorporated or a related company. The source code for Equinox is available for free download at www.eclipse.org. When using and applying the information generated by Kronos products, customers should ensure that they comply with the applicable requirements of federal and state law, such as the Fair Labor Standards Act. Nothing in this Guide shall be construed as an assurance or guaranty that Kronos products comply with any such laws. FCC Compliance - After testing, this equipment complies with the limits for a Class A digital device pursuant to Part 15 of FCC Rules. These limits provide reasonable protection against harmful interference when this equipment is operated in a commercial environment. This equipment generates, uses, and can radiate radio frequency energy. If it is not installed and used in accordance with the instruction manual, it can cause harmful interference to radio communications. Operation of this equipment in a residential area is likely to cause harmful interference, in which case, the user, and not Kronos Incorporated, is required to correct the interference. In order to maintain compliance with FCC regulations, shielded cables must be used with this equipment. Operation with non-approved equipment or unshielded cables is likely to result in interference to radio and television reception. If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures: reorient or relocate the receiving antenna; increase the separation between the equipment and the receiver; connect the equipment into an outlet on a circuit different from that to which the receiver is connected; or consult the dealer or an experienced radio/tv technician for help. You may also find helpful the following booklet, prepared by the FCC: "How to Identify and Resolve Radio-TV Interference Problems." This booklet is available from the U.S. Government Printing Office, Washington D.C. 20402. FCC Notice (for U.S. Customers) - This device complies with Part 15 of the FCC Rules. Operation is subject to the following conditions: 1. This device may not cause harmful interference, and 2. This device must accept any interference received, including interference that may cause undesired operation. Caution: Changes and Modifications not expressly approved by the manufacturer or registrant of this equipment can void your authority to operate this equipment under Federal Communications Commissions rules.
Canadian DOC Compliance - This digital apparatus does not exceed the Class A limits for radio noise emissions from digital apparatus set out in the Radio Interference Regulations of the Canadian Department of Communications. This device complies with Industry Canada license-exempt RSS standard(s). Operation is subject to the following two conditions: (1) this device may not cause interference, and (2) this device must accept any interference, including interference that may cause undesired operation of the device. Cet appareil numerique respecte les limites de rayonnement de bruits radio electriques applicables aux appareils numeriques de classe A, prevues au Reglement sur le materiel brouilleur du ministere des Communications du Canada. Ce dispositif est conforme aux normes RSS sans licence d Industrie Canada. Son utilisation est soumise aux deux conditions suivantes : (1) ce dispositif ne peut pas provoquer d'interférence et (2) ce dispositif doit accepter toute interférence, y compris les interférences pouvant provoquer un mauvais fonctionnement du dispositif. EN 55022 (CISPR 22) - This product is a Class A product. In a domestic environment, it may cause radio interference in which case the user may be required to take adequate measures. RoHS Directive - ADP InTouch data collection devices and all hardware options currently qualified to work with these devices are designed in accordance with the European Union Restriction of the Use of Certain Hazardous Substances in Electrical and Electronic Equipment ("RoHS") Directive (2002/95/EC), taking effect July 1, 2006. The RoHS directive prohibits the sale of electronic equipment containing certain hazardous substances such as lead, cadmium, mercury, hexavalent chromium, polybrominated biphenyls ("PBB") and polybrominated diphenylethers ("PBDE") in the European Union. A program is in place to address the requirements of the RoHS Directive in respect to the various categories of electronic products. Published by ADP, Inc. Automatic Data Processing, Inc. One ADP Boulevard Roseland, New Jersey 07068 For more information, see the following ADP, Inc. Web page: http://www.adp.com Document Revision History Document Revision Product Version Release Date C ADP InTouch v1.0 May 2012 3
4
Contents Contents Chapter 1: Overview Introduction... 12 How ADP InTouch works... 13 How the device operates with the host application... 13 Cross-punching... 13 Modes of operation... 14 ADP InTouch features... 15 Labor tracking transactions... 15 Job tracking transactions... 16 Schedule enforcement... 19 Default transactions... 20 Transaction persistence... 20 Soft key schedules... 21 Language support... 22 Using badges... 24 Integrated readers... 24 Remote readers... 24 Navigation... 25 Home page... 25 Sample transaction page... 27 Numeric keypad... 28 Alphanumeric keypad... 29 Calendar... 30 Device status icons... 31 Battery backup... 31 Global Home Override... 31 Global Non-Home Override... 32 Low disk space... 32 Network communications error... 33 User s Guide 5
Contents System maintenance required...33 Uncollected offline QuickGlance transactions...33 Customizing the user interface...34 Adding a logo...34 Adding a screen saver...34 Adding a message...34 Chapter 2: Employee Mode Transactions Introduction...36 Biometric scanning...37 Standard transactions...39 Punch...39 Gate Entry...40 Work through Meal...40 Delayed Labor Transfer...41 Enter Tips...42 Labor Transfer...43 Job Transfer...44 Delayed Job Transfer...45 Edit Hours...46 Edit Money...47 Review Punches...48 Start Work Rule Transfer...49 End Work Rule Transfer...50 View Current Schedule...51 View Future Schedule...51 View Punch Status...52 View Totals...52 Call for Assistance...53 QuickGlance transactions...54 Approve Timecard (QuickGlance)...55 Justify Exception (QuickGlance)...56 New Request (QuickGlance)...57 Request for Time Off (QuickGlance)...58 Pay Code Edit Online (QuickGlance)...59 6
Contents View Accruals Online (QuickGlance)... 60 View Schedules Online (QuickGlance)... 60 View Timecard Online (QuickGlance)... 62 View Totals Online (QuickGlance)... 63 View Messages (QuickGlance)... 64 Enterprise Activities transactions... 65 Chapter 3: Manager Mode Transactions Introduction... 68 Accessing manager mode... 69 Using a Supervisor badge... 69 Using an Employee badge... 70 Biometrics... 71 Templates... 71 Terminology... 72 Lock, drop, and hold method... 73 Biometric verification... 76 Biometric identification... 86 Troubleshooting... 96 Unenroll Employee... 98 Standard transactions... 99 Add Punch... 99 View Gate Times... 100 Gate Override - Duration... 101 Gate Override - Employee... 101 Cancel Gate Override... 102 Change Password... 102 Delete Punch... 103 View On or Off Premises Employees... 103 Global Home Override... 104 Global Non-Home Override... 105 Pay Code Move Amount... 106 View Bell Times... 107 Ring Bell... 108 Silence Bell... 108 User s Guide 7
Contents Single Home Employee Restriction Override...109 Single Non-Home Employee Restriction Override...110 View Employee Information...110 Biometric Templates Report...111 QuickGlance transactions...112 Pay Code Move Online (QuickGlance)...112 Schedule Override (QuickGlance)...113 Chapter 4: Maintenance Mode Functions Introduction...118 Initial setup and configuration...119 Required settings...119 Optional settings...121 Completing the setup...122 Maintenance mode functions...123 Accessing and exiting maintenance mode...123 Cleaning the touchscreen...124 Settings...125 Date and Time...125 Communication Settings...126 Audio...132 Display...132 Remote Access...132 Bar Code Symbology...133 Remote Readers...134 VoIP Settings...134 Advanced...136 Failure Override...136 Employee Enroll Count...137 Non-Enrolled Employees...137 Restart Terminal...137 Change Maintenance Mode Password...138 Remote Debug Mode...139 Factory Defaults...139 Delete All Punches...140 8
Contents Restore HTTP (non-ssl)... 140 Biometric Verification... 141 Biometric Enrollment Tutorial Video... 142 Calibrate Touchscreen... 142 Reports... 144 Software report... 144 File Systems report... 144 Database report... 145 Hardware report... 145 Communication Settings report... 146 Network report... 146 Device Status report... 146 Memory report... 147 Ethernet report... 147 Readers report... 148 Biometric report... 148 Tests... 150 Sequential test... 150 Communications test... 150 Integrated Badge test... 151 Display test... 152 Tone test... 152 LED test... 153 GPIO Output Bits test... 154 Monitor GPIO Inputs test... 154 Microphone test... 154 Remote Badge test... 154 Chapter 5: Error Messages and Troubleshooting Error messages... 156 Troubleshooting... 164 Using the device... 164 Using a remote PC... 167 Using the device management application... 167 Restarting devices... 168 User s Guide 9
Contents 10
Chapter 1 Overview This chapter contains the following sections: Introduction on page 12. How ADP InTouch works on page 13. ADP InTouch features on page 15. Using badges on page 24. Navigation on page 25. Device status icons on page 31. Customizing the user interface on page 34. Note: If you are configuring the ADP InTouch for the first time, go to Initial setup and configuration on page 119.
Chapter 1 Overview Introduction ADP InTouch is a data collection device that communicates with the ADP host applications. The device collects information that employees enter using a badge reader, biometric device, or keypad. The host application software collects data from the devices to track and process labor-related data, generate management reports, and transfer information to the payroll service. ADP InTouch does the following: Enforces schedules, by controlling when specific employees can swipe in and swipe out for shifts, meals, and breaks. Displays accrued vacation, sick time, and messages to individual employees (depending on the host application). Provides touchscreen soft keys that enable users to perform transactions such as labor account transfers, pay code transactions, and QuickGlance transactions. The latter allow users to access and interact with current information that is not resident at the device. Note: This documentation refers to transactions by their default names. Your administrator can change these names to conform with your business practices. 12
How ADP InTouch works How ADP InTouch works How the device operates with the host application Administrators: Use the host application to configure employees and information such as schedules, punch restrictions, and labor accounts. The host application downloads this information to the device, which uses it to accept or restrict employee punches. When employees swipe their badges at the device, the punch information is stored in the database on the device. The host application collects the stored data and totals the hours, computes overtime, calculates wages, tracks labor, and generates reports. If the host application is Enterprise etime, use the device management application to define which transactions users can perform, and to monitor the data that the host application and device exchange. The device supports SSL encryption so that sensitive information about employees and their timecards is protected on the Internet. Cross-punching Cross-punching allows employees who are not assigned to a device (that is, nonhome employees) to punch at that device. Administrators: Use the device management application to enable the crosspunching feature for a device. Access the General Device Settings building block, and select Allow Non-Home Employees, on the Punch Rules tab. User s Guide 13
Chapter 1 Overview Modes of operation ADP InTouch operates in three modes: Employee Manager Maintenance Each mode has its own set of transactions, depending on the host application that your organization is using. Users require a specific type of badge (Employee, Manager, or Maintenance) to access each mode. Throughout this document, the terms manager and supervisor are used interchangeably. Employee mode The device most often operates in employee mode. It accepts punch data that employees enter using a badge reader or touch screen. For details about employee mode, see Employee Mode Transactions on page 35. Manager mode Manager mode allows authorized users to perform tasks such as editing employee punches, adding missed employee punches, and viewing employee information. For details about manager mode, see Manager Mode Transactions on page 67. Maintenance mode Maintenance mode allows authorized users to display technical information about the device, execute diagnostic tests, and define configuration settings. For details about maintenance mode, see Maintenance Mode Functions on page 117. 14
ADP InTouch features ADP InTouch features Labor tracking transactions Overview ADP InTouch can perform labor tracking transactions using labor accounts or cost centers, which are defined in the host application. Labor accounts comprise one or more labor levels, which are arranged hierarchically, and constitute a cost center. Examples include: programmer/software/engineering drill press operator/tooling/manufacturing Administrators: Specify what department or labor level information to send to each device. The two options are: Send all department or labor level entry information for all labor levels. Send one labor level set. A labor level set comprises specific groups of labor level entries for each labor level. If you configure the device to validate entries when employees perform labor account transfers, the device accepts only those labor level entries included in the labor level set. When employees swipe their badges, the system associates the punch and hours worked with their home (assigned) labor account unless they perform a transfer to another labor account. Labor account transfers Administrators: You can configure labor account transfers to work in the following ways: Set up the device to prompt for all labor levels or only specified labor levels. Assign a default entry or no entry to any of the labor level prompts that appear. Define a transaction to include a default labor level value that employees cannot change (there is no prompt for the labor level). User s Guide 15
Chapter 1 Overview Define a transaction that has no value for one or more labor levels. This option creates abbreviated labor level transfers that do not require employees to enter all labor levels. Prompts for these labor levels display no value. If an employee does not enter a value for the labor level, the timekeeping application searches for the last labor level entry that the employee transferred to, during the current shift. If there is no entry, the application uses the corresponding labor level entry in the employee s home labor account. Job tracking transactions Overview Job tracking allows an organization to track hours worked by location. It is available to organizations that use Enterprise etime as the host application. Unlike labor account tracking, which is payroll-oriented, job tracking is workoriented. A company can, however, implement both types of hours tracking in the system. A site can track employee hours by job. If the site maps jobs to its organizational hierarchy, the jobs are known as organizational jobs. For example, in a hospital, a registered nurse works a job titled RN1. If the site uses organizational jobs, it can add location information to the job title, such as Health Care/Hospital A/OR/RN1. Administrators: Use Enterprise etime to define jobs and assign each employee to a primary job (the job that the employee regularly performs). You can configure devices to allow employees to perform transfers to other jobs for which they are qualified. Job transfer sets Administrators: Use Enterprise etime to create and assign job transfer sets, which define the jobs that employees can transfer to. You can load each home employee s assigned job transfer set and other information to a device. 16
ADP InTouch features You can use the device management application to load a specific job transfer set to a device. A device job transfer set defines the jobs that employees can transfer to. This feature allows non-home employees to perform job transfers. It can also confine job transfers to jobs that are near the device. How job transfers and validation work Administrators: You can use the host application to configure devices to perform job transfers in the following ways: Configure soft keys to perform automatic job transfers, which are transfers to jobs that employees cannot change. Use this feature when employees who punch in at a particular device always transfer to the same limited number of jobs. Note: If employees are assigned to a job transfer set, the job associated with each soft key that performs a transfer must be part of that transfer set. Otherwise, the system rejects the job transfer. If employees are not assigned to a job transfer set and the device does not contain a job transfer set, the system rejects the job transfer. Configure a soft key to allow employees to initiate job transfers. In this configuration, employees select a job from their employee job transfer set or from a device job transfer set. At a single device, you can configure a soft key for each kind of job transfer automatic and employee-initiated. User s Guide 17
Chapter 1 Overview If employees are assigned to employee job transfer sets and the device is assigned to a device job transfer set, the jobs to which an employee can transfer depend on the configuration of the device: Type of job validation Type of employee Home Non-home By employee s assigned job transfer set only Can transfer only to jobs in their assigned job transfer set. Cannot perform a job transfer because the employee s assigned job transfer set is not sent to the device. By device job transfer set only Can transfer only to jobs in the device job transfer set sent to the device. Can transfer only to jobs in the device job transfer set sent to the device. By employee and device job transfer sets Can transfer only to jobs that are in both their assigned employee job transfer set and the device job transfer set sent to the device. Cannot perform a job transfer because the employee s assigned job transfer set is not sent to the device. Note: The system shortens the organizational job names in a transfer set, whenever possible. For example, a job transfer set contains the following jobs: Health Care/Hospital A/OR/RN1 Health Care/Hospital A/ICU/Ward/RN1 Health Care/Hospital A/Nursery/RN1 Because all of the job names contain Health Care/Hospital A/, the system shortens each name to include the last common part ( Hospital A ) and the remaining unique parts. The abbreviated list is: Hospital A/OR/RN1 Hospital A/ICU/Ward/RN1 Hospital A/Nursery/RN1 18
ADP InTouch features Employees can manually enter the names of jobs. If the name is not valid, however, the device does not accept the transaction. If a non-home employee performs a job transfer (that is, performs a crosspunch), the device cannot validate job entries unless it is assigned to a device job transfer set. Administrators: You can allow employees to perform both a job transfer and a labor level transfer in the same transaction. For example: If jobs are not mapped to labor level entries, set up the job transfer transaction to allow employees to transfer to a specific job and labor account. To track how grant funds are being used, configure a labor level to represent the grant. When employees swipe in, they perform a job transfer and a labor level transfer to the labor level entry that represents the grant. Schedule enforcement Administrators: To configure devices to validate employee punches against their schedules, use the device management application. The punch rules contain a setting that enables schedule enforcement. You can tailor the complexity of schedule enforcement to meet your business needs. Depending on your system configuration, the devices can do the following: Limit how early and late employees can punch in or punch out. Enable managers to perform punches for employees, and to override punch restrictions for employees. Prevent employees from punching in when they are not scheduled. Enforce meal and break schedules for employees, including minors, to satisfy state and federal labor laws. To configure a full array of punch restrictions for the device, see the appropriate documentation for Enterprise etime and Enterprise Scheduler (if installed). The system requires the latter application to enforce meal and break rules for employees. User s Guide 19
Chapter 1 Overview Default transactions Administrators: You can use the device management application to set up default transactions for ADP InTouch users. When an employee swipes a badge or enters a badge ID, the data collection device automatically initiates the transaction that you designate as the default. Default transactions include punches, labor account transfers, job transfers, and so on. If you can assign a transaction to a soft key, you can assign it to a badge swipe or badge ID entry as a default transaction. You can assign default transactions to home and non-home employees, and to local and remote readers. If you assign a default transaction to an internal reader, it also applies to the external reader. When the default transaction for a home employee s badge swipe is a punch, you can assign a different default transaction for a badge ID entry. For example, if a group of home employees routinely change job assignments when they start a shift, you can set the default transaction to a Job Transfer for a start-of-shift badge read. The types of default transactions are: Home employee default Home employee shift start Home employee IN during shift Home employee shift end Non-home employee default Transaction persistence If the host application is Enterprise etime, an administrator can configure it to repeatedly apply an employee s pay code edits and transfers to the employee s record, for each scheduled work day. The transaction persists until the employee or manager (on the employee s behalf) performs a punch, edit, or transfer at the device or using the host application. The repeating transaction generates amounts (for pay code edits) or punches (for transfers), based on the employee s daily schedule. 20
ADP InTouch features A pay code edit is persistent when both of the following are true: The employee is assigned to a schedule. Enterprise etime is configured to repeat the pay code edit on days that the employee works. A labor account transfer or work rule transfer is persistent when both of the following are true: The employee is assigned to a schedule. The employee s assigned pay rule is configured to repeat labor account transfers or work rule transfers on days that the employee works. If Enterprise etime automatically generates punches based on an employee s schedule, and a persistent transaction is in effect for that employee, the persistent transaction takes precedence. Soft key schedules Administrators: For each device, you can use the device management application to create soft key schedules, during which certain device transactions are not available to employees. For example, during periods when many employees punch in or punch out, you can de-activate the View Totals or View Current Schedule soft keys. Each soft key schedule can contain up to eight time intervals for each day of the week. User s Guide 21
Chapter 1 Overview Language support ADP InTouch devices include pre-installed, translated versions of the user interface and error messages. The devices currently support the following languages: English (U.S) French (France) French (Canada) Portuguese (Brazil) Spanish (Mexico) Dutch German Chinese (Simplified) Chinese (Traditional) Administrators: You can translate the user interface into other languages, or customize the text in any of the supported languages. For details, see the guide to using the ADP InTouch Translation and Customization Toolkit. Depending on which version of the device management application you are using, you can provide employees with access to one or more translated versions of the interface. For additional information, see the Enterprise etime System Administrator s Guide Device Manager. Single language support Administrators: If you are using Enterprise Device Manager 6.1.x, the device can display the interface in only one language. Select the language in: Setup > Device Manager Setup > General Device Settings > Device Interaction, and in Setup > Device Manager Setup > Soft Key Settings. 22
ADP InTouch features Multi-language support Administrators: If you are using Enterprise Device Manager 6.2.x, the device can display the interface in one or more of the supported interface languages. Select Setup > Device Manager Setup > Device Language Settings. You designate one of these languages as the default interface language. Assign the Device Language Settings to your General Device Settings and your Soft Key Settings. Note: The Device Language Settings do not control QuickGlance transaction pages. QuickGlance pages appear in the language specified in the Enterprise Device Manager server. Employees: To perform a transaction in a different language, select a language from the language bar. The home page and the subsequent transaction pages appear in the selected language. Complete and submit the transaction. The Employee home page reappears and reverts to the default language. Note: When a user who is in manager mode or maintenance mode chooses a different language, it remains in effect for all transactions during the current logon session unless the user selects another language. User s Guide 23
Chapter 1 Overview Using badges Integrated readers ADP InTouch is equipped with one of the following integrated or internal badge readers: HID Proximity EM Proximity MiFare Smart Card or iclass Smart Card Bar code Magnetic stripe If the device is equipped with a proximity reader, hold the badge within two inches of the target area (top right corner of the device). If the device is equipped with a bar code reader or a magnetic stripe reader, swipe the badge through the reader to perform transactions. If the device reads the badge successfully, the LED flashes green, and the speaker emits a tone. If the badge read is unsuccessful, the LED flashes red, the speaker emits a different tone, and an error message appears on the screen. Wait until the message times out or tap the X to close the message. Then re-attempt the badge read. Remote readers Remote or external readers (for example, Wiegand Proximity) are available, as an option. For more information, see your product representative. 24
Navigation Navigation Home page The following illustration is an example of the employee home page. Administrators: You can use the device management application to configure the employee or manager home page to display only the date and time. In addition, you can configure the size of the soft keys, how they are labeled, and the number of them that appear on each page. For more information, see the system administrator s guide for the device management application. Interface standards: Tap the blue arrows to scroll through the soft keys. The circles at the bottom of the page indicate the number of soft key screens. The blue-filled circle indicates which screen in the series you are viewing. Tap the appropriate soft key to perform the transaction. User s Guide 25
Chapter 1 Overview Depending on the how the device is configured, one or more languages can appear at the top right portion of the page, in the language bar. To perform a transaction in a language other than the default, tap the appropriate language (use the blue arrows to scroll through the list). See Multi-language support on page 23. The front of the device contains two keys. The Home key (bottom right) returns users to the respective employee mode, manager mode, or maintenance mode home page. The Menu key (bottom left) allows authorized users to access the following: Maintenance Mode: Opens the maintenance mode home page. Biometric Enrollment Tutorial Video: Runs an instructional video about how to enroll employees for biometric verification or identification. See Biometrics on page 71. Clean Touchscreen: See Cleaning the touchscreen on page 124. 26
Navigation Sample transaction page Interface standards: Task button colors: Yellow indicates the active task. Blue indicates a completed task, or one that is available. For example, in the previous illustration, you can tap the Edit Date or Edit Time soft keys to modify those entries. Gray indicates a task that you can access only if you complete a prerequisite task. Use the blue arrows below the task buttons to scroll through them. The menu on the right contains information related to the active task. Use the blue arrows to view the menu items. When you make a selection, the task button displays your choice with a check mark. Tap the keypad icon (bottom right) to access the keypad and enter text. User s Guide 27
Chapter 1 Overview Numeric keypad The Clear key clears your entire entry. 28
Navigation Alphanumeric keypad Interface standards: The Shift key works as a toggle. The Clr key clears your entire entry. The number on the right side of the text box indicates how many more characters you can enter. To close the keypad without saving, tap the X. User s Guide 29
Chapter 1 Overview Calendar Interface standards: The selected date is orange. The calendar defaults to the current date, which is outlined in black. If you tap another date, the current date remains outlined in black. Use the blue arrows to scroll through the months. 30
Device status icons Device status icons One or more status icons can appear below the logo on the home page. They provide information or indicate a problem that requires intervention by an administrator. Battery backup Indicates that the data collection device has lost power and is operating on battery backup. Check the plugs, connections, and so on. Global Home Override Indicates that a manager has performed the Global Home Override transaction, which overrides schedule and punch restrictions for home employees. This icon appears for the entire duration of the override. User s Guide 31
Chapter 1 Overview Global Non-Home Override Indicates that a manager has performed the Global Non-Home Override transaction, which allows non-home employees to punch at restricted times. This icon appears for the entire duration of the override. Low disk space Indicates that the disk free space has fallen below the low disk space threshold. When this condition occurs, the Compress Database feature automatically reclaims unused, allocated space within the embedded InTouch database. This process also results in freeing disk space, because it decreases the overall database file sizes. In addition, if InTouch detects a disk full condition, the Compress Database function automatically runs during the clean-up process. If the device is performing transactions slowly, compressing the database can improve performance when the issue is caused by database fragmentation. 32
Device status icons Network communications error Indicates that the device is failing to communicate with the device management application, or with a QuickGlance server, which can reside on a different machine. Check the Ethernet connections. System maintenance required Indicates that the average memory usage, CPU load, or both have exceeded the thresholds. Contact your administrator. Uncollected offline QuickGlance transactions Indicates that the Enterprise Activities server is down, and there are uncollected offline QuickGlance transactions. Contact your administrator to restart the server. User s Guide 33
Chapter 1 Overview Customizing the user interface For details about performing these tasks, see the system administrator s guide for the device management application. Adding a logo Administrators: Use the device management application to add your company logo to the home page. First, import your company logo to the device. Select Setup > Device Manager Setup > Import Device Logo Files. Then, add your logo by selecting Setup > Device Manager Setup > General Device Settings > Theme and Logo. Adding a screen saver Administrators: Use the device management application to add a screen saver URL to the device. To configure the URL and the wait time, select Setup > Device Manager Setup > General Device Settings > Device Interaction. You must also add the URL to the application s trusted servers list. Select Setup > Device Manager Setup > Trusted Servers List. Adding a message Administrators: Use the device management application to configure one or two messages to periodically appear at the bottom of the page. Select Setup > Device Manager Setup > General Device Settings > Device Interaction. 34
Chapter 2 Employee Mode Transactions This chapter contains the following sections: Introduction on page 36. Standard transactions on page 39. QuickGlance transactions on page 54. Enterprise Activities transactions on page 65.
Chapter 2 Employee Mode Transactions Introduction Use employee mode to perform activities such as a simple punch, a labor transfer, or a work rule transfer. When ADP InTouch is in employee mode (the default mode), you initiate a transaction by tapping the appropriate soft key. The following sections describe how to perform employee mode transactions. All procedures assume that you are using a badge. Note: At the conclusion of many transactions, a Review page appears. Tap Back to make changes, or tap Submit to save your data. The instructions in this chapter assume that you are ready to Submit; they do not explicitly mention the Back option, when it is available. For optional entries, such as Comment Code or Job, you can select <Leave Blank>. 36
Introduction Biometric scanning Data collection devices that include the ADP QuickPunch option can authenticate your identity based on a finger (or biometric) scan. This option offers two types of biometric scanning: biometric verification and biometric identification. Biometric verification requires you to swipe your badge or enter your badge ID before you scan a finger. Biometric identification requires you to perform only a finger scan. Before you can use biometric scanning to perform transactions, your manager must enroll you at the device. Managers: For details about enrolling employees for biometric verification or identification, see Biometrics on page 71. Administrators: The device management application controls the biometric policies for individual data collection devices. To enable non-home employees to perform biometric verification: Enroll employees at a device to which they are assigned. Enable cross-punching at selected devices that employees are not assigned to. Biometric identification employees cannot cross-punch. Standard transactions Standard transactions use information that resides at the device. For these transactions, the system requires home employees only, or home and non-home employees to perform biometric verification. Administrators: You cannot require employees to perform biometric scanning for only selected standard transactions. The device management application setting that enables biometric verification or identification applies to all standard transactions. If you disable this setting (Enable Biometric Identification), the device still requires employees to perform biometric scanning for transactions that change their in-status or out-status (for example, simple punches and labor transfers). User s Guide 37
Chapter 2 Employee Mode Transactions QuickGlance transactions QuickGlance transactions use information that resides on the host application database. Administrators: Use the device management application to enable biometric scanning for individual QuickGlance transactions. For these transactions, the system requires home employees to perform biometric scanning. If you have enabled non-home employees to perform biometric scanning for standard transactions, they must also perform biometric scanning for these QuickGlance transactions. 38
Standard transactions Standard transactions Standard (or local) transactions use information that is stored in the device. The following standard employee transactions are included with ADP InTouch. Punch Note: If your administrator has configured a punch as the default transaction for a badge swipe, this soft key may not be available. For more information, see Default transactions on page 20. Use the Punch transaction to punch in or punch out. 1. Tap Punch. 2. Swipe your badge or enter your badge ID and tap Enter. User s Guide 39
Chapter 2 Employee Mode Transactions Gate Entry The Gate Entry transaction allows you to unlock a door or turnstile without affecting your punch status. 1. Tap Gate Entry. 2. Swipe your badge or enter your badge ID and tap Enter. Work through Meal Your administrator can configure the host application to automatically deduct time for meals and breaks. That is, you do not have to punch out or punch in for meals and breaks. If the application is configured in this way, the Work Through Meal transaction allows you to override the automatic deduction for meals or breaks. 1. Tap Work Through Meal. 2. Swipe your badge or enter your badge ID and tap Enter. 40
Standard transactions Delayed Labor Transfer Use the Delayed Labor Transfer transaction to enter a labor account transfer that occurred in the past or that will occur in the future. 1. Tap Delayed Labor Transfer. 2. Swipe your badge or enter your badge ID and tap Enter. 3. Select the date. You can enter a date up to 29 days before or after the current date. 4. Enter the time and tap Enter. 5. Depending on how your system is configured, you can select one or more labor levels. For example: Work Order Item Number Product Cost Center Job Department Division 6. (Optional) Select a Job. 7. (Optional) Select a Comment Code. 8. Tap Submit. User s Guide 41
Chapter 2 Employee Mode Transactions Enter Tips Use the Enter Tips transaction to record your tips. 1. Tap Enter Tips. 2. Swipe your badge or enter your badge ID and tap Enter. 3. Enter the tip amount 4. Depending on how your system is configured, you can select one or more labor levels. For example: Work Order Item Number Product Cost Center Job Department Division 5. (Optional) Select a Comment Code. 6. Tap Submit. 42
Standard transactions Labor Transfer Use the Labor Transfer transaction to apply the time you work to a labor account. The device can prompt you for up to seven labor levels, depending on how the system is set up. 1. Tap Labor Transfer. 2. Swipe your badge or enter your badge ID and tap Enter. 3. Depending on how your system is configured, you can select one or more labor levels. For example: Work Order Item Number Product Cost Center Job Department Division 4. (Optional) Select a Job. 5. (Optional) Select a Comment Code. 6. Tap Submit. User s Guide 43
Chapter 2 Employee Mode Transactions Job Transfer Use the Job Transfer transaction to assign a job other than the primary job to the shift that you are beginning. 1. Tap Job Transfer. 2. Swipe your badge or enter your badge ID and tap Enter. 3. Select a Job. 4. Depending on how your system is configured, you can select one or more labor levels. For example: Work Order Item Number Product Cost Center Job Department Division 5. (Optional) Select a Comment Code. 6. Tap Submit. 44
Standard transactions Delayed Job Transfer Use the Delayed Job Transfer transaction to enter a job transfer that occurred in the past or that will occur in the future. 1. Tap Delayed Job Transfer. 2. Swipe your badge or enter your badge ID and tap Enter. 3. Select a Job. 4. Select the date. You can enter a date up to 29 days in the past or in the future. 5. Enter the time and tap Enter. 6. Depending on how your system is configured, you can select one or more labor levels. For example: Work Order Item Number Product Cost Center Job Department Division 7. (Optional) Select a Comment Code. 8. Tap Submit. User s Guide 45
Chapter 2 Employee Mode Transactions Edit Hours Use the Edit Hours transaction to associate an amount of time with a pay code. You can add hours to, or subtract hours from a pay code. Use this feature to enter non-productive time (for example, sick, vacation, or personal time) when you are unable to punch in and punch out. The prompts that appear depend on how the transaction is set up in the host application. The following procedure lists all possible prompts. 1. Tap Edit Hours. 2. Swipe your badge or enter your badge ID and tap Enter. 3. Select the date. You can enter a date up to 29 days in the past or in the future. 4. Enter the number of hours and tap Enter. 5. (Optional) Select a pay code. Note: Whether you can enter a pay code or must accept a default pay code depends on which host application you are using and how the transaction is configured. If you enter a pay code, the device does not validate the entry. 6. Depending on how your system is configured, you can select one or more labor levels. For example: Work Order Item Number Product Cost Center Job Department 46
Standard transactions Division 7. (Optional) Select a Job. 8. Tap Submit. Edit Money Use the Edit Money transaction to associate a positive or negative money amount with a pay code. The prompts that appear depend on how your administrator set up the transaction in the host application. The following procedure lists all possible prompts. 1. Tap Edit Money. 2. Swipe your badge or enter your badge ID and tap Enter. 3. Select the date. You can enter a date up to 29 days before or after the current date. 4. Enter the time and tap Enter. 5. Enter the amount of money and tap Enter. 6. (Optional) Select a pay code. Note: Whether you can enter a pay code or must accept a default pay code depends on which host application you are using and how the transaction is configured. If you enter a pay code, the device does not validate the entry. 7. Depending on how your system is configured, you can select one or more labor levels. For example: Work Order User s Guide 47
Chapter 2 Employee Mode Transactions Item Number Product Cost Center Job Department Division 8. (Optional) Select a Job. 9. Tap Submit. Review Punches Use the Review Punches transaction to view past punches at this device only. The device defaults to the past 12 hours, unless the host application is configured differently (maximum is 72 hours). 1. Tap Review Punches. 2. Swipe your badge or enter your badge ID and tap Enter. The punch transactions appear. 48
Standard transactions Start Work Rule Transfer Use the Start Work Rule Transfer transaction to associate the time that you are about to work with a specific activity. 1. Tap Start Work Rule Transfer. 2. Swipe your badge or enter your badge ID and tap Enter. 3. Select the Device Work Rule. 4. Depending on how your system is configured, you can select one or more labor levels. For example: Work Order Item Number Product Cost Center Job Department Division 5. (Optional) Select a Job. 6. (Optional) Select a Comment Code. 7. Tap Submit. User s Guide 49
Chapter 2 Employee Mode Transactions End Work Rule Transfer Use the End Work Rule Transfer transaction to associate an end time with a specific activity that you just completed. 1. Tap End Work Rule Transfer. 2. Swipe your badge or enter your badge ID and tap Enter. 3. Depending on how your system is configured, you can select one or more labor levels. For example: Work Order Item Number Product Cost Center Job Department Division 4. (Optional) Select a Job. 5. (Optional) Select a Comment Code. 6. Tap Submit. 50
Standard transactions View Current Schedule When you are punched in for a shift, use the View Current Schedule transaction to display its start and end times, including breaks and meals. If you are not punched in for a shift, this transaction does not show schedule information. 1. Tap View Current Schedule. 2. Swipe your badge or enter your badge ID and tap Enter. 3. Tap a scheduled day to view details. 4. Tap Close. View Future Schedule Use the View Future Schedule transaction to display the start and end times for upcoming shifts, including breaks and meals. Depending on the settings in the host application, the device can display up to 14 shifts. For example, if you have a 14-day schedule, and 10 days of that schedule have elapsed, the device displays the schedule for the remaining 4 days. 1. Tap View Future Schedule. User s Guide 51
Chapter 2 Employee Mode Transactions 2. Swipe your badge or enter your badge ID and tap Enter. Your scheduled shifts appear. View Punch Status Use the View Punch Status transaction to view information about your last punch. 1. Tap View Punch Status. 2. Swipe your badge or enter your badge ID and tap Enter. Information about your last punch appears. View Totals Note: This transaction differs from View Totals Online (QuickGlance) on page 63. The View Totals Online transaction accesses current information directly from the host database. The View Totals transaction accesses the totals information that was last downloaded to the device. 52
Standard transactions Use the View Totals transaction to display hour or monetary amount totals in pay codes for a specific employee, categorized by job. This transaction allows you to view accrued information, such as vacation time, sick time, and the flextime balance. 1. Tap View Totals. 2. Swipe your badge or enter your badge ID and tap Enter. Administrators: Use the host application to display up to seven pay code totals on the device. Call for Assistance Administrators: Use the device management application to set up the contacts that employees can call. Select Setup > Device Manager Setup > Assistance Contacts Lists. To assign a contacts list to a device, use the General Device Settings building block (Setup > Device Manager Setup > General Device Settings). The Call for Assistance transaction also requires you to configure the VoIP Settings, which are in maintenance mode (see VoIP Settings on page 134). When you encounter a problem at the device, use the Call for Assistance transaction to contact your manager, help desk, or whomever your administrator has added to the Assistance Contacts List, in the host application. 1. Tap Call for Assistance. 2. Swipe your badge or enter your badge ID and tap Enter. 3. Tap the appropriate contact. The device displays the status of the call, as it connects. 4. To end the call, tap End Call. If the line is busy, tap Retry or End Call. User s Guide 53
Chapter 2 Employee Mode Transactions QuickGlance transactions Unlike standard transactions, QuickGlance transactions do not rely on information stored in ADP InTouch. QuickGlance transactions allow you to do the following: Perform transactions that obtain information directly from the host application database. Enter transactions at the device and submit the information directly to the host application database. Transaction information and data entry screens are HTML pages that you access using a Web address (URL). Use the System Settings portion of Enterprise etime to specify the following information. This information controls the formatting of time and duration values in QuickGlance transaction screens. The login user name associated with the device (by default, InTouchUser ). The default display profile associated with the user name. The following table describes the QuickGlance transactions that are available when you are working in employee mode. For instructions about assigning these transactions to soft keys, refer to the system administrator s guide for the device management application you are using. 54
QuickGlance transactions QuickGlance Transaction Approve Timecard Justify Exception New Request Pay Code Edit Online View Accruals Online View Schedules Online View Timecard Online View Totals Online Request for Time Off View Messages Notes These transactions are available only when you are using Enterprise etime as the host application. These transactions are available only when you are using Enterprise etime and Process Manager as the host applications. Administrators: You can create custom QuickGlance transactions for your employees. For more information, see the system administrator s guide for the device management application. Approve Timecard (QuickGlance) Use the Approve Timecard transaction to review and approve the timecard for a specific pay period. The device displays an hourly view of the timecard (start time, end time, and shift totals). The timecard shows actual punch times even if the host application is configured to perform punch rounding. You can also use this transaction to revert an approved timecard to its unapproved state. User s Guide 55
Chapter 2 Employee Mode Transactions You can perform this transaction only if your assigned time entry method in the timekeeping application is hourly. The hourly time entry method requires employees to enter start and stop shift times in their timecards. 1. Tap Approve Timecard. 2. Swipe your badge or enter the badge ID and tap Enter. 3. Select the appropriate period. If your timecard does not appear, one of the following may have occurred: You did not enter start and stop shift times for the pay period. The message No transactions found appears. You are not assigned the hourly time entry method in the host application. The message Project view is not supported at this device appears. A manager has already approved the timecard. You cannot retract the approval. Justify Exception (QuickGlance) The Justify Exception transaction allows employees to select one or more duration pay codes to justify missing time. Missing time exceptions typically occur when an employee punches in late, leaves early, or is absent. The Justify Exception transaction is available only when the Auto-Resolved Exceptions feature is configured in the timekeeping application. 1. Tap Justify Exception. 2. Swipe your badge or enter the badge ID and tap Enter. 3. Select an exception from the list. 4. Select the pay code with which you are justifying the exception. 56
QuickGlance transactions 5. Enter the amount of time. 6. (Optional) To justify the exception with additional pay codes, repeat steps 4 and 5, as necessary. 7. Tap Review. 8. Tap Submit. Note: If you tap the confirmation page before it times out, the list of exceptions reappears. The system identifies each resolved exception with a green check mark. New Request (QuickGlance) Use the New Request transaction to request a pay code (for example, time off for vacation or personal time). Requesting time off in days This type of time off request is in increments of whole days, not hours. 1. Tap New Request. 2. Swipe your badge or enter the badge ID and tap Enter. 3. Select the time off request type. 4. Select Days. 5. Enter the start date of the request. 6. Enter the end date of the request. To request one day, enter the same date as the start date. User s Guide 57
Chapter 2 Employee Mode Transactions 7. Select the Pay Code. Requesting time off in hours This type of time off request is in increments of hours, not whole days. 1. Tap New Request. 2. Swipe your badge or enter the badge ID and tap Enter. 3. Select the time off request type. 4. Select Hours. 5. Enter the start date of the request. 6. Enter the start time of the request. 7. Enter the amount, in hours. 8. Select the Pay Code. Request for Time Off (QuickGlance) Use the Request for Time Off transaction, to request time off, such as vacation or personal time. The transaction initiates a business process in the host application, which requires action by a manager. Employees can use the View Messages transaction (see View Messages (QuickGlance) on page 64) to determine the results of their requests. 1. Tap Request for Time Off. 2. Swipe your badge or enter your badge ID and tap Enter. 3. Check your accrual balances. 4. (Optional) Enter a Comment Code. 58
QuickGlance transactions 5. Select the Leave Type. 6. Select the From Date. 7. Select the To Date. 8. Enter the number of hours of time off for each day. Note: If you specified a range of days, the number you enter is the number of hours per day. 9. Tap Submit. Pay Code Edit Online (QuickGlance) Use the Pay Code Edit Online (QuickGlance) transaction to associate an amount of time with a pay code. You can enter a positive or negative number of hours or days to the pay code. Use this feature to enter non-productive time when you are unable to punch in and out (for example, sick, vacation, or personal time). The pay codes that are available depend on how you are configured in the host application. 1. Tap Pay Code Edit Online. 2. Swipe your badge or enter your badge ID and tap Enter. 3. Select the pay code. 4. Select the date. You can enter a date up to 29 days in the past or in the future. 5. Enter the time and tap Enter. 6. Do one of the following: Enter a duration, in hours. Enter the number of days. User s Guide 59
Chapter 2 Employee Mode Transactions 7. Tap Submit. View Accruals Online (QuickGlance) Use the View Accruals Online transaction to view current totals of accrued time, such as vacation, personal, and sick time. The totals are accurate as of the time that you perform the transaction. Accrual totals information includes the accrual code name, type, and period ending balance. You can also view projected accrual totals as of a specific date. 1. Tap View Accruals Online. 2. Swipe your badge or enter your badge ID and tap Enter. 3. Select the end date of the period you are viewing. You can enter a date in the past or the future. View Schedules Online (QuickGlance) Use the View Schedules Online transaction to display your scheduled shifts for the next 14 days, including today. The information includes the job, labor account, or work rule transfers associated with the shifts. If no job, labor account, or work rule appears with a shift, employees work their assigned job, labor account, or work rule. 60
QuickGlance transactions 1. Tap View Schedules Online. 2. Swipe your badge or enter your badge ID and tap Enter. Your schedule appears. 3. Tap a scheduled day to view details. 4. Tap Close. User s Guide 61
Chapter 2 Employee Mode Transactions View Timecard Online (QuickGlance) The View Timecard Online transaction displays a timecard in an hourly view (start time, end time, and shift totals) for each day in the selected pay period. Only employees whose assigned time entry method is hourly can perform this transaction. The hourly time entry method requires employees to enter start and stop shift times in their timecards, using the host application. 1. Tap View Timecard Online. 2. Swipe your badge or enter your badge ID and tap Enter. Information about your last punch appears. 3. Select the time span. Previous Pay Period Current Pay Period Next Pay Period Today Yesterday Week to Date Last Week 4. Tap a day. An exclamation point icon indicates that there is an exception. The timecard shows actual punch times, even if the host application is configured to perform punch rounding. An E indicates an exception, such as a missed punch. 62
QuickGlance transactions View Totals Online (QuickGlance) The View Totals Online transaction differs from View Totals on page 52, which accesses totals information that was last downloaded to the device. Use the View Totals Online transaction to view hours totals for various time frames, including the previous pay period and week-to-date. The totals are accurate as of the time that you perform the transaction. 1. Tap View Totals Online. 2. Swipe your badge or enter your badge ID and tap Enter. 3. Select the time span. Previous Pay Period Current Pay Period Next Pay Period Today Yesterday Week to Date Last Week Tap the plus sign (+) to view details. Totals information is organized by location, and by job within each location. An (x) indicates that the employee performed a job transfer to the current job. User s Guide 63
Chapter 2 Employee Mode Transactions View Messages (QuickGlance) Use the View Messages transaction to read messages that managers send you. These messages are the same ones that appear in your Enterprise etime Inbox. Messages include meeting announcements and responses to requests for time off. 1. Tap View Messages. 2. Swipe your badge or enter your badge ID and tap Enter. 3. Tap the appropriate message to view its contents. 64
Enterprise Activities transactions Enterprise Activities transactions Administrators: To enable employees to perform Enterprise Activities transactions, use Enterprise etime and Enterprise Activities as the host applications. You can assign Enterprise Activities transactions to soft keys using the device management application. Note: Each transaction references an HTML form (created using Transaction Builder in Enterprise Activities) that has its own URL. When an employee taps a soft key, the device calls the URL and displays the form on the screen. When the transaction is completed, the device sends the information to the Enterprise Activities database. If the network is unavailable, the device stores the transaction and sends it when the network recovers. If the host application server is offline when an employee initiates a transaction, the device displays a default HTML form associated with the transaction. The employee completes the form and the device stores the information. When the host application server comes back online, the device sends the transaction information to the application database. User s Guide 65
Chapter 2 Employee Mode Transactions 66
Chapter 3 Manager Mode Transactions This chapter contains the following sections: Introduction on page 68. Accessing manager mode on page 69. Standard transactions on page 99.
Chapter 3 Manager Mode Transactions Introduction You use manager mode to perform transactions for employees. Transactions include adding punches, adjusting pay code hours, and overriding restrictions. Caution: Performing manager mode transactions can affect data that the device has already sent to payroll for processing. Administrators: Use the device management application to set up access to manager mode. You can configure a device to include one or more employee mode transactions while the device is in manager mode. For information about Employee mode transactions, see Employee Mode Transactions on page 35. Note: At the conclusion of many transactions, a summary of the data you entered appears. Tap Back to make changes, or tap Submit to save your data. The instructions in this chapter assume that you are ready to Submit; they do not explicitly mention the Back option, when it is available. 68
Accessing manager mode Accessing manager mode You access manager mode by using a Supervisor (or Manager) badge, or an Employee badge whose badge ID is assigned as a Manager badge, in the host application. Note: If the device is in manager mode and is idle for a specified time span without user input, it automatically exits manager mode and returns to employee mode. Your administrator sets the amount of idle time, using the host application. Using a Supervisor badge Note: Supervisor badges are sold separately. For more information, see your product s representative. To access manager mode: 1. Swipe your Supervisor ( S ) badge or enter the badge ID and tap Enter. 2. Enter your manager mode password and tap Enter. Note: The default password is 00000. To change the password at the device, use the Change Password transaction. See Change Password on page 102. If it is not available, your administrator can assign the Change Password transaction to a soft key using the host application. The supervisor password that you set at a device applies only to that device. 3. To log out of manager mode, tap Logout. User s Guide 69
Chapter 3 Manager Mode Transactions Using an Employee badge Use the Manager Login transaction to access manager mode, when the following conditions are met. You are enrolled in Enterprise etime as an employee with a Manager license. The device allows you to use an Employee badge to access manager mode. 1. Tap Manager Logon. 2. Swipe your badge or enter the badge ID and tap Enter. 3. Enter your manager mode password and tap Enter. 4. To log out of manager mode, tap Logout. 70
Biometrics Biometrics If you are using the ADP QuickPunch option, the Enroll Employee and Unenroll Employee transactions are available. These transactions also require some configuration in the device management application. For details, see the system administrator s guide for the device management application. Templates The Enroll Employee transaction creates a template for an employee s finger. A template is a mathematical representation of a fingerprint that is stored on the InTouch device, in an encrypted format. The ADP QuickPunch technology does not store actual fingerprint images. Furthermore, the mathematical representations of the fingerprints cannot be used to re-create the original images. Each employee can enroll two fingers a primary finger and, if required, a secondary finger. InTouch uses these templates to perform biometric verification or biometric identification when employees perform a finger scan. Biometric verification requires an employee to swipe a badge or enter a badge ID before scanning a finger. Biometric identification requires only a finger scan. You can enroll an employee for both biometric verification and biometric identification. However, an individual InTouch device can support only one type of biometric authentication at a time. A data collection device can store 4,000 verification templates or 500 identification templates (the latter are larger). The number of templates is based on the number of fingers that are enrolled, not the number of employees. ADP therefore recommends that, for a given device, up to 2,000 biometric verification employees enroll two fingers each; or up to 250 biometric identification employees enroll two fingers each. To determine the current capacity of a device, run the Biometric report. See Biometric report on page 148. User s Guide 71
Chapter 3 Manager Mode Transactions Terminology Nail joint Finger core First knuckle A finger contains a pattern of ridges, with typically one innermost ridge that curves in on itself, near the center. This area is called the finger core. In the following illustrations, the finger core is identified by a green dot: Arches (plain and tented) Loops (singular and twin) 72
Biometrics Whorls and central pocket loops Lock, drop, and hold method In this documentation, the technique for successfully enrolling a finger is referred to as the lock, drop, and hold method. Sensor border Sensor Ridge-lock User s Guide 73
Chapter 3 Manager Mode Transactions Lock Slide your finger along the ridge-lock, without touching the sensor, until the first knuckle aligns with the ridge-lock. Sliding the finger along the ridge-lock helps to dissipate electrostatic discharge that can adversely affect the biometric device. Note: When you rest your first knuckle on the ridge-lock, your nail joint should extend slightly past the white border of the sensor. This position ensures that your finger core is at the center of the sensor. If your finger is small, however, the nail joint might not extend past the border of the sensor while the first knuckle is resting on the ridge-lock. In this case, slide your first knuckle slightly past the ridge-lock so that the nail joint crosses the white border of the sensor. 74
Biometrics Drop Drop your finger flat onto the surface of the sensor, with your finger core in the center of the sensor, and your finger in contact with the white border of the sensor. Apply moderate pressure. If you apply too much pressure, the finger ridges can flatten out and produce a smudged image. If you apply too little pressure, the sensor might not detect your finger. In either case, a Poor enrollment can result. In addition, do not rotate the finger after you have placed it on the sensor. Hold Hold your finger on the sensor until the LED flashes, and then promptly remove it. Green indicates a Good enrollment; orange indicates a Fair enrollment; red indicates a Poor enrollment. The Enroll Employee transaction requires the participation of both the manager and the employee. To enroll an employee for biometric verification, go to Biometric verification on page 76. User s Guide 75
Chapter 3 Manager Mode Transactions To enroll for an employee for biometric identification, go to Biometric identification on page 86. Biometric verification To enroll an employee for biometric verification, perform the following steps: 1. Tap Enroll Employee. 2. Swipe the employee s badge or enter the badge ID and tap Enter. The Biometric Enrollment Wizard guides employees through the enrollment process. Select Finger to Enroll Note: To view an instructional video about biometric enrollment, tap the Video Tutorial button. 76
Biometrics Tap the button that corresponds to the finger you are enrolling. A check mark indicates a finger that you have previously enrolled. Use the index, middle, or ring finger. Enroll the thumb or pinkie only if you cannot successfully enroll the other fingers. If you do tap the thumb or pinkie, a warning message appears. Capture Fingerscan Note: Ensure that your finger is clean and not too dry. User s Guide 77
Chapter 3 Manager Mode Transactions Directly face the device so that you can comfortably place your finger on the sensor without having to awkwardly extend your arm or hand. Use the lock, drop, and hold method (for details, see Lock, drop, and hold method on page 73): Lock: Slide your finger forward and along the ridge-lock, without touching the sensor area. Drop: Drop your finger onto the surface of the sensor, and apply moderate pressure. Hold: Hold your finger on the sensor until the LED flashes, and then promptly remove it. When the biometric device detects a scan, the data collection device displays the following information: Quality Score A measurement of the useful data that the sensor detected in the finger scan. Some fingers have ridges, scars, or other characteristics that can lower the quality score. Range: 0 100. 78
Biometrics Content Score The relative amount of information that the sensor detected. Smaller fingers and poor finger placement result in lower content scores. Range: 0 100. Threshold A measure of how closely an employee s live finger scan must match the stored enrollment template. For biometric verification, there are three threshold settings: Normal, Low, and None, which are configured in the device management application (Setup > Device Manager Setup > General Device Settings > Punch Rules). The following table describes the icons associated with the scan results: Icon Description Indicates a Good quality score, or content score. Note: The threshold always receives a Good score. Indicates a Fair quality score or content score. Indicates a Poor quality score, or content score. The following examples of scan results include the recommended user actions. Note: You can configure InTouch to add the core locator to the fingerscreen images during the biometric verification enrollment process (for examples of this feature, see Biometric identification on page 86). Or, you can configure InTouch to not display employee fingerscans at all during biometric verification. For information about these settings, see your product s representative. User s Guide 79
Chapter 3 Manager Mode Transactions Good Enrollment Result Good Enrollment (Quality and Content Scores are 60 or greater.) Action The Confirm Fingerscan screen appears. Go to Confirm Fingerscan. 80
Biometrics Fair Enrollment Result Fair Enrollment Retry Suggested (Quality Score is 40 59, or Content Score is 20 59.) Action Tap one of the following: Change Finger Go to Select Finger to Enroll. Retry Go to Capture Fingerscan. Accept Best This option allows you to accept a Fair Enrollment for this employee. Go to Confirm Fingerscan. User s Guide 81
Chapter 3 Manager Mode Transactions Poor Enrollment 82
Biometrics Result Poor Enrollment (Quality Score is less than 40, or Content Score is less than 20.) Action Tap one of the following: Change Finger Go to Select Finger to Enroll. Retry Go to Capture Fingerscan. Accept Best (not pictured) If, after at least three enrollment attempts, the employee s best result is a Poor Enrollment, the Accept Best button appears. This option allows you to accept a Poor Enrollment for this employee. Go to Confirm Fingerscan. Failure User s Guide 83
Chapter 3 Manager Mode Transactions Result Failure The core of your finger was not detected. Action Tap one of the following: Change Finger Go to Select Finger to Enroll. Retry Go to Capture Fingerscan. Accept Best (not pictured) If, after at least three enrollment attempts, the employee has achieved a Fair Enrollment or a Poor Enrollment, the Accept Best button appears. This option allows you to accept a Fair or Poor enrollment for this employee. Go to Confirm Fingerscan. Confirm Fingerscan Re-scan the same finger that you used in the Capture Fingerscan step. The device compares the previously captured finger scan image (or template) with your current live finger scan. The following table describes the possible results of the enrollment test: Result Accepted No finger scan detected Failed Action If you have enrolled only one finger, the system prompts you to enroll another finger. You can enroll a secondary finger or reenroll your primary finger. Go to Select Finger to Enroll. If you have already enrolled two fingers, or you decline to enroll another finger, the enrollment process is completed. Managers: The system prompts you to enroll another employee. Tap one of the following: Retry Go to Confirm Fingerscan. Change Finger Go to Select Finger to Enroll. Tap one of the following: Retry The system instructs you how to reposition your finger for a better scan. Go to Confirm Fingerscan. Change Finger Go to Select Finger to Enroll. 84
Biometrics Managers: If the employee s enrollment test fails three consecutive times, the following results page appears: To change the threshold setting for the current employee only tap one of the following: Normal Low None Go to Confirm Fingerscan on page 84. Note: A lower threshold allows a wider variance between the enrollment template and the live finger scan. This adjustment increases the chance that the device will accept the employee s test results. However, a lower threshold also increases the chance that the device will incorrectly accept another employee s finger. If you set the threshold to None, you ensure that the device will accept the employee s test results. User s Guide 85
Chapter 3 Manager Mode Transactions To allow the employee to enroll a different finger, tap Enroll Different Finger. Go to Select Finger to Enroll on page 76. Biometric identification Note: Biometric identification supports only home employees. To enroll an employee for biometric identification, perform the following steps: 1. Tap Enroll Employee. 2. Swipe the employee s badge or enter the badge ID and tap Enter. The Biometric Enrollment Wizard guides employees through the enrollment process. Select Finger to Enroll Note: To view an instructional video about biometric enrollment, tap the Video Tutorial button. 86
Biometrics Tap the button that corresponds to the finger you are enrolling. A check mark indicates a finger that you have previously enrolled. Use the index, middle, or ring finger. Enroll the thumb or pinkie only if you cannot successfully enroll the other fingers. If you do tap the thumb or pinkie, a warning message appears. Capture Fingerscan Note: Ensure that your finger is clean and not too dry. User s Guide 87
Chapter 3 Manager Mode Transactions Directly face the device so that you can comfortably place your finger on the sensor without having to awkwardly extend your arm or hand. Use the lock, drop, and hold method (for details, see Lock, drop, and hold method on page 73): Lock: Slide your finger forward and along the ridge-lock, without touching the sensor area. Drop: Drop your finger onto the surface of the sensor, and apply moderate pressure. Hold: Hold your finger on the sensor until the LED flashes, and then promptly remove it. When the biometric device detects a scan, the data collection device displays the following information: Quality Score A measurement of the useful data that the sensor detected in the finger scan. Some fingers have ridges, scars, or other characteristics that can lower the quality score. Range: 0 100. 88
Biometrics Content Score The relative amount of information that the sensor detected. Smaller fingers and poor finger placement result in lower content scores. Range: 0 100. Core Placement Indicates whether the core of the finger was in the middle of the sensor. Score: Good or Poor. Threshold A measure of how closely an employee s live finger scan must match the stored enrollment template. For biometric identification, the device management application automatically sets the threshold to High. You cannot change this setting. The following table describes the icons associated with the scan results: Icon Description Indicates a Good quality score, content score, or core placement. Note: The threshold always receives a Good score. Indicates a Fair quality score or content score. Note: The core placement never receives a Fair score. Indicates a Poor quality score, content score, or core placement. The following examples of scan results include the recommended user actions. The circular target indicates where the finger core should be placed on the sensor (it is always in the same position). The plus sign (or core locator) indicates where the finger core was actually placed on the sensor. If the sign is green, the Core Placement is Good; if it is red, the Core Placement is Poor. Note: You can configure InTouch to not display employee fingerscans during the biometric identification enrollment process. For information about this configuraiton setting, see your product s representative. User s Guide 89
Chapter 3 Manager Mode Transactions Good Enrollment Result Good Enrollment (Quality and Content Scores are 60 or greater. Core Placement is Good.) Action The Confirm Fingerscan screen appears. Go to Confirm Fingerscan. 90
Biometrics Fair Enrollment Result Fair Enrollment Retry Suggested (Quality Score is 40 59, or Content Score is 20 59. Core Placement is Good.) Action Tap one of the following: Change Finger Go to Select Finger to Enroll. Retry Go to Capture Fingerscan. Accept Best This option allows you to accept a Fair Enrollment for this employee. Go to Confirm Fingerscan. Note: You can lower the Quality Score threshold to 25 (from 40), to make it easier for biometric identification employees to achieve a Fair Enrollment. For information about this configuration setting, see your product s representative. User s Guide 91
Chapter 3 Manager Mode Transactions Poor Enrollment 92
Biometrics User s Guide 93
Chapter 3 Manager Mode Transactions Result Poor Enrollment (Quality Score is less than 40, or Content Score is less than 20, or Core Placement is Poor.) Action Tap one of the following: Change Finger Go to Select Finger to Enroll. Retry If the Core Placement is Poor, the system instructs you how to reposition your finger for a better scan. Go to Capture Fingerscan. Accept Best (not pictured) If an employee achieves at least three consecutive Poor Enrollment results, the Accept Best button appears provided that at least one of the Poor Enrollment results is due solely to a Poor Core Placement. That is, both the Quality and Content scores must be at least Fair. Under these conditions, you can accept a Poor Enrollment for this employee. Go to Confirm Fingerscan. Note: You can configure InTouch to not display the Accept Best button, under these conditions. For information about this setting, see your product s representative. 94
Biometrics Failure Result Failure The core of your finger was not detected. Action Tap one of the following: Change Finger Go to Select Finger to Enroll. Retry Go to Capture Fingerscan. Accept Best If, after at least three enrollment attempts, the employee has achieved a Fair result or a Poor result, the Accept Best button appears provided that the Quality and Content scores are at least Fair. This option allows you to accept a Fair or Poor enrollment for this employee. Go to Confirm Fingerscan. Confirm Fingerscan Re-scan the same finger that you used in the Capture Fingerscan step. The device compares the previously captured finger scan image (or template) with your current live finger scan. User s Guide 95
Chapter 3 Manager Mode Transactions The following table describes the possible results of the enrollment test: Result Accepted No finger scan detected Failed Action If you have enrolled only one finger, the system prompts you to enroll another finger. You can enroll a secondary finger or reenroll your primary finger. Go to Select Finger to Enroll. If you have already enrolled two fingers, or you decline to enroll another finger, the enrollment process is completed. Managers: The system prompts you to enroll another employee. To enroll another employee for biometric identification, remain in the Enroll Employee transaction. That is, do not allow the system to time out to the employee or manager home page, while you are enrolling multiple employees. Tap one of the following: Retry Go to Confirm Fingerscan. Change Finger Go to Select Finger to Enroll. Tap one of the following: Retry The system instructs you how to reposition your finger for a better scan. Go to Confirm Fingerscan. Change Finger Go to Select Finger to Enroll. Troubleshooting To determine the cause of a Fair or Poor quality or content score, refer to the fingerprint image on the scan results page, and compare it to the following examples: 96
Biometrics Moist finger or too much pressure Dry finger or too little pressure Note: If an employee receives a Poor core placement score while enrolling for biometric identification, InTouch provides on-screen instructions for achieving a Good score. To improve the quality or content score, consider the following: Is the finger core centered on the scanning surface? Is the employee applying too much or too little pressure on the sensor? Is the finger is too dry? If so, direct the employee to breathe on the finger, or to apply hand lotion. Is the finger too moist? Is the finger clean? User s Guide 97
Chapter 3 Manager Mode Transactions Is the sensor clean? Fingerscan quality and content can vary by finger. Attempt to enroll an alternate finger. Unenroll Employee The Unenroll Employee transaction removes an employee s template from the data collection device. It revokes the employee s ability to punch using a finger scan. The Unenroll Employee transaction requires the participation of both the manager and the employee. 1. Tap Unenroll Employee. 2. The employee punches in, using a badge, a keyboard, or a finger scan. 3. To confirm the unenrollment, tap Submit. 98
Standard transactions Standard transactions Standard (or local) transactions use information that is stored in the device. The following standard manager transactions are included with ADP InTouch. The instructions for all manager mode transactions assume that you are already in manager mode. Add Punch Use the Add Punch transaction to add a missing punch for an employee, or to edit punch information. You cannot change the date or time of an existing punch. However, you can delete the punch (see Delete Punch on page 103) and then add a punch with a new date or time. You can perform this transaction for 29 days before or after the current date, which is considered day 0. 1. Tap Add Punch. 2. Swipe the employee s badge or enter the badge ID and tap Enter. 3. Select the date. 4. Enter the time and tap Enter. 5. Depending on how your system is configured, you can select one or more labor levels. For example: Work Order Item Number Product Cost Center User s Guide 99
Chapter 3 Manager Mode Transactions Job Department Division 6. (Optional) Select a Comment Code. 7. (Optional) Select a Job. 8. Tap Submit. Note: Midnight (enter as 00:00) is the first minute of a day; 11:59 P.M. (enter as 23:59) is the last minute of a day. View Gate Times Administrators: You can connect a data collection device to a door latch, to control employee access to a locked building or room. Use the device management application to do the following: Configure the data collection device to accept gate entry punches from home employees and non-home employees. Connect a remote badge reader to a device that is configured for gate entry. You can install the reader outside the door to the building that houses the device. The default transaction for the reader is Gate Entry. Configure the device to interpret a badge read as either of the following: Entry only Set up a soft key to perform this transaction. Entry and a simple in-punch or out-punch for a shift The punch can also be subject to schedule enforcement and biometric verification or identification. 100
Standard transactions Set up the gate schedules for a device. A gate open schedule is a period when a door is unlocked, and employees can access an area without swiping their badges. A gate off schedule is a period when the gate remains locked, even if an employee performs a transaction that would otherwise unlock the gate. Managers: Use the View Gate Times transaction to review the gate open and gate off schedules for a device. 1. Tap View Gate Times. Gate Override - Duration Use the Gate Override - Duration transaction to open a door for a specified time span without requiring employees to swipe a badge. This feature is useful when you are not restricting access to an area. 1. Tap Gate Override - Duration. 2. Enter the Open Duration, in minutes. Maximum amount: 10,080 (or 7 days). 3. Tap Submit. The door unlocks to allow unrestricted entry. Gate Override - Employee Use the Gate Override - Employee transaction to open a door for a specific employee. This feature is useful when the device cannot read an employee s badge, or when the employee has forgotten the badge. User s Guide 101
Chapter 3 Manager Mode Transactions 1. Tap Gate Override - Employee. 2. Swipe the employee s badge or enter the badge ID and tap Enter. Cancel Gate Override The Cancel Gate Override transaction cancels a Gate Override - Duration transaction. Change Password When you are using a Supervisor badge to enter manager mode, the Change Password transaction is available. 1. Tap Change Password. 2. Enter the current password. 3. Enter the new password and tap Enter. 4. Re-enter the new password. Note: The new password applies to all Supervisor badges, but only to the device where you performed this transaction. 102
Standard transactions Delete Punch Use the Delete Punch transaction to delete an improperly entered employee punch. You can enter a date up to 30 days before or after the current date. 1. Tap Delete Punch. 2. Swipe the employee s badge or enter the badge ID and tap Enter. 3. Select the date. 4. Enter the time and tap Enter. 5. Tap Submit. View On or Off Premises Employees Use the View On or Off Premises Employees transaction to view a list of home employees who are currently on or off the premises. 1. Tap View On or Off Premises Employees. 2. To view the employees who are on or off the premises, tap the appropriate arrow. User s Guide 103
Chapter 3 Manager Mode Transactions Global Home Override Administrators: For information about punch interpretation rules, see the system administrator s guide for the device management application. Use the Global Home Override transaction to override schedule and punch restrictions for home employees when unusual circumstances occur. For example, if there is inclement weather, this feature enables home employees to punch out early. 1. Tap Global Home Override. 2. Tap Enable. 3. Enter the duration of the override (use the hh:mm format) and tap Enter. The maximum value is 99:59. 4. Tap Submit. For the entire duration of the override, the system displays an icon below the logo on the employee and manager home pages. See Global Home Override on page 31. Note: To disable an override, tap Global Home Override and then tap Disable. 104
Standard transactions Global Non-Home Override Use the Global Non-Home Override transaction to temporarily or indefinitely allow non-home employees to punch at restricted times. For example, this feature enables non-home employees to punch out early because of inclement weather. 1. Tap Global Non-Home Override. 2. Tap Enable. 3. Enter the duration of the override (use the hh:mm format). The maximum value is 99:59. 4. Tap Submit. For the entire duration of the override, the system displays an icon below the logo on the employee and manager home pages. See Global Non-Home Override on page 32. Note: To disable an override, tap Disable in step 2. User s Guide 105
Chapter 3 Manager Mode Transactions Pay Code Move Amount Use the Pay Code Move Amount transaction to move an employee s hours from one pay code to another. The prompts that appear depend on how your administrator set up the transaction in the host application. The following procedure lists all possible prompts. Note: The following procedure assumes that the option to transfer to another job is available. If the transaction does not allow job transfers, Enter Badge is the last prompt that appears. 1. Tap Pay Code Move Amount. 2. Enter the employee s badge ID and tap Enter. 3. Select the date. 4. Enter the time and tap Enter. 5. Select the From Pay Code. 6. Enter the hours and tap Enter. 7. Select the To Pay Code. 8. Enter the hours and tap Enter. 9. Depending on how your system is configured, select a From Labor Levels from one or more of the following: Work Order Item Number Product Cost Center 106
Standard transactions Job Department Division 10. (Optional) Select a Comment Code. 11. Tap Submit. View Bell Times If a device is connected to a bell, organizations can schedule the bell to ring at specific times, such as the start of a break. Bell schedules include primary bells and optional warning bells. Primary bells signal the start of a transaction; warning bells signal the approach of a transaction (for example, the start of a shift). To review the bell schedules, tap View Bell Times. Administrators: Use the device management application to configure bell schedules, including the following parameters: The days and times that the primary bell rings. The length of time that the primary bell rings. The length of time before the primary bell rings that the warning bell rings. The length of time that the warning bell rings. User s Guide 107
Chapter 3 Manager Mode Transactions Ring Bell Use the Ring Bell transaction to ring the bell at unscheduled times, such as during an emergency. 1. Tap Ring Bell. 2. Enter the Duration of the ring, in seconds. 3. Tap Enter. Silence Bell Use the Silence Bell transaction for either of the following reasons: To prevent the bell from ringing as scheduled, for a specified duration. To silence a bell that is ringing. 1. Tap Silence Bell. 2. Enter the Duration (in seconds) that the bell is silent. If you enter 0, the bell is silent for an indefinite period. 3. Tap Enter. 108
Standard transactions Note: To disable the silencing of the bell so that it will ring later as scheduled, perform this transaction again and specify a duration other than 0. Single Home Employee Restriction Override When unusual circumstances occur, use the Single Home Employee Restriction Override transaction to override schedule and punch restrictions for a specific home employee. For example, you can allow an employee to start or leave work earlier than scheduled. In the Number of Credits step, enter the number of times that an employee can punch. This step allows you to extend the override to an employee for a longer duration. 1. Tap Single Home Employee Restriction Override. 2. Swipe the employee s badge or enter the badge ID and tap Enter. 3. Enter the number of credits (99 or fewer) and tap Enter. When a restriction override is enabled, a small icon appears near the upper right corner of the idle screen (in Employee, Manager, or Maintenance mode). User s Guide 109
Chapter 3 Manager Mode Transactions Single Non-Home Employee Restriction Override Use the Single Non-Home Employee Restriction Override transaction to enter a punch for a non-home employee when there is a Global Restriction in effect. You can perform this transaction for several employees in succession. 1. Tap Single Non-Home Employee Restriction Override. 2. Swipe the employee s badge or enter the badge ID and tap Enter. 3. Swipe the next employee s badge or enter the badge ID and tap Enter. 4. Continue in this manner until you have included all of the appropriate employees. When a restriction override is enabled, a small icon appears near the upper right corner of the idle screen (in employee, manager, or maintenance mode). View Employee Information The View Employee Information transaction displays a set of data for a specific employee. 1. Tap View Employee Information. 110
Standard transactions 2. Swipe the employee s badge or enter the badge ID and tap Enter. The following information appears: General Schedules Punch Restriction Credits Message Assignments Accruals Biometric Enrollment status (Enrolled or Not Enrolled) Biometric Templates Report Run this report to view a list of some or all of the biometric templates that are stored in the biometric device. 1. Tap Biometric Templates Report. 2. Do one of the following: To view all of the templates, tap All. Go to step 6. To view only templates that have low scores or other problems, tap Problem. Continue to the next step. 3. Select the search criteria. Tap the appropriate soft key and tap Yes. Quality or Content < 60 Quality < 40 or Content < 20 Threshold of None Thumb or Pinkie Non-optimal finger placement Quality & Content 0 Note: For details about these terms, see Biometrics on page 71. 4. Tap Review. 5. Tap Submit to view the results. User s Guide 111
Chapter 3 Manager Mode Transactions QuickGlance transactions The following QuickGlance transactions are available when you are working in manager mode. For more information, see QuickGlance transactions on page 54. Pay Code Move Online (QuickGlance) Note: This transaction is available only when you are using Enterprise etime as the host application. Use the Pay Code Move Online transaction to move a positive or negative amount of time from one pay code to another. The pay codes that are available depend on how you are configured in the host application. 1. Tap Pay Code Move Online. 2. Swipe your badge or enter your badge ID and tap Enter. 3. Select the date. 4. Enter the time and tap Enter. 5. Select the pay code that you are moving hours from. 6. Enter the number of hours and tap Enter. 7. Enter the pay code that you are adding hours to. 8. (Optional) Select a Comment Code. 9. Tap Submit. 112
QuickGlance transactions Schedule Override (QuickGlance) Note: This transaction is available only when you are using Enterprise etime and Enterprise Scheduler as the host applications. The Schedule Override transaction allows you to edit shifts at the device without using Enterprise Scheduler. The host application validates these revisions against the punch interpretation rules that apply to you. If the changes are rejected, an error message appears. If the changes are accepted, the revised schedule is saved to the host application database. The host application then sends the revised schedule back to the device, which accepts or rejects the punches. To begin the Schedule Override transaction: 1. Tap Schedule Override. 2. Swipe your badge or enter your badge ID and tap Enter. The Schedule Override screen displays up to three scheduled shifts. If you are working when you perform this transaction, the current shift is included. If you do not have a schedule, no shifts appear, and the tab reads 0 Schedule Items. 3. Do one of the following: To add a shift, go to Adding shifts on page 114. To edit a shift, go to Editing shifts on page 114. To delete a shift, go to Deleting shifts on page 115. User s Guide 113
Chapter 3 Manager Mode Transactions Adding shifts Note: The Schedule Override transaction does not allow you to add shifts that comprise more than one segment. 1. Tap Add Shift. 2. Select the start date of the shift. 3. Enter the start time and tap Enter. 4. Select the end date of the shift. 5. Enter the end time and tap Enter. 6. Select the Pay Code. 7. (Optional) Select a Comment Code. 8. Tap Submit. Editing shifts 1. Select a shift. 2. Tap Edit. 3. Select the start date of the shift. 4. Enter the start time and tap Enter. 5. Select the end date of the shift. 6. Enter the end time and tap Enter. 7. Select the Pay Code. 8. (Optional) Select a Comment Code. 9. Tap Submit. 114
QuickGlance transactions Deleting shifts 1. Select a shift. 2. Tap Delete. 3. (Optional) Select a Comment Code. 4. Tap Submit. User s Guide 115
Chapter 3 Manager Mode Transactions 116
Chapter 4 Maintenance Mode Functions This chapter contains the following sections: Introduction on page 118. Initial setup and configuration on page 119. Maintenance mode functions on page 123. Settings on page 125. Advanced on page 136. Reports on page 144. Tests on page 150.
Chapter 4 Maintenance Mode Functions Introduction Maintenance mode allows you to display technical information about the ADP InTouch data collection device, perform configuration tasks, and execute diagnostic tests. These tests can help you troubleshoot hardware malfunctions. If you or a product representative cannot diagnose a particular hardware problem, return the device to ADP. See the guide for returning the touchscreen data collection device. Caution: Before you disassemble the device, use the host application to collect all of the data that is stored on it. The number of available options depends on the type of device you are using: Standard model or Slim Profile model. The deeper, Standard model (see illustration) enables you to install more options, such as an external reader or back-up battery. Important: The application software for the device resides on the SD (Secure Digital) card, which is in the unit. Removing, copying, or altering the SD card voids your warranty. 118
Initial setup and configuration Initial setup and configuration This section describes how to initially set up and configure a new data collection device. These instructions apply to a typical setup. The procedure can vary depending on which options are installed and which features your organization is using. Some configuration tasks, such as defining which transactions users can perform at the device, require you to use the device management application. In addition, many of the settings that you configure on the device must match the corresponding settings in the device management application. These settings are identified throughout this chapter. For more information, see the system administrator s guide for the device management application. Note: For details about assembling and mounting the device, see the ADP InTouch installation guide. Required settings The following steps apply to all setup scenarios: 1. Power up the device. If the device times out during the initial setup, you can re-access maintenance mode in two ways: swipe a Maintenance badge; or open the device and press the maintenance mode button on the main board, which is on the inside front cover (see button in the following illustration). To remove the front cover, use the security wrench that was shipped with the device. You must press and hold the button for four seconds. Note: Button enables you to restart the device, when the system is not responding. Press and hold the button for four seconds. User s Guide 119
Chapter 4 Maintenance Mode Functions 1 2 Note: If you are prompted to calibrate the touchscreen, use a stylus pen (do not use your finger) to tap each of the five cross-hairs that appear. For detailed instructions, see Calibrate Touchscreen on page 142. 2. Tap the default language. Note: This language is used only during the initial setup and configuration of the device. After you complete the setup, you download the language information from the device management application. The default language that you specify in the device management application supersedes the default language that you choose in this step. For more information, see Language support on page 22. The Communications Settings page opens. 120
Initial setup and configuration 3. Configure the Communication Settings, which include: General communication settings (server-initiated or device-initiated). IPV4 configuration or IPV6 configuration. DNS (Domain Name System) configuration. For information about configuring these settings, see Communication Settings on page 126. 4. Set the date and time (see Date and Time on page 125). Important: By default, the maintenance mode password for all new devices is set to 115190. ADP recommends that, for security purposes, you change the password. Go to Change Maintenance Mode Password on page 138. If you do not change the default password, a Security Alert prompts you to change it, each time that you swipe a Maintenance badge, enter 115190, and tap Enter. Optional settings Perform one or more of the following steps, depending on the options and features that you are using: To change the default audio settings, see Audio on page 132. To change the default display settings, see Display on page 132. If one or more bar code badge readers are attached to the device, use the Bar Code Symbology setting to ensure that the device can read the badges. See Bar Code Symbology on page 133. If one or more remote badge readers are connected to the device, use the Remote Readers function to configure them. See Remote Readers on page 134. To allow a user to remotely access the device from a PC, enable the Remote Access function. See Remote Access on page 132. To allow a user to remotely debug the device from a PC that is running VNC, enable the Remote Debug Mode function. See Remote Debug Mode on page 139. User s Guide 121
Chapter 4 Maintenance Mode Functions If the device makes available the Call for Assistance employee transaction, configure the VoIP settings (see VoIP Settings on page 134). Completing the setup Use the host application to complete the following tasks (for details, see the system administrator s guide for the device management application). Add the device to your system configuration, and assign it to a device group. Test the communication between the host application and the device. Define the transactions (in employee mode and manager mode) that users can perform at the device. Define which type of data to download from the host application to the device (for example, activity codes, pay codes, and so on). 122
Maintenance mode functions Maintenance mode functions Note: At the conclusion of many functions, a Review page appears. Tap Back to make changes, or tap Submit to save your data. The instructions in this chapter assume that you are ready to Submit; they do not explicitly mention the Back option, when it is available. Accessing and exiting maintenance mode After you perform the initial setup, there are two routine ways to access maintenance mode. User s Guide 123
Chapter 4 Maintenance Mode Functions Using a Maintenance badge Swipe the Maintenance ( M ) badge within two inches of the target area (top right corner of the device). Depending on how the device is configured, the system prompts you for a password. If you have not already changed the maintenance mode password from its default value (115190), the system prompts you to change the password to a more secure value. See Change Maintenance Mode Password on page 138. To exit from maintenance mode, press the Home key. Note: If the device is idle for 45 seconds without any input from a user, it automatically exits maintenance mode and returns to employee mode. Using the Menu key Press the Menu key on the front of the device (bottom left), and tap Maintenance Mode. Enter the maintenance mode password, and tap Enter. Note: The instructions for maintenance mode functions in this chapter assume that you are already in maintenance mode. Cleaning the touchscreen Note: Do not spray screen cleaner directly on the device. Spray the cleaner on a soft, lint-free cloth. See the ADP InTouch installation guide for additional preventive maintenance information. To clean the touchscreen surface, press the Menu key on the front of the device (bottom left), and tap Clean Touchscreen. The system disables the touchscreen for 30 seconds, so that you can clean its surface without inadvertently performing a transaction. The system counts down the number of seconds that the touchscreen remains disabled. After you finish cleaning the touchscreen, wait until the remaining time elapses, or press the Home key on the front of the device (bottom right) to exit. 124
Settings Settings Date and Time Use the Date and Time setting to set the date and time on the device. 1. Tap Settings. 2. Tap Date and Time. 3. Year Setting: Enter the four-digit year, and tap Enter. 4. Month Setting: Enter the month, and tap Enter. 5. Day Setting: Enter the date, and tap Enter. 6. Time Setting: Enter the time, tap the AM/PM soft key to toggle between AM and FM, and tap Enter. 7. Tab Submit. Note: When the device establishes a connection with the host application, the latter resets the date and time on the device to match its own settings. User s Guide 125
Chapter 4 Maintenance Mode Functions Communication Settings Note: The communication settings for the device must match the corresponding settings in the device management application. If your organization uses Enterprise Device Manager, the Communication Mode settings that you enter in the Device Communication Setting building block (Setup > Device Manager Setup > Device Communication Settings) must match the communication settings that you enter on the device. General Communication settings Server-Initiated 1. Tap Settings. 2. Tap Communication Settings. 3. Tap General Communication. 4. Server Device Initiated: Tap Server-Initiated. 5. Device ID: Enter the same ID that you enter in the device management application (Setup > Device Manager Setup > Devices). 6. Tap Submit. Note: For Server-Initiated communication, you must also enter the IPV4 or IPV6 Configuration settings. See IPV4 Configuration on page 128, and IPV6 Configuration on page 129. Device-Initiated 1. Tap Settings. 2. Tap Communication Settings. 3. Tap General Communication. 4. Server Device Initiated: Tap Device-Initiated. 5. Device ID: Enter the same ID that you enter in the device management application (Setup > Device Manager Setup > Devices). 126
Settings 6. Primary Server Password: This password allows the device management application to identify the device when it performs operations such as QuickGlance transactions. Enter a numeric password whose length is 6 10 digits. Note: If the password is enabled for the device in the device management application (Setup > Device Manager Setup > Device Communication Settings), enter the same password here. If the password is disabled for the device, enter any combination of six digits. 7. Verify Server Password: Re-enter the password. 8. HTTP-SSL: Choose the same setting that you specify in the device management application (Setup > Device Manager Setup > Device Communication Settings). 9. Primary Server IP: The IP address of the Web host server that you are connecting to (the default value 127.0.0.5). Enter the same IP address that you enter in the device management application (Setup > Device Manager Setup > Device Communication Settings). 10. Primary Server Port: Enter the same Primary Port number that you enter in the device management application (Setup > Device Manager Setup > Device Communication Settings). The default value is 80 (non-ssl). 11. Primary Server Instance ID: The instance ID number of the timekeeping application that the device is communicating with (the default value is 5001). Enter the same instance ID that you enter in the device management application (Setup > Device Manager Setup > Device Communication Settings). Note: If you later change the instance ID in Device Manager Setup, the setting in the device is updated when it next initiates communication with the device management application. 12. Tap Submit. User s Guide 127
Chapter 4 Maintenance Mode Functions IPV4 Configuration Note: If you are using the IPV6 IP address format, skip this setting. Important considerations for Dynamic Host Configuration Protocol (DHCP) Use a DHCP server to automatically assign IP addresses to devices (see step 4, in the procedure that follows). Before you complete the communication settings for the device, note the following: Ensure that your DHCP server complies with the minimum requirements of the DHCP RFC2132 standard to supply an IP address, subnet mask setting, and default gateway setting. Do not configure ADP InTouch devices to use DHCP on a network that does not support DHCP. Otherwise, each device performs an address request every five seconds for an indefinite period. These requests can adversely affect network performance. To change the IP address of a device that uses DHCP: change the address on the network; assign the address to the device; and then remove the address from the DHCP pool so that another device cannot use it. If you remove a device that uses DHCP, you can reuse its former IP address. To configure the device to use the IPV4 address format: 1. Tap Settings. 2. Tap Communication Settings. 3. Tap IPV4. 4. Address Mode do one of the following: Tap DHCP. Go to step 8. Tap Static. Go to the next step. 5. IP Address: Enter the IP address for this device (the default value is 127.0.0.1) and tap Enter. 6. Subnet Mask: Enter the IP address for the sub-network (the default value is 255.255.255.0) and tap Enter. 7. Gateway: Enter the gateway IP address (including the periods) and tap Enter. 128
Settings 8. Auto DNS Update: Tap True or False. 9. Speed tap one of the following: Auto 10 Full Duplex 10 Half Duplex 100 Full Duplex 100 Half Duplex 10. Tap Review. 11. Tap Submit. IPV6 Configuration Note: If you are using the IPV4 IP address format, skip this setting. To configure the device to use the IPV6 address format: 1. Tap Settings. 2. Tap Communication Settings. 3. Tap IPV6. 4. IPV6 Support: If False, go to step 12. If True, continue to the next step. 5. Address Mode: Select one of the following: Manual: Complete steps 6, 7, 8, 9, 11, and 12. Stateful: Go to step 9. Stateless: Go to step 9. 6. IP Address: Enter the IP address and tap Enter. 7. Prefix: Enter the prefix and tap Enter. 8. Gateway: Enter the gateway IP address and tap Enter. User s Guide 129
Chapter 4 Maintenance Mode Functions 9. Use DHCP V6 server for options (O flag): Tap True or False. 10. Use DHCP V6 server for IP address (M flag): Tap True or False. 11. Speed: This setting defaults to Auto. 12. Tap Submit. DNS Configuration The DNS (Domain Name System) feature enables a device to access and process information that does not reside on the device. QuickGlance transactions, for example, access a URL for information. To use the DNS feature, you must have access to a DNS server. For example, the View Schedules Online transaction requires access to the host application database, to access current information about schedules and jobs. The DNS feature resolves the domain name of the host application s server so that the device can access the information at the specified URL. 1. Tap Settings. 2. Tap Communication Settings. 3. Tap DNS Configuration: If you are using the IPV4 IP address format and you set the Address Mode to DHCP (see IPV4 Configuration on page 128), the system auto-populates all of the DNS values. Go to step 9. Otherwise, go to the next step. 4. Enabled: Tap True. 5. Primary DNS Server: Enter the IP address of the primary DNS server. 6. Secondary DNS Server: Enter the IP address of the secondary DNS server. 7. Primary DNS Server (IPV6): If you set IPV6 Support to True and you set the Address Mode to Manual (see IPV6 Configuration on page 129), enter the IP address of the primary DNS server. Otherwise, go directly to the next step. 130
Settings 8. Secondary DNS Server (IPV6): If you set the IPV6 Address Mode to Manual and you have a secondary DNS server for IPV6, enter the IP address of this server. Otherwise, go directly to the next step. 9. Tap Submit. Important considerations for Dynamic DNS (DDNS) Support Dynamic DNS is supported by ADP InTouch by configuring the DHCP server to update the DNS server dynamically. When an IP address is assigned to the client device, the DHCP server updates the DNS server with the DNS (A) record and (PTR) records. Configure the DHCP server so that it deletes the records in the DNS server when an IP address lease time expires for a particular client device. Windows 2003 (and higher versions) DHCP server and DNS server support this type of behavior and configuration. The DNS server is not updated when the address mode of the client device is configured as static (and the static IP address is configured at the device). The DNS server is updated only when the address mode of the client device is configured as DHCP. The ADP InTouch device workflow with Dynamic DNS server configuration is as follows: The device makes a request to the DHCP server. By default, the device ID is used as the device host name. The DHCP server assigns an IP address to the client request. If the DHCP server is configured to update the DNS server, only the DNS server is updated. The client device makes a request to the DHCP server to renew the IP address at a frequency equal to the lease time divided by two. If the IP address is not renewed, the corresponding DNS record is deleted from the DNS server. User s Guide 131
Chapter 4 Maintenance Mode Functions Audio Use the Audio settings to configure the tones that the device emits. 1. Tap Settings. 2. Tap Audio. 3. Tone Volume: Tap the plus (+) or minus (-) sign to adjust the volume of the beeper. 4. Key Click: Indicates whether the device emits a clicking tone when users tap the touchscreen or a key. Note: To listen to your settings, tap Set and then tap Test. To retain the original settings, tap Revert. 5. Tap Set. Display Use the Display setting to adjust the brightness of the device screen. 1. Tap Settings. 2. Tap Display. 3. Brightness Control: Tap the plus (+) or minus (-) sign to adjust the brightness. 4. (Optional) To preview the setting, tap Test. 5. Do one of the following: To revert to the original brightness, tap Revert. To save the new setting, tap Set. Remote Access This function enables a device to be remotely accessed, using a VNC viewer. It is useful for troubleshooting purposes. 1. Tap Settings. 132
Settings 2. Tap Remote Access. 3. Remote Access Support: Tap Enabled. 4. Access Password: Enter the password. 5. Verify Access Password: Re-enter the password. 6. Tap Submit. To remotely access this device using a VNC viewer, you must have the following information: IP address of the device. Remote access password for the device. When you connect to this device using a VNC viewer, you can access the two keys on the front of the device: To access the device Menu key from the viewer session, press Ctrl+m. To access the device Home key from the viewer session, press Ctrl+h. Bar Code Symbology Use the Bar Code Symbology setting to specify the types of bar codes that employee badges use, so that the device can read the badges properly. When the host application sends the device configuration to this device, it overwrites the settings that you select here. Caution: If you set Interleaved 2-of-5 to False, the device cannot read a Maintenance or a Supervisor badge. Consequently, users cannot access maintenance mode or manager mode from this device. 1. Tap Settings. 2. Tap Bar Code Symbology. 3. Select True for each bar code type that employee badges use: EAN-8 (European Article Numbering 8) Interleaved 2-of-5 UPC-A (Universal Product Code A) User s Guide 133
Chapter 4 Maintenance Mode Functions UPC-E (Universal Product Code E) Code 128 Code 39 EAN-13 (European Article Numbering 13) Codabar 4. Tap Submit. Remote Readers You can connect one or two remote badge readers to a given data collection device. Remote readers can allow employees to perform simple punches. To configure remote readers: 1. Tap Settings. 2. Tap Remote Readers. 3. Remote Readers 1: Select a reader (for example, Prox). 4. (Optional) Remote Readers 2: Select the same reader that you chose in the previous step. 5. Tap Review. 6. Tap Submit. The device automatically restarts. VoIP Settings Configure the VoIP (Voice-over-Internet Protocol) settings to enable employees to use the Call for Assistance transaction (See Call for Assistance on page 53). 1. Tap Settings. 2. Tap VoIP Settings. 3. Registrar: Enter the IP address and tap Enter. 4. User Name: Enter the user name and tap Enter. 5. Password: Enter the password and tap Enter. 134
Settings 6. STUN (Session Traversal Utilities for NAT) Server: Enter the IP address and tap Enter. 7. Tap Submit. User s Guide 135
Chapter 4 Maintenance Mode Functions Advanced The Advanced functions allow you to support the biometric functions, and to perform routine maintenance and troubleshooting activities. Failure Override Note: This setting is available only for data collection devices that include a biometric device. Use Failure Override to specify whether ADP InTouch accepts or rejects biometric punches when authentication fails. 1. Tap Advanced. 2. Tap Failure Override. 3. Do one of the following: To allow punches when authentication fails, tap Accept Punches. To disallow punches when authentication fails, tap Reject Punches. Note: This setting defaults to Reject Punches. 136
Advanced Employee Enroll Count This function is available only for data collection devices that include a biometric device. It displays the number of employees who are enrolled for biometric authentication, and the number who are not enrolled. 1. Tap Advanced. 2. Tap Employee Enroll Count. Non-Enrolled Employees Note: This setting is available only for data collection devices that include a biometric device. The screen lists the employees who are assigned to the device group that includes the current device, but who are not enrolled for biometric authentication. 1. Tap Advanced. 2. Tap Non-enrolled Employees. Restart Terminal Note: You can also restart a device using the device management application. Select Device Manager > Devices > Troubleshooting > Reboot Device. Use the Restart Terminal function to restart the device. 1. Tap Advanced. 2. Restart Terminal: Tap Yes. 3. Tap Yes to confirm your selection. User s Guide 137
Chapter 4 Maintenance Mode Functions Important: If the device is not responding, you can reboot it using the restart button on the main board, which is on the inside front cover of the device. To remove the cover, use the security wrench that was shipped with the device. You must press and hold the button for four seconds. See the note on page 119, and the accompanying illustration. Change Maintenance Mode Password Use the Change Maintenance Mode Password function to change the password for a Maintenance badge, and to require users to enter a password when they swipe their badges. Note: Even if you do not require users to enter a password to access maintenance mode, you must change the default password (115190) to a new value. That is, you cannot set a blank password. 1. Tap Advanced. 2. Tap Change Maintenance Mode Password. 3. Enter the new password (six or fewer characters) and tap Enter. 4. Re-enter the new password and tap Enter. 5. (Optional) To require users to enter this password when they swipe a Maintenance badge, enable Password with Badge. 6. Tap Submit. 138
Advanced Remote Debug Mode Note: The Remote Debug Mode function requires you to first enable Remote Access (see Remote Access on page 132). The Remote Debug Mode function allows a user to remotely debug a reader, from a PC that is running UltraVNC. 1. Tap Advanced. 2. Tap Remote Debug Mode. 3. Tap Enable. 4. Tap the menu on the right side of the screen. A list of the integrated readers that are installed on the ADP InTouch appears. 5. Tap the appropriate reader. 6. Tap the appropriate badge: S (Supervisor badge) M (Maintenance badge) 7. Tap Swipe. 8. Tap OK. Note: After the ADP InTouch reboots, the Remote Debug Mode menu is disabled. To re-enable it, repeat the steps described in this section. Factory Defaults Use Factory Default to revert the device settings to the factory default settings. Caution: Use the Factory Default settings only if the device is not operating properly. You lose all previous settings and data when you perform this function. 1. Tap Advanced. 2. Tap Factory Defaults. User s Guide 139
Chapter 4 Maintenance Mode Functions 3. Tap Restore. 4. Tap Yes to confirm your selection. The device reboots. 5. Restore the Communication Settings. See Communication Settings on page 126. Delete All Punches Caution: The Delete All Punches function deletes all transactions stored in the device database. Use the Delete All Punches function to correct the Last punch invalid error. For more information, see Last punch invalid [NGT 04-2 ({failurecode})] on page 157. After you perform the Delete All Punches function, the device contains only home employee data associated with schedule enforcement. 1. Tap Advanced. 2. Tap Delete All Punches. 3. Tap Delete. 4. Tap Yes to confirm your selection. Restore HTTP (non-ssl) Note: The Restore HTTP (non-ssl) function is available only if the device uses server-initiated communication. The devices communicate with the host application in secure mode, which uses SSL for authenticating and encrypting data. Secure mode allows the host to use HTTPS when processing URLs, but it disallows HTTP. If communication fails on the host application side, perform this function to enable the host to use HTTP. You can then use methods such as SSH-SFTP to communicate with the device for troubleshooting purposes. 140
Advanced Note: The Restore HTTP (non-ssl) function does not prevent the host from using HTTPS; it only adds the ability to use HTTP. To perform the Restore HTTP (non-ssl) function: 1. Tap Advanced. 2. Tap Restore HTTP (non-ssl). 3. Tap Restore. To return the device to secure mode (that is, to disallow HTTP), access the device management application and initialize the device. Initialization restores the device to secure mode, which is its default state. Biometric Verification Note: This test applies only to devices that include the ADP QuickPunch authentication device. ADP InTouch confirms that an employee s finger scan image matches the corresponding template in the biometric device. The Biometric Verification function allows you to perform a typical biometric verification punch without creating an actual punch record for the employee. 1. Tap Advanced. 2. Tap Biometric Verification. 3. Swipe the badge that you are testing, or enter the employee s badge ID. 4. Direct the employee to place the appropriate finger on the sensor, using the same position that was used during the initial enrollment. User s Guide 141
Chapter 4 Maintenance Mode Functions If the device accepts the verification, a confirmation message appears. If the verification fails, an error message appears. Tap Retry and instruct the employee to repeat the verification process. If the verification repeatedly fails, re-enroll the employee s finger. See Biometrics on page 71. Biometric Enrollment Tutorial Video This function plays a video that shows how to enroll employees for biometric authentication. This video is also available during the enrollment process (see Biometrics on page 71). 1. Tap Advanced. 2. Tap Biometric Enrollment Tutorial Video. Calibrate Touchscreen The Calibrate Touchscreen function allows you to recalibrate the device s touchscreen, to improve its touch accuracy. 1. Tap Advanced. 2. Tap Calibrate Touchscreen. 3. Tap Calibrate. 4. Tap Yes. The device reboots, and displays the touchscreen calibration utility. 142
Advanced 5. Use a stylus pen (do not use your finger) to tap each cross-hair, as it appears on the screen. Five cross-hairs appear: one in each corner, and one in the middle of the screen. User s Guide 143
Chapter 4 Maintenance Mode Functions Reports Software report The Software report displays various file components and their version numbers. The report can reveal whether certain components are up-to-date, which can help you perform diagnostics. 1. Tap Reports. 2. Tap Software. File Systems report The File Systems report displays information about the following partitions: Boot Root Database Multimedia Staging Area For each partition, the following information appears (all sizes in megabytes): Total Size: The total size of the partition. Used: The amount of space that is currently being used. Available: The amount of available space in the partition. Used Percentage: The percentage of the partition that is currently being used. 144
Reports To run the report: 1. Tap Reports. 2. Tap File Systems. Database report The Database report displays information about the tables in the database. It includes information about punches, employees, and the biometrics function. To run the report: 1. Tap Reports. 2. Tap Database. Hardware report This report displays information about the hardware inside or attached to the device, including: The serial number of the device, and the device ID. The kinds of optional devices that are installed (for example, remote bar code reader, proximity reader, and so). The formats of the optional devices. The amount of total and used memory. The amount of total and used disk space. To run the report: 1. Tap Reports. 2. Tap Hardware. User s Guide 145
Chapter 4 Maintenance Mode Functions Communication Settings report Note: The Communication Settings report is only available with devices that operate in device-initiated mode. This report displays all of the settings that you configured using the Communication Settings function (See Communication Settings on page 126). The information in the report can help you diagnose problems with the device. To run the report: 1. Tap Reports. 2. Tap Communication Settings. Network report The Network report displays the network configuration for the device. It indicates whether the remote access feature is enabled, and which IP address format the device is using: IPV4 or IPV6. It includes the IP addresses for the primary and secondary domain name servers (DNS). For information about enabling the DNS feature, see Communication Settings on page 126. To run the report: 1. Tap Reports. 2. Tap Network. Device Status report Use the Device Status report to display information about a particular device, including: The version number of the operating system. The device ID. The version number of the database schema. The version number of the application firmware. 146
Reports To run the report: 1. Tap Reports. 2. Tap Device Status. Memory report The Memory report displays the amount of memory on the device. It includes the amount of total memory, free memory, and swap memory. To run the report: 1. Tap Reports. 2. Tap Memory. Ethernet report This report displays information about the Ethernet connection to the device. The statistics reflect the activity since the device was last restarted, including: The MAC (Media Access Control) address. The Ethernet speed. The number of packets that were transferred and received. The number of transfer and receive errors that occurred. The number of collisions that occurred. To run the report: 1. Tap Reports. 2. Tap Ethernet. User s Guide 147
Chapter 4 Maintenance Mode Functions Readers report The Readers report displays information about the badge readers that are attached to the device. The content varies, depending on the type of reader, but it includes: The type of reader. The device state. The firmware version number. The number of good reads. The number of bad reads. To run the report: 1. Tap Reports. 2. Tap Readers. Biometric report The Biometric report is available only for ADP InTouch devices that include a biometric authentication device. The report displays statistics about the biometric activity at the device, including: The number of templates that are stored in the biometric device. If a single employee enrolls both a primary and a secondary finger, the device counts them as two templates. The maximum number of templates that the device can hold, and the current number of templates. The number of successful finger scan images. The number of times that the device could not associate a template with the badge ID of an employee. The number of firmware and hardware errors associated with the device. 148
Reports Note: The number of event occurrences are cumulative totals for the life of the biometric device. You cannot reset the totals or report on specific time spans. 1. Tap Reports. 2. Tap Biometric. User s Guide 149
Chapter 4 Maintenance Mode Functions Tests Sequential test Use the Sequential test to execute the Display, LED, and Tone tests, in succession. When the beeper emits two tones, the test is complete. Note: You can run each test included in the Sequential Tests function individually, using each test s maintenance function. 1. Tap Tests. 2. Tap Sequential. 3. Tap the play button. The tests execute automatically. Communications test Note: The Communications test is available only on devices that use deviceinitiated communication. On devices that use server-initiated communication, use the Test Device function in the device management application. 150
Tests Use the Communications test to determine whether the data collection device is communicating properly with the application server. The application server is also known as the primary server. The information on the report includes: The outcome of the test (Success or Failure). The primary server IP address. The primary server instance ID. The primary server port. To run the test: 1. Tap Tests. 2. Tap Communications Test. The device contacts the primary server and then displays the results screen. Integrated Badge test Use the Integrated Badge test to check a badge or badge reader. 1. Tap Tests. 2. Tap Integrated Badge. 3. Swipe the badge that you are testing. The information that appears depends on the type of badge you are testing. It can include the following: Symbology Badge Data Badge type Barcode length Company code String Part1 String Part2 String Part3 User s Guide 151
Chapter 4 Maintenance Mode Functions Display test Note: You can execute the Display test, Tone test, and LED test as a group by running the Sequential test. See Sequential test on page 150. Use the Display test to check the device s screen. 1. Tap Tests. 2. Tap Display. 3. Tap the play button. A pattern of vertical bars in each of the following color arrangements appears: Red, green, blue, black, white. Green, blue, black, white, red. Blue, black, white, red, green. Black, white, red, green, blue. White, red, green, blue, black. Tone test Use the Tone Test to ensure that the device s beeper is operating. 1. Tap Tests. 2. Tap Tone. 3. Tap the play button. The device emits a tone during this test. If the test is successful, the message Tone Detected appears. 152
Tests LED test Use the LED Test to ensure that the device s LED lights are working. Note: This test does not test the LED light on an attached remote reader. 1. Tap Tests. 2. Tap LED. 3. Tap the play button. If the test is successful, the lights flash, in succession, red, green, and yellow. User s Guide 153
Chapter 4 Maintenance Mode Functions GPIO Output Bits test Output bits are electronics that control external devices such as bells or door strikes, which are attached to ADP InTouch. Use the GPIO Output Bits test to ensure that these external devices are operating. 1. Tap Tests. 2. Tap GPIO Output Bits. 3. Tap the button that corresponds with the output bit (1-4) that you are testing to toggle the output bit between an on or off state. Monitor GPIO Inputs test 1. Tap Tests. 2. Tap Monitor GPIO Inputs. 3. Tap the play button. Microphone test This test ensures that the integrated microphone is operating properly. 1. Tap Tests. 2. Tap Microphone. 3. Tap the record button (red dot). If the recording is successful, the message Recording Complete appears. 4. To listen to the recording, tap the play button. Remote Badge test This test ensures that the remote badge reader is operating properly. 1. Tap Tests. 2. Tap Remote Badge. 3. Tap the play button. 154
Chapter 5 Error Messages and Troubleshooting This chapter contains the following sections: Error messages on page 156. Troubleshooting on page 164.
Chapter 5 Error Messages and Troubleshooting Error messages ADP InTouch displays various error messages to help you perform transactions and diagnose problems. Some of the error messages contain a message number, with the prefix NGT. A portion of these messages may also include a failure code, as in the following example: Schedule violation [NGT 05-1 ({failurecode})] When you call your product s representative for support, refer to the message number and failure code. Note: Different error messages can have the same message number. In addition, identical error messages can appear in different contexts. Some error messages contain {n}, where n represents dynamic content, such as a number or word. The system dynamically inserts the content of {n} into the string, as required by the device transaction. See the following examples: Field precision is {n} [NGT 94-20] Maximum value is {n} [NGT 96-1] Exact length is {n} [NGT 96-3] This section includes some of the more common error messages and how to address them. For a complete list of the error messages and text strings, see the guide to translating and customizing the ADP InTouch interface. Error reading badge data [NGT 01-1] The device detected a badge swipe, but it could not interpret the data correctly. Administrators: Depending on the type of reader, run one of the following tests: Integrated Badge (see Integrated Badge test on page 151) Remote Badge (see Remote Badge test on page 154) 156
Error messages Unrecognized badge format [NGT 02-1] The device can decode the data on the badge, but the bar code does not match any of the associated formats. Administrators: Use the Bar Code Symbology setting to specify the appropriate types of bar codes that employee badges use (see Bar Code Symbology on page 133). Supervisor badge is not allowed [NGT 02-6] The device does not permit access to Manager mode by swiping a Supervisor badge. Only employees who are assigned a Manager license in the timekeeping application can swipe their badges to access Manager mode. Punch rejected [NGT 04-1 ({failurecode})] The time that has elapsed since the last punch is less than the required minimum time between punches. Last punch invalid [NGT 04-2 ({failurecode})] The date and time of the last punch is in the future, so the system cannot perform schedule enforcement. Schedule violation [NGT 05-1 ({failurecode})] The schedule enforcement logic rejects the employee s punch. The failure codes provide details about addressing these violations: 101 You are attempting to punch too soon after your previous punch. Wait until the repunch interval passes, and then punch again. Administrators: The Restrict Punch Interval defines the amount of time that must elapse before an employee can repunch. Use the device management application to configure this parameter. User s Guide 157
Chapter 5 Error Messages and Troubleshooting 102 The device management application has not downloaded the punch interpretation rule that you are assigned to. Administrators: Use the device management application to download the appropriate punch interpretation rule to the device. 104 A previous punch has a future date and time stamp, so the system cannot accept another punch until after the date and time of your previous punch. 105 You are attempting to punch too soon after your previous punch. Wait until the repunch interval passes, and then punch again. Administrators: The Restrict Punch Interval defines the amount of time that must elapse before an employee can repunch. Use the device management application to configure this parameter. 108 You are attempting to start a new shift at an unscheduled time. Wait until the start of your next scheduled shift, and then punch in. Administrators: The Restrict Unscheduled In-punches parameter directs the device to reject in-punches from employees who do not have a scheduled shift. Use the timekeeping application to configure this parameter. 109 You are attempting to punch in too early for your next shift. Wait until the start of your next scheduled shift, and then punch in. Administrators: The punch must be within the Early Start Margin associated with the scheduled start time. Use the timekeeping application to configure this parameter. 110 You are attempting to punch in too late to start your next shift. Administrators: The punch must be within the Late Start Margin associated with the scheduled start time. Use the timekeeping application to configure this parameter. Managers: To allow the employee to punch in, perform a Schedule Override transaction, or use the scheduling application to change the employee s schedule. 111 You are attempting to punch out too late to end your shift. 158
Error messages Administrators: The punch must be within the Late End Restriction associated with the scheduled end time. Use the timekeeping application to configure this parameter. Managers: To allow the employee to punch out, perform a Schedule Override transaction. 112 You are attempting to punch out too early to end your current shift. Wait until the end of your shift, and then punch out. Administrators: The Begin Early End Restriction and Lift Early End Restriction parameters determine when employees can punch out before the end of a shift. Use the timekeeping application to configure these parameters. 113 You are attempting to punch out too early to end a meal. Wait until your minimum meal time elapses, and then punch out. Administrators: The punch must be after the minimum meal time has elapsed, as defined in the Minimum Meal parameter. Use the timekeeping application to configure this parameter. 114 Your punch interpretation rule is set for simple schedules, but you are not assigned to a valid schedule. Administrators: The Punch Restrictions setting specifies whether the device enforces full or simple schedules. Use the timekeeping application to configure this parameter. If you select Simple, you must assign a schedule to the employee. 115 You are not allowed to punch out for a break because you are working an unscheduled shift, or your current shift has no scheduled breaks. Administrators: The Enable Schedule Enforcement setting directs the device to reject home employee punches that are not based on their schedules. Use the device management application to configure this parameter. 116 You are attempting to punch out for a break too early. Wait until the start of your next break, and then punch out. Administrators: The Early Start Break Margin parameter specifies how long before scheduled breaks and meals employees can punch out. Use the timekeeping application to configure this parameter. User s Guide 159
Chapter 5 Error Messages and Troubleshooting 117 You are attempting to punch out too late to start a scheduled break, or you are attempting to punch out too early to end your shift. Administrators: The Late Start Break Margin specifies how long after the start of scheduled breaks and meals that employees can punch out. The Begin Early End Restriction and Lift Early End Restriction parameters prevent employees from punching out too early to end a shift. Use the timekeeping application to configure these parameters. 118 You are attempting to punch in from a break too late. Administrators: The punch must be within the Late End Break Margin associated with the break. Use the timekeeping application to configure this parameter. Managers: To allow the employee to punch in, perform a Schedule Override transaction. 119 You are attempting to punch in from a break too early. Wait until the end of your current break, and then punch in. Administrators: The punch must be after the Minimum Meal time (which also governs breaks) has elapsed. Use the timekeeping application to configure this parameter. 120 You have already taken the break scheduled for this time. Wait until your next scheduled break or the end of your shift, and then punch out. Administrators: The employee has punched twice within the Late Start Break Margin (this parameter is in the timekeeping application). The device interprets the second punch as an improper attempt to punch out for the same break. 121 You entered an invalid password for logging on as a manager. Valid for home employees only [NGT 06-1] This transaction can only be performed by home employees, but the employee badge does not match any of the home employees loaded in the device. 160
Error messages Unknown home employee [NGT 06-2 ({failurecode})] The employee badge does not match any of the home employees loaded in the device. Managers: Access manager mode and swipe the employee badge, or enable a single or global restriction credit. Administrators: Use the device management application to allow non-home employees to punch, or add the employee to the device group and then update the device. Invalid function for this employee [NGT 06-4] The employee is attempting to perform a manager mode transaction (for example, Change Password), but has not swiped a supervisor badge. Invalid restriction level [NGT 08-1 ({failurecode})] The employee badge does not match any of the home employees loaded in the device. Non-home employees are allowed to punch, but not for the restriction level encoded on the badge. Managers: Access manager mode and swipe the employee badge, or enable a single or global restriction credit. Administrators: Use the host application to allow non-home employees to punch, with the restriction level encoded on the badge. Invalid for home employees [NGT 09-1] The employee badge matches a home employee who is loaded in the device, but only non-home employees can perform this transaction. Managers: Access manager mode and enable a single or global non-home restriction override. Security violation [NGT 11-1 ({failurecode})] User s Guide 161
Chapter 5 Error Messages and Troubleshooting No punches allowed now [NGT 17-1 ({failurecode})] DB failure for Passwords [NGT 36-4] An error occurred when the device attempted to update its database with a new password. No restriction profile assigned [NGT 41-1 ({failurecode})] The punch interpretation rule that the employee is assigned to is not available. Enter valid data [NGT 94-8] The invalid value that the user entered may appear to the right of the message. Negative values not allowed [NGT 94-13] Positive values not allowed [NGT 94-19] Field precision is {0} [NGT 94-20] You have not entered the required number of digits after the decimal point. Password is incorrect [NGT 95-1 ({failurecode})] You entered an invalid password for the Supervisor or Maintenance badge. Enter data in decimal format [NGT 95-5] Maximum length is {0} [NGT 96-1] Minimum length is {0} [NGT 96-2] 162
Error messages Exact length is {0} [NGT 96-3] Maximum number of digits is 16 [NGT 96-4] User s Guide 163
Chapter 5 Error Messages and Troubleshooting Troubleshooting This section provides some first steps you can take to perform troubleshooting. There are three ways to troubleshoot a device: Using the device. Using a remote PC. Using the device management application. Note: To troubleshoot more complicated hardware problems, which may require an electrician, see the ADP InTouch installation guide, or contact your product representative. Using the device Communications To diagnose communication problems between the device and the application or primary server, perform one or more of the following functions: Restore HTTP (non-ssl) Enables the host to use HTTP, when communication fails on the host application side. See Restore HTTP (non-ssl) on page 140. This transaction is available only if the device uses server-initiated communication. Communications test Determines whether the device is communicating properly with the application server. See Communications test on page 150. This test is available only on devices that use device-initiated communication. On devices that use server-initiated communication, use the Test Device function, in the device management application. Communications Settings report Displays the settings that were entered in the Communication Settings. See Communication Settings report on page 146. This report is only available with devices that operate in device-initiated mode. 164
Troubleshooting Biometrics To diagnose problems related to biometric authentication devices, run the following reports: Biometric report Displays biometric statistics, including the number of firmware and hardware errors associated with a device. See Biometric report on page 148. Biometric Templates report Displays templates that have low scores or other problems. See Biometric Templates Report on page 111. Badges To diagnose problems with badges and badge readers, run the following tests: Integrated Badge test Confirms whether a badge or badge reader is functioning properly. See Integrated Badge test on page 151. Remote Reader test Confirms whether a remote badge reader is working properly. See Remote Badge test on page 154. Display To address problems with the device s touchscreen or LED lights, perform one or more of the following functions: Calibrate Touchscreen Recalibrates the device s touchscreen. See Calibrate Touchscreen on page 142. Display test Confirms that the device s screen displays properly. See Display test on page 152. LED test Confirms that the device s LED lights are working. See LED test on page 153. User s Guide 165
Chapter 5 Error Messages and Troubleshooting Audio To ensure that the audio components of the device are working correctly, run the following tests: Microphone test Confirms that the device s microphone is operating properly. See Microphone test on page 154. Tone test Confirms that the device s beeper is working. See Tone test on page 152. External devices If external devices (for example, bells or door strikes) are attached to the ADP InTouch, run the following tests to ensure that they are operating properly. GPIO Output Bits test See GPIO Output Bits test on page 154. Monitor GPIO Inputs test See Monitor GPIO Inputs test on page 154. Device status icons One or more status icons can appear on the employee mode home page. Four of them indicate problems that require immediate attention: Running on battery backup Low disk space Network communications error System maintenance required For details, see Device status icons on page 31. 166
Troubleshooting Using a remote PC To diagnose device problems using a remote PC, perform the following functions: Remote Access Enables a device to be remotely accessed, using a VNC viewer. See Remote Access on page 132. Remote Debug Mode Allows an authorized user to remotely debug a reader, from a PC that is running VNC. See Remote Debug Mode on page 139. Note: To use this function, you must first enable Remote Access. Using the device management application A user can troubleshoot certain device operations from the device management application. Select Device Manager > Devices > Troubleshooting. The options include: Test Device View Device Transactions Find Employee Transactions Retrieve Logs View Log Report View Device Configuration Data For details, see the system administrator s guide for the device management application. User s Guide 167
Chapter 5 Error Messages and Troubleshooting Restarting devices There are three ways to restart a device: Using the Restart Terminal function See Restart Terminal on page 137. Using the internal restart button If a device is unresponsive, an authorized user can reboot it using the restart button, which is located inside the device. For details, see the note on page 119, and the accompanying illustration. Using the host application In the device management application, select Device Manager > Devices > Troubleshooting > Reboot Device. 168