TimeBase Field Installation Guide

TimeBase Clocks

TimeBase Clocks Overview

UKG Pro TimeBase clocks are designed to work with UKG ProTime and Attendance systems.

The TimeBase Installation Guide provides basic steps for mounting and connecting your TimeBase clock to the Internet and your Time and Attendance system.

UKG preconfigures your TimeBase clock prior to shipment to ensure a quick and successful installation. The preconfiguration includes adding the clock to your Time and Attendance system and the UKG ProTouchBase host, your time clock communications server. The goal is to provide you with a seamless activation experience. Your time clock is ready for use when power and Internet connectivity are enabled.

TimeBase Clock Interface with Display Options
Note

If you require installation assistance, please contact your Time Clock Activation Specialist.

TimeBase Hardware

TimeBase Clock Requirements Specification

TimeBase clocks require specific critera for installation.

Topic Requirements
Physical Dimensions
  • Width: 8.0 inches
  • Height: 5.6 inches
  • Depth: 1.8 inches (measured at lowest point of device)
  • Weight: 1.2 pounds
    Note Measured dimensions and weight do not include badge readers or other optional accessory hardware that may be installed or connected to the TimeBase clock.
Power Supply
  • AC power or optional Power over Ethernet (PoE) module
  • 110V AC (integrated 12VDC power adapter included for AC standard power)
  • Optional: Power over Ethernet (PoE) module; 802.3af compliant; 15 watts at 5V
  • TimeBase also operates with PoE+(802.3at) power-sourcing equipment (PSE)
  • Contact your Time Clock Activation Specialist to purchase PoE module
Environment
  • Operating temperature: +32° to +113℉ (0° to +45℃)
  • Non-operating (storage) temperature: -4° to 113℉ (-20° to 45℃)
  • Relative humidity: 5% to 80% non-condensing
  • Maximum operating altitude: 10,000 feet (3000 meters)
Connection
  • Standard Ethernet (10/100 Base-T) Port 443 must be open in switch and router settings
  • Wi-Fi (802.11 a/b/g 2.4 GHz - WEP, WAP, WAP₂ encryption standards)
    Important Port 443 must be available on the switch or router to allow communications between the TimeBase clock and the TouchBase host.

Verify Package Contents

TimeBase clocks include specific package components for installation.

  1. Open and unpack the TimeBase clock box.
  2. Verify that the box contains the following items:
    Item Quantity Image
    TimeBase Clock 1 One TimeBase Clock
    Rubber Gasket 1 One Rubber Gasket
    Mounting Guide 1 One Mounting Guide
    Back Plate 1 One Back Plate
    Screws and Anchors 6 each Six Screws and Six Anchors
    AC Power Adapter 1 One AC Power Adapter
    Network Cable 1 One Network Cable
    T8 Torque Screwdriver 1 One Screwdriver
    Torx Screws 2 Two Star Screws
    Cables and Diode 2 Two Cables and Diodes
    Test ID Card 1 One Test ID Card
  3. Retain the box, cables, and any other unused parts for future use.

TimeBase Clock Installation Requirements

Biometric Reader Placement

TimeBase clocks include device placement recommendations for the TimeBase Biometric Reader.

External light luminance must not exceed 8000 LUX for proper operation of the fingerprint sensor on the TimeBase Biometric Reader.

Avoid direct sunlight. Install the device indoors at least 10 feet (3 meters) away from windows and 6.5 feet (2 meters) away from light fixtures.

Proper placement of Biometric Reader
Mount each clock at the same height, especially if employees complete punches at multiple time clocks. Consistent finger placement ensures optimal scanning of all time clock readers.
Important This recommendation applies to biometric time clocks located in one or more facilities.

TimeBase Clock Installation Site

Site recommendations for TimeBase clock installation to ensure a successful reading.

Site Recommendation Site Recommendation Image
Avoid direct sunlight outdoors Avoid direct sunlight outdoors
Avoid direct sunlight from a window Avoid sunlight from windows
Avoid reflected sunlight from mirrors or other reflective surfaces Avoid reflected sunlight
Avoid bright light fixtures Avoid bright light fixtures

Install a TimeBase Clock

Mount TimeBase Clock to Wall

TimeBase clocks must be mounted securely to a wall.

  1. If the mounting plate is attached to the TimeBase clock, remove the screw at the bottom edge with the supplied screwdriver.
    Back Plate from TimeBase Clock Removal
  2. Determine the position of the mounting plate on the wall. Mount the TimeBase clock on the wall approximately 4-5 feet from the ground.
    Note If installing a biometric clock, make sure the height provides for comfortable finger placement on the biometric sensor. Guidelines set by the Americans with Disabilities Act (ADA) recommend mounting the clock so that the top of the time clock is no higher than 48" from the floor.
  3. Apply the mounting template to the desired location. Mark the four screw locations and wiring access hole (if running wires through the wall).
    Mounting Template Installation Location
  4. Cut out the wiring access hole (approximately 1½ x 1½ inches) for cables.
  5. Line up the opening of the mounting plate with the newly cutout opening on the wall.
  6. Screw the plate to the wall, and pull the cables through the cutout opening.
    Mounting Plate Installation with Wall Screws Location
  7. Connect the power and Ethernet cables to the appropriate connections on the back of the TimeBase clock.
  8. Connect the supplied AC Power Adapter to a local 110VAC/60Hz power socket in the recessed hole on the back of the TimeBase clock.
    Supplied AC Power Adapter Connection Location
  9. If your TimeBase clock is connected to your network via a wired Ethernet connection, attach a 10/100Base-T Ethernet cable from a local network connection to the RJ45 connector in the recessed hole on the back of the clock. TimeBase clocks require a connection to the Internet in order to communicate with your time system.
    Ethernet Cable Installation Location
    Important If you have ordered optional Power over Ethernet (PoE) adapter or optional battery backup accessories for your clock(s), be sure to install these components before continuing with the mounting process. Follow the instructions in the Install an Optional Battery to a TimeBase Clock section and the Install an Optional PoE Converter section.
  10. Attach the TimeBase clock terminal to the back plate.
    Time Clock Terminal Connection to Back Plate
  11. Secure the TimeBase clock terminal to the back plate using the supplied screwdriver and star-shaped screw.
    Clock Secured to Back Plate
    Important Check that the mounting plate is securely tightened to the wall.

Install an Optional Battery to a TimeBase Clock

The operational battery backup is an optional accessory. If you have not ordered batteries with your clock(s), skip this section. If a battery is installed, the clock should stay online during a power outage. To order a battery, open a support case via the UKG Community for assistance.

  1. To connect the battery, first disconnect the DC charger.
  2. Connect the DC charger to the battery, and the battery to the clock.
    Battery Connected to TimeBase Clock

Connect TimeBase Clock to Ethernet Cable

TimeBase clocks are connected to the TouchBase host using an Ethernet cable.

UKG preconfigures the Ethernet cable connection prior to shipping the TimeBase clock. Preconfiguration information is included in case a reconnect is required after installation.
  1. Press the M/↲ (Administrative Menu) button on the number pad and enter the Admin user identification number (ID) and password (PWD) provided by your Time Clock Activation Specialist.
  2. Select OK.
  3. Press M/↲ again to bypass the locked Admin Affirm page.
  4. Select OK to turn off the alarm prompt.
  5. Select Comm (Communications).
  6. Select Network.
  7. Select the IP address method:
    • For Static IP addressing, toggle DHCP to OFF using the arrow key.

      Enter the Static IP information in the applicable fields. Select OK.

      Static IP Information with DHCP turned to OFF
    • For DHCP IP addressing, toggle DHCP to ON using the arrow key.DHCP Network IP Information with DHCP turned to ON

      The IP information from your network DHCP server automatically populates to the applicable fields.

Install an Optional PoE Converter

The Power over Ethernet (PoE) converter is an optional accessory that allows clocks to be powered via network cable instead of DC charger. If you have not ordered a PoE converter with your clock(s), skip this section.

The PoE converter and the cable harness are connected between the clock and the Ethernet cable connection.
  1. Connect the Ethernet cable and the harness to the PoE converter, ensuring they are connected in the correct direction.
    PoE Converter
  2. Connect the other end of the harness to the clock.
    PoE Converter Connected to Clock
  3. Optional: If you want to use both the PoE converter and the battery, connect the battery between the PoE harness and the clock.
    PoE Converter and Battery Connected to Clock

Connect TimeBase Clock to Wi-Fi

TimeBase clocks are Wi-Fi enabled, although Ethernet cable connectivity is the preferred connection method.

  1. Press the M/↲ (Administrative Menu) button on the number pad and enter the Admin user identification number (ID) and password (PWD) provided by your Time Clock Activation Specialist.
  2. Select OK.
  3. Select OK to turn off the alarm prompt.
  4. Select Comm (Communications).
  5. Select Network.
  6. Select the network SSID to which you want to connect.
    Network SSID List Selection
    After selecting the network SSID, the Password Setup login page to access the Wi-Fi network appears.Wi-Fi Password Setup Login with Password Prompt Displayed
  7. Choose one of two options for creating and loading the Wi-Fi password:
    • Enter the Wi-Fi password using the keypad.
    • Enter the Wi-Fi password using a personal USB thumbdrive.
    Keypad Entry Thumbdrive Entry
    Press * to access the alphanumeric key entry system. Using the personal USB thumbdrive, create a file entitled:

    zkoption.txt

    Using the arrows, navigate to Load Password and select OK. Input the following text to the file:

    WIFIPassword=<enterYourPasswordHere>

    Select OK to exit. Save the file and eject the thumbdrive.
    Insert the thumbdrive to the USB slot on the left side of the TimeBase clock.
    Using the arrows, navigate to Load Password and select OK.
    Select OK to exit.
  8. Confirm that an IP address has been appropriately assigned by navigating to the Wi-Fi Setup icon and verifying the IP address code.
    TimeBase Clock Menu with Wi-Fi Icon Selected IP Address Assignment for Verification

TimeBase Network Verification

TimeBase clocks provide a connection verification status.

TimeBase clocks include a Network Status icon in the upper right corner. A successful connection for power and the Internet displays as a green checkmark.

Network Status Icon with Green Checkmark Display
Important If the Network Status icon displays a red status LED or a red X, contact your local IT specialist to verify Internet connection.

Create a Test Punch

Create a test punch using the preconfigured test employee badge number.

The TimeBase clock is preconfigured for a test employee. The test badge number is 999999. Check with your Time Clock Activation Specialist to confirm the test badge number.
  1. Using the TimeBase keypad, enter badge number 999999.
  2. Select OK.
    The clock displays a successful test punch with the punch date and time.

Register TimeBase Clock on TouchBase Host

Register the TimeBase clock on the TouchBase host via the URL address.

UKG completes the host registration process prior to shipping the TimeBase clock. Registration information is provided in case a factory reset is required after installation. Additional information, such as the configuration company prefix, URL, and passwords, is provided by your Time Clock Activation Specialist.

Based on successful power and Internet connections to the TimeBase clock, complete the following:

  1. Press the M/↲ (Administrative Menu) button using the keypad.
  2. Enter the Admin user identification (ID) number and password (PWD) provided by your Time Clock Activation Specialist.
  3. Select OK.
  4. Select Comm (Communications) from the Administrative Menu.
  5. Select Web Setup from the Communications Menu.
  6. Using the navigation arrows, change the WebServer to URL Mode and Load URL.
    Web Setup with URL Mode Selected for WebServer and Load URL Highlighted
  7. Select OK.

Register TimeBase Clock Using USB Thumbdrive

Register a TimeBase clock using a personal USB thumbdrive to connect to the TouchBase host.

UKG completes the host registration process prior to shipping the TimeBase clock. Registration information is provided in case a factory reset is required after installation. You can also register several clocks in multiple locations using this method. Contact your Time Clock Activation Specialist to obtain the configuration company prefix or URL needed for registration.
  1. Using a personal USB thumbdrive, create the file:

    zkoption.txt

  2. Access the file and enter the following text:

    WebURL=https://<client_unique_url>.com:443/touchbasehost

  3. Save the file. Eject the thumbdrive.
  4. Insert the thumbdrive to the USB slot on the left side of the TimeBase clock.
    The Web Setup screen appears.
  5. From the Web Setup screen, navigate to Load URL and select OK.

Authenticate the TimeBase Clock

Authenticate the TimeBase clock from the TouchBase host with the credentials provided by your Time Clock Activation Specialist.

The TouchBase host administrator must authenticate the TimeBase clock from the TouchBase host for security reasons. The URL, username, and password are provided by your Time Clock Activation Specialist. After authentication is complete, configuration files are downloaded and the TimeBase application is configured. An authentication verification process takes place between the TimeBase clock and the TouchBase host on a reoccurring basis.
Note If the TimeBase clock was previously authenticated on the host, refer to the TouchBase Host Administrator Guide for instructions on how to re-authenticate a revoked device.
  1. Authenticate the new TimeBase clock. Use a Web browser to navigate to the TouchBase host and sign in with the URL and credentials provided by your Time Clock Activation Specialist.
  2. Locate the device (device name: Unknown) in the TimeBase clock list. Locate the device by its serial number (located on the sticker on the back of the TimeBase clock).
  3. Enter part of the device name or the serial number in the Search box to search for a device.
    TimeBase List Page
    Only those names that match what was entered in the Search box appear in the updated list.
    Tip Use the wildcard character, %, in place of an actual character to display additional devices. For example, a search for %bc displays records for abc, bbc, cbc, and so on.
  4. Select the device name, Unknown, in the Name field.
    The Edit TouchBase dialog box opens.
  5. Enter the following information in the Edit TouchBase dialog box for the TimeBase clock:
    OptionDescription
    NameName of the TimeBase clock (for example, Front Entry, indicating its location)
    Important The clock name selected for the TouchBase host must match the clock name in Time and Attendance.
    GroupSelect the appropriate group option from the drop-down menu
    ConfigurationSelect the appropriate configuration option from the drop-down menu
    Time ZoneSelect the appropriate time zone option from the drop-down menu (Java time zone displays upon installation)
  6. Select Save.
    The TimeBase List page reopens.
  7. Locate the device in the list and select Authenticate.
    The TouchBase host authenticates the device. The device downloads the configuration files from the host and configures the TimeBase application.

Register a Fingerprint in TimeBase

Establish Employee Fingerprint Identification

TimeBase clock access requires fingerprint identification for employees.

  1. Press the M/↲ (Administrative Menu) button on the number pad and enter the Admin user identification number (ID) and password (PWD) provided by your Time Clock Activation Consultant.
  2. Select OK.
  3. Select User Mng (User Management).
  4. Select Manage.
  5. Select the employee.
  6. Select OK.
    Note Search for an employee by entering the Badge ID on the keypad and selecting OK.
    Employee Selection List for Enrollment
  7. Select Enroll FP (Enroll Fingerprint) from the Edit Enroll FP screen.
    Enroll FP Button Selection
  8. Ask the employee to place a thumb or index finger on the biosensor and push down to obtain the fingerprint image.
    Important Remove the protective tape from the biosensor before employee finger placement.
    Enroll Fingerprint Screen with Pressed Fingerprint
  9. Follow the prompts on the Quality Color indicator. Three distinct presses of the same finger are required.
    Enroll Fingerprint Screen with Two of the Three Required Finger Impressions
    After three successful fingerprint impressions, a green check mark icon appears.Enroll Fingerprint Screen with Successful Fingerprint Registration

Troubleshooting Solutions

TimeBase Clock Troubleshooting Solutions

TimeBase clock troubleshooting solutions for common issues are available.

Issue Cause Fix
Power LED is off.
  • No power
  • No voltage
  • Examine power and ground connections
  • Ensure the 110v plug has power
  • Try another 12v power adapter
TimeBase clock is unable to connect to the TouchBase host.
  • Loose connection
  • No Internet connection
  • Check that the Ethernet cable connections are secure
  • If using Wi-FI, ensure that the SSID and password are correct
  • Verify that network and firewall settings are not blocking communication to the Internet
LCD displays the following message after attempting to clock in with a fingerprint: "Please try again."
  • Fingerprint sensor is unable to obtain a clear fingerprint image; sensor may have accumulated excess dirt or scratches
  • Fingerprint sensor cable is loose from circuit board
  • Employee may have a previous fingerprint enrollment that should be deleted before a new enrollment can proceed
  • Clean the sensor with a moist tissue
  • Check if sensor needs to be repaired or replaced. Contact the Time Clock Support Team
Time clock continually displays 00:00 after restarting the device.
  • Drained clock battery
  • Replace the battery
Keypad buttons do not produce a sound when pressed.
  • Buzzer, loudspeaker, or circuit board issue
  • Contact the Time Clock Support Team
New employee fingerprint cannot be verified.
  • Poor fingerprint quality
  • If repeated attempts with the same finger fail to register, use a different finger
  • Reduce the fingerprint threshold setting
  • If an employee's fingerprints are completely unreadable, assign a PIN number to the employee instead