Data Collection Manager System Administrator's Guide

Data Collection Manager System Administrators Guide
An administrators guide to configuring the Data Collection Manager system and to monitoring and managing communication between data collection devices and the applications that manage transactions. Data Collection Manager Version 5
Document Part Number: 4703096-001 Document Revision: A
The information in this document is subject to change without notice and should not be construed as a commitment by Kronos Incorporated. Kronos Incorporated assumes no responsibility for any errors that may appear in this manual. This document or any part thereof may not be reproduced in any form without the written permission of Kronos Incorporated. All rights reserved. Copyright 20012004. Cambridge Clock, CardSaver, Datakeeper, Datakeeper Central, eForce, Gatekeeper, Gatekeeper Central, Imagekeeper, Jobkeeper Central, Keep.Trac, Kronos, Kronos Touch ID, the Kronos logo, My Genies, PeoplePlanner, PeoplePlanner & Design, Schedule Manager & Design, ShopTrac, ShopTrac Pro, StarComm, StarPort, StarSaver, StarTimer, TeleTime, Timekeeper, Timekeeper Central, TimeMaker, Visionware, Workforce Accruals, Workforce Central, Workforce Decisions, Workforce Express, Workforce Genie, and Workforce TeleTime are registered trademarks of Kronos Incorporated or a related company. Comm.Mgr, CommLink, DKC/Datalink, FasTrack, HyperFind, Improving the Performance of People and Business, Kronos 4500, Kronos 4500 Touch ID, Kronos e-Central, KronosWorks, Labor Plus, Schedule Assistant, Smart Scheduler, Smart View, StartLabor, Start Quality, Start WIP, Starter Series, Timekeeper Decisions, Timekeeper Web, VisionPlus, Winstar Elite, WIP Plus, Workforce Activities, Workforce Connect, Workforce Employee, Workforce HR, Workforce Manager, Workforce MobileTime, Workforce Payroll, Workforce Record Manager, Workforce Recruiter, Workforce Scheduler, Workforce Smart Scheduler, Workforce Tax Filing, Workforce Timekeeper, and Workforce View are trademarks of Kronos Incorporated or a related company. All other trademarks or registered trademarks used herein are the property of their respective owners and are used for identification purposes only. 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. Published by Kronos Incorporated 297 Billerica Road, Chelmsford, Massachusetts 01824-4119 Phone: 978-250-9800, Fax: 978-367-5900 Kronos Incorporated Global Support: 1-800-394-HELP (1-800-394-4357) For links to information about international subsidiaries of Kronos Incorporated, go to: http://www.kronos.com Document Revision History Document Revision A Product Version DCM 5.0 Release Date March 2004
Contents
About This Guide Organization of This Guide ........................................................................ xvi Abbreviations and Terms ......................................................................... xviii Related Documents..................................................................................... xix Chapter 1: Introducing Data Collection Manager Overview ....................................................................................................1-2 DCM Applications ......................................................................................1-3 Communication Monitor ......................................................................1-3 Device Manager ...................................................................................1-4 Event Manager .....................................................................................1-5 Sentinel Service ...................................................................................1-5 Accessing the Data Collection Manager Applications ...............................1-7 About the Cross-Launch Utility ...........................................................1-8 About the DCM Integrated Logon Utility ...........................................1-8 Logging on to DCM and Workforce Timekeeper ................................1-8 Reports About DCM in Workforce Timekeeper ..................................1-9 Steps for Configuring the Data Collection Manager ................................1-10 Chapter 2: Defining an Application Connection Overview ....................................................................................................2-2 Application Connections ............................................................................2-3 Editing an Application Connection Description ..................................2-3 Deleting an Application Connection ....................................................2-3 Creating a New Application Connection .............................................2-4 The DCM Application Transaction Count .................................................2-6 Chapter 3: Communication Channels Overview ....................................................................................................3-2 Creating Communication Channels ............................................................3-3 Modem Channels .................................................................................3-4
Contents
Series 4000 Communication Channels ................................................ 3-5 Series 400 Communication Channels .................................................. 3-6 Configuring a Modem for a Series 4000 Terminal .............................. 3-6 About IP Addresses for the Communication PC and Series 4000 Terminals................................................................ 3-6 About Dial-Up Networking ............................................................... 3-10 Prerequisites................................................................................. 3-11 Configuring a Dial-up Entry on Windows 2000.......................... 3-12 Configuring Dial-up Networking on Windows NT ..................... 3-16 Configuring Dial-up Networking on Windows XP ..................... 3-19 Configuring Communication Channels in the Device Manager ............. 3-22 Defining an Ethernet Communication Channel ................................ 3-23 Series 400 Ethernet Communication ........................................... 3-25 Defining a Modem Communication Channel .................................... 3-26 Defining a Serial Communication Channel ....................................... 3-30 Chapter 4: Device Group and Global Setup Overview .................................................................................................... 4-2 Device .................................................................................................. 4-2 Device Groups ..................................................................................... 4-3 Collecting Device Groups.............................................................. 4-4 Assigning Device Groups .............................................................. 4-4 Example of Collecting and Assigning Group Data Collection...... 4-4 The Device Manager .................................................................................. 4-5 Creating Device Groups ............................................................................. 4-7 Collecting vs. Assigning Groups ................................................... 4-9 Displaying Collecting and Assigning Group ................................ 4-9 Editing Device Groups ............................................................................. 4-10 Copying Device Groups ........................................................................... 4-11 Deleting Device Groups ........................................................................... 4-12 Adding Devices ........................................................................................ 4-13 Adding a Device by Using the Device Wizard ................................. 4-13 Adding a Device by Using the Device Manager ............................... 4-17 Viewing Devices List ........................................................................ 4-21 Assigning a Device to a Device Group .................................................... 4-22
iv
Kronos Incorporated
Contents
Assigning Devices by Using Communication Channels ...................4-22 Assigning a Device to More Than One Group.............................4-23 Editing Devices ........................................................................................4-25 Editing a Device by Using the Device Wizard ..................................4-25 Editing a Device by Using the Device Manager ...............................4-25 Copying Devices ......................................................................................4-26 Copying a Device by Using the Device Wizard ................................4-26 Copying a Device by Using the Device Manager .............................4-26 Deleting Devices ......................................................................................4-28 Deleting a Device by Using the Device Wizard ................................4-28 Deleting a Device by Using the Device Manager ..............................4-29 Bell Schedules ..........................................................................................4-30 Adding, Editing, Copying, or Deleting a Bell Schedule ....................4-32 Gate Schedules .........................................................................................4-33 Adding, Editing, Copying, or Deleting a Gate Schedule ...................4-36 Remote Transactions ................................................................................4-37 Creating a Remote Transaction ..........................................................4-38 Editing a Remote Transaction ............................................................4-40 Copying a Remote Transaction ..........................................................4-40 Deleting a Remote Transaction ..........................................................4-41 Assigning a Remote Transaction to a Function Key .........................4-41 System Settings ........................................................................................4-42 General Settings .................................................................................4-44 Log File Settings ................................................................................4-45 Log File Severity Reporting Levels .............................................4-45 Specifying the Log File Settings ..................................................4-46 Device Download Settings .................................................................4-48 Communication Settings ....................................................................4-50 Global Values Settings .......................................................................4-52 File-Based Communication Requests ..........................................4-53 Timeframe for Totals and Accruals..............................................4-56 E-Mail Notification ............................................................................4-56 WFC Connection ...............................................................................4-59 Whats Next? .....................................................................................4-62
Contents
Chapter 5: Configuring Devices Configuring Device Parameters ................................................................. 5-2 Initialization ......................................................................................... 5-3 Update .................................................................................................. 5-5 AFT Commands Tab ........................................................................... 5-6 Badge Reader Tab ............................................................................... 5-8 Reader Configuration..................................................................... 5-9 Local Reader Display..................................................................... 5-9 Badge Type Specification and Configuration.............................. 5-10 Bell Schedules Tab ............................................................................ 5-13 Default Transactions Tab .................................................................. 5-15 Assigning a Default Transaction.................................................. 5-18 Disabling an Employee Default Transaction Assignment ........... 5-18 Changing a Default Reader Transaction to Punch ....................... 5-19 Display Tab ....................................................................................... 5-20 Employee Tab .................................................................................... 5-23 FIFO Tab ........................................................................................... 5-25 Free Form XML Tab ......................................................................... 5-27 Function Key Tab .............................................................................. 5-30 Supervisor Function Key Command............................................ 5-30 Employee Function Key Task...................................................... 5-30 Gate Entry Tab .................................................................................. 5-35 Gate Schedules Tab ........................................................................... 5-38 Job Transfer Tab ................................................................................ 5-40 Jobs and Job Sets ......................................................................... 5-41 Specifying Job Transfer Settings ................................................. 5-42 Job Transfer Function Key Setting .............................................. 5-43 Labor Levels Tab ............................................................................... 5-44 Labor Transfer Tab ............................................................................ 5-46 Punch Rules Tab ................................................................................ 5-47 Supervisor Tab ................................................................................... 5-48 Loading Basic Configuration Parameters to a Device ............................. 5-49 Using the Device Manager Initialize to Load Basic Configurations to a Device or a Device Group ....................... 5-50
vi
Kronos Incorporated
Contents
Using the Communication Monitor Initialize to Load Basic Configurations to a Device or a Device Group .......................5-51 Viewing and Enabling Devices ................................................................5-52 Chapter 6: Setting Up Labor Level Information Overview ....................................................................................................6-2 Labor Levels ........................................................................................6-2 Labor Level Sets ..................................................................................6-3 Selecting Labor Level Options for the Device ...........................................6-4 Defining Labor Transfer Options ...............................................................6-6 Configuring Labor Transfer Settings ..........................................................6-9 Assigning Labor Levels to a Function Key ..............................................6-15 Removing Labor Levels from a Device ...................................................6-19 Downloading Labor Levels to a Device ...................................................6-21 Chapter 7: Totals and Accruals Overview ....................................................................................................7-2 Creating Total Definitions ..........................................................................7-3 Editing a Total Definition ....................................................................7-5 Deleting a Total Definition ..................................................................7-6 Assigning Total Definitions to Function Keys ...........................................7-7 Defining Function Key Assignments ...................................................7-7 Specifying Subtotals to Display ...........................................................7-9 Downloading Total Definitions and Accruals to a Device .......................7-10 Downloading Total Definitions and Accruals ...................................7-10 Sending Totals and Accruals to the Device .......................................7-11 Displaying Totals at the Device ...............................................................7-13 Chapter 8: Activity Codes, Comment Codes, and Pay Code Edits Creating Activity Codes .............................................................................8-2 What is an Activity Code? ...................................................................8-2 Activity Code Definitions ..............................................................8-2 Example of Using an Activity Code...............................................8-3 Creating Activity Codes .......................................................................8-3 What is an Activity Code Profile? .......................................................8-5
vii
Contents
Creating Activity Code Profiles .......................................................... 8-5 Assigning an Activity Code Profile to Devices ................................... 8-7 Downloading Activity Code Profiles to Devices ................................ 8-8 Assigning an Activity Code to a Function Key ................................. 8-10 Unassigning an Activity Code Profile from a Device ....................... 8-12 Configuring Comment Codes .................................................................. 8-15 What is a Comment Code? ................................................................ 8-15 Enabling Comment Codes for a Series 4000 Terminal ..................... 8-15 Enabling Comment Codes for a Series 400 Device .......................... 8-17 Configuring Pay Code Edits .................................................................... 8-19 What is a Pay Code? .......................................................................... 8-19 What is a Pay Code Edit? .................................................................. 8-19 Enabling Pay Code Edits for a Series 4000 Terminal ....................... 8-20 Enabling Pay Code Edits for a Series 400 Device ............................ 8-21 Example ....................................................................................... 8-23 Chapter 9: Collecting Data and Managing Transactions Enabling Data Collection ........................................................................... 9-2 Collecting Data .................................................................................... 9-3 Monitoring Transactions and Device Communications ............................. 9-4 The Communication Monitor Window ............................................... 9-4 Collecting Transaction Input Files ............................................................. 9-8 Processing a Transaction Input File ........................................................... 9-9 Loading a Transaction Input File ........................................................ 9-9 Formatting a Transaction Input File .................................................. 9-10 Transaction Codes ............................................................................. 9-11 Location of a Transaction Input File ................................................. 9-11 Setting Up a Transaction Output File for a Device Group ................ 9-12 Viewing Transactions .............................................................................. 9-13 Correcting Invalid Transactions ............................................................... 9-15 Scheduling Events .................................................................................... 9-17 Creating a New Event List File ......................................................... 9-18 Defining a DCM Command Event .................................................... 9-18 Adding a Command or Run Program to an Event Manager File ...... 9-21
viii
Kronos Incorporated
Contents
Deleting a Command or Run Program from an Event Manager File ............................................................................9-22 Event Manager Options .....................................................................9-22 DCM Commands ...............................................................................9-24 Events and Download Options ...........................................................9-31 Defining a Program Event .................................................................9-34 Using the Sentinel Service to Automatically Start the Event Manager ...................................................................................9-38 Centralized Log File .................................................................................9-39 Log File Viewer .................................................................................9-39 Log File Format .................................................................................9-41 Transaction Output Files ..........................................................................9-43 Transaction Output File Format .........................................................9-44 Transaction Output File Example Format ....................................9-45 Transaction Output File Examples ...............................................9-45 Data Backups ............................................................................................9-46 Chapter 10: Using the Sentinel Overview ..................................................................................................10-2 Sentinel Status Monitoring .......................................................................10-3 Sentinel Startup ..................................................................................10-3 Monitoring Communication Channels and Application Connections .............................................................................10-4 Displaying the Status of the DCM System and DCM Processes .10-5 Sentinel Shutdown .............................................................................10-8 Disconnecting DCM Application Connections During Shutdown ....10-8 Processing External Start and Stop Requests .....................................10-8 Monitoring Host Application Connections ........................................10-8 Monitoring Transactions to the Host Application........................10-9 Managing the Event Manager ..........................................................10-10 Shutting Down and Restarting the Sentinel Service ........................10-10 Shutting Down the Sentinel Service...........................................10-11 Restarting the Sentinel Service...................................................10-11 Providing Enhanced Database Connection Support ...............................10-12 Retrying Connections to the Database .............................................10-12
ix
Contents
Chapter 11: Loading Files and Data to and from a Device Overview of Softload and Load Firmware .............................................. 11-2 Upgrading the Firmware in Series 4000 Terminals ................................. 11-3 Performing a Series 4000 Firmware Upgrade .......................................... 11-5 Performing a Softload ........................................................................ 11-5 Performing a Series 400 Firmware Upgrade ............................................ 11-7 Loading Firmware ............................................................................. 11-7 Re-initializing after Performing a Softload .............................................. 11-8 Loading Device Parameter Files .............................................................. 11-9 Extracting a Parameter File ................................................................... 11-10 Importing a Parameter File .................................................................... 11-12 Exporting a Parameter File .................................................................... 11-13 Synchronizing the Date and Time on the Communication PC with All Devices ............................................................................ 11-14 Using the Communication Monitor to Set the Date and Time ........ 11-14 Using the Device Manager to Set the Date and Time ..................... 11-15 Series 4000 Terminal Device Report ..................................................... 11-16 Chapter 12: Troubleshooting Procedures ................................................................................................ 12-2 Setup and Configuration .................................................................... 12-3 Operation/Data Collection Modes ................................................... 12-11 System Faults and Recovery ........................................................... 12-14 Optimizing Ethernet Timeouts on Busy Networks ................................ 12-16 Viewing Application Connections and Communication Channels ........ 12-17 Reading a Transaction Output File ........................................................ 12-18 Labor Level Entries ................................................................................ 12-21 Troubleshooting with the Communication Monitor .............................. 12-22 Chapter 13: Error Codes and Messages Error Messages ......................................................................................... 13-2 Format ................................................................................................ 13-3 Communication Driver Error Codes ................................................. 13-4 Serial and Modem Error Codes.................................................... 13-4 Modem Error Codes..................................................................... 13-6
Kronos Incorporated
Contents
Communication Driver Error Codes ............................................13-7 Communication Type Independent Error Codes..........................13-8 Communication Channel Error Codes .............................................13-10 Configuration Service Error Codes ..................................................13-21 Softload Error Codes ........................................................................13-26 Data Collection Manager Generic Error Codes ...............................13-27 Data Collection Manager Series 4000 Error Messages ...................13-43 Error Messages from Connecting to Workforce Timekeeper .................13-55 Error Messages from a Series 4000 Terminal ........................................13-57 Device Error Messages from a Series 400 Device .................................13-58 Interpreting Error Messages .............................................................13-58 Appendix A: Theory of Operation Data Flow Architecture ............................................................................. A-2 Data Transfer Files .............................................................................. A-2 The Data Transfer Concept ........................................................... A-2 Queue Files ......................................................................................... A-3 Application Client ............................................................................... A-4 Transaction Files ................................................................................. A-4 Log Messages ...................................................................................... A-4 Sentinel ............................................................................................... A-5 Communication Interface Components .............................................. A-5 Communication Channels ............................................................. A-5 Communication Clients................................................................. A-6 Communication Drivers ................................................................ A-6 Data Flow in the Workforce Timekeeper System ...................................... A-7 Uploading Data ................................................................................... A-7 Uploading Data from Series 4000 Terminals ................................ A-8 Uploading Data from Series 400 Devices ..................................... A-9 Downloading Data ............................................................................ A-10 Downloading Data to Series 4000 Terminals.............................. A-11 Downloading Data to Series 400 Devices................................... A-12
xi
Contents
Appendix B: Modifying INI File Values Setting Bulk Processing .............................................................................B-2 Setting the Sentinel Service Status Automatic Refresh Intervals ..............B-3 Database Disconnect Retry Wait Time ......................................................B-4 List Size Settings ........................................................................................B-5 Registering a New Communication PC .....................................................B-6 Appendix C: Understanding and Accessing Punch/Transaction Data Understanding Collected Transaction Records .........................................C-2 Collected Transaction Record Identifiers and Data Fields ..................C-2 Collected Transaction Record Formats and Syntax ............................C-7 Punch Record (A) ..........................................................................C-9 Labor Transfer Record (B)...........................................................C-10 Add-a-Punch Record or Delayed Labor Transfer Record (E) .....C-11 Function Key Record (F) .............................................................C-12 Delete-a-Punch Record (H)..........................................................C-13 Add or Subtract Pay Code Hours Record (I) ...............................C-14 Move Pay Code Hours from One Pay Code to Another Record (J).................................................................................C-15 Decimal Transaction Record (Add/Subtract Pay Code Money) (K) ..............................................................................C-16 Tips Record (L)............................................................................C-17 Entry Management Record (S) ....................................................C-18 Hourly Time Stamp Record (T)...................................................C-19 Individual Message Audit Trail Record (T).................................C-19 Activity Code Record (V)............................................................C-20 Gate Record (W) ..........................................................................C-21 Supervisor, Guard, and Maintenance Transaction Records ..............C-22 General Record Format................................................................C-22 Login Record (0)..........................................................................C-24 Logout Record (1)........................................................................C-24 Transaction Record (2) ................................................................C-25 Single Restriction Override Record (3) .......................................C-26 Home Employee Global Restriction Override Record (4)...........C-27 Non-Home Employee Global Restriction Override Record (5) ..C-28
xii
Kronos Incorporated
Contents
Security Transaction Record (6).................................................. C-29 Open Gate for an Individual Employee Record (7) .................... C-30 Open Gate for Specified Duration Record (8)............................. C-31 Cancel Meal Deduction Record (9)............................................. C-32 Punch Type and Daylight-Saving Time ............................................ C-32 Using Host Commands to Collect and Clear Transaction Data ........ C-34 Appendix D: Using DCM with Series 4000 Terminals Series 4000 Terminals Features ................................................................. D-2 Functional Differences Between Series 4000 and Series 400 Terminals .. D-3 Glossary Index
xiii
Contents
xiv
Kronos Incorporated
About This Guide
This guide is for individuals who configure, use, and troubleshoot the Data Collection Manager (DCM) system. This preface contains the following sections:
w w w
Organization of This Guide Abbreviations and Terms Related Documents
About This Guide
Organization of This Guide

Chapters in this guide provide the following information:
w w
Chapter 1, Introducing Data Collection Manager, presents the DCM system by describing its components and how they interact. Chapter 2, Defining an Application Connection, explains how to define application connections that enable host applications to communicate with the Data Collection Manager system. Chapter 3, Communication Channels, explains how to configure and use the DCM communication channels. It includes information about using the Device Manager to configure communication channels and how to set up Ethernet, modem, and serial connections. Chapter 4, Device Group and Global Setup, explains how to configure and use the DCM communication channels and provides an overview of the Device Manager and the Device Wizard. It explains how to add and modify device groups and devices in the DCM configuration. It includes information about using the Device Manager to configure communication channels and explains how to set up Ethernet, modem, and serial connections. Chapter 5, Configuring Devices, explains how to configure devices. Chapter 6, Setting Up Labor Level Information, explains how to set up labor level information and load it to devices. Chapter 7, Totals and Accruals, explains how to configure function keys to display totals and accruals. Chapter 8, Activity Codes, Comment Codes, and Pay Code Edits, explains how to configure activity codes, comment codes, and pay code edits. Chapter 9, Collecting Data and Managing Transactions, explains how to start data collection, manage transactions, and schedule events. Chapter 10, Using the Sentinel, provides an overview of the Sentinel application that manages communication functions. Chapter 11, Loading Files and Data to and from a Device, explains how to send files, data, and firmware to a device. Chapter 12, Troubleshooting, provides procedures for resolving problems that occur while using the Data Collection Manager system.
w w w w w w w w
xvi
Kronos Incorporated
Organization of This Guide
w w w w
Chapter 13, Error Codes and Messages, lists the error codes and messages. Appendix A, Theory of Operation, describes the DCM architecture and components and how they interact. Appendix B, Modifying INI File Values, provides the INI file values that are specific to the Data Collection Manager. Appendix C, Understanding and Accessing Punch/Transaction Data, provides information about using the records events in the first in, first out (FIFO) buffer of its random access memory Appendix D, Using DCM with Series 4000 Terminals, provides a list of the Series 4000 features and a comparison of the Series 4000 and Series 400 terminals. The Glossary contains a list of terms with their meaning.
xvii
About This Guide
Abbreviations and Terms

This section explains the following abbreviations and terms used in this guide:
Abbreviation AFT API comm channel comm type DHCP DCM DLL DNS DSN DUN FTP IP LAN LCD ODBC PCMCIA PIN PPP RAS TCP/IP WFC WTK Meaning Arbiter File Transfer Application Program Interface communication channel communication type Dynamic Host Configuration Protocol Data Collection Manager system Dynamic Link Library Domain Naming System Data Source Name Dial-Up Networking File Transfer Protocol Internet Protocol Local Area Network Liquid Crystal Display Open Database Connectivity Personal Computer Memory Card Interface Adapter Personal Identification Number Point-to-Point Protocol Remote Access Server Transmission Control Protocol/Internet Protocol Workforce Central Suite Workforce Timekeeper system
xviii
Kronos Incorporated
Related Documents
Related Documents
In addition to this guide, the following documentation is available to help you use DCM:
w
The Data Collection Manager Installation Guide provides step-by-step instructions for installing the DCM system to use with the Workforce Timekeeper system. The Data Collection Manager Database Reference Guide lists and describes the database tables used by the Data Collection Manager (DCM) system. The Data Collection Manager Online Help installs automatically with DCM. To browse the contents of the Help file, start a DCM application and select Help > Help Topics. Browse through the Contents or click the Index tab, type an entry or scroll through the listed topics, and then click Display to view a topic. The 400 Series Terminal Configuration Guide provides reference and procedural information about configuring the Series 400 terminal The 400 Series Terminal Installation Guide provides step-by-step instructions for installing the Series 400 terminal. The Series 4000 Terminal Users Guide provides basic concepts of the Series 4000 terminal, instructions for performing functions and transactions, and maintaining and servicing the terminal. The Series 4000 Terminal Installation Guide provides step-by-step instructions for installing the Series 4000 terminal and performing basic configuration. This document is shipped with the Series 4000 terminal. The Terminal Communication Network Reference Guide provides an overview of the Ethernet, RS-485, modem, and RS-232 communications methods.
w w
w w w
xix
About This Guide
xx
Kronos Incorporated
Chapter 1
Introducing Data Collection Manager
This chapter introduces the Data Collection Manager (DCM) system by describing its components and how they interact. This chapter contains the following sections:
w w w w
Overview DCM Applications Accessing the Data Collection Manager Applications Steps for Configuring the Data Collection Manager
Chapter 1
Overview
The Data Collection Manager is a flexible suite of applications and libraries that enables the flow of data between a host application and data collection devices. A host application is the Kronos Workforce Timekeeper application for which employee data is provided and derived. A data collection device is a piece of hardware that collects time and attendance data, activities information, or other types of information. The device collects the information and, through DCM, makes it available for management by host applications, such as Workforce Timekeeper. DCM communicates by using Ethernet, serial, and modem communication types. It is fully scalable and can run on a standalone PC, an application server, or across multiple PCs in an enterprise environment. Using the DCM applications, you can:
w w w w w w w w
Configure and test data collection devices. View and log transactions, such as functions that occur at the device. View messages, such as status and errors generated by the DCM applications. Establish connections to different Ethernet, serial, and modem device types. Store transactions at key transfer points. Initialize and update device configuration and application data to devices. Collect punches from devices. Collect biometric data from the Series 4000 terminal.
The following section describes the DCM applications.
1-2
Kronos Incorporated
DCM Applications
DCM Applications
DCM includes the following applications:
w w w w w
Communication Monitor Device Manager Event Manager Sentinel Service Activity Codes
You need to log on with your user name and password the first time that you access one of the DCM applications. The DCM applications that require a logon include Device Manager, Event Manager, Communication Monitor, and Activity Codes.
Communication Monitor
The Communication Monitor enables you to monitor device and device groups and is also a means of transferring data to and from devices. The Communication Monitor enables you to view system information such as data flow, communication tests, device status, and error posting. The Communication Monitor lists:
w w
Which devices are responding and which are not. This information includes the date and time that the device responded or did not respond. The requests and responses between the devices and applications that manage the information. This information includes status messages, transactions, and error messages.
The Communication Monitor enables you to perform the following tasks:

w w w w
Initialize and update devices Set the date and time on the device Test device communications Start and stop data collection
1-3
Chapter 1
w w w w
Monitor transactions for the system Edit and resubmit failed transaction data View the DCM log View local device transactions
Device Manager
The Device Manager allows you to define application connections, communication channels, devices, and device groups, and to configure system properties. The Device Manager main window displays the hierarchy of device groups, communication channels, devices, and the request status. Using the Device Manager, you can also:
w w w w w
Check device status Load files, device programs, and collected data Enable logs for troubleshooting If the environment changes, modify the configuration, and then reinitialize devices Update device firmware
The Device Manager contains a Device Wizard that leads you through a series of dialog boxes in which you provide the information required to add or edit devices. The Device Wizard includes the following features:
w w
It detects available ports when you configure serial devices. It detects installed modems and their applicable modem strings. If you select a device that uses a modem as the method of communication, the Device Wizard detects the modem if one is installed with the appropriate Windows operating system: Windows NT, Windows 2000, or Windows XP. It enables you to test communication to a device as the final step in adding or editing the device.
1-4
Kronos Incorporated
DCM Applications
Event Manager
The Event Manager enables you to schedule actions or tasks (called events) to start and stop automatically at a specified date and time. Using Event Manager options, you can specify:
w w w
The additional time that the Event Manager application waits before issuing a scheduled event The time that the Event Manager uses to determine that an event is past due Whether or not to prompt when deleting an event
You can configure Event Manager to start automatically when the DCM Communications PC is started, without requiring a user to log on. Scheduled events run automatically if the DCM Communication PC is restarted without requiring user intervention. For more information about enabling automatic Event Manager startup, see System Settings on page 4-42. Event Manager log messages appear in the DCM centralized log file. For more information about the centralized log, see Log File Settings on page 4-45.
Sentinel Service
The Sentinel Service is a background application that runs while the DCM system is in operation. The Sentinel Service launches and manages the application connections and communication channel connections. Every DCM Communication PC in the system must have a Sentinel Service process running in order to perform most DCM operations. Windows 2000, Windows NT, and Windows XP can launch the Sentinel Service as a Windows service. This ensures that the Sentinel Service remains running when you log off the DCM Communication PC, and that the Sentinel Service starts automatically whenever the DCM Communications PC is started. The Sentinel Service performs the following tasks:
w
It manages all the communication channels configured for processing on the given system. The Sentinel Service starts, monitors, and stops the communication channels.
1-5
Chapter 1
It manages all the application connections configured for processing on the given system. The Sentinel Service establishes, monitors, and disconnects application connections. It manages the Collection Agent. It provides database connection support. When the Sentinel Service starts, it requires a connection to the database; it does not start communication channels or application connections without a database connection. If the Sentinel Service cannot connect to a database, it retries to connect after a fixed amount of time. When this time expires, the Sentinel Service lists an error on the screen and in the log. The Sentinel Service constantly checks the connections to the database during its monitoring operations. If the database connection is lost during this processing, the Sentinel Service shuts down all DCM application connections and communication channels. During this period of time, a message appears in the Sentinel Service window indicating that the Sentinel Service is attempting to reconnect to the database. The Sentinel Service then starts a thread that tries to reconnect to the database. This thread attempts a connection, waits 60 seconds, and then retries. When the connection is reestablished, the Sentinel Service restarts the DCM application connections, communication channels and, if configured, automatic data collection and the Event Manager.
w w
It monitors the required available disk space for DCM applications. If the disk space falls below the minimum that is required, the Sentinel Service shuts down all communication channels and application connections, and enters error messages into the log file. When the required disk space becomes available, the Sentinel Service restarts the DCM application connections, communication channels, and, if configured, automatic data collection and the Event Manager.
You can configure Event Manager to start when the DCM Communications PC is started, without requiring a user to log on. This allows scheduled events to run automatically if the DCM Communication PC is restarted without requiring user intervention. To configure Sentinel Service to start automatically the Event Manager, refer to System Settings on page 4-42.
1-6
Kronos Incorporated
Accessing the Data Collection Manager Applications

You access the Data Collection Manager system from the Microsoft Windows Program menu. When you select the Data Collection Manager from the Program menu, the Data Collection Manager Start menu appears. From the Data Collection Manager Start menu, you access the DCM applications. Note: Make sure that the server and database are up and running before you open a DCM application. When you open your first application, the logon screen appears. This logon requires you to enter a user name and password.
1-7
Chapter 1
About the Cross-Launch Utility

All applications in the Workforce Timekeeper system share a common database. When installed as part of the Workforce Timekeeper system, DCM does not have a separate database. Its tables reside in a section of the Workforce Timekeeper system database. When a DCM application starts up, it requires database access to retrieve information from the DCM tables in the database. Since DCM uses the common Workforce Timekeeper database, you must enter a user name and a password on the logon screen to gain access. You can log on to DCM or one application of Workforce Timekeeper, and then have access to all other Workforce Timekeeper applications with the same level of access rights, without having to re-enter a user name or password. DCM access is specified in the Function Access Profiles option of the Access Profiles option of Workforce Central Setup applications. See the Workforce Timekeeper documentation for more information about setting DCM Access Profiles.
About the DCM Integrated Logon Utility

When you are logged on to DCM, you then have access to the communication and application clients without having to re-enter a user ID or password. Your user ID is stored and used later in these applications and their database connections.
Logging on to DCM and Workforce Timekeeper

Data Collection Manager and Workforce Timekeeper allow you to log on without having to re-enter your user name and password when you open most other applications.
1-8
Kronos Incorporated
Reports About DCM in Workforce Timekeeper

Workforce Timekeeper provides the following reports that contain information from DCM:
w
Activity Code Definitions ReportAn activity code enables you associate a work rule with a pay rule. For example, when hospital employees enter the operating room, they press a function key and swipe their badge. This activates the work rule and pay rule assigned to their activity code. They swipe again when they leave, and are transferred back to their primary labor account. The Activity Code Definitions report shows the activity code definitions that are configured in the Data Collection Manager. Activity Code Profiles ReportActivity code profiles enable you to map activity codes to the function keys on devices. The Activity Code Profiles report shows the activity code profiles that are defined in the Data Collection Manager. Device Assignments ReportThe Device Assignments report contains a list of devices that includes the device ID, device name, the device groups that each device belongs to, whether the device has collection enabled, the communication channel that the device is assigned to, and whether the device is enabled. Device Group and Device Assignments ReportThe Device Group and Associated Assignments report contains a list of device groups, and includes the associated devices, the communication channel that each device is assigned to, and whether each device is enabled.
For more information about Workforce Timekeeper reports, see the Workforce Timekeeper documentation.
1-9
Chapter 1
Steps for Configuring the Data Collection Manager

The following table outlines the necessary steps to configure your DCM system:
Step 1. Plan implementation: communication connections and device destination on Communication PCs. 2. Define the connections for the applications that use DCM to get data. 3. Configure communication channels. 4. Configure device groups. 5. Configure devices, device application options, and device download options. 6. Synchronize the date and time of the devices with the Communication PC. 7. If you are upgrading, extract existing device configuration from the device to a parameter file. Caution: If you are upgrading from DCM 2A or earlier, the device settings within the database are reset to the defaults and you lose your existing configuration. 8. Configure the parameters for each device and download the parameters to the device. 9. Load data to the devices. Chapter 4, Device Group and Global Setup. Chapter 11, Loading Files and Data to and from a Device. Chapter 2, Defining an Application Connection. Chapter 3, Communication Channels. Chapter 4, Device Group and Global Setup. Chapter 5, Configuring Devices. Reference
Chapter 11, Loading Files and Data to and from a Device. Chapter 11, Loading Files and Data to and from a Device.
1-10
Kronos Incorporated
Steps for Configuring the Data Collection Manager
Step 10. Start data collection. This step is not necessary if Online is selected for the device, and Automatic Data Collection is selected for the device group. 11. If you are using batch collection, use the Event Manager to schedule a Collect Event and any other required events. 12. Configure Events to periodically update configuration data at devices.
Reference Chapter 9, Collecting Data and Managing Transactions.
Chapter 9, Collecting Data and Managing Transactions.
Chapter 9, Collecting Data and Managing Transactions.
1-11
Chapter 1
1-12
Kronos Incorporated
Chapter 2
Defining an Application Connection
This chapter explains how to define and edit the connections between Workforce Timekeeper applications and the Data Collection Manager (DCM) system. This chapter contains the following sections:
w w w
Overview Application Connections The DCM Application Transaction Count
Chapter 2
Overview
DCM uses application connections to send punches to and exchange other information with Workforce Timekeeper via the Workforce Timekeeper application server. DCM provides a default application connection, Application Connection 1, during installation. In most installations, you can use the default application connection for all DCM Communication PCs. Application connections are associated with devices and DCM Communication PCs based on device group definitions and communication channel assignments. The Sentinel Service on each DCM Communications PC automatically starts the required application connections based on the devices assigned to communication channels that run on the DCM Communication PC. For more information about device group definitions, see Creating Device Groups on page 4-7. For more information about communication channel assignments, see Assigning a Device to a Device Group on page 4-22. Caution: Collect all data before changing the information in the application connection. Do this to avoid routing information to the wrong destination. You may change the name or the description of the default application connection, create additional application connections, and delete application connections by using Device Manager. If your system handles large loads of collect events and you would like to improve data processing performance, you can also define multiple server connections within an application connection on one or more DCM Communication PCs. For more information, see WFC Connection on page 4-59.
2-2
Kronos Incorporated
Application Connections
You can edit an application connection description. You can also delete and create a application connections.
Editing an Application Connection Description

To edit the description of the application connection: 1. From the Device Manager main window, select Setup > Application Connections. The Setup Application Connections dialog box appears. 2. Select an application connection and click Edit. The Edit Application Connection dialog box appears.
3. Edit the application connection description and click Update.
Deleting an Application Connection

You can delete an application connection that is not assigned to a device group. To delete an application connection: 1. From the Device Manager main window, select Setup > Application Connections. The Setup Application Connections dialog box appears. 2. Select an application connection and click Delete. 3. Click Yes in the confirmation message box to delete the application connection.
2-3
Chapter 2
Note: You cannot delete an application connection that is being used by one or more DCM Communication PCs. To delete an application connection, first shut down data collection on devices assigned to device groups that use the application connection and edit the device groups to use a different application connection.
Creating a New Application Connection

To create a new application connection: 1. Select Start > Programs > Data Collection Manager > Device Manager. If no other DCM applications are open (except the Sentinel Service, which runs in the background on startup), you are required to enter a user name and password. 2. From the Device Manager main window, select Setup > Application Connections. The Setup Application Connections dialog box appears. 3. Click New. The New Application Connection dialog box appears.
4. In the New Application Connection dialog box, enter the name and, optionally, a description, for the new application. The maximum length for an application name is 40 alphanumeric characters. Note: Do not use the following special characters in the application connection name: / * ? < > | : ;
2-4
Kronos Incorporated
5. Click Add. The new application connection appears in the displayed list. The new application connection is automatically started after you create or edit a Device Group that uses the new application connection and assign devices to it. For more information about device group definitions, see Creating Device Groups on page 4-7. For more information about communication channel assignments, see Assigning a Device to a Device Group on page 4-22.
2-5
Chapter 2
The DCM Application Transaction Count

After you create an application connection, DCM counts the number of transactions that are processed and the number of transactions processed successfully. To display the transaction count, click the DCM Application icon on your system tray:
The DCM Application transaction count appears.
To reset the transaction count, click the yellow icon and select Reset Transactions Processed from the drop-down list.
2-6
Kronos Incorporated
Chapter 3
Communication Channels
This chapter explains how to configure and use the Data Collection Manager communication (comm) channels. It includes information about using the Device Manager to configure communication channels and how to set up Ethernet, modem, and serial connections. This chapter contains the following sections:
w w w
Overview Creating Communication Channels Configuring Communication Channels in the Device Manager
Chapter 3
Overview
The Data Collection Manager (DCM) system includes communication channels that support communication between devices and host applications. Devices interact with a host application using one of the following three communication methods:
w w w
Ethernet Serial (Series 400 and Series 100 only) Modem (dedicated analog only) Note: You can use both Series 400 devices and Series 4000 terminals with a modem, but Series 400 devices and Series 4000 terminals cannot be configured on the same modem.
To configure communication methods for devices, specify the communication method when you use the Device Wizard to create a device, which then configures the communication channel, or specify the communication channel in the Device Manager. For more information about the Device Wizard, see Adding a Device by Using the Device Wizard on page 4-13. For data collection purposes, add devices to device groups specifying an Ethernet, modem, or serial communication channel. A device contains specific communication attributes, which include:
w
IP address or DNS name, if Ethernet Note: Latin 1 characters are not supported in DNS host names.
w w
Telephone number, if modem Baud rate, if serial
3-2
Kronos Incorporated
Creating Communication Channels

When you create communication channels, specify a different communication channel for each type of communication. For example, if your DCM system uses modem and Ethernet communication, create two communication channels. Create one communication channel named MODEM to support modem communication on COM1, and a second communication channel named ETHERNET to support Ethernet communication using an Ethernet card. Although each communication method requires a separate communication channel, you can create more than one communication channel for a single type of communication method, with the exception of modem communication. For more information, see Modem Channels on the next page. Modem and serial communication channels are port-unique. A communications port can be used only on one communication channel. A single Communication PC supports up to 250 data collection devices spread over a maximum of 10 communication channels. The following table provides the default maximum number of devices that a communication channel of each type supports: Actual performance varies depending on system and network configuration. See the Data Collection Manager Installation Guide for more information.
Maximum Number of Devices per Communication Channel 50 20 50 30 50
Communication Type Ethernet (Series 4000) Ethernet (All devices except Series 4000 terminals) Modem (Series 4000 terminals) Modem (All devices except Series 4000 terminals) Serial (All devices except Series 4000 terminals)
3-3
Chapter 3
Modem Channels
You can configure a modem for a Series 4000 terminal or a Series 400 device, but the configuration is different. To configure a Series 4000 modem, you must create a dial-up connection in your Windows operating system, which covers some of the settings that you usually configure in the communication channel for Series 400 devices. Note: You cannot share a communication channel or modem between Series 4000 terminals and other types of devices. Each modem works only with one communication channel. If you have only one modem, only one communication channel is valid for that modem. You can configure up to four modem communication channels per Communication PC, one per communication port. The following items are some guidelines for using modems with Kronos modem devices:
w w
The modem must be installed with the Windows operating system. The DCM Communication PC requires a dedicated analog phone line for communication with Kronos modem devices. Do not share this line with any other devices, such as a telephone or a fax machine. This analog phone line can originate from the PBX or directly from the telephone company. Digital phone lines are not supported when connected to a Kronos device under any condition. Connecting a digital phone line to a Kronos device might result in serious damage.
w w w
Modem devices are defined only on the Communication PCs that they communicate with. A Communication PC cannot be set up with a Series 4000 modem device and a Series 400 modem device on the same channel. All modem devices on a Communication PC must be configured to connect at the same speed that is the lowest device speed. The exception is to connect modem devices of different speeds to separate modems attached to the PC.
3-4
Kronos Incorporated
If you need to dial a number for an outside line, use the letter w in place of a comma. The w forces the modem to wait for a dial tone before continuing. For example, 9w 987 9876543. PBX switch times may not be set appropriately for use with a Kronos modem device. The two settings that affect modem timing are the S9 and S10 settings. You can change these settings in the modem initialization string. Refer to your modem documentation for details. The following setting is for the required duration, in tenths of a second, of the remote modems carrier signal before recognition by the dialing modem. S9=n n= 1 to 255 The following setting is for the duration, in tenths of a second, that the modem waits after loss of carrier before hanging up. S10=n n=1 to 255
Series 4000 Communication Channels

Always configure a Series 4000 modem device on a single communication channel, even if it is a member of more than one device group.
Device Group A Communication channel 1 same modem Device Group B Communication Channel 1
Note: If you move a Series 4000 terminal to a different communication channel, you must adjust the IP address to match the subnet for the dial-up connection assigned to the new communication channel. For more information, see About IP Addresses for the Communication PC and Series 4000 Terminals on page 3-6.
3-5
Chapter 3
Series 400 Communication Channels

To configure two modem devices on one communication channel in a Series 400 device, set the baud rate for the communication channel to the lowest of the two baud rates. For example, if you have two modem devices, a 2400 baud modem and a 19200 baud modem, set the baud rate to 2400. If you require high- and low-speed modem communication on the same PC, you need to configure the modem devices on two modems on separate communication channels.
Configuring a Modem for a Series 4000 Terminal

Caution: To perform modem installation and configuration, you must have an advanced knowledge of networking. Otherwise, communication problems and data loss can result.
Because the Series 4000 modem communicates via Transmission Control Protocol/Internet Protocol (TCP/IP) using Point-to-Point Protocol (PPP), you need an IP addresses. The DCM Communication PC and Series 4000 terminal form a small network for which you must define a dial-up connection. About IP Addresses for the Communication PC and Series 4000 Terminals You must assign IP addresses at both ends of the PPP link. The DCM Communication PC and Series 4000 terminals must be on the same subnet. You do not need to assign subnet mask and gateway numbers at the devices because the data travels over a point-to-point connection, so they are on one physical network.You need different IP addresses for each dial-up connection, which you define at the DCM Communication PC.
3-6
Kronos Incorporated
You can use the same IP address for up to 50 Series 4000 modems on the same modem communication channel. DCM uses the Device ID to identify the device that is sending data. The IP address simply allows communication. See the illustration on the following page. The following items are some guidelines for assigning IP addresses:
w
Assign IP addresses that do not conflict with other devices in your corporate network. Do not use a subnet that is the same as your corporate subnet. To determine whether or not an IP address was assigned to a Series 4000 device, swipe a Maintenance badge at the device to enter Maintenance mode, and select Comm Setup from the Maintenance Mode menu. The IP address appears if one was assigned.
w w w
Define one dial-up connection for each modem on the Communication PC. Assign an IP address with a different subnet to each connection. Do not use an IP address in which the host field contains all zeros or all ones. If you change the IP address for a Series 4000 terminal, you must restart your application connection.
3-7
Chapter 3
The following illustration shows two modems on a DCM Communication PC, with a network connection for each one, and sample IP addresses:
DCM Communication PC Ethernet IP address 1
DCM Applications
PPP Client Remote Access Service
PPP Client Remote Access Service
IP address 2 example: 192.168.0.1
Modem
Modem
IP address 4 example: 192.168.1.1
IP address 3 example: 192.168.0.2 Modem PPP Server Series 4000 device
IP address 5 example: 192.168.1.2 Modem PPP Server Series 4000 device
All devices using this dial-up connection can use IP address 3.
All devices using this dial-up connection can use IP address 5.
Each dial-up network must have a different subnet.
3-8
Kronos Incorporated
Recommended IP addresses Since the IP addresses for the dial-up connections between the Communication PC modem and the devices do not connect to the corporate intranet or the Internet, you can use the following IP addresses, which are approved for private networks:
IP Addresses 10.0.0.110.255.255.255 172.16.0.1172.31.255.255 192.168.0.1192.168.255.255 Type of Network Class A network A contiguous block of 16 class B networks A contiguous block of 255 class C networks
You define IP addresses when you configure the dial-up connection. Assigning IP Addresses on Multiple Communication PCs If you are using more than one Communication PC, do not repeat on subsequent PCs the IP addresses that are already assigned to dial-up connections, such as IP addresses 2 through 5 in the illustration. Assign a different subnet to each dial-up connection. Example Communication PC A
Sample IP Address 192.168.0.1
Location IP address 1 IP address 2 Communication PC A modem 1 on communication PC A modems on first group of devices modem 2 modems on second group of devices
Connects to corporate intranet, Internet first group of devices
IP address 3 IP address 4 IP address 5
modem 1 on Communication PC A second group of devices modem 2
192.168.0.2 192.168.1.1 192.168.1.2
3-9
Chapter 3
Communication PC B
Sample IP Address 192.168.2.1 192.168.2.2 192.168.3.1
Location IP address 6 IP address 7 IP address 8 IP address 9 Communication PC B modem 1 on comm PC B modems on third group of devices modem 2 on communication PC B modems on fourth group of devices
Connects to corporate intranet, Internet third group of devices modem 1 on Communication PC B fourth group of devices
IP address 10
modem 2
192.168.3.2
Note: The DCM Communication PC also requires a dedicated analog phone line for communication with Kronos modem devices. A shared analog line may result in unreliable collections.
About Dial-Up Networking

The Microsoft Network and Dial-up Connections application should be provided with your operating system. A dial-up entry sets the parameters for all devices assigned to the modem that you are configuring, and creates an entry in the Windows Remote Access Service system phone book (rasphone.pbk). You must create an entry in the phone book for each modem on the Communication PC. Review the Prerequisites, and then configure a dial-up connection.
3-10
Kronos Incorporated
Prerequisites Before you use DCM to configure a modem for a Series 4000 terminal, verify that the following tasks are accomplished:
w
The Series 4000 terminal is installed with a modem cage and a modem. For information about installing a modem in a Series 4000 terminal, see the installation instructions that shipped with your Series 4000 terminal.
w w
Version 1.1 or later of the Series 4000 firmware is installed; it includes PCMCIA modem support. An IP address is entered physically at each device, using Maintenance mode. For more information about IP addresses, see About IP Addresses for the Communication PC and Series 4000 Terminals on page 3-6.
A static IP address is entered at the DCM Communication PC for its modem, which is described on the following pages and dependent on the type of your operating system. DCM 4.4 or later is installed on the Communication PC. The Remote Access Service (RAS) is installed for your operating system. The Remote Access Server provides the API for DCM to act as a PPP Client. The Series 4000 terminal is the PPP server. The RAS stores the dial-up connection that you define.
w w
A V.90-compatible modem is installed on the Communication PC, according to the instructions provided with it. The modem can be internal or external. For Series 400 devices, the modem must be connected to Comm1, Comm2, Comm3, or Comm4.
You must: 1. Create a dial-up entry for the modem on your Communication PC by using the Microsoft Network and Dial-up Connections application. See Configuring a Dial-up Entry on Windows 2000 on page 3-12, Configuring Dial-up Networking on Windows NT on page 3-16, or Configuring Dial-up Networking on Windows XP on page 3-19. 2. Use the Device Wizard or the Device Manager to add the device. 3. Use the Device Manager to configure the device.
3-11
Chapter 3
Configuring a Dial-up Entry on Windows 2000 Be sure that you are running Windows 2000 Service Pack 2 or later. To create a dial-up entry: 1. From the Windows Start menu, select Settings > Network and Dial-up Connections > Make New Connection. The Network Connection Wizard appears. Click Next. 2. Select Dial-up to private network and click Next. 3. If the Select a Device dialog box appears, select only one modem in the Select the devices list. You must create a separate dial-up connection for each modem on the Communication PC. 4. The Wizard prompts you for a Phone Number to Dial. Leave this text box blank; you will enter a phone number in DCM instead. Click Next. 5. The Wizard prompts you for Connection Availability. Select For all users. This selection sends the connection to the RAS phone book and click Next. 6. If the Internet Connection Sharing dialog box appears, click Next. 7. The Completing the Network Connection Wizard dialog box appears. Enter a name for the connection to the modem that you are configuring. For example, depending on the brand and communication channel, you could enter: US Robotics on Comm 1 8. Click Finish. The connection name appears in the RAS phone book file, rasphone.pbk. DCM selects the following default DunPhonebookPath to the rasphone.pbk file, where X is the drive on which the operating system is installed (typically C or D): X:\Documents and Settings\All Users\Application Data\Microsoft\Network\Connections\Pbk\rasphone.pbk
3-12
Kronos Incorporated
Note: When rasphone.pbk is not located in the expected default directory, from the Device Manager, select Setup > System Settings. On the System Properties tab, select the Enable use of phone book path check box and edit the Phone book path. For more information about System Settings, see System Settings on page 4-42. After you click Finish, the Connect connection name dialog box appears. 9. Click Properties. On the General tab, the modems that are defined in your Windows operating system appear in the list. 10. Select the modem for the Series 4000 terminal(s) that you are configuring. 11. Click the Options tab to adjust the Redialing options.
a. Select zero in the Redial attempts drop-down list.
3-13
Chapter 3
b. Select one minute in the Idle time before hanging up drop-down list. The Idle time before hanging up setting controls the timeout for the dial-up connection. The phone line remains in use unless there is a request to use it to dial another modem. Note: The default for Idle time before hanging up is Never. To avoid large telephone bills, you must change the setting to one minute. If a collection is in progress, the device must complete sending data and the Collection Agent must finish processing the data before DCM can process another request, such as test device, initialize, or collect. 12. Click the Networking tab.
a. From the Type of dial-up server I am calling drop-down list, select PPP: Windows 95/98/NT 4/2000, Internet. b. From the Components checked are used by this connection group box, select the Internet Protocol (TCP/IP) check box. 13. Click Properties.
3-14
Kronos Incorporated
a. Click Use the following IP address. b. Enter an IP address for the modem of the PPP Client. It is in the DCM Communication PC, and it communicates with the Series 4000 terminals. Do not use leading zeros. For example, enter 192.168.2.2, not 192.168.002.002. For more information about how to decide which IP address to use, see About IP Addresses for the Communication PC and Series 4000 Terminals on page 3-6. Do not enter DNS server addresses. 14. Click Advanced.
3-15
Chapter 3
15. Clear the Use default gateway on remote network check box. This helps Ethernet connections function properly while they are connected. Leave Use IP header compression selected. 16. Click OK three times. You return to the Connect connection name dialog box. 17. To assign an IP address for another modem port on the DCM Communication PC, repeat this procedure. 18. Close the Connect connection name dialog box by clicking the x in the upperright corner. 19. Use the Device Wizard to configure the Series 4000 modem device. For more information, see Adding a Device by Using the Device Wizard on page 4-13. Configuring Dial-up Networking on Windows NT You must be running Windows NT Version 4.0, Service Pack 6A or later to configure dial-up networking.
3-16
Kronos Incorporated
To create a dial-up entry: 1. Double-click the My Computer icon, and double-click Dial-Up Networking. The Dial-Up Networking dialog box appears. 2. Click New. The New Phonebook Entry Wizard appears. 3. Enter a name in the text box for the connection to the modem that you are configuring for the Communication PC. For example, depending on the brand and communication channel, you could enter: US Robotics on Comm 1 4. Click Next. 5. In the Server dialog box, clear all the check boxes. 6. Click Next. The Modem or Adapter dialog box appears. 7. Select the modem that this connection to the Series 4000 terminal is to use. 8. Click Next. The Phone Number dialog box appears. Do not enter a phone number here. You will enter it in DCM for each device. 9. Click Next. 10. Click Finish. The connection name appears in the RAS phone book file, rasphone.pbk. DCM selects the following default DunPhonebookPath to the rasphone.pbk file, where X is the drive on which the operating system is installed (typically C or D): X:\\WINNT\system32\ras=rasphone.pbk (for Windows NT) Note: When rasphone.pbk is not located in the expected default directory, from the Device Manager, select Setup > System Settings. On the System Properties tab, select the Enable use of phone book path check box and edit the Phone book path. For more information about System Settings, see System Settings on page 4-42. You must adjust networking and redialing properties.
3-17
Chapter 3
Adjusting Networking and Redialing Properties 1. After you click Finish, select Edit entry and modem properties in the More drop-down list. The Edit Phonebook Entry dialog box appears. 2. Click the Server tab. 3. From the Dial-up server type drop-down list, select PPP: Windows NT, Windows 95 Plus, Internet. 4. Verify that the TCP/IP check box is selected. 5. Click TCP/IP Settings. The PPP TCP/IP Settings dialog box appears. a. Select the Specify an IP address option. b. Enter an IP address for the modem of the PPP Client. It is in the DCM Communication PC and it communicates with the Series 4000 terminals. Do not use leading zeros. For example, enter 192.168.2.1, not 192.168.002.001. Do not use an IP address in which the host field contains all zeros or all ones. For more information about how to decide which IP address to use, see About IP Addresses for the Communication PC and Series 4000 Terminals on page 3-6. Note: All devices that communicate with the Communication PC through this connection must have the same subnet. If you define more than one modem connection for the Communication PC, you must use an IP address with a different network number for each connection. Some sample IP address combinations are:
DCM Communication PC modems 192.168.1.1 192.168.2.1
COM Port COM 1 COM 2
Series 4000 modems 192.168.1.2 192.168.2.2
If you move devices to a different dial-up connection or a different communication channel, you must change the IP address at the device.
3-18
Kronos Incorporated
For more information about IP addresses on a Windows NT network, see the illustration in the About IP Addresses for the Communication PC and Series 4000 Terminals on page 3-6. c. Do not enter DNS server addresses. d. You must clear the Use default gateway on remote network check box. Otherwise, the Communication PC is disconnected from the LAN or WAN when the dial-up networking connection is running. e. Click OK. You return to the Server tab. 6. Click OK. You return to the Dial-Up Networking dialog box. 7. Select User Preferences in the More drop-down list. The User Preferences dialog box appears. 8. Click the Appearance tab to adjust the redialing options. a. Select zero in the Number of redial attempts drop-down list. b. Select 60 seconds in the Idle seconds before hanging up drop-down list. The Idle seconds before hanging up setting controls the timeout for the dial-up connection. The phone line remains in use unless there is a request to use it to dial another modem. If a collection is in progress, the device must complete sending data and the Collection Agent must finish processing the data before DCM can process another request, such as test device, initialize, or collect. 9. Use the Device Wizard to configure the Series 4000 modem device. For more information, see Adding Devices on page 4-13. Configuring Dial-up Networking on Windows XP To create a dial-up entry: 1. From the Windows Start menu, select Settings > Network Connections > New Connection Wizard. The New Connection Wizard appears. 2. Click Next. 3. For your connection type, select the Connect to the network at my workplace check box and click Next.
3-19
Chapter 3
4. For the way the connection is to be made, select Dial-up connection and click Next. 5. Enter a name for your dial-up connection and click Next. 6. Although no telephone number is necessary because the required telephone number is entered when the device is configured, you can enter a telephone number to use for this connection so that you can test the connection. Click Next. 7. Select the connection availability for anyone or only for yourself and click Next. 8. Click Finish and modify your settings. The connection name appears in the RAS phone book file, rasphone.pbk. DCM selects the following default DunPhonebookPath to the rasphone.pbk file, where X is the drive on which the operating system is installed (typically C or D): X:\\Documents and Settings\All Users\Application Data\Microsoft\Network\Connections\Pbk\rasphone.pbk Note: When rasphone.pbk is not located in the expected default directory, from the Device Manager, select Setup > System Settings. On the System Properties tab, select the Enable use of phone book path check box and edit the Phone book path. For more information about System Settings, see System Settings on page 4-42. To modify your settings: 1. From the Windows Start menu, select Settings > Network Connections > dialup-connection name. The Connection Name Properties window opens. 2. From the Options tab, select 0 for the Redial attempts and 1 minute for Idle time before hanging up. 3. From the Networking tab, click Properties. The Internet Protocol (TCP/IP) Properties window opens. 4. Click Use the following IP address. 5. Enter the IP address. This address identifies the PPP Client (CC2) when connecting with the PPP server on the Series 4000 terminal.
3-20
Kronos Incorporated
6. Click Advanced. The Advanced TCP/IP Settings window opens. 7. Clear the Use default gateway on remote network check box. 8. Click OK on each of the previous three windows to apply your settings.
3-21
Chapter 3
Configuring Communication Channels in the Device Manager

The Device Manager application enables you to configure devices, device groups, and communication channels, and then assign the devices to device groups using communication channels. It also supports a Device Wizard that provides a series of configuration screens in which you provide the information required to add devices. This section describes configuring communication channels by using the Device Manager. For information about setting up devices and device groups, see Chapter 4, Device Group and Global Setup. To access the Device Manager, select Start > Programs > Data Collection Manager > Device Manager. The Device Manager main window opens. You can also click Tools to access the Device Manager from the Communication Monitor and Event Manager applications.
After they are created, the hierarchy of device groups, communication channels, and devices appears on the left; the Request Status appears on the right.
3-22
Kronos Incorporated
See the following sections for information about the dialog boxes that you need to complete for Ethernet, serial, and modem communication channels:
w w w
For Ethernet options, see Defining an Ethernet Communication Channel on page 3-23. For modem options, see Series 400 Ethernet Communication on page 3-25. For serial options, see Defining a Serial Communication Channel on page 3-30.
Note: If the communication channel assigned to the port or modem is running when you configure a serial or modem device, shut down and restart the channel before testing the device.
Defining an Ethernet Communication Channel

1. From the Device Manager main window, select Setup > Comm Channels. The Configure Comm Channels dialog box appears. 2. Click New. The New Channel dialog box appears. 3. Enter a unique Communication Channel name, and click OK. The Comm Channel - channel name dialog box appears.
3-23
Chapter 3
4. Enter a description of the communication channel and select the Communication PC that is part of the communication channel that you are configuring. 5. Select Ethernet as the Communications Type. 6. Select either Series 4000 or All other devices for the device type. 7. Specify the amount in seconds for the time between collections. The valid range is 10 to 43200 seconds. 8. If you selected All other devices for the device type, specify the Response Timeout for the Communication PC timeout. For busy networks, increase the value. 9. To specify the amount of time between network checks for active online devices, select the Enable Collecting device check box and specify the amount of time between network checks. A network check for collecting devices tests the connectivity between the Communication PC and the collecting devices managed within DCM.
3-24
Kronos Incorporated
10. To specify the amount of time between network checks for idle enabled devices, select the Enable Idle device check box and specify the amount of time between network checks. A network check for devices that are not collecting punches tests the connectivity between the Communication PC and the idle devices managed within DCM. 11. To return to the system defaults, click Defaults. 12. Click OK. Series 400 Ethernet Communication For busy networks, it is recommended that you increase the Ethernet timeout values on both the comm PC and the device. The standard timeout setting is two seconds. Valid settings range from one to five seconds. It is recommended that the timeout values for the comm PC and the device be equal. Note: Setting Ethernet timeouts applies to Series 400 devices only. To set the Ethernet timeout values for the comm PC and a device: 1. Close all data collection processes that are running on the comm PC. 2. Select Setup > Comm Channels. a. Highlight the appropriate communication channel and click Edit. b. Increase the Response Timeout. The maximum allowed is 5 seconds. 3. Set the device timeout from the comm PC. If you are not able to set the timeout value from the PC, go to step 4. a. Find the device AFT file (<device-id>.aft). b. Edit the command string that follows Set Ethernet timeout to include the last number in the command string, which is the actual timeout value. The following example shows setting the timeout value to five seconds. ---Set Ethernet timeout--///90#10#5#5#// c. Download the file to the device or devices.
3-25
Chapter 3
4. Set the device timeout at the device. a. Enter Maintenance mode. b. Set the value for the Command 90, Procedure 10, Step 5 to the desired value. It is recommended that this value equal the value that is set for the timeout for the comm PC. 5. Restart data collection processes on the Communications PC.
Defining a Modem Communication Channel

1. From the Device Manager main window, select Setup > Comm Channels. The Configure Comm Channels dialog box appears. 2. Click New. The New Comm Channel dialog box appears. 3. Enter the name of the new communication channel, which can be up to 20 characters, and click OK. The General tab of the Comm Channel dialog box appears. 4. Select Modem as the Communications Type on the General tab of the Comm Channel dialog box. Note: In Windows 2000, some modems may not be detected when both internal and external modems exist.
3-26
Kronos Incorporated
5. Enter a description of the communication channel and select the Communication PC. 6. In the Communications group box, select one of the following options:
w w
Series 4000, go to step 9. All Other Devices, go to step 7.
7. Click the Advanced tab and change any communications settings, for example, Word length, Parity, Stop bits, and so on, if needed. For more information about the advanced modem settings, see the DCM online Help.
8. Click the Modem tab.
3-27
Chapter 3
w w
From the Port list, select the communication port that the modem on the Communication PC is using. If you enabled auto detect, the Device Manager detects the modem that is on your current PC and displays the appropriate modem and initialization strings in the Modem tab. From the Baud rate list, select the baud rate of the modem for the Communication PC. From the Model string list, select the modem connected to your Communication PC. The initialization string for that modem appears automatically in the Initialization string box. The Initialization string box displays the initialization string, or sequence, for the selected modem from the Modem string list. You can edit this string by typing your changes in the Initialization string box. Before you do so, check your modem documentation for suggested initialization strings. Select the Carrier detect box to have the Data Collection Manager notify you when a modem has detected the carrier and the connection is made. Select the Parity check box to enable the Data Collection Manager to check the parity bit in the data received from the modem. The parity bit determines whether or not the data sent is intact and without error.
w w
3-28
Kronos Incorporated
w w
Click Auto detect to have the Data collection Manager check the PC that you are using for available modem connections or communication ports. Click Advanced to go to the Advanced Modem Settings dialog box. In this dialog box, you can set several parameters for the communication channel to issue to the Communication PC modem. If you are connecting the modem to multiple modem devices with different baud rates, set the baud rate for the communication channel to the lowest speed. If you need to change the communication settings at the device, check the devices configuration guide for the appropriate procedure. If you have a communication failure during initialization of Series 100 devices, increase the Wait after hang-up value to 4000 msec.
Go to Step 10.
9. If you selected Series 4000, from the Dial-up Connection drop-down list on the Modem tab for Series 4000 terminals, select the Modem tab to specify the dial-up connection that you configured in Windows. See Configuring a Dial-up Entry on Windows 2000 on page 3-12. If your dial-up connection does not appear in the list, see Configuring a Modem for a Series 4000 Terminal on page 3-6. Note: You cannot share a modem between a Series 4000 terminal and other types of devices. The following modems were verified for use with the Data Collection Manager system on Series 4000 terminals. Click Advanced and enter the modem configuration parameters:
Modem Zoom Dual Mode 56 US Robotics 56K Hayes Optima 56 Model Number 2929L 5686 02892
3-29
Chapter 3
The following modem strings were verified for use with the Data Collection Manager system on Series 400 devices. Click Advanced and enter the modem configuration parameters:
Modem Motorola 28.8K US Robotics 56K US Robotics 56K String &F\Q0 &FE1V1&C1&D2 &F&C1&D2&K0&N3 Baud Rate 19,200 2,400 19,200 2,400
USB modems are supported by DCM only for Series 4000 devices. 10. Make any changes needed and click OK to return to the Comm Channel dialog box.
Defining a Serial Communication Channel

Serial devices are defined only on the Communication PCs that they communicate with.
Caution: Series 400 serial devices cannot complete an initialization or an update

that contains non-English characters. For more information about initialization or update, see Configuring Device Parameters on page 5-2. To define a serial communication channel: 1. From the Device Manager main window, select Setup > Comm Channels. The Configure Comm Channels dialog box appears. 2. Click New. The New Comm Channel dialog box appears. 3. Enter the name of the new communication channel, and then click OK. The General tab of the Comm Channel dialog box appears.
3-30
Kronos Incorporated
4. Enter a description of the communication channel. 5. Select the Communication PC. 6. Select Serial as the Communications type. Two serial parameter drop-down lists appear on the dialog box. 7. Select the Serial port and Baud rate. 8. To specify the amount of time between network checks for active online devices, select the Enable Collecting device check box and specify the amount of time between network checks. A network check for collecting devices tests the connectivity between the Communication PC and the collecting devices managed within DCM. 9. To specify the amount of time between network checks for idle-enabled devices, select the Enable Idle device check box and specify the amount of time between network checks. A network check for running devices that are not collecting punches tests the connectivity between the Communication PC and the idle devices managed within DCM. 10. Click the Advanced tab.
3-31
Chapter 3
11. Select any necessary parameters from the Advanced tab. 12. Click OK. For information about the parameters, see the DCM online Help.
3-32
Kronos Incorporated
Chapter 4
Device Group and Global Setup
This chapter explains how to create, edit, and delete device groups and devices. This chapter contains the following sections:
w w w w w w w w w w w w w w w
Overview The Device Manager Creating Device Groups Editing Device Groups Copying Device Groups Deleting Device Groups Adding Devices Assigning a Device to a Device Group Editing Devices Copying Devices Deleting Devices Bell Schedules Gate Schedules Remote Transactions System Settings
Chapter 4
Overview
One major function of the Data Collection Manager (DCM) system is to collect data from devices and send it to a host application. This communication process involves application connections and communication channels, in addition to the data collection device and host application. For additional information about communication channels, including Ethernet, modem and serial connection setup, see Chapter 3, Communication Channels. For more information about data collection, see Chapter 9, Collecting Data and Managing Transactions. Note: Before you can assign a device to a device group by using the Device Manager, you must have a communication channel, a device group, and an application connection for the new device to be assigned. If you create a device with the Device Wizard, the communication channel and the device group do not need to be created first. For more information about using the Device Wizard to create devices, see Adding a Device by Using the Device Wizard on page 4-13.
Device
A device is a piece of electronic equipment, such as a Series 4000 terminal and its associated attributes. Using the DCM system, a device collects data input and interacts with an application through a communication channel. When defined, a device is an independent entity until it is grouped. A device contains specific attributes, which include:
w w w w w
Model type and description IP address or DNS name, if Ethernet Telephone number, if modem support Baud rate, if serial Time zone settings
For more information about the differences between the Series 400 and Series 4000 terminals, see Appendix D, Using DCM with Series 4000 Terminals.
4-2
Kronos Incorporated
Overview
Device Groups
Use device groups to organize data collection and assign employee lists to devices. For example, a device group can include all devices in a specific building or for a department. Some examples of device groups are:
w w w
Headquarters (building) Accounting (department, division, or function) Shop floor (location)
You can create more than one device group. For example, you can create one device group for all devices in the Accounting Division, another device group for all devices in the Engineering Division, and a third device group for all devices in the Sales Division. You can assign devices to more than one device group. For example, assign the devices that are in your Accounting, Engineering, and Sales device groups to a Facility device group. These devices are now part of four device groups: Accounting, Engineering, Sales, and the Facility groups. If you have more than one group, you can specify a device group to be a collecting device group or an assigning device group. Note: The Series 4000 terminal with Kronos Touch ID supports primary and secondary finger scan templates. The DCM Employee Biometric Data download option supports up to 4000 templates per device group. Each primary and secondary template is considered a home employee. If all the home employees are assigned both primary and secondary templates, the maximum number of home employees at the Kronos Touch ID device is then 2000. You can use device groups for:
w w
Data collection Employee assignment
4-3
Chapter 4
Collecting Device Groups You create collecting device groups to group sets of devices for collecting employee transactions and sending them to the host applications for labor tracking, report generating, wage calculations, and so on. Assigning Device Groups You assign employees to assigning device groups. You could send the employees information to the devices in all three buildings in the assigning device group, or just to the device at the front door of each of the buildings. An employee assigned to a specific device or device group is a home employee. The devices are called the employees home devices. A non-home employee is someone whose employee configuration is not downloaded to the device. Employee information downloads only to the device group to which the employees are assigned in their user employee profile in the host application. You could define what device group employees belong to based on their labor account assignment. Example of Collecting and Assigning Group Data Collection To enable data collection for all devices, create the Facility device group. The Facility device group becomes the collecting device group. The Accounting, Engineering, and Sales device groups become the assigning device groups. All DCM requests route to the device through the collecting device group. Organizing several devices into one device group conserves system resources.
4-4
Kronos Incorporated
The Device Manager
The Device Manager

The DCM Device Manager application enables you to create and manage device groups and devices. Device Manager also enables you to define application connections and communication channels. It also supports a Device Wizard that provides a series of dialog boxes in which you provide the information required to add devices. The Device Manager also simplifies communications by detecting available serial ports, installed modems, and Ethernet connections, and then automatically determines the communication channel that the device is to use. To access the Device Manager: 1. Select Start > Programs > Data Collection Manager > Device Manager. If no other DCM applications are open (except the Sentinel Service, which runs in the background on startup), you are required to enter a user name and password. 2. If necessary, type the user name and password, and then click OK. The Device Manager main window opens.
4-5
Chapter 4
The Device Manager main window displays your configuration. After a communications channel and a device is assigned to a device group, the device groups appear on the left; the Request Status panel appears on the right. Expand the tree view of the hierarchy to view the communication channel and devices of each device group. Note: An asterisk (*) preceding the name of a device in the hierarchy indicates that the device is assigned to collect data for that collecting group. Use the tree view as a shortcut to perform all functions in the Device Manager main window. For example, when you select a communication channel, you are selecting all the devices in that device group that communicate with the communication channel. Similarly, you can select multiple devices in a communication channel by using the Control key. If you have not defined application connections, the default application connections appear in the drop-down box. You must define at least one application connection before you create devices and device groups. For information about defining application connections, see Chapter 2, Defining an Application Connection.
4-6
Kronos Incorporated
Creating Device Groups

The Add Device Group dialog box enables you to create a new device group. You can access the Add Device Group dialog box in one of the following ways:
w
Using the Device Wizard when you are creating or editing a device (for more information about using the Device Wizard to create devices, see Adding a Device by Using the Device Wizard on page 4-13): 1. From the Device Manager main window, select Setup > Device Wizard. 2. Click New, or select a device and click Edit. 3. Proceed through the Device Wizard until you reach the Select Groups dialog box. 4. Click Add Group. The Add Device Group dialog box appears.
Using the Device Manager when you are creating or editing a device: 1. Open the Device Manager main window. 2. Select Setup > Device Groups. The Configure Device Groups dialog box appears. 3. Click New to add a device group. The Add Device Group dialog box appears.
4-7
Chapter 4
To create a device group: 1. In the Add Device Group dialog box, type the device group name and description. The maximum length for a group name is 20 alphanumeric characters. Do not use the following special characters in the group name: / * ? < > | : ; Note: Do not give the device group the same name as a communication channel in your configuration. Do not use names such as Modem1, Serial1, Ether1, and so on, for device group names. ModemX, SerialX, and EtherX (where X is any number greater than or equal to 1) are names that the Device Wizard uses for communication channels. 2. Select the application connection from the drop-down list of defined connections. 3. For online devices, select the Automatic Data Collection check box to set up automatic data collection when the communication channel is started in the Sentinel Service. For more information about data collections, see Chapter 9, Collecting Data and Managing Transactions. 4. Select the Transaction Output File check box to enable a transaction output file that stores all collected transactions for the device group. 5. When you finish, click Add and then click Close. Note: After you assign a device and communication channel to the device group, it appears on the Device Manager main window left panel (tree). A device, a communication channel, and a device group must be associated together to complete the device group. If you create a device with the Device Wizard, the communication channel and the device group do not need to be created first. For more information about using the Device Wizard to create devices, see Adding a Device by Using the Device Wizard on page 4-13. For more information about creating device groups, search on device group in the online Help index, or click Help in any of the Device Group dialog boxes.
4-8
Kronos Incorporated
Collecting vs. Assigning Groups If you have only one group, it defaults to a collecting group. If you have multiple groups, you designate one of the groups as the collecting group; the others are assigning groups. The following rules apply to device groups:
w w w w w
You can assign a device to only one collecting device group. You can assign a device to many assigning device groups. A collecting device group can also be an assigning device group. You can create many combinations of assigning device groups, but you can assign each employee to only one assigning device group. Devices in assigning device groups and collecting device groups can use different types of collection methods.
Displaying Collecting and Assigning Group To display or hide collecting or assigning groups: 1. From the Device Manager main window, select View > Device List. 2. Click the Collecting Groups, or Assigning Group, or both, to display them. Clear either Collecting Groups or Assigning Groups to hide them. Devices assigned to collect data for their group appear with an asterisk (*).
4-9
Chapter 4
Editing Device Groups

You can change a device group description, the application connection, or automatic data collection and data transaction file selections. See the DCM online Help for more information about these values. When you edit a device group, all devices assigned to that group are affected. To edit a device group: 1. From the Device Manager main window, select Setup > Device Groups. The Configure Device Groups dialog box displays the device groups currently configured. 2. Select a device group and click Edit. The Edit Device Group dialog box appears.
To edit a device group, make changes in the Edit Device Group dialog box, and click Update.
4-10
Kronos Incorporated
Copying Device Groups
Copying Device Groups

You can copy the parameters of one device group and change the name to create a new group. Copying a device group does not copy the devices assigned to the original device group. The new device group has no assigned devices until devices are assigned to it. Load the configuration to the device or devices before you begin data collection. To copy a device group: 1. From the Device Manager main window, select Setup > Device Groups. The Configure Device Groups dialog box appears. 2. Select a device group and click Copy. The Add Device Group dialog box appears.
To copy a device group, type a name for a new device group in the Add Device Group dialog box, and click Add.
4-11
Chapter 4
Deleting Device Groups

You can delete a device group only if no devices are assigned to it. You cannot delete a device group that is assigned to any employees. Before you remove the last device assigned to the device group, you must remove any employees assigned to that device. You may assign employees to a device in another device group. To delete a device group: 1. From the Device Manager main window, select Setup > Device Groups. The Configure Device Groups dialog box displays the device groups currently configured. 2. Select a device group and click Delete. 3. Click Yes in the confirmation message box to delete the selected device group. The device group is removed from the DCM database.
4-12
Kronos Incorporated
Adding Devices
Adding Devices
You can add devices by using the Device Wizard or the Device Manager. The Device Manager provides the Device Wizard that displays a series of dialog boxes that enable you to specify device information. DCM selects the communication channel for the device. Note: Before you can assign a device to a device group, you must have a communication channel and a device group for the new device to be assigned.
Adding a Device by Using the Device Wizard

To use the Device Wizard to add a device: 1. From the Device Manager, select Setup > Device Wizard. The Configure Devices with Device Wizard window opens.
2. Click New. The Device Wizard appears. 3. The Welcome to the Device Wizard window lists the information that you need to enter to add a device. After reading the Welcome to the Device Wizard window, click Next. 4. In the Device Model dialog box, select the device from the list of supported devices and click Next.
4-13
Chapter 4
5. In the Device Identification dialog box:
4-14
Kronos Incorporated
Adding Devices
a. Enter a unique name and a 6-digit device ID for the device that you selected. The device ID is the unique six-digit password number that matches the password programmed at this device during installation. When defining Series 100 devices, assign a unique six-digit device ID to each device, even though the password at the physical device is always set to 000000. b. You can add a Device description that identifies the device; for example, a description that describes its location or use within your organization. The description can be up to 40 alphanumeric characters, including spaces. c. Click Next. 6. In the Time Zone dialog box: a. Select a time zone for the location of the selected device. b. Select or clear the Automatically adjust device for daylight-saving time changes check box. If you are adding a Series 400 device, an AFT Command 113 must be sent to the device once every six months to ensure that daylight-saving time (DST) works properly. A Command 113 is sent whenever an initialize or an update is sent. It is not included in the generated AFT file, but is logged. Each initialization or update that contains information sends Host Command 113, which specifies when the next DST change is to occur and in which time direction. This command must be sent to each legacy device that is configured to automatically adjust its time at least once between each DST change. However, Host Command 113 is subject to a blackout period. The default blackout period duration is one hour before and 24 hours after a DST change. If you add or edit a device on your system during the blackout period, you must manually send the time to the device and initialize the device after the blackout period. 7. If you are adding a Series 4000 terminal, select the language. English is the default. 8. If you are adding a non-Series 4000 terminal, you can select to have a printer attached.
4-15
Chapter 4
9. In the Communication dialog box: a. Select the communication method. Either Ethernet or modem for Series 4000 terminals and Ethernet, modem, or serial for all other devices. b. Select the name of the Communication PC. c. Click Next. 10. In the Collection dialog box, select the method to use to collect data from the device. Online collection allows for continuous data collection from the device when initiated. Online devices can also use scheduled collections. Batch collection sends data when a collect event scheduled in Event Manager is initiated. Modem devices use batch. Serial and Ethernet devices may use either online or batch collection. 11. Enter the following information in the Communication Settings dialog box, depending whether your connection is Ethernet, modem, or serial:
w
For an Ethernet connection, select Use IP address or Use Host Name, and then type the IP address or host name. If you enter an IP address, do not use leading zeros. For example, type 192.168.2.2, not 192.168.002.002. For more information about how to decide which IP address to use, see About IP Addresses for the Communication PC and Series 4000 Terminals on page 3-6. Do not enter DNS server addresses. If you enter a host name, it must be known on your network by being configured on a Domain Naming System (DNS) server on your network.
For a modem connection: For a Series 400 device, type the telephone number and select a modem string from the Modem string list. Click Add/Edit to add a modem initialization string, or select a string from the list and click Add/Edit to edit a string. DCM automatically detects the modem configured on your system.
Note: You cannot share a communication channel or modem between a Series 4000 terminal and other types of devices.
4-16
Kronos Incorporated
Adding Devices
For a Series 4000 terminal, type the telephone number. Select the dial-up connection that you configured in Windows. If your dial-up connection does not appear in the list, see Configuring a Modem for a Series 4000 Terminal on page 3-6.
w
If you are adding a serial device, select the port, if necessary. DCM automatically detects available ports. You can accept or change the baud rate.
12. In the Select Groups dialog box, select a collecting device group and, optionally, an assigning device group for the device. If no group has been created or if you want to add another group, click Add Group. For more information on adding groups, see Creating Device Groups on page 4-7. 13. When you finish, click Next. 14. In the Testing Device dialog box: a. Click Test Device and watch the progress of testing the device in the Device test information box. Click Finish. The Download Options dialog box appears. b. Select the download options for your device. Download options specify what information to send to devices from the Workforce Timekeeper database. For more information about the download options, click Help in the Download Options dialog box, or see Events and Download Options on page 9-31. c. Click OK or Cancel to add the data collection device to the database. If you select Cancel, Device Configuration is the only option selected for downloading when initializing the device. 15. In the confirmation message box, click Yes to add another device, or No to exit the Device Wizard and return to the Device Manager.
Adding a Device by Using the Device Manager

To use the Device Manager to add a new device: 1. From the Device Manager main window, select Setup > Devices. The Setup Devices dialog box appears.
4-17
Chapter 4
2. Click New. The New Device dialog box appears.
3. Type a unique, six-digit ID, and click OK. The Device - ID dialog box appears.
4-18
Kronos Incorporated
Adding Devices
4. On the General tab of the Device - ID dialog box, select the model type and the collection method. The default is Online. The options available for the device model type you selected are enabled, and a Time Zone tab appears. Online collection allows for continuous data collection from the device when initiated. Online devices can also use scheduled collections. Batch collection sends data when a collect event scheduled in Event Manager is initiated. Modem devices use batch. Serial and Ethernet devices may use either online or batch collection.
5. The Device name defaults to the word Device and the six-digit ID specified in step 3. You can edit the device name, which can be up to 15 alphanumeric characters, including spaces. 6. You can add a description of the device to identify it; for example, a description that describes its location or use within your organization. The description can be up to 40 alphanumeric characters, including spaces. 7. If you are using an IP address, type the address in the Communication settings section. If you are entering an IP address, do not use leading zeros. For example, type 192.168.2.2, not 192.168.002.002. For more information about how to decide which IP address to use, see About IP Addresses for the Communication PC and Series 4000 Terminals on page 3-6. Do not enter DNS server addresses.
4-19
Chapter 4
If you are using a host name, select the Use Host Name check box, and enter the Host Name in the Communications settings section. Ethernet devices can use a host name that is known on your network. The host name must be configured on a Domain Naming System (DNS) server on your network. 8. If appropriate, enter the phone number of the associated modem from which the device can be reached in the Phone number text box. 9. Device Enabled is selected by default. Only enabled devices can be used in communication. If you clear the Device Enabled check box, save the added device, and then later change the device to enabled, you are notified that if the device is assigned to a device group and the group is being used for data collection in your system, you must use the Sentinel program to restart the communication channel that supports the disabled device. If changes were made to the device configuration, you must initialize the device to download the information. The bright green icon in the Device Manager hierarchical tree indicates that the device is enabled. A darkened green icon indicates disabled devices. 10. If you are adding a Series 400 device, you can also select the Printer Attached check box. 11. If you are adding a Series 4000 terminal, specify the language. English is the default. 12. Select Download Options and Application Options as needed. You can also select Configuration options. Download options specify what information to send to devices from the Workforce Timekeeper database. For more information about the download options, click Help in the Download Options dialog box. Application options specify which activity code profiles, tips, job sets, and labor level sets are downloaded to the device. For more information about the application options, click Help in the Application Options dialog box.
4-20
Kronos Incorporated
Adding Devices
For more information about job sets and job transfers, see Job Transfer Tab on page 5-40. For more information about Activity Code profiles, see Chapter 8, Activity Codes, Comment Codes, and Pay Code Edits. For more information about Labor level sets, see Chapter 6, Setting Up Labor Level Information. 13. If you need to specify a time zone other than Eastern Standard time, or you want to disable the daylight-saving time selection, click the Time Zone tab and make any necessary selections. In the Time Zone dialog box: a. Select a time zone for the location of the selected device. b. Select or clear the Automatically adjust device for daylight-saving time changes check box. Note: If you are adding a Series 400 device, an AFT Command 113 must be sent to the device once every six months to ensure that DST works properly. A Command 113 is sent whenever an initialize or an update is sent. It is not included in the generated AFT file, but is logged. 14. When you are finished, click OK to add the device.
Viewing Devices List

To view the list of created devices: 1. From the Device Manager main window, select Setup > Devices. The Configure Devices dialog box appears. 2. Click Export. A list of the devices and other information, such as the Device ID and device type, is placed in a file in the DCM/data data directory.
4-21
Chapter 4
Assigning a Device to a Device Group

If you created a device using the Device Manager, rather than the Device Wizard, you must assign the device to a device group. When you assign the device to a device group, on the Device Manager main window, the hierarchy of device groups, communication channels, and devices appears on the left; the Request Status appears on the right. The device that you added appears on the left. If it does not, select View > Refresh. The asterisk (*) preceding the name of the device in the hierarchy indicates that the device is active for data collection, and that the device group it is assigned to is a collecting device group. Device groups without an asterisk are assigning device groups. To assign a new device to a device group: 1. From the Device Manager main window, select Setup > Assign Devices to Groups. The Assign Group devices dialog box appears. 2. Select the device group where the device is to be assigned from the Device Group drop-down list. 3. Select the Communication Channel that the device is to use from the Assign Using Comm Channel drop-down list. 4. Select the device to be assigned from the Unassigned devices list, and click Add. The device moves to the Assigned devices list. 5. Repeat steps 2 through 4 as many times as needed to add devices to a device group. 6. To return to the Device Manager main window, click OK.
Assigning Devices by Using Communication Channels

If your device groups have been created, you can assign devices to device groups by communication channels. To assign devices to device groups by using communication channels: 1. From the Device Manager main window, select Setup > Assign Devices to Groups.
4-22
Kronos Incorporated
Assigning a Device to a Device Group
2. Select a device group from the Device Group drop-down list. 3. Select a device from the Unassigned devices list to add to the device group. 4. Select a communication channel from the Assign Using Comm Channel dropdown list. Note: Use the communication channel that matches the devices communication method. For example, assign an Ethernet device using an Ethernet communication channel. 5. Click Add. The selected device is added to the device group and appears in the right window. 6. Repeat steps 4 and 5 until all devices that you need to connect through the selected communication channel are added to the device group. 7. When done, click OK. Assigning a Device to More Than One Group After assigning a device to one group, you can assign it to a second or third device group. For example, you assign Device 1 to a device group named Building 2 and you also assign Device 1 to the Engineering device group. After assigning Device 1 to both device groups, make sure that only one instance of the device is enabled at a time for data collection. To assign a device to more than one device group: 1. From the Device Manager main window, select Setup > Assign Devices to Groups. 2. Select the device, for example Device 1, that you added to device group Building 2. 3. Select a second device group, for example Engineering, to which to add Device 1. 4. Select a communication channel that matches the communication method of the device, for example Ethernet for an Ethernet device.
4-23
Chapter 4
5. Click Add. The device (Device 1) is assigned to a second device group, Engineering, as well as Building 2. A message appears that tells you that the device is enabled for Data Collection in a particular device group, for example, Building 2, and asks if you want to enable it in the new group, for example Engineering.
w w w
Click Yes if you are defining a new collecting device group and click OK on the Assign Group Devices dialog box. Click No if you are defining an assigning device group and click OK on the Assign Group Devices dialog box. Click No and Cancel to cancel assigning the device to a another group.
Specify a collecting device group to collect data, such as transactions, from devices. Specify an assigning device group to collect employee information, such as schedules, from devices. Both types of device groups assist support personnel. For more information about collecting and assigning device groups, see Device Groups on page 4-3. 6. Repeat steps 25, selecting another device group to which you add the device, until the device is added to all the required device groups. 7. When done, click OK.
4-24
Kronos Incorporated
Editing Devices
Editing Devices
You can edit device information, such as the device name, IP address, or download and application options by using the Device Manager or the Device Wizard.
Editing a Device by Using the Device Wizard

To use the Device Wizard to edit a device: 1. From the Device Manager main window, select Setup > Device Wizard. 2. Select a device and click Edit. The Device Wizard window opens. 3. Click Next to begin going through the series of dialog boxes. 4. Make any necessary changes as you go through the dialog boxes. 5. When you are done making changes, click Finish.
Editing a Device by Using the Device Manager

To use the Device Manager to edit a device: 1. From the Device Manager main window, select Setup > Devices. The Configure Devices dialog box appears. 2. Select the device to edit and click Edit. The Device dialog box appears. 3. On the General tab, make the appropriate changes and click OK. The Device dialog box remains open. Note: If you change the IP address, restart your application connection. 4. Repeat steps 1-3 to edit more devices, or click Close to return to the Device Manager main window. To use the Device Manger to edit application options, download options, or configuration options, select a device on the Device Manager main window, and then select the appropriate option from the Configuration menu.
4-25
Chapter 4
Copying Devices
Use the Copy command when you have set up a device and want other devices to use that same setup. It copies all entries that are common between the two setups, such as the configuration, and download and application options. You can copy devices by using the Device Manager or the Device Wizard.
Copying a Device by Using the Device Wizard

To use the Device Wizard to copy a device: 1. From the Device Manager main window, select Setup > Device Wizard. The Device Wizard window opens. 2. Select a device to copy and click Copy. 3. The Device Identification dialog box of the Device Wizard appears. 4. Type a name and unique device ID and click Next. 5. Click Next to proceed through the Device Wizard until you reach the Communications Settings dialog box. You must change the IP address for the copied device. 6. When you reach the end of the Device Wizard, click Finish to add the device to the database. 7. Assign the new device to a device group. The device appears on the Device Manager main window. For information about assigning devices, see Assigning a Device to a Device Group on page 4-22.
Copying a Device by Using the Device Manager

To use the Device Manager to copy a device: 1. From the Device Manager main window, select Setup > Devices. The Configure Devices dialog box appears. 2. Select the device to copy and click Copy. The New Device dialog box appears.
4-26
Kronos Incorporated
Copying Devices
3. Type a unique, six-digit device ID and click OK. The Device dialog box appears. The General tab displays the parameters for the device being copied. 4. You must change the IP address for the device. 5. When you finish making changes, click OK. 6. Assign the new device to a device group. The device appears on the Device Manager main window. For information about assigning devices, see Assigning a Device to a Device Group on page 4-22.
4-27
Chapter 4
Deleting Devices
Before deleting a device, remove the device from the device group or groups where it is assigned and use the Application Options dialog box to unassign all labor levels from the device. For more information about labor levels, see Chapter 6, Setting Up Labor Level Information. Note: Collect any punches left in the device before you delete the device. You can delete a device by using the Device Manager or the Device Wizard. Note: After the last device is removed from a communication channel, the communication channel use remains device-specific. A communication channel with all Series 4000 terminals deleted is then available only for Series 4000 terminals. A communication channel with all other types of devices deleted can then be used only for non-Series 4000 terminals.
Deleting a Device by Using the Device Wizard

To use the Device Wizard to delete a device: 1. From the Device Manager main window, select Setup > Device Wizard. The Device Wizard window opens. 2. Select a device to delete. 3. Click Delete. 4. Click Yes in the confirmation message dialog box to delete the device. The device is removed from the device groups and is deleted from the Data Collection Manager database.
4-28
Kronos Incorporated
Deleting Devices
Deleting a Device by Using the Device Manager

To use the Device Manager to delete a device: 1. From the Device Manager main window, select Setup > Assign Devices to Groups. The Assign Group devices dialog box appears. 2. Select the device group where the device is assigned from the Device Groups drop-down list. 3. In the Assign Group devices dialog box, select the device to delete from the Assigned devices list, and click Remove. The device moves to the Unassigned devices list. 4. Repeat steps 2 and 3 as many times as needed to remove the devices from each device group to which they are assigned. 5. To return to the Device Manager main window, click OK. 6. Select Setup > Devices. The Configure Devices dialog box appears. 7. Select the device ID for the device to be deleted and click Delete. 8. To delete the device, click Yes in response to permanently removing the device from the DCM database. Click Close.
4-29
Chapter 4
Bell Schedules
You can configure a Series 4000 terminal that is equipped with a bell and power
source to ring a bell at specific times during the day on select days of the week to mark events, such as shift or break start and end. You can also configure the bell to ring as a warning before the scheduled times. A bell schedule consists of the settings, including the optional warning bell settings, to ring a bell at a specific time on specific days of the week. You can create as many schedules as you want but you can only assign up to 48 schedules for a single device. Note: You can configure a Series 4000 terminal to activate a bell or a gate, but not both. You can configure a function key at a Series 4000 terminal to enable a Supervisor to display all bell schedules assigned to the terminal, ring the bell, or silence the bell. For more information about bell schedules and function keys, see Function Key Tab on page 5-30. To create a bell schedule: 1. From the Device Manager main window, select Setup > Bell Schedules. If no bell schedules were created, the Bell Schedule dialog box appears, where you can create a bell schedule. If bell schedules were created, the Bell Schedules dialog box appears. Click New and the Bell Schedules dialog box appears.
4-30
Kronos Incorporated
Bell Schedules
2. Enter a unique bell schedule name. For example, Bell - Loading Dock. The maximum number of valid characters is 50. Do not use the following characters: \, /, *, , , ?, <, >, :, ;, and # 3. To enable the bell to ring for this bell schedule, select the Enable Bell check box. This setting allows you to temporarily disable the bell for this schedule at a future point without requiring you to un-assign this bell schedule from each Series 4000 terminal. For example, if the bells usually ring on Mondays but on Memorial Day the bells are shut off, clear the Enable Bell check box for the Monday bell schedule and initialize each terminal with the Device Configuration Download Option enabled prior to Memorial Day. 4. Specify the time of day, in 24-hour format, that the primary bell is to ring. 5. Specify the duration of the primary bells ring. Valid durations are from one to nine seconds. 6. Select the days that the primary bell is to ring.
4-31
Chapter 4
7. To specify an optional warning bell: a. Select the Enable Warning Bell check box. b. Specify the number of minutes before the primary bell is scheduled to ring that the warning bell is to ring. Specify the length of time in seconds that the warning bell is to ring. Valid durations are from one to nine seconds. Because both the primary bell and the warning bell ring at the same volume, you can distinguish a warning bell with a shorter duration time than the primary bell. You can create as many bell schedules as you want, and you download up to 48 bell schedules for each device. To assign bell schedules to a specific Series 4000 terminal, refer to Bell Schedules Tab on page 5-13. Bell Schedules are sent to Series 4000 terminals as part of an Initialize that includes Device Configuration. If you add, edit, or delete bell schedules or change which bell schedules are assigned to a particular Series 400 terminal, you must Initialize the device with the Device Configuration Download option enabled in order for the changes to take effect at the terminal.
Adding, Editing, Copying, or Deleting a Bell Schedule

To add, edit, copy, or delete a bell schedule: 1. From the Device Manager main menu, select Setup > Bell Schedules. The Bell Schedules dialog box appears. 2. Select a bell schedule and click Edit, Copy, or Delete.
4-32
Kronos Incorporated
Gate Schedules
Gate Schedules
You can configure a gate schedule for a Series 4000 terminal to control gate entry based on time enforcement rules. Gates can be a door, turnstile, gate, or other device controlled by an electronic lock. The two types of gate schedules are gate open schedule and gate off schedule.
w
A gate open schedule defines a period of time for specified days of the week during which the gate remains unlocked, so a user does not have to perform a transaction at the Series 4000 terminal in order to open the gate. A gate off schedule defines a period of time for specified days of the week during which the gate remains locked, even if an employee performs a transaction that would otherwise unlock the gate. A supervisor-only transaction must be performed at the Series 4000 terminal in order to open the gate during a gate off schedule.
From the Device Manager, select Setup>Gate Schedules to define Gate open and off schedules, and to assign then up to seven Gate Open, or seven Gate Off, or both schedules for each Series 4000 terminal attached to a Gate. You can configure a Series 4000 terminal function key to enable a supervisor to display all gate schedules assigned to the device, open a gate for a length of time, and open a gate for an employee. For more information about assigning a function key, see Function Key Tab on page 5-30. In addition to gate open and off schedules, you can configure the following gate related functions at Series 4000 terminals:
w
For employee mode transactions, the gate opens only if both of the following events occur: The Series 4000 terminal accepts the transaction. The employee ID satisfies the Gate validation rule that is selected on the Gate Entry tab in the configuration. The two valid gate validation rules are accept any valid employee badge format, which includes home and non-home employees, and accept home employee badges only.
Only supervisors can open the gate for non-home employees.
4-33
Chapter 4
For supervisor mode transactions, either of the following transactions opens the gate and does so without validation: Open gate for individual employee Open gate for specified length of time
You can create and download up to seven gate open and seven gate off schedules for a Series 4000 terminal. Note: You can configure a Series 4000 terminal to activate a gate or a bell, but not both. To create a gate schedule: 1. From the Device Manager main window, select Setup > Gate Schedules. The Gate Schedules dialog box appears. If no gate schedules were created, the Gate Schedule dialog box appears, where you can create a gate schedule. If gate schedules were created, the Gate Schedules dialog box appears. Click New and the Gate Schedule dialog box appears.
4-34
Kronos Incorporated
Gate Schedules
2. Enter a unique Gate Schedule name. For example, Gate Schedule - Main Building or Gate Schedule 1. The maximum number of valid characters is 50. Do not use the following characters: \, /, *, , ?, <, >, :, and ; 3. Specify whether this schedule is a gate open or gate off schedule. 4. To a enable a gate for this gate schedule, select the Enable Schedule check box. This allows you to define a gate schedule and separately control whether it is used or not. For example, if the gates usually are accessible on Mondays but on Memorial Day the gates are not accessible, clear the Enable Gate check box for the Monday gate schedule and initialize prior to Memorial Day. 5. Specify the time of day that the gate schedule starts. Specify the time in 24hour format, from 00:00 to 23:59 inclusive. 6. Specify the length of time that the gate is open if this is a gate open schedule or is closed if this is a gate off schedule. Specify the time in 24-hour format, from 00:01 to 23:59 inclusive. 7. Specify the days of the week that the gate schedule is in effect. 8. Click OK.
4-35
Chapter 4
To assign one or more gate schedules to a specific series 4000 terminal, see Gate Schedules Tab on page 5-38. Gate schedules are sent to Series 4000 terminals as part of an Initialize that includes Device Configuration. If you add, edit, or delete gate schedules or change which gate schedules are assigned to a particular Series 4000 terminal, Initialize the devices with the Device Configuration Download option enabled in order for the changes to take effect at the devices.
Adding, Editing, Copying, or Deleting a Gate Schedule

To add, edit, copy, or delete a gate schedule, from the Device Manager main menu: 1. Select Setup > Gate Schedules. The Gate Schedules dialog box appears. 2. Select a gate schedule and click Edit, Copy, or Delete.
4-36
Kronos Incorporated
Remote Transactions
Remote Transactions
Remote transactions use a browser in the Series 4000 terminal to perform online transactions in a manner similar to accessing a Web site on a PC. Unlike other transactions performed at Series 4000 terminals, remote transactions do not generate transaction records that are collected by DCM, as data entered by the user is immediately processed by the Web server to which the Series 4000 terminal is connected. All remote transactions are identified in the Function Key tab with [Remote Transaction] displayed following the transaction name. Remote transactions are sent to Series 4000 terminals as part of an Initialize that includes Device Configuration. If you add, edit, or delete remote transactions or change which remote transactions are assigned to a particular Series 4000 terminal, you must Initialize the terminal with the Device Configuration Download option enabled in order for the changes to take effect at the terminal. Data Collection Manager provides one or more predefined remote transactions. You may edit these remote transactions to change the Web server or transaction name, but no other changes should be made. You cannot delete predefined remote transactions. Clicking Delete returns the transactions to their predefined Web server and transaction name. Workforce Central applications including Workforce Timekeeper and Workforce Activities provide remote transactions that are available after installation, and may add additional remote transactions based on user actions. These remote transactions are displayed in the DCM configuration Function Key tab to allow assignment to specific Series 4000 terminals. They may or may not be available for editing in the Remote Transaction dialog box as explained in the following sections.
4-37
Chapter 4
Creating a Remote Transaction

To create a remote transaction: 1. From the Device Manager main menu, select Setup > Remote Transactions. If no remote transactions were created previously, the Add Remote Transaction dialog box appears. If remote transactions were created, the Setup Remote Transactions dialog box appears. Click New. The Add Remote Transaction dialog box appears.
2. Enter the Remote Transaction name. The Remote Transaction name is a user-defined name that DCM can include in the available functions list for soft key assignments. If the URL parameters are not listed in the URL Parameters text box in the Remote Transaction dialog box, the system downloads the name of the transaction name and the Transaction URL to the Series 4000 terminal. The maximum number of valid characters is 50. Do not use the following characters: \, /, *, , , ?, <, >, :, ;, and #. DCM lists the transaction name in the device configuration options user interface for softkey functions assignment with [Remote Transaction] appended to the name. For example, Begin Activity [Remote Transaction].
4-38
Kronos Incorporated
Remote Transactions
3. Enter the transaction code. The transaction code is a unique name for the transaction. For example, BAC. Usually the code name is three characters. The maximum is 5 characters. The transaction code name is unavailable when you edit the transaction name. 4. Enter the transaction URL. Enter the URL of the Web server that will execute the transaction. The transaction URL can be a URL for the default HTML page with the soft key definitions for the Workforce Activities transactions, or the URL for each of the defined activities transactions. For example, http://MYSERVER/ wfc/wfa/4000servlets/beginact.jsp. The setting is global. Enter the URL in Web-permissible format, beginning with either http:// or https://. The maximum number of combined Transaction URL and URL Parameters characters is 255. Note: If you enter a DNS name as part of the URL (for example, http:// mywebserver/transaction.jsp), you must enable DNS support at Series 4000 terminals to which this remote transaction is assigned (refer to the Series 4000 Installation Guide for details). Otherwise, you must enter the IP Address of the web server (for example, http://155.155.18.32/transaction.jsp) 5. If any other transaction parameters are required to be appended to the URL, enter them in the URL Parameters text box. Entering Parameters is optional. The maximum number of characters for Parameters is 120. The maximum number of combined Transaction URL and URL Parameters characters is 255. The syntax for a possible string could be &Key1=value1&Key2=value2&... where Key1, Key2... are the additional fields required by the remote transaction. 6. Specify the timeout in seconds that the terminal is to wait for a response while invoking the URL to the server. The minimum is 0 seconds. The maximum value is 1800 seconds. The default is 30 seconds. 7. Select Prompt for Employee Badge if the employee is to swipe or enter the employee badge immediately after selecting the remote transaction soft key so that the Web server can look up employee-specific information before starting the remote transaction. 8. Click OK.
4-39
Chapter 4
Editing a Remote Transaction

To edit a remote transaction, from the Device Manager main menu: 1. Select Setup > Remote Transactions. The Remote Transaction dialog box appears. View Schedules Online is a DCM default remote transaction. Note: The URL setting for a remote transaction is global. Changes made affect all DCM installations that use the same server.
2. Select the remote transaction and click Edit. 3. Edit any of the text boxes except the Transaction Code. 4. Click OK.
Copying a Remote Transaction

To copy a remote transaction, from the Device Manager main menu: 1. Select Setup > Remote Transactions. The Remote Transaction dialog box appears. 2. Select the remote transaction. 3. Click Copy. 4. Enter the new Transaction Name and its Transaction Code.
4-40
Kronos Incorporated
Remote Transactions
5. If any other transaction parameters are required to be appended to the URL, enter them in the Properties text box. Entering Properties is optional. The syntax for a possible string could be &Key1=value1&Key2=value2&... where Key1, Key2... are the additional fields required by the remote transaction. 6. Specify the timeout in seconds that the terminal is to wait for a response while invoking the URL to the server. The minimum is 0 seconds. The maximum value is 1800 seconds. The default is 30 seconds. 7. Select the Prompt for Employee Badge check box if the employee is to swipe or enter the employee badge before selecting the remote transaction soft key. 8. Click OK.
Deleting a Remote Transaction

To delete a remote transaction, from the Device Manager main menu: 1. Select Setup > Remote Transactions. The Remote Transaction dialog box appears. 2. Select the remote transaction and click Delete.
Assigning a Remote Transaction to a Function Key

After you add, edit, or copy a remote transaction, assign the remote transaction to a function key by using the Function Key tab, see page 5-30. The Function Key tabs Assign Function Key dialog box contains both local and remote transactions. When you download the Device Configuration, all soft key assignments are sent to the terminal.
4-41
Chapter 4
System Settings
You can specify DCM system settings for the following DCM properties:
w w w w w w w
General settings for transaction output files, starting Event Manager, and parameter file display and removal Log file settings for size, count, and reporting level for the DCM log file that is applicable across all Communication PCs Device download retries and reuse Communication for phone book path and direct communication path Global values for file-based requests and timeframe for totals and accruals E-mail notification server and recipients Workforce Central connection to a Workforce Activity application server or additional Workforce Timekeeper application servers when DCM is installed for Workforce Timekeeper
All the System Settings, with the exception of those on the Global Values tab, apply only to the DCM Communications PC on which Device Manager is currently being run. To make changes to system settings other than Global Values, you must run Device Manager on each DCM Communications PC and make the appropriate System Settings changes. Changes to settings on the Global Values tab affect the operation of all DCM Communications PCs, regardless of which DCM Communication PC is running Device manager when the changes are made. Some settings are device-specific. For example, you can specify that a parameter file be automatically deleted after device configuration is extracted for a Series 400 device. Note: After you change any system setting, disable and enable Sentinel Service. You can do this from the Sentinel Service tray icon. To specify the system settings, from the Device Manager, select Setup > System Settings. The System Settings dialog box appears.
4-42
Kronos Incorporated
System Settings
Note: Click OK only after you are finished configuring all tabs that are to be changed.
All the System Settings, with the exception of those on the Global Values tab, apply only to the DCM Communications PC on which the Device Manager is currently being run. To make changes to system settings other than Global Values, you must run Device Manager on each DCM Communications PC and make the appropriate System Settings changes. Changes to settings on the Global Values tab affect the operation of all DCM Communications PCs, regardless of which DCM Communication PC is running Device manager when the changes are made.
4-43
Chapter 4
General Settings
To specify the general system settings: 1. From the Device Manager, select Setup > System Settings. The System Settings dialog box appears. 2. Select the General tab. 3. Specify the maximum transaction output file rollover size in KB that is reached before the next transaction output file is created. The minimum supported value is 0. The default count is 500. The maximum supported value is 20000. During data collection, transaction output files receive punch and transaction information. These files are located in the DCM/data/trx directory. When the transaction output file approaches the maximum, the existing file is renamed with a timestamp appended to the name and a new file is created. This function does not delete any files. For example, trxout file name.out becomes trxout file name_timestamp.out. The new transaction output file then becomes ltrxout file name.out. The following example shows Group1 is a transaction output file and Group1_0725200253102.out is a rollover file: trx\ Group1.out Group1_0725200253102.out 300K 503K
4. To specify that the Sentinel Service automatically starts the Event Manager whenever the Sentinel Service is started, loads the last Event Manager list file, and does not require a User Name and Password (integrated logon), select the Start Event Manager with Sentinel check box. Note: When the Sentinel Service is set to automatically enable the Event Manager, list files created by users must be placed in a share folder that grants access permission to all users on the local Communications PC.
4-44
Kronos Incorporated
System Settings
5. To specify that the Device Manager display a failed parameter file into a notepad editor when the configuration upload from a Series 400 device is complete, select the Show failed parameter file after device configuration is extracted check box. When an extract device configuration request is made to the device, DCM puts the imported configuration parameters into one file and all failed parameters into another file. These failed parameters are ones that DCM could not recognize for this device or could not parse to import into the DCM device configuration table. 6. For all Series 400 devices, to delete the parameter file after executing an Extract Parameter File operation, select the Remove parameter file after device configuration is extracted check box. Series 4000 terminals do not support the Extract Parameter File operation. To save the file after executing an Extract Parameter File operation, clear the Remove parameter file after device configuration is extracted check box. This allows the file to be saved in an ASCII file, data\temp\device_id_temp.
Log File Settings

DCM provides and maintains a centralized log message file for each DCM system that provides an audit trail, which is a useful diagnostic tool.The centralized log file combines all log messages from the different DCM applications into one file. These messages report both errors and normal information about operations and DCM actions. The settings on the Log File tab define the actions that the log file lists. Log File Severity Reporting Levels You can specify the severity level that messages must attain to be reported in the log file. The four levels of severity are:
w w
ERRORThe ERROR message reports a serious discrepancy within DCM. Either system stability or data integrity may be compromised. WARNINGThe WARNING message reports that an unexpected condition occurred within DCM, which probably signals an error, but either is ignorable or the code can perform a standard correction to continue.
4-45
Chapter 4
w w
INFOThe INFO message reports a normal DCM operation. DEBUGFor internal use only.
DEBUG is the highest logging level and includes all levels. Enabling this setting may significantly reduce DCM performance, and should only be enabled if directed buy your service representative. INFO is the next level down and includes WARNING and ERROR messages. WARNING is the next level down and includes ERROR messages. ERROR is the lowest logging level. The default is INFO and is the recommended setting. Specifying the Log File Settings To specify the log file settings: 1. From the Device Manager main window, select Setup > System Settings. The System Settings dialog box appears. 2. Click the Log File tab.
4-46
Kronos Incorporated
System Settings
3. Specify the maximum log file rollover size in KB that is reached before the next log file is created. The minimum supported value is 500. The default count is 500. The maximum supported value is 20000. During data collection, log files receive data collection and application response information. These files are located in the \DCM\Data\logs\computer name directory. When a log file reaches the maximum size or beyond the maximum size within a given range, the existing file is renamed to the next available slot in the file names. For example, logname.log becomes logname_#.log. The new log becomes logname.log. When the new log file reaches the maximum size, it is renamed to the next available slot in the file names. For example, logname.log becomes logname_2.log. The new log becomes logname.log.
4-47
Chapter 4
This continues until logname_10.log is created. When the new logname.log reaches maximum size, DCM replaces the oldest log file. The following example shows where the DCM log file is set to a length of 500 KB and the number of rollovers is 10: DCM.log DCM_1.log DCM_2.log DCM_3.log DCM_4.log DCM_5.log DCM_6.log DCM_7.log DCM_8.log DCM_9.log DCM_10.log 300K 502K 501K 502K 502K 500k 500K 501K 502K 500K 501K
4. Specify the maximum number of times the log file can be segmented into new files. The minimum supported value is 0. The default count is 10. The maximum supported value is 50. 5. Optionally, select Log Transactions to include each transaction in the centralized log file. The file size increases rapidly and, therefore, enable Log Transactions only for debug or troubleshooting purposes. 6. Specify the log severity levels for the DCM components that post log error messages to the centralized log file. Error messages that do not apply to a listed DCM component are posted by DCM default. Select each level from the dropdown menus. The default is INFO and is the recommended setting for all.
Device Download Settings

To specify the device download settings: 1. From the Device Manager main window, select Setup > System Settings. The System Settings dialog box appears. 2. Click the Device Download tab.
4-48
Kronos Incorporated
System Settings
3. To delete download files after executing a download procedure, select the Remove download files after device download check box. 4. To activate a download retry option, select the Enable download retry check box. When a load configuration request for an initialization or update fails, the DCM system retries the request. 5. If you selected the Enable download retry check box, specify the number of times DCM retries and the time interval, in minutes, between the retries. The minimum number of retries is 0 and the maximum number of retries is 5. The minimum length of time for another retry is 1 minute and the maximum length of time for another retry is 180 minutes. When the request is successful or the maximum number of retries is reached, the request is removed from the retry queue.
4-49
Chapter 4
6. To specify the length of time to save a download data file, select the Enable reuse of download data files check box and specify the length of time to save the file. The minimum length of time to save the file is zero minutes and the maximum length of time to save the file is 1440 minutes.The default is 15 minutes.
Communication Settings
For Series 4000 terminals, you can specify the Remote Access Service (RAS) system phone book path for dial-up networking and specify direct communication to a specified IP address for a Communication PC that has more than one network interface card (NIC). For more information about the Windows Remote Access Service system phone book, see Chapter 3, Communication Channels. To specify the communication settings: 1. From the Device Manager main window, select Setup > System Settings. The System Settings dialog box appears. 2. Click the Communication tab.
4-50
Kronos Incorporated
System Settings
3. To enable dial-up networking, click the Enable use of phone book path check box and enter the full phone book path. A dial-up entry sets the parameters for all devices assigned to a modem that you configure, and creates an entry in the Windows Remote Access Service system phone book (rasphone.pbk). You must create an entry in the phone book for each modem on the Communication PC. DCM must have the correct path to the phone book or an error occurs. For Windows 2000, DCM uses the following path: \Documents and Settings\All Users\Application Data\Microsoft\Network\Connections\Pbk\rasphone.pbk
4-51
Chapter 4
For Windows NT, DCM uses the following path: \WINNT\system32\ras\rasphone.pbk It is possible for PCs to have multiple RAS phone books. You can locate the phone book by making an entry (see Configuring a Dial-up Entry on Windows 2000 on page 3-12 or Configuring Dial-up Networking on Windows NT on page 3-16), and then searching for rasphone.pbk in Windows Explorer. Verify the date of the file to make sure it matches the date on which you created the entry, and then look in the file to locate the entry that you created. If rasphone.pbk is not located in the default directory, you can enter or edit the entry of the complete path to the RAS system phone book file in the Dial-up Networking section of the System Properties tab. For example, on a Windows 2000 Communication PC, DCM uses the default path: X:\Documents and Settings\All Users\Application Data\Microsoft\Network\Connections\Pbk\rasphone.pbk On one machine however, the RAS System phone book is located in: X:\WINNT\system32\ras\rasphone.pbk 4. For Series 4000 terminals, if your Communication PC has more than one network interface card (NIC), select the Direct communications to specified IP Address check box and specify the IP address of the card to bind for DCM communications. The system defaults to the IP address of the machine that you are using.
Global Values Settings

You can enable file-based communication requests and specify a time frame for totals and accruals. Note: Unlike the other tabs in System Settings, changes to settings on the Global Values tab affect the operation of all DCM Communications PCs, regardless of which DCM Communication PC is running Device Manager when the changes are made.
4-52
Kronos Incorporated
System Settings
File-Based Communication Requests Certain DCM device communication functions require access to files that were created externally from DCM or to create files that will be viewed by the user or used by applications other than DCM. These access requests are called file-based communication requests. DCM supports the following file-based communication requests:
w
Load FirmwareFirmware is the software that resides in a device. For more information about loading device firmware, see Upgrading the Firmware in Series 4000 Terminals on page 11-3. Load Parameter FileYou can modify the configuration of a device using a parameter file of host interface commands and other device commands. For more information about loading a parameter file, see Re-initializing after Performing a Softload on page 11-8. Extract Device ParametersThe Extract Parameter File function saves the configuration from a device to a parameter file. This function enables you to upgrade the DCM system and to save your custom device configuration. DCM does not support extracting parameters from Datakeeper, handheld, or Series 4000 terminals. For more information about the Extract Parameter File function, see Extracting a Parameter File on page 11-10. Get Device ReportA device report lists a Series 4000 terminals hardware properties. For more information about device reports, see Series 4000 Terminal Device Report on page 11-16.
By default, DCM looks for or creates these files on the DCM Communications PC that is processing the communications request. If your installation has more than one Communications PC and you want to initiate a file-based communication request from one PC that will take place on another PC, you must enable the use of file-based requests across Communication PCs and specify a shared network folder that all DCM Communication PCs can use for all file-based communication requests. Use the following steps: 1. From the Device Manager main window, select Setup > System Settings. The System Settings dialog box appears. 2. Click the Global Values tab.
4-53
Chapter 4
3. Select the Enable use of file-based requests across Communication PCs check box. Note: When you select the Enable use of file-based requests across Communication PCs check box, DCM looks for that network share for any of the file-based requests. If you have an environment where each Communication PC is independent and does not need to support the file requests from one PC to another, do not enable this setting. In this case, each DCM Communication PC uses the local DCM/data directory to store and retrieve these files.
4-54
Kronos Incorporated
System Settings
4. Create a network share folder that is accessible from all Communication PCs. This shared folder does not need to be on one of the Communication PCs. Grant read/write access to all DCM Communication PC users to this share. For example, \\PCNAME\ShareName, where PCNAME is the computer name where the folder is share. ShareName can point to any subdirectory on that PC, such as c:\kronos\dcm\datafiles or c:\dcm\data. Note: Do not use the following special characters in the shared folder name: / * ? < > | : ; Note: To process a file-based communications request with a shared network folder, the user that has logged onto the DCM Communication PCs that either initiate or process the request must be setup with the appropriate access rights to the shared folder by your network administrator. 5. Specify the computer name where the shared folder is stored. 6. Specify the file name of the shared folder. When you select the Load Firmware, Load Parameter File, Extract Parameter File, or Get Device Report request, DCM validates the existence of this shared folder on the network if the file-based request across Communication PCs is enabled. If the shared folder is available:
w w
That location is used to copy Load Parameter File and Load Firmware file requests. That location is used to post the result files for Extract Parameter and Get Device Report requests.
If the shared folder is not available or the user logged on to the DCM Communication PC does not have appropriate access rights to the folder, an error message appears.
4-55
Chapter 4
Timeframe for Totals and Accruals To specify when totals and accruals are compiled: 1. From the Device Manager main window, select Setup > System Settings. The System Settings dialog box appears. 2. Click the Global Values tab. 3. Select either Current Pay Period or As of Today for the timeframe for totals and accruals. Current Pay Period specifies from the beginning of the current pay period until the end of the current pay period and the accrued amount until the end of the current pay period As of Today specifies from the beginning of the pay period until today and the accrued amount until today. For more information about totals and accruals, see Chapter 7, Totals and Accruals.
E-Mail Notification
You can specify that notifications about system errors or device errors are sent to selected e-mail recipients. The Sentinel Service captures information about a DCM services failure, such as a communication channel is not running and sends a system error e-mail message. The communication channels capture information about a device error, such as a device status or a communication activity failure and sends a device error e-mail message. System error notifications are sent in the following monitoring conditions:
w w w w w w
Error in launching a DCM application Error in launching a DCM communication channel Error in launching a DCM application client Error in validating a database connection Disk space is below the 50MB minimum level, which shuts down DCM applications Application is being shut down due to critical error
4-56
Kronos Incorporated
System Settings
Device error notifications are sent in the following conditions:

w w
DCM cannot establish communications with the device when the device is in offline mode DCM can communicate with the device but the device returned an error
The system error notification message includes the PC data and time of the failure, the Communication PC name, and a general message about the failure. You can enable notifications for system errors, device errors, or both, and specify how often DCM should check for errors and send notifications. Like all other System Settings except those on the Global tab, settings on the E-mail tab apply only to the DCM Communications PC that is running Device Manager when the changes are made. To enable or change E-mail notification settings on multiple DCM Communication PCs, you must run Device Manager on each PC and make the appropriate changes. Each DCM Communication PC will send its own e-mail notification, and the PC's name will be included. To specify e-mail notification: 1. From the Device Manager main window, select Setup > System Settings. The System Settings dialog box appears. 2. Click the E-mail tab.
4-57
Chapter 4
3. Select the Enable E-mail Notification check box to enable notification. 4. Enter the URL for your Simple Mail Transfer Protocol (SMTP) server. SMTP protocol is used to send e-mail messages between mail clients and mail servers. For example, mycompanymail.com. The SMTP server port defaults to port 25. The SMTP server timeout defaults to 120 seconds. 5. Specify the e-mail address of each recipient for DCM e-mail notification. Separate each recipient name with a semicolon. 6. Specify the e-mail sender name that is to appear as the sender of the e-mail notification. Separate each recipient name with a semi-colon.
4-58
Kronos Incorporated
System Settings
7. Specify the time interval that DCM checks for error and status messages to be sent by e-mail. Specify the interval in hours and minutes The minimum length of time to check for e-mail is five minutes (00:05) and the maximum length of time to check for e-mail is twenty-four hours (24:00). The default is 1 hour Each time DCM checks for error conditions, it sends notification if errors exist, even if the error existed the last time DCM sent an error notification. For this reason, you should set the notification interval such that the recipients are not sent notifications faster than they can respond to them, but often enough that errors are detected and corrected quickly. 8. To specify the type of e-mail notification to be sent, select System Error Notification or Device Error Notification or both. 9. To test your e-mail notification setup, click Test E-Mail. A test e-mail is sent to all recipients. 10. Click Defaults to clear all check boxes and all text boxes. Note: If you disable the Sentinel Service, e-mail notification is also disabled.
WFC Connection
The application server that was named during installation connects DCM to the Workforce Timekeeper application and is used for authentication. You can define additional server connections to improve data processing performance. Multiple connections are helpful at times of peak loads of data transactions if your system performs collect events by using the Communication Monitor or Event Manager. You can define up to three connections from one DCM application connection. DCM can send collected add and edit punches more efficiently to the application database.
4-59
Chapter 4
You can define:

w
Multiple connections to one serverIf you have one powerful application server and are processing thousands of punches in collect events, you can somewhat increase the throughput from the DCM client PC to the application server. Multiple connections to multiple Workforce Timekeeper serversThis is the most efficient method.
Both methods are limited by the throughput capacity of the database. To define multiple server connections: 1. From the Device Manager main window, select Setup > System Settings. The System Settings dialog box appears. 2. Click the WFC Connection tab.
4-60
Kronos Incorporated
System Settings
3. The Default connection to WTK Application Server defaults to the application server to which your Communication PC is connected. If your Workforce Central installation includes Workforce Activities, enter the name of the application server or its IP address, not the full URL, in the Default connection to WFA Application Server text box. For example, mycomputer and 158.228.20.10 are valid server names, while http://mycomputer/ wfc/xmlservice is not a valid server name. The maximum number of characters for either a server name or IP address is 15. 4. Select https or http as the protocol type. 5. To add additional WTK application server connections to your Communication PC, click Add. This is optional. 6. Enter the name of the application server or its IP address, not the full URL, in the Server name or IP Address text box. For example, mycomputer and 158.228.20.10 are valid server names, while http://mycomputer/wfc/ xmlservice is not a valid server name. The maximum number of characters for either a server name or IP address is 15. This remote server enables you to transfer groups of simple punches from devices. You can enter the same server that you used for installation, or a different server. If you enter the same server, a second connection for that server is added for the same DCM application connection.
Caution: The protocol that you select, http or https, must match the protocol used by the application server and be consistent with other protocol selections made for that application server.
7. Select https or http as the protocol type. 8. Click OK. 9. Click Add again to add another WTK application server connection. 10. Click OK. The entire URL that defines your Web server appears in the Server Connections list box. To change the name of a WTK application server connection, select it and click Edit. You can change the server name or IP address or the protocol. When finished, click OK.
4-61
Chapter 4
To remove a WTK application server connection, select it and click Delete. To define multiple connections to application servers on another Communication PC, repeat this procedure from that PC.
Whats Next?
After the communication channels, device groups and devices are created, and devices are assigned to device groups, configure the devices. Device configuration is described in Chapter 5, Configuring Devices.
4-62
Kronos Incorporated
Chapter 5
Configuring Devices
This chapter explains how to configure devices. It also includes information about testing and viewing the device configuration. This chapter contains the following sections:
w w w
Configuring Device Parameters Loading Basic Configuration Parameters to a Device Viewing and Enabling Devices
Chapter 5
Configuring Devices
Configuring Device Parameters

You can configure device parameters, such as badge information, labor levels, and job transfer commands by using tabs in the Configuration Options dialog box.This section describes the tabs in the Configuration Options dialog box. The descriptions of the Configuration Options tabs begins on page 5-6. The tabs are described in alphabetical order. The tabs that are available are determined by the device selected. For example, when configuring a Series 4000 terminal, no AFT tab is available. To access the Configuration Options, use the Device Manager and select a device to configure and select Device > Configuration. The Configuration Options dialog box appears. (The following example is specific to a Series 4000 terminal.)
5-2
Kronos Incorporated
You can also access the Configuration Options dialog box when you create or edit a device in the Setup > Devices procedure. For more information about creating or editing a device, see Adding Devices on page 4-13. On each Configuration Options tab, you can:
w
Click Restore to refresh the window to the default settings before you made any unsaved changes. After clicking OK, the dialog box closes and the next Restore uses the current settings. Click Apply to save changes you make on a tab before you move to another tab. Click OK to apply all changes that you made on all the tabs. Click Help for detailed information.
w w w
After you configure a device for the first time, use the Initialize command to download the configuration information to the device. After the device is initialized, use the Event Manager or the Update command to download changes to the device. The Update command loads employee information from the host application that has changed since the last update. For more information about the Event Manager, see Chapter 9, Collecting Data and Managing Transactions.
Initialization
The Initialization process sends configuration parameters to a device. The configuration includes operating parameters, biometric data, and employee, job, and labor data. Initializing a Series 400 device clears any information from the device and downloads the new information. Series 4000 terminals retain all employee information during all initialization unless the Clear all employee information download option is selected. Clear All Employee information does not delete employee punches from devices.
5-3
Chapter 5
Configuring Devices
Caution: When you initialize a Series 400 device with download options that include Device Configuration, all information about home employees is erased from the device. This includes the current punch in or out status of each employee. Therefore, be very careful about performing an initialize to a Series 400 device. It is recommended that you do not select Device Configuration as one of the default download options. The default download options are used by many Event Manager events and can result in employee information being deleted.
If you edit a configuration or add a new device, you must load the configuration to the particular device by initializing with the Device Configuration Download Option selected. Home Employee configuration and status information at a Series 400 device, including punch in/out status, is erased when device configuration is sent to a Series 400 device. Therefore, if you are using home employees at Series 400 devices, do not use Device Configuration as an option for downloads when you initialize unless you are initializing a new device that contains no employee information or when no employees are working. You should also make sure that all home employee information required at the device, such as employees, schedules, and totals, is sent as part of an initialization that includes Device Configuration. Initializing without Device Configuration leaves existing employee lists intact. If you need to send Device Configuration to a Series 400 device, always select one or more employee list download options as well. If you are using schedules, select the download options Employee list with schedules. If you are using totals, select Employee totals when you initialize. If you use schedules at devices, initialize only at times when employees are not expected to be working a shift. If you initialize during a shift when employees are working, their in/out statuses at the devices are erased and they may not be able to punch out properly.
Caution: Series 400 serial devices cannot complete initialization with download
options that contain non-English characters.
5-4
Kronos Incorporated
The devices displayed on the hierarchical tree turn yellow to indicate that the request is submitted. The devices return to green after the actual devices respond. At the same time, the Status window in the Device Manager main window reflects the loading of the configuration to the specified devices. For more information about initializing a configuration, see Loading Basic Configuration Parameters to a Device on page 5-49.
Update
The Update process sends new information to a device. An initialized device should be updated regularly to reflect changes made to the host application that must be current at the device. The Update command changes in information, such as new employee data, changes to employee schedules, and any changes to the employee records, labor entry lists, or components of the organizational map. The command retains any existing information from the DCM or the host application database. Update loads employee information from the host application that has changed since the last update. Update does not load device configurations.
Caution: Series 400 serial devices cannot complete an update that contains nonEnglish characters. Note: The date and time for DCM Communication PC, devices, and database should be synchronized. If the database server time is behind the Communication PC time, when biometric data is deleted using the Workforce Timekeeper People Editor, it may or may not be deleted from the terminal when a device update is performed. Also, Employee badge data may not be updated immediately when a device update is performed.
5-5
Chapter 5
Configuring Devices
AFT Commands Tab

Use the AFT Commands tab to enter one or more AFT commands that are not supported by the Device Manager. Note: AFT commands are for use with Series 400 devices only.
AFT commands are based on the Arbiter File Transfer (AFT) program. This is a set of communication standards that enable communication between devices and PCs. Use AFT instead of the devices keypad commands to enter values for device procedures on this tab.
5-6
Kronos Incorporated
Caution: This tab enables you to enter potentially risky commands; for example,
setting time and date, or deleting FIFO records. The AFT Commands tab is freeformthere is no format checking or range validation of the entered commands. The commands do not have to include the leading and trailing forward slash delimiters; these are automatically added as necessary when the configuration is loaded to the device. Note: To add a new line in an AFT File, use the Control and Enter key combination, not just the Enter key. For more information about AFT commands, see the 400 Series Terminal Configuration Guide.
5-7
Chapter 5
Configuring Devices
Badge Reader Tab

Use the Badge Reader tab to specify the types of badges that the reader accepts, the badge parameters, and what bar code symbologies the reader recognizes. Depending on the type of badge used, specify bar code, magnetic card reader, or proximity card parameters. You can also enter a location code, which is encoded on all badges. The features that are visible and enabled are specific to the device that you are configuring.
Note: Proximity card reader configuration requires knowledge of parity schemes and proxy formats. Consult with your badge vendor for configuration information.
5-8
Kronos Incorporated
Reader Configuration If you are configuring a bar code reader, click Bar code symbologies and select which symbologies to accept for all the bar code readers attached to the device. Although the Series 4000 terminal can support two remote readers, use a single set of configuration settings that applies to both remote readers, if installed. If you are configuring a magnetic stripe reader, click Magnetic stripe tracks and select which track to accept. If you are configuring a proximity reader, click Proximity formats and specify the Proximity card format. If you are configuring a proximity badge:
w w
The maximum number of data bits allowed for the proximity badge code is 32. The Series 4000 terminal can accept up to five Proximity Badge formats. If more than five Proximity Badge formats are assigned to a device, only the first five assigned are downloaded to the device at the time of device initialization. For Series 4000 terminals, the DCM configuration service sends the bar code formats for labor badges even when proximity badges are enabled for employee, supervisor, or maintenance badges. If the proximity card reader is enabled, you cannot configure the bar code reader. If you need to change the default bar code reader configuration, select Standard and generic as the Badge type in the Employee Badges box, and edit the Badge format.
Local Reader Display If you are configuring a Series 400 device, you can:
w w w w
Select the Beep for badge acceptance check box if you want the device to generate an audible beep when an employee swipes a badge. Select the Display badge read errors check box if you want the device to display an error when the badge reader rejects a badge. Select the Enable megabeeper check box if you want the device to accept badge swipes using the megabeeper option. Select the Enable remote indicator check box if you want the device to accept badge swipes using the remote indicator lights option.
5-9
Chapter 5
Configuring Devices
Badge Type Specification and Configuration Select the badge type:

w
None specifies that an employee enters a number on the device keypad to punch in, to punch out, or to perform a labor transfer, instead of swiping a badge. A Personal Identification Number (PIN) is usually an employees badge number. Standard allows an employee to punch by swiping a standard-format badge. If you select a Standard badge type, you can also enter the Badge location code. The location code can be 0, 1, or 2 uppercase letters. For example, BB. The default is 2 spaces, which you can leave if you do not want to use the company code. If you do specify a location code, be sure that the same location code value is encoded on all badges that are used at the device. To specify a code, double-click the text box to highlight the spaces and enter the company location code.
Standard and generic allows an employee to punch by using either a standard or a generic badge. A generic badge is any badge that uses a bar code that is not in the standard badge format. You can set up the terminal to read badges that differ from the standard badges.
You can use generic badges to differentiate between in-punches and out-punches and labor transfer entries. If you specify generic badges, you must also specify the badge format, by clicking Edit format on the Badge Reader tab dialog box. The badge specifies the current format for a generic badge. For example, xxxDDDDDDDDii defines a 13-character generic badge with an 8-digit data field that the reader detects by ignoring the last 2 characters. If you edit the generic badge format:
w
Either click the Allow any length generic badge check box, or clear the check box and specify the total number of numeric characters, which can be from zero to 32 numeric characters. Do not specify a badge length of 17 or 18 numeric characters because these lengths are reserved for standard badges.
5-10
Kronos Incorporated
Specify the number of numeric characters in the data field, which represents the ID number. For employee badges, the data field is the employee identification number. The terminal recognizes employee ID numbers in the range of zero to 9 digits. Specify the location of the data field by defining the number of trailing digits in a generic badge for the read to ignore, starting from the right, in the Characters to ignore text box. You can enter a value from zero to 30. For employee badges, the data field is the employee identification number. For labor account transfer badges, the data field is the labor account. For labor level transfer badges, the data field is the labor level. Note: The sum of the value in the Number of characters in data field and the Characters to ignore (from right) cannot exceed the value in the Total characters on badge text box. For example, if the total characters on a badge is 20, the sum of the Characters to ignore text box and the Number of characters in data field text box cannot exceed 20. Click Test to verify entries in the Generic Badge dialog box. If the entries are valid, the format appears in the Badge Format text box. If the entries are invalid, an error message appears in the Badge Format text box.
For more information about Badge Reader tab options, click Help. When you download the badge reader configuration to a device, the following settings are included in the download operation:
w w w w w
Bar code, magnetic stripe, and proximity formats for all maintenance badges are sent. Bar code, magnetic stripe, and proximity formats for all supervisor badges are sent. Bar code and magnetic stripe formats for standard employee badges are sent if standard employee badges are enabled on the Badge Reader tab. Bar code and magnetic stripe formats for generic employee badges are sent if generic employee badges are enabled on the Badge Reader tab. Bar code and magnetic stripe formats for labor badges are sent for standard or generic labor badges if they are enabled on the Labor Transfer tab.
5-11
Chapter 5
Configuring Devices
w w
Bar code and magnetic stripe formats are sent for standard or generic job badges if they are enabled on the Job Transfer tab. Proximity formats for employee badges are sent for each proximity badge that is defined and assigned on the Proximity Card Format Configuration dialog box. Proximity badges support only maintenance, supervisor, and employee badges. They do not support labor or job badges.
Because maintenance and supervisor functions require access to the Series 4000 terminals keypad and display, remote readers do not accept maintenance or supervisor badges.
5-12
Kronos Incorporated
Bell Schedules Tab

After a bell schedule is created, you can use the Bell Schedules tab to assign a bell schedule to a Series 4000 terminal. For more information about creating a bell schedule, see Bell Schedules on page 4-30. You can also configure a function key to enable a Supervisor to display a bell schedule, ring a bell, or silence a bell. For more information about assigning functions to device keys, see Function Key Tab on page 5-30.
Note: Series 4000 terminals can support either an attached Gate or an attached Bell, but not both. You can assign a maximum of 48 bell schedules to each device.
5-13
Chapter 5
Configuring Devices
To assign or unassign a bell schedule to a device: 1. Select the Enable bell schedules check box. The available bell schedules appear. 2. To assign a bell schedule to the device, highlight the bell schedule in the Available schedules list and click Add. 3. To unassign a bell schedule from a device, highlight the bell schedules in the Assigned schedules list, and click Remove. After you enable or disable a bell schedule, or change assignments, re-initialize the device configuration.
5-14
Kronos Incorporated
Default Transactions Tab

For Series 4000 terminals, use the Default Transaction tab to configure the default transaction that is performed when an employee swipes a badge or enters a PIN to perform a function other than punch an employee in or out under specified conditions. You can assign the default transaction entered by home and by nonhome employees. If the default transaction for a home employee's entry is a Punch, you also can assign a different default transaction for a home employee's badge swipe or PIN entry at the start of a shift, at the end of a shift, or during a shift. For example, for a group of home employees who routinely change job assignments when they start a shift, you can set the default assignment for a badge swipe to start a shift to Job Transfer. In addition to defining different default transactions for home and non-home employees, you can also specify different default transactions when an employee uses the badge reader or keypad at the Series 4000 terminals that are local readers, or when the employee uses a reader that is mounted remotely from the Series 4000 terminals that called a remote readers. An attached reader such as a bar code wand or scanner that must be used at the Series 4000 terminal is considered to be a local reader. For example, you could configure the default transaction at a remote reader mounted at the entrance of a building as a Gate Entry to open the front door, and the default transaction at the Series 4000 terminal mounted in an employee work area inside the building to punch the employee in or out. If you are configuring a Series 400 device, select the Perform function key activity on out-punch check box on the Function Key tab to assign out punch processing transaction to the device. For more information about the Function Key tab, see Function Key Tab on page 5-30.
5-15
Chapter 5
Configuring Devices
The five default reader transactions are:

w
Home employee defaultPerforms a specific transaction after a home employee swipes a badge. The assigned default transaction is performed instead of a punch. For example, if the Home employee default for remote readers is assigned to open a gate, the swipe opens the gate without clocking the employee in or out. You can assign any transaction that can be assigned to a soft key.
5-16
Kronos Incorporated
If the transaction assigned to this default is anything other than Punch, the assignments of the other three Home employee default transactions (shift start, in during shift, and shift end become unavailable, that is, you cannot assign default transactions to the Home employee shift start, IN during shift, or shift end selections. You must assign the Punch function to another soft key by using the Function Key tab and home employees must use this soft key to punch in or out.
w
Home employee shift startPerforms a specified transaction after a home employee swipes a badge that is interpreted by the Series 4000 terminal as an IN punch to start a shift. This setting is available only if the Home employee default is set to Punch. If the specified transaction does not affect the punch status of the employee, the terminal produces a record for the punch and then performs the specified transaction. If the specified transaction does affect the punch status of the employee, the terminal does not produce a FIFO record for the punch but does produce a FIFO record for the specified transaction. For example, if the Home employee default is set to Punch and the Home employee shift start is set to a Labor transfer, the Series 4000 terminal records a labor transfer transaction record when the employee punch starts a shift. If the Home employee default is set to Punch and the Home employee shift start is set to a View current schedule, the Series 4000 terminal records a punch transaction record and then shows the employee's current schedule when the employee punch starts a shift.
Home employee IN during shiftPerforms a specified transaction after a home employee swipes a badge (performs a punch) that is interpreted by the Series 4000 terminal as an IN punch during a shift, such as a return from a break or a meal. This setting is available only if the Home employee default is set to Punch. The Series 400 generates transaction records in the same manner described for the Home employee shift start. Home employee shift endPerforms a specified transaction after a home employee swipes a badge that is interpreted by the Series 4000 terminal as an OUT punch that ends a shift. This setting is available only if the Home employee default is set to Punch. You can assign only transactions that do not affect the employee's IN/Out status, such as View Schedules or Enter Tips.
5-17
Chapter 5
Configuring Devices
Non-home employee defaultPerforms a specific transaction after a nonhome employees swipe a badge or enters their employee badge number. The assigned transaction is always performed. If you select a Non-home employee default transaction other than Punch, and you want non-home employees to be able punch in and out, you must assign a Punch function to a soft key by using the Function Key tab and non-home employees must press this soft key to punch in or out.
Assigning a Default Transaction To assign a default transaction from a Punch to another transaction: 1. Highlight the transaction and click Assign. The Assign Function dialog box appears. You cannot assign a supervisor command function. If the Home employee default is assigned a default transaction other than Punch, all other Home employee selections are unavailable. 2. Select a function from the Function List. For some selections, such as a Labor Transfer, you may enter more details by clicking Details. Details dialog boxes vary according to the function selected. For example, if you selected Delayed Labor Transfer, the Job Transfers dialog box includes a Prompt for job check box. When you have finished, click OK twice. Disabling an Employee Default Transaction Assignment To assign no transaction for a Home or Non-home employee default so that all swipes at the terminal or remote reader are ignored, select either Home employee default or Non-home employee default for the local reader., or remote reader, or both and click Delete. For local readers, employees will be required to press a soft key on order to perform a transaction. For remote readers, employees cannot perform any transactions.
5-18
Kronos Incorporated
Changing a Default Reader Transaction to Punch To change a Home employee default or Non-home employee default assignment other to a Punch assignment, highlight the transaction, click Assign, select Punch, and click OK. To change a Home employee shift start, Home employee IN during shift, or Home employee shift end default transaction assignment from a transaction assignment other than a Punch assignment to a Punch assignment, highlight the transaction, click Delete. To change all default transactions back to Punch, click Restore.
5-19
Chapter 5
Configuring Devices
Display Tab
Use the Display tab to control how information appears on the device screen. You can enter a device message, enable a beep for keypad entries, specify date and time formats, and define the length of time to list employee identification text and to display transaction responses.
To specify the changing message durations, in the General area: 1. In the Error message duration text box, enter the length of time that an error message appears.Valid values are 1 through 255 in tenths of a second. The default is 1.
5-20
Kronos Incorporated
2. In the Transaction response duration text box, enter the length of time that a confirmation message of success or failure appears. The message usually includes the employees name or badge number. Valid values are 1 through 1200 in tenths of a second. The default is 6. 3. In the Non-employee timeout text box, enter the length of time that the device remains in supervisor or maintenance mode without any activity before the device returns to employee mode. Valid values are 5 through 150 in seconds and in 5s increments. The default value is 45. 4. In the Data display duration text box, enter the length of time that an informational message appears. These messages are the result of a view transaction, such as View Current Schedule or Review Punches and require the employee additional time to read, and possibly scroll, what appears on the Series 4000 terminal. The valid values are 1 through 25 in seconds. The default value for Series 4000 terminals is 5. The default value for all other devices is 1. To specify the device message displays and their durations, in the Message area: 1. In the Device text box, enter a message that consists of 20 characters or fewer for Series 400 devices and 40 characters or fewer for Series 4000 terminals. 2. In the Duration text box, enter the length of time that the message appears. The valid values are 1 through 255 in seconds. The default value is 13. 3. In the Alternate text box, enter an alternate message that appears alternately with the first message. The alternate message can be 40 characters or fewer. 4. In the Alt Duration text box, enter the length of time that the alternate message appears. The valid display duration for an alternate message is from 1 to 25 seconds. If the first or alternate is blank, the remaining message appears constantly and ignores the length of time specified for the blank message. To set the format for the date that appears on the device: 1. Select the day, month, and year order from the Format drop-down list. 2. Select the symbol that is to be used to separate the day, month, and year from the Delimiter drop-down list. 3. Select to display the year in either a 2-digit year or a four-digit year.
5-21
Chapter 5
Configuring Devices
To set the format for the time that appears on the device: 1. Select the symbol that is to be used to separate the day, month, and year from the Delimiter drop-down list. 2. Select to display the time either 12-hour format or 24-hour format. The 12hour format displays the hours and minutes and either AM or PM. The 24hour format displays the hours and minutes.
5-22
Kronos Incorporated
Employee Tab
Use the Employee tab to specify when an employee punches in and punches out, and the text that appears after a punch. You also select a method that the device uses to calculate an employee's next in-punch when an out-punch is omitted. The features that are visible and enabled are specific (based on the options you selected on a given tab) to the device that you configure.
Use the Employee tab to:

w w
Specify whether to display the employees name or badge when an employee punches in or out. Specify whether to use restriction profiles or schedule shifts to calculate an employee's next in-punch when an out-punch is omitted.
5-23
Chapter 5
Configuring Devices
Specify whether or not home employees can punch only during their regularly scheduled hours. If you do not select this feature, home employees can punch at any time. Specify the number of individual schedules that the device makes available for each home employee. Enter a value from 0 to 14. The default value is 3. Specify the number of days ahead that the device is to use when determining the future schedules to display.
w w
For more information about the Employee tab, see the online Help.
5-24
Kronos Incorporated
FIFO Tab
FIFO (first-in, first-out) is the data storage buffer in the devices random access memory (RAM). The FIFO contains a consecutive list of records of events that take place at the device. Use the FIFO tab to specify the number of hours that certain function keys that are assigned employee and supervisor functions look into the past for data. Setting the FIFO scan interval properly helps to avoid use of older, obsolete data.
When configuring a Series 4000 terminal, you can use the FIFO tab to set the Scan Interval for Reviewing Punches (in hours). The scan interval defines the number of hours that certain function key functions look into the past for data. Setting the FIFO scan interval properly helps to avoid use of older, obsolete data. Valid settings are 0-72 hours. The default setting is 12.
5-25
Chapter 5
Configuring Devices
When configuring a Series 400 device, you can use the FIFO tab to set the following options:
w
Scan Interval for Reviewing Punches (in hours)The scan interval defines the number of hours that certain function key functions look into the past for data. Setting the FIFO scan interval properly helps to avoid use of older, obsolete data. Valid settings are 0-72 hours. The default setting is 12. Scan Interval Offset (in hours)The scan interval offset enables you to offset the scan interval so that it matches times for reviewing your standard 8hour shifts. By default, the FIFO scan interval measures time in terms of three 8-hour shifts beginning at midnight (midnight to 8:00 A.M., 8:00 A.M. to 4:00 P.M., 4:00 P.M. to midnight). However, if your first daily shifts begin at a time other than midnight, for example, 2:00 A.M., you can offset the FIFO scan interval by 2 hours so that the scan interval begins at 2:00 A.M. instead of at midnight. The ability to offset the FIFO scan interval enables the device to scan data in terms of the employees shifts. Entering a value of 0 results in no offset of the FIFO scan interval. Valid settings are 0-7 hours. The default setting is 0.
5-26
Kronos Incorporated
Free Form XML Tab

You can send XML files to specify additional Series 4000 terminal configurations that are not supported by the Device Manager. Although you can use the Load Parameter File command and event to load XML configuration commands, the configuration commands in that XML file may be deleted whenever DCM initializes with Device Configuration selected as one of the download options. The Free Form XML tab enables you to send XML configuration commands every time Device Configuration is sent, so that configuration settings are automatically maintained through all initializations without deletion each time that DCM performs an initialization. Use the Free Form XML tab to enter one or more XML file names that specify the additional configuration settings. These files are sent after device configuration set in DCM Device Manager is sent and may overwrite some device settings depending on the XML commands included in the file. If you specify multiple XML files, they are sent in the order listed in the Free Form XML tab. Enter one file name for each feature to activate or deactivate. Entries in this tab take precedence over configuration settings in other areas of the Configuration Options dialog box. Be sure that each XML file contains properly formed XML and only one verbobject pair. If the file does not exist or has a length of zero, or exceeds the maximum allowable size of 32K, it is not downloaded and the initialization is canceled. Note: Use this tab only if you are an advanced user and are certain that the XML files specified result in the desired behavior of the Series 4000 terminal.
5-27
Chapter 5
Configuring Devices
To add XML files to the DCM initialization process: 1. If no file names are listed, click either Add Before or Add After. The Select XML File Name to Add Before Selection in List dialog box appears. DCM defaults to the DCM data directory. You may browse to other directories. 2. The file name that you select must have an .xml extension. Select the file name to add to the end of initializations and click Open. The file name appears in the Free Form XML dialog box. The maximum file size for the file is 32K. You may add up to 20 free form XML files. You cannot add duplicate files. 3. To add additional file names, click either Add Before or Add After.
5-28
Kronos Incorporated
4. The files are processed in the order in which they are listed. To move a file name up or down in your list, select the file name and click Move Up or Move Down. 5. To remove a file from the list, select the file and click Remove.
5-29
Chapter 5
Configuring Devices
Function Key Tab

A function key is a programmable button on a device that allows employees and supervisors to perform functions quickly. Each key has the following settings:
w w w
Unassigned Assigning a function to a function key for use by all employees, including supervisors Assigning a command to a function key for use by supervisors only
The function keys are called soft keys on a Series 4000 terminal. Use the Function Key tab to assign tasks to the function keys. Examples of function key assignments include canceling an automatic meal deduction, labor account transfer, start and stop an activity, view totals, and enter tips. You can assign tasks to function keys for employee and supervisor use, or only for supervisor use. The options that are available are determined by the model of the device selected. Supervisor Function Key Command A supervisor function key command is a function available only to supervisors while the device operates in supervisor mode. After you assign a supervisor command to a function key and download the information to the device, a supervisor can perform the function by entering supervisor mode and pressing the associated function key on the device. Employee Function Key Task An employee function key task is available to employees and supervisors while the device operates in employee mode, for example, Cancel Meal Deduction. After you assign an employee task to a function key and download the information to the device, an employee or a supervisor can perform the task by pressing the associated function key on the device.
5-30
Kronos Incorporated
Note: If you configure a function key with a function or transaction that includes a pay code, activity code, comment code, or total, be sure to select the corresponding item in the Download options and initialize the device. Otherwise, validation of the entered code fails because the corresponding validation list does not exist in the device and the assignments are not allowed. If this validation fails, the user cannot complete the function or transaction.
5-31
Chapter 5
Configuring Devices
To assign tasks to a function key: 1. Expand the function key and highlight either No function assigned, which is applied to a function key that all employees use, or highlight No supervisor command assigned, which is applied to a function key assignment that only supervisors can use. Series 4000 terminals support up to 28 function key assignments. All other devices support up to 12 function key assignments. 2. Click Assign and the Assign Function window opens. When configuring a Series 400 device, if you selected No function assigned for all employees and want to assign this function to supervisors only, select the Supervisors only check box. You cannot assign a function as both Supervisor only and Supervisor commands. 3. Select the task that you want to assign to the function key. Not all tasks are applicable to the application in which the device is connected. Some tasks enable you to define which actions can be performed at the device for the task selected. If you want the display at the Series 4000 terminal to be other than the default command list label, specify the display text in the Function key label text box. Series 4000 terminals support up to 40 characters that line wrap. All other devices support up to 20 characters without line wrap. 4. For some selections, such as Activity selections, you may need to enter more details by clicking Details. Details dialog boxes vary according to the function selected. For example, if you selected Start Activity, the Details dialog box includes a Must prompt user for Labor Account check box. If no default values are assigned for any labor levels, the check box is active and you can either select it or clear it. If one or more default values are assigned for which Allow override check box was selected, the Must prompt user for Labor Account check box is selected and unavailable. If all the usable labor levels have Allow override not selected, you cannot change any labor values and the Must prompt user for Labor Account check box cleared and unavailable. When you finish, click OK.
5-32
Kronos Incorporated
After you click Details, the Function Key Settings that may appear are Activity Codes, Labor Levels, Job Transfers, and Comment Codes. For more information about labor levels, see Chapter 6, Setting Up Labor Level Information. For more information about job transfers, see Job Transfer Tab on page 5-40. For more information about totals definitions (pay codes or accrual codes), see Chapter 7, Totals and Accruals. For more information about activity codes and comments codes, and assigning pay code edits to a function key, see Chapter 8, Activity Codes, Comment Codes, and Pay Code Edits. For more information about the Function Key tab and all available options, press Help. 5. Click OK in the Assign Function dialog box. Note: The functions that are available are specific to the device being configured. For example, the Series 4000 terminal soft keys can be assigned Pay Code Hours Edit and Pay Code Money Edit in Employee mode, and Pay Code Hours Adjustment and Pay Code Hours Edit in Supervisor mode. 6. If available, you can select the Perform function key activity on out-punch check box to enable employees to perform a function key task when they punch out from a shift. When you select this check box, the Function key mapping list displays the Out Punch selection for function key task assignments. 7. If available, you can select the Display function key text for labor transfers check box to display the text assigned to a function key when the employee presses that function key to perform a labor transfer. 8. If available, you can select the Always require soft key press check box to require employees to press a soft key before swiping their badge or entering a PIN to initiate a transaction. 9. If available, you can select the Tips and function keys only to enable employees check box to perform tip and function key entries only. When you select this check box, the device does not accept simple punches, such as inpunches and out-punches, but labor account transfers are still available.
5-33
Chapter 5
Configuring Devices
10. Optionally, select the Allow negative tips check box to enable employees to enter negative decimal tips. 11. If available, you can select the Enable tips shortcut keys check box to enable employees to use the + (plus) and - (minus) keys to enter tips. 12. To add, delete, or edit totals for Totals configuration, click Configure Totals. For more information about Totals, see Chapter 7, Totals and Accruals. For more information about the Function Key tab options, click Help.
5-34
Kronos Incorporated
Gate Entry Tab

Use the Gate Entry tab to set up the device to manage employee entry. You can use the terminal to unlock devices with an attached universal contact relay that electrically opens the device, such as a door, turnstile, or swing gate. A universal relay kit enables a Series 4000 terminal to control another AC/DC device when someone swipes a badge at the terminal or at a remote reader that is attached to the terminal. Note: You can configure a Series 4000 terminal to activate a bell or a gate, but not both.
5-35
Chapter 5
Configuring Devices
To specify a gate entry setting in response to a swipe of a valid employee badge on a Series 4000 terminal: 1. Enable gate support if the device supports gate entry by selecting the Enable gate support check box. 2. Specify the number of minutes until the gate locks for a repeat of the previous badge swipe without executing a punch. For example, if an employee swipes a badge and the gate unlocks but the employee does not open the gate before the gate returns to the lock position, the employee must swipe the badge again. To prevent another punch execution, specify the number of minutes that the gate accepts a swipe to open the gate and without another punch execution in the Gate passback interval text box. The minimum value is 0 minutes. The maximum value is 255 minutes. The default is 0 minutes. 3. Specify in seconds the length of time that a gate remains open after access is given and before being considered a break in security in the Gate open duration text box. Allow enough time for employees to swipe their badge and open the corresponding gate. The minimum is 1 second. The maximum value is 30 seconds. The default is 1 second. 4. For Gate validation, specify ether Employee badge format, which accepts any badge format, or Home employees only, which accepts home-employee badges only. 5. To enable storage of Gate entry punch transaction records, select or clear any of the following options:
w w w
Specify Entry if the device adds to its memory a record that contains the badge numbers of employees who are granted entry. Specify Violation if the device adds to its memory a record that contains the badge number of an employee who is not granted entry. Specify Override if the device adds to its memory a record that contains the badge number of an employee who are granted access as the result of a supervisor override.
5-36
Kronos Incorporated
Note: Workforce Timekeeper does not support the Gate Entry records and discards the records if they are enabled and collected. DCM places Gate Entry records in a transaction output file if enabled. For more information about transaction output files, see Transaction Output Files on page 9-43 and Setting Up a Transaction Output File for a Device Group on page 9-12.
5-37
Chapter 5
Configuring Devices
Gate Schedules Tab

Use the Gate Schedules tab to make gate schedules available at a Series 4000 terminal. Gate schedules, which control gate entry based on time enforcement rules, are setup specifications. For more information about creating gate schedules, see Gate Schedules on page 4-33. You may assign up to seven gate open schedules and seven gate off schedules to a single Series 4000 terminal. Note: You can configure a Series 4000 terminal to activate a bell or a gate, but not both.
5-38
Kronos Incorporated
To specify gate schedules for a Series 4000 terminal: 1. Enable gate schedules if the device supports gate entry by selecting the Enable gate schedules check box. 2. Highlight the gate open schedules and click Add. You can highlight more than one schedule by holding the Control button while you select the schedules. 3. Highlight the gate off schedules and click Add. You can highlight more than one schedule by holding the Control button while you select the schedules.
5-39
Chapter 5
Configuring Devices
Job Transfer Tab

Use the Job Transfer tab to configure settings pertaining to job transfers at a Series 4000 terminal. These parameters include job badge format (if used), allowing non-home employees to perform job transfers, enabling the use of the Series 4000 keypad to enter job data, and the validation rule for job transfers that are entered by home employees.
DCM retrieves jobs data from Workforce Timekeeper and downloads that data to the terminal. DCM also collects job transfer transactions from the terminal and submits these transactions to the Workforce Timekeeper application.
5-40
Kronos Incorporated
Jobs and Job Sets A job set specifies a collection of jobs. A job transfer set is a type of job set to which an employee can transfer. Jobs, job sets, and job transfer sets are defined by Workforce Timekeeper. Job transfer sets are assigned to employees in WTK or to devices in DCM. The two types of job transfer sets that can be downloaded to a terminal are the device job set and employee job sets. Any job transfer set that is defined in Workforce Timekeeper may be selected to be the device job set. Do this in the Device > Applications Options dialog box in DCM Device Manager. You can specify a different job transfer set as the device job set for each Series 4000 terminal in the system. You can also assign a job transfer set to each employee in Workforce Timekeeper. Each employee may have a different assigned job transfer set, or the same job transfer set may be assigned to multiple employees. You can also use the same job transfer set as the device job set and employee job sets. The job sets that are downloaded to the Series 4000 terminal are determined by the Device > Download Options dialog box. If the Device Job Transfer Set download option is selected, the device job set that you specify on the Application Options dialog box is downloaded. If the Employee Job Transfer Sets download option is selected, all job sets that are assigned to the home employees for the terminal are downloaded. Selecting the device job transfer set downloads only one job transfer set, while selecting employee job transfer sets usually downloads multiple job sets. If no device job set is selected and downloaded to the terminal, only home employees can use the device for job transfers. Note: The job sets that are downloaded to the Series 4000 terminal must correspond to the validation rule for jobs entered by home employees that is specified on the Job Transfer tab. Also, if non-home employees are allowed to perform job transfers, the jobs in the device job set are always used to validate the entered job value. For non-home employees to perform job transfers, the device job set must be downloaded to the Series 4000 terminal.
5-41
Chapter 5
Configuring Devices
Specifying Job Transfer Settings When a Series 4000 terminal function key is assigned a function that can perform a job transfer, you can specify whether or not the employee is prompted for job data and whether or not the employee can override the default job value. Only jobs in the device job set can be assigned as default values to function keys. To specify job transfer settings: 1. To use badges to enter job values, select either Kronos Standard or Generic badge types. If you select generic badges, you must then click Edit Format to define the generic job badge format. 2. Optionally, click to allow a non-home employee to perform a job transfer at the terminal. A non-home employee does not have an associated employee job set at the device, and so the devices uses the Device Job Transfer set to validate nonhome employee job transfers. 3. Click Restrict time on re-punch to restrict employees from performing multiple job transfers with in the re-punch interval specified on the Punch Rules tab. 4. Click Allow keypad entries to allow employees to use the keypad when entering a job value at the terminal, if appropriate. If Allow keypad entries is not enabled, employees must select the appropriate job from a list or use a job transfer badge. 5. Select the validation method to be used at the terminal when home employees perform job transfers. Select Employee job transfer set to restrict home employees transfer to jobs contained in their employee job transfer set. Select Device job transfer set to allow home employees to transfer to any job on the device job transfer set. Select Must be in both employee to restrict home employee transfers to only jobs that are contained in both that employees job transfer set and the device job transfer set assigned to this device. Home employees and non-home employees can perform job transfer to jobs in the device job set.
5-42
Kronos Incorporated
If you selected Employee job transfer set, the jobs entered by home employees is checked for validation. Only home employees can perform job transfers if the employee has an assigned employee job set that is downloaded to the terminal. Job Transfer Function Key Setting After you apply the job transfer configuration and you specify the Device Job Transfer Set in the Download Options function, you can assign a job transfer function key to the terminal. Use the Function Key tab to select a function key, to assign job transfer to the key, and to specify function key settings in the Detail dialog box. For more information about the function key details, see Function Key Tab on page 5-30.
5-43
Chapter 5
Configuring Devices
Labor Levels Tab

Use the Labor Levels tab to specify parameters for labor levels and individual labor fields. These include the badge types (if any) allowed to enter labor levels and fields, the format of the generic badge, and Series 400 default values for #-key or supervisor-initiated labor transfers. The Labor Levels tab that you see depends on the host application that you are using and the device you are configuring. If no Labor Levels were assigned to a device, the configuration elements do not appear and a message informs you that No Labor Levels are available to this device. For more information about select labor level options for a device, see Configuring Labor Transfer Settings on page 6-9.
5-44
Kronos Incorporated
Standard badges support only numeric values. If you enable alphanumeric labor data and select standard labor badges, the badge format supports only numeric data. If you are configuring a Series 4000 terminal, you can use the Function Key tab to enable ad hoc entries. If Ad hoc is active, validation is turned off at the device. The ad hoc flag must be set first in the Access Profile and Labor Level Maintenance options of the Workforce Timekeeper Setup Applications.
5-45
Chapter 5
Configuring Devices
Labor Transfer Tab

Use the Labor Transfer tab to enable employees to perform labor transfers. You can specify the types of badges that employees use for labor transfers, the prompts that appear for labor transfers when employees punch, and the access method that non-home employees use to perform transfers.
The configuration that you specify on the Labor Transfer tab may affect what you can specify on the Labor Levels tab. The information on these two tabs is interrelated for Generic Badge configuration. For more information about configuring labor level transfers, see Configuring Labor Transfer Settings on page 6-9.
5-46
Kronos Incorporated
Punch Rules Tab

Use the Punch Rules tab to change the settings that control home employee and non-home employee punching. Verify the type of badge that an employee uses for punching in and out, and instruct the device to accept punches from non-home employees. You can also enable employees to enter their Personal Identification Numbers (PINs) at a Series 4000 terminal or by using the * (asterisk) key and entering PINs at all other devices. For more information about the Punch Rules tab options, see the online Help.
5-47
Chapter 5
Configuring Devices
Supervisor Tab
Use the Supervisor tab to specify the tasks that supervisors and guards perform at the device. Supervisors perform supervisor tasks only when the device is in supervisor mode.
Some devices do not use guard mode. The supervisor functions in the Function Key tab may vary according to device.
5-48
Kronos Incorporated
Loading Basic Configuration Parameters to a Device

After you set device parameters by using the configuration tabs, you must send, or load, the parameters to the devices in your system. Each time that you change a configuration setting in the Data Collection Manager system, send the new configuration to the affected devices as soon as possible. For example, if you change the global message on a device, load the new global message to the devices. You need to load a basic configuration before you collect data for the first time.
Caution: If you upgrade from DCM 2A with Workforce Timekeeper 3 or earlier to a newer version, remember to extract your Series 400 device configuration before you enter the first initialize command. Otherwise, you lose your customized device configuration.
Load configuration data to devices by using one of the following methods:
w
Select a device group as a shortcut to load configuration data by using the Communications > Initialize command to all communication channels and devices associated with that device group. Use the Device Manager or the Communication Monitor application. Select a communication channel as a shortcut to loading configuration data by using the Communications > Initialize command to all the devices associated with that communication channel. Use the Device Manager application. Select one or more specific devices and use the Communications > Initialize command to load the configuration data. Use the Device Manager or the Communication Monitor application.
Note: The Communications > Update command does not load device configurations. The Update command loads employee information from the host application that has changed since the last update. Before selecting the Initialize command, select Device Configuration in the Download Options dialog box (Device Manager > File > Download Options). If you initialize only a device, you are prompted for download options.
5-49
Chapter 5
Configuring Devices
Note: When you initialize a Series 400 device with download options that include Device Configuration, all information about home employees is deleted from the device. This includes the current punch in or out status of each employee. Therefore, be very careful about performing an initialize to a Series 400 device with the Device Configuration download option selected and do not select Device Configuration as one of the default download options. The default download options are used by many Event Manager events, and can result in employee information being deleted. If you need to send Device Configuration to a device, always select one or more employee list download options as well. If you are using schedules, select the download options Employee list with schedules. If you are using totals, select Employee totals when you initialize. If you use schedules at devices, initialize only at times when employees are not expected to be working a shift. If you initialize during a shift when employees are working, their in/out statuses at the devices are erased and they may not be able to punch out properly. For more information about initialization, see Initialization on page 5-3. For information about loading device parameters that are not included in the Configuration Options tabs, see Chapter 11, Loading Files and Data to and from a Device.
Using the Device Manager Initialize to Load Basic Configurations to a Device or a Device Group
To load configuration data to a device by using the Device Manager main window: 1. From the Device Manager main window, expand the tree and select one or more devices or device groups. 2. Select Communications > Initialize. The Load Configuration options dialog box appears. This command clears all configuration settings on your device and loads the new settings in the device configuration to the device when Device Configuration is downloaded. It also loads any options you selected in the Download Options dialog box (Device Manager > Configure > Edit > Download Options).
5-50
Kronos Incorporated
3. Select the download options and click OK. The device icon displayed on the hierarchical tree turns yellow to indicate that the request is submitted. The device icon returns to green after the device successfully performs the request. At the same time, the Status window in the Device Manager main window reflects the loading of the configuration to the specified devices. If the load configuration is unsuccessful, see Chapter 12, Troubleshooting, for help.
Using the Communication Monitor Initialize to Load Basic Configurations to a Device or a Device Group
Using the Communication Monitor application, you load configuration information to devices, manually collect data from devices, set the time and date for the collection PCs, start and stop data collection, as well as follow the progress of these events. You access the Communication Monitor from the Data Collection Manager Start menu. To load the configuration by using the Communication Monitor: 1. From the Data Collection Manager Start menu, select Communication Monitor. 2. From the Communication Monitor main menu, select Communications > Initialize. This command clears all configuration settings on your device and loads the new settings in the device configuration to the device when Device Configuration is downloaded. It also loads any options you selected in the Download Options dialog box (Device Manager > Device > Download Options). 3. From the Select Target dialog box, select a device or device group. 4. Click Initialize. The configuration parameters are sent to the device. You observe the loading progress in the Communication Status list on the Communication Monitor main window.
5-51
Chapter 5
Configuring Devices
Viewing and Enabling Devices

The tree view of the Device Manager indicates which devices had events that were successful and which devices had events that failed.
w w w
Devices that are responding and able to communicate with DCM appear with green screens in the icons. Devices that are not responding and not able to communicate with DCM appear with yellow screens in the icons. Devices that are not enabled appear with dark gray screens in the icons.
To enable a previously disabled device for data collection: 1. From the Device Manager main window, select Setup > Devices. 2. Select the device to enable and click Edit. 3. Select the Device Enabled check box and click OK. 4. Click Yes to the confirmation prompt. 5. Click Close in the Configure Devices dialog box. The device name changes from a dark gray to light gray in the Device Manager main window, designating that the device is now enabled for data collection if it is responding and is able to communicate with DCM.
5-52
Kronos Incorporated
Chapter 6
Setting Up Labor Level Information
This chapter explains how to set up labor level information and how to load it to devices. This chapter contains the following sections:
w w w w w w w
Overview Selecting Labor Level Options for the Device Defining Labor Transfer Options Configuring Labor Transfer Settings Assigning Labor Levels to a Function Key Removing Labor Levels from a Device Downloading Labor Levels to a Device
Chapter 6
Overview
Host applications provide the labor levels, labor level sets, and labor level entry options that are available to the DCM system. DCM provides the means for you to set up labor level information for a device and download this information to the device. This chapter describes how to accomplish this.
Labor Levels
Typically, labor levels associate an employees time with cost centers that have a hierarchical relationship to each other, for example:
w w w
Level 1 is a department (Facilities) Level 2 is a division in the department (Maintenance) Level 3 is a job in the division (Electrician)
Certain host applications and devices support only three labor levels. The Data Collection Manager system lists screens that are appropriate to the number of labor levels that the host application or the device supports. If your host application or device supports seven labor levels, additional example labor levels are:
w w w w
Level 4 is a Cost Center Level 5 is a Product Level 6 is an Item Number Level 7 is a Work Order
Caution: If you create labor level entries that contain non-English characters,
you cannot download any labor level entries to your Series 400 devices. Each labor level usually contains sub-categories or entries of available choices. An entry from each labor level makes up a labor account. Labor accounts are cost centers to which employees worked hours accrue. A labor level set provides a way to send a selected subset of labor levels to a device.
6-2
Kronos Incorporated
Overview
Note: Whenever you modify a device configuration, you need to load the changes to the device so that they can be reflected at the device. After making your labor level changes, see the section Downloading Labor Levels to a Device later in this chapter.
Labor Level Sets

Labor Level Sets enable you to specify a collection of labor levels. Instead of specifying each labor level individually, you can specify a labor level set for a particular device. Each labor level set is defined by the host application. Use DCM to assign the labor level set to a device.
6-3
Chapter 6
Selecting Labor Level Options for the Device

Use the Application Options dialog box to select labor options for the device. For labor level options to take effect, you must download them to the device. To select labor level options for a device: 1. Select Start > Programs > Data Collection Manager > Device Manager. The Device Manager main window appears. 2. Select the device for which to set up labor level options. 3. Select Device > Application Options. The Application Options dialog box appears.
4. Select Activity code profile, Tips, and Job set as appropriate.
6-4
Kronos Incorporated
Selecting Labor Level Options for the Device
5. From the Labor levels list in the Device dialog box, select the Labor level set or None to select the labor levels to assign to the device. If you select no labor level set, you can select labor levels. If you select a labor level set, you cannot select labor levels. If you do not select either labor levels or a labor level set, no labor levels can be downloaded to the device. 6. Click OK. A Device Manager message appears explaining that you can use the Labor Level or Function Key tabs on the Data Collection Manager Configuration Options dialog box to make any necessary changes. 7. Click OK. Repeat this procedure for each device to which you want to assign labor levels. See Downloading Labor Levels to a Device later in this chapter, for information about loading configuration to the device.
6-5
Chapter 6
Defining Labor Transfer Options

Use the Labor Transfer tab on the Configuration Options dialog box to set up the device to allow labor transfers. Labor transfers allow the tracking, for accounting purposes, of employees who work in areas defined by different labor accounts. You specify the type of badges that an employee uses to perform labor transfers, the access method, and the prompts that appear when an employee punches in and punches out. To set up labor transfer options: 1. From the Device Manager main window, select the device for which to set up labor transfers. 2. Select Device > Configuration and click the Labor Transfer tab.
6-6
Kronos Incorporated
Defining Labor Transfer Options
3. Select a transfer badge type to allow a labor transfer.

w w w
Select None to not accept labor level or account badges at the device. Select Generic to allow non-standard or generic labor level or account badges at the device. Select Standard to allow Kronos standard labor level or account badges at the device.
4. Specify access options.

w w
Select the Allow non-home employees check box to enable non-home employees to perform labor transfers. Select the Restrict time on re-punch check box to restrict time between repunches. If you select this check box, set the repunch restriction time in the Punch Rules tab. Select the Enable # key for transfers check box to enable an employee to use the # (number) key to perform labor transfers to a default labor level. If you select this check box, the device assigns the default labor level assigned in the Labor Levels tab. Clear this check box to not allow labor level transfers to a default value by using the # key.
Note: The # key is not available on some devices. 5. Select the Allow keypad entries check box to enable employees to enter labor level data by using the device keypad. If you do not select Allow keypad entries, the employees must use labor level or account badges to enter labor data. 6. Specify if and how the device prompts for labor levels when the employee performs a simple punch.
w w w
Select None to specify that the device does not prompt for labor transfer data. Select First daily in-punch to perform a labor transfer on only the initial in-punch. Select All in-punches to perform a labor transfer each time an employee punches.
6-7
Chapter 6
7. Specify when an entry is required for labor levels that are prompted when an employee perform1s a simple punch.
w w w
Select None to specify that no entry data transfer is required. Select First daily in-punch to specify that data transfer is required only on the initial punch. Select All in-punches to specify that data transfers are required on all employee entries.
8. If Standard is selected as the transfer badge type, the Standard Badge restriction level specifies the restriction levels that the device accepts for labor account and labor level transfers. Ensure that the restriction levels are encoded in the badge format. Note: You set up restriction levels and assign employees to the levels in the host application. 9. Click OK to return to the Device Manager main window.
6-8
Kronos Incorporated
Configuring Labor Transfer Settings

Use the Labor Levels tab to set configuration values for each labor transfer. This includes the type of input that the device accepts for labor transfers and, optionally, a default labor level value that the device automatically assigns to a labor transfer. Before you configure labor transfers, be sure that the labor options are set as described earlier in Selecting Labor Level Options for the Device. To set the values for labor transfers: 1. From the Data Collection Manager Start menu, select Device Manager. 2. From the Device Manager window, select the device for which to set up labor transfers. 3. Select Device > Configuration and click the Labor Levels tab.
6-9
Chapter 6
4. If you specified Generic badge type on the Labor Transfer tab, select the labor level for which to specify generic badge values from the Labor Levels dropdown list. For other badge types, go to step 7. 5. Click Edit Format to edit the Generic badge format for labor transfers. The Generic Badge - Labor Level dialog box appears. Note: You can edit the Generic badge format only if you specified a Generic badge type on the Labor Transfer tab. Otherwise, the Edit Format button is not available.
6-10
Kronos Incorporated
6. In the Generic Badge - Labor Level dialog box: a. Select the Allow any length generic badge check box or enter a number from 1 to 32 in the Number of characters in data field text box to specify the total number of characters on the generic badge. Do not use 17 or 18. These numbers are reserved for Kronos standard badges. Zero indicates no generic badge. For labor account transfer badges, the data field is the labor account number. The terminal recognizes labor account numbers in the range of zero to 30 digits. For Labor level transfer badges, the data field is the labor level number. The sum of the digits in the seven labor levels cannot exceed 30.
6-11
Chapter 6
For labor level transfer badges, the sum of the digits is less than or equal to 30 for the labor level. Note: The sum of the number of characters in the data field and the number of characters to ignore (from the right) is equal to or less than the total number of characters on the badge. b. Enter the number of characters to ignore at the end of the format. This number locates the data field. c. Click Test to verify the entries. If the entries are valid, the format appears in the Badge Format box. If the entries are invalid, an error message appears in the Badge Format box. d. Click OK to accept the changes, run the test, and return to the Labor Levels tab. 7. On the Labor Levels tab, select the Allow alphanumeric values check box to allow alphanumeric values. If cleared, only numeric values are allowed. 8. A partial transfer is a labor level transfer feature that enables users to specify fewer labor levels, rather than all labor levels, to be used in the host application. The user only needs to enter a value for every labor level that is configured in the host application. If you are configuring a Series 400 device, select the Allow partial transfers check box to enable employees to bypass prompts by pressing Enter. You also must assign a Not Assigned value and allow override for any labor level that you want to be able to enter as a partial labor transfer. Go to step 9. If you are configuring a Series 4000 terminal, partial labor level transfers are specified on the Function Key tab. Go to step 14. For more information about configuring partial labor level transfers for a Series 4000 terminal, see Assigning Labor Levels to a Function Key on page 6-15. 9. Select a Labor Level from the Default value for the # key and supervisor transfers list box, and click Assign. The Labor Level dialog box appears.
6-12
Kronos Incorporated
10. To allow override for any labor level that you entered as a partial labor transfer, select the Allow override check box. If you select the Allow Override option, the employee either accepts or changes the associated labor level entry at the device. 11. To allow ad hoc entries if your host application has defined ad hoc labor levels, click the Allow ad hoc check box. If you select Allow ad hoc, the employee can enter a new labor level at the device. Note: The options that appear depend on how labor levels have been configured in the host application. Disabled options are not available. For example, the ad hoc flag must be set first in the Access Profile and Labor Level Maintenance options of the Workforce Timekeeper Setup Applications. If the host application is configured for three or fewer labor levels, three check boxes appear where you can enable ad hoc for each labor level individually. 12. Click OK.
6-13
Chapter 6
13. Repeat steps 9 through 12 until you have assigned the appropriate labor levels. 14. On the Labor Levels tab, the default order for the Labor Levels that were configured in the Application Options appear in the Labor level prompt order check box. The order specifies the sequence in which the device prompts for labor level entries when the employee performs a labor level transfer. You can edit the order of the levels, but not add or delete any level. For example, if you configured Labor Levels 1, 2, 3, and 5, or the Labor Level Set is configured for Labor Levels 1, 2, 3, and 5, the default order could be 5321. You can change the order to 3512, but not 351 or 3571. For more information about setting labor levels, see Selecting Labor Level Options for the Device on page 6-4. 15. Click OK to return to the Device Manager main window.
6-14
Kronos Incorporated
Assigning Labor Levels to a Function Key

Use the Function Key tab to assign tasks to function keys. You set up function keys to perform tasks, for example, list the employees last punch, request a tip amount, or cancel an automatic meal deduction. You assign tasks to function keys for employee and supervisor use, or only for supervisor use. You can also assign labor levels to function keys so that an employee can charge time to one or more labor accounts. To assign labor levels to a function key: 1. From the Device Manager main window, select the device for which to set up function keys. 2. Select Device > Configuration and click the Function Key tab. The Configuration Options dialog box appears.
6-15
Chapter 6
Note: The options available are determined by the device that you are configuring. 3. If available, you can select the Perform function key activity on out-punch check box, which allows employees to perform a function key task when they punch out from a shift. 4. In the Function key mapping list, expand a Function Key, select one of the following options, and click Assign:
w w
For Series 4000 terminals, select either No function assigned or No supervisor command assigned. For Series 400 devices, select No function assigned.
The Assign Function dialog box appears.
5. If you are configuring a Series 4000 terminal, select Labor Transfer and click Detail. If you are configuring a Series 400 device, select Labor Account Transfer and click Detail. The Function Key Settings dialog box appears.
6-16
Kronos Incorporated
6. From the Labor Transfer dialog box, click the Labor Levels tab, highlight a labor level, and click Assign. The Labor Level dialog box appears.
6-17
Chapter 6
7. Select the appropriate labor level entry from the Labor Level dialog box. If you select the Allow Override option, the employee either accepts or changes the associated labor level entry at the device. If you select Allow ad hoc, the employee can enter a new labor level at the device. If you select Allow partial transfers, the employee can specify fewer labor levels, rather than all labor levels, to be used in the host application. The employee only needs to enter a value for every labor level that is configured in the host application. Note: The options that appear depend on how labor levels have been configured in the host application. Disabled options are not available. For example, the ad hoc flag must be set first in the Access Profile and Labor Level Maintenance options of the Workforce Timekeeper Setup Applications. 8. Repeat steps 5 through 7 until you have assigned the appropriate labor levels to the function key. 9. Click OK. For more information about the Function Key tab, see Function Key Tab on page 5-30. After a labor level is assigned to a function key, you need to load the labor level assignment to your device or devices. See Downloading Labor Levels to a Device on page 6-21.
6-18
Kronos Incorporated
Removing Labor Levels from a Device
Removing Labor Levels from a Device

Before you remove labor levels from a device, you need to remove any labor level assignment to a function key, a number (#) key, or a labor level transfer that is assigned to that device. You cannot delete a labor levels or a labor level set if it is assigned to any devices. To remove labor levels from a device: 1. From the Data Collection Manager Start menu, select Device Manager. The Device Manager window opens. 2. Select the device from which to remove labor level information. 3. Select Device > Applications Options. The Application Options dialog box for the device appears.
4. In the Labor levels list, select None in the Labor level set drop-down menu and clear all the labor levels.
6-19
Chapter 6
5.
Click OK.
6. Download the option to the device by using the Initialize command from the Device Manager or the Communication Monitor application.
6-20
Kronos Incorporated
Downloading Labor Levels to a Device
Downloading Labor Levels to a Device

You can download (initialize) as a manual request from the Device Manager or the Communication Monitor. You can also schedule a download event in the Event Manager. To download labor level information to a device from the Device Manager: 1. Select the device for which to download the labor levels. 2. Select Device > Download Options. The Download Options dialog box appears. 3. Select Labor Accounts and click OK.
4. From the Device Manager, select the device for which you want to download the new parameters. 5. Select Communications > Initialize. The Load Configuration options dialog box appears. 6. From the drop-down list, select Device Configuration and click OK.
6-21
Chapter 6
Note: When you initialize a Series 400 device with download options that include Device Configuration, all information about home employees is deleted from the device. This includes the current punch in or out status of each employee. Therefore, be very careful about performing an initialize to a Series 400 device with the Device Configuration download option selected and do not select Device Configuration as one of the default download options. The default download options are used by many Event Manager events, and can result in employee information being deleted. If you do need to send Device Configuration to a device, always select one or more employee list download options as well. If you are using schedules, select the download options Employee list with schedules. If you are using totals, select Employee totals when you initialize. If you use schedules at devices, initialize only at times when employees are not expected to be working a shift. If you initialize during a shift when employees are working, their in/out statuses at the devices are erased and they may not be able to punch out properly. Series 4000 terminals retain all employee information during all initializations unless the Clear all employee information download option is selected. Clear All Employee information does not delete employee punches from devices The labor options are sent to the device that you specified and then the Device Manager main window reappears.
6-22
Kronos Incorporated
Chapter 7
Totals and Accruals
This chapter explains how to define function keys to display totals and accruals. It contains the following sections:
w w w w w
Overview Creating Total Definitions Assigning Total Definitions to Function Keys Downloading Total Definitions and Accruals to a Device Displaying Totals at the Device
Chapter 7
Totals and Accruals
Overview
Certain devices display totals and accrual balances for employees. A device is configured to list a number of total definitions for home employees. Users display device totals from total definitions by using a function key. A total definition contains the sum of a specific calculation, for example, hours worked or sick time earned. DCM supports these total definitions with pay codes or accrual codes. Each total definition has one setting system-wide; total definitions are not deviceindependent. DCM uses the application connection library to retrieve the list of configured pay codes and accrual codes in the application. You can create totals definitions with pay code or accrual code selections, and then assign total definitions to function keys to display the totals at that device. You can configure different function keys to show different total definitions for different devices. When you select Employee Totals as a download option for a device, the totals definitions and employee totals are downloaded to the device with a device initialize or scheduled totals download event. When you select Device Configuration as a download option for the device, totals definition assignments to function keys are downloaded with the device initialize. DCM uses the application connection library to interface with the application to retrieve totals and accruals for the employees. For more information about configuring pay codes, refer to Chapter 8, Activity Codes, Comment Codes, and Pay Code Edits.
7-2
Kronos Incorporated
Creating Total Definitions

In DCM, you can define totals definitions for a selected pay code or accrual code. Totals definitions are system-wide and are not device-specific. Use the Totals Configuration dialog box, which you access from the Function Key tab on the Configuration Options dialog box, to create totals definitions. To create totals definitions: 1. Select Start > Programs > Data Collection Manager > Device Manager. 2. From the Device Manager main window, select the device for which to set up the total definitions. 3. Select Device > Configuration. The Configuration Options dialog box appears.
7-3
Chapter 7
Totals and Accruals
4. Click the Function Key tab, and then click Configure Totals. The Totals Configuration dialog box appears. Use this dialog box to assign a specific total type (pay code or accrual) to a total definition. It is empty by default.
5. Click Add to add a new total definition. The Totals dialog box appears.
6. Enter a name for the totals definition. The name can contain a maximum of 20 alphanumeric characters. For example, Nurses Overtime. Do not enter special characters such as:, /, \, *, and so on, because these characters are not accepted.
7-4
Kronos Incorporated
7. Select Pay Code or Accrual Code as the total type.

w w
A pay code designates a specific type of pay, for example, regular rate, overtime, or holiday rate. An accrual code designates a benefit that an employee earns over time, for example, vacation time, or sick time.
8. Select a pay code or accrual code from the list, and then click OK. 9. Click OK.
Editing a Total Definition

To edit a total definition: 1. From the Device Manager main window, select the device for which to edit the total definitions. 2. Select Device > Configuration. The Configuration Options dialog box appears. 3. Click the Function Key tab. 4. Click Configuration Totals. The Totals Configuration dialog box appears. 5. Select the name of the total definition to edit. 6. Click Edit. The Totals dialog box appears.
7-5
Chapter 7
Totals and Accruals
7. Enter a new Totals Name if you want to change it. 8. Select Pay Code or Accrual Code. Depending on your selection, a list of pay codes or accrual codes that were defined in the client application appears. 9. Select a pay code or accrual code from the list, and then click OK. The Totals list appears in the Totals Configuration dialog box.
Deleting a Total Definition

DCM allows a maximum of seven total definitions. Delete a total definition when that total is no longer necessary. For example, salaried employees no longer need to keep track of their overtime. To delete a total definition: 1. From the Device Manager main window, select the device for which to delete the total definitions. 2. Select Device > Configuration. The Configuration Options dialog box appears. 3. Click the Function Key tab. 4. Click Configuration Totals. The Totals Configuration dialog box appears. 5. Select the name of the total definition. 6. Click Delete and Yes to confirm. 7. Click OK.
7-6
Kronos Incorporated
Assigning Total Definitions to Function Keys

To assign total definitions to function keys, define the function key assignment and then specify the totals that you want to display at the device.
Defining Function Key Assignments

Use the Function Key tab in the Configuration Options dialog box to define function key assignments. To assign a function key: 1. In the Configuration Options dialog box, click the Function Key tab.
7-7
Chapter 7
Totals and Accruals
2. Click the plus sign before the function key name to display the list of functions assigned or not assigned. 3. Select No function assigned or No supervisor command assigned. 4. Click Assign. The Assign Function dialog box or the Assigning Supervisor Command dialog box appears.
5. Select a function to assign to that specific function key. 6. If you want the display at the Series 4000 terminal to be other than the default command list label, specify the display text in the Function key label text box. Series 4000 terminals support up to 40 characters that line wrap. All other devices support up to 20 characters without line wrap. 7. If the Detail button becomes active, click it to configure additional parameters. For more information about the detail parameters, click Help. 8. Click OK until the Device Configuration Options dialog box reappears with the function that you selected assigned to the function key that you selected.
7-8
Kronos Incorporated
Specifying Subtotals to Display

To specify the totals that are to appear on the device: 1. On the Function Key tab, click the plus sign before the function key name to display the list of functions assigned or not assigned. 2. Select the assigned function key that is to display the totals. 3. Click Assign. 4. In the Assign Function dialog box that appears, select View Totals and click Detail. The Function Key Settings - View Totals dialog box appears with the list of totals definitions.
5. Select the totals to be displayed on the device. The totals enabled are devicespecific. 6. Click Apply to accept the change and make more changes, or click OK to accept the change and return to the Assign Function dialog box. If you click Apply and Cancel, the applied changes remain and the dialog box exits. 7. Click OK. The Function Key tab reappears. 8. Click Apply to apply the changes and continue to display the Function Key tab, or click OK to apply the changes and close the Configuration Options dialog box.
7-9
Chapter 7
Totals and Accruals
Downloading Total Definitions and Accruals to a Device

To download total definitions and accruals to a device, set the proper download options from the Device Manager.
Downloading Total Definitions and Accruals

1. From the Device Manager main window, highlight the appropriate device. 2. Select Communications > Initialize. The Load Configuration options dialog box appears.
3. Select Employee Totals. Note: To download function key assignments that display totals at the device, you need to download Device Configuration as part of an initialize. When totals definitions are deleted, verify the function key assignments and save the device configuration. To reflect the proper function key assignments for totals definitions at the device, you need to send the device configuration to the device. 4. Click OK.
7-10
Kronos Incorporated
Downloading Total Definitions and Accruals to a Device
Sending Totals and Accruals to the Device

When a communication channel receives the request to initialize or update, it loads the configuration service of DCM KrCfgSvc.dll. The configuration service builds the download file based on the selected device download options. It requests application-specific information, for example, employees, totals, labor levels, entry lists, activity codes, pay codes, and restriction profiles from the application connection library. Note: Restriction profiles and terminal rules are equivalent terms and depend on the host application supported. The Workforce Timekeeper connection library provides employee totals data lists to the configuration service and devices only during initialization, not during an update request. Note: When you initialize a Series 400 device with download options that include Device Configuration, all information about home employees is deleted from the device. This includes the current punch in or out status of each employee. Therefore, be very careful about performing an initialize to a Series 400 device with the Device Configuration download option selected and do not select Device Configuration as one of the default download options. The default download options are used by many Event Manager events, and can result in employee information being deleted. If you do need to send Device Configuration to a device, always select one or more employee list download options as well. If you are using schedules, select the download options Employee list with schedules. If you are using totals, select Employee totals when you initialize. If you use schedules at devices, initialize only at times when employees are not expected to be working a shift. If you initialize during a shift when employees are working, their in/out statuses at the devices are erased and they may not be able to punch out properly. Series 4000 terminals retain all employee information during all initializations unless the Clear all employee information download option is selected. Clear All Employee information does not delete employee punches from devices.
7-11
Chapter 7
Totals and Accruals
Individual totals are part of the employee totals record that depend on the total number of configured total definitions. Note: With Workforce Timekeeper, totals and accruals are downloaded with vested balances in the current pay period.
7-12
Kronos Incorporated
Displaying Totals at the Device
Displaying Totals at the Device

To display a total, press the function key that is assigned to display that total on the device. This action causes the Pay Code total or Accrual Code total to appear in HH:MM format for that employee.
w
If the Accrual Code/Pay Code is defined as time, the device displays the total as hours:minutes. For Series 400 devices and for Series 4000 terminals version 1.03.04 or earlier, the device displays the Accrual/Pay Code hours total the range of -9999:59 to 9999:59. If the total displays as 0:00, it is outside this range, or the total for that totals definition is not available from the application. Money totals that are sent to the device are rounded. For Series 4000 terminals version 1.03.05 or later, the terminal displays the Accrual/Pay Code hours total the range of -9999:59 to 999999999:59. If the total displays as 0:00, it is outside this range, or the total for that totals definition is not available from the application. Money totals that are sent to the terminal are not rounded.
If the Accrual Code/Pay Code total is defined as money, the device displays the dollar amount only.
If you do not want to display at the device accrual codes that are flagged as hidden in the host application, do not configure the particular accrual as code to be downloaded to the device. Note: Totals that use any non-English characters may not get displayed correctly at a Series 400 device.
7-13
Chapter 7
Totals and Accruals
7-14
Kronos Incorporated
Chapter 8
Activity Codes, Comment Codes, and Pay Code Edits
This chapter describes how to configure activity codes, comment codes, and pay code edits. This chapter contains the following sections:
w w w
Creating Activity Codes Configuring Comment Codes Configuring Pay Code Edits
Chapter 8
Creating Activity Codes

This section explains how to create activity code profiles and assign them to devices.
What is an Activity Code?

An activity code is an item that associates a pay rule with a work rule. An activity code includes the following information:
w
The default work rule. This is the work rule that is used when the following conditions occur: The user enters an activity code. The pay rule in the activity code definition does not match the pay rule in the employee record. Workforce Timekeeper then defaults to the default work rule.
Pay rule and work rule associations. This list of pay rules are linked to various work rules. One of the pay rules and its associated work rules is used when the following conditions occur: The user enters an activity code. A pay rule in the activity code definition matches the pay rule in the employee record. Workforce Timekeeper uses the work rule associated with that pay rule.
Activity Code Definitions Activity code definitions provide several ways to associate work rules with an activity code. An activity code definition may default to a single work rule to provide all employees with the same interpretations of time, and an activity code definition may map to one or more work rules to provide different interpretations of time for various groups of employees.
8-2
Kronos Incorporated
An employee enters activity codes at Series 400 device to indicate one of the following conditions:
w w
The employee transferred to a different cost center. The employee worked a special type of shift.
Example of Using an Activity Code An employee enters an activity code at a device because she worked 8 hours in the quality assurance department, which is not her usual job. Working in the quality assurance department earns her more money. When she enters the activity code, Workforce Timekeeper compares the pay rule in the activity code definition to the pay rule from the employee record.
w
If the activity code definition and the employee record include the same pay rule, Workforce Timekeeper uses the associated work rule to interpret the hours. If the activity code definition and the employee record do not include the same pay rule, Workforce Timekeeper uses the default work rule in the activity code definition to interpret the hours.
A single activity code may be mapped to multiple work rules within the Workforce Central system. Employees can use the same activity code at the device to indicate a special pay situation, even though the employee may be paid according to different rules.

To create activity codes: 1. From the Start menu, select Programs > Data Collection Manager > Activity Codes. The Activity Code Configuration window opens. 2. From the list box, select Activity Code Definition if not already selected. 3. Select File > New. The Activity Code Definition - Create New dialog box appears.
8-3
Chapter 8
4. Enter a unique name for the new activity code. 5. Select a default work rule for the activity code. The default work rule goes into effect under the following conditions: a. The user enters an activity code at a device. b. The pay rule in the activity code definition does not match the pay rule in the employee record. You have the option to select a default work rule for this activity code by using the Default Work Rule drop-down box. Note: If you select None and the pay rule in the activity code definition does not match the employee's pay rule, the Transaction Data Editor lists an error message.
8-4
Kronos Incorporated
6. To link the pay rules to the work rules, select a pay rule on the left side of the window and a work rule on the right side of the window, and click Add. Regardless of whether or not you selected a default work rule, you must create Pay Rule/Work Rule associations. You can create many of them. You can associate only one pay rule with a work rule. However, you can associate more than one work rule with a pay rule. As you link pay rules to work rules, the associations are listed in the Pay Rule/ Work Rule Associations area of the window. 7. When you have finished, click OK to save the new activity code.
What is an Activity Code Profile?

Activity code profiles are the means that you use to assign activity codes to a device. An activity code profile consists of the following components:
w w
The name of the activity code profile Activity codes (numbers from 1 to 20) that can be entered at each device that is assigned that activity code profile
Note: An activity code definition must be created before you can create an activity code profile. You must create an activity code profile before you can assign an activity code to a function key.
Creating Activity Code Profiles

To create activity code profiles: 1. From the Start menu, select Programs > Data Collection Manager > Activity Codes. The Activity Code Configuration window opens. 2. From the list box, select Activity Code Profiles if not already selected. 3. Select File > New. The Activity Code Profile - Create New dialog box appears.
8-5
Chapter 8
4. Enter a unique name for this profile, for example, Tech Support Profile. 5. Map an available definition to an activity code: a. Select an available definition in the left window pane. b. Select an activity code in the right window pane. The activity code numbers do not correspond to function key numbers. Activity numbers allow employees to scroll through several codes at the device and select the one that they want to enter. c. Click Assign to map the available definition to the activity code. 6. Optionally, you can repeat step 5 until you map all the activity definitions to the activity code numbers that are to be entered at the device. Specify the activity code profile before you initialize the device. For more information about specifying the profile, see Assigning an Activity Code Profile to Devices on page 8-7. To remove an activity code profile, select the profile and its associated activity codes, and click Remove. To delete an activity code profile from the database, highlight the profile and select File > Delete.
8-6
Kronos Incorporated
Assigning an Activity Code Profile to Devices

To assign the activity code profile to devices: 1. From the Data Collection Manager main menu, select Device Manager. The Device Manager window opens. 2. Select the device for which the activity code profile is to be assigned. 3. Select Device > Application Options. The Application Options dialog box appears.
4. In the Activity code profile list box, select one of the profiles in the dropdown list and click OK.
8-7
Chapter 8
Downloading Activity Code Profiles to Devices

The following procedure explains how to download activity codes to devices: 1. From the Data Collection Manager main menu, select Device Manager. 2. Select a device or a device group.
w
If you select a single device to initialize, the Load Configuration options dialog box appears with Activity Codes selected. You select additional download options, and then click OK. The activity code profile is sent to the device that you specified. Check the Request status window for the results of your download option.
Note: If you select Clear All Employee Information, employees who have punched in may not be able to punch out.
w
If you selected all devices in a communication channel or a device group, downloading of the activity code profiles to the devices starts immediately after you select the update or initialize option. Check the Request status window for the results of your download option.
3. Select Communications > Initialize to download the new parameters.
8-8
Kronos Incorporated
Note: When you initialize a Series 400 device with download options that include Device Configuration, all information about home employees is deleted from the device. This includes the current punch in or out status of each employee. Therefore, be very careful about performing an initialize to a Series 400 device with the Device Configuration download option selected and do not select Device Configuration as one of the default download options. The default download options are used by many Event Manager events, and can result in employee information being deleted. If you do need to send Device Configuration to a device, always select one or more employee list download options as well. If you are using schedules, select the download options Employee list with schedules. If you are using totals, select Employee totals when you initialize. If you use schedules at devices, initialize only at times when employees are not expected to be working a shift. If you initialize during a shift when employees are working, their in/out statuses at the devices are erased and they may not be able to punch out properly. Series 4000 terminals retain all employee information during all initializations unless the Clear all employee information download option is selected. Clear All Employee information does not delete employee punches from devices 4. At the device, assign the function keys to the device code numbers. Alternatively, use the Function Key tab in the Configuration Options dialog box. See the following section, Assigning an Activity Code to a Function Key. You can correlate device codes to the function keys, for example, assigning device code 9 to function key 1. However, to reduce confusion, you map the device codes to their corresponding function keys. You can also program a function key to prompt for activity codes. Employees enter an activity code after pressing the function key. For more information about assigning an activity code to a function key, refer to the next section.
8-9
Chapter 8
Assigning an Activity Code to a Function Key

To assign an activity code to a function key: 1. From the Device Manager main window, select the device. 2. Select Device > Configuration. The Configuration Options dialog box appears. 3. Click the Function Key tab. 4. In the Function key mapping list, expand the Function Key to which to assign an activity code, and select one of the following:
w w
No function assigned to select an activity code assignment for an employee No supervisor command assigned to select an activity code for supervisor use only
8-10
Kronos Incorporated
5. Click Assign. In the Assign Function dialog box, select the activity code to assign to the function that key you selected. 6. In the Assign Function dialog box, scroll until you find Start Activity and select it.
7. Click Detail. The Function Key Settings dialog box appears. Select the activity code from the Activity code list to assign to the Function Key. Select other options, as appropriate.
8-11
Chapter 8
8. Click OK until you return to the Device Manager main window. For more information about the Function Key tab, see Function Key Tab on page 5-30. After an activity code is assigned to a function key, you need to load the activity code to your device or devices. See Downloading Activity Code Profiles to Devices on page 8-8.
Unassigning an Activity Code Profile from a Device

You cannot delete an activity code profile if it has been assigned to a device. First unassign the activity code profile from the device. To unassign the activity code profile from devices: 1. From the Device Manager window, select the device whose activity code profile you are unassigning. 2. Select Device > Application Options. The Application Options dialog box appears.
8-12
Kronos Incorporated
3. In the Activity code profile list box, select <None> and click OK. You are also prompted for configuration options to unassign function keys. Download the option to the device by using the Initialize command from the Communication Monitor or the Device Manager. Select Communications > Initialize to clear all the settings on your device and load the new settings.
8-13
Chapter 8
Note: When you initialize a Series 400 device with download options that include Device Configuration, all information about home employees is deleted from the device. This includes the current punch in or out status of each employee. Therefore, be very careful about performing an initialize to a Series 400 device with the Device Configuration download option selected and do not select Device Configuration as one of the default download options. The default download options are used by many Event Manager events, and can result in employee information being deleted. If you do need to send Device Configuration to a device, always select one or more employee list download options as well. If you are using schedules, select the download options Employee list with schedules. If you are using totals, select Employee totals when you initialize. If you use schedules at devices, initialize only at times when employees are not expected to be working a shift. If you initialize during a shift when employees are working, their in/out statuses at the devices are erased and they may not be able to punch out properly. Series 4000 terminals retain all employee information during all initializations unless the Clear all employee information download option is selected. Clear All Employee information does not delete employee punches from devices After unassigning the activity code profile from the device, you delete the activity code profile from the Activity Code Configuration application.
8-14
Kronos Incorporated
Configuring Comment Codes

This section explains how to configure and download comment codes to devices.
What is a Comment Code?

A comment code, and its associated comment text, is an item that is defined in Workforce Timekeeper Setup Applications. You can associate comments with a subset of commands and assign these commands to function keys. Each comment is assigned a code number that the user enters at the device. For Series 400 devices, the comments codes are enabled only for certain supervisor functions or commands and only for Full models, such as the 480 Full model. If you configure a function key with a function or transaction that includes a pay code, activity code, comment code, or total, be sure to select the corresponding item in the Download options list the next time you initialize the device. Otherwise, validation of the entered code always fails because the corresponding validation list does not exist in the device. If this validation fails, the user cannot complete the function or transaction.
Enabling Comment Codes for a Series 4000 Terminal

Each command that can be enabled for comment codes is enabled separately. Both employees and supervisors have access to comment codes but for different sets of commands. To enable comment codes for a Series 4000 terminal: 1. From the Device Manager main window, select the device to configure. 2. Select Device > Configuration. The Configuration Options dialog box appears. 3. In the Configuration Options dialog box, click the Function Key tab. 4. Select the function key to which to assign a function. 5. Click the + (plus) sign to expand the function key options. 6. Select No function assigned or No supervisor command assigned.
8-15
Chapter 8
Note: If you selected No function assigned, some options, such as Delayed Labor Transfer, can be entered by an employee for any day from the first day of the current month to the next day within the month of the current date. For example, if the date is March 15, the user can enter any day from 1-16 for a Delayed Labor Transfer within the first 16 days of March. If the user enters 17 or above, the Delayed Labor Transfer is entered for the previous month, for example February 17. Note: If you selected No supervisor command assigned, some options, such as delete a punch, can be deleted by a supervisor for any day from the first day of the current month to the next day within the month of the current date. For example, if the date is March 15, the user can enter any day from 1-16 for a punch delete within the first 16 days of March. If the user enters 17 or above, the deleted punch is entered for the previous month, for example February 17. 7. Click Assign. The Assign Function or the Assign Supervisor Command dialog box appears. 8. Select the function to assign to the function key. In the Command List, select Add Punch, Delayed Labor Transfer, Delete Punch, End Activity, Job Transfer, Labor Transfer, Pay Code Hours Adjustment, Pay Code Hours Edit, Pay Code Money Edit, or Start Activity. 9. Click Detail. The Function Key Settings dialog box that is specific to the function that you selected appears. 10. In the Comment Code area, select the Prompt for comment code check box. 11. From the drop-down list, select a default comment to assign a default value or leave the text box blank. 12. Optionally, select the Entry required to require the user to enter a comment code. 13. Optionally, select the Allow override check box to allow an override to the default. 14. Click OK until you reach the main menu.
8-16
Kronos Incorporated
Enabling Comment Codes for a Series 400 Device

You can configure comment codes for a Series 400 device for a select set of commands by using the Supervisor tab and the Function Key tab in the Configuration Options dialog box. To enable comment codes for a Series 400 device: 1. From the Device Manager main window, select the device to configure. 2. Select Device > Configuration. The Configuration Options dialog box appears. 3. Click the Supervisor tab. 4. Select the Prompt for comment code check box and click Apply. Comment codes are enabled for any supervisor command or supervisor only function that supports a comment code. 5. Click the Function Key tab. 6. Select the function key to which to assign a function. 7. Click the + (plus) sign to expand the function key options. 8. Click either No function assigned or No supervisor command assigned. 9. Click Assign. If you selected No function assigned, the Assign Function dialog box appears. a. Select the Supervisor only check box. b. From the Function List, select the function to assign to the function key. c. If Detail is enabled, click it. The Function Key Settings dialog box that appears is specific to the function that you selected appears. Select the appropriate settings and click OK. The available details to select are Labor Levels, Pay Code, Activity, or Totals. For more information about the Details dialog box options, refer to the online Help.
8-17
Chapter 8
Note: If you selected No function assigned, some options, such as Delayed Labor Transfer, can be entered by an employee for any day from the first day of the current month to the next day within the month of the current date. For example, if the date is March 15, the user can enter any day from 1-16 for a Delayed Labor Transfer within the first 16 days of March. If the user enters 17 or above, the Delayed Labor Transfer is entered for the previous month, for example, February 17. If you selected the No supervisor command, the Assign Supervisor Command dialog box appears. Select the function to assign to the function key. Note: If you selected No supervisor command assigned, some options, such as delete a punch, can be deleted by an employee for any day from the first day of the current month to the next day within the month of the current date. For example, if the date is March 15, the user can enter any day from 1-16 for a punch delete within the first 16 days of March. If the user enters 17 or above, the deleted punch is entered for the previous month, for example February 17. 10. Click OK twice.
8-18
Kronos Incorporated
Configuring Pay Code Edits

This section explains how to configure pay code edits to devices.
What is a Pay Code?

Pay codes are categories of time or money that employees earn. Regular and overtime are examples of pay codes for worked or productive time. Jury duty, vacation, and sick time are examples of pay codes for nonproductive time. Bonus is an example of a pay code that holds monetary amounts. Pay codes and ID numbers are assigned by Workforce Timekeeper.
What is a Pay Code Edit?

A pay code edit is used to enter an amount of time or money against a particular pay code. Supervisors and, in some case, employees may perform pay code edits at Series 400 devices, and both supervisors and employees may perform pay code edits at 4000 terminals, by pressing a soft key or function key that you configure by using DCM. For each soft key or function key, you can specify the pay code to which to apply the edit and, optionally, a default amount of hours or money. For example, you may configure Soft Key 3 to add 8 hours of vacation time. Note: If you configure a function key with a function or transaction that prompts the user to enter a pay code, activity code, or comment code, be sure to select the corresponding item in the Download options list the next time you initialize the device. Otherwise, validation of the entered code fails because the corresponding validation list does not exist in the device. If this validation fails, the user cannot complete the function or transaction.
8-19
Chapter 8
Enabling Pay Code Edits for a Series 4000 Terminal

You can configure pay code edits for a Series 4000 terminal by using the Function Key tab in the Configuration Options dialog box. The functions that are available are specific to the host application used and the device being configured. The functions that are available are specific to the device being configured. For example, the Series 4000 terminal soft keys can be assigned Pay Code Hours Edit and Pay Code Money Edit in Employee mode, and Pay Code Hours Adjustment and Pay Code Hours Edit in Supervisor mode. To enable pay code edits for a Series 4000 terminal: 1. Open the Device Manager main window and select the terminal to configure. 2. Select Device > Configuration. The Configuration Options dialog box appears. 3. Click the Function Key tab. 4. Select the function key to which to assign a function. 5. Click the + (plus) sign to expand the function key options. 6. Select either No function assigned or No supervisor command assigned and click Assign. If you selected No function assigned, the Assign Function dialog box appears. From the Function list, select Pay Code Hours Edit. If you selected No supervisor command assigned, the Assign Supervisor Command dialog box appears. From the Command List, select Pay Code Hours Adjustment, Pay Code Hours Edit, or Pay Code Money Edit. 7. Click Detail. The Function Key Settings dialog box appears. Only pay codes that have a pay code ID number are displayed in the Function Key Settings dialog box. If no pay code ID numbers were defined in the host application, an information message reports that no pay codes are available from the host application. Use the host application setup component to define pay code ID numbers. For more information about assigning pay code ID numbers to a pay code, refer to the host application documentation.
8-20
Kronos Incorporated
8. Select the pay code to be used as the default that is associated with the function key setting. Pay code names with pay code ID numbers that were defined in the host application are downloaded through DCM to the device. Use the Function Key Settings dialog box to associate the transaction with a specific pay code. You may also specify a number of default hours and can prevent employees from overriding this default setting. 9. If selected, clear the Allow override check box. Note: Although pay code transaction configuration allows you to enable Override for pay codes, DCM cannot display a list of identifying pay code numbers. You must use the default pay code number assigned by Workforce Timekeeper. If you select Pay Code Adjustment and the default values for the From and To selections, and also do not allow these to be overridden, the function key always performs an adjustment with the From and To default values, even if it is inappropriate for that employee. For more information about the options listed in Function Key Settings dialog box, click Help. 10. Click OK. 11. To change the label that appears on the device for the function key, enter the new label text in the Function key label box. 12. Click OK twice.
Enabling Pay Code Edits for a Series 400 Device

To enable pay code edits for a Series 400 device: 1. Open the Device Manager main window and select the device to configure. 2. Select Device > Configuration. The Configuration Options dialog box appears. 3. Click the Function Key tab.
8-21
Chapter 8
4. Select the function key to which to assign a function. 5. Click the + (plus) sign to expand the function key options. 6. Select either No function assigned or No supervisor command assigned. 7. Click Assign. If you selected No function assigned, the Assign Function dialog box appears. From the Function list, select Pay Code Transaction and go to step 8. If you selected No supervisor command assigned, the Assign Supervisor Command dialog box appears. From the Command List, select Supervisor Pay Code Adjustment or Supervisor Pay Code Transaction and go to step 11. 8. If you selected No function assigned and selected Pay Code Transaction, click Detail. The Function Key Settings dialog box appears. A Function Settings dialog box does not display areas that do not apply to a particular function or assignment. The features that are visible and enabled are specific and based on the options you selected on a given tab. They are also specific to the device that you configure or to the settings in the host application. Use the Function Settings dialog box to associate a transaction with a specific pay code, specify the number of default hours, and prevent employees from overriding the default settings. Only pay codes that have a pay code ID number are downloaded through DCM to the device and displayed in the Function Key Settings dialog box. If no pay code ID numbers were defined in the host application, an information message reports that no pay codes are available from the host application. Use the host application setup component to define pay code ID numbers. For more information about assigning pay code ID numbers to a pay code, refer to the host application documentation. 9. If selected, clear the Allow override check box. Note: Although pay code transaction configuration allows you to enable Override for pay codes, DCM cannot display a list of identifying pay code numbers. You must use the default pay code number assigned by Workforce Timekeeper.
8-22
Kronos Incorporated
10. Select the Pay code to be used as the default that is associated with the function key setting. For more information about the options listed in the Function Key Settings dialog box, click Help. 11. Click OK twice. Example A pay code is defined in Workforce Central Setup Applications. Workforce Timekeeper assigns to each pay code a number that the user enters at the device. For Series 400 devices, the pay codes are enabled only for certain supervisor functions or commands and only for Full models, such as the 480 Full model. Pay code transactions enable employees to add or subtract hours associated with a pay code. For example, after a pay code is configured as Daily-OT, the pay code hour is 2, and the labor level is configured as 101, the prompts displayed at a 480 device might be:
w
ENTER DAY 10The employee can press Enter to accept the default (today) or change the code number for day, for example 14 for the 14th of the month, and then press Enter. Unless the punch is added for either the current date or the next day, the entry is a day that has passed. For example, if the current date is the 15th of the month and the employee enters 22, the transaction edit is for the 22nd of the previous month.
ENTER HOURS 2:00The employee can press Enter to accept the default (2:00), or change the code number for the pay hour, press the AM or PM key, and press Enter. 301201101The employee can press Enter to accept the default (301 201 101), or change the pay code number for labor level and then press Enter.
8-23
Chapter 8
8-24
Kronos Incorporated
Chapter 9
Collecting Data and Managing Transactions
This chapter explains how to start data collection, manage transactions, and schedule events. This chapter contains the following sections:
w w w w w w w w w w
Enabling Data Collection Monitoring Transactions and Device Communications Collecting Transaction Input Files Processing a Transaction Input File Viewing Transactions Correcting Invalid Transactions Scheduling Events Centralized Log File Transaction Output Files Data Backups
Chapter 9
Enabling Data Collection

You can set up a system of data collection that runs automatically for a device group. You can also manually perform a one-time collection of data from a device or a device group. Devices need to be set up with the Online collection method specified for the automatic data collection method or the start data collection method to work at the device group. Before you start data collection, ensure that all configuration data is loaded to all devices in your DCM system and that the Sentinel Service is running and enabled. The Sentinel application starts data collection on devices that have been enabled for automatic data collection through their device group association. For more information about the Sentinel Service, see Chapter 10, Using the Sentinel. Note: For updating, the date and time for DCM Communication PC, devices, and database should be synchronized. If the database server time is behind the Communication PC time, when biometric data is deleted using the Workforce Timekeeper People Editor, it may or may not be deleted from the terminal when a device update is performed. Also, Employee badge data may not be updated immediately when a device update is performed. To start automatically collecting data from a device group, use one of the following three methods:
w
Use the Device Manager application. An automated process collects data from the new or edited device group. a. From the Device Manager main menu, select Setup > Device Groups. The Configure Device Groups dialog box appears. b. Click New or select a device group and click Edit. If you clicked New, enter the device group name and a description, select an application connection, click the Automatic Data Collection check box, and click Add. If you clicked Edit, click the Automatic Data Collection check box and click Update.
9-2
Kronos Incorporated
Enabling Data Collection
c. Click Close. d. Reboot. Data collection restarts automatically on the device group.
w
Use the Communication Monitor application. An automated process collects data from selected device groups until you stop data collection. a. From the Communication Monitor main menu, select Device > Start Data Collection. The Select Target to Start Data Collection dialog box appears. b. Select the device group and click Start Data Collection.
Use the Event Manager application to start data collection at a specified time in the future. Define a Start Data Collection event to start data collection from all devices in a specified device group at a specified time. See Scheduling Events later in this chapter for more information.
Collecting Data
To start collecting data from a single device or a device group, use the Communication Monitors Collect command. This is a manual process to perform a one-time collection of data from a device or a device group. This does not start an automated data collection process. 1. Select Start > Programs > Data Collection Manager > Communication Monitor. 2. From the Communication Monitors main menu, select Device > Collect. 3. Select the device or device group from which to collect data, and then click Collect. The Data Collection Manager system polls those devices for transactions and sends any transactions to the database. The use of some anti-virus software may result in degraded performance at the Communication PC during the process of data collection. Performance problems may include unacceptably high CPU and memory use. Consult your anti-virus software documentation and support to determine how to configure your antivirus software to balance protection versus performance.
9-3
Chapter 9
Monitoring Transactions and Device Communications

The Communication Monitor enables you to monitor devices and device groups and is also a means of transferring data to and from devices. The Communication Monitor initiates the transfer of punches stored in the devices and then continuously monitors transactions between the devices and host applications that manage the information. The Communication Monitor enables you to view system information such as data flow, device status, and error posting. You can use this information for troubleshooting. You can start and stop data collection from the Communication Monitor.
The Communication Monitor Window

To access the Communication Monitor window, from the Data Collection Manager main menu, select Communication Monitor. You can also click Tools to access the Communication Monitor from the Device Manager and Event Manager applications.
9-4
Kronos Incorporated
The Communication Monitor window lists the following information for each interaction between a device and the host application:
w w w w w w w w
Device response status Date and time of the last interaction Device ID Device Name Device Group Type of activity Current state of the activity Results
The following table describes the different types of messages that appear in the Communication Monitor:
Message Type Transactions Application errors Application responses Requests and results Device errors Communication errors Communication activity Display Lists all the device transactions. Lists error responses to the device transactions. Lists all the application responses to device transactions, including the successes and failures. Lists the application requests and the responses to those requests. Lists the errors on a particular device. Lists the errors that occur during device communications. Lists all the traced communications messages.
If communication to the device has not been requested, there is no status.
9-5
Chapter 9
The following table lists the Communication Monitor window drop-down menus and icons:
Dropdown Menu File View
Function/Icon Action Exit Toolbar Status Bar Refresh Exit the Communication Monitor. Display or hide toolbar. Display or hide status bar. Send registration messages to active communication channels and device groups, and updates displays. Downloads the configuration settings to the selected device or device group. Initialize clears any settings that were already in the device. Polls the devices in a selected device group and collects data. This starts a manual data collection process.
Device
Initialize
Collect
Collect Processes an existing device or group transaction input file Transaction File that resides in the kronos\wfc\dcm\data\trx folder. For more information, see the "About Transaction Input File" topic in the DCM online Help. Update Set Date/Time Updates a selected device or selected device groups by downloading changes. Sends the date and time of the Communication PC to the specified device.
Test Device Verifies whether or not communication is available between a Communications device or a device group and the DCM Communication PC. Start Data Collection Stop Data Collection Starts the data collection process for devices in a selected device group. This initiates the automatic data collection process. Stops the data collection process for devices in a selected device group. This stops the automatic data collection process.
9-6
Kronos Incorporated
Dropdown Menu Tools
Function/Icon Action Transaction Data Enables you to edit a selected transaction. For more Editor information about the Transaction Data Editor, see Viewing Transactions on page 9-13. View Transactions View Log Displays punch data. Displays a centralized log. For more information about log files, see Centralized Log File on page 9-39. Accesses the Event Manager.
Device Manager Accesses the Device Manager. Event Manager Help Help Topics
If you receive more than one Collect Complete message for a Series 4000 terminal, the terminal finished sending data, but the Collection Agent has not finished processing it. You may receive Collect Complete messages approximately every 5 seconds until the Collection Agent finishes processing, or until a processing error occurs.
9-7
Chapter 9
Collecting Transaction Input Files

Support for transaction file processing is provided by default. An option in the Communication Monitor enables you to manually collect transaction input files at the group or device level. The file name for a specific transaction input file is based on the name of the group or device. The file, group.in or DeviceId.in is located in the \dcm\data\trx directory. To manually collect transaction input files: 1. In the Communication Monitor main window, select Device > Collect Transaction File. The Select Target to Collect File dialog box appears.
2. Select the groups or devices from the drop-down list, and then highlight the groups or devices for collection. 3. Click Collect File. The transaction collection processing begins. The results appear in the Communication Monitor.
9-8
Kronos Incorporated
Processing a Transaction Input File

Transaction files contain transaction data from all devices. Communication channels for Series 400 devices and the DCM Collection Agent for Series 4000 terminals write transaction files based on the host application connection specified for the device in the active data collection group. The transaction output file is created by the communication channel or the Collection Agent for collected transactions from the device. The transaction input file is created by a user or by renaming a trx.out file to a trx.in file that is to be used for reprocessing transactions. Transaction file processing is initiated as part of a scheduled event from the DCM Event Manager or from a manual request in the DCM Communication Monitor. Collections and messages are routed directly to the application queue. Manual requests from Communication Monitor or scheduled events from Event Manager are supported for transaction input files at the device or group level. The file name for a specific transaction input file is based on the name of the device or device group. The file, DeviceId.in or group.in, must be located in the \dcm\data\trx directory. For more information about scheduling events, see Scheduling Events on page 9-17.
Loading a Transaction Input File

You can load a file that lists transactions to a device. This is a way to enter external punches into the Data Collection Manager system. Some punches are from a remote, isolated site, where it is easier to FTP a file of punches than communicate directly from a data collection device. The following sections contain information about preparations that you need to make before loading transactions to the device.
9-9
Chapter 9
Formatting a Transaction Input File

If you have a file of transactions to import into DCM, ensure that the file is formatted correctly, as follows:
Position 1 2 22 37 38 39 42 50 56 Length 1 20 15 1 1 3 8 6 1 Enter Value # This position contains the device group name for the source device. This position contains the device ID or password. This position contains the letter for the device type: D=Direct; P=Periodic. This position contains the record type identifier for the application. This position contains the transaction code for the application. (See the table on page 9-11.) This position contains the date of the transaction using the format MMDDYYYY. This position contains the time of the transaction using the format HHMMSS. This position contains a value that designates whether the transaction was created during DST (Daylight-Saving Time)? 1=Yes; 0=No. This position contains the time zone ID: 13011 Eastern Standard Time. This position contains the online response value from the application? 1=Yes; 0=No. # This position contains raw transaction data.
57 62 63 64
5 1 1
A sample file that uses the preceding format is as follows:

1234567890123456789012345678901234567890123456789012345678901234567890 #WFC Application 000001 DAA 070420021054001130110#1001###
9-10
Kronos Incorporated
Transaction Codes
The following table lists transaction codes that are listed in a transaction input file.
Record Identifier A B C D E F G H I J K L M S T V W Y Z FIFO Record Type Punch Department/Labor Transfer Supervisor Record Daylight-Saving Add a Punch Function Key Guard Record Delete a Punch Pay Code Transaction Pay Code Adjustment Quantity Transaction Tips Maintenance Record Entry Manager Event Time Stamp and Individual Message Audit Trail Activity Code Punch Gate Punch Report Count Reference Date
Location of a Transaction Input File

Support for Transaction Input (Trx In) file processing is enabled by default. You can request processing of a Trx In file for a specific device group or device by using the Communication Monitor or a scheduled event from the Event Manager.
9-11
Chapter 9
Based on the application connection and its configuration, DCM determines the routing for Trx In files for a specified device group. The associated communication channel uses this information to set up the routing from the device to the collecting group and to the application connection. The file name for a specific transaction input file is based on the name of the group or device. The file group.in or DeviceId.in is located in the \dcm\data\trx directory.
Setting Up a Transaction Output File for a Device Group

To set up a transaction output file for a device group: 1. From the Device Manager main menu, select Setup > Device Groups. 2. Click New, or select a device group and click Edit. a. If you clicked New, enter the device group name and a description, select an application connection, click the Transaction Output File check box, and click Add. b. If you clicked Edit, click the Transaction Output File check box and click Update. 3. Click Close. Based on the configuration of the selected application, DCM determines the routing for the transaction file.
9-12
Kronos Incorporated
Viewing Transactions
Viewing Transactions
The Transaction Viewer shows transaction data, the device that processed the transaction, and the total number of transactions processed. Transactions appear in descending order from the most recent to the oldest. Up to 1000 transactions can appear. If more than 1000 transactions are processed, the newest transactions appear at the top of the list and the display is refreshed to contain no more than 1000 transactions. The transaction count is updated to include all transactions. To access the Transaction Viewer, from the Communication Monitor main menu, select Tools > View Transactions. The Transaction Viewer appears and shows the raw transaction data coming from the devices.
You do not need to close the Transaction Viewer to access other DCM functions.
9-13
Chapter 9
The information that appears on the Transaction Viewer is view-only and both valid and invalid transactions appear. To determine if a transaction displayed on the viewer is an invalid transaction, access the Transaction Editor, where the invalid transactions are also listed. For more information about the Transaction Editor, see Correcting Invalid Transactions on page 9-15. Note: When the Communication Monitor is shut down, the Transaction Viewer window is shut down automatically.
9-14
Kronos Incorporated
Correcting Invalid Transactions
Correcting Invalid Transactions

When data is collected from devices, the Workforce Timekeeper application server validates each transaction. If a transaction, for example, an employees inpunch or out-punch, contains incorrect data, Workforce Timekeeper does not process the transaction. You can fix the invalid transaction information by using the Transaction Data Editor and then resubmitting the transaction. To start the Transaction Data Editor: 1. From the Communication Monitor main menu, select Tools > Transaction Data Editor. The Transaction Data Editor dialog box appears and shows the raw transaction data coming from the devices.
9-15
Chapter 9
2. In the Transaction Data Editor window, select the transaction to correct. 3. Click Edit. The Transaction Data Editor dialog box appears. The Error Report near the bottom of the Transaction Data Editor dialog box describes the invalid data. 4. Change the transaction value that caused the error. For more information about transaction values, see Appendix C, Understanding and Accessing Punch/Transaction Data. 5. When the invalid transaction is correct, click Re-submit. 6. The transaction is resubmitted to the DCM application queue for reprocessing.
9-16
Kronos Incorporated
Scheduling Events
Scheduling Events
An event is an action or task, such as a data collection, device update, or a program execution, that you schedule to run in the DCM Event Manager application. When you specify events in the DCM Event Manager, you create actions for DCM to perform at specific times. DCM performs the actions specified at the date and time that you specify. The DCM Event Manager launches your events automatically at the scheduled time. To specify an action event, refer to DCM Commands on page 9-24. To specify a program event, refer to on page 9-31. Schedule events for present and future times only. If you define an event for a past time, the DCM Event Manager disables the event. For events to run successfully, the DCM Event Manager must be running on a Comm PC and the Sentinel Service must be running and enabled. You can run multiple instances of DCM Event Manager on different Comm PCs within the same network. To access DCM Event Manager, from the Data Collection Manager main menu, select Event Manager. The DCM Event Manager main window lists events, how often each event is scheduled to run, and the schedule. You can also click Tools to access the DCM Event Manager from the Device Manager and Communication Monitor applications. The first time the Event Manager is opened, the DCM Event Manager - Untitled window, in which no event commands are loaded to the DCM Event Manger, appears by default. After that, the DCM event list that opens by default is the last event list closed.
9-17
Chapter 9
Event commands are stored in .lst files. To load an event list into Event Manager select File > Open and open the appropriate .lst file.
Caution: When you use the Event Manager, do not open any file that is not a .lst
file. The Event Manager overwrites a file in the .lst file format.
Creating a New Event List File

To create a new event list file, from the DCM Event Manager window: 1. Click File > Save As. The Save As dialog box appears. If you do not use Save As to save and name your file, but use Save after you add events, the DCM Event Manager saves the file as Event_date. 2. Specify the name of the file and include the .lst extension. 3. Click Save. The Event Manager dialog box appears with the file name included in its heading. 4. Go to the next section, Defining a DCM Command Event, to specify the DCM Command Events for the list file.
Defining a DCM Command Event

You can list separate events in a list file. You can create copies of this list file and copy it to other Comm PCs that are running an Event Manager.
9-18
Kronos Incorporated
Scheduling Events
Events are listed in the Event Manager window in the order in which they happen. The time at the bottom of the window specifies the amount of time until the next event is to run. When you define a DCM command event, you are setting up an action to run at a specified time. To define a DCM command event: 1. From the Data Collection Manager Start menu, select Event Manager. The Event Manager window opens. 2. Select Edit > Add. The Add Event dialog box appears. 3. Complete the tabs in the Event dialog box. a. On the General tab, select Execute DCM Command from the Event type drop-down list. Optionally, you can add a description of the event in the Description text box. Select the Enable Event check box to allow the event that you are creating to occur. To disable the event, clear the Enable Event check box. The default description is Execute DCM Command. You can enter a description that is closer to the actual command description, such as Collect first shift. b. On the Frequency tab, choose how often and when this event occurs. Select the frequency from the When drop-down menu, You can run the event once, or every few minutes, every few hours, or daily. Select One Time to disable the event after it has run or to remove the event from the list. Select Minutes to specify the cycle of how often the event is run, based on the amount that you enter. Select Hourly to run an event each hour and specify the number of minutes past each hour that the event runs. Specify Daily to specify that the event runs days and time that you specify. To select multiple days, hold down the CTRL key and select the appropriate days.
9-19
Chapter 9
c. On the DCM Command tab, select a command from the Command dropdown menu, and for Action, enter a parameter for the DCM command. For group commands, enter the exact name of the group. For device commands, enter the device ID. For the Connect command, enter the telephone number of the device as specified in the device configuration. Schedule a separate event for each modem connection. If more than one device shares a phone number (as in an RS-485 daisy chain of devices from a modem device), only a single event is needed. Note: Data entered on the DCM Command tab is case-sensitive. Check the syntax of the DCM event and enter the appropriate case. For information specific to DCM commands, see DCM Commands on page 9-24. The following windows show completed configuration tabs for an event with these actions:
w
The event is enabled to collect all device data from the devices in the device group called EtherGroup.
9-20
Kronos Incorporated
Scheduling Events
The event occurs every Thursday at 12:33:45 AM.
The event collects data from the Ethernet group.
Adding a Command or Run Program to an Event Manager File

To add a command or program to a list file: 1. Select Edit > Add. The Add Event dialog box appears. 2. Complete the tabs as described in Defining a DCM Command Event on page 9-18. 3. Click OK to return to the file or click Apply to add another event to the file.
9-21
Chapter 9
Deleting a Command or Run Program from an Event Manager File

To delete a command or program from a list file: 1. Select the command or program. 2. Select Edit > Cut. The edit is automatically saved when you close the file. Note: If you do not want to save the file with the deletions, select Edit > Undo before you close the file. Otherwise, all changes are saved when you close the file.
Event Manager Options

Use the Event Manager Options dialog box to specify:
w w w
The additional time that the Event Manager application waits before issuing a scheduled event The time that the Event Manager uses to determine that an event is past due Whether or not to prompt when deleting an event
To specify Event Manager display, timing, and prompt requirements: 1. From the Event Manager window, select Tools > Options. The Event Manager Options dialog box appears.
9-22
Kronos Incorporated
Scheduling Events
2. Click the Hide when iconized check box if you want to hide the Event Manager icon when you minimize the application window. If you hide the icon, you must rerun the Event Manager application to display the application again. 3. Specify, in seconds, the Timer interval that is to be added when the Event Manager application counts down to a scheduled event. For example, if you enter 180 seconds, you have enabled an Event to run every five minutes. When the timer counts down to 5 minutes, it waits an additional 180 seconds before it starts an event. If the number of seconds entered in the Timer interval text box is greater than the number of minutes entered in the Skip time span text box, the event does not start. 4. Specify, in minutes, the Skip time span that the Event Manager uses to determine if an event is past the due date to run. This is also determined by the number of seconds that is entered in the Timer interval text box. Note: If the number of seconds entered in the Timer interval text box is greater than the number of minutes entered in the Skip time span text box, the event cannot run. 5. Specify when the system is to prompt before deleting an event. Never means that no confirmation is displayed. 6. Click OK.
9-23
Chapter 9
DCM Commands
The following table lists the DCM Command events and their Action field formats. Enter the Action field entry exactly as it appears in this table. Do not use spaces. The field is case-sensitive. To execute an event, ensure that the Sentinel Service is running and enabled on the specified PC. For example, if you define an event to start collecting data at 1:00 A.M., the Sentinel Service must be active at that time.
Event Command Collect Action Field Entry The Device Group name:Device ID; for example, Accounting:000001, where Accounting is the group name and 000001 is the device ID. Description Retrieves data from one or more devices connected to a single modem by using the modems telephone number. For example, you collect data from all devices connected to a modem whose telephone number is 1-222-555-1212 daily at 9:00 A.M. The communication channel for these devices must be on the same PC as the Event Manager. Sends a request to the DCM Collection Agent running on the comm PC to process a transaction input file for the specific device. The transaction input file is enabled by default. Retrieves data from devices in a specified device group. This applies to both online and batch devices. For example, you collect data from your finance device group daily at 6:00 A.M. The event specifies the device group.
CollectFile
The Device Group name:Device ID; for example, Accounting:000001, where Accounting is the group name and 000001 is the device ID.
CollectGroup
Device Group name; for example, Finance.
9-24
Kronos Incorporated
Scheduling Events
Event Command CollectGroupFile
Action Field Entry Device Group name; for example, Finance.
Description Sends a request to the DCM Collection Agent on the Communication PC to process a transaction input file for the specified group. The transaction input file is enabled by default. Retrieves data from one or more devices connected to a single modem by using the modems telephone number. For example, you collect data from all devices connected to a modem whose telephone number is 1-222-555-1212 daily at 9:00 A.M. The communication channel for these devices must be on the same PC as the Event Manager. Sends the device configuration data selected in download options, DCM and application, to the specified device. Includes biometric data if selected in Download Options.
Connect
The Device telephone number that is specified in the device configuration; for example, 1-222-555-1212.
LoadDevice
Device Group name:Device ID, or Device ID
LoadDeviceActivity Codes LoadDeviceComment Codes LoadDeviceConfiguration
Device Group name:Device ID, or Device ID Device Group name:Device ID, or Device ID Device Group name:Device ID, or Device ID Device Group name:Device ID, or Device ID
Sends only Activity Codes to the specified device. Sends only Activity Codes to the specified device. Sends only device configuration data to the specified device. Sends the device job transfer set to the specified device.
LoadDeviceDeviceJob TransferSet
9-25
Chapter 9
Event Command LoadDeviceEmployees LoadDeviceEmployees BiometricData LoadDeviceEmployees JobTransferSets LoadDeviceEmployees NoSchedules LoadDeviceEmployees Totals LoadDeviceFile
Action Field Entry Device Group name:Device ID, or Device ID Device Group name:Device ID, or Device ID Device Group name:Device ID, or Device ID Device Group name:Device ID, or Device ID Device Group name:Device ID, or Device ID Device Group name:Device ID:File name (full path name), or Device ID:File name (full path name)
Description Sends all employee-specific data to the specified device. Sends the employee and biometric data to the specified device. Sends the employee job transfer set to the specified device. Sends employees without their schedules to a single device. Sends employee totals to a single device. Sends the specified AFT or XML file to the specified device.
LoadDeviceFirmware
Device ID:File name (full path name) Sends the specified file containing the firmware to the specified device. Device Group name:Device ID, or Device ID Device Group name:Device ID, or Device ID Device Group name:Device ID, or Device ID Device Group name:Device ID, or Device ID. Note: Restriction profiles and terminal rules are equivalent terms and depend on the host application supported. Sends Labor Levels to the specified device. Sends only Labor Levels with No Reference Text to the specified device. Sends pay codes to the specified device. Sends Restriction Profiles to the specified device.
LoadDeviceLaborLevels LoadDeviceLaborLevelsNo RefText LoadDevicePayCodes LoadDeviceRestriction Profiles
9-26
Kronos Incorporated
Scheduling Events
Event Command LoadGroup
Action Field Entry Device Group name
Description Sends the device configuration data selected in download options, DCM and application, to all the devices in the specified device group. Includes biometric data if selected in Download Options.
LoadGroupActivity Codes LoadGroupComment Codes LoadGroup Configuration LoadGroupDeviceJob TransferSet LoadGroupEmployees
Device Group name Device Group name
Sends Activity Codes to all devices in the specified group. Sends the Comment Codes to all devices in the specified group. Sends device configuration data to all devices in the specified group. Sends the device job transfer set to all devices in the specified group. Sends all employee-specific data to all the devices in the specified device group. Sends the employee and biometric data to all devices in the specified group. Sends employee job transfer sets to all devices in the specified group. Sends employees with no schedules to a group of devices. Downloads totals and accruals for all employees for the specified device group.
Device Group name
Device Group name
Device Group name
LoadGroupEmployees BiometricData LoadGroupEmployeesJob TransferSets LoadGroupEmployeesNo Schedules LoadGroupEmployees Totals
Device Group name
Device Group name
Device Group name
Device Group name
9-27
Chapter 9
Event Command LoadGroupFile
Action Field Entry Device Group name:File name (full path name)
Description Sends the specified AFT or XML file to all devices in the specified device group. The group must contain compatible devices; for example, all Series 4000 or all Series 400. Sends the version of firmware to all devices in the specified group. Sends Labor Levels to all devices in the specified group. Sends only Labor Levels with No Reference Text to all devices in the specified group. Send Pay Codes to all devices in the specified group.
LoadGroupFirmware
Device Group name:File name (full path name) Device Group name Device Group name
LoadGroupLaborLevels LoadGroupLaborLevels NoRefText LoadGroupPayCodes LoadGroupRestriction Profiles
Device Group name Device Group name
Sends only Restriction Profiles Note: Restriction profiles and terminal to all devices in the specified rules are equivalent terms and depend group. Note: Restriction profiles and on the host application supported. terminal rules are equivalent terms and depend on the host application supported. Device Group name:DeviceID or Device ID Device Group name Sends the date and time of the comm PC to the specified device. Sends the date and time of the comm PC to all devices in the specified device group.
SetDateTime
SetDateTimeGroup
9-28
Kronos Incorporated
Scheduling Events
Event Command StartDC
Description Collects data from all devices in a specified device group. This applies only to online devices. For example, you start data collection from all devices in your accounting device group daily at 12:00 A.M.
StopDC
Device Group name.
Stops data collection for a specified device group. This applies only to online devices. For example, you stop data collection on the accounting device group at 1:00 A.M. Sends changed application data specified in the download options to the specified device. Includes biometric data if selected in Download Options.
UpdateDevice
Device Group name:Device ID, or Device ID.
UpdateDeviceEmployees
UpdateDeviceEmployees Device Group name:Device ID, or Device ID.
Sends changed employee data, including schedules, to the specified device. Sends changed employee data for employees without their schedules to the specified device. Sends the changed application data specified in download options to all devices in the specified device group. Includes biometric data if selected in Download Options.
UpdateDeviceEmployeesNo Schedules
UpdateGroup
Device Group name
9-29
Chapter 9
Event Command UpdateGroupEmployees
Description Sends changed employee data, including schedules, to all devices in the specified device group. Sends changed employee data for employees without their schedules to all devices in the specified device group.
UpdateGroupEmployeesNo Schedules
The following commands are supported by previous versions of the Data Collection Manager; they are supported in Version 5.0 for backward compatibility. A domain is a device group.
Event CollectDomain Description Retrieves data from modem devices in a specified domain. For example, you collect data from your finance domain daily at 6:00 A.M. The event specifies the domain Sends all device configuration data, DCM and application, to all the devices in the specified domain. Sends only Activity Codes to all devices in the specified domain. Sends only device configuration data to all devices in the specified domain. Sends all employee-specific data to all the devices in the specified domain. Downloads totals and accruals for all employees for the specified domain. Sends the specified AFT or XML file to all devices in the specified domain. The domain must contain compatible devices, for example all Series 4000 or all Series 400. Sends Labor Levels to all devices in the specified domain. Sends only Labor Levels with No Reference Text to all devices in the specified domain.
LoadDomain LoadDomainActivity Codes LoadDomain Configuration LoadDomainEmployees LoadDomainEmployees Totals LoadDomainFile
LoadDomainLaborLevels LoadDomainLaborLevels NoRefText
9-30
Kronos Incorporated
Scheduling Events
Event LoadDomainLRestriction Profiles SetDateTimeDomain UpdateDomain UpdateDomainEmployees UpdateDomain EmployeesNoSchedules
Description Sends only Restriction Profiles to all devices in the specified domain. Note: Restriction profiles and terminal rules are equivalent terms and depend on the host application supported. Sends the date and time of the comm PC to all devices in the specified domain. Sends changed application data to all devices in the specified domain. Sends changed employee-specific data to all devices in the specified domain. Sends changed employee data for employees without their schedules to all devices in the specified domain.
Events and Download Options

DCM events send information from the database to devices when the event performs an initialize or an update. The data that the system downloads varies according to the event selected. The following table lists the Initialize events and the download options for each event. The asterisk (*) means that you must select the download option from the Download Options dialog box for the data to be sent to the device. For all other events, the Event Manager ignores whatever is selected in the Download Options dialog box. It sends whatever you see in the Download Options column in the table.
9-31
Chapter 9
DCM Initialize Events LoadDevice LoadGroup
Download Options Employees* Biometric Data* Schedules* Restrictions* Totals* Labor Levels* Activities* Device Configuration* Comments* Pay Codes* Device Job Transfer Set* Employee Job Transfer Sets*
LoadDeviceActivityCodes LoadGroupActivityCodes LoadDeviceConfiguration LoadGroupConfiguration LoadDeviceEmployees LoadGroupEmployees LoadDeviceEmployeeBiometricData LoadGroupEmployeeBiometricData LoadDeviceEmployeesNoSchedules LoadGroupEmployeesNoSchedules LoadDeviceEmployeesTotals LoadGroupEmployeesTotals
Activities Device Configuration Employees Schedules Restrictions Employees Biometric Data Employees Restrictions Employees Schedules Restrictions Totals
LoadDeviceEmployeeJobTransferSets LoadGroupEmployeeJobTransferSets
Employee Job Transfer Sets
9-32
Kronos Incorporated
Scheduling Events
DCM Initialize Events LoadDeviceJobTransferSet LoadGroupJobTransferSet LoadDeviceLaborLevels LoadGroupLaborLevels LoadDeviceLaborLevelsNoRefTxt LoadGroupLaborLevelsNoRefTxt LoadDeviceRestrictionProfiles LoadGroupRestrictionProfiles
Download Options Device Job Transfer Sets Labor Levels Labor Levels (No text) Restrictions
The following table lists the Update events and the download options for each event. The asterisk (*) means that you must select the download option from the Download Options dialog box for the data to be sent to the device. For all other events, the Event Manager ignores whatever is selected in the Download Options dialog box. It sends whatever you see in the Download Options column in the table.
DCM Update Events UpdateDevice UpdateGroup UpdateDeviceEmployees UpdateGroupEmployees UpdateDeviceEmployeesBiometricData UpdateGroupEmployeesBiometricData UpdateDeviceEmployeesNoSchedules UpdateGroupEmployeesNoSchedules Download Options Employees* Schedules* Restrictions* Employees Schedules Restrictions Employees Biometric Data Employees Restrictions
9-33
Chapter 9
UpdateDevice and UpdateGroup uses the download options configuration for each device. If no download options are selected that can be updated, this event does not update the configurations. By specifying the UpdateDevice or UpdateGroup event, you must also set the appropriate download options. UpdateDeviceEmployees and UpdateGroupEmployees update the employees with schedules regardless of the download options. By specifying the UpdateDeviceEmployees or UpdateGroupEmployees event, you do not need to set the download options. UpdateDeviceEmployeesNoSchedules and UpdateGroupEmployeesNoSchedules update the employees without schedules regardless of the download options.
Defining a Program Event

When you define a program event, you are setting up an external file to run at a specified time. To define a program event: 1. From the Data Collection Manager Start menu, select Event Manager. The Event Manager window opens. 2. Select Edit > Add. The Add Event dialog box appears. 3. Complete the tabs in the Event dialog box. a. On the General tab, select Run Program from the Event type drop-down list. Optionally, you can add a description of the program in the Description text box. Select the Enable Event check box to allow the program event that you are creating to occur. To disable the event, clear the Enable Event check box. The default description is Execute DCM Command. You can enter a description that is closer to the actual program description.
9-34
Kronos Incorporated
Scheduling Events
b. On the Frequency tab, choose how often and when this event occurs. Select the frequency from the When drop-down menu, You can run the event once, or every few minutes, every few hours, or daily. Select One Time to disable the event after it has run or to remove the event from the list. Select Minutes to specify the cycle of how quickly the event is run, based on the amount that you enter. Select Hourly to run an event each hour and specify the number of minutes past each hour that the event runs. Specify Daily to specify that the event runs days and time that you specify. To select multiple days, hold down the CTRL key and select the appropriate days. c. On the Run Program tab, enter the command name to execute the external program, enter the path for the program entered in the Command line that the Event Manager is to execute, and select the Run style from the dropdown list. Normal runs the program as it normally would in the host application, Minimized minimizes the program while it is running, and Maximized maximizes the program while it is running so that it displays a full screen. Note: Data entered on the Run Program tab is case-sensitive. Check the syntax of the DCM program event and enter the appropriate case.
9-35
Chapter 9
The following windows show completed configuration tabs for a program event with these actions:
w
The event is enabled to execute a backup program.
The event occurs every Thursday at 12:33:45 AM.
9-36
Kronos Incorporated
Scheduling Events
The event executes the update program in the scripts directory. When the program is run the program icon appears in the task bar.
9-37
Chapter 9
Using the Sentinel Service to Automatically Start the Event Manager

When the Sentinel Service is started, it starts the applications and communication channels that it detects on your system. It also starts the Event Manager if automatic startup is set for Event Manager in the System Settings. To launch Event Manager automatically from the Sentinel Service: 1. From the Device Manager, select Setup > System Settings. 2. On the System Properties tab, select the Start Event Manager with Sentinel check box. 3. Click OK. For more information about using the Sentinel Service, see Chapter 10, Using the Sentinel. For more information, see System Settings on page 4-42.
9-38
Kronos Incorporated
Centralized Log File

The centralized log file combines all log messages from all the DCM applications into one file. These messages report both errors and normal information about operations and DCM actions. DCM provides and maintains a centralized log message file that provides an audit trail that acts as a useful diagnostic tool. You set the log file reporting levels in the Device Manager. The centralized log generated by DCM applications is limited in size and number. For more information about configuring the log file properties, see Log File Settings on page 4-45. The centralized log file displays the flow of transactions within the local Communication PC. It does not display transactions for any other Communication PC. You can access the Log Viewer from any DCM application by selecting Tools > View Log.
Log File Viewer

The Log Viewer enables you to browse to select a centralized DCM log file, open the file, and display related information. For more information about configuring log file properties, see Log File Settings on page 4-45. To view the log messages in the DCM log file: 1. In either the Communication Monitor or the Device Manager, select Tools > View Log. The Log Viewer dialog box appears.
9-39
Chapter 9
2. In Log File Name, select the browse button to display the available DCM.log files. The Select Log File dialog box appears. 3. Select the appropriate DCM.log file to view and click Open. The Log Viewer displays the log file information. The following Information for each log message can appear: w Date and Time w Log Context w Log Level w Caller Identifier w Log Message
9-40
Kronos Incorporated
You can specify that the information be filtered so that only certain information is displayed. To specify which log messages are displayed based on a specific column-level attribute: 1. From the Filter Column drop-down list, select a column label (All, Date, Date Time, Log Context, Log Level, Caller Identification, or Log Message). If you select All, no filtering is done and the Look for field is not available. 2. In the Look for text box, enter the column entry that is to be used in the filtered search. For example, if you chose Log Context in the Filter Column drop-down list, you could enter DCM.UTILITYLIBRARY text box. Entries in the Look for text box are case-sensitive. 3. Click Find Now. The log file displays the filtered information. For example, Log Context and Log Level entries must all be in capital letters, Caller Identifier for Sentinel displays DCM.SENTINEL log messages and Context for Sentinel displays DCMUTILITYLIBRARY log messages. The Log View displays the number of records found.To view the entire log message, click on the message. The Details area displays the date and time, the Log Context, the Caller Identifier, the Log Level, and the entire message.
Log File Format

The following row of numbers represent the character positions (index) for the format of each line in the log file:
1234567890123456789012345678901234567890123456789012345678901234567890123456789012345 678901234567890123456789012345678901234567890........ Date Time ;SourceOfMessage ;LogLevel; CallerIdentifier ; MessageText Date Time ;SourceOfMessage ;LogLevel;CallerIdentifier ; MessageText
The following example is a Net Check request status message that was posted to the log file:
01/05/2004 14:23:07; DCM.APILIBRARY; INFO; commclnt2.exe:Ether2; Ether2:DCMSERVER2K Net Check 111 111111 0#Operation complete#Operation complete
9-41
Chapter 9
A log file contains the following entries:

Entry Date Time Description Month, day, and year in mm/dd/yyyy format; and the time in hours, minutes, and seconds in hh:mm:ss (24-hour) format when a message was posted to the log file. The DCM module identifier (application or library) from which this message is being logged. Log level setup for the calling application (INFO, WARNING, ERROR, or DEBUG).
Source of Message Log Level
Caller Identifier Calling DCM application name that is logging this message. For example, commclnt.exe, appclnt.exe,
SentinelService.exe, and so on.
Message Text
Message information, which depends on the type of the message.
The message for Net Check request example is logged from the Comm channel Ether' (shown by Caller Identifier as Commclnt.exe) as the INFO (information) message. The DCM module that wrote the message is the DCM API library (shown by Source of Message DCM.APILIBRARY).
9-42
Kronos Incorporated
Transaction Output Files

DCM provides transaction output files that record all transactions.When you create a device group, you enable or disable transaction output files. A transaction output file stores all collected transactions for the device group. Over time, the accrual of information in the transaction output file causes the file to grow in size as each transaction request is added to the file. To limit the size of transaction output files, use the Device Manager to specify the maximum size for the transaction output files. For more information about enabling transaction output files, see Creating Device Groups on page 4-7 or the description of using the Device Wizard on page 4-13. For more information about setting the transaction output file rollover size, see System Settings on page 4-42. A transaction output file contains the following information for each transaction:
w w w
Date and Time Source Type String- type of message
Because the file records all transactions, use it as an audit trail. For example, assume that your database shows that an employee did not log in this morning. The employee claims to have logged in at 7:30 A.M. By checking the log file, you determine if the punch is there, indicating that the employee logged in and DCM collected the punch. You can then use the log file to determine why the application did not receive notification of the login. In this manner, you are using the log file as a diagnostic tool. Note: Disable the Sentinel Service before archiving and purging transaction files. This prevents transactions from occurring during this procedure. After modifying or purging a transaction file, restart the Sentinel Service to ensure that it monitors for the new modifications. For example, it may be necessary to restrict overtime. Use the Start DC and Stop DC actions to prevent when an employee can punch in and out.
9-43
Chapter 9
Transaction Output File Format

The following table defines the format of transaction output files:
Offset 0 1 21 36 37 38 41 49 55 56 61 62 63 Length Field 1 20 15 1 1 3 8 6 1 5 1 1 cStatus Domain DeviceId Type Key Date Time DST Timezone Online Delimiter Data Comments Character number Domain (Group) for source device Native 6-digit address of device Record type identifier (implementation defined) Transaction Key (previously, Transaction Code) Trx Date MMDDYYYY Trx Time HHMMSS Trx created during DST (1 or 0) Timezone ID Online indicator (1 or 0) Field delimiter for Data Beginning of Data (format depends on Type and Key)
DeviceType Type of device (P)eriodic, (D)irectConnect, and so on
Transaction Output File Example Format
01234567890123456789012345678901234567890123456789012345678901234567890 || | ||| | | || ||| #CA: Plant 132 10456 DAA 122519951530121 43950#|<--- Data begins
Transaction Output File Examples The following examples are based on different supported transaction types from the devices. The format of the Data field is different starting from offset 63, based on the transaction types. The format depends on the order of the data fields that
9-44
Kronos Incorporated
were received as part of the transactions from the devices. For more information about the transaction formats, see the device documentation.
#Group 1 061228 PAA 062620021322001130110#1# #Group 1 061228 PBB 062620021322001130110#2001#301|201|101#0#1# #Group 1 061228 PGG 062620021323001130110#98#9#2001# #Group 1 061228 PLL 062620021324001130110#+#675#2001#3 #Group 1 061228 PII 062620021331001130110#98#6385#0#+#300#0#2#2001#301|201|101# #Group 1 061228 PEE 062620021332001130110#98#6385#812#2001#5#301|201|101# #Group 1 061228 PVV 062620021335001130110#1#2001#6#0#301|201|101# #Group 1 061228 PVV 062620021336001130110#0#2001#7#0#301|201|101# #Group 1 061228 PCC 062620021341001130110#2#0# #Group 1 061228 PKK 062620021341001130110#2#6385#821#+#550#1#2001 #Group 1 061228 PCC 062620021342001130110#2#1# #Group 1 061228 PCC 062620021342001130110#2#0# #Group 1 061228 PEE 062620021342001130110#2#6385#822#2001# #Group 1 061228 PHH 062620021343001130110#2#6385#823#2001# #Group 1 061228 PJJ 062620021343001130110#2#6385#823#300#1#2#2001
9-45
Chapter 9
Data Backups
Properly configuring your system is one of the most important things you do to ensure maximum performance. In addition, be sure to back up your data and your system regularly to ensure data integrity. All DCM data is contained in the host application unless it is a standalone systemDCM is included in the host application backup. For more information on backing up data in your application, see your application documentation.
9-46
Kronos Incorporated
Chapter 10
Using the Sentinel
This chapter provides an overview of the Sentinel and its functions. This chapter contains the following sections:
w w w
Overview Sentinel Status Monitoring Providing Enhanced Database Connection Support
Chapter 10
Using the Sentinel
Overview
The Sentinel is always running when the Data Collection Manager system is in operation. You can disable or enable from the Sentinel icon on the system tray or on the Sentinel status window. The Sentinel launches and manages the application connections and communication channel connections. If any of these processes stop, the data flow is interrupted. You can use the Sentinel to verify that these processes are running. Every DCM communication desktop in the system has a Sentinel process running on it. Windows 2000, Windows NT, and Windows XP can launch the Sentinel as a Windows NT service. This ensures that the Sentinel remains running when you log off the machine. For more information, see Providing Enhanced Database Connection Support on page 10-12. The Sentinel performs the following tasks:
w w w w
Manages all the communication channels configured for processing on the given system Manages all the application connections configured for processing on the given system Provides enhanced database connection support Monitors the DCM State Manager, which is a troubleshooting tool designed for Kronos Global Support personnel
The Sentinel application starts the following processes:

w w
The communication channels and application connections. Data collection on devices that are enabled for automatic data collection through their device group association. The communication channel determines which devices have been enabled.
The application client, which is managed by the Sentinel, requires access to the Workforce Timekeeper server during startup. If the server is not available, the application client keeps punches in a .q or .qin file.
10-2
Kronos Incorporated
Sentinel Status Monitoring

The Sentinel performs the following steps to manage the communication channels configured for processing on a specified system:
w w w w
Starts the communication channels Monitors the communication channels Stops the communication channels Processes external messages
To manage the application connections, the Sentinel:

w w w
Establishes the application connections Monitors the application connections Disconnects the application connections
Sentinel Startup
When the Sentinel starts up on a system, it launches all the communication channels configured for processing on that system, by using the following process: 1. The Sentinel queries the CommPC field in the DCMCommChannel table in the DCM database. 2. If the CommPC field contains the current system name or is configured for local processing, the Sentinel starts the communication channel by launching the proper communication channel executable with the channel name. The executable is either commclnt.exe for Series 400 devices or commclnt2.exe for Series 4000 devices. Communication channel executables run in the background and do not present any user interface.
10-3
Chapter 10
Using the Sentinel
Note: Before any of the DCM applications can run, the Workforce Timekeeper server must be running, and it may take up to 10 minutes or more to be ready. Start the Sentinel after that. If you start the Sentinel too soon, DCM applications send a warning and waits for the Web server to start. When the Sentinel starts, it establishes all the application connections configured for the local system, using the following process: 1. The Data Collection Manager determines on which system the application processing launches. DCM determines this by checking the application mappings in the device group configuration. The Sentinel starts the application connection by launching the application client executable with the application connection name. 2. For each application connection, an application client starts processing all application messages. The application-specific connection library processes all DCM messages for a given application. The application-specific connection library validates and posts the DCM messages, including punches and transactions, to the application clients database.
Monitoring Communication Channels and Application Connections

When the Sentinel starts, it appears as an icon on your system tray, in the lowerright corner of your screen.
Sentinel icon
10-4
Kronos Incorporated
To display the Sentinel drop-down list, right-click the icon:

w
Disable shuts down the Sentinel. If you disable the Sentinel, the icon displays a red ball with a white x in it on the Sentinel icon. Moving from disabled to enabled may take a few seconds because the Sentinel restarts all the communication channels. If the Sentinel is disabled, Disable changes to Enable, which you can click to start the Sentinel. Status displays the current status of the DCM system and DCM processes.
Displaying the Status of the DCM System and DCM Processes To display the status of the application and communication channel processes that are configured on the local system: 1. Right-click the Sentinel icon and be sure that the Sentinel is enabled. 2. Click Status. The Sentinel Service Status window appears. You can also Double-click the Sentinel icon to see the current status. By default, Sentinel updates the display every 60 seconds.
10-5
Chapter 10
Using the Sentinel
The information that appears on the Status section of the Sentinel Service Status window is for viewing only and cannot be edited. The Process Names appear. A check mark in front of a process name indicates that the application is running and no identified problems are associated with the application. Each process is either Running or Not Running. The System Status display uses symbols about the system status. A yellow triangle with an exclamation point in front of the process name is a warning sign. The following error messages appear with a red x:
w w
Disk space low. Shutting down all Communication Channels, Application Connections and DCM Core Service appears when the disk space is too low. Unable to establish a connection to the database appears when the database connection was lost or was never established.
10-6
Kronos Incorporated
w w w w
Sentinel Service is not ready appears when the service was started but was not completed due to an error. Please wait while the Sentinel Service is stopping appears when you click Disable. Please wait while the Sentinel Service is starting appears when you click Enable. The Sentinel has been disabled appears when the Sentinel Service is not running.
To view the other Sentinel error messages that appear in the DCM centralized log, click View Log. To change the user ID and password settings for database log on, click Properties. To disable the Sentinel, click Disable. To enable the Sentinel, click Enable. Moving from one state to the other may take a few seconds. Note: Disable and Enable on the Sentinel Status window disables or enables Sentinel, not a communication channel nor a DCM application.
10-7
Chapter 10
Using the Sentinel
Sentinel Shutdown
When the Sentinel shuts down, it shuts down all the communication channels that it started on the local system, by using the following process: 1. The Sentinel retrieves a list of all communication channels running on the Communication PC. 2. The Sentinel posts a DCM request to shut down the channel. 3. If a communication channel is processing when it receives a shutdown request, it finishes processing the request, and then shuts down.
Disconnecting DCM Application Connections During Shutdown

When the Sentinel shuts down, it posts a Windows message to each application client to shut down and continues its shutdown processing.
Processing External Start and Stop Requests

The Device Wizard and Device Manager applications post requests to the Sentinel to modify the status of communication channels. When you modify a communication channel or change a list of devices, the application sends a request to stop and start, or start the specified communication channel. The Sentinel then processes that request.
Monitoring Host Application Connections

The Sentinel Status window lists the status of the host application connections. The Sentinel looks at the internal application connection status within the Sentinel process. By default, updates of the current information occur every 60 seconds. During this monitoring loop, the Sentinel checks for application connections configured on the local system that need to be started or stopped. Note: An application runs only if a connection library is assigned for the host application.
10-8
Kronos Incorporated
Monitoring Transactions to the Host Application In certain host applications, the Application Status dialog box appears for the application client when the Sentinel is started. Use this dialog box to determine if transactions or punches entered at the device and sent to the host applications database are valid or invalid. The Transaction Processed area of the dialog box contains the total number of transactions and the number of successful transactions. This is an example of the Application Status dialog box for the Workforce Timekeeper application before any transactions are processed.
Interpret these processed transactions as follows:

w w
If the number of Successful transactions and the number of Total transactions are the same, all transactions are valid transactions. If the number of Successful transactions is fewer than the number of Total transactions, some transactions are not valid transactions. You view and correct invalid transactions in the Transaction Data Editor, from the Communication Monitor. For information, see Viewing Transactions in Chapter 9. To reset the transaction count, click the yellow icon and select Reset Transactions Processed from the drop-down list.
10-9
Chapter 10
Using the Sentinel
Managing the Event Manager

The Event Manager is responsible for configuring and launching scheduled events on a given Communication PC. You can define events that the Event Manager starts at a given time against specific devices and device groups. To launch Event Manager automatically from the Sentinel Service: 1. From the Device Manager, select Setup > System Settings. 2. On the System Properties tab, select the Start Event Manager with Sentinel Service check box. 3. Click OK. This setting causes the Sentinel Service to start the Event Manager as part of its startup process. The Event Manager is started after all the communication channels and application connections have been launched. When the Sentinel Service is shut down, a Windows message is posted to the Event Manager to shut down. If the Sentinel Service detects a database disconnection, a message is posted to the Event Manager to shut down. When the Sentinel Service detects that the database connection is back, it restarts the Event Manager.
Shutting Down and Restarting the Sentinel Service

Avoid shutting down the Sentinel Service except for database conversions, database backups, and software updates. If you decide to back up your system: 1. Shut down the Sentinel Service. 2. Back up your database. 3. Restart the Sentinel Service. Shutting down the Sentinel Service halts communication between the devices and the host applications. Shutting down the Sentinel Service stops data collection on your Communication PC.
10-10
Kronos Incorporated
Shutting Down the Sentinel Service To shut down the Sentinel Service: 1. Right-click the Sentinel icon in the lower-right corner of the desktop to display the Sentinel menu. 2. Click Disable. Restarting the Sentinel Service To restart the Sentinel Service: 1. Right-click the Sentinel icon in the lower-right corner of the desktop to display the Sentinel menu. 2. Click Enable. Note: Before any of the DCM applications can run, the Workforce Timekeeper server must be running, and it may take up to 10 minutes or more to be ready. Start the Sentinel Service after that. If you start the Sentinel Service too soon, DCM applications send a warning and waits for the Web server to start.
10-11
Chapter 10
Using the Sentinel
Providing Enhanced Database Connection Support

Often the DCM Communication PC is located in an area that does not have constant user attention. If problems arise on the communication side, the DCM system tries to resolve these issues internally. The following sections explain how to set up preventive methods.
Retrying Connections to the Database

When the Sentinel Service starts, it requires a connection to the database. No communication channels or application connections start without this connection. At startup, the Sentinel Service attempts to connect to the database by using the predefined DCM data source. If this connection is not established, the Sentinel Service retries to connect after a fixed amount of time. When this time expires, the Sentinel Service lists an error on the screen and in the log. The Sentinel Service constantly accesses the database during its monitoring operations. If the database connection is lost during this processing, the Sentinel Service shuts down all DCM application connections and communication channels. During this period of time, a message appears in the Sentinel window indicating that the Sentinel Service was unable to establish a connection to the database. The Sentinel window does not display any status for communication channels or applications when a database connection was not established. Sentinel Service requires the database connection to determine which application clients and communication clients should be running on its communication PC. The Sentinel Service has a thread that tries to reconnect to the database. This thread attempts a connection, waits 60 seconds, and then retries. When the connection is reestablished, the Sentinel Service restarts the DCM application connections, communication channels, and if configured, automatic data collection and the Event Manager.
10-12
Kronos Incorporated
Chapter 11
Loading Files and Data to and from a Device
This chapter explains how to send files, data, and firmware to a device. This chapter contains the following sections:
w w w w w w w w w w w
Overview of Softload and Load Firmware Upgrading the Firmware in Series 4000 Terminals Performing a Series 4000 Firmware Upgrade Performing a Series 400 Firmware Upgrade Re-initializing after Performing a Softload Loading Device Parameter Files Extracting a Parameter File Importing a Parameter File Exporting a Parameter File Synchronizing the Date and Time on the Communication PC with All Devices Series 4000 Terminal Device Report
Chapter 11
Overview of Softload and Load Firmware

The software that resides on a device is referred to as firmware. The process of upgrading the firmware in devices is called the softload process for Series 4000 terminals. For all other devices, this process is called load firmware. For information about loading firmware to other devices, see Performing a Series 400 Firmware Upgrade on page 11-7. The upgrade process is a communication protocol between the Data Collection Manager (DCM) system and the device that initiates and controls the upgrade process. DCM performs a Batch collect of all uncollected punches from the devices firstin-first-out (FIFO) punch memory before the download process begins.
11-2
Kronos Incorporated
Upgrading the Firmware in Series 4000 Terminals
Upgrading the Firmware in Series 4000 Terminals

The process of upgrading the Series 4000 terminal to the latest firmware version includes softloading, or transferring, the latest firmware to the terminal, and then re-initializing the terminal to restore its data. Terminal firmware is packaged in a file that is named to indicate the version number of the firmware, and with the file extension krm. Upgrade your terminals to the latest firmware version so that you can take advantage of the latest terminal features. Note the following important information about the upgrade process:
w
Before you perform the softload procedure, contact your Kronos Service Representative or refer to the customer support section of www.kronos.com to ensure that you obtain the latest version of the firmware. You can softload firmware to multiple device groups simultaneously. However, if a device group consists of a combination of Series 4000 and Series 400 terminals, you must select only the Series 4000 terminals within the device group. You use the Device Manager in Data Collection Manager (DCM) to perform the softload process. DCM sends a command to collect all uncollected punches from the terminal before the softload process begins. DCM initiates and controls the softload process with the Series 4000 terminal. The terminal displays a message indicating that a softload is in progress. You cannot enter any information at the terminal while the softload is in progress. When performing a Softload by using a Citrix or Microsoft Terminal Services client or console session, the softload file, for example, 02.00.00.00.KRM, must be located on a local, unmapped drive on the DCM Communications PC, for example, C:\. The Softload fails if the softload file is located on a network drive. The softload process restarts the Series 4000 terminal and removes all data except communication settings from the terminal. After the softload process finishes, use DCM to restore all terminal configuration settings, the date and time, and employee data to the terminal. Employees cannot use the terminal until the terminal has been initialized with employee data.
11-3
Chapter 11
Caution: To ensure a successful softload, do not reboot the terminal while it is in Softload mode, and ensure that a constant network connection is established with the terminals to which you will softload the firmware.
Do the following steps before softloading new firmware to your Series 4000 terminal:
w w
Verify that the Data Collection Manager Sentinel has been launched and that all Series 4000 communication channels are running. Plan the best time to upgrade the terminal firmware with the following in mind: If you use punch restriction rules at the Series 4000 terminals, plan to perform the softload procedure between shifts, if possible, to avoid employees having problems with punch restrictions after you initialize the terminal. (You need to manually initialize the terminals after the softload process finishes. Instructions for initializing the terminals are presented later in this section.) The amount of time it takes DCM to softload (transfer) the firmware to a Series 4000 terminal varies. If the terminals are equipped with the Kronos Touch ID verification terminals, the process may take longer. After the firmware is softloaded, the terminals reboot themselves. The reboot process generally takes 4 to 5 minutes to complete. The process of re-initializing the terminal may take several minutes, depending on the processing power of the computer; and the amount of data that Data Collection Manager must query, generate, and send to the Series 4000 terminal. Also, initialization takes longer for terminals that use modem communication than it does for terminals using Ethernet communication.
11-4
Kronos Incorporated
Performing a Series 4000 Firmware Upgrade

The Series 4000 firmware upgrade process consists of at least two tasks:
w w
Performing the softload of firmware to the Series 4000 terminals Manually re-initializing the terminals
If any of your Series 4000 terminals are equipped with the Kronos Touch ID finger scan verification terminal, you must also send finger scan templates to the Series 4000 terminals after you have softloaded the firmware and re-initialized the terminals. DCM 5.0 supports Touch ID version 2.0.
Performing a Softload
To perform a Series 4000 terminal softload: 1. If you are upgrading from version 1.x to version 2.0, be sure to perform the steps described in the Series 4000 Terminal Users Guide. 2. If you upgrading version 2.0 to include thin client functionality, refer to the Series 4000 Terminal Users Guide. 3. If your Series 4000 terminals are equipped with Kronos Touch ID finger scan verification terminals, collect the finger scan templates from all the terminals that you will upgrade with new firmware. 4. Access the DCM Device Manager application. 5. Select one or more Series 4000 terminals or device groups that contain only Series 4000 terminals from the left pane of the Device Manager window. 6. If you select a device group that consists of a combination of Series 4000 and Series 400 devices, you must select only the Series 4000 terminals within the device group. Select Communications > Advanced > Load Firmware.
11-5
Chapter 11
7. In the Load Firmware Name dialog box, complete the following steps: a. In the File of types text box, ensure that *.krm is selected. b. Browse to select the appropriate .krm file that you received from Kronos Global Support. c. Click Open. DCM begins softloading the firmware to the Series 4000 terminal or device group that you selected.
11-6
Kronos Incorporated

DCM enables you to load firmware to a device. Firmware always has one of the following extensions, based on the type of device:
w w w w
.KRE186 mainboard device program .KRShandheld device program .KRN177 mainboard device program .KRAEthernet option board program
Loading Firmware
To load firmware to a device or group of devices: 1. From the Data Collection Manager main menu, select Device Manager. 2. From the Device Manager main window, select one or more devices. 3. Select Communications > Advanced > Load Firmware. 4. Select the file to load. As the Device Manager completes loading the program to each device, the message Download Complete appears in the status window. If the status window lists a message that DCMs attempt to load the program was unsuccessful, note the message number and check it in Chapter 12, Troubleshooting, for help. For more information about loading a program, search on load program in the online Help index or click Help from the Device Manager main window.
11-7
Chapter 11
Re-initializing after Performing a Softload

After you finish softloading the firmware to the devices, complete the following steps: 1. Test the communications to the devices to which you softloaded the firmware to ensure that the softload and rebooting processes have finished. If you cannot communicate to one or more of the devices, wait a few minutes and try to communicate again. 2. From the Device Manager, select Communications > Set Date and Time. This step is optional for Series 4000 terminals. 3. Use the Device Manager to initialize the devices, specifying device configuration and other information that needs to be restored to the devices (for example, employees, labor level entries, and schedules). Note: If the Touch ID verification device is attached to the Series 4000 terminal, be sure to select Employee Biometric Data as one of the download options for the initialization. 4. From the Device Manager, select Communications > Set Date and Time.
11-8
Kronos Incorporated
Loading Device Parameter Files
Loading Device Parameter Files

DCM allows you to load device parameters that are not included in the Configuration Options tabs. For example, you have unique, defined commands in your configuration. You load these parameters by creating an XML file to download parameters to a Series 4000 terminal or an AFT file to download parameters to a Series 400 device. In general, these files have an .AFT or .XML extension. Note: DCM does not support extracting parameters from Datakeeper, handheld, or Series 4000 terminals. Using parameter files, you can:
w w w w
Extract a parameter file to upload configuration data from a device to the database Import a parameter file to move configuration data from an external file to the database Export a parameter file to create a file from configuration data in a database Load a parameter file to download configuration data from a parameter file to a device
Note: Collect all punches in the device before loading a parameter file to the device. Otherwise, it does not collect these punches.The parameter file that you load to the device overrides the configuration stored in the device. Use this utility only if you are an advanced user. To load a file to a device or group of devices: 1. From the Data Collection Manager main menu, select Device Manager. 2. Select one or more devices from the Device Manager main window. 3. Select Communications > Advanced > Load Parameter File. As the Device Manager completes loading the file to each device, the message Download Complete appears in the status window. If the status window lists a message that DCMs attempt to load the file was unsuccessful, note the message number and check it in Chapter 12, Troubleshooting, for help.
11-9
Chapter 11
Extracting a Parameter File

When you upgrade, if you initialize your devices without saving the current configuration, the default configuration is loaded to the device and the custom device configuration is lost. Use the Extract Parameter File function to extract the configuration from a device to a parameter file and to update the configuration for the specified device in the database. This function enables you to upgrade the DCM system and to save your custom device configuration. Note: DCM does not support extracting parameters from Datakeeper, handheld, or Series 4000 terminals. The following procedure extracts the parameters to the deviceID.prm file and then imports the deviceID.imp file into the database. To extract a parameter file from a device: 1. From the Data Collection Manager main menu, select Device Manager. 2. Select the device to extract the device configuration from the hierarchical tree in the Device Manager main window. 3. Select Communications > Advanced > Extract Device Parameters. Note: DCM system properties determine whether or not a parameter file is deleted or not after a device configuration is extracted. For more information about deleting or saving parameter files, see System Settings on page 4-42. 4. Click OK to overwrite the current parameter file in the database. Click Cancel to stop the operation. If you click OK, the device configuration is extracted from the device to a parameter file. The parameter file is processed and any commands that are not supported by DCM or cannot be downloaded to a device are placed in a file with a name of deviceID.imp.
11-10
Kronos Incorporated
Extracting a Parameter File
The Device Manager displays the return status when processing is complete, including complete file locations. Do not download the data\temp\device_id_temp file to the device because certain device commands in the file cannot be downloaded to the device.
11-11
Chapter 11
Importing a Parameter File

You import an existing parameter file to update the device configuration in the Data Collection Manager database. Note: DCM supports importing only AFT parameter files to devices. Importing XML files is not supported. To import a parameter file to the database: 1. From the Data Collection Manager main menu, select Device Manager. 2. Select the device to import the device configuration to the database from the hierarchical tree in the Device Manager main window. 3. Select File > Import Parameter File. 4. Select the name of the parameter file from the Import Parameter File Name dialog box and click Open. The devices that appear in the hierarchical tree turn yellow to indicate that DCM is implementing the request. When the operation is complete, the devices return to green. An Import Parameter File command takes an existing parameter file (.aft) and uses it to populate the device configuration settings in the database. Device commands that are not supported by DCM are placed in a file with a name deviceID.imp. Note: You can copy the commands in the deviceID.imp file into the AFT Commands tab in the Configuration Options dialog box to update the configuration in the database or download the AFT Commands to a device.
11-12
Kronos Incorporated
Exporting a Parameter File
Exporting a Parameter File

You export a parameter file from the Data Collection Manager database and save it in a file for future use. To export a parameter file from the database: 1. From the Data Collection Manager main menu, select Device Manager. 2. Select the device to export the device configuration from the hierarchical tree in the Device Manager main window. 3. Select File > Export Parameter File. 4. In the Export Parameter File Name dialog box, type the path of the directory to save the parameter file. 5. Click Save. The devices that appear in the hierarchical tree turn yellow to indicate that DCM is implementing the request. When the operation is complete, the devices return to green. An Export Parameter File command retrieves information from the database and places it in a file with a name deviceID_EXP.AFT. For Series 4000, Export Parameter File generates a manifest file (deviceID_exp.mft) and multiple XML files. The exported file contains some or all the following: supported device configuration commands, and all commands entered in the AFT Commands tab in the Configuration Options dialog box. If you are using a non-Series 4000 terminal, one file is returned. If you are using a Series 4000 terminal, two or more files are returned. One of the Series 4000 export files is an XML manifest file that lists, in order, the exported XML files.
11-13
Chapter 11
Synchronizing the Date and Time on the Communication PC with All Devices
DCM allows you to synchronize the time on all devices that are connected to each comm PC. DCM uses the date and time on the comm PC as the date and time to send to the devices. To ensure that you are sending the correct date and time, check the date and time on the comm PC before sending this information to the devices. Note: Before changing the date or the time on your comm PC, shut down all DCM applications, including the Sentinel. When you restart DCM, you must send the date and time to all devices. You send the date and time to devices by using one of the following methods:
w w w
Select all device groups as a shortcut to sending the date and time to all communication channels and devices connected to the comm PC. Select a device group as a shortcut to sending the date and time to all communication channels and devices associated with that device group. Select a communication channel as a shortcut to sending the date and time to all devices associated with that communication channel (Device Manager only). Select a specific device.
You set the date and time with the Communication Monitor or the Device Manager applications.
Using the Communication Monitor to Set the Date and Time

To set the date and time on a device or group of devices from the Communication Monitor: 1. From the Communication Monitor, select Device > Set Date/Time. The Select Target to Set Date/Time dialog box appears.
11-14
Kronos Incorporated
Synchronizing the Date and Time on the Communication PC with All Devices
2. Select All devices, Device group devices, or Device groups from the pulldown list. 3. Select an individual device or device group, and click Set Date/Time. For more information about setting the date and time, search on date and time in the online Help index or click Help from the Device Manager main window.
Using the Device Manager to Set the Date and Time

To set the date and time on a device or group of devices, from the Device Manager main window, select Communications > Set Date and Time. As the Device Manager completes setting the date and time on each device, the message Operation Complete appears in the status window. If the status window lists a message that DCMs attempt to send the date and time was unsuccessful, see Chapter 12, Troubleshooting, for help. For more information about setting the date and time, search on date and time in the online Help index or click Help from the Device Manager main window.
11-15
Chapter 11
Series 4000 Terminal Device Report

A device report lists a Series 4000 terminals hardware properties. The report lists the following properties:
w w w w w w w
Device ID Collection group Model type Release version Biometric version if applicable Collection method Biometric parameters if applicable
To view or edit the report: 1. From the Device Manager main menu, select a Series 4000 terminal. 2. Select Communications > Advanced > Get Device Report. The device report for the specified terminal appears.
11-16
Kronos Incorporated
Chapter 12
Troubleshooting
This chapter provides procedures for solving problems that you encounter while using the Data Collection Manager system. It describes the log file and lists and explains error messages. This chapter contains the following sections:
w w w w w w
Procedures Optimizing Ethernet Timeouts on Busy Networks Viewing Application Connections and Communication Channels Reading a Transaction Output File Labor Level Entries Troubleshooting with the Communication Monitor
Chapter 12
Troubleshooting
Procedures
The following sections provide troubleshooting procedures to solve common problems within DCM:
w w w
Setup and Configuration Operation/Data Collection Modes System Faults and Recovery
These sections list error information and the solutions using the following format:
w w w
ProblemDescription of problem EnvironmentClient PC (local device), network, host applications SolutionClient PC (local device), Ethernet, Modem, and Serial
12-2
Kronos Incorporated
Procedures
Setup and Configuration

PROBLEM: My client PC does not communicate with a device that I just created and added to a device group.
Environment Serial device Solution Check the following items concerning the serial communication channel connection to the device: 1. Is the port set up properly? w Is the baud rate/COM port set properly in the Device Manager? w There is no port conflict; another resource is not trying to use the port at the same time. w Is the cable plugged in? w Is the Smart Converter (if used) set up properly? w Is the device ID correct in the Device Manager? w Does the device model setting match the physical device? 2. Are the device/device settings set up properly? w Does the baud rate match PC settings? w Is the device ID correct? 3. Are the applications and communication channels running in the Sentinel? If they are not running, restart them. Also, try stopping and restarting each application and communication channel. 4. Verify that the device that you are trying to communicate with has the correct boot prom and application firmware by doing either of the following: w Check the boot prom and application firmware at the device. w Test the device in the Device Wizard. If the test is successful, the device has the correct boot prom and application firmware.
12-3
Chapter 12
Troubleshooting
Environment
Solution
Ethernet device Check the following items for the Ethernet communication channel connection to the device: 1. Is the port set up properly? w There is no conflict/error with the configuration of the Ethernet interface on the PC; verify that your Windows network settings are configured correctly. w In the Device Manager, verify: Is the IP address correct? Make sure you are able to ping the device by using that IP address. Is the device ID correct? w Is the cable plugged in? w On a Series 400 device or the Series 4000 terminal, check that the green link LED located inside the device is lit, and check that the green link LED on the hub or switch is also lit. 2. Are the device/device settings are set up properly? w Is the IP address set at the device? w Is the device ID correct? w Is the IP address being used by another network device? 3. Are the applications and communication channels running in the Sentinel? If they are not running, restart them. Also, try stopping and restarting each application and communication channel. 4. Does the device that you are trying to communicate with have the correct boot prom and application firmware? Check by doing either of the following: w Check the boot prom and application firmware at the device. w Test the device in the Device Wizard. If the test is successful, and then the device has the correct boot prom and application firmware.
12-4
Kronos Incorporated
Procedures
Environment Modem device
Solution Check the following items for the Series 400 modem communication channel link connection to the device: 1. Is the port set up properly? w In the Device Manager, check the following: Is the phone number where the device is located correct? Is the device ID correct? Does the device model setting match the physical device? Does the baud rate match the device baud rate? Is the COM port setting correct? Are miscellaneous communication settings in the Comm Channel/Advanced and Comm Channel/Modem screens correct? w Is the modem configured correctly? Refer to the modem manual. w Is the telephone network functioning properly? w The dial-up delay is not excessive? w Is the modem string correct? 2. Are the applications and communication channels running in the Sentinel? If they are not running, restart them. Also try stopping and restarting each application and communication channel.
12-5
Chapter 12
Troubleshooting
Environment
Solution
Network, Serial You use an administrators PC to configure the settings for one or more Communication PCs. 1. Is the Communication PC for the devices configured correctly for network operation? w Is there a conflict/error with the configuration of the Ethernet interface on the PC? Are the Windows network settings configured correctly? w Is the share name for the DCM directory correct? w Is the data collection computer name correct? Ensure that the proper computer name is assigned in the Windows settings. Ensure that the proper computer name is assigned to all the communication channels in the device group. w The communication channel/input data path for one or more of the communication channels is not pointing to an invalid PC location in the network. 2. Is the Communication PC functioning? w Use Microsoft networking utilities to confirm that the Communication PC is in operation. 3. Is the administrators PC configured correctly? w Is the computer name correct? Ensure that the proper name is assigned in Windows settings at the administrators PC. 4. Are the database location and/or location settings correct? See the problem, I get database error messages whenever one of my DCM applications attempts to read or write information, on page 11-9 for more information about troubleshooting database errors. 5. Is the administrators PC functioning properly? w Use the Windows utilities to confirm general network operation.
12-6
Kronos Incorporated
Procedures
PROBLEM: I get an error message such as Comm driver error code [-6].
Environment Serial Solution Your system may be unable to respond within the set timeout period due to CPU resource issues. You must adjust the timeout to allow for additional response time. The amount of time that you should allow depends on the number of processes running on the system and the extent to which CPU resources are being used. More processes and resources in use may require a larger timeout value. For more information, see Advanced tab in Series 400 Ethernet Communication in Chapter 3 and Registering a New Communication PC in Appendix B.
PROBLEM: Since I installed a modem in my Series 4000 terminal, I am having problems accessing my e-mail, browser, or other applications.
Environment Series 4000 terminal with a modem Solution Check the configuration of the TCP/IP and redialing properties in your dial-up connection. Your dial-up connection may have the Use as default gateway check box selected. For more information, see Configuring a Dial-up Entry on Windows 2000 on page 3-12 or Configuring Dial-up Networking on Windows NT on page 3-16.
PROBLEM: During initialization of a Series 100 device, a communication failure occurred.

Environment Modem Solution Open the Advanced Modem Settings dialog box and increase the Wait after hang-up value to 4000 msec. For more information, see Series 400 Ethernet Communication on page 3-25.
12-7
Chapter 12
Troubleshooting
PROBLEM: I get database error messages whenever one of my DCM applications attempts to read or write information.
Environment Client PC Solution If you are running the entire DCM system on a local Communication PC, database error messages indicate the following: 1. The database server is not running properly. a. Ensure that the database server is running on the database PC. b. Ensure that the DCM data source is configured for the proper database server. 2. Check the ODBC settings in the Control Panel to make sure the DSN is correct. 3. The database that is a component of your system possibly exists in the wrong location or does not exist. Caution: The application database file contains applicationspecific records. Unless otherwise directed by a service representative, do not attempt to use database development tools to alter the internal records in the database file. a. Execute the ODBC administration program on your Windows NT/2000 system. Verify that a DSN exists for the application database. Record the location (path) of the database file. b. Use Microsoft Explorer to ensure that the database file exists in the ODBC-assigned directory. If it does not exist, perform a system search for the file. If you locate it, move it to the assigned directory. c. Check that the database is set as read-write, not read-only. d. Check that the database file has not been corrupted. 4. Use the Test Connection function in the ODBC setup to check connectivity.
12-8
Kronos Incorporated
Procedures
Environment Network
Solution If you configured your data collection system for database access across a network, database error messages indicate the following: The remote system is inaccessible. The database file resides in the wrong location on the remote system. w The ODBC DSN is not configured to point to the proper location of the database on the remote system. w The database on the remote system is set as Read-Only. w The database file is corrupted.
w w
PROBLEM: I have added a device group to the database, but it does not appear on the device group/communication channel tree in the Device Manager.
Environment Setup Solution Device groups are not shown on the tree until you assign devices to device groups. To assign devices: 1. Create records for the devices and communication channels (if they do not already exist). 2. Use Setup > Assign Devices to Groups to add the devices to your device group, by using one or more of the communication channels that you created.
PROBLEM: There is an excessive delay whenever I try to access DCM information in the database.
Environment Database Solution To enhance performance, do the following: 1. A segment of the network is particularly slow; therefore, move the database to another location in the system. 2. The server PC is not fast enough; change servers.
12-9
Chapter 12
Troubleshooting
PROBLEM: When I send employees to a Series 400 device, I get an Unknown Structure error (structure ID=16) in building application data for BuildHomeEmployeeList error message.
Environment Database Solution When the system tried to build an employee without schedules list for download to the device, the database error message indicates:
w w
An Oracle database needs increased TEMP space. The database needs maintenance and reindexing.
PROBLEM: The log file does not contain all the transactions/messages that I expect to see.
Environment Setup Solution Log messages are posted in the DCM centralized log file based on the log options defined in the System Properties in the Device Manager application. For more information about the DCM log file, see Log File Settings on page 4-45.
PROBLEM: An attempt to process TRX.IN files by copying OUT files and renaming them results in all files being marked with a .failed extension on the files. No punches are processed through the system.
Environment Setup Solution The existence of .failed files indicates that DCM is handling the request. If you see this type of file, consider the follow conditions that may lead to its creation:
w w w w w
No groups are present on this Communication PC. The group is on another Communication PC or is not assigned. DCM is not renaming a file in process. DCM failed to write to app.q. DCM cannot open a server connection.
12-10
Kronos Incorporated
Procedures
Operation/Data Collection Modes

PROBLEM: My log file contains messages that I am not familiar with. What do these error messages mean?
Environment Application connection Solution Some error messages are logged for the WFCAPI integration into the connection library (krdcmwfc4.dll). These error messages do not appear on the users display. The following error messages are written to the centralized log file in the data\logs\commpc subdirectory.
w w w w w w w w w w w w
Error in loading WFCAPI library Failure in connecting to the database Error in validating Username/Password for WFCAPI connection Error in queue message data Error in user logout for WFCAPI connection WFCAPI error during call to get Bulk Accruals WFCAPI error during call to get Bulk Totals WFCAPI error during call to get Labor Level Sets WFCAPI error during call to get Biometric Data WFCAPI error during call to get Remote Transactions Application Server failure or Network failure occurred Failed to add invalid transaction - Device ID
12-11
Chapter 12
Troubleshooting
PROBLEM: I do not see any particular error messages but the application does not appear to be receiving any transactions.
Environment Application processing Solutions To verify that transactions are being collected at the device and prepared for delivery at the Communication PC: 1. In the Device Manager, select Communications > Test Device Communications to verify that the device is online. 2. In the Sentinel verify that the necessary applications and communication channels are running. 3. Use the Communication Monitor to verify that transactions are being picked up and posted to the application input queue. 4. Use the Device Manager to verify that there is an associated application entry for your application and that the entry includes the proper Communication PC. 5. Verify that all the system paths are mapped properly.
PROBLEM: I am not receiving any transactions from all the devices connected to a particular Communication PC in my network.
Environment Application processing Solution Use the Windows NT network tools, for example, Microsoft Explorer to verify that the Communication PC is visible according to its computer name, or do the following: 1. Verify that the computer name is correct. 2. Use the Device Manager to test device communications. 3. Verify that the communication channels all reference the same computer name. 4. Stop and restart the Sentinel.
12-12
Kronos Incorporated
Procedures
PROBLEM: I am receiving error messages similar to the following: Unable to post to transaction output file... Unable to post to output queue file...
Environment Application processing Solution These errors usually indicate faults in the following areas:
w w
w w w w w
The application is not registered with the data collection system. The computer name is not correct. For more information, see Chapter 3, Communication Channels. and Setup and Configuration on page 12-3. If you have opened the Device Manager, close and restart it. If no communications are reestablished, stop and restart the communication channel by using the Sentinel application. The local disk is full. Each PC in your data collection environment is accessible and has sufficient disk space. Each PC or server used for data collection has been set up with access rights to the other PCs. See the Data Collection Manager Installation Guide for more detailed information. Use the Microsoft Windows NT utility Network Neighborhood or the Explorer to verify that the PC is accessible.
PROBLEM: My client PC is unable to see all the expected transactions and messages while using the Communication Monitor.
Environment System monitoring Solution In the Communication Monitor, use the Device menu to enable or disable the transactions to list.
12-13
Chapter 12
Troubleshooting
System Faults and Recovery

PROBLEM: Cannot connect to the database when I receive both the Sentinel Service is not ready error message and the Unable to establish a connection to the database error message.
Environment Application processing Solution On the Sentinel Service Status window, click Properties, correct the database account information, and click OK.
PROBLEM: The database connection is down and I no longer retrieve information from the database by using my DCM applications. The database appears to be empty.
Environment Application processing Solution Do the following: 1. Make sure that the database is up and running. 2. Close and restart your DCM applications.
PROBLEM: I see missing DLL errors when I try to run DCM.

Environment Host applications Solution Verify that the ...\kronoscm\dcm entry is in your path. You do not see these messages if your Communication PC is running only DCM, as recommended.
PROBLEM: A DCM application shut down improperly (using Windows Task Manager), and now it does not launch from the host Workforce Timekeeper system.
Environment DCM applications Solution Restart the application from the DCM menu to update the Workforce Timekeeper cross-launch information properly.
12-14
Kronos Incorporated
Procedures
PROBLEM: The device behaves unpredictably during updates or initialization. The cause could be the use of non-ASCII characters.
Environment Devices Solution Although it is possible to enter non-ASCII characters in the host application, do not use such characters in any data sets that you expect to be downloaded to the device. Such data sets include, but are not limited to, employee names, schedule names, pay codes, accrual profiles, labor level definitions and entries, and global messages.
PROBLEM: The Sentinel is not functioning properly.

Environment DCM Version 4.8 and Workforce Timekeeper Version 4 Solution Although it is possible to enter non-ASCII characters in the host application, do not use such characters in any data sets that you expect to be downloaded to the device. Such data sets include, but are not limited to, employee names, schedule names, pay codes, accrual profiles, labor level definitions and entries, and global messages.
12-15
Chapter 12
Troubleshooting
Optimizing Ethernet Timeouts on Busy Networks

The standard Ethernet timeout setting, when a PC is communicating with a device over an Ethernet network, is two seconds for both the Communication PC and the device. This setting is adequate for most environments. In some instances, this setting is not long enough for communication between a PC and a device. In these cases, Kronos recommends that you increase the timeout settings for both the Communication PC and the device. Also, use the same value for the timeout setting for both the Communication PC and the device. Valid Ethernet timeout settings are from one to five seconds. Note: Setting Ethernet timeouts applies to Series 400 devices only. To set Ethernet timeout values for the Communication PCs and devices, do the following: 1. Close all data collection processes running on the Communication PC. 2. Select Setup > Comm Channels. 3. Highlight the appropriate communication channel and click Edit. 4. Increase the Response Timeout. The maximum allowed is 5 seconds. Note: Set the timeout value for the device equal to the timeout value for the Communication PC. 5. Restart data collection processes on the Communication PC.
12-16
Kronos Incorporated
Viewing Application Connections and Communication Channels
Viewing Application Connections and Communication Channels

The Sentinel shows the application connections and communication channels that are running. A communication channel does not run unless at least one device is assigned to it. Note: Even though application connections and communication channels are running, data collection does not occur until you start it by using one of the methods discussed in Chapter 9, Collecting Data and Managing Transactions. For more information on the Sentinel, see Chapter 10, Using the Sentinel. If transactions are not picked up by the device, check the Sentinel to make sure that the following components are operational for the device:
w w w w
Communication channel Application connection Data collection for the given device group Database connection If the database is not running, a message appears at the bottom of the Sentinel Status window. In this case, the Sentinel continues to reestablish connection with the database. When the connection is successful, the Sentinel automatically restarts the applications and communication channels.
12-17
Chapter 12
Troubleshooting
Reading a Transaction Output File

The following example is a connect request that was posted to the log file:
12345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678 (Date/Time) (Source) (Type String) (Type) (Pwd) (Data) | | | | | | 04/17/1998 17:15:21 Ethera:SYSTEM12NT Connect 116 000001 555-5555
A log file contains the following entries:

Entry Date/Time Source Description Month, day, and year in mm/dd/yyyy format; and the time in hours, minutes, and seconds in hh:mm:ss (24-hour) format when a message was posted to the log file. Device group or communication channel that created and posted the message to the log file. Note: If the Source field contains a colon, the information following the colon is the computer name in which the device group or communication channel is running. In the previous example, Ethera is the device group, and SYSTEM12NT is the computer name.
12-18
Kronos Incorporated
Reading a Transaction Output File
Entry Type String
Description The type string consists of the different types of messages posted to the log file; they include the following types:
w w w w w w w w w w w w w w w w w w w w w
Completion Status - designates that the transaction has completed Collect - standard Connect - standard Device Out Of Service - designates that communication did not occur with a specific device Device Status - standard Get Date Time - standard Host Report - host application-related Load Configuration - initialize or update Load File - standard Load Program - load firmware Load Trx (Transaction) Table Message Response Net(work) Check - check for one or more device Parameter Save Process Error - contains information about a processing error that occurred Process Status - contains interim information about a request Set Date/Time - standard Start DC - standard Stop DC - standard Transaction - punch/trx Transaction Response - designates a response to a device trx from an application
Type Pwd Data
Numeric message type ID. Device ID and password of the device. Message content, such as error strings, transactions, requests, and response strings. Note: The Data entry for responses also includes the following numbers: 0 = Operation complete 1= Device status 2 = Download complete 3 = Collect complete
12-19
Chapter 12
Troubleshooting
Note: Disable the Sentinel before archiving and purging transaction files. This prevents transactions from occurring during this procedure. After modifying or purging a transaction file, restart the Sentinel to ensure that it monitors for the new modifications. For example, it may be necessary to restrict overtime. Use the Start DC and Stop DC actions to prevent when an employee can punch in and out.
12-20
Kronos Incorporated
Labor Level Entries
Labor Level Entries

If your host application supports the use of alphanumeric labor level names, it may allow both uppercase and lowercase characters to be used in the name. If your host application does support use of both uppercase and lowercase characters, the default behavior for sending labor level entries (names) to the device is to send them exactly as they are defined in the host application. However, if it is necessary to make the names uppercase, you can add the settings shown in the following example to the krdcm.ini file in the local DCM directory. The settings allow you to either control this behavior globally or for specified devices. For more information about .ini files, see Modifying INI File Values in Appendix B. The following example shows how to keep labor level list entries and default values unaltered for the device 000123 and make all others uppercase. If these settings are omitted from the krdcm.ini file, labor level names are sent to the device exactly as they are defined in the host application. [000123] LaborEntriesUpper=0 // 0=unaltered (default), 1=uppercase [Configuration Services] LaborEntriesUpper=1 //0=unaltered (default), 1=uppercase
12-21
Chapter 12
Troubleshooting
Troubleshooting with the Communication Monitor

The Communication Monitor monitors device and application interaction on the network, and provides live status showing which devices are responding and which are not. Responding devices communicate with the communication channel; non-responding devices are not communicating with the communication channel. For more information about the Communication Monitor, see Chapter 9, Collecting Data and Managing Transactions. You track the following types of information when an event is processing:
w w w w
Building of the download file Downloading file progress Collecting transaction status Completion status
The Messages and transaction window allows you to troubleshoot problems by monitoring the messages and transactions to and from the devices and from the host application. If you receive more than one Collect Complete message for a Series 4000 terminal, the device has finished sending data, but the Collection Agent has not finished processing it. You may receive Collect Complete messages approximately every 5 seconds until the Collection Agent finishes processing all punches, or until a processing error occurs.
12-22
Kronos Incorporated
Chapter 13
Error Codes and Messages
This chapter contains the following sections:

w w w w
Error Messages Error Messages from Connecting to Workforce Timekeeper Error Messages from a Series 4000 Terminal Device Error Messages from a Series 400 Device
Chapter 13
Error Messages
This section contains lists of error messages for the Data Collection Manager and their resolutions. This section lists the error message and a solution. The following list provides a quick synopsis. For more information or further assistance, contact your service representative.
Error Numbers -1 to -22 -23 to -29 -30 to -65 -80 to -99 -100 to -240 -800 to -845 -900 to -905 -1000 to -1200 00000000 to 011DA803 Explanation Serial and Modem Error Codes Modem Error Codes Communication Driver/Type Independent Error Codes Polled Ethernet Error Codes Diagnostic Communication Channel Error Codes Configuration Service Error Codes Softload Error Codes Data Collection Manager Generic Error Codes Data Collection Manager Series 4000 Error Codes
13-2
Kronos Incorporated
Error Messages
Format
Communication channel error messages have the following format: <error code>#{device}#<text>{optional text}#{file name}#{phone number}{IP address} Where:
<error code> {device} <text> {optional text} <file name> <phone number> <IP address> is the error code. is the optional device ID. is the error text. is the optional error-specific text. is the optional path and file name associated with the command that was processed when the error occurred. is the optional telephone number of the remote device(s) that is related to the error. is the optional IP address of the remote device(s) that is related to the error.
The format of the error messages in the Communication Monitor and log files differs from that shown above. The format shown above is internal to the communication channel.
13-3
Chapter 13
Communication Driver Error Codes

The communication driver generates the error codes that appear in the following tables. Serial and Modem Error Codes Serial and modem devices generate the following error codes. Error codes -1 through -22 (listed in the Error Code column) indicate problems with direct connect serial communication. If these errors occur infrequently, the communication channel typically recovers automatically. If the errors become excessive, do one or more of the following actions:
w w w w w
Verify that the communication cable is hooked up and properly wired. Verify that the same serial comm parameters are set in the device(s) and in Device Manager. Choose a lower baud rate. Increase the intermessage delay.
Increase the message begin timeout.
Note: See list above in the following table refers to these five actions.
Error Code -1 -2 -3 -4 -5 -6 -7
Text No DSR (check cable) RTS ON; unable to transmit No DCD (receiver timeout) No STX (receiver timeout) Bad check-sum Bad sequence number Receiver timeout
Description/Action See list above. See list above.Check Smart Converter or hub configuration. See list above.Check Smart Converter or hub configuration. See list above. See list above. See list above. See list above.
13-4
Kronos Incorporated
Error Messages
Error Code -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22
Text Short I-Frame (receiver timeout) Bad character received No CTS (hand-shake timeout) DCD ON timeout Transmit failed No comm port I-Frame too long Status check failed Attempt to send before device EOT Device is not selected Receiver overrun Attempt to read device after EOT Bad packet size Bad ETX
Description/Action See list above. See list above. See list above. See list above. See list above. Verify that the port exists and is enabled on the communication channel PC. Also, see list above. See list above. See list above. See list above. See list above. See list above. See list above. See list above. See list above.
Wrong device responded See list above.
13-5
Chapter 13
Modem Error Codes Modem devices generate the following error codes:
Error Code -23 -24 -25
Text Modem fault; echoing Modem not ready Modem dial failed
Description/Action Verify that the modem is properly configured and connected to the telephone line. Retry the operation. Verify that the modem is properly configured and connected to the telephone line. Retry the operation. Verify that the modem is properly configured and connected to the telephone line. Adjust the telephone number or modem string assigned in Device Manager. Retry the operation. Verify that the modem is properly configured and connected to the telephone line. Retry the operation.
-26 -29
Carrier lost
Unrecognized error code Contact your service representative; <code> contains [<code>] the unrecognized error code.
13-6
Kronos Incorporated
Error Messages
Communication Driver Error Codes Communication drivers generate the following error codes:
Error Code -30
Text Model not initialized
Description/Action The comm driver does not determine the host command offset because it was not initialized with device model family. Verify that there is only one copy of DCM program files and libraries on PC. Reinstall everything, if necessary.
-31
Command not supported The comm driver does not translate the host command (by host command offset) because the command is not supported by device model family. FIFO file not supported The comm driver does not drain FIFO of the specified device because no file name was given for the temporary punch file.Verify that there is only one copy of DCM program files and libraries on PC. Reinstall everything, if necessary. The comm driver does not drain FIFO of the specified device because it does not open the temporary punch file. Retry the operation; if unsuccessful, contact your service representative. The comm driver does not perform a parameter save on the device in boot mode. Run the application in the specified device and retry the operation. The comm driver tried sending a host report to a device without enough memory to store the report. Reconfigure the device to increase memory or delete host reports stored on the device and retry the operation. The comm driver attempted to send a host report with invalid characters (null, STX, or ETX).
-32
-33
Opening FIFO file
-34
Device application not running Host report not enough memory
-48
-49
Host report invalid file
13-7
Chapter 13
Communication Type Independent Error Codes Softloads generate error codes that are independent of communication type.
Error Code -40 -41 -42 -43 -44 -45 -46
Text Unable to erase flash memory Unable to set softload mode Unable to read boot PROM ID Incorrect firmware file extension Invalid firmware file extension No accessory board Too many firmware blocks Unable to exit softload mode
Description/Action Retry; need to restart device. Retry; need to restart device. Retry; need to restart device. The improper firmware file was specified for device model. The firmware file is *.kre, *.krn, *.krs, or *.kra. You load *.kra files only to a device that has an Ethernet port. The program file (*.kre, *.krn, or *.krs) contains more than 2 blocks. DCM does not softload this program file. Send a parameter file to the device. If necessary, cold-start the device.
-47
13-8
Kronos Incorporated
Error Messages
File downloads generate error codes that are independent of communication type.
Error Code -50 -52 -53 -54 -55
Text Unable to allocate AFT memory
Description/Action Shut down the Sentinel and restart.
Unable to open output file Verify write access to the indicated path. Unable to write to output Verify write access to the indicated path. file Unable to open <deviceid>_ERR.log file Unable to write to <device-id>_ ERR.log file Too many reports specified Verify write access to the indicated path. Verify write access to the indicated path.
-61
DCM has requested to download an AFT file that contains more than 200 commands that result in an output file. Reduce the number of commands that specify an output file or split the download into two or more separate operations. Retry the operation. Check devicename_ERR.log. For an explanation of the error codes in this file, refer to Device Error Messages from a Series 400 Devicelater in this chapter. The download file contains no commands or report requests. Shut down the Sentinel and restart.
-62 -63
Comm unreliable, transfer aborted File contains invalid commands
-64 -65
Empty file Did not release all AFT memory
13-9
Chapter 13
Communication Channel Error Codes

The communication channel generates error codes that are independent of communication type.
Error Code -100
Text
Description/Action
Command not supported The device does not support the attempted operation, or components of the DCM installation are incompatible. Verify that the proper device model is specified in the DCM configuration. Next, verify that you have proper versions of the device firmware (boot and app) and all components of DCM. Upgrade the device, or reinstall DCM, as necessary. Invalid argument The components of the DCM installation are incompatible. Verify that you have proper versions of all DCM components. Reinstall DCM, if necessary. Specify a valid six-digit device ID and retry the operation. An operation was attempted that requires a device ID to be specified. Verify that you have proper versions of all DCM components. Reinstall DCM, if necessary. Verify that the port exists and is enabled in communication channel PC. An attempt to open port that was already open occurred. Verify that the same port is not defined for more than one active communication channel on a PC. w Shut down the Sentinel and restart.
w
-101
-102 -103
Invalid device ID A device ID must be specified
-104 -105
Unable to open port Port is already open
13-10
Kronos Incorporated
Error Messages
Error Code -106
Text Transport is not available
Description/Action The device cannot send data via modem or Ethernet. Try the following solutions: 1. Select the device in the Device Manager and look for a series of error messages that may help diagnose the problem. If you receive a RAS error, see Microsoft Help. 2. Open the Sentinel Status window. Stop and then start the device. 3. Only if the other methods do not work, shut down the Sentinel and restart.
-107
Input file not specified
An operation was attempted that requires a file name to be specified. Verify that you have proper versions of all DCM components. Reinstall DCM, if necessary. Verify location of file at indicated path and that it has at least read access. The DCM system automatically retries and recover from this error. If this error persists or occurs frequently, it indicates a problem either with communication or the device hardware. This error is caused by either of the following: The device firmware version is incompatible with DCM. w DCM is attempting to collect old FIFO data from the device. Verify that the device firmware versions (boot and app) are compatible with DCM. If this is the case, flush the device FIFO, reinitialize the device configuration, and retry the operation.
w
-108 -109
File does not exist Unable to delete transaction
-110
Invalid transaction format
Note This results in loss of punch data. -111 Invalid XML or syntax error in XML data Validate the XML data file for format using a standard browser.
13-11
Chapter 13
Error Code -112 -113 -114 -115 -116 -117
Text
Description/Action
Empty HTTP response or Retry the request. no response from device Unable to load XML file Verify that the device is operating and the to device communication channel is working. Error reported by series 4000 OS Error reported by series 4000 application Error reported by series 4000 communication Error reported by series 4000 configuration services Retry the operation. Reboot if the retry fails. Retry the operation. Reboot if the retry fails. Retry the operation. Reboot if the retry fails. Retry the operation. Reboot if the retry fails.
-118 -119 -120 -121 -122 -123 -124
Error reported by series Retry the operation. Reboot if the retry fails. 4000 database processing Error reported by series 4000 diagnostics Unable to open data source/database Domain/device group not defined No devices in specified domain/device group Unable to add device to communication channel Invalid port specified Retry the operation. Reboot if the retry fails. Verify ODBC configuration and drivers. Shut down all DCM components and restart. Use the Device Manager to add devices to the device group. Shut down the Sentinel and restart. The components of the DCM installation are incompatible. Verify that you have proper versions of all DCM components. Reinstall DCM, if necessary Shut down the DCM module which you are running and restart. If the problem persists, contact your database administrator. Stop and restart DCM.
-125
Unable to get required value from DCM database Invalid DCM home path
-126
13-12
Kronos Incorporated
Error Messages
Error Code -127
Text Invalid command
Description/Action The communication channel does not recognize specified command. Verify that there is only one copy of DCM program files and libraries on PC. Reinstall everything, if necessary.
-128
Unknown comm channel The communication channel does not recognize the type communication channel type in the DCM database.Verify that there is only one copy of DCM program files and libraries on the PC. Reinstall everything, if necessary. Selected device is disabled Error during data collection Invalid Transaction message Unable to reset mailbox Starting DC Enable device for communication. Refer to the centralized log file. Refer to the centralized log file. Stop and restart DCM. The communication channel does not start data collection thread. Exit DCM and application; reboot and retry the operation. If unsuccessful, contact your service representative. The communication channel does not open the temporary FIFO file during the process of draining punches from the specified device. Exit DCM and the application; reboot and retry the operation. If unsuccessful, contact your service representative.
-129 -130 -131 -132 -135
-136
Opening FIFO file for read
-137 -140 -141
Writing bulk transaction Check the disc space and the DCM network settings. file during data collection STATUS: Device responding Device not responding Information only. Verify that the device exists on the network and is running. Verify communication configuration (serial parameters or IP address).
13-13
Chapter 13
Error Code -142 -143
Text Unable to download; device contains data
Description/Action Run data collection to retrieve all data from device, and then retry the download.
FAULT: Device put out of Too many comm errors have caused the service communication channel to stop attempting to collect data from the device. ERROR: Transport not available. ##nnnnnnn currently has exclusive use of line. Does not allow yyyyyyy to hang it up. DCM post message The phone line is in use. The device with telephone number ##nnnnnnn is using the line to do a collection. The device with telephone number yyyyyyy cannot use the modem until the first device has finished the collection. Let the collection complete and try again later. The communication channel does not post message to DCM; as a result, data collection stops. Exit DCM and the application; reboot and retry the operation. If unsuccessful, contact your service representative. Multiple processes in the communication channel attempted to execute a protected area of code. Exit DCM and the application; reboot and retry the operation. This is a fatal error; if unsuccessful, contact your service representative. The communication channel loaded but does not completely connect to the configuration service DLL to load configuration or import AFT file. Verify that there is only one copy of DCM program files and libraries on the PC. Reinstall everything, if necessary. The communication channel does not load the configuration service DLL to load configuration or import AFT file. Verify that the configuration service file (KrCfgSvc.dll) exists in DCM share directory. Ensure that the path includes reference to this directory. Stop the communication channel and the Data Collection Agent. Reboot the device.
-145
-160
-161
FATAL: Output Reentrancy
-162
Connecting to config service
-163
Loading config service
-170
Invalid URI Error reported by series 4000 communication
13-14
Kronos Incorporated
Error Messages
Error Code -171
Text No Parser Memory reported by series 4000 communication
Description/Action Stop the communication channel and the Data Collection Agent. Reboot the device.
-172
XML Parse error reported Stop the communication channel and the Data by series 4000 Collection Agent. Reboot the device. communication No root object in XML reported by series 4000 communication Invalid END in XML document reported by series 4000 communication Application protocol error reported by series 4000 communication Invalid XML tag name reported by series 4000 communication Invalid XML packet reported by series 4000 communication Invalid session header reported by series 4000 communication No client buffers left reported by series 4000 communication Web client buffers exhausted reported by series 4000 communication Stop the communication channel and the Data Collection Agent. Reboot the device. Retry the operation.
-173
-175
-176
Retry the operation.
-178
-179
-180
-181
-182
13-15
Chapter 13
Error Code -183
Text Client take resource failed reported by series 4000 communication Client give resource failed reported by series 4000 communication
Description/Action Retry the operation.
-184
-186
Flash write error reported Retry the operation. by series 4000 communication Flash read error reported Retry the operation. by series 4000 communication Wrong packet type error reported by series 4000 communication Client invalid request reported by series 4000 communication Client buffer overflow reported by series 4000 communication Retry the operation.
-187
-188
-189
-190
-191
Client no server reported Reboot and retry the operation. by series 4000 communication Client file error reported Reboot and retry the operation. by series 4000 communication Client abort connection error reported by series 4000 communication Reboot and retry the operation.
-192
-193
-194
Client abort general error Reboot and retry the operation. reported by series 4000 communication
13-16
Kronos Incorporated
Error Messages
Error Code -195
Text Client queue request failure error reported by series 4000 communication Client syntax error reported by series 4000 communication Client protocol error reported by series 4000 communication
Description/Action Reboot and retry the operation.
-196
-197
Reboot and retry the operation.
-198
Client no resources error Reboot and retry the operation. reported by series 4000 communication Failed to read COMM Retry the operation. request reported by series 4000 application Missing attribute tag reported by series 4000 application Invalid verb reported by series 4000 application Invalid object name reported by series 4000 application Invalid XML record reported by series 4000 application Retry the operation.
-202
-203
-204 -205
Retry the operation. Retry the operation.
-207
-208
Failed to update Retry the operation. configuration reported by series 4000 application Invalid configuration data Retry the operation. reported by series 4000 application
-209
13-17
Chapter 13
Error Code -210
Text
Description/Action
Transaction not supported Retry the operation. reported by series 4000 application COMM aborted operation Retry the operation. reported by series 4000 application Failed to lock database reported by series 4000 application Record not found reported by series 4000 application Failed to update FIFO status reported by series 4000 application Value out of range reported by series 4000 application Retry the operation.
-211
-212
-213
-214
Reboot and retry the operation.
-215
Check configuration parameters and retry the operation.
-216 -217
Database full reported by Run a data collection operation on the device and series 4000 application wait 5 to 10 minutes. Internal database error reported by series 4000 application Client busy reported by series 4000 application Contact your service representative.
-218 -219 -220
Failed to spawn task error Reboot and retry the operation. reported by series 4000 Message Queue send error reported by series 4000 Message queue receive error reported by series 4000 Retry the operation.
-221
13-18
Kronos Incorporated
Error Messages
Error Code -222
Text Out of memory error reported by series 4000 OS Exceeded buffer size error reported by series 4000 Unrecognized object error reported by series 4000 Invalid parameter error reported by series 4000 Symbol not found error reported by series 4000 Symbol not found error reported by series 4000
Description/Action Run a data collection operation, and then retry the original operation. Retry the operation.
-223
-224
-225 -226 -227 -228 -229 -230 -231
Retry the operation. Retry the operation. Retry the operation.
Device ID unknown error Check the device setup to validate the device ID. reported by series 4000 Invalid List error reported Retry the operation. by series 4000 Invalid packet type error Retry the operation. reported by series 4000 Invalid XML version ID reported by series 4000 communication Retry the operation.
-232
Series 4000 terminal has Consult your Series 4000 documentation and follow reached set database the procedure to clean the database. memory capacity Failed to read COMM Retry the operation. request reported by series 4000
-233
13-19
Chapter 13
Error Code -234
Text
Description/Action
Previous Load Firmware Verify that the agent is running. It the error persists, stop the communication channel and retry the request is still pending, operation. please wait for that request to complete first. Boot cycle for the specified device has not completed. Wait at least three minutes for the device to boot before attempting any operation.
-235
-236 -240
Incompatible Series 4000 Use the proper vendor-specific device. terminal type detected. XML files for series 4000 Retry the operation. terminals cannot exceed 32K
13-20
Kronos Incorporated
Error Messages
Configuration Service Error Codes

The configuration service generates the following error codes:
Error Code -800
Text Unknown structure
Description/Action The host application or configuration GUI (graphical user interface) requested information for an unrecognized data structure.Verify that the proper versions of the host application and DCM are installed.Verify that there is only one copy of DCM program files and libraries on PC. Reinstall everything, if necessary. The configuration GUI requested information from host application for a data structure that the host application does not recognize. Verify that the proper versions of the host application and DCM are installed.Verify that there is only one copy of DCM program files and libraries on PC. Reinstall everything, if necessary. This is not an error. You should never see this status code. If you do, contact your service representative. The configuration service requested application data to build the file, but received an error from the application connection library. Look for error in deviceID_ERR.log. The configuration service requested an application data item that is not supported by the application in the connection library. The host application or configuration GUI failed to supply one or more required arguments to a configuration service API function. Verify that the proper versions of the host application and DCM are installed.Verify that there is only one copy of DCM program files and libraries on PC. Reinstall everything, if necessary.
-801
Not app struct
-802 -805
No app data Errors in building download file with application data Not implemented in application Invalid argument
-806
-810
13-21
Chapter 13
Error Code -811
Text No cfg session
Description/Action The application attempted to build or import an AFT file without properly initializing the configuration service. Verify that the proper versions of the host application and DCM are installed. Verify that there is only one copy of DCM program files and libraries on PC. Reinstall everything, if necessary. The configuration service was unable to obtain model information from the DCM database for the specified device. Verify that there is only one copy of the DCM program files and libraries on PC. Verify that the DCM database is current and properly referenced. Reinstall everything, if necessary.
-812
Getting model info
-813
Cannot determine device The configuration service was unable to determine ID the device ID (password) by querying the DCM database with a device name. Use the Device Manager to verify that a device exists in DCM database with a given device name. Cannot determine model The configuration service was unable to determine DLL the model DLL file name by querying DCM database. Use the Device Manager to verify that the device exists in the DCM database. If it does, the problem designates incompatible versions of the programs in DCM. Verify that there is only one copy of DCM program files and libraries on the PC. Reinstall everything, if necessary. Loading Model DLL The configuration service was unable to load the specified model DLL. Verify that the proper model DLL file exists in the DCM share directory. Ensure that the path includes a reference to this directory. The configuration service loaded but was unable completely connect to the model DLL. Verify that there is only one copy of DCM program files and libraries on the PC. Reinstall everything, if necessary.
-814
-815
-816
Connecting to model DLL
13-22
Kronos Incorporated
Error Messages
Error Code -817
Text Model DLL does not support model
Description/Action An incorrect model DLL was loaded for the specified device. Verify that there is only one copy of the DCM program files and libraries on the PC. Verify that the DCM database is current and properly referenced. Reinstall everything, if necessary. The application requested that the configuration service build an AFT file when no model DLL was loaded. Exit DCM and the application; reboot, and retry. If the error persists, contact your service representative. The configuration service failed to unload the model DLL. Exit DCM and the application; reboot, and retry. If the error persists, contact your service representative. The configuration service was unable open the DCM database. Verify that there is only one copy of DCM program files and libraries on the PC. Verify that the DCM database is current and properly referenced. Reinstall everything, if necessary. The configuration service was unable to write to the DCM database.Verify that there is only one copy of DCM program files and libraries on the PC. Verify that the DCM database is current and properly referenced. Reinstall everything, if necessary. The configuration service was unable to write to the AFT output file. Exit DCM and the application: reboot, and retry. If the error persists, contact your service representative. The configuration service was unable to open the AFT input (import) file. Verify that the import file exists. If so, exit DCM and the application; reboot, and retry. If the error persists, contact your service representative.
-818
Model DLL not accessible
-819
Freeing model DLL
-820
Opening DB
-821
ERR:Writing to DB
-832
Writing cfg file
-833
Opening input file
13-23
Chapter 13
Error Code -834
Text Reading Input File
Description/Action The configuration service was unable to read from the AFT input (import) file. Exit DCM and the application; reboot, and retry. If the error persists, contact your service representative.
-840
Cannot talk to application The configuration service was unable to connect to the host application DLL to perform an operation that requires data stored in the application. Verify that the host application is properly registered in DCM. Verify that the proper versions of the host application and DCM are installed. Verify that there is only one copy of DCM program files and libraries on the PC. Reinstall everything, if necessary. Opening list The configuration service was unable to initialize the labor account and labor level lists used by the configuration GUI. Exit DCM and the application; reboot, and retry. If the error persists, contact your service representative. The configuration service was unable to set up the labor level list used by the configuration GUI. Exit DCM and the application; reboot, and retry. If the error persists, contact your service representative.
-841
-842
Cannot add lab field to list
-843
Cannot add account to list The configuration service was unable to set up the labor account list used by the configuration GUI. Exit DCM and the application; reboot, and retry. If the error persists, contact your service representative. Getting list info The configuration service was unable to obtain information from the host application regarding whether a validation list was included in the AFT file. Verify that the proper versions of the host application and DCM are installed. Verify that there is only one copy of the DCM program files and libraries on the PC. Reinstall everything, if necessary.
-844
13-24
Kronos Incorporated
Error Messages
Error Code -845
Text Labor entries list size exceeded
Description/Action The configuration service returned an error while building a download file with labor entries. The labor entries list size exceeded what the device supports. Download the build error. Deselect the labor level for download. The configuration service returned an error while building a download file. Retry the operation. The component of the configuration service that builds the download files (AFT or XML) could not be loaded into memory. There may not be enough free memory on the PC. Check the available memory on the PC. Stop any unnecessary programs on the PC and retry.
-850 -851
kErrMemoryException kErrCreatingExport Object
-852
kErrCreatingAppAware Object
The component of the configuration service that defines how to build configuration that is compatible with the host application could not be loaded into memory. There may not be enough free memory on the PC. Check the available memory on the PC. Stop any unnecessary programs on the PC and retry.
-853
kErrCreatingStd Proximity
The configuration service was unable to create the definition for the Kronos standard proximity badge. This format should be sent to a Series 4000 terminal that has a proximity reader. There may not be enough free memory on the PC. Check the available memory on the PC. Stop any unnecessary programs on the PC and retry.
-854
Config service error in building download
The configuration service returned an error while building a download file. Retry the operation.
13-25
Chapter 13
Softload Error Codes

The Softload application is available with Series 4000 terminals. It generates the following error codes:
Text Invalid reply XML file format Invalid manifest file format
Description/Action Make sure communication is working, and try the softload again. The *.krm file is not correctly formatted. Replace the file with a new copy. The *.krm file is not correctly formatted. Replace the file with a new copy. Make sure communication is working, and try the softload again. Make sure communication is working, and try the softload again. Unplug the device and reboot. If you need further assistance, contact your service representative.
-902
Incompatible file version
-903 -904 -905
Error during file upload Authentication failed Device cannot reboot
For more information about the Softload application, see Chapter 11, Loading Files and Data to and from a Device.
13-26
Kronos Incorporated
Error Messages
Data Collection Manager Generic Error Codes

Data Collection Manager applications generate the following error codes. If the description is a DCM internal error, contact your service representative.
Error Code -1000
Text
Description/Action
Error adding the application Internal error. Retry operation. If error reoccurs, to the Data Collection contact your service representative. Manager registration table Error removing the application from the Data Collection Manager registration table. Internal error. Retry operation. If error reoccurs, contact your service representative.
-1001
-1002
The selected application has Internal error. Retry operation. If error reoccurs, not been registered for use contact your service representative. with the Data Collection Manager. An invalid application handle has been specified. Invalid data field received No records found in the application input queue The application has not properly initialized with Data Collection Manager An unregistered Comm Channel was found in the Data Collection Manager database. Error opening the Data Collection Manager data source Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative.
-1003 -1004 -1005 -1006
-1007
-1008
Check that the database is connected, that the ODBC System DSN for the Data Collection Manager is correct, and that the database user name and password are correct.
13-27
Chapter 13
Error Code -1009
Text
Description/Action
This application has already Internal error. Retry operation. If error reoccurs, contact your service representative. initialized the connection with Data Collection Manager. An invalid group name has Enter a valid device group name and retry the been specified. operation. An invalid application name Internal error. Retry operation. If error reoccurs, has been specified. contact your service representative. Only one group per application. No devices found in the given group An invalid device ID has been specified No database has been specified. An invalid message type has been specified. The specified group is already being accessed. The specified file does not exist. Internal error. Retry operation. If error reoccurs, contact your service representative. Assign devices to the specified group or specify another device group and retry the operation. Specify a valid six-digit device ID and retry the operation. Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative. Ensure that the file name is correct and that the file is in the specified location and retry the operation.
-1010 -1011 -1012 -1013 -1014 -1015 -1016 -1017 -1018
-1019
Unable to copy the Check the following: specified file for download. w Available disk space w Share rights to the directory An invalid path has been specified. Internal error. Retry operation. If error reoccurs, contact your service representative.
-1020 -1021 -1022
No message read procedure Internal error. Retry operation. If error reoccurs, has been specified. contact your service representative. Error starting the specified Comm Channel Stop and restart the Sentinel. Contact your service representative if this problem reoccurs.
13-28
Kronos Incorporated
Error Messages
Error Code -1023 -1024 -1025
Text
Description/Action
An invalid Comm Channel Internal error. Retry operation. If error reoccurs, has been specified. contact your service representative. Error stopping the specified Internal error. Retry operation. If error reoccurs, Comm Channel contact your service representative. Specify a telephone number that matches the The specified phone number does not exist in the number assigned to one of the devices that you are attempting to connect to and retry the operation. Data Collection Manager database. The Data Collection Manager database is not open. The specified device already exists. Check that the database is connected, that the ODBC System DSN for the Data Collection Manager is correct, and that the database user name and password are correct. Internal error. Retry operation. If error reoccurs, contact your service representative.
-1026
-1027 -1028
The current program is not Internal error. Retry operation. If error reoccurs, set up with Data Collection contact your service representative. Manager as an application. Unable to write to the transaction output file Unable to open the queue file Check the following:
w w w w
-1029
Available disk space Access rights to the DCM\data directory Available disk space Access rights to the DCM\data directory
-1030
Check the following:
-1031
Unable to mark the current Check the following: record for delete w Available disk space w Access rights to the DCM\data directory Unable to write empty records to the queue file Unable to access the required location in the queue file Check the following:
w w w w
-1032
Available disk space Access rights to the DCM\data directory Available disk space Access rights to the DCM\data directory
-1033
Check the following:
13-29
Chapter 13
Error Code -1034
Text
Description/Action
Unable to write to the queue Check the following: file w Available disk space w Access rights to the DCM\data directory Unable to read from the queue file No queue name specified Error allocating required memory Error locking required memory block Check the following:
w w
-1035
Available disk space Access rights to the DCM\data directory
-1036 -1037 -1038 -1039
Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative.
Error accessing tables in the Check that the database is connected, that the Data Collection Manager ODBC System DSN for the Data Collection database Manager is correct, and that the database user name and password are correct. Error accessing tables in the Check that the database is connected, that the Data Collection Manager ODBC System DSN for the Data Collection database Manager is correct, and that the database user name and password are correct. Error editing records in the Check that the database is connected, that the ODBC System DSN for the Data Collection Data Collection Manager database Manager is correct, and that the database user name and password are correct. Error adding records in the Check that the database is connected, that the Data Collection Manager ODBC System DSN for the Data Collection Manager is correct, and that the database user database name and password are correct. Error updating records in the Data Collection Manager database Check that the database is connected, that the ODBC System DSN for the Data Collection Manager is correct, and that the database user name and password are correct.
-1040
-1041
-1042
-1043
13-30
Kronos Incorporated
Error Messages
Error Code -1044
Text
Description/Action
Error deleting records from Check that the database is connected, that the the Data Collection ODBC System DSN for the Data Collection Manager database Manager is correct, and that the database user name and password are correct. No records found in the given database table Internal error. Retry operation. If error reoccurs, contact your service representative.
-1045 -1046 -1047
End of the current record set Internal error. Retry operation. If error reoccurs, has been reached. contact your service representative. Unable to rename the given Check the following: file name w Available disk space w Access rights to the DCM/data directory w Specification of the input path Unable to open the given file Check the following:
w w
-1048
-1049 -1050 -1051 -1052
The requested application is Internal error. Retry operation. If error reoccurs, already being used. contact your service representative. Invalid type specified for PC name validation Invalid location specified for PC name validation Error writing to log file Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative. Check the following:
w w
-1053 -1054 -1055 -1056
Invalid destination key specified for message
Internal error. Retry operation. If error reoccurs, contact your service representative.
Invalid input path has been Internal error. Retry operation. If error reoccurs, specified contact your service representative. Invalid output path has been Internal error. Retry operation. If error reoccurs, specified contact your service representative. Duplicate message found in Internal error. Retry operation. If error reoccurs, message queue contact your service representative.
13-31
Chapter 13
Error Code -1057 -1058 -1059 -1060 -1061 -1062
Text No message found in message queue Invalid request type specified No list items found in the given list No more items left in the given list Invalid device group specified Specified device is not assigned to any group. Specified device is not assigned to any device group.
Description/Action Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative. Enter a valid device group name and retry the operation. Assign the devices to an specified device group or specify another device group and retry the operation. If the device that you specified is not assigned to any device group, check the configuration of the device groups and assign the device to an appropriate device group.
-1063
-1064 -1065 -1066 -1067 -1068 -1069
Unable to open registry key Internal error. Retry operation. If error reoccurs, contact your service representative. Unable to set registry value Internal error. Retry operation. If error reoccurs, contact your service representative. Unable to get registry value Internal error. Retry operation. If error reoccurs, contact your service representative. Error starting the application connection Error stopping the application connection Unable to remove existing file Stop and start the Sentinel Service. Contact your service representative if this problem reoccurs. Internal error. Retry operation. If error reoccurs, contact your service representative. Check the following:
w w
-1070
Input buffer size is too large Internal error. Retry operation. If error reoccurs, for the request contact your service representative.
13-32
Kronos Incorporated
Error Messages
Error Code -1071
Text
Description/Action
The specified device group Internal error. Retry operation. If error reoccurs, still has devices assigned to contact your service representative. it. The specified group still has Internal error. Retry operation. If error reoccurs, devices assigned to it. contact your service representative. Unable to connect with the Validate that the following items are included in specified application the DCM Communication PC system path: connection library w \kronoscm\dcm w \kronoscm\lib directory Invalid device name specified Specify a valid device name and retry the operation.
-1072 -1073
-1074 -1075 -1076 -1077 -1078
Invalid device ID specified Specify a valid six-digit device ID and retry the operation. Invalid model ID specified Internal error. Retry operation. If error reoccurs, contact your service representative. Specified communication channel already exists No IP address specified Internal error. Retry operation. If error reoccurs, contact your service representative. An Ethernet device requires an IP address. Enter an IP address for the device by using the Device Wizard or the Device Manager.
-1079
No phone number specified A telephone number is required when you add a modem device by using the Device Wizard, the Device Manager, or the Event Manager. Enter the phone number to communicate with the device. No initialization string specified An initialization string is required when you add a modem device by using the Device Wizard or the Device Manager. Select the modem initialization string for the specified device. A port is required when you add a serial or modem device by using the Device Wizard or the Device Manager. Specify the port name.
-1080
-1081
No port name specified
13-33
Chapter 13
Error Code -1082
Text No baud rate specified
Description/Action A baud rate is required for the port when you add a modem or serial device by using the Device Wizard or the Device Manager. Select the baud rate for the port.
-1083
No modem name specified A modem name is required when you add a modem device by using the Device Wizard or the Device Manager. Select a modem name from the Modem string list. No modem string name specified No group specified A modem string is required when you add a modem device by using the Device Wizard or the Device Manager. Specify a modem string. A device group is specified when you add a device by using the Device Wizard or the Device Manager. Assign the device to a device group. If the communication method you specified is not the correct one for the added device, select the correct communication method: Ethernet, modem, or serial. Internal error. Retry operation. If error reoccurs, contact your service representative. The device is the only device assigned to a group that still has employees assigned to it. Reassign employees to another device group, and then try removing the device again. Select a device that has a printer attached to it, or add a printer to the specified device, and then try printing again. Validate that the following items are included in the DCM Communication PC system path:
w w
-1084
-1085
-1086
Invalid communication method specified
-1087 -1088
No transaction table specified Device cannot be removed, it is still being used by the application. Please check to see if employees are still assigned to it. The specified device does not have a printer attached to it. Unable to connect to the Configuration Service library
-1089
-1090
\kronoscm\dcm \kronoscm\lib directory
13-34
Kronos Incorporated
Error Messages
Error Code -1091
Text
Description/Action
No application update state Internal error. Retry operation. If error reoccurs, found for specified device contact your service representative. group The selected group still has employees assigned to it. All employees must be removed from this group before it can be deleted. All employees must be removed from this group before it can be deleted. Make sure that the device group that you remove is not the last device group associated with the host application. Also, make sure that all devices have been removed or reassigned before attempting to remove the device group.
-1092
-1093
The model types cannot be You are unable to copy the device settings from a different when editing or device of one model type to a device of a different copying a device. model type. Make sure that the model types are the same when copying device settings from one device to another. The specified host PC name Internal error. Retry operation. If error reoccurs, contact your service representative. was not found in the database. A local host PC cannot be specified in a network environment. A network host PC cannot be specified in a local environment. Invalid application user Invalid library handle specified You have specified a local PC for a network installation of the Data Collection Manager. Enter a network path to a DCM comm PC. You have specified a network host PC for a local installation of the Data Collection Manager. Enter the name of the local PC. The user does not have DCM access rights defined for the specified application. See your supervisor. Internal error. Retry operation. If error reoccurs, contact your service representative.
-1094
-1095
-1096
-1097 -1098 -1099 -1100
Unable to retrieve database The database information is inaccessible. Check information the database connection or the ODBC setup. Invalid password specified The password that you entered is not correct. Enter the correct password.
13-35
Chapter 13
Error Code -1101
Text
Description/Action
User does not have the The user does not have DCM rights to perform the proper DCM access rights. operation. Modify the users access profile and retry the operation. Improper application licensing Invalid application code specified Initialization error on the connection library The host application that you are trying to run does not have a proper license. DCM internal error. The connection library is unreacheable. Check the database connection. If the database is running, DLLs are missing. Contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative. DCM internal error. Specify a valid device group and retry the operation. If the device group that you are trying to delete still contains devices, reassign the devices to another device group, and then try the operation again. The information in the Service.Properties file is invalid. The MERANT drivers are not properly licensed. Update the license. Internal error. Retry operation. If error reoccurs, contact your service representative. The transaction received from the device contains incorrect information. View and correct the invalid transaction by using the Transaction Data Editor accessed from the Tools menu in the Communication Monitor.
-1102 -1103 -1104
-1105 -1106 -1107 -1108
XLaunch request failure Instance of XLaunched application already exists Invalid device group specified Specified group contains devices
-1109 -1110 -1111 -1112
Authentication service failure Invalid Oracle MERANT driver license Invalid communication status specified Transaction posted to invalid transaction table
13-36
Kronos Incorporated
Error Messages
Error Code -1113
Text Invalid Download Options specified for Device Update. The download options for this device must be modified to specify more than just the device configuration for an update request.
Description/Action You have specified an Update command in the Communication Monitor or the Device Manager with device configuration specified as the only download option. If you send device configuration information to the device, use the Initiate command in the Communication Monitor or the Device Manager. To send information other than device configuration to the device, use the Update command.
-1114
Transaction record A transaction record was longer than 2048 exceeded maximum length characters and could not be successfully collected. and was not processed. Contact your service representative. Invalid MERANT driver license Contact your service representative.
-1115 -1116
Transaction record less than A transaction record was less than 64 characters and could not be successfully collected. Contact minimum length and was your service representative. not processed. An invalid IP address has Verify the IP address format. Do not use leading been specified. IP address zeroes for Series 4000 terminals. octets must be a valid number between 0 and 255 The specified IP address has Enter a different IP address. been used by another device, please enter a different IP address. Exceeded the maximum number of serial devices Exceeded the maximum number of modem devices Exceeded the maximum number of peer devices Consult the DCM documentation for device limits. Consult the DCM documentation for device limits. Consult the DCM documentation for device limits.
-1117
-1118
-1119 -1120 -1121 -1122
Exceeded the maximum Consult the DCM documentation for device number of Ethernet devices limits.
13-37
Chapter 13
Error Code -1125 -1126 -1127 -1128 -1129 -1130 -1131 -1132 -1133 -1134
Text Queue Message is null Queue Message is internal Invalid installation information (Product ID) Hard failure partially through processing Bulk. General SecDLL error Requested API was not found Unsupported Encryption Type Overflow of string buffer.
Description/Action Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative. The system registry has been edited or corrupted. Reinstall Data Collection Manager Software. Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative.
Error starting the Collection Stop and start the Sentinel Service. Contact your Agent service representative if this problem reoccurs. Device is incompatible with Verify the compatibility of devices on the Communication Channel communication channel. type Critical authentication failure Logon authentication failure Incompatible DCM database version Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative. If you are using Workforce Central, upgrade your DCM installation to match the current version of WFC. If using DCM Standalone, ensure all DCM installations are at the same revision.
-1135 -1136 -1137
-1138
Internal error. Retry operation. If error reoccurs, UpdateClients, unsuccessful viewer request contact your service representative. to Collection Agent, unable to convert status
13-38
Kronos Incorporated
Error Messages
Error Code -1139
Text
Description/Action
Database Error: Unable to Internal error. Retry operation. If error reoccurs, contact your service representative. find the SEQ_NAME record for this application in the SEQUENCE table ODBC Error(08002): Connection is in use Internal error. Internal error. Application server failure. No dial-up network connection is specified for a Series 4000 modem terminal Communication Channel. No dial-up network connection found in the phone book specified for Series 4000 modem terminals. Contact your database administrator to check on the maximum number of connections available to the database. Retry operation. If error reoccurs, contact your service representative. Retry operation. If error reoccurs, contact your service representative. Ensure that the Workforce Timekeeper application server is running. Ensure that Series 4000 modem Communication Channels have a valid dial-up network connection specified in Device Manager > Setup > Communication Channels. Series Create a dial-up network connection for use for series 4000 modem devices as specified in Chapter 3, Communication Channels..
-1140
-1141 -1142 -1144 -1145
-1146
-1147
No Host Name specified for Specify a valid Host Name or IP address for the this device. device in Device Manager > Setup> Device Wizard. Duplicate Host Name specified for this device. Host Name for this device resolves to an IP Address assigned to another device Ensure that each device has a unique Host Name or IP address specified in Device Manager > Setup > Device Wizard. The IP address returned for this device based on its DNS name is already assigned to another device in DCM. Contact your network administer to determine which device should have this IP address.
-1148
-1149
13-39
Chapter 13
Text Internal error. Unable to connect to database. The specified database is an Archive.
Description/Action Retry operation. If error reoccurs, contact your service representative. The specified database was created using Workforce Record Manager and cannot be used with DCM. Contact your system administrator to change the DCM data source DSN to point to the production database. Retry operation. If error reoccurs, contact your service representative.
-1152 -1153
Internal error.
Unable to validate DCM Reboot the DCM Communication PC. If error Standalone license - Vendor persists, contact your service representative. daemon not running. Unable to validate DCM Reboot the DCM Communication PC. If error Standalone license persists, contact your service representative. License server not running. Missing properties file for a Language properties files for selected language is specific language. not in the properties directory. Improper language file configuration. Unable to read from the requested file. Properties files may have been deleted or moved. Reinstall DCM to restore properties files. The DCM Comm client was unable to find a download file that was built for an initialize or update. Retry the initialize or update. If the error continues to occur, make sure that there are no processes running on the PC that could be periodically deleting files from the DCM temp directory. Properties files may have been deleted or moved. Reinstall DCM to restore properties files.
-1154
-1155 -1156 -1157
-1158
Unable to open the requested DCM properties file.
-1159
Unable to read information Property file read error encountered. Reinstall from the requested DCM DCM to restore properties files. properties file. Internal error. Property file read error encountered. Reinstall DCM to restore properties files.
-1160
13-40
Kronos Incorporated
Error Messages
Error Code -1161
Text Unable to open the Data Collection Manager database. Please verify that the data base server is running and the Data Collection Manager data source has been properly configured. It is also possible that there are insufficient database connections configured. Specified device is not assigned to the specified group. Invalid Syntax. Error writing to properties file. Error backing up the properties file. Error setting the value for the key. Error getting the value for the key. Firmware file is incompatible with device type. Unable to write out requested Device Report file Requested DCM process not found
Description/Action Verify that the database server is running and that the Data Collection Manager data source has been properly configured. Be sure that sufficient database connections are configured.
-1162
Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative. Property file write error encountered. Reinstall DCM to restore properties files. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative. Property file error encountered. Reinstall DCM to restore properties files. Use the proper firmware and retry operation. If error reoccurs, contact your service representative. Check access rights on all DCM-related disk drives. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative.
-1163 -1164
-1165 -1166 -1167 -1168
-1169
-1170
13-41
Chapter 13
Text Requested DCM process not found Error posting request to DCM Message Processing Agent
Description/Action Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative.
-1172 -1173 -1174 -1175 -1176 -1177 -1178 -1179 -1180 -1181 -1182 -1183 -1184
Request object is not found Internal error. Retry operation. If error reoccurs, in list contact your service representative. Specified device was not found Internal error. Retry operation. If error reoccurs, contact your service representative.
Error adding a device state Internal error. Retry operation. If error reoccurs, contact your service representative. Error removing a device state Device state list is full Error retrieving a device state Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative.
Unable to access the Device Internal error. Retry operation. If error reoccurs, State server contact your service representative. Error reading FIFO file Error accessing allocated required memory Invalid collection method specified Invalid key value was provided for search Internal DCM Error Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative. Internal error. Retry operation. If error reoccurs, contact your service representative.
Specified Communications Internal error. Retry operation. If error reoccurs, port is unavailable contact your service representative.
13-42
Kronos Incorporated
Error Messages
Error Code -1185
Text
Description/Action
Specified Communications Internal error. Retry operation. If error reoccurs, contact your service representative. port is being used by another communications Channel Invalid Communications Port specified Sentinel Service is not running Internal error. Retry operation. If error reoccurs, contact your service representative. Start the Sentinel Service. Retry operation. If error reoccurs, contact your service representative.
-1186 -1187
Data Collection Manager Series 4000 Error Messages

Data Collection Manager applications generate the following error codes. If the description is a DCM internal error, contact your service representative.
Error Code 00000001
Text Communication error
Description/Action Unable to communicate with Series 4000 terminal. Ensure that IP address and device ID for this device are the same in DCM and at the device. Ensure that the device is properly connected to the network and can be pinged from the DCM Communications PC. Retry the operation. Retry the operation. If error reoccurs, contact your service representative. There was en error with the specified file. Refer to the detailed error description for the specific file error, correct the error, and retry the operation.
00000002 00000003
Series 4000 HTTP server error DCM file error
13-43
Chapter 13
Error Code 00000004
Text Series 4000 Message
Description/Action The Series 4000 terminal responded with an information or warning message. Refer to the detailed error description for the specific error, correct the error, and retry the operation. Refer to Error Messages from a Series 4000 Terminal on page 13-57. Contact your network administrator to ensure that the DCM Communications PC has a valid IP address or DNS name assigned to it. Internal Error. Retry the operation. If error reoccurs, contact your service representative. Internal Error. Retry the operation. If error reoccurs, contact your service representative. A required communication channel was not running and will be started by the DCM Sentinel Service. If the communication channel is not restarted successfully, and additional error message is displayed, contact your service representative.
00000005
Unable to determine DCM PC IP Address DCM internal error DCM unknown error Comm Channel is not running, attempting to restart
00000007 00000009 00000029
0000002D Unable to Softload device - The krm file contains an invalid entry. Check the format for each line in the file. bad line in Softload manifest file 0000002E Communication Error A communication failure occurred between DCM and a Series 4000 terminal. A connection to the terminal cannot be opened.
00000101 00000102
Device not found in device Retry the operation. If the error reoccurs, list contact your service representative. DNS lookup failed and no saved IP for this device This device is configured to use a DNS name and the DNS name could not be determined. Ensure that the specified DNS name is correct, and confirm with your network administrator that the DCM Comm PC and the DNS server are properly configured.
13-44
Kronos Incorporated
Error Messages
Error Code 00000103
Text
Description/Action
Device model is The specified device is not compatible with incompatible with installed Workforce Timekeeper. Contact your service application representative to replace the device. Reported device ID does The device ID programmed at the device is not match stored device ID different than the device ID that is specified in DCM. Change the device ID at the device to match the device ID specified in DCM in Device Manager > Setup > Devices. Device model does not support Load Firmware The selected device model does not support the Load Firmware command. Select a device model that does support Load Firmware, or refer to your device documentation to determine how to upgrade the firmware. The specified file does not exist. Check the file path and name and retry the operation. The specified firmware file does not exist. Check the file path and name and retry the Load Firmware operation. Contact your database administrator to ensure that the DCM database source, name, and log on settings are correct and that the database server is operating properly. An internal error occurred. Retry the operation. If the error reoccurs, contact your service representative. An internal error occurred. Retry the operation. If the error reoccurs, contact your service representative. An internal error occurred. Retry the operation. If the error reoccurs, contact your service representative. An internal error occurred. Retry the operation. If the error reoccurs, contact your service representative.
00000104
00000107
00000109
Invalid file or filename
0000010A File does not exist
0000010B
Unable to connect to database
0000010C
Error occurred trying to start or access application
0000010D Error occurred trying to access device list 0000010E Error occurred trying to create the Device List Object Error setting the configuration session
0000010F
13-45
Chapter 13
Error Code 00000110
Text Error closing the configuration session Failure trying to derive a class from a base class Device is disabled
Description/Action An internal error occurred. Retry the operation. If the error reoccurs, contact your service representative. An internal error occurred. Retry the operation. If the error reoccurs, contact your service representative. The specified device is disabled. Enable the device by using Device Manager > Setup > devices or select an enabled device and retry the operation. The current user does not have rights to access the selected firmware download file. Contact your network administrator to provide the appropriate access rights and retry the operation.
00000111
00000112
00000113
File access denied (check permissions)
00000114
API Error: Required device An internal error occurred. Retry the ID was not provided in API operation. If the error reoccurs, contact your call service representative. API Error: Required file specification was not provided in API call An internal error occurred. Retry the operation. If the error reoccurs, contact your service representative.
00000115
00000116
Application is exiting due to An internal error occurred. Disable and Enable an unrecoverable error the DCM Sentinel Service and retry the operation. If the error reoccurs, contact your service representative. Device not found in device The selected device may have recently been list. Device list update assigned to another group or communications pending. Please try again. channel. Retry the operation. Error occurred trying to create the Group List Object. An internal error occurred. Disable and Enable the DCM Sentinel Service and retry the operation. If the error reoccurs, contact your service representative.
00000117
00000118
13-46
Kronos Incorporated
Error Messages
Error Code 00000119
Text Error retrieving Communications PC IP Address from database. Sentinel service request error. Restart the Sentinel Service or reboot.
Description/Action An internal error occurred. Disable and Enable the DCM Sentinel Service and retry the operation. If the error reoccurs, contact your service representative. An internal error occurred. Disable and Enable the DCM Sentinel Service and retry the operation. If the error reoccurs, reboot the DCM Comm PC. If the error reoccurs, contact your service representative. An internal error occurred. Disable and Enable the DCM Sentinel Service and retry the operation. If the error reoccurs, reboot the DCM Comm PC. If the error reoccurs, contact your service representative.
0000011A
0000011B
Sentinel service response error. Restart the Sentinel Service or reboot.
0000011C
Sentinel service finish error. An internal error occurred. Disable and Enable Restart the Sentinel Service the DCM Sentinel Service and retry the operation. If the error reoccurs, reboot the or reboot. DCM Comm PC. If the error reoccurs, contact your service representative. Sentinel service mutex error. Restart the Sentinel Service or reboot. An internal error occurred. Disable and Enable the DCM Sentinel Service and retry the operation. If the error reoccurs, reboot the DCM Comm PC. If the error reoccurs, contact your service representative.
0000011D
00000121 00000122
Sentinel Service is not ready. Verify that the application server is running. Unable to establish a Start it if it is not running. connection to the application server. Please verify that the application server has been started, and is running. Path or other error occurred A Path setting required by DCM is incorrect. trying to initialize the comm Contact your service representative. driver
01001002
13-47
Chapter 13
Error Code 01001003
Text
Description/Action
Database or other error Contact your database administrator to ensure occurred trying to create the that the DCM database source, name, and log CommChan Object on settings are correct and that the database server is operating properly. Database, memory, or other Contact your database administrator to ensure error occurred trying to that the DCM database source, name, and log create the Download Object on settings are correct and that the database server is operating properly. Database or other error occurred building configuration files Database or other error occurred building the configuration file(s) using the manifest file Error building the configuration file(s) Contact your database administrator to ensure that the DCM database source, name, and log on settings are correct and that the database server is operating properly. Contact your database administrator to ensure that the DCM database source, name, and log on settings are correct and that the database server is operating properly. Contact your database administrator to ensure that the DCM database source, name, and log on settings are correct and that the database server is operating properly. Ensure that the imported parameter file is properly formatted and retry the import. An internal error occurred. Disable and Enable the DCM Sentinel Service and retry the operation. If the error reoccurs, contact your service representative. Contact your database administrator to ensure that the DCM database source, name, and log on settings are correct and that the database server is operating properly.
01001004
01001005
01001007
01001008
01001009
Error importing parameter file
0100100A Communication channel or database error trying to createLoadConfigObject() to perform device configuration 0100100B Communication channel or database error occurred trying to create the CCommRequestProcessor Object
13-48
Kronos Incorporated
Error Messages
Error Code 0100100C
Text Communication channel or database error occurred trying to initialize the CCTools DLL
Description/Action Contact your database administrator to ensure that the DCM database source, name, and log on settings are correct and that the database server is operating properly. An internal error occurred. Retry the operation. If the error reoccurs, disable and enable the DCM Sentinel Service and retry the operation. If the error persists, contact your service representative.
0100100D Another instance of this CommChannel is already running
0100100E
Invalid comm channel type The specified communications channel is not compatible with the specified device. Ensure that Series 4000 terminals are assigned only to Comm Channels configured for Series 4000 terminals, and all other devices are configured for Comm. Channels configured for other devices in Device Manager > Setup > Communication Channels. Database or other error Contact your database administrator to ensure occurred trying to build the that the database server is operating properly. Device List An internal error occurred. Retry the Error occurred trying to operation. If the error reoccurs, disable and create the CommClientDialog Object enable the DCM Sentinel Service and retry the operation. If the error persists, contact your service representative. Error occurred trying to create the CCommClientDebugDlg Object Comm channel name not specified An internal error occurred. Retry the operation. If the error reoccurs, disable and enable the DCM Sentinel Service and retry the operation. If the error persists, contact your service representative. An internal error occurred. Retry the operation. If the error reoccurs, disable and enable the DCM Sentinel Service and retry the operation. If the error persists, contact your service representative.
01001010
01001011
01001012
01001013
13-49
Chapter 13
Error Code 01001014 01001015
Text Database lookup failed for Comm channel named Path, Sentinel service, or other error occurred trying to initialize the DCMAPI library Error occurred while reading a database value Unable to retrieve download data to build device configuration files
Description/Action Contact your database administrator to ensure that the database server is operating properly. A Path setting required by DCM is incorrect. Contact your service representative.
01001016 01001019
Contact your database administrator to ensure that the database server is operating properly. An internal error occurred. Retry the operation. If the error reoccurs, contact your service representative. An internal error occurred. Retry the operation. If the error reoccurs, disable and enable the DCM Sentinel Service and retry the operation. If the error persists, contact your service representative. An internal error occurred. Disable and Enable the DCM Sentinel Service and retry the operation. If the error reoccurs, contact your service representative. An internal error occurred. Disable and Enable the DCM Sentinel Service and retry the operation. If the error reoccurs, contact your service representative.
0100101A Unable to load the DCM configuration service to perform device configuration 0100101D Error trying to update the device state - restart Sentinel service 0100101E Cannot find the State Manager process - restart Sentinel service
01001020
No valid download options The only specified download option was selected Employee Biometric information and the specified devices does not support Biometrics. Select valid download options or upgrade the device to support biometrics and retry the operation. Contact your network administrator to ensure Error retrieving DCM that the DCM Communications PC has a valid Collection Agent IP IP address or DNS name assigned to it. Address for use in collection request to device
01001021
13-50
Kronos Incorporated
Error Messages
Error Code 01122001
Text Error trying to stop data collection
Description/Action Unable to successfully complete a Stop Data Collection command. Perform a Start Data Collection Command followed by a Stop Data Collection Command. The specified file is empty. Edit or specify a different file and retry the operation. The specified file is larger than 32K. Divide the file into multiple files less than 32K, and retry the operation.
1132001 1132002
XML file for Series 4000 device is empty XML file for Series 4000 device exceeded 32K
1132003
DCM Configuration An internal error occurred. Retry the Service Exception Detected operation. If the error reoccurs, contact your on LoadConfig service representative. Error finding Load Firmware .krm file - retry Load Firmware. Ensure that a valid .krm file is specified and retry the Load Firmware operation.
1132004
1132005
Unable to Load Firmware to A previous load firmware attempt was in device - previous Load process and failed. Wait for 5 minutes, then Firmware failed. retry the Load Firmware operation. Unable to Softload device remote transactions must first be collected by connecting to the remote server Unable to Softload device biometric templates must first be collected by performing a Collect One or more remote transactions are stored in the device. Ensure that the remote server is enabled and perform the remote transaction to ensure that all remote transactions are collected. Retry the Load Firmware operation. The device has at least one biometric template that must be collected. Retry the Load Firmware operation to collect any available templates.
1132006
1132007
01132008
Unable to Softload device - An Initialization request to stop data collection failed stop data collection failed. Test terminal communication, check request network connection, and retry softload request.
13-51
Chapter 13
Error Code 01132009
Text
Description/Action
Unable to Softload device - An Initialization request to collect request failed primary collection failed. Test terminal communication, check request network connection, and retry softload request. Unable to update device state - restart Sentinel service An internal error occurred. Retry the operation. If the error reoccurs, disable and enable the DCM Sentinel Service and retry the operation. If the error persists, contact your service representative. Reading the serialized download retry archive file resulted in a C++ exception. Allow another download retry time period to expire, and verify success. If repeated failures occur, delete the archive file. Serializing download retry to archive file caused an exception. Delete the archive file as it may be corrupt. Re-run the terminal update or initialize for failed terminals. A communications error occurred. Retry the operation. If the error persists, reboot the Series 4000 terminal and retry the operation. An internal error occurred at the Series 4000 terminal. Retry the operation. If the error persists, reboot the Series 4000 terminal and retry the operation. An internal error occurred at the Series 4000 terminal. Retry the operation. If the error persists, reboot the Series 4000 terminal and retry the operation. The specified file could not be opened. Verify the file name and location and retry the operation.
01172001
011A2001
Exception caught attempting to read download retry archive file from disk Exception caught attempting to read download retry archive file to disk Communications socket error with Series 4000 Non success device status received from Series 4000
011A2002
011D8001
011D8002
011D8003
HTTP Server error (not 200) from Series 4000
011D8004
File open error for Series 4000 related operation
13-52
Kronos Incorporated
Error Messages
Error Code 011D8005
Text
Description/Action
File access or not specified The specified file could not be accessed. error for Series 4000 Verify that the current DCM Comm PC user operation has the proper rights to access the file. File length is zero for Series The specified file was empty. Verify the file 4000 operation name and location and retry the operation. File too large for transfer to The specified file was larger than 32767 bytes. Series 4000 If the file was manually created, split the file into two files. If DCM generated the file, retry the operation. If the error persists, contact your service representative. Unknown error type detected by driver for a Series 4000 operation An unknown error occurred at the Series 4000 terminal. Retry the operation. If the error persists, reboot the Series 4000 terminal and retry the operation.
011D8006 011D8007
011D8008
011D8009
Series 4000 Request status An unknown error occurred at the Series 4000 unknown - no status in xml terminal. Retry the operation. If the error response from device persists, reboot the Series 4000 terminal and retry the operation. Unable to connect to Series 4000 modem device due to a RAS connection problem. Verify proper RAS configuration on the DCM Comm PC and retry the operation.
011D800A Series 4000 RAS connection error
011D800C DCM time out occurred while waiting for a Series 4000 response 011D800D Series 4000 xml packet terminator missing from Series 4000 response 011D9089 Series 4000 is busy and unable to process the request at this time The Series 4000 terminal closed a socket connection before sending xml packet terminator. Check the terminal communciation status. Retry the operation. Retry command at a later time.
13-53
Chapter 13
Error Code
Text
Description/Action
011D900A A command was sent by Allow more time for device to reboot after a DCM when the application softload. Reboot device and allow time to was not running. come up. 011DA003 Series 4000 application detected an invalid verb in the xml document 011DA603 Series 4000 database has reached watermark Series 4000 terminal response. The application received a request from the communication layer that was not a GET, SET, or DELETE. The Series 4000 terminal database is almost full. It has only enough room for punch data. Perform punch collection.
011DA604 Series 4000 database is full The Series 4000 terminal database is full. Perform punch collection.
13-54
Kronos Incorporated
Error Messages from Connecting to Workforce Timekeeper
Error Messages from Connecting to Workforce Timekeeper

The following error messages may occur when users try to use DCM to log on to Workforce Timekeeper:
Error Message Failed before completion. Meaning A fatal error. Solution The web/application server is unavailable. Make sure the application is running and completely started.
Password is about to The users password will This is a warning message. Enter a new expire. expire. password or wait until the current password expires and enter a new one at that time. User information is rejected. Password expired. The user account is rejected. The users password has expired. Verify that the application server is running. Also, verify that you entered the user name and password correctly. When your password has expired, the Enter a New Password dialog box appears. Enter a new password and confirm it.
Password expired, you cannot change. DSN not found. Account is locked out. Account must change password.
The users password has expired and you cannot change it. The Data Source Name cannot be found. Verify that the data source is registered on the application server.
The password has expired.
When a password expires, the Enter a New Password dialog box appears. Enter a new password and confirm it. Log on as a valid DCM user.
This account is not a This account does not valid DCM user. have the proper DCM access rights.
13-55
Chapter 13
Error Message Username or password is either empty or has invalid characters. Maximum number of logon attempts.
Meaning
Solution Enter your user name and password. Passwords are case-sensitive (be sure to use the same uppercase and lowercase letters).
The user has reached the Try again, using a valid logon. maximum number of attempts to log on that is allowed.
13-56
Kronos Incorporated
Error Messages from a Series 4000 Terminal
Error Messages from a Series 4000 Terminal

The following error messages may be sent by a Series 4000 terminal:
Error Message Bio DB full Description The attempt to add a biometric template failed because the bio pod database is full.
Bio invalid template The format of the biometric template in the XML document is not compatible with the biometric unit in the Series 4000 terminal. Bio uncollected transactions One of the following events occurred: A delete all on the biometric data was requested and no unsynced biometric records are on the terminal. w A delete biometric data on an individual employee that has unsynced bio records This does not apply when the employee record is deleted. Deleting an employee does not remove unsynced templates from the POD.
w
Device failure
A generic message that indicates some terminal failure when processing an XML request.
Employee not in App A biometric template request was sent to the terminal for an DB employee that is not in the terminal database. Invalid packet Invalid packet for terminal type Parse error at line x byte offset y Service already active Symbol not found The session header in the XML document that was sent from DCM is not correct. The Series 4000 model number does not support the XML data contained in the document that was sent. The XML file sent to the terminal is not well formatted.
A request to collect data was sent to the terminal when collection was already in process. A command was sent to DCM when the application was not running.
Undocumented error A generic message that means there is no text associated with the code error code.
13-57
Chapter 13
Device Error Messages from a Series 400 Device

This section provides error messages to help isolate the source of any malfunction that occurs while a device is operating.
Interpreting Error Messages

The Series 400 device lists two types of messages that provide helpful information when troubleshooting malfunctions:
w w
Error Messages Status Messages
This section contains the error messages that the Series 400 device lists. It also describes the possible causes of the error message. Additional information about the procedures, steps, and commands referenced in the messages is available in the Series 400 documentation:
Series 400 Guides 400 Series Terminal Configuration Guide 400 Series Terminal Host Software Interface Guide 400 Series Terminal Supervisors Reference 400 Series Terminal Maintenance and Troubleshooting Guide Information Procedures and steps Host commands Supervisor and guard commands Maintenance commands
Note: You can disable error messages 01, 02, and 10 by using Procedure 1, Step 1 of the Series 400 device program. If you are experiencing any badge reading problems, ensure that these error messages are enabled.
13-58
Kronos Incorporated
Error Messages
Message Error 01: BADGE READ ERROR Description/Action The Series 400 device is unable to read the badge correctly, or the bar code symbology is not enabled in the device program. Clean the reader and test the other badges. If the badge is properly encoded, make sure that the bar code symbology has not been disabled (Procedure 11). Error 03: USE FUNCTION KEY The Series 400 device is set to disable simple time and attendance punches. The device accepts only punches that have a function key associated with them. This is usually a requirement of the host system. If this behavior is not desirable, change the associated parameter in the Series 400 device program by using Procedure 5, Step 3, Value 8. Error 04: REPUNCH The Series 400 device rejected a punch because the elapsed RESTRICTION time since the employee last punched is less than the repunch interval. There are separate repunch intervals for home and non-home employees. The home employee repunch interval comes from either a restriction profile or a parameter in the device program (Procedure 7, Step 1). w Non-home employees always have the device program parameter applied to their punches (Procedure 7, Step 2).
w
A possible cause of Error 04 is that the device time was set to some time in the future, some punches occurred, and then the time was corrected. It is OK to erase all punch data stored by the Series 400 device to prevent this error. Erasing data is done with extreme cautionall collected and uncollected first-in first-out (FIFO) data is included. Maintenance mode command 130 erases all FIFO data and all current schedule data for all employees; however, this data does not include individual schedules for employees, just data reflecting that an employee is currently working a shift.
13-59
Chapter 13
Message Error 05: PUNCH RESTRICTED
Description/Action The Series 400 device rejected a punch because, according to the schedule enforcement information stored in the device, the employee is not authorized to punch at this time. The restriction profile includes generic and individual schedules to which the employee is assigned. The Series 400 device (not the 420 or 405 models) rejected a punch because the employee assigned to this badge or PIN number is not a home employee, and cross-punching or entry management features are not enabled. Use the employee list to verify employee device assignments. To enable the punching of non-home employees, change the setting for Procedure 22 in the device program to enable nonhome employees to punch, according to their restriction level.
Error 06: UNKNOWN EMPLOYEE
Error 07: OFF TIME The device rejected a punch because it is configured with an off-time that includes the current time of day. If this behavior is not desirable, do the following: Ensure that the off-times are correct, and that the day-ofweek exclusion(s) are correct. Refer to Procedure 21, Steps 1 through 4 of the device program. w Check to see if the punch requires gate entry but the current time is during a gate off-time. Refer to Procedure 21, Steps 5 through 12.
w
Error 08: PUNCH RESTRICTED
The Series 400 device rejected a punch because the restriction level encoded on the badge does not match the restriction template parameter in the device program. This applies only to non-home employees. Refer to Procedure 22, Step 1, of the device program. A supervisor used a home employees badge while executing supervisor command 5. This command is intended for nonhome employees; supervisor command 2 is the corresponding command for home employees.
Error 09: HOME EMPLOYEE
13-60
Kronos Incorporated
Message Error 10: BADGE DATA ERROR
Description/Action The badge that was swiped was decoded but contains invalid data. For a standard badge, this includes the wrong company code, out-of-range values for one of the three 1-of-7 code fields, and the wrong checksum for a code 3-of-9 badge. If the badge is not a standard badge, it is a generic badge. Use the Series 400 device program to configure the device to accept generic badges. The following are relevant procedures in the device program:
w w w w
Use Procedure 1, Step 2 to enable the use of employee generic badges. Use Procedure 1, Steps 4 through 6 to define characteristics of the employee generic badge bar code. Use Procedure 5, Step 3, Value 64 to enable use of badges for departments and labor accounts. Use Procedure 24, Steps 1 through 3 to define characteristics of the labor accounts for generic bar code badges. Use Procedure 24, Steps 4 through 12 and Steps 14 through 25 to define characteristics of the labor level generic bar code badges (seven labor levels). Set nonzero values in Procedure 24, Steps 4 through 12 to enable the use of expanded labor tracking fields. Use Procedure 25, Steps 1 through 3 to define characteristics of a department generic bar code badge.
Error 11: UNKNOWN EMPLOYEE
The device rejected a punch because it is configured for entry management, and the badge that was swiped is not on the gate lists. Error 11 occurs on the 420 device model when a simple punch badge ID does not result in a gate opening (home employee or gate lists). The 405 device model returns Error 11 when it rejects a badge ID because it is not on the deduct lists. The Series 400 device rejected a department/labor account/ labor level badge because the restriction level encoded on the badge does not match the department badge restriction template specified in the device program (Procedure 22, Step 2).
Error 12: PUNCH RESTRICTED
13-61
Chapter 13
Message Error 13: OUT OF RANGE
Description/Action Error 13 is associated with changing parameter values in the Series 400 device program and appears in any of the following situations: The combination of settings for a generic bar code badge size, date size, and number of digits to ignore is invalid. w Values for employee, department, labor level, and labor account generic bar code badge settings is invalid. w The badge size of a labor level badge is set to that of the labor account badge.
w
Error 14: DEPARTMENT BADGE
The Series 400 device rejected a badge swipe because the badge number is on the department validation list or on one of the labor level validation lists. The device is expecting an employee badge swipe. If this behavior is not desirable, change the setting for Procedure 5, Step 3, in the device program to 128. Exclude the weighted value of 128 to turn off this feature.
Error 16: OUT OF RANGE
Error 16 is associated with changing parameter values in the Series 400 device. Possible reasons for this error message are: The generic bar code data size is longer than the maximum possible length. w The data size specified for the labor account badge does not match the combined data size settings of the labor levels.
w
Error 18: (sent to host PC)
The Series 400 device rejected host command 90 (Set Terminal Program) because the device is operating in program mode. Do the following: Use host command 99 to force the Series 400 device into normal mode. w Use host command 90 to edit the device programs parameters as desired. w For details on host commands, see the Series 400 Terminal Host Software Interface Guide.
w
13-62
Kronos Incorporated
Message Error 19: (sent to host PC)
Description/Action The Series 400 device rejected host command 10 or 11 (Add Home Employee) because the maximum number of home employees the device accommodates has been reached. Do the following: Check the setting for Procedure 4, Step 1 or Step 7, which determines the maximum number of home employees the device accommodates. This is done through host command 89. w Use host command 120#25# to verify that all home employees in the list belong in the list. For the syntax of the host commands, see the Series 400 Terminal Host Software Interface Guide.
w
Error 20: LIST The Series 400 device does not find the list item you are ITEM NOT FOUND trying to modify or delete. Note: Use of error 20 was discontinued in a later flash version. Any attempts to delete items that are not in the list are no longer considered to be an error. If a modify request is anticipated, and the entry is not already in the list, the attempt is treated as an add. Error 21: LIST NOT The specified list is not be found or the list number you FOUND specified is not valid. Error 22: LIST FULL The specified list (to add to) is full. The validation list has the maximum number of items. Check the Series 400 device program setting for the allowable number of entries. See the Series 400 Terminal Configuration Guide to determine which procedure in the device program to check. No memory is allocated for this list. Change the appropriate parameter in the Series 400 device program to allocate memory for the list. See the Series 400 Terminal Configuration Guide to determine which procedure in the device program to check. A change to a list size limit or other memory allocation parameter (translation text) does not fit in the memory available in the device. Check values for the device program, or try using the memory sizing utility MEM400 (described in the Series 400 Terminal Configuration Guide).
Error 23: (sent to host PC)
Error 24: ERROR
13-63
Chapter 13
Message Error 26: OVER CREDIT LIMIT
Description/Action Error 26 is associated with the model 405 Employee Debit Terminal (EDT). The employee attempting a debit transaction is marked by the host system as over the credit limit. Therefore, the device does not allow the employee to perform the transaction. The employee still performs credit transactions. These two error messages appear together and are associated with model 405 Employee Debit Terminal (EDT). The errors indicate that an employee attempting a debit transaction has reached the maximum number of pay period splits. You can split large purchases across multiple pay periods, but these messages warn the employee that this transaction will not be split across multiple pay periods. The transaction is accepted and is forwarded to the host. This message appears when an employee attempts to enter a personal identification number (PIN) at the Series 400 device while PIN entry is disabled. The employee swipes a badge at the Series 400 device instead. If you enable PIN entry by using the device program (Procedure 5, Step 1, Value 1), you also prevent home employees from using PINs (Procedure 16, Step 3) based on their restriction profiles. For details on the procedures, see the Series 400 Terminal Configuration Guide.
Error 27: WILL NOT BE SPLIT Error 28: EMPS SPLIT FULL
Error 30: NEED BADGE
Error 36: WARNING This message appears when an operator tries to enter data at a FIFO FULL device when the first in, first out (FIFO) buffer is full. All punch attempts are rejected until the FIFO is collected and flushed. Do the following as soon as possible: Use host command 100 (Send Complete FIFO) to send data from the device. w Use host command 110 (Clear FIFO) to flush the data from the device.
w
For information on using host commands 100 and 110, refer to the host application collection of data and to the Series 400 Terminal Host Software Interface Guide.
13-64
Kronos Incorporated
Message Error 41: INVALID SCHEDULE
Description/Action The Series 400 device rejected a punch attempt by a home employee because the host system has not sent schedule enforcement information to the device. Schedule information includes restriction profiles and generic schedules and allows the device to determine whether to accept a punch. This error is associated with changing parameter values in the Series 400 device program. The current settings indicate that the shorthand notation feature is enabled (Procedure 25, Step 4), but there is no memory allocated for the labor account list (Procedure 26, Step 7). Use Procedure 26, Step 7 to allocate memory for the labor account list. This error is associated with changing parameter values in the Series 400 device program. The current settings indicate that the shorthand notation feature is enabled (Procedure 25, Step 4), but one of the prompt sequence settings (Procedure 24, Step 13; Procedure 25, Step 8; Procedure 25, Steps 10 through 13; Procedure 44, Steps 1 through 13) is not compatible with the labor levels enabled (Procedure 25, Steps 1 through 3). Another reason for this error message is that the value in Procedure 25, Step 4 is greater than the number of enabled labor levels. The Series 400 device now accepts seven labor levels, but still supports use of just three labor levels. The settings mentioned in the previous paragraph are valid for configurations not using the new labor levels. Procedure 33 was added to specify prompting sequences to support all seven labor levels (not just the new labor levels). For details on the procedures, see the Series 400 Terminal Configuration Guide.
Error 42: CONFIG CONFLICT
Error 43: CONFIG CONFLICT
Error 44: NOT ALLOWED
This error is associated with the break enforcement feature. A home employee attempted an in-punch, but the time since the corresponding out-punch is shorter than the minimum set in the Series 400 device program. The feature is enabled based on the restriction profile associated with the home employee (Procedure 69, Steps 1 through 15), the shift length, minimum break, and minimum meal are determined when the shift first starts (Procedures 61 through 68, Steps 1 through 15).
13-65
Chapter 13
Message Error 50: ERROR
Description/Action The Kronos Options Package (KOP) value stored in the Series 400 device indicates that the downloaded system is for the wrong product (400 versus 550). Contact your service representative. Another reason for this error message is the wrong Softload file was sent to the device. The flash application starts and determines that the KOP bit settings do not agree with the flash application version (420 versus 460). The baud rates set in the Series 400 device program for host communication (Procedure 10, Step 1) and printer communication (Procedure 9, Step 2) are not compatible with the hardware (DUART). If both baud rates are greater than 9600, ensure that they are set to the same rate. This error is also returned when maintenance command 138 is executed to test the integral modem, and the device does not communicate with the modem. The modem is either inoperable or not installed.
Error 59: ERROR
Error 60: TABLE FULL
While executing host command 65 (Create/Edit Bell Schedule Table), the device determined that the time of day for the bell does not exist in the current bell schedule, and that the bell table contains the maximum number of entries (fixed at 48). If necessary, use host command 65 to edit the bell schedule as needed. For information on host command 65, see the Series 400 Terminal Host Software Interface Guide. The bell time specified does not exist in the bell schedule, or the time entered is not a valid time of day. The action the user attempted involves bells or gates, but they are not enabled in the device program. Use of both bells and gates is only possible if the optional I/O daughterboard has been installed. This error is seen when using host commands 65, 66, 120#58#, 121, 122, 123, 124, 129; and maintenance commands 6, 7, l1, 14, 17, 65, 66. This error is also returned if maintenance command 118 is used to interrogate the integral modem, but the integral modem is not enabled. See Procedure 9, Step 1 to enable the integral modem.
Error 61: INVALID BELL TIME Error 62: NOT INSTALLED
13-66
Kronos Incorporated
Message Error 63: ERROR Error 64: ERROR
Description/Action A hardware problem was detected when the Series 400 device was turned on. Contact your service representative. An error was detected during the external loopback test (maintenance command 177 or 182). The required loopback was not completed or there was a hardware failure. If the device is equipped with an internal modem module, ensure that Procedure 9 has been configured with a valid number of rings (1 to 4). A fatal RAM error has occurred during execution of maintenance command 111. Try cold-starting the device. If this fails, return the unit for service. This is a catch-all error message returned when a resource or configuration conflict prevents the Series 400 device from performing a command. Here are some situations when this error is returned:
w w
Error 65: RAM FAULT Error 68: CONFIG CONFLICT
w w
Maintenance command 137 is executed (Reset Printer Port), but the port is being used for host communication. Host command 70 is sent (Store Host Report), but the Series 400 device is not configured to store host reports (Procedure 54, Step 2, Value 2). A change to Procedure 4, Step 7 is nonzero, but perimeter management is enabled (Procedure 41, Step 1, Value 1). A change to Procedure 5, Step 5 includes the value 4, but there is no daughterboard installed or the daughterboard is being used for ringing a bell (Procedure 5, Step 3, Value 1) or is being used for perimeter management (Procedure 41, Step 1, Value 1). A change to Procedure 27, Step 1 is being made, but the device is configured for expanded labor tracking (Procedure 25, Steps 1 through 3 and 10 through 13). A change to Procedure 27, Step 2 is being made, but the device is configured for expanded labor tracking (Procedure 25, Steps 1 through 3 and 10 through 13).
13-67
Chapter 13
Message Error 70: ERROR
Description/Action There is no software loaded in the mainboard flash to support the Datasave or Detailed process that was initiated. Therefore, the boot-EPROM does not contain any code to perform the requested action.
Error 73: (sent to the During the softload process, an attempt to erase flashhost PC) EEPROM failed. Error 74: BAD DEFAULT This error is associated with changing parameter values in the Series 400 device program. The default department or labor level value specified is longer than the size specified in the device program.
Error 75: NO SUCH The department, labor level, or labor account entry is not in ENTRY the validation list. Cross-check list entries in the host system, and download the corrected list to the Series 400 device. Error 76: DUART ERROR Error 77: ERROR Error 78: (sent to host PC) Error 79: (sent to host PC) Error 80: NOT ALLOWED During a Datasave operation, the Series 400 device failed to send all the RAM contents. This is most likely due to a host communication failure. During programming of the I/O daughterboard flash chip, the memory to be programmed was found not to be blank. During the softload process, an attempt to program the flashEEPROM failed. During the softload process of programming the flashEEPROM, the Series 400 device rejected data sent by the host software. A user is attempting to execute a command that is disabled in the Series 400 device program. Refer to Procedure 60 to enable use of the command.
Error 81: NO DATA A user is attempting to select a host report, but either there is AVAILABLE no memory allocated for the host report buffer or there are no reports in the buffer.
13-68
Kronos Incorporated
Message Error 82: BAD DEFAULT
Description/Action A user is attempting to use a default department or labor level assignment, but the default was not found in the validation list. The Series 400 device lists the error message, disregards the default, and prompts for entry of a valid value. The default is not validated when it is specified in the Series 400 device program; it is validated when it is used. Ensure that the default is part of the validation list sent by the host system.
Error 83: ERROR
This error is associated with changing parameter values in the Series 400 device program. A user is attempting to set an invalid function key assignment or use a value that is out of range. Not all models support all possible function key functions. Refer to Procedure 50 to verify a correct function number.
Error 86: PRINTER A user is attempting to access the printer attached to the Series NOT READY 400 device through the serial connection on the I/O daughterboard. Either the printer has not been configured in the device program (Procedure 9, Step 3), or the printer has lost its network connection. Error 87: ERROR This error is associated with changing parameter values in the Series 400 device program. The change affects memory allocation, and the FIFO must be empty to reallocate memory. The host system collects and flushes the FIFO data before the parameter is changed, or you use maintenance command 135 if the saved record FIFO is erased. A legal argument was entered with a value that is out of range, in a command sequence. Reasons for this error message is that non-numeric values were used for numeric-only arguments or that required arguments are not present. A user entered an illegal argument. Reasons for this error message are that numeric values used are too large or too small or not in an acceptable set of values.
Error 92: OUT OF RANGE
Error 94: INVALID ENTRY
13-69
Chapter 13
Message Error 95: INVALID PASSWORD
Description/Action A user entered an illegal password. This error is returned in the following situations: When an invalid password has been entered after attempting to enter maintenance mode, supervisor mode, or guard mode. w When an invalid entry code is entered (gate list or deduct list). w When an invalid communication password is entered when attempting to perform a system restart through maintenance commands 90, 91, 93 or device program Procedures 78, 79, 80. w When a nonmatching password is used with command 69 to change a supervisor or guard password.
w
Error 99: INVALID ENTRY EXCEPTION nn
A user entered a nonexistent command or programming procedure number. An error occurred in the application. Operation of the Series 400 device from this point on is unpredictable and unreliable. Note the exception number (nn). If there are uncollected punches in the FIFO, use host command 101 (Send FIFO From Last Poll) to collect them as soon as possible. For details, see the Series 400 Terminal Host Software Interface Guide. Depending on the cause of the error, all information stored in the Series 400 device is possibly erased. Cold-start the device and perform a softload operation to load a new application to correct the situation. Contact Kronos Global Support and report the device configuration.
Failed on AddNew
This message may appear in a DCM log during a communications check to various devices. It indicates a possible problem updating the DCMCOMMSTATUS table for a device.
13-70
Kronos Incorporated
Appendix A
Theory of Operation
This appendix describes the high-level Data Collection Manager (DCM) architecture and components, and how they interact. This appendix contains the following sections:
w w
Data Flow Architecture Data Flow in the Workforce Timekeeper System
Appendix A
Theory of Operation
Data Flow Architecture

The DCM 5.0 data flow architecture includes the following components:
w w w w w w
Data Transfer Files Queue Files Application Client Transaction Files Sentinel Communication Interface Components
Note: At least one labor level must be defined in your Workforce Timekeeper (WTK) database before you can use your DCM components. All DCM applications function normally, but if no labor level was defined in WTK, application clients cannot log on to the WTK server at start up.
Data Transfer Files

Data transfer files contain transactions, requests, and responses associated with the communication between devices and the application client, or host application. Collected data is transferred between devices and the application client itself. All internal DCM transaction processing is limited to the local PC and DCM does not write any file I/O across the network. Queue files and transaction files are types of data transfer files. The Data Transfer Concept Applications post requests in the communication (comm) channel input data transfer files. The communication channels retrieve the requests, act on them, and post responses to the application input data transfer files.
A-2
Kronos Incorporated
The communication channels also post transactions and messages to the input data transfer files of the specific applications. DCM Application Program Interfaces (APIs) that support each device communication type send data to a data transfer file that is specific for each application. After the application client processes the transaction or message, APIs post a response to a specific data transfer file for each communication channel.
Queue Files
Queue files provide storage for transactions, requests, and responses in the data stream flow. These files, also called data transfer files, may be communication channel queue files or application queue files. They reside in the input data path, dcm\data\queues\PCName.The location for the queue files is defined as part of the application connection and the communication channels configuration and cannot be changed. Queue files provide the following benefits:
w
Data IntegrityQueue files ensure a maximum level of reliability during the transfer of transactions and messages. They prevent data loss during most failure events, for example, a system lockup or power outage at the Communication PC. User TransparencyExcept during system setup, you need not be aware of the existence of data transfer files. They provide complete run-time isolation between the DCM system and the host application. The host application does not have to run while DCM is communicating with the data collection devices.
A-3
Appendix A
Theory of Operation
Application Client
The application client is a DCM executable process that transfers the DCM messages and collected transactions (punches) from queue file to the application connection library that interfaces with the host application. The data is then processed in the host application.
Transaction Files
Transaction files contain transaction data from all devices. Communication channels for Series 400 devices and the DCM Collection Agent for Series 4000 terminals write transaction files based on the host application connection specified for the device in the active data collection group. The transaction output file is created by the communication channel or the Collection Agent for collected transactions from the device. The transaction input file is created by a user or by renaming a trx.out file to a trx.in file that is to be used for reprocessing transactions. Transaction file processing is initiated as part of a scheduled event from the DCM Event Manager or from a manual request in the DCM Communication Monitor. Transactions are routed directly to the host application queue. Manual requests from Communication Monitor or scheduled events from Event Manager are supported for transaction input files at the group or device level. The file name for a specific transaction input file is based on the name of the device group or device. The file, group.in or DeviceId.in, must be located in the \dcm\data\trx directory.
Log Messages
Log messages are posted in the DCM centralized log file based on the log options defined in the System Settings in the Device Manager application. The Log View of the file provides information for audit trails and troubleshooting. For more information about the DCM log file, see Log File Settings on page 4-45.
A-4
Kronos Incorporated
Sentinel
The Sentinel application manages the application connections and communication channels configured for processing on the DCM system. Every DCM communication desktop in the system has a Sentinel process running on it. When the DCM installation is complete, the Sentinel starts automatically when you reboot your system and continues to run in the background when the Data Collection Manager system is in operation. You can open the Sentinel Status window to view, start, and stop application connections and communication channels.
Communication Interface Components

The DCM communication interface consists of the following components:
w w w
Communication channels Communication clients Communication drivers
Communication Channels Communication channels for Series 400 and Series 4000 terminals use the routing information based on the application connection for the device in the active data collection group. Routing, which is based on the application connection, posts all messages, including DCM messages and collected transactions, directly to the application queue.
A-5
Appendix A
Theory of Operation
Communication Clients Each communication channel has an associated communication client. The DCM communication clients are executable programs that handle communication requests. One communication client supports Series 100 and Series 400 devices and one communication client supports Series 4000 terminals. Using the Sentinel, you launch multiple instances or versions of the program to enable communication with different device types. This means the same version of the program supports almost all devices. The communication client retrieves information from the DCM database for the following reasons:
w w w
To obtain parameters for configuring the communication port To obtain parameters for configuring the devices To identify the devices where data is collected
Communication drivers support the DCM communication clients. Communication Drivers The DCM communication driver is a dynamic link library (DLL) that is specific to the data collection method supported by the devices. The communication drivers manage Ethernet, modem, and serial communication for Series 400 devices, and Ethernet and modem communication for the Series 4000 terminals. The communication driver manages handshaking, messaging, and error processing for each device type and implements the high-level APIs that are used to communicate with devices.
A-6
Kronos Incorporated
Data Flow in the Workforce Timekeeper System

This section illustrates the flow of data between a device and a Workforce Timekeeper database. It describes these processes:
w w
Uploading data from a device to the database Downloading data from the database to a device
The following three DCM functions execute uploads and downloads:

w w w
Initialize (download)After you configure devices, you execute Initialize to download the device configuration from the database to the device. Update (download)After a device is initialized, you execute Update to download employee information. Collect (upload)Transactions at the device are collected at the device and sent to the database.
Note: Punches must occur between January 1, 1985, and December 31, 2037.
Uploading Data
Uploading data occurs in any of the following ways:
w w w
The upload, or collection, event is scheduled in the DCM Event Manager. A request is made in the DCM Communications Monitor to retrieve data from devices, and the collection is initiated. A device group is configured for Automatic Data Collection. When a device group is configured for Automatic Data Collection, all online devices in that group are placed in an automatic collection state. A data collection start on a device group from the Communications Monitor.
Figures in the following sections show uploading data from a Series 4000 terminal and a Series 400 device.
A-7
Appendix A
Theory of Operation
Uploading Data from Series 4000 Terminals

Step 4: The transactions are passed to the WTK Services Interface, which makes an XML request to one or more WTK app servers to process the transactions.
WTK database
Services on WTK Application Server

XML data requests
WTK Services Interface (WFCAPI.DLL) DCM/WTK Connection Library DCM WTK Application Client
Application Q file Step 2: XML punch data from all Series 4000 devices is posted to the Collection Agent, then directly to the Application Connection queue file.
Application QIN file
Step 3: The DCM WTK application client reads transactions from the application QIN file.
Collection Agent (HTTP Server)
Communication Channel Series 4000 Communication Driver

DCM HTTP Client
Communication Channel Series 4000 Communication Driver

DCM HTTP Client
Step1: The communication channel receives a request from the application client to retrieve punch data from the Series 4000 devices. The communication channel posts the request to the device and initiates collection.
A-8
Kronos Incorporated
Uploading Data from Series 400 Devices

Step 4: The transactions are passed to the WTK Services Interface, which makes an XML request to one or many WTK application servers to process the transactions.
WTK database
Services on WTK Application Server
XML data requests
Step 3: The DCM WTK app client reads transactions from the application QIN file.
WTK Services Interface (WFCAPI.DLL) DCM/WTK Connection Library DCM WTK Application Client
Step 2: The requesting comm channel receives punch data from the devices and posts the data to the application connection Q file.
Application Q file
Application QIN file
Series 400 Comm Channel Communication Driver

Ethernet, serial, modem
Series 400 Comm Channel Communication Driver

Step 1: The communication channel receives a request from an application to retrieve punch data from a Series 400 device. The request is posted to the device and collection begins.
A-9
Appendix A
Theory of Operation
Downloading Data
Downloading data occurs in one of two ways:
w w
The download event is scheduled in the DCM Event Manager. An initialize or update request is made in the DCM Communication Monitor to download data to devices.
Figures in the following sections show downloading data to a Series 4000 terminal and a Series 400 device.
A-10
Kronos Incorporated
Downloading Data to Series 4000 Terminals

Step 1: Initialize and update requests are posted to the proper comm channel queue file. Step 2: The comm channel processes the request by calling the Configuration Service to build the download file.
DCM Event Manager (Timed Event)
Comm Channel queue file(s)
XML
Configuration Service WTK Connection Library
Series 4000 Communication Channel Series 4000 Communication Driver

DCM HTTP Client
Step 3: The Configuration Service builds the required XML download files by looking in the data file repository or querying the application and the database for the proper data.
Step 4: The XML download files are transferred to the specified devices.
Step 5: The result from each device download is posted to the Communication Status table in the database and the application connection log file.
DCM Log file
A-11
Appendix A
Theory of Operation
Downloading Data to Series 400 Devices
Step 1: Initialize and update requests are posted to the proper comm channel queue file. Step 2: The comm channel processes the request by calling the Configuration Service to build the download file.
DCM Event Manager (Timed Event)
Comm Channel queue file(s)
AFT
Configuration Service WTK Connection Library
Series 400 Communication Channel Communication Driver

Step 3: The Configuration Service builds the required AFT download files by looking in the data file repository or querying the application and the database for the proper data.
Step 4: The AFT download files are transferred by the comm channel to the specified . devices.
Step 5: The result from each device download is posted to the Communication Status table in the database and the application connection log file.
DCM Log file
A-12
Kronos Incorporated
Appendix B
Modifying INI File Values
This appendix provides information about using INI file values with the Data Collection Manager system. The DCM INI file is called krdcm.ini and is found in kronos\wfc\dcm. This appendix contains the following sections:
w w w w w
Setting Bulk Processing Setting the Sentinel Service Status Automatic Refresh Intervals Database Disconnect Retry Wait Time Registering a New Communication PC Registering a New Communication PC
Caution: You must have system administrator privileges and advanced knowledge of INI files to use the features described in this appendix, or data corruption is a possibility.
Note: Changes to the INI files affect your system. Contact your service representative before making changes to ensure your systems integrity. Before you modify your INI file, be sure to make a backup copy.
Appendix B
Setting Bulk Processing

The default for bulk transaction processing is 1 (on), which enables Bulk Transaction Processing. You can modify this parameter in the krdcm.ini file, located in the local DCM directory.
[Data Collection Manager] Bulk Transaction Processing = 1 on
B-2
Kronos Incorporated
Setting the Sentinel Service Status Automatic Refresh Intervals
Setting the Sentinel Service Status Automatic Refresh Intervals

You can modify the values for setting the automatic refresh intervals for the Sentinel Status dialog box and for the DCM system display. The Display Update Interval value, in seconds, changes the time between refresh operations in the Sentinel Status dialog box. The default is 60 seconds, and the minimum is 30 seconds. If you want to change the default, add a line similar to the following example to your krdcm.ini file. Example [Sentinel] Display Update Interval = 120 //Set update interval to 120 seconds
B-3
Appendix B
Database Disconnect Retry Wait Time

The value for Database Disconnect Retry Wait time allows you to specify the time in seconds, between database reconnection attempts. This occurs when the Sentinel becomes disconnected from the database. The default value is 60 seconds and the minimum value is 30 seconds. To change the default, add a line similar to the following example in your krdcm.ini file. If you add this line, system performance is possibly affected if the database is disconnected. Example [Data Collection Manager] Database Disconnect Retry Wait time=120 //data retry every 120 seconds (2 min.)
B-4
Kronos Incorporated
List Size Settings
List Size Settings

The default settings for list size growth in the krdcm.ini file are as follows: [Configuration Services] Emp List Growth Size = 300 Gate List Growth Size = 500 Comment List Growth Size = 100 Pay Code List Growth Size = 100 Account List Growth Size = 300 Dept List Growth Size = 300 Labor Level List Growth Size = 100 The absolute list size varies with the device as indicated in the following table. List size is not allocated for Series 4000 devices. Depending on the physical memory of a device, a list of maximum size may not fit.
480/470 Devices 65535 127 1400 65535 65535 65535 999 999 460/450 Devices 500 127 1400 65535 65535 65535 999 999 540T Device 500 N/A N/A N/A 65535 65535 999 N/A
List Employee Messages Non-home messages Gate list Labor level Labor account Pay codes Comment codes
B-5
Appendix B
Registering a New Communication PC

The comm PC Registration utility provides a simple way to change to another comm PC in the event that the first comm PC is no longer available. Note: The PC Registration utility is for use only with systems that have a single comm PC. DCM installs the CommPCReg.exe in the DCM directory when you select to install a comm PC. The installation does not create a shortcut icon or program menu selections for the CommPCReg utility. Double-click the executable in Windows Explorer. To register the new comm PC: 1. Double-click CommPCReg.exe in the DCM directory. The utility detects the new comm PC name and lists it in the comm PC Registration dialog box for you to verify. Note: The comm PC name has a maximum of 15 characters and matches the system name as it is defined in the system network settings. 2. If the PC name is correct, click Register comm PC to continue. To exit the utility, click Close. 3. In the pop-up message, click Yes to confirm your selection and continue to the next step. The utility checks to see if DCM is installed on the PC as the comm PC. If not, the utility lists an error message and aborts the process. Note: The database must be running. If the utility is unable to connect to the database, you receive an error message and the utility ignores the rest of the process. The utility now checks to see whether any of the defined application connections are set up in the network configuration. If so, the utility lists a confirmation message to change all connections to the Local comm PC setup.
B-6
Kronos Incorporated
Registering a New Communication PC
4. Click Yes to convert any application connections that are set up in the network configuration, to run in Local configuration on the comm PC. The utility checks to see whether any defined communication channels are set up in the network configuration. If so, the utility lists a confirmation message to continue to convert all communication channels to the Local comm PC setup. 5. Click Yes to continue. The utility finishes the registration process and lists a success message. 6. Click Close to exit the application.
B-7
Appendix B
B-8
Kronos Incorporated
Appendix C
Understanding and Accessing Punch/Transaction Data
This appendix provides information about using the records events (such as, punches, labor account transfers, tip entries) in the collected transactions from devices. This chapter contains the following topic:
w
Understanding Collected Transaction Records
Appendix C

After you configure a Series 100 device, Series 400 device, or Series 4000 terminal (after you set the parameters in the device program), the device uses its remaining random access memory to store punches and other event data. This memory forms the device's collected transactions buffer. For every event that takes place at the device, the device writes a record to the collected transactions buffer. Records are stored in different modes, depending on who performs the activities at the device:
w
Records resulting from activities performed by employees or supervisors who punch in and out every day are stored in employee mode. Examples of these activities are in-punches and out-punches, pay code transactions, and labor transfers. Records resulting from special activities performed by management or maintenance personnel are stored in supervisor, guard, or maintenance mode. Examples of special activities are login, logout, restriction overrides, gate transactions, and cancel meal deductions. These records are explained in Supervisor, Guard, and Maintenance Transaction Records on page C-22.
Collected Transaction Record Identifiers and Data Fields

The device stores different types of records in its collected transactions buffer based on activities performed. Most transaction records contain several data fields after the record identifier and time stamp. The fields that are present in a record depend on the collected transaction record type, for example punch, tips, daylight-saving. The following table lists record data fields for understanding the DCM transactions formats described in the following sections.
C-2
Kronos Incorporated
Symbol aa
Collected Transaction Record Description Field Activity code Two-digit field. Values for the field range from 0-20 and correspond to an activity code that is associated with a period of work.Implications such as pay code are interpreted by the host software. Badge reader One-digit field that indicates how the employee ID was entered for the event. Valid values are as follows:
w w w w w
0 Not applicable 1 Integral reader 2 First remote reader 3 Second remote reader 4 No reader (PIN)
ccc
Pay code number
Field of up to three digits. The host software uses pay code numbers to calculate and store the types of hours worked. Collected transaction records associate the pay code with either a duration of time or a dollar amount. Alphanumeric field of up to 20 characters. The host software uses it to track labor other than by pay code or by employee. One-digit field that indicates the device has detected an unusual entry management event.Valid values are as follows:
w w w w
dddddd e
Simple labor account Entry event
0 Not applicable 1 Gate forced open 2 Gate open too long 3 Gate finally closed
Gate code
One-digit fixed length field that indicates what type of entry management was performed. Valid gate codes are as follows:
w w w w
0 Not applicable 1 Entry allowed (gate opened) 8 Punch allowed (gate not opened) 9 Entry denied
C-3
Appendix C
Symbol hhhhh
Collected Transaction Record Description Field Time Variable-length numeric field that represents the number of minutes, from midnight (00:00) of the collected transaction reference date. The date associated with the time of day can be another field in the transaction record, or the transaction report reference date (Z record). Examples: hhhh can be the number of minutes from midnight on the effective date for the transaction or the amount of time to be added or subtracted from a pay code (expressed in minutes). w hhhhh can be the number of minutes from midnight (00:00) of the collected transaction reference date.
w
iiiiiiiii
Employee ID Variable length nine-digit field. Employees are represented by a numeric string in collected transaction records. In the device, the employee ID is equivalent to the badge number or PIN. Function key code Two-digit fixed-length field. The device has function keys to represent various time and attendance and labor tracking functions.
kk
lf3|lf2|lf1 or lf7|lf6|lf5| lf4|lf3|lf2| lf1
Labor account Variable length alphanumeric field. The labor account is in fixed subfield order; each subfield has a maximum length of 20. The lf3|lf2|lf1 format is used for all device firmware versions except 400.6 and later versions. (Pre-400.6 versions supported up to three labor levels. 400.6 supports up to seven labor levels.) The maximum number of characters for this field is 30 characters. The lf7|lf6|lf5|lf4|lf3|lf2|lf1 format is used by devices using version 400.6 of the device firmware, which supports up to seven labor levels. It is used if the labor account structure includes any of levels 4 through 7. The maximum number of characters for each labor entry is 20; the maximum number of characters for this field is 140 characters, not including the delimiters ( | ). The labor level delimiters ( | ) are always present even if there is no value for a labor level. The host uses labor accounts to track labor other than by pay code or by employee.
C-4
Kronos Incorporated
Symbol mmmm nnnnnn
Collected Transaction Record Description Field Minutes from Field of up to four digits. The value represents a time of day midnight expressed in minutes. Quantity Field of up to six digits. The value that the quantity field represents varies depending on the record type. Examples: nnn can be the number of minutes to move from one pay code to another. w nnnnn can be the effective date (a date since 1/1/85) for a pay code transaction.
w
ooooooo p
Gross receipts Field of up to seven digits. The value is associated with a tips amount (a quantity record field). Punch code One-digit field that identifies the type of punch. In order for this field to be included, punch typing must be enabled in the device program. Valid punch codes are as follows:
w w w w w w w w w w
0 Unknown (not important) 1 Out-punch 2 In for new shift 3 In from break 4 In from meal 5 Dept./labor transfer while in 6 In from meal or break 7 Gate entry only 8 Cross punch 9 Restricted (violation)
Opened gate
One-digit field that identifies which gate was involved with the entry management event. Valid values are as follows:
w w w w
0 Not applicable 1 First gate 2 Second gate 8 No gate
C-5
Appendix C
Symbol r
Collected Transaction Record Description Field Direction One-character field that represents on/off, forward/ backward, or plus/minus. The possible values for this field are as follows: + represents on, forward, or plus; and represents off, backward, or minus. For example, + in a pay code transaction can specify the addition of hours. Two-digit field that represents the identification number of the guard, supervisor, or maintenance personnel who performed the edit, transaction, or override. The maintenance ID is always 99. A supervisor code of 98 indicates the record was generated through an employee edit function. Two-digit field that is part of the collected transaction record time stamp and is the seconds at which the event took place. By default, events are recorded only to the minute. One-digit field. Valid values are:
w w
ss
Supervisor code
tt
Seconds
Affect overtime
1 Transaction affects overtime 0 Transaction affects overtime
ww x
Supervisor The host interprets this field as a reason for a supervisor to comment code generate the collected transaction record. Message status One-digit field. The field reflects action by an employee when an individual message is viewed. The host software interprets the value. Valid values are as follows:
w w w w
1 Message acknowledged 2 Message display was not finished 3 Message not acknowledged 4 Message previously acknowledged
yyy
Message index Message age
Field of up to three digits, which is the individual message index (1 through 127) indicating a particular message in the message dictionary. One-digit field that represents the number of days elapsed since the individual message was assigned.
C-6
Kronos Incorporated
Collected Transaction Record Formats and Syntax

This section presents a general description of each type of collected transaction record, followed by the record's format and an example. The symbols listed in the Collected Transaction Record Identifiers and Data Fields on page C-2 represent the record's data fields. Keep the following points in mind:
w
The examples of collected transaction record formats presented in this section include line breaks where necessary because of page format restrictions. These records are actually reported on one line. Where applicable, the description indicates the host command or the command you can perform at the device or both that causes the collected transaction record to be written. The DCM Comm client (Series 100 devices and Series 400 devices) and Collection Agent (Series 4000 devices) handle translation of each record type from device-specific format to DCM transaction message format.
DCM collects transactions from the device and translates the transaction records from the device-specific format to the DCM transaction message format. The transaction is stored in this translated format in the Transaction output file (group.out). The transaction is also stored in the Bulk transaction file (.btx) or in the queue file (app.q )or both based on the DCM configuration for data collection. The following table defines the format of the DCM formatted transaction:
Offset Length Field 0 1 21 36 37 38 41 49 1 20 15 1 1 3 8 6 cStatus Domain DeviceId Type Key Date Time Comments Character # Domain (Device Group) for source device Native 6-digit address of device Record type identifier (implementation-defined) Transaction Key (Transaction Code) Trx Date MMDDYYYY Trx Time HHMMSS
DeviceType Type of device (P)eriodic, (D)irectConnect, etc.
C-7
Appendix C
Offset Length Field 55 56 61 62 63 1 5 1 1 DST Timezone Online Delimitor Data
Comments Trx created during DST? (1 or 0) Timezone ID Online indicator (1 or 0) Field delimiter for Data Beginning of Data (format depends on Type and Key)
Example format:
01234567890123456789012345678901234567890123456789012345678901234567890 | | | ||| | | |||||
#Group1 111111 122520031530001130110#|<--- Data begins here
DAA
The numbers 0,19 represent the position index for the transaction fields as an example. It is not included in the transaction file. This example shows that Transaction A (Simple Punch) was collected from device ID 111111 from group Group' on 12/25/2003 at 15:30:00. The badge number and other details specific to this transaction appears in the Data section. Example of transactions: Simple Punch Record (A) #Group 1 111111 PAA 062620021322001130110#402#1###
Labor Transfer Record (B) #Group 1 111111 PBB 062620021322001130110#402#701|601|501|401|301|201|101##5#0### Examples of other transaction types: #Group 1 061228 PGG 062620021323001130110#98#9#2001# #Group 1 061228 PLL 062620021324001130110#+#675#2001#3 #Group 1 061228 PII 062620021331001130110#98#6385#0#+#300#0#2#2001#301|201|101# #Group 1 061228 PEE
C-8
Kronos Incorporated
062620021332001130110#98#6385#812#2001#5#301|201|101# #Group 1 061228 PVV 062620021335001130110#1#2001#6#0#301|201|101# #Group 1 061228 PVV 062620021336001130110#0#2001#7#0#301|201|101# #Group 1 061228 PCC 062620021341001130110#2#0# #Group 1 061228 PKK 062620021341001130110#2#6385#821#+#550#1#2001# #Group 1 061228 PCC 062620021342001130110#2#1# #Group 1 061228 PCC 062620021342001130110#2#0# #Group 1 061228 PEE 062620021342001130110#2#6385#822#2001# #Group 1 061228 PHH 062620021343001130110#2#6385#823#2001# #Group 1 061228 PJJ 062620021343001130110#2#6385#823#300#1#2#2001# Punch Record (A) The device writes a record when the terminal is operating in employee mode, and an employee swipes a badge or manually enters a PIN number. The punch record is translated to an A transaction type record when collected by DCM.Format of an A record in the DCM transaction message format contains the following data:
#iiiiiiiii#p#g#q#b#
The following list describes the data fields, in the order they appear in the record format:
w w w w w
iiiiiiiii is the employee ID (badge number). p is the punch type (optional). g is the gate code (optional). q is the gate number (optional). b is the employee badge ID source (optional).
C-9
Appendix C
Example: #402#1#### In this example, employee 402 punched in and the device processed that punch as an out punch (1). The punch date and time are included in the DCM message. Labor Transfer Record (B) Labor transfer record is generated in one of the following modes:
w
The terminal is operating in employee mode, and an employee executes the labor transfer function using the configured # key (Series 400 devices) or soft key (Series 4000 devices). The terminal is operating in supervisor mode, and an supervisor executes the labor transfer function in maintenance or supervisor mode.
The labor transaction record is translated to a B transaction type record when collected by DCM. The format for a B record in the DCM transaction message format contains the following data:
#iiiiiiiii#lf7|lf6|lf5|lf4|lf4|lf3|lf2|lf1#g#kk#p#ss#ww#q#b#
w w w w w w w w w
iiiiiiiii is the employee ID (badge number). lf3|lf2|lf1 or lf7|lf6|lf5|lf4|lf3|lf2|lf1 is the labor account (optional). g is the gate code (optional). kk is the optional function key code (1 to 12). p is the punch type (optional). ss is the supervisor number (optional). ww is the supervisor comment code (optional). q is the gate number (optional). b is the employee badge-ID source (optional).
C-10
Kronos Incorporated
Example:
#402#701|601|501|401|301|201|101##5#0####
In this example, employee 402 was transfer to labor account 701|601|501|401|301|201|101. The punch date and time are included in the DCM message. Add-a-Punch Record or Delayed Labor Transfer Record (E) When a supervisor performs the function of Pay Code Money Edit at the device by using the assigned function key or using the device-supported command, it generates a Decimal Transaction record at the device. A Decimal Transactions is translated to a K transaction type record when collected by DCM. Format of an E record in DCM transaction message format contains the following data:
#ss#nnnnn#hhhh#iiiiiiiii#kk#lf7|lf6|lf5|lf4|lf3|lf2|lf1#aa#ww#
w w w w w w w w
ss is the supervisor number. nnnnn is the effective date (days since 1/1/85) for the pay code transaction. hhhhh is the number of minutes from midnight on the effective date for the added punch. iiiiiiiii is the employee ID (badge number). kk is the optional function key code (1 to 12). lf3|lf2|lf1 or lf7|lf6|lf5|lf4|lf3|lf2|lf1 is the labor account (optional). aa is the activity code (optional). ww is the supervisor comment code (optional).
Example:
#1896#01#5155#120#402#0#701|601|501|401|301|201|101#012#05#16##
C-11
Appendix C
In this example, the device writes an Add-a-Punch record to the transaction at 7:36 a.m. (1896 minutes past midnight of the transaction reference date). Supervisor 01 added a punch for the date 2/9/99 (5155 days past 1/1/85) at 2:00 A.M. (120 minutes past midnight) for employee 402. The labor account is 701|601|501|401|301|201|101. Future hours aree associated with activity code 05. The supervisor entered a comment code of 16. No function key is associated with the punch (0). The punch date and time are included in the DCM message. Function Key Record (F) The device writes an F Function Key record to the transaction when an employee presses a function key that is configured as a generic function key. The host software program interprets this punch. Format of an F record in DCM transaction message format contains the following data:
#iiiiiiiii#kk#g#q#b#
w w w w w
iiiiiiiii is the employee ID (badge number). kk is the function key. g is the gate code (optional). q is the gate number (optional). b is the employee badge ID source (optional).
Example:
#402#2#1###
In this example, the device wrote a Function Key record to the transaction at 9:21 a.m. (2001 minutes past midnight of the transaction reference date), employee 402 pressed function key 2, and the gate was opened (1). The punch date and time are included in the DCM message.
C-12
Kronos Incorporated
Delete-a-Punch Record (H) When a supervisor performs the function of Delete Punch at the device by using the assigned function key or using the device-supported command, it generates a Delete-a-Punch transaction record at the device. Delete-a-Punch Transactions are translated to H transaction type records when collected by DCM. The format of an H record in DCM transaction message format contains the following data:
#ss#nnnnn#hhhh#iiiiiiiii#kk#lf7|lf6|lf5|lf4|lf3|lf2|lf1#aa#ww#
w w w w w w w w
ss is the supervisor number. nnnnn is the effective date (days past 1/1/85) for the pay code transactioon. hhhhh is the number of minutes from midnight on the effective date of the deleted punch. iiiiiiiii is the employee ID (badge number). kk is the function key code (optional). lf3|lf2|lf1 or lf7|lf6|lf5|lf4|lf3|lf2|lf1 is the labor account for the deleted punch (optional). aa is the activity code (optional). ww is the supervisor comment code (optional).
Example
#01#5155#120#402#0#012###
In this example, the device wrote a delete-a-punch record to the transaction at 7:31 a.m. (1891 minutes past midnight of the transaction reference date). Supervisor 01 deleted a punch for the date of 2/9/99 (5155 days past 1/1/85) at 2:00 A.M. (120 minutes past midnight) for employee 402. No function key is associated with the punch (0), the punch is associated with labor account 012, no activity code was entered (aa), and the supervisor did not enter a comment code (ww). The punch date and time are included in the DCM message.
C-13
Appendix C
Add or Subtract Pay Code Hours Record (I) When an employee or supervisor performs the function of Pay Code Hours Edit at the device by using the assigned function key or using the device supported commands, it generates a Category Transaction record at the device. Category Transaction are translated to an I transaction type record when collected by DCM. A supervisor uses either the assigned function key or command 52 at the device, either in supervisor or in maintenance mode, to add or subtract hours from a pay code for an employee. Format of an I record in the DCM transation message format contains the following data:
#ss#nnnnn#hhhh#r#hhhh#v#ccc#iiiiiiiii#lf7|lf6|lf5|lf4|lf3|lf2|lf1#ww#
w w w w w w w w w w
ss is the supervisor number. nnnn is the effective date (days since 1/1/85) for the pay code transaction. hhhh is the number of minutes from midnight on the effective date for the transaction. r determines whether hours are added (+) to or subtracted (-) from the pay code. hhhh is the amount of time to be added or subtracted from the pay code, expressed in minutes. v determines whether the transaction affects overtime (1) or does not affect over-time (0). ccc is the pay code number. iiiiiiiii is the employee ID (badge number). lf3|lf2|lf1 or lf7|lf6|lf5|lf4|lf3|lf2|lf1 is the labor account (optional). ww is the supervisor comment code (optional).
Example:
#62#5155#120#+#240#1#14#402###
C-14
Kronos Incorporated
In this example, the device wrote a Pay Code Transaction record to the transaction at 1990 minutes past midnight of the transaction reference date. Supervisor 62 performed a transaction by using an effective date of 2/9/99 (5155 days past 1/1/85) and an effective time of 2:00 A.M. (120 minutes past midnight), to add (+) 4:00 (240 minutes). The hours do affect overtime calculations (1), using pay code 14 for employee 402. There is no labor account (lf3|lf2|lf1) and no comment code (ww). The punch date and time are included in the DCM message. Move Pay Code Hours from One Pay Code to Another Record (J) When a supervisor performs the function of Pay Code Hours Adjustment at the device by using the assigned function key or using the device-supported command, it generates a Category Adjustment transaction record at the device. Category Adjustment transaction is translated to a J transaction type record when collected by DCM. The format of a J record in DCM transaction message format contains the following data:
#ss#nnnnn#hhhh#r#nnnn#ccc#ccc#iiiiiiiii#lf7|lf6|lf5|lf4|lf3|lf2|lf1#lf7|lf6|lf5|lf4|lf3|lf2| lf1#ww#
The following list describes data fields, in the order they appear in the record format:
w w w w w w w w w
ss is the supervisor number. nnnnn is the effective date (days past 1/1/85) for the pay code adjustment. hhhh is the number of minutes from midnight on the effective date for the adjustment. r determines whether the decimal quantity is added (+) to or subtracted (-) from the pay code. nnnnnn is the amount (in hundredths with implied decimal; for example, 60000 equals 600.00). ccc is the pay code number. iiiiiiiii is the employee ID (badge number). lf3|lf2|lf1 or lf7|lf6|lf5|lf4|lf3|lf2|lf1 is the labor account (optional). ww is the supervisor comment code (optional).
C-15
Appendix C
Example:
#1789#93#5155#120#+#400#14#402###
In this example, the terminal wrote a Pay Code Adjustment record to the transaction at 6:56 a.m. (1856 minutes past midnight of the transaction reference date). Supervisor 38 performed the transaction by using an effective date of 2/9/99 (5155 days past 1/1/85) and an effective time of 2:00 A.M. (120 minutes past midnight) to move 5:05 (325 minutes) from pay code 14 to pay code 15 for employee 402. The supervisor used labor account 701||||||101 for pay code 14 and labor account 708||||||101 for pay code 15 and did not include a comment code (ww). The punch date and time are included in the DCM message. Decimal Transaction Record (Add/Subtract Pay Code Money) (K) The device writes a Decimal Transaction record to the transaction when a supervisor uses either either the assigned function key or command 55 at the device (in supervisor or maintenance mode) to add or subtract a decimal quantity (typically a currency amount). The format of a K record in DCM transaction message format contains the following data:
#ss#nnnnn#hhhh#r#nnnn#ccc#ccc#iiiiiiiii#lf7|lf6|lf5|lf4|lf3|lf2|lf1# lf7|lf6|lf5|lf4|lf3|lf2|lf1#ww#
w w w w w w
ss is the supervisor number. nnnnn is the effective date (days past 1/1/85) for the decimal transaction. hhhhh is the number of minutes from midnight on the effective date for the trans-action. r determines whether the decimal quantity is added (+) or subtracted (-) from the pay code. nnnnnn is the amount (in hundredths with implied decimal, for example, 60000 equals 600.00). ccc is the pay code number.
C-16
Kronos Incorporated
w w w
iiiiiiiii is the employee ID (badge number). lf3|lf2|lf1 or lf7|lf6|lf5|lf4|lf3|lf2|lf1 is the labor account (optional). ww is the supervisor comment code (optional).
Example:
1789#93#5155#120#+#400#14#402 ###
In this example, the device wrote a Decimal Transaction record (K) to the transaction at 5:49 a.m. (1789 minutes past midnight of the transaction reference date). Supervisor 93 performed the transaction using an effective date of 2/9/99 (5155 days from 1/1/85) and an effective time of 2:00 A.M. (120 minutes past midnight) to add (+) $4.00 (400) to pay code 14 for employee 402. There is no labor account (lf3|lf2|lf1) and no comment code (ww). The punch date and time are included in the DCM message. Tips Record (L) The device writes a Tips record to the transaction when an employee enters a tip amount (a decimal amount) at the device. You use the device program to enable employees to enter tips using either a function key, tips keys on the keyboard (+ and - keys), or out-punch processing. The format of an L record in DCM transaction message format contains the following data:
#r#nnnnn#iiiiiiii#kk#dddddd#llf7|lf6|lf5|lf4|lf3|lf2|lf1#ooooooo#
w w w w
r determines whether the entered amount is added (+) or subtracted (-) from the tips pay code. nnnnnn is the tip amount (in hundredths with implied decimal, for example, 500 equals 5.00). iiiiiiiii is the employee ID (badge number). kk is the function key code (optional).
C-17
Appendix C
w w
lf3|lf2|lf1 or lf7|lf6|lf5|lf4|lf3|lf2|lf1 is the labor account (optional). ooooooo is the gross receipts amount (optional).
Example:
#+#50033#402###
In this example, the device wrote a tips record (L) to the transaction at 9:30 a.m. (2010 minutes past midnight of the transaction reference date). A positive (+) tips amount of $5.00 (500) is added to the tips pay code for employee 402. There is no labor account (lf3|lf2|lf1, or lf7|...|lf1) and no gross receipts amount (ooooooo). The punch date and time are included in the DCM message. Entry Management Record (S) Only Gatekeeper devices (model 420) can generate an entry management record. The perimeter management function detects three events that are indicated in this collected transaction record. None of the events are directly associated with a punch. They all represent abnormal perimeter management conditions that are detected by monitoring attached hardware. The format of an S record in DCM transaction message format contains the following data:
#v#q#
w w
v is the type of entry management event. q is the gate associated with the event.
Example:
#16#3#2#
C-18
Kronos Incorporated
This example shows that a Gatekeeper device wrote an entry management record (S) at 1:52 A.M. (1552 minus 1440 divided by 60 equals 1.867 hours) and 16 seconds. The event that occurred was a gate closing (3). The gate involved was the second gate (2). The punch date and time are included in the DCM message. Hourly Time Stamp Record (T) The device writes an hourly Time Stamp record to the transaction every hour on the hour (if you enable this feature in the device program). The device is unable to write time-stamp records to the transaction during power failures. The format of a T record in DCM transaction message format contains the following data:
hhhhh#
w
hhhhh is the number of minutes from midnight (00:00) of the transaction reference date).
Example:
1560#
In this example, the device writes an hourly time-stamp record (T) to the transaction at 1560 minutes past midnight of the transaction reference date. This time corresponds to 2:00 A.M. The punch date and time are included in the DCM message. Individual Message Audit Trail Record (T) The device writes an Individual Message Audit Trail record to the transaction when the device displays a message to an employee. The record reports employee activity during the viewing of one or two messages.
C-19
Appendix C
The format of a T record in DCM transaction message format contains the following data:
#0#iiiiiiiii#x#yyy#z#x#yyy#z#
w w w w w
0 distinguishes the record from a time-stamp record. iiiiiiiii is the employee ID (badge number). x is the message status. yyy is the number of the message shown to the employee. z is the number of days since the message was assigned to the employee.
Example:
#0#123654#3#112#2#1#78#0#
In this example, the device writes an Individual Message Audit Trail record (T) to the transaction at 7:21 A.M. (1881 minus 1440 divided by 60 equals 7.35 hours). This record is not an hourly time-stamp record (0). Employee 123654 did not acknowledge (3) message 112, displayed by the device. The message was assigned 2 days ago. The employee did acknowledge (1) message 78, which was assigned today (0 days ago). The punch date and time are included in the DCM message. Activity Code Record (V) The device writes an Activity Code record to the transaction when an employee presses a function key configured as an activity start or as an activity clear. The format of a V record in DCM transaction message format contains the following data:
#aa#iiiiiiii#kk#g#llf7|lf6|lf5|lf4|lf3|lf2|lf1#ss#ww#q#b#
C-20
Kronos Incorporated
w w w w w w w w w
aa is the activity code number. iiiiiiiii is the employee ID (badge number). kk is the function key number. g is the gate code (optional). lf3|lf2|lf1 or lf7|lf6|lf5|lf4|lf3|lf2|lf1 is the labor account (optional). ss is the supervisor number (optional). ww is the supervisor comment code (optional). q is the gate number (optional). b is the employee badge ID source (optional).
Example:
#03#402#6#1#33|01|96#78#35#
In this example, the device writes an Activity Code record (V) to the transaction at 8:21 P.M. (2661 -1440 / 60 equals 20.35 hours). Future hours are associated with activity code 03 for employee 402, who pressed function key 6 to start the transaction. The gate is opened (1), future hours are associated with labor account 330196, and supervisor 78 entered comment code 35. The punch date and time are included in the DCM message. Gate Record (W) Only Gatekeeper devices (model 420) can generate a Gate record. The device writes a gate record to the transaction to store a time and attendance record for interpretation by the host software program. The format of a W record in DCM transaction message format contains the following data:
hex_time#iiiiiiiii#p#g#q#b#
C-21
Appendix C
w w w w w w
hex_time is a hexadecimal value representing the number of minutes from midnight (00:00) of the transaction reference date. iiiiiiiii is the ID of the employee who opened the gate. p is the punch code. g is the gate code. q is the gate number (optional). b is the employee badge-ID source (optional).
Example:
#628#102595#2#1#2#1#
In this example, the device writes a Gate record (W) at 2:16 A.M. (628 equals 1576 minutes, 1576 minus 1440 equals 136 minutes, or 2 hours and 16 minutes) when employee 102595 punches to start a new shift (2). The punch causes a gate (1) to open. The second gate (2) opened when the employee swiped her badge at the first integral reader (1). The punch date and time are included in the DCM message.
Supervisor, Guard, and Maintenance Transaction Records

The collected transaction records listed in this section result from supervisor, guard, or maintenance personnel activity at the device. These records follow a general format that includes an ID for an associated subrecord. The subrecord varies according to the type of activity the supervisor, guard, or maintenance personnel perform at the device. General Record Format The general format of a supervisor/guard/maintenance record is:
X#ss#type#data#
C-22
Kronos Incorporated
w w
X is the record identifier (C = supervisor, G = guard, M = maintenance). ss is the supervisor ID. In a maintenance record, this field always has a value of 99. An ss value of 98 indicates an edit record. (The cancel meal deduct record is an example of an edit record.) type is the subrecord ID. These collected transaction records can be created when the device is operating in normal, supervisor, guard, or maintenance mode. However, not all records apply to all modes. The following table summarizes the subrecord ID values and to which operating modes each subrecord applies:
ID Value 0 1 2 3 4 5 6 7 8 9 Record Type Login Logout Transaction Single Restriction Override Global Restriction Override Non-home Employee Punch Enable/Disable Security Transaction Open Gate for Individual Open Gate for Specified Duration Cancel Mean Deduction Supervisor Mode X X X X X X X X X X Guard Mode X X X X X X X X X X X X X X X X X X Maintenance Mode
data is the remaining relevant information.
C-23
Appendix C
Login Record (0) The device writes a Login record to the transaction when a supervisor or guard logs in. The format of a 0 record in DCM transaction message format contains the following data:
X#ss#0#
w w w
X is the record identifier (C = supervisor or G = guard). ss is the supervisor number. 0 is the subrecord ID (0 = login).
Example:
C#440#14#0#
In this example, at 4:40 P.M. (2440 minus 1440 divided by 60 equals 16.667 hours), supervisor 14 logged in (0). The punch date and time are included in the DCM message. Logout Record (1) The device can create the Logout record only when the device is in supervisor or guard mode. The device writes this record to the transaction when a supervisor or guard logs out. The format of a 1 record in DCM transaction message format contains the following data:
X#ss#1#
C-24
Kronos Incorporated
w w w
X is the record identifier (C = supervisor or G = guard). ss is the supervisor number. 1 is the subrecord ID (1 = logout record).
Example:
C#1440#01#1#
In this example, supervisor 01 logs out (1) at midnight (1440 minutes past midnight of the transaction reference date). The punch date and time are included in the DCM message. Transaction Record (2) The device writes the Transaction record to the transaction when a supervisor performs a transaction for an employee at the device. You use the host software to define transaction codes to perform specific tasks. For example, you can define a transaction code to add hours to an employee's sick time. To perform this transaction, a supervisor must enter the defined transaction code using the device keyboard. The format of a 2 record in DCM transaction message format contains the following data:
X#ss#2#nnnnnn#iiiiiiiii#kk#lf7|lf6|lf5|lf4|lf3|lf2|lf1#
w w w w w w
X is the record identifier (C = supervisor only or M = maintenance only). ss is the supervisor number. 2 is the subrecord ID (2 = transaction record). nnnnnn is the transaction code. iiiiiiiii is the employee ID (badge number). kk is the optional function key.
C-25
Appendix C
lf3|lf2|lf1 or lf7|lf6|lf5|lf4|lf3|lf2|lf1 is the labor account to which the employee is transferring (optional)
The transaction code consists of six digits with a maximum value of 999,999. Example:
C#1440#01#2#345#
In this example, at midnight (1440 minutes past midnight of the transaction reference date), supervisor 01 performed a transaction (2) specifying a transaction code of 345. The punch date and time are included in the DCM message. Single Restriction Override Record (3) The device writes a Single Restriction Override record to the transaction when a supervisor uses either either the assigned function key or command 2 at the device (in supervisor mode) to give or remove a restriction credit for a single home employee. Home employees at the device have a restriction credit status of 0 or 1. A status of 0 means the employee is restricted from punching during a defined restriction period. A restriction credit status of 1 means the employee is allowed to punch during a defined restricted period. The format of a 3 record in DCM transaction message format contains the following data:
X#ss#3#r#iiiiiiiii#
w w w w w
X is the record identifier (C = supervisor, G = guard, M = maintenance). ss is the supervisor number. 3 is the subrecord ID (3 = single restriction override record). r determines if the restriction credit is given (+) or removed (-). iiiiiiiii is the employee ID (badge number).
C-26
Kronos Incorporated
Example:
C#1440#01#3#+#14525356#
In this example, at midnight (1440 minutes past midnight of the transaction reference date, supervisor 01 gave (+) a restriction credit (3) to employee 14525356. The punch date and time are included in the DCM message. Home Employee Global Restriction Override Record (4) The device writes a Home Employee Global Restriction Override record to the transaction when a supervisor uses command 3 at the device (in supervisor mode) to set or clear the global restriction credit for all home employees. This overrides the state of the restriction credit stored as part of the home employee schedule enforcement data. The format of a 4 record in DCM transaction message format contains the following data:
X#ss#4#r#hhhhh#
w w w w w
X is the record identifier (C = supervisor, G = guard, M = maintenance). ss is the supervisor number. 4 is the subrecord ID (4 = global restriction override record). r determines if the global restriction credit is set (+) or cleared (-). hhhhh is the duration in minutes of the restriction override (optional).
Example:
C#1440#01#4#+#120#
In this example, at midnight (1440 minutes past midnight of the transaction reference date), supervisor 01 used host command 3 (4) to set (+) the global restriction credit for all home employees, for a duration of 2:00 (120 minutes). The punch date and time are included in the DCM message.v
C-27
Appendix C
Non-Home Employee Global Restriction Override Record (5) The device writes a Non-Home Employee Global Restriction Override record to the transaction when a supervisor uses host command 4 to set or clear the global restriction credit for all non-home employees. When the restriction credit is set, any non-home employee whose punch would otherwise be rejected is allowed to punch. Home employees of a device are those whose badge numbers have been sent to the device from the host. Normally, only home employees can punch at a device. However, non-home employees may be allowed to punch at that device if you enable the feature in the device program (Procedure 22). The format of a 5 record in DCM transaction message format contains the following data:
X#ss#5#r#hhhhh#
w w w w w
X is the record identifier (C = supervisor, G = guard, M = maintenance). ss is the supervisor number. 5 is the subrecord ID (5 = non-home employee punch enable/disable record). r determines if non-home employee punching is enabled (+) or disabled (-). hhhhh is the duration in minutes of the non-home employee punch restriction (optional).
Example:
C#1440#01#5#-#
In this example, at midnight (1440 minutes past midnight of the transaction reference date), supervisor 01 uses host command 4 (5) to clear (-) the non-home employee global restriction credit. When a credit is cleared, there is no associated duration (hhhhh). The punch date and time are included in the DCM message.
C-28
Kronos Incorporated
Security Transaction Record (6) The device writes a Security Transaction record to the transaction when a supervisor or guard uses command 15 at the device to record a security transaction. You use the host software to define transaction codes to perform specific tasks. For example, you can define a transaction code to add hours to an employee's sick time. To perform this transaction, a supervisor must enter the defined transaction code using the device keyboard. The format of a 6 record in DCM transaction message format contains the following data:
X#ss#6#nnnnnn#iiiiiiiii#
w w w w w
X is the record identifier (C = supervisor, G = guard, M = maintenance). ss is the Supervisor number. 6 is the subrecord ID (6 = security transaction record). nnnnnn is the transaction code. iiiiiiiii is the employee ID (optional).
Example:
C#1440#01#6#135#2468#
In this example, at midnight (1440 minutes past midnight of the transaction reference date), supervisor 01 recorded a security transaction (6) using transaction code 135, for employee 2468. The punch date and time are included in the DCM message.
C-29
Appendix C
Open Gate for an Individual Employee Record (7) The device writes an Open Gate for an Individual Employee record to the transaction in either of the following situations:
w w
A supervisor or guard uses either either the assigned function key or command 12 at the device (in supervisor, guard, or maintenance mode). The host software sends host command 122 to the device.
The function in the device opens a gate for an employee. The format of a 7 record in DCM transaction message format contains the following data:
X#ss#7#g #iiiiiiii#q#b#
w w w w w w w
X is the record identifier (C = supervisor, G = guard, M = maintenance). ss is the supervisor number. 7 is the subrecord ID (7 = open gate for individual record). g is the gate code for the entry management activity. iiiiiiiii is the ID of the employee for whom the gate was opened. q is the gate number (optional). b is the employee badge-ID source (optional).
Example:
C#1440#01#7#1#402#
In this example, at midnight (1440 minutes past midnight of the transaction reference date), supervisor 01 used command 12 (7) at the device (in supervisor mode) to open the gate (1) for employee 402. The punch date and time are included in the DCM message.
C-30
Kronos Incorporated
Open Gate for Specified Duration Record (8) The device writes an Open Gate for specified duration record to the transaction in either of the following situations:
w w
A supervisor or guard uses either either the assigned function key or command 14 at the device. The host software sends host command 124 to the device.
Either action causes the gate to be opened for a specified length of time, or indefinitely. The format of an 8 record in DCM transaction message format contains the following data:
X#ss#8#r#hhhhh#q#
w w w w w w
X is the record identifier (C = supervisor, G = guard, M = maintenance). ss is the supervisor or guard number. 8 is the subrecord ID (8 = open gate for specified duration). r determines whether the gate was opened (+) or closed (-). hhhhh is the duration that the gate is to be open (optional). q is the gate number (optional).
Example: C#1440#01#8#+#120# In this example, at midnight (1440 minutes past midnight of the transaction reference date), supervisor 01 used command 14 (8) to open (+) the gate for 120 minutes. The punch date and time are included in the DCM message.
C-31
Appendix C
Cancel Meal Deduction Record (9) The device writes a Cancel Meal Deduct record to the transaction in either of the following situations:
w w
A supervisor uses either either the assigned function key or command 59 at the device (in supervisor mode). An employee presses a function key configured as a cancel meal deduction.
Either action cancels the normal time deduction for meal breaks so that an entire shift is considered worked time. The format of a 9 record in DCM transaction message format contains the following data:
X#ss#9#iiiiiiiii#
w w w w
X is the record identifier (C = supervisor, G = guard, M = maintenance). ss is the supervisor number. 9 is the subrecord ID (9 = cancel meal deduct record). iiiiiiiii is the ID of the employee for whom the meal deduction was canceled.
Example:
C#1440#01#9#402#
In this example, at midnight (1440 minutes past midnight of the transaction reference date), supervisor 01 used command 59 (9) to cancel the normal deduction for any meal breaks taken by employee 402. The punch date and time are included in the DCM message.
Punch Type and Daylight-Saving Time

Some parameters in the device program are associated with daylight-saving time (DST) and the relationship between the device and the host software computer. This section explains what happens if the DST change occurs.
C-32
Kronos Incorporated
The Series 100, 500 and 400 terminals accept host command 113 to adjust the time of day at the device and enforce following of daylight-saving time. When the date and time specified in the host command occurs, the device writes a transaction record with the new time of day. The DST change also affects future punch records, under the following circumstances:
w w w
Punch typing is disabled in the device program for punch type in-punch records (Procedure 5, Step 1). The punch is for a home employee whose shift started before the DST change. The report DST state parameter is not set in the device program (Procedure 8, Step 2).
The punch record shows a time (minutes from midnight) that is adjusted to offset the DST toggle, and a punch type of 0. This information allows the host software to use the time reported on this punch and previous punches for this employee, to perform calculations for minutes worked. The adjusted time subsequently makes the record appear out of sequence with the rest of the punch data. The following table lists a sample transaction report with appropriate punch data. The sample report includes hourly time-stamp transaction records for clarity. Text on the left is the transaction report; text on the right explains each line of the report.
Transaction Report Text T 2220 A 2220 120946 A 2279 120958 D 2340 + T 2340 T 2400 T 2460 T 2520 A 2520 120910
Explanation Passing of 13:00 Punch at 13:00 for employee 120946 Punch at 13:59 for employee 120958 Forward DST change at 14:00 to 15:00 Passing of 15:00 Passing of 16:00 Passing of 17:00 Passing of 18:00 Punch at 18:00 for employee 120910
C-33
Appendix C
Transaction Report Text A 2401 120946 0
Explanation Punch at 18:01 for employee 120946, who started a new shift when that employee punched at 13:00.
No D record for 14:00 (2280) is available because that time never "existed" in the device. The time of the last punch is relative to the 13:00 punch; the elapsed time between the punches is 3:01, but the time change at the device record relates to the time of the previous punch. It has been 3:01 since this employee last punched (2401 minus 2220 equals 181 minutes). Note: The time of all transaction events is stored based on the device's current local time. Since the DST state field appears only in the host command 108 response, use it carefully. The host software adjusts the time of the punch according to its own rules when the punch is collected from the device. The only piece of time-sensitive data missing is the time zone in which the event occurred.
Using Host Commands to Collect and Clear Transaction Data

For more information about using host commands to collect transaction data from a device, see Chapter 9, Collecting Data and Managing Transactions.
C-34
Kronos Incorporated
Appendix D
Using DCM with Series 4000 Terminals
This appendix provides information about using Series 4000 terminals with the Data Collection Manager system. This appendix contains the following sections:
w w
Series 4000 Terminals Features Functional Differences Between Series 4000 and Series 400 Terminals
Appendix D
Series 4000 Terminals Features

The Series 4000 terminal includes the following features:
Feature Schedule enforcement Totals display Message display Functions and transactions Soft keys Description Controls when specific employees can swipe badges. Displays employee names, vacation, sick time, and other totals at the device. Enables the devices to display messages for individual employees. Enables the devices to process various functions and transactions, such as labor account transfers and pay code transactions. Keys that are configured to perform specific functions. The names of the functions associated with each key are configured to display on the screen. The display names can be up to 40 characters in length. If necessary, the display name wraps to the second line.
D-2
Kronos Incorporated
Functional Differences Between Series 4000 and Series 400 Terminals
Functional Differences Between Series 4000 and Series 400 Terminals

The following table shows the functional differences between the Series 4000 and the Series 400 terminals:
Function or Characteristics Punch status information display Individual employee information display Entering a PIN
Series 4000 Users can view punches, last punch, and punch status. Users can display individual employee information. Users enter the badge number directly.
Series 400 Users can view punch status, elapsed time, and last punch. Users can display and print individual employee information. Users press the * key before entering the badge number, except for PINonly devices (430, 450, or 470) or if the badge is configured on the Badge Reader tab as None.
Supervisor functions Device configuration Installation and maintenance Keys
Supervisors use soft keys Supervisors enter command numbers to initiate functions. to initiate functions. Users configure devices in Users configure devices by using DCM. DCM and AFT commands. Performed by the customer. Soft keys. Performed by Kronos Representatives. Function keys.
Modem configuration Users configure a dial-up Users configure the device with a modem by using the Device Wizard. connection in Windows first, and then configure the device by using the Device Wizard.
D-3
Appendix D
D-4
Kronos Incorporated
Glossary
access profile
A user-specific file that determines which DCM components a user can access and the types of functions a user can perform within the DCM system.
activity code
A punch transaction type that associates a pay rule with a work rule. An activity code profile maps activity codes to the function keys on devices.
accrual
An amount of time or money that employees earn or accumulate over time, based on a companys employment terms and policy. Typically, an employee accrues time for vacation days, sick days, and floating holidays. Employees can also accrue money for bonuses, travel allowances, or uniforms.
accrual code
The account that identifies and holds the type of accrual balance, such as vacation, sick, or bonus.
ad hoc query
A search for people in the Workforce Timekeeper system that you create and save for use during your current session only. If Ad hoc is active, validation turned off at the device.
amount associated with a pay code
A credit to an employee of time or money that is processed by and assigned to a specific pay code. For example, you can assign 3 hours of time to the Sick pay code and a monetary amount to a Bonus pay code.
amount associated with a pay rule
A credit of time to an employee that is processed by the employees pay rules. For example, you can credit 8 hours of time to a holiday pay rule that controls payment based on a pay rule that requires an employee to work the day before and the day after a holiday.
application client
An executable that runs an instance of an application.

application connection
The connection library and connection(s) specification that DCM uses when transferring data between devices and host applications.
application program interface
The point through which an application interacts with an operating system using high-level language calls.
badge location code
A company code component of the standard badge format that is automatically entered when employees swipe their badge. A company code limits the badges that can be used at a particular site.
badge reader
The hardware that decodes data from badges, such as a bar code badge, magnetic stripe badge, or proximity badge, and stores that data until an application collects it.
bar code reader
A device that decodes data from the symbols on a bar code badge, and stores that data until an application collects it.
bell schedule
Bell time settings, including the optional warning bell settings, configured to ring one bell.
bulk processing
A collection method that optimizes data collection performance by processing simple punches in large blocks of data.
Glossary-2
Kronos Incorporated
Glossary
comment code
A comment code, and its associated comment text, is an item that is defined in the Workforce Timekeeper Setup application. DCM comment code configuration enables employees to enter comments at the device.
Communication Monitor
The DCM application that allows you to start and stop data collection, and initialize and update devices. The Communication Monitor lists devices that are responding and not responding, and the data and transactions that travel to and from devices. In addition, you access the Transaction Data Editor from the Communication Monitor. The Communication Monitor allows you to monitor transactions between devices and the host applications that manage the information.
communication channel
The type of transmission method (Ethernet, serial, or modem) that the comm PC uses to communicate with one or more devices.
communication client
An executable that runs an instance of the communication channel.

communication driver
A dynamic link library (DDL) that is specific to the data collection method supported by the devices; handles device handshaking, messaging, and error processing for each device type and implements the high-level APIs that are used to start data communication to devices.
communication (comm) PC
The PC that collects data from and downloads data to the devices.
communication type
A type of device communicationEthernet, serial, or modem.

Configuration Options
The DCM application that allows you to set the configuration parameters for data collection devices.
Glossary-3
connection library
The DLL for the host application that provides interaction between DCM and the host application.
cross-launch
After you log on to DCM, the Cross-Launch utility enables you to access other applications in Workforce Timekeeper without logging on to the applications separately.
cross-punching
Cross-punching allows a device to accept non-home employees. Validation is not performed at the device when employees enter punches.
Data Collection Manager
A flexible suite of applications and libraries designed to configure, collect, transfer, and monitor the flow of data between an application and data collection devices.
device
The hardware that allows users to enter time and activity data, which is then sent to host applications.
device group
A logical group of data collection devices. For example, all data collection devices in a specific building might be called by one device group name.
Device Manager
The DCM application that enables you to create devices, communication channels, and device groups, then assign the devices to device groups that use the communication channels.
Device Wizard
A DCM utility that helps you create and edit devices and device groups.
Domain Name System (DNS)
A distributed host information database used in the Internet. DCM uses this system to assign a device name to an IP address.
Glossary-4
Kronos Incorporated
Glossary
dynamic link library
A file containing executable code and data bound to a program at load time or run time, rather than during linking.
Ethernet
Local Area Network (LAN) technology. Defined by the IEEE 802.3 specification.
event
An action or task that you schedule to run at specified intervals in the Event Manager application.
Event Manager
The DCM application that allows you to schedule events such as data collection and device updates.
firmware
The software that resides on a device.

function key
A programmable button on a device that allows employees and supervisors to perform functions quickly.
gate entry
The configuration that unlocks a physical portal with an attached universal contact relay that electrically opens the device, such as a door, turnstile, or swing gate.
global message
A user-entered message set up in the configuration user interface that appears on the device display.
home employee
An employee assigned to a specific device or device group.These devices are called the employees home devices.
Glossary-5
host application
The Kronos application for which the device is collecting information. You use the host application to update the device with new employee information and collect punches and transactions from the device.
HTTP
Hypertext Transfer Protocol defines how messages are sent and displayed between websites and browsers.
in-punch
A punch that starts a work interval.

job transfer set
A type of job set to which employees can transfer themselves at a device.

job set
A collection of jobs.
labor account
A labor account is the location where employees worked hours are accrued. Employees are assigned a home account to which their hours are accrued, unless a shift is an account transfer. Accounts consist of up to three or seven levels, depending on your device, to allow you to clearly define the account. Start with a general description.
labor account transfer
A transfer of an employee or group of employees to a different labor account.

labor level entry
A selection at a specific labor level. Labor level entries usually contain an entry number and a description. For example, 01 North, 02 South, 03 East, and 04 West are labor level entries for the division labor level, while 100 Manufacturing, 200 Sales, and 300 Operations are labor level entries for the department labor level.
labor level set
A collection of labor levels as defined by the host application.
Glossary-6
Kronos Incorporated
Glossary
legacy device
All devices except Series 4000 terminals.

log file
A file that continually accrues information; used as an audit trail and a diagnostic tool.
magnetic stripe badge reader
A device that decodes data from a magnetic stripe badge, and stores that data until an application collects it.
messages
Device information, such as status and errors, that is returned from the host application in response to a transaction.
monitor PC
One or more optional PCs on which DCM is installed. Monitor PCs monitor communication between devices and the comm PC.
non-home employee
An employee not assigned to a particular device.

not responding
Devices that are not in communication with the communication channel.

open database connectivity (ODBC)
A standard programming language interface used to connect to and interact with a variety of databases.
out-punch
The punch that ends a work interval.

partial labor level transfer
A labor level transfer feature that enables users to specify fewer labor levels, rather than all labor levels, to be used in the host application. The user only needs to enter a value for every labor level that is configured in the host application.
Glossary-7
pay code
A category used to organize time and money. Time pay codes accrue hours, while money pay codes accrue money. Examples of pay codes are Regular and Overtime for worked or productive time. Jury Duty, Vacation, and Sick time are examples of pay codes used for unworked time or non-productive time. Bonus is an example of a pay code that holds monetary amounts.
pay code adjustment
A method to move hours from one set of labor levels or jobs to another under the same pay code.
pay rules
A set of rules that are used to calculate hours worked by employees. A pay rule contains general payroll rules such as type of pay period, for example weekly. A complete pay rule controls such items as the pay period length, the day divide, when punches link to schedules, when devices accept and reject punches, which holidays give holiday credits, and the order that hour types are processed.
proximity badge reader
A device that decodes data from a proximity badge, and stores that data until an application collects it. Proximity badges are read within a certain distance of the badge and the device.
punch
Employee or supervisor input at a device as collected by DCM. The input specifies the employee or supervisor attendance at work and the hours worked.
queue file
The file from which the host application collects data and enters it into the host application.
request
An inquiry initiated by an application to a device or device group.

responding
Devices that are in communication with the communication channel.
Glossary-8
Kronos Incorporated
response
An action that results from a request.

schedule
A series of days defined for items such as shifts and transactions.

Sentinel
The DCM application that launches communication channels for each comm PC in the network.
shared directory
A directory that is network-accessible based on permissions assigned to the share name by the system administrator.
share name
An identifier for a shared directory.

simple punch
A badge swipe or PIN entry at the device that has no associated transaction nor requires any other action, such as using a function key.
status check
A feature in the Communication Monitor that allows you to verify whether or not communications is available between a device or device group and the DCM Communication PC.
transfer
Hours charged to a labor account that is different from an employees home account or hours charged to a work rule.
transaction
Information that travels from the devices to the host application for processing, such as the time an employee punched in or out.
Glossary-9
Transaction Data Editor
A DCM tool that displays transactions that were rejected by DCM or the host application and cannot be fully processed. You can edit the transactions and resubmit them to the processing queue.
transaction input file
A file that contains external input into the DCM system.

transaction output file
A file that contains a recording of all transaction data, based on the device group.
work rule
Work rules apply specific payroll rules to shifts. These rules determine how employee hours accrue. Examples are breaks, overtimes, and pay code distribution.
XML
Extensible Markup Language, a subset of the Standard Generalized Markup Language (SGML) that facilitates data transfers between applications. Developers create tags, tag definitions and validation rules that determine how the data is transferred between applications.
Glossary-10
Kronos Incorporated
Index
Symbols
.AFT file extension .i.file-based requests .KRA file extension .KRE file extension .KRN file extension .KRS file extension .XML file extension 11-9 4-53 11-7 11-7 11-7 11-7 11-9
starting 10-9 stopping 10-9 application, problems accessing 12-7 automatic startup, Event Manager 4-44
B
backup 9-46 badge accepting home employee 5-47 generic 5-10 proximity 5-9 specifying acceptable badge types 5-8 standard 5-10 badge reader download 5-11 specification 5-8 badge types 5-10 bar code reader 5-9 batch collection 4-16, 4-19 bell schedules 4-30 to 4-32 configuring 5-13 browser, accessing 12-7
A
accrual code 7-2 to 7-6, 7-13 activity code 5-33, 8-15, 8-19 assigning to a function key 8-10 creating 8-3, 8-5 definition 8-2, 8-3 mapping to activity codes 8-5 activity code profile accessing 8-7 creating 8-5 definition 8-5 loading to a device 8-8 unassigning 8-12 ad hoc entries 6-13, 6-18 AFT commands, entering 5-6 AFT file, loading 11-9 application client A-4 application connection defining 2-4 deleting 2-3
C
centralized log file 9-39 client application A-4 communication A-6
Index
comment code 5-33, 8-15 to 8-18, 8-19 for a Series 400 terminal 8-17 for a Series 4000 terminal 8-15 communication channel definition 3-3 Device Manager 3-22 error codes 13-10 modem 3-4, 3-26 overview 3-2 serial 3-30 Series 400 3-6 Series 4000 3-5 starting 10-8 status 10-5 stopping 10-8 communication client A-6 communication driver A-6 Communication Monitor, overview of 1-3 Communication PC communication channels support 3-3 communication channels supported 3-3 devices supported 3-3 communication PC IP address 3-11 synchronizing date and time 11-14 Communication PC, registering new B-6 communication settings 4-50 configuration parameters, loading 5-49 configuration service, error messages 13-21 configuration, steps to 1-10 configuring a modem Series 4000 3-6 cross-launch 1-8 cross-launch utility 1-8
D
data backup 9-46 data collection batch 4-16, 4-19 enabling a device for
5-52
online 4-16, 4-19 starting 9-2 data collection device maximum supported 3-3 data download A-10 data flow A-7 data transfer file A-2 data upload A-7 daylight-saving time 4-15, 4-21 FIFO record C-32 DCM data flow architecture A-2 DCM application 1-3 accessing 1-7 launching from WFC 12-14 logging on 1-8 start menu 1-7 using INI file values with B-1 default reader transactions 5-16 default transactions configuring 5-15 default work rule 8-2 device adding 4-13 assigning to device group 4-22 assigning to second group 4-23 copying 4-26 definition 4-2 deleting 4-28 editing 4-25 maximum supported 3-3 synchronizing date and time 11-14 update command 5-49 viewing enabled and disabled 5-52 viewing responding 5-52 device communication monitoring 9-4 to 9-7 device download settings 4-48 device error messages interpreting 13-58
Index-2
Kronos Incorporated
Index
device group assigning 4-4, 4-9 assigning a new device 4-22 collecting 4-4, 4-9 copying 4-11 creating 4-7 definition 4-3 deleting 4-12 displaying 4-9 editing 4-10 name 4-8 device ID 4-15 device list 4-21 Device Manager adding a device 4-17 adding a new device 4-17 assigning devices to device groups 4-22 configuring communication channel 3-22 copying a device 4-26 deleting a device 4-29 description 4-5 editing a device 4-25 overview 1-4 device parameter file 11-9 device parameters configuring 5-2 Device Wizard adding a new device 4-13 copying a device 4-26 deleting a device 4-28 description 1-4 editing a device 4-25 devices, functional differences D-3 dial-up connection Series 4000 terminal with modem 3-6 dial-up connections 3-10 dial-up entry creating on Windows 2000 3-12
dial-up network creating on Windows XP 3-19 dial-up networking creating on Windows NT 3-16 direct communications IP address 4-52 display, configuring 5-20 DLL errors 12-14 download retry 4-49 download file deleting 4-49 saving 4-49 download options 4-17 download options, Event 9-31 downloading badge reader configuration 5-11 downloading data A-10 DSN, error message 13-55
E
e-mail notification 4-56 e-mail, accessing 12-7 employee function key command 5-30 error messages 13-2, 13-70 communication channel 13-10 communication driver 13-7 configuration service 13-21 DSN 13-55 format 13-3 generic 13-27 logging on 13-55, 13-57 serial and modem 13-4 Series 400 Device 13-58 softload 13-8, 13-26 errors missing DLL 12-14 password 13-55 Ethernet communication channel 3-2 Ethernet timeout value, increasing 3-25
Index-3
Index
Event DCM command format 9-24 to 9-30 defining 9-19 to 9-37 download options 9-31 scheduling 9-17 specifying 9-17 Event Manager options 9-22 overview 1-5 Event Manager options specifying 9-22
generic badge format, editing 6-10 global settings direct communications IP address 4-52 global values settings 4-52 file-based requests 4-53 totals and accruals timeframe 4-56
I
INI file values using with DCM B-1 initialization process 5-3 interpreting missed punches 5-23 invalid transaction, correcting 9-15 IP address assigning 3-6 changed 3-5 DCM communication PC 3-11 recommended 3-9 Series 4000 modem 3-11, 3-18
F
FIFO records C-2 FIFO, configuring 5-25 file data transfer A-2 queue A-3 transaction 9-9, A-4 firmware 11-7 upgrading 11-3 upgrading Series 400 11-7 upgrading Series 4000 11-5 firmware upgrade 11-2 function key assigning labor levels 6-15 assigning tasks to 5-30 function key command employee 5-30 supervisor 5-30
J
job set 5-41 job transfer configuring 5-42 function key setting overview 5-40
5-43
L
labor level account, configuring 5-44 labor level options selecting 6-4 Labor Level Sets 6-3 labor levels assigning to function key 6-15 downloading 6-21 overview 6-2 removing 6-19
G
gate entry configuring 5-35 settings 5-35, 5-39 gate schedules 4-33 to 4-36 configuring 5-38 general system settings 4-44 generic badge 5-10
Index-4
Kronos Incorporated
Index
labor transfer badge types, selecting 6-7 editing generic badge format 6-10 enable # key for transfers 6-7 non-home employees 6-7 restrict time on repunch 6-7 skip leading zeros 6-7 specifying 5-46 standard badge labor level restrictions 6-8 labor transfer options specifying 6-6 labor transfer settings configuring 6-9 list size settings B-5 loading configuration data 5-50 loading to a Series 400 device 11-7 local reader options, Series 400 device 5-9 log file centralized 4-45, 9-39 messages 12-19 number 4-48 severity reporting levels 4-45 size 4-46 viewer 9-39 log file settings 4-45 log message file 4-45, 9-39 log messages 12-10, A-4 Log Viewer 9-39 logging on to DCM 1-3 logon error messages 13-55, 13-57 screen 1-8
modem autodetecting 1-4 configuring for Series 4000 3-6 error messages 13-6 Series 4000 12-7 Series 4000 IP address 3-6, 3-11, 3-18 specifying the delay times 3-29 troubleshooting 12-5, 12-7 undetected 3-26 modem channel 3-4 modem channel, defining 3-26 modem communication channel 3-2 monitor device communications 9-4 to 9-7 transactions 9-4 to 9-7
N
network check 3-24, 3-31
O
online collection 4-16, 4-19
P
parameter file exporting 11-13 extracting 11-10 importing 11-12 loading 11-9 parameter files deleting 4-45 saving 4-45 partial transfers configuring 6-12 password error messages 13-55 pay code 5-33, 7-2 to 7-6, 7-13, 8-15, 8-19 pay code edit 8-19 to 8-23 for a Series 400 terminal 8-21 for a Series 4000 terminal 8-20
M
message log A-4 message display times 5-21 messages log 12-10 missed punches, interpreting 5-23
Index-5
Index
pay rule 8-4 phone book for dial-up connection 4-51 Program Event defining 9-34 proximity badge 5-9 punch rule 5-47 punch schedule, specifying 5-23
Q
queue file A-3
R
rasphone 3-12, 3-17, 3-20 Remote Access Service 3-10, 4-51 Series 4000 terminal with modem remote transaction assigning to function key 4-41 creating 4-38 editing 4-36, 4-40, 4-41 remote transactions predefined 4-37 View Schedules Online 4-37 reports about DCM 1-9 3-6
S
scan interval 5-25 schedules bell 4-30 gate 4-33 Sentinel 9-24, 12-17 accessing the database 10-12 establishing communication with applications 10-4 monitoring communication channel 10-5 overview 1-5, 10-2, A-5 shutting down 10-8, 10-11 starting a communication channel
starting and stopping host application 10-9 viewing status of comm channels 10-5 Sentinel icon 10-5 serial channel, defining 3-30 serial communication channel 3-2 Series 4000 modem dial-up entry on Windows 2000 3-12 dial-up networking on Windows NT 3-16 dial-up networking on Windows XP 3-19 IP address 3-6, 3-11, 3-18 prerequisites 3-11 troubleshooting 12-7 Series 4000 terminal troubleshooting 12-7 softload 11-2 standard badge 5-10 status of comm channels using Sentinel 10-5 supervisor function key command 5-30 supervisor task, specifying 5-48 system settings 4-42 to 4-62 communication 4-50 device download 4-48 e-mail notification 4-56 general 4-44 global values 4-52 log file 4-45 totals and accruals timeframe 4-56 WFC Connection 4-59 system tray Sentinel icon 10-5
T
total definition assigning to function keys 7-7 creating 7-3 deleting 7-6 display 7-9 displaying at the device 7-13 downloading 7-10
10-3
Index-6
Kronos Incorporated
Index
editing 7-5 naming 7-4 sending to the device 7-11 totals and accruals assigning to function keys 7-7 creating 7-3 deleting 7-6 display 7-9 displaying totals at the device 7-13 downloading 7-10 employee totals 7-2 naming a total definition 7-4 sending to the device 7-11 specifying a pay code 7-5 specifying an accrual field 7-5 time frame 4-52 totals and accruals timeframe 4-56 transaction code 9-11 transaction count resetting 2-6 Transaction Data Editor 9-15 transaction file 9-9, A-4 transaction input file collecting 9-8 extension 9-12 formatting 9-10 loading 9-9 location 9-11, A-4 processing 9-9 transaction output file 9-43 setting up 9-12 transaction output files 4-45 reading 12-18 size 4-44 Transaction Viewer 9-13 transactions default reader 5-16 monitoring 9-4 to 9-7 resetting count 2-6
troubleshooting application connections 12-17 communication channels 12-17 communication monitor 12-22 Ethernet networks 12-16 procedures 12-2 transaction output file 12-18
U
update process 5-5 uploading data A-7 user access rights planning 1-8
V
View Schedules Online remote transaction 4-37
W
WFC Connection 4-59 work rule 8-2 default definition 8-2 linking with pay rule 8-5 Workforce Timekeeper logging on 1-8
X
XML file, loading 11-9
Index-7
Index
Index-8
Kronos Incorporated

Data Collection Manager System Administrator's Guide

Încărcat de

Informații document

Descriere originală:

Titlu original

Drepturi de autor

Formate disponibile

Partajați acest document

Partajați sau inserați document

Opțiuni de partajare

Vi se pare util acest document?

Este necorespunzător acest conținut?

Drepturi de autor:

Formate disponibile

Data Collection Manager System Administrator's Guide

Încărcat de

Drepturi de autor:

Formate disponibile

Data Collection Manager System Administrators Guide

Document Part Number: 4703096-001 Document Revision: A