Sys Admin Guide Data Collection

Workforce Central ®
System Administrator’s Guide

Data Collection
An administrator’s guide to configuring the Data Collection

Manager system and to monitoring and managing
communication between data collection devices and the
applications that manage transactions.
Kronos Workforce Central Suite

Version 6
Document Part Number: 4703955-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 2007.
Altitude, Altitude Dream, 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, ShiftLogic, ShopTrac, ShopTrac
Pro, StarComm, StarPort, StarSaver, StarTimer, TeleTime, Timekeeper, Timekeeper Central, TimeMaker, Unicru,
Visionware, Workforce Accruals, Workforce Central, Workforce Decisions, Workforce Express, Workforce Genie,
and Workforce TeleTime are registered trademarks of Kronos Incorporated or a related company. Altitude MPP,
Altitude MPPXpress, Altitude Pairing, Altitude PBS, Comm.Mgr, CommLink, DKC/Datalink, eDiagnostics, Experts at
Improving the Performance of People and Business, FasTrack, Hireport, HR and Payroll Answerforce, HyperFind,
Kronos 4500 Touch ID, Kronos 4500, Kronos 4510, Kronos Acquisition, Kronos e-Central, Kronos KnowledgePass,
Kronos TechKnowledgy, KronosWorks, KVC OnDemand, Labor Plus, Momentum Essentials, Momentum Online,
Momentum, MPPXpress, Overall Labor Effectiveness, Schedule Assistant, Smart Scheduler, Smart View, Start
Quality, Start WIP, Starter Series, StartLabor, Timekeeper Decisions, Timekeeper Web, VisionPlus, Winstar Elite,
WIP Plus, Workforce Acquisition, Workforce Activities, Workforce Analytics, Workforce Attendance, Workforce
Central Portal, Workforce Connect, Workforce Employee, Workforce HR, Workforce Leave, Workforce Manager,
Workforce MobileTime, Workforce Operations Planner, Workforce Payroll, Workforce Record Manager, Workforce
Recruiter, Workforce Scheduler with Optimization, Workforce Scheduler, Workforce Smart Scheduler, Workforce Tax
Filing, Workforce Timekeeper, and Workforce View are trademarks of Kronos Incorporated or a related company.
Mozilla.org is a registered trademark of the Mozilla Foundation. 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 USA
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 Product Version Release Date
A Workforce Central 6.0 June 2007

Contents
About This Guide

Organization of this guide ........................................................................... 14
Abbreviations and terms .............................................................................. 16
Related documents ....................................................................................... 17
Chapter 1: Introducing Data Collection Manager

Overview ..................................................................................................... 20
DCM applications ........................................................................................ 21
Communication Monitor ....................................................................... 21
Device Manager .................................................................................... 22
Device Work Rules ............................................................................... 23
Event Manager ...................................................................................... 23
Sentinel Service .................................................................................... 24
Accessing the Data Collection Manager applications ................................. 25
About the DCM integrated logon utility .............................................. 25
Reports about DCM in the Workforce Timekeeper application ........... 25
Steps for configuring the Data Collection Manager .................................... 27
Chapter 2: Defining an Application Connection

Overview ..................................................................................................... 30
Application server connections ............................................................. 31
Application connections .............................................................................. 34
Editing an application connection description ...................................... 34
Deleting an application connection ....................................................... 34
Creating a new application connection ................................................. 34
Chapter 3: Communication Channels

Overview ..................................................................................................... 38
Creating communication channels .............................................................. 39
Contents
Modem channels ....................................................................................40

Series 4000 communication channels ...................................................41
Series 400 communication channels .....................................................41
Configuring a modem for a Series 4000 terminal ........................................43
IP addresses for the communication PC and Series 4000 terminals .....43
About dial-up networking ......................................................................47
Configuring communication channels in the Device Manager ...................53
Secure communication ..........................................................................54
Defining an Ethernet communication channel ......................................55
Defining a modem communication channel ..........................................57
Defining a serial communication channel ............................................60
Multiple communication PCs .......................................................................62
Multiple NIC Cards ...............................................................................63
Chapter 4: Device Group and Global Setup

Overview ......................................................................................................66
Device ....................................................................................................66
Device groups ........................................................................................67
Device Manager ..........................................................................................69
Creating device groups .................................................................................70
Editing device groups ...................................................................................73
Copying device groups .................................................................................74
Deleting device groups .................................................................................75
Adding devices .............................................................................................76
Adding a device by using the Device Wizard .......................................76
Adding a device by using the Device Manager .....................................80
Editing devices .............................................................................................86
Editing a device by using the Device Wizard .......................................86
Editing a device by using the Device Manager ....................................86
Copying devices ...........................................................................................88
Copying a device by using the Device Wizard .....................................88
Copying a device by using the Device Manager ..................................89
Deleting devices ...........................................................................................94
Deleting a device by using the Device Wizard .....................................94
Deleting a device by using the Device Manager ...................................94
4 Kronos Incorporated
Contents
Bell schedules ............................................................................................ 96

Adding, editing, copying, or deleting a bell schedule ........................... 97
Gate schedules ............................................................................................. 98
Adding, editing, copying, or deleting a gate schedule ........................ 100
Soft key schedules .................................................................................... 101
Creating a new soft key schedule ........................................................ 101
Editing a soft key schedule ................................................................. 102
Copying a soft key schedule ............................................................... 102
Assigning a soft key schedule to a soft key ........................................ 103
Deleting a soft key schedule ............................................................... 103
Proximity badge formats ........................................................................... 104
Smart View transactions ............................................................................ 105
Multi-language Smart View transactions ............................................ 106
Creating a Smart View transaction ..................................................... 107
Editing a Smart View transaction ....................................................... 110
Copying a Smart View transaction ..................................................... 110
Deleting a Smart View transaction ..................................................... 111
Assigning a Smart View transaction to a soft key ............................. 111
Making changes to Smart View transaction definitions ..................... 112
System Settings ......................................................................................... 114
General settings ......................................................................................... 116
Log File settings ........................................................................................ 118
Log file severity reporting levels ........................................................ 118
Specifying the log file settings ............................................................ 118
Device Download settings ......................................................................... 121
Communication settings ............................................................................ 122
Configuring the ports used by the Apache web server ....................... 124
Configuring the ports used by the IIS Web server on Windows 2003 or
Windows XP Professional ........................................................ 124
Global Values settings ............................................................................... 125
File-based communication requests .................................................... 125
Timeframe for totals and accruals ....................................................... 127
E-mail notification settings ........................................................................ 129
System error notification ..................................................................... 129
Device error notification ..................................................................... 130
Workforce Central System Administrator’s Guide—Data Collection 5

Contents
Event error notification ........................................................................130

E-mail notification specifications ........................................................130
Server Connection settings .........................................................................132
Default application server connections ..............................................133
Default activities server connections ...................................................133
Additional server connections for transaction processing ...................134
Chapter 5: Configuring Devices

Configuring device parameters ..................................................................138
Initialization .........................................................................................139
Update ..................................................................................................140
AFT commands tab .............................................................................141
Badge Reader tab .................................................................................142
Bell Schedules tab ...............................................................................147
Default Transactions tab ......................................................................148
Display tab ...........................................................................................151
Employee tab ......................................................................................153
FIFO tab ..............................................................................................154
Free FormXML tab ........................................................................155
Function Key Tab ................................................................................156
Gate Entry tab ......................................................................................159
Gate Schedules tab ............................................................................161
Job Transfer tab ..................................................................................161
Labor Levels tab .................................................................................164
Labor Transfer tab ..............................................................................165
Manager tab .........................................................................................167
Punch Rules tab ...................................................................................170
Soft Key tab ........................................................................................171
Supervisor tab ......................................................................................175
Loading basic configuration parameters to a device ..................................177
Using the Device Manager to load basic configurations .....................178
Using the Communication Monitor to load basic configurations .......179
Viewing and enabling devices ...................................................................180
Contents
Chapter 6: Setting Up Labor Level Information

Overview ................................................................................................... 182
Labor levels ......................................................................................... 182
Labor level sets ................................................................................... 183
Selecting labor level options for the device .............................................. 184
Defining labor transfer options ................................................................. 185
Configuring labor transfer settings ............................................................ 187
Assigning labor levels to a soft key ........................................................... 190
Removing labor levels from a device ........................................................ 192
Downloading labor levels to a device ....................................................... 193
Chapter 7: Totals and Accruals

Overview ................................................................................................... 196
Creating a totals definitions ....................................................................... 197
Editing a totals definition .................................................................... 198
Deleting a totals definition .................................................................. 198
Assigning totals definitions to soft keys ............................................. 200
Downloading totals definitions and accruals to a device .......................... 201
Downloading totals definitions and accruals ...................................... 201
Chapter 8: Device Work Rules, Comment Codes,

and Pay Code Edits
Device work rules and profiles .................................................................. 204
Work rules, device work rules, and device work rule profiles ........... 204
Creating device work rule definitions ................................................. 206
Creating device work rule profiles ...................................................... 207
Deleting pay rule/work rule associations from a device work rule .... 207
Assigning a device work rule profile to a device ................................ 208
Assigning a device work rule to soft keys .......................................... 209
Unassigning a device work rule profile from a device ..................... 210
Comment codes ....................................................................................... 212
What is a comment code? ................................................................... 212
Enabling comment codes for a Series 4000 terminal .......................... 212
Enabling comment codes for a Series 400 device .............................. 214
Pay codes and pay code edits .................................................................... 216

Contents
What is a pay code? .............................................................................216

What is a pay code edit? ......................................................................216
Enabling pay code edits for a Series 4000 terminal ............................217
Enabling pay code edits for a Series 400 device ...............................218
Chapter 9: Collecting Data and Managing Transactions

Enabling data collection .............................................................................222
Automatic data collection ....................................................................223
Starting and stopping data collection ..................................................223
One-time data collection from the Device Manager ...........................224
One-time data collection from the Communications Monitor ............224
Monitoring transactions and device communications ................................225
Communication Monitor window .......................................................225
Collecting transaction input files ...............................................................229
Processing a transaction input file .............................................................230
Loading a transaction input file ...........................................................230
Formatting a transaction input file ......................................................231
Transaction codes ................................................................................232
Location of a transaction input file ......................................................232
Setting up a transaction output file for a device group ........................233
Viewing transactions ..................................................................................234
Correcting invalid transactions ..................................................................235
Viewing transaction statistics .....................................................................236
Scheduling events ......................................................................................237
DCM events and the Task Scheduler ................................................238
Defining a DCM command event ......................................................239
Deleting a command event ..................................................................242
Editing, copying, or renaming a command event ................................243
Testing an event .................................................................................243
Event Manager refresh interval ...........................................................243
E-mail notification of a command event failure ..................................244
DCM command events .............................................................................245
Events and download options ..............................................................250
Defining a program event ....................................................................254
Deleting a program event ....................................................................257
Contents
Editing, copying, or renaming an program event ............................... 258

E-mail notification of a run program event failure ............................. 258
Event sets ............................................................................................ 258
Centralized log file .................................................................................... 260
Log file viewer .................................................................................... 260
Log file format .................................................................................... 262
Transaction output files ............................................................................. 263
Transaction output file format ............................................................ 264
Data backups ............................................................................................. 266
Chapter 10: Using the Sentinel

Overview ................................................................................................... 268
Sentinel startup .................................................................................... 269
Sentinel status monitoring ......................................................................... 271
Monitoring communication channels and application connections .... 271
Displaying the status of the DCM system and DCM processes ......... 272
Editing the Sentinel Service properties ............................................... 273
Disabling the Sentinel ......................................................................... 274
Viewing the Sentinel log ..................................................................... 275
Sentinel shutdown .............................................................................. 275
Processing external start and stop requests ......................................... 275
Shutting down and restarting the Sentinel Service ............................. 275
Providing enhanced database connection support ..................................... 277
Retrying connections to the database .................................................. 277
Chapter 11: Loading Files and Data to and from a Device

Upgrading Series 4000 Terminals ............................................................. 280
Smart View functionality .................................................................... 280
Preparing to upgrade Series 4000 terminals ....................................... 281
Series 4000 terminal upgrade procedures ........................................... 284
Troubleshooting Series 4000 terminal softload problems ......................... 291
Performing a Series 400 firmware upgrade ............................................. 293
Loading firmware ................................................................................ 293
Re-initializing after performing a softload ................................................ 294
Loading a device parameter file ................................................................ 295

Contents
Extracting a parameter file ........................................................................296

Importing a parameter file ..........................................................................297
Exporting a parameter file ..........................................................................298
Synchronizing the date and time on the communication PC with all devices .
299
Using the Communication Monitor to set the date and time ...............300
Using the Device Manager to set the date and time ............................300
Chapter 12: Troubleshooting

Series 4000 terminal and configuration reports .........................................302
Viewing the Series 4000 terminal report .............................................302
Resetting the Series 4000 terminal biometric report data ...................302
Retrieving Series 4000 terminal configuration data ............................303
Troubleshooting procedures .......................................................................306
Setup and configuration .......................................................................307
Operation/data collection modes .........................................................315
System faults and recovery ..................................................................318
Optimizing Ethernet timeouts on busy networks .......................................321
Viewing application connections and communication channels ...............322
Reading a transaction output file ...............................................................323
Labor level settings ....................................................................................325
Troubleshooting with the Communication Monitor ..................................326
Chapter 13: Error Codes and Messages

Error messages ...........................................................................................328
Format ..................................................................................................328
Communication driver error codes ......................................................329
Communication channel error codes ...................................................334
Configuration service error codes .......................................................344
Softload error codes .............................................................................350
Data Collection Manager generic error codes .....................................350
Data Collection Manager Series 4000 error messages ........................368
Error messages from connecting to Workforce Timekeeper ...................390
Error messages from a Series 4000 terminal .............................................392
Device error messages from a Series 400 device .......................................393
Contents
Interpreting error messages ................................................................. 393

Error messages .................................................................................... 394
Appendix A: Theory of Operation

Data flow architecture ............................................................................... 408
Data transfer files ................................................................................ 408
Queue files .......................................................................................... 409
Application client ................................................................................ 409
Transaction files .................................................................................. 409
Log messages ...................................................................................... 410
Sentinel ............................................................................................... 410
Communication interface components ............................................... 410
Data flow in the Workforce Timekeeper system ....................................... 412
Uploading data .................................................................................... 412
Downloading data ............................................................................... 415
Appendix B: Modifying INI File Values

Setting bulk processing .............................................................................. 420
Setting the Sentinel Service status automatic refresh intervals ................. 421
Database disconnect retry wait time .......................................................... 422
List size settings ........................................................................................ 423
Registering a new communication PC ...................................................... 424
Appendix C: Understanding and Accessing

Punch/Transaction Data
Understanding collected transaction records ............................................ 428
Collected transaction record identifiers and data fields ...................... 428
Collected transaction record formats and syntax ................................ 433
Supervisor, Guard, and Maintenance Transaction records ................. 447
Punch Type and daylight saving time ................................................. 456
Using host commands to collect and clear transaction data ............... 458
Appendix D: Using DCM with Series 4000 Terminals

Series 4000 terminal features .................................................................... 460
Functional differences between Series 4000 and Series 400 devices ........ 461

Contents
Glossary
Index
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:
• “Organization of this guide” on page 14
• “Abbreviations and terms” on page 16
• “Related documents” on page 17
About This Guide
Organization of this guide

Chapters in this guide provide the following information:
• Chapter 1, “Introducing Data Collection Manager,” on page 19 presents the
DCM system by describing its components and how they interact.
• Chapter 2, “Defining an Application Connection,” on page 29 explains how to
define application connections that enable host applications to communicate
with the Data Collection Manager system.
• Chapter 3, “Communication Channels,” on page 37 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,” on page 65 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,” on page 137 explains how to configure
devices.
• Chapter 6, “Setting Up Labor Level Information,” on page 181 explains how
to set up labor level information and load it to devices.
• Chapter 7, “Totals and Accruals,” on page 195 explains how to configure soft
keys to display totals and accruals.
• Chapter 8, “Device Work Rules, Comment Codes, and Pay Code Edits,” on
page 203 explains how to configure device work rules, comment codes, and
pay code edits.
• Chapter 9, “Collecting Data and Managing Transactions,” on page 221
explains how to start data collection, manage transactions, and schedule
events.
• Chapter 10, “Using the Sentinel,” on page 267 provides an overview of the
Sentinel application that manages communication functions.
Organization of this guide
• Chapter 11, “Loading Files and Data to and from a Device,” on page 279
explains how to send files, data, and firmware to a device.
• Chapter 12, “Troubleshooting,” on page 301 provides procedures for resolving
problems that occur while using the Data Collection Manager system.
• Chapter 13, “Error Codes and Messages,” on page 327 lists the error codes
and messages.
• Appendix A, “Theory of Operation,” on page 407 describes the DCM
architecture and components and how they interact.
• Appendix B, “Modifying INI File Values,” on page 419 provides the INI file
values that are specific to the Data Collection Manager.
• Appendix C, “Understanding and Accessing Punch/Transaction Data,” on
page 427 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,” on page 459
provides a list of the Series 4000 features and a comparison of the Series 4000
and Series 400 devices.
• The “Glossary” on page 463 contains a list of terms with their meanings.

About This Guide
Abbreviations and terms

This section explains the following abbreviations and terms used in this guide:
Abbreviation Meaning
AFT Arbiter File Transfer
API Application Program Interface
comm channel communication channel
comm type communication type
DHCP Dynamic Host Configuration Protocol
DCM Data Collection Manager system
DLL Dynamic Link Library
DNS Domain Naming System
DSN Data Source Name
DUN Dial-Up Networking
IP Internet Protocol
LAN Local Area Network
LCD Liquid Crystal Display
ODBC Open Database Connectivity
PCMCIA Personal Computer Memory Card Interface Adapter
PPP Point-to-Point Protocol
RAS Remote Access Server
TCP/IP Transmission Control Protocol/Internet Protocol
WFC Workforce Central suite
WTK Workforce Timekeeper
Related documents
Related documents
In addition to this guide, the following documentation is available to help you use
Data Collection Manager:
• The Workforce Central Data Collection Manager Installation Guide provides
step-by-step instructions for installing the DCM system to use with the
Workforce Timekeeper system.
• The Workforce Central Data Collection Manager Database Tables 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 select the Index tab,
type an entry or scroll through the listed topics, and then click Display to view
a topic.
• The Series 400 Terminal Configuration Guide provides reference and
procedural information about configuring the Series 400 device.
• The Series 400 Terminal Installation Guide provides step-by-step instructions
for installing the Series 400 device.
• The Series 4000 Terminal User’s Guide provides basic concepts of the Series
4000 terminal, instructions for performing functions and transactions, and
maintaining and servicing the device.
• 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.
DCM installations include Release Notes that contain information about new
features, resolved and known issues and solutions, and late-breaking changes. You
can access this file from the DCM menu after DCM is installed.
PDF and HTML versions of the Workforce Central Data Collection Manager
Installation Guide, the Workforce Central System Administrator’s Guide—Data
Collection and the Workforce Central Data Collection Manager Database Tables
Reference Guide are available on the documentation CD.

About This Guide
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:
• “Overview” on page 20
• “DCM applications” on page 21
• “Accessing the Data Collection Manager applications” on page 25
• “Steps for configuring the Data Collection Manager” on page 27
Chapter 1 Introducing Data Collection Manager
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 from which employee data is 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 the Workforce Timekeeper application.
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:
• 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.
• Establish secure connections for Ethernet communication between DCM and
Series 4000 version 2.1 devices.
• 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.
DCM applications
DCM applications
DCM includes the following applications:
• Communication Monitor
• Device Manager
• Device Work Rules
• Event Manager
• Sentinel Service
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 Device
Work Rules.
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:
• 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:
• Initialize and update devices
• Set the date and time on the device
• Test device communications
• Monitor transactions for the system

• Edit and resubmit failed transaction data

• View the DCM log
• View local device transactions
Device Manager
The Device Manager application enables 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:
• Check device status
• Load files, device programs, and collected data
• Enable logs for troubleshooting
• If the environment changes, modify the configuration, and then re-initialize
devices
• Update device firmware
• Start and stop data collection
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:
• 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 2003, Windows XP Professional, or Windows
Vista monitoring PC.
• It enables you to test communication to a device as the final step in adding or
editing the device.
DCM applications
Device Work Rules

The Device Work Rules application enables you to create, edit, and delete Device
Work Rules that you can then assign for use at specific devices by using the
Device Manager. A device work rule enables employees to perform a work rule
transfer at a device. Device work rules map work rules to pay rules, which allows
a single device work rule to be used at a device to transfer different employees to
different work rules, based on the employee's pay rule assignment in Workforce
Timekeeper.
For more information about device work rules, see “Device work rules and
profiles” on page 204.
Event Manager
The Event Manager application enables you to configure scheduled actions or
tasks, which are called events. The events are then listed in the Microsoft Task
Scheduler where they are launched at specified times. You can use the Event
Manager to configure events, including:
• Send configuration changes made in Workforce Timekeeper or Device
Manager to devices
• Collect data from modem or other devices configured for batch data
collection
• Send the date and time to devices
• Run programs
• Load Firmware to devices
You can access the Event Manager by selecting Start > Programs > Data
Collection Manager > Event Manager, by selecting Tools > Event Manger
from the Device Manager, or by selecting Tools > Event Manager from the
Communication Monitor.
For events to run successfully, the Microsoft Task Scheduler must be running on
the DCM communication PC. For all events except Disable Sentinel and Enable
Sentinel, the Sentinel Service must be running on the same DCM communication
PC. The Event Manager does not need to be running when an event is launched.

E-mail notification of event errors are set up in the DCM System Settings. For
more information about e-mail notification, see “E-mail notification settings” on
page 129.
If the DCM communication PC is restarted, scheduled events run automatically
without requiring user intervention. Event Manager log messages appear in the
DCM centralized log file. For more information about the centralized log, see
“Log File settings” on page 118. For more information on scheduling events by
using Event Manager, see “Scheduling events” on page 237.
Sentinel Service
The Sentinel Service is a Windows service 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 running in order to
perform most DCM operations.
The Sentinel Services is configured as an automatic 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 communication PC is started
For more information about the Sentinel Service, see “Using the Sentinel” on
page 267.
Accessing the Data Collection Manager applications
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 the first application, the logon screen appears. This logon requires
you to enter a user name and password.
About the DCM integrated logon utility

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.
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.
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. The user ID
is stored and used later in these applications and their database connections .
Reports about DCM in the Workforce Timekeeper application

The Workforce Timekeeper application provides the following reports that
contain information from DCM:

• Device Work Rule Definitions Report—A device work rule enables you to
associate a work rule with a pay rule. For example, when hospital employees
enter the operating room, they press a soft key and swipe their badges. This
activates the work rule and pay rule assigned to the device work rule. The
employees swipe again when they leave.
The Device Work rule Definitions report shows the device work rule
definitions that are configured in the Data Collection Manager.
• Device Work Rule Profiles Report—Device work rule profiles enable you
to map device work rules to the soft keys on devices.
The Device Work rule Profiles report shows the device work rule profiles that
are defined in the Data Collection Manager.
• Device Assignments Report—The Device Assignments report contains a list
of devices that includes the device ID, device name, the device groups that
each device belongs to, whether or not the device has collection enabled, the
communication channel that the device is assigned to, and whether or not the
device is enabled.
• Device Group and Device Assignments Report—The 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 or not each device is enabled.
For more information about Workforce Timekeeper reports, see the Workforce
Timekeeper documentation.
Steps for configuring the Data Collection Manager
Steps for configuring the Data Collection Manager

The following table outlines the necessary steps to configure the DCM system:
Step Reference
1. Plan implementation: communication

connections and device destination on
communication PCs.
2. Define the connections for the applications that “Defining an Application
use DCM to get data. Connection” on page 29
3. Configure communication channels. “Communication Channels” on page
37
4. Configure device groups and assign devices to “Device Group and Global Setup” on
the groups. page 65
5. Configure devices, device application options, “Configuring Devices” on page 137
and device download options.
6. Synchronize the date and time of the devices “Loading Files and Data to and from
with the communication PC. a Device” on page 279
7. If you are upgrading, extract existing device “Loading Files and Data to and from
configuration from the device to a parameter a Device” on page 279
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
the existing configuration.
8. Configure the parameters for each device and “Device Group and Global Setup” on
download the parameters to the device. page 65
9. Load data to the devices. “Loading Files and Data to and from
a Device” on page 279
10. Start data collection. “Collecting Data and Managing
Note: This step is not necessary if Online is Transactions” on page 221
selected for the device, and Automatic Data
Collection is selected for the device group.

Step Reference
11. If you are using batch collection, use the Event “Collecting Data and Managing
Manager to schedule a Collect Event and any Transactions” on page 221
other required events.
12. Configure Events to periodically update “Collecting Data and Managing
configuration data at devices. Transactions” on page 221
Chapter 2
Defining an Application Connection
This chapter explains how to define and edit the connections between Workforce
Central applications and the Data Collection Manager (DCM) system.
• “Application connections” on page 34
Chapter 2 Defining an Application Connection
Overview
DCM uses application connections to send punches to and exchange other
information with the Workforce Timekeeper application via the Workforce
Central application server. DCM provides a default application connection,
Application Connection 1. 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 communication PC automatically starts the required application
connections based on the devices assigned to communication channels that run on
the DCM communication PC.
A communication PC is the computer where communication channels are set up
to communicate with devices and to collect data. You can have all applications of
the Data Collection Manager (DCM) system on a communication PC. You can
even run the host application on that same PC. Alternatively, you can use one PC
for the communication PC, other PCs for different DCM applications, and still
another PC for the host application. You can have more than one communication
PC in a device network system.
You can specify system settings for connections to additional Workforce Central
application servers. The application server connection defaults to the application
server to which the communication PC is connected.
Note: Multiple connections are available only when bulk processing is enabled in
DCM.
For more information about setting up the server connections, see “Application
server connections” on page 31 and “Application connections” on page 34.
If DCM is connected to multiple communication PCs, you need a share folder and
file-based requests enabled. For more information about setting up a network
share folder for a DCM system with multiple communication PCs, see “Multiple
communication PCs” on page 62. For more information about setting up DCM
file-based requests in that network environment, see “Server Connection settings”
on page 132.
Overview
For more information about device group definitions, see “Creating device
groups” on page 70. For more information about communication channel
assignments, see “Adding a device by using the Device Manager” on page 80.
Application server connections

When the Sentinel starts up on a system, it establishes all the application
connections configured for the local system.
If no applications have been started, the SentinelService Configuration dialog box
appears.
Caution: Collect all data before changing the information in the application
connection. Do this to avoid routing information to the wrong destination.
To configure the primary default web or application server connection in the user
interface:
1. Select one configuration from the Available Configurations list box.

2. Click Select. The information in the Current Selection area of the screen
changes to reflect the selection.
3. Click OK.
To configure the server connection manually:

1. Enter the Workforce Timekeeper server name in the Host Name text box. You
must know the name of the server, and include the domain suffix of the server.
For example, myserver.mycompany.com.
When you configure host names or application instances, use the following
formatting rules:
– The maximum number of alphanumeric characters for the host name is
301 (250 for the host name, 1 for the semicolon, and 50 for the port
number). Spaces are not allowed. The host name is not case-sensitive.
The semicolon and port number are optional and are used together only
for configuring to application server.
– The maximum number of alphanumeric characters for the application
instance is 50 and is case-sensitive. The first character can be a forward
slash (/) and spaces are not allowed.
2. Enter the instance of the Workforce Timekeeper application that you want to
use in the Application Context text box. You may have only one instance on
the server or you may have several. You must know the name of the instance
you want to use.
3. Select the connection protocol to be used in communications between the
application and the Workforce Timekeeper server: https (SSL) or http (non
SSL).
Caution: The protocol that you select, http or https, must match the protocol
used by the web or application server and be consistent with other protocol
selections made for that server.
4. Click OK.
5. Restart the system for the changes to take affect.
Overview
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 the 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 “Server Connection settings” on page 132.
To change the application server connection, see “Editing the Sentinel Service
properties” on page 273.

Application connections
You can edit an application connection description. You can also delete and create
an application connection.
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 Connection 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:
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.
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.
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: / * ” ’ ? < > | : ;
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 70. For more information about
communication channel assignments, see “Adding a device by using the
Device Manager” on page 80.

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, how to set up connections, and
how to set up a multiple communication PC environment.
• “Creating communication channels” on page 39
• “Configuring a modem for a Series 4000 terminal” on page 43
• “Configuring communication channels in the Device Manager” on page 53
• “Multiple communication PCs” on page 62
Chapter 3 Communication Channels
Overview
The Data Collection Manager (DCM) system includes communication channels
that support communication between devices and host applications.
Devices that interact with a host application use on the following three
communication methods:
• Ethernet
• Serial (Series 400 and Series 100 only)
• Modem (dedicated analog only)
Note: You can use both Series 400 and Series 4000 terminals with a modem,
but Series 400 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 76.
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:
• IP address or DNS name, if Ethernet
Note: Latin 1 characters are not supported in DNS host names.
• Telephone number, if modem

• Baud rate, if serial
Creating communication channels

When you create communication channels, specify a different communication
channel for each type of communication. For example, if the 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 page 40.
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 Workforce Central Data Collection Manager Installation
Guide for more information.
Communication Maximum Number of Devices

Type Device Type per Communication Channel
Ethernet Series 4000 only 50
Ethernet All devices except Series 4000 20
terminals
Modem Series 4000 only 50
Modem All devices except Series 4000 30
terminals
Serial All devices except Series 4000 50
terminals

Modem channels
You can configure a modem for a Series 4000 or a Series 400 device, but the
configuration is different. To configure a Series 4000 modem, you must create a
dial-up connection in the 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:
• 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.
• 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.
• 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 the
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 Device Group B

Communication channel 1 same modem 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 “IP
addresses for the communication PC and Series 4000 terminals” on page 43.
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.
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.
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. For example,
in the following illustration, all Series 4000 terminals on Modem 1 can have IP
address 3.
If you are using more than one modem on a communication PC, you must use
different IP addresses for the Series 4000 terminals on each modem
communication channel. For example, in the following illustration, IP address 3
must be different than IP address 5.
The following items are some guidelines for assigning IP addresses:
• Assign IP addresses that do not conflict with other devices in the corporate
network. Do not use a subnet that is the same as the corporate subnet.

To determine whether or not an IP address was assigned to a Series 4000

terminal, 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.
• Define one dial-up connection for each modem on the communication PC.
Assign an IP address with a different subnet to each connection. Make sure
that the IP address(es) assigned to the Series 4000 terminals on one modem
communication channel are different from the IP address(es) assigned to
Series 4000 on all other modem communication channels on that
communication PC.
• 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 communication PC when the Sentinel
Service is running, you must restart the Sentinel Service to have the change
take effect.
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 PPP Client

Remote Access Service Remote Access Service
IP address 2 IP address 4
example: 192.168.0.1 Modem 1 Modem 2 example: 192.168.1.1
IP address 3 IP address 5
example: 192.168.0.2 example: 192.168.1.2
Modem Modem
PPP Server PPP Server
Series 4000 timeclock Series 4000 timeclock
All devices using this All devices using this

dial-up connection can dial-up connection can
use IP address 3. use IP address 5.
Each dial-up network must have a different subnet.

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 Type of Network

10.0.0.1–10.255.255.255 Class A network
172.16.0.1–172.31.255.255 A contiguous block of 16 class B networks
192.168.0.1–192.168.255.255 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
Location Connects to Address
IP address 1 Communication PC A corporate intranet, Internet
IP address 2 modem 1 on Communication first group of devices 192.168.0.1
PC A
IP address 3 modems on first group of modem 1 on Communication 192.168.0.2
devices PC A
IP address 4 modem 2 second group of devices 192.168.1.1
IP address 5 modems on second group of modem 2 192.168.1.2
devices
Communication PC B
Sample IP
Location Connects to Address
IP address 6 Communication PC B corporate intranet, Internet
IP address 7 modem 1 on comm PC B third group of devices 192.168.2.1
IP address 8 modems on third group of modem 1 on 192.168.2.2
devices Communication PC B
IP address 9 modem 2 on communication fourth group of devices 192.168.3.1
PC B
IP address 10 modems on fourth group of modem 2 192.168.3.2
devices
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 the 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.
Prerequisites
Before you use DCM to configure a modem for a Series 4000 terminal, verify that
the following tasks are accomplished:
• 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 the Series 4000 terminal.
• Version 1.1 or later of the Series 4000 firmware is installed. This version
includes PCMCIA modem support.
• An IP address is entered physically at each device, using Maintenance mode.
For more information about IP addresses, see “IP addresses for the
communication PC and Series 4000 terminals” on page 43.
• 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 the
operating system.
• DCM 5.0 or later is installed on the communication PC.
• The Remote Access Service (RAS) is installed for the 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.
• 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 the communication PC by using the
Microsoft Network and Dial-up Connections application.
2. Use the Device Wizard or the Device Manager to add the device.
3. Use the Device Manager to configure the device.
Configuring a dial-up entry on Windows 2003
To create a dial-up entry:

1. From the Windows Start menu, select Settings > Network Connections or, if
displayed as a menu, right-click the dial-up icon and select Open. The
Network Connection dialog box appears.
2. Under Network Tasks, select Create a new connection. The Welcome to the
New Connection Wizard dialog box appears.
3. Click Next. The Network Connection Type dialog box appears.
4. Select Connect to the network at my workplace and click Next. The
Network Connection dialog box appears.
5. Select Dial-up connection and click Next. The Select a Device dialog box
appears.
6. Select the modem that you plan to use and click Next. The Connection Name
dialog box appears.
7. Type the name for the connection in the Company Name text box. The Phone
Number to Dial dialog box appears.
8. Enter a telephone number in the Phone number text box. You may need to
include a 1 or the area code or both. To verify whether or not you need the
extra numbers, dial the telephone number on the telephone. If you hear a
modem sound, the number that you dialed is correct.
9. Click Next. The Connection Availability dialog box appears.
10. Select Anyone’s use and click Next. The Completing the New Connection
Wizard dialog box appears.
11. 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
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 114.
12. After you click Finish, the Connect DCM Setup dialog box appears.

13. Click Properties. The DCM Setup Properties dialog box appears.
14. On the General tab, the modems that are defined in the Windows operating
system appear. Verify that the modem that you previously selected is checked.
15. Select the Options tab to adjust the redialing options.
a. From the Redial attempts list, select zero.
b. From the Idle time before hanging up list, select 1 minute.
16. Select the Network tab.
a. From the Type of dial-up server I am calling list, select PPP: Windows
95/98/NT/2000, Internet.
b. From the This connection uses the following items list, select the
Internet Protocol (TCP/IP) check box.
c. Click Properties. The Internet Protocol (TCP/IP) Properties dialog box
appears.
d. Select Use the following IP address.
e. 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 “IP addresses for the communication PC and Series
4000 terminals” on page 43.
Do not enter DNS server addresses.
f. Click Advanced. The Advanced TCP/IP Settings dialog box appears.
17. On the General tab,
a. Clear the Use default gateway on remote network check box if it is not
already cleared.
b. Check the User IP header compression check box if it is not already
checked.
18. Click OK three times. You return to the Connect DCM Setup dialog box.
19. Click the Close icon.
Configuring dial-up networking on Windows XP Professional
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 the connection type, select the Connect to the network at my workplace
check box and click Next.
4. For the way the connection is to be made, select Dial-up connection and click
Next.
5. Enter a name for the 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 the 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
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 114.
To modify the 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.
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 the settings.
Configuring communication channels in the Device Manager
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
“Device Group and Global Setup” on page 65.
To access the Device Manager, select Start > Programs > Data Collection
Manager > Device Manager. The Device Manager main window opens. You can
also select 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.
See the following sections for information about the dialog boxes that you need to
complete for Ethernet, serial, and modem communication channels:
• For Ethernet options, see “Defining an Ethernet communication channel” on
page 55.
• For modem options, see “Defining a modem communication channel” on
page 57.
• For serial options, see “Defining a serial communication channel” on page 60.
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.

Secure communication
A DCM installation that supports secure communications with the Series 4000
devices requires an Apache or IIS Web server. The Web server setting uses the
default port 80 for standard HTTP communication and port 443 for HTTPS
(secure) communication. In a secure installation, the Web server uses a DCM
proxy module within the Apache or IIS Web server to forward requests to the
DCM Collection Agent.The Web server settings default to the same values.
If the Web server listening port setting must be changed, first edit the IIS or
Apache Web server setting, and then update the Web server setting on the
Communication tab. Stop and restart Sentinel after you make the changes.
If the DCM server runs behind a Network Address Translation (NAT) server, add
the following lines to the krdcm.ini file:
[DCM Host IP Alias Table]
alias_name=outside IP address on NAT server mapped to
the internal DCM server IP address
DeviceID=alias_name
where:
The DeviceID is the six-digit device identifier for each terminal outside the
internal-protected local area network that DCM must communicate with. Add
each device identifier on a different line and set equal to the alias_name. Entries
are not required for devices that communicate with DCM on the inside internal-
protected local area network.
The alias_name can be any text other than the DCM server's HOSTNAME.
Example
NAT=158.228.65.187
111111=NAT
123456=NAT
Defining an Ethernet communication channel

From the Device Manager main window, select Setup > Comm Channels. The
Setup Comm Channels dialog box appears.
1. Click New. The New Channel dialog box appears.
2. Enter a unique Communication Channel name, and click OK. The Comm
Channel - channel name dialog box appears.
3. Enter a description of the communication channel.
4. Select the communication PC that is part of the communication channel that
you are configuring.
5. If the communication PC supports Secure Sockets Layer (SSL) technology
and was selected during the installation procedure, that information appears
next to the named communication PC.
Note: If devices that use SSL are assigned to this channel, the devices can
only be assigned to communication PCs that support SSL.
6. Select Ethernet as the Communications Type.

7. Select Series 4000 or All other devices for the device type.
8. Specify the amount in seconds for the time between collections in the Collect
Interval text box. The valid range is 1 to 43200 seconds. The default is 20
seconds.
9. 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. The default is 4 seconds.
10. 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.
11. 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.
12. To return to the system defaults, click Defaults.
13. Click OK.
Series 400 Ethernet communication

For busy networks, Kronos recommends that you increase the Ethernet timeout
values on both the DCM communication PC and the device. The standard timeout
setting is two seconds. Valid settings range from one to five seconds.
Kronos recommends that the timeout values for the DCM communication PC and
the device be equal.
Note: Setting Ethernet timeouts applies to Series 400 devices only.
To set the Ethernet timeout values for the DCM communication PC and a device:
1. Close all data collection processes that are running on the DCM
communication 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 DCM communication 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.
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. Kronos recommends that this value equal the value that is set for
the timeout for the DCM communication PC.
5. Restart data collection processes on the communication 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.
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:
– Series 4000—If you select Series 4000, the Modem tab appears. Go to
step 9.
– All other devices—If you select All other devices, the Advanced and
Modem tabs appear. 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.
a. 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 the current PC and displays the
appropriate modem and initialization strings in the Modem tab.
b. From the Baud rate list, select the baud rate of the modem for the
communication PC.

c. From the Model string list, select the modem connected to the
communication PC. The initialization string for that modem appears
automatically in the Initialization string box.
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 String Baud Rate

Motorola 28.8K &F\Q0 19,200
2,400
US Robotics 56K &FE1V1&C1&D2 19,200
US Robotics 56K &F&C1&D2&K0&N3 2,400
d. 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 the changes in the Initialization string box. Before you do
so, check the modem documentation for suggested initialization strings.
e. 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.
f. 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.
g. Click Auto detect to have the Data collection Manager check the PC that
you are using for available modem connections or communication ports.
h. 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.
i. 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 device’s configuration guide for the appropriate
procedure.
j. If you have a communication failure during initialization of Series 100
devices, increase the Wait after hang-up value to 4000 msec.
k. 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, click the Modem tab to specify the
dial-up connection that you configured in Windows.
If the dial-up connection does not appear in the list, see “Configuring a
modem for a Series 4000 terminal” on page 43.
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 Model Number

Zoom Dual Model 56 2929L
US Robotics 56K 5686
Hayes Optima 56 02892
Note: USB modems are supported by DCM only for Series 4000 terminals.
10. Make any changes needed and click OK to return to the Comm Channel
dialog box.
USB modems
Some USB modems may behave differently under different operating systems.
For example, you may not be able to connect to the devices if you are using the
SupraMax External — USB 56K Modem (Part Number 90680023) from
Diamond Multimedia with a server running Microsoft Windows Professional XP.
If you have a USB modem that is not connecting to a Series 4000 terminal,
performing the following steps may correct the problem.
1. From the Start menu, open the Windows Control Panel

2. Double-click Network Connections. The Network Connection dialog box

appears.
3. Select the modem connection and select File > Properties. The Properties
dialog box appears.
4. Click Configure on the General tab. The Modem Configuration dialog box
appears.
5. Disable the Enable hardware flow control check box. The other two boxes
are disabled too.
6. Click OK twice to return to the connection icon screen.
You can connect now to the device.
Note: Kronos recommends using the most recent drivers for the modem, which
are available on the manufacturer's Web site. Be sure to download and install the
latest patches and services packs for the Microsoft operating system.
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 138.
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.
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, in seconds, between network checks. A network check for
collecting devices tests the connectivity between the communication PC and
the collecting devices managed within DCM. The valid range is 1 through
43200 seconds.
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.
11. Select any necessary parameters from the Advanced tab.
12. Click OK.
For information about the parameters, see the DCM online Help.

Multiple communication PCs

When you make a file-based request, DCM looks for or creates these files on the
DCM communication PC that is processing the communications request. If the
installation has more than one communication PC and you want to initiate a file-
based communication request from one PC that will take place on another PC, you
must specify a shared network folder that all DCM communication PCs can use
for the file-based communication requests, enable the Sentinel Service access to
the shared file, and specify system settings for the use of file-based requests
across communication PCs.
The following DCM file-based requests require a shared network folder for use
across multiple communication PCs:
• Load Firmware
• Load Parameter File
• Extract Device Parameters
• Get Device Report
• Get Device Configuration
To set up the system for file-based requests:
1. Set up a shared network folder. Refer to the system documentation.
2. Enable the Sentinel Service access to the shared file:
a. From the Control Panel, select Administrative Tools > Services.
b. Scroll down and right-click SentinelService.
c. Select Properties. The SentinelService Properties (Local Computer)
dialog box appears.
d. Click the Log On tab. The Log On dialog box appears.
e. Click This account and enter the name of the account with domain access
rights.
f. Enter the password twice for that domain account.
g. Click OK.
3. Specify the system settings for the use of file-based requests across
communication PC as described in “File-based communication requests” on
page 125.
Multiple communication PCs
Multiple NIC Cards

For a Series 400 device, DCM does not support multiple network interface (NIC)
cards or teaming software. If a DCM server is equipped with more than one
network interface card or with NIC teaming software, communication problems
may occur and punch collection may be delayed or fail. In some cases, punches
may be lost. Disable or remove all but one network interface card.
For a Series 4000 terminal, DCM supports multiple network interface (NIC) cards
but does not support teaming software. If the DCM communication PC has more
than one NIC card, you must specify the NIC card to bind for DCM
communications using the NIC card IP address. You must do this for all DCM
communication PCs in the DCM system.
IP addresses are set in the krdcm.ini file. For example, if the system has three
communication PCs each with more than one NIC card, the following settings
would identify each DCM communication PC, where DCMPC1 through
DCMPC3 are the host names:
• [DCM Host IP Alias Table]
• DCMPC1 = 158.228.48.22
• DCMPC2 = 158.228.48.44
Workforce Central components that are used by DCM to communicate with
Workforce Central applications must be modified manually to support DCM
running on a communication PC that has more than one NIC card. Modify the
WFCAPI.ini file in the kronos\wfc\kronscm\lib directory as
illustrated in the following example. This example uses the format PCName = IP
address.
[Host IP Alias Table]
DCMPC1 = 158.228.48.22

Chapter 4
Device Group and Global Setup
This chapter explains how to create, edit, and delete device groups and devices.
• “Device Manager” on page 69
• “Creating device groups” on page 70
• “Editing device groups” on page 73
• “Copying device groups” on page 74
• “Deleting device groups” on page 75
• “Adding devices” on page 76
• “Editing devices” on page 86
• “Copying devices” on page 88
• “Deleting devices” on page 94
• “Bell schedules” on page 96
• “Gate schedules” on page 98
• “Soft key schedules” on page 101
• “Proximity badge formats” on page 104
• “Smart View transactions” on page 105
• “System Settings” on page 114
Chapter 4 Device Group and Global Setup
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 “Communication Channels” on page 37. For more information about data
collection, see “Collecting Data and Managing Transactions” on page 221.
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 by
using 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 76.
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:
• 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 “Using DCM with Series 4000 Terminals” on page 459.
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:
• 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 the 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:

• Data collection
• Employee assignment

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 three buildings in the assigning device group, or just
to the device at the front door of each building. 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
Referring to the previous example, you could create the Facility device group to
enable data collection for all devices. 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.
Device Manager
Device Manager
The DCM Device Manager 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.
The Device Manager main window displays the configuration. After a
communications channel and a device is assigned to a device group, the device
groups appear on the left and 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, see “Defining an Application Connection” on page 29.

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:
• 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 76):
a. From the Device Manager main window, select Setup > Device Wizard.
b. Click New, or select a device and click Edit.
c. Proceed through the Device Wizard until you reach the Select Groups
dialog box.
d. Click Add Group. The Add Device Group dialog box appears.
• Using the Device Manager when you are creating or editing a device:
a. Open the Device Manager main window.
b. Select Setup > Device Groups. The Configure Device Groups dialog box
appears.
c. Click New to add a device group. The Add Device Group dialog box
appears.
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 the 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.
Creating device groups
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 “Collecting
Data and Managing Transactions” on page 221.
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 76.
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.
Collecting and 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:
• 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 groups
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 Groups, 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 (*).
Editing device groups
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.
3. To edit a device group, make changes in the Edit Device Group dialog box,
and click Update.

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:
Configure Device Groups dialog box appears.
2. Select a device group and click Copy. The Add Device Group dialog box
appears.
3. To copy a device group, type a name for a new device group in the Add
Device Group dialog box, and click Add.
Deleting device groups
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:
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.

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.
Before you add a Series 4000 terminal that is currently configured for a secure
communication PC to a non-secure communication PC, you must first use Setup
> Device or Setup > Device Wizard to change the Series 4000 terminal
configuration from https (secure) to http (non-secure). For more information
about editing a device, see “Editing devices” on page 86.
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.
5. In the Device Identification dialog box:
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
Adding devices
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 the 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.
c. 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 the system during the blackout period, you
must manually send the time to the device and initialize the device after
the blackout period.
d. If you are adding a Series 4000 terminal, select the language. English is
the default.
e. If you are adding a non-Series 4000 terminal, you can select to have a
printer attached.
f. Click Next.
7. In the Communication dialog box:

a. Select the communication method: Ethernet or modem for Series 4000

terminals, or Ethernet, modem, or serial for all other devices.
b. Select the name of the communication PC. If the communication PC
supports Secure Sockets Layer (SSL) technology, that information
appears next to the named communication PC.
c. Click Next.
8. In the Collection dialog box, select the method to use to collect data from the
device and click Next.
Online collection allows for continuous data collection from the device when
the device is initiated. Online devices can also use scheduled collections.
Batch collection sends data when a scheduled collect event is initiated.
Modem devices use batch. Serial and Ethernet devices may use either online
or batch collection.
9. In the Communications Settings dialog box, the information that you enter
depends on whether the connection is Ethernet, modem, or serial and whether
or not the system is secure.
a. 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 “IP addresses for the
communication PC and Series 4000 terminals” on page 43.
Do not enter DNS server addresses. If you enter a host name, it must be
known on the network by being configured on a Domain Naming System
(DNS) server on the network.
b. If the communication PC supports secure Series 4000 terminals, you can
select https (SSL). Select the appropriate Protocol.
c. For a modem connection:
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 the
system.
Adding devices
Note: You cannot share a communication channel or modem between a Series

4000 terminal and other types of devices.
Series 4000 terminal—Type the telephone number. Select the dial-up

connection that you configured in Windows. If the dial-up connection
does not appear in the list, see “Configuring a modem for a Series 4000
terminal” on page 43.
d. 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.
10. Click Next.
11. In the Select Groups dialog box:
a. 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 70.
b. Click Next.
12. 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 the device.
Download options specify what information to send to devices from the
Workforce Timekeeper database. The download options that you select
for the device are always used for the LoadGroup, LoadDevice,
UpdateGroup, and UpdateDevice events and when you select Initialize
from the Device Manager or Communication Monitor.
When you select Device Initialize from the Device Manager, you can add
and delete options for that particular initialization.
For more information about the download options, click Help in the
Download Options dialog box, or see “Events and download options” on
page 250.

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.
13. 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.
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. 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.
5. Select the collection method. 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 scheduled collect
event is initiated. Modem devices use batch. Serial and Ethernet devices may
use either online or batch collection.
For more information about data collections, see “Collecting Data and
Managing Transactions” on page 221.
6. 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.
7. You can add a description of the device to identify it; for example, a
description that describes its location or use within the organization. The
description can be up to 40 alphanumeric characters, including spaces.
8. If you are using an IP address, type the address in the Communication settings
section.
Adding devices
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 “IP addresses for the communication
PC and Series 4000 terminals” on page 43.
Do not enter DNS server addresses.
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 the network. The host
name must be configured on a Domain Naming System (DNS) server on the
network.
9. If appropriate, enter the phone number of the associated modem from which
the device can be reached in the Phone number text box. You may also need to
set the Device User ID and password in order to load firmware to Series 4000
modem devices.
a. If the Series 4000 device has firmware version 2.0 or greater, and you
have changed the default FTP User ID and password at the Series 4000
device, click Device Password, clear the Use default User ID and
Password check box, and enter the User ID and password.
b. If the Series 4000 terminals has firmware version 1.3.x or earlier, click
Device Password and ensure that the Use default User ID and
Password check box is checked.
To load firmware to Series 4000 modem devices, FTP must be enabled on
Series 4000 terminals, and the FTP user name and password at each Series
4000 terminal must match the FTP user name and password that is specified
for that device in Device Manager > Setup > Device > Edit > Device
Password.
Series 4000 devices with Firmware versions 2.1.0 and later have FTP enabled
by default. You must enter Maintenance mode at the Series 4000 terminal and
use the Telnet/FTP logon transaction to enable FTP. You may also change the
user name and password from their default values. If you change the default
values, you must change the user name and password that is specified for that
device in DCM, as well.

Note: If you disable FTP or change the user name or the password at the
device but not in DCM, you cannot load firmware to this device.
Series 4000 devices with Firmware versions 1.3.x and earlier have FTP
enabled, and you cannot change the default User ID and password. No change
is required in DCM for these devices.
Note: If you change the DCM user name and password, you cannot load
firmware to this device.
Note: User names and passwords that are entered at Series 4000 terminals are
numeric unless the terminal has an alpha-numeric keypad.
10. If you are adding a Series 4000 version 2.1 device, you can select either the
https protocol for a device that supports Secure Sockets Layer (SSL)
technology or the http protocol for a device that does not support SSL.
If you select http and the device supports SSL, security is not available.
If you select https and the device does not support SSL, you cannot initialize
the device when the device firmware version is determined. A message
appears at initialization time that states that incompatible security settings
exist between DCM and the device.
11. Device Enabled is selected by default. Only enabled devices can be used in
communication.
The bright green icon in the Device Manager hierarchical tree indicates that
the device is enabled. A darkened green icon indicates disabled devices.
12. If you are adding a Series 400 device, you can also select the Printer
Attached check box.
13. If you are adding a Series 4000 terminal, specify the language. English is the
default.
14. Select Download Options and Application Options as needed. You can also
select Configuration options.
Adding devices
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 device work rule 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.
For more information about job sets and job transfers, see “Job Transfer tab”
on page 161. For more information about device work rule profiles, see
“Device Work Rules, Comment Codes, and Pay Code Edits” on page 203. For
more information about labor level sets, see “Setting Up Labor Level
Information” on page 181.
15. 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.
16. When you are finished, click OK to add 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.
If the device groups have been created, you can assign devices to device groups
by communication channels.
To add devices 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 device to be assigned from the Unassigned devices list, and click
Add. The device moves to the Assigned devices list.
4. Select the Communication Channel that the device is to use from the Assign
Using Comm Channel drop-down list.
Use the communication channel that matches the device’s communication
method. For example, assign an Ethernet device using an Ethernet
communication channel.
If the communication PC supports Secure Sockets Layer (SSL) technology,
that information appears beneath the named communication PC.
Note: If the channel does not support SSL communication, you cannot assign
a device that is configured for SSL communication to that channel.
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 when you are done adding
devices to a device group, 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
Adding devices
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:
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.
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.
a. Click Yes if you are defining a new collecting device group and click OK
on the Assign Group Devices dialog box.
b. Click No if you are defining an assigning device group and click OK on
the Assign Group Devices dialog box.
c. 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 67.
6. Repeat steps 2–5, selecting another device group to which you add the device,
until the device is added to all the required device groups.
7. When you are finished, click OK.

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.
6. From the Device Manager main menu, select the target device and select
Communications > Initialize. The Load Configuration options dialog box
appears.
7. Select Device Configuration and click OK.
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 the application connection.
4. Repeat steps 1-3 to edit more devices, or click Close to return to the Device
Manager main window.
Editing devices
appears.
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.

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, download options, and application options.
You can copy devices by using the Device Manager or the Device Wizard.
Note: If you copy a Series 400 device to a Series 4000 terminal, some supervisor
commands cannot be mapped into equivalent Series 4000 transactions. When the
copy process is complete, a log file is created that describes the function key
configuration that could not be mapped.
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. If you are copying a Series 400
device, select either a target Series 400 or Series 4000 terminal and click
Next. If you are copying a Series 400 terminal, click Next. The Device
Identification dialog box of the Device Wizard appears.
3. Type a device name and a unique device ID, change the device description if
appropriate, and click Next.
4. Select the time zone, whether or not to automatically adjust the device for
daylight saving changes, select the language, and click Next.
5. Select the communication method and the communication PC, and click
Next.
6. Select the collection method and click Next.
7. Select the communication setting and the protocol. If you select to use the IP
address, do not use the IP address of the original device for the copied device.
Click Next.
Copying devices
8. Select the collecting device group for the target device. Select a group from
the drop-down list or click Add Group to create a new collecting device
group.
9. When you reach the end of the Device Wizard, click Finish to add the device
to the database.
Copying a device by using the Device Manager

You can use the Copy function to copy a Series 400 device to another Series 400
device or to a Series 4000 terminal, or to copy a Series 4000 terminals to another
Series 4000 terminal.
You can use the Copy To function to copy a existing device to another existing
device. Both devices must be the same model.
Copy function
You can use the Device Manager to copy a Series 400 device to either another
Series 400 device or to a Series 4000 terminal, or to copy a Series 4000 terminal
to another Series 4000 terminal.
When you are copying a Series 400 device to a Series 4000 terminal, note the
following issues:
• If you are copying a Series 400 device to a Series 4000 terminal, some
functions that are equivalent may have different names. For example, a Series
400 Decimal Transaction is equivalent to a Series 4000 Pay Code Money
Edit.
• If you are copying a Series 400 device to a Series 4000 terminal, the Series
400 in-punch processing is not copied to the Series 4000 terminal. Instead, an
entry is added to the conversion log file. This is not the only function that
cannot be copied from a Series 400 device to a Series 4000 terminal, but it is
unique because you can manually configure the Series 4000 terminal so that it
behaves closely to the way the Series 400 does.
The Series 400 device can be configured to prompt the employee to enter
labor data for one or more in-punches for a shift. These prompts can be
configured so that the entry of labor data is mandatory or optional.
Collectively, this configuration is referred to as Series 400 in-punch
processing.

When Series 400 in-punch processing is enabled, the behavior is as follows:

– When an employee swipes a badge or enters a PIN, the Series 400 device
performs a punch. This includes adding a punch record in the FIFO.
– If the punch is an in-punch, the Series 400 terminal determines (based on
configuration) if it needs to prompt the user for labor data. Depending on
configuration, the prompt for labor data may require the user to enter
labor data, or allow the user to enter labor data or press Clear to bypass
the prompts.
– If the user entered labor data for the in-punch, the Series 400 terminal
generates a Labor Transfer record and adds the record to the FIFO.
Caution: The Series 4000 terminal can be configured to prompt for labor data
on in-punches by assigning Labor Transfer transactions to one or more default
transactions. However, the functionality provided by Series 4000 default
transactions differs from the Series 400 in-punch processing. The Series 4000
does not generate a punch record in the FIFO before performing a Labor
Transfer. Thus, if a default transaction is configured with a Labor Transfer,
and the employee aborts the Labor Transfer, neither a punch nor a Labor
Transfer record is added to the FIFO. The Series 400 does add a punch record
to the FIFO.
To use the Device Manager to copy a Series 400 device to another Series 400
device or to a Series 4000 terminal, or to copy a Series 4000 terminal to another
Series 4000 terminal:
2. Select the device to copy and click Copy. The New Device dialog box
appears.
3. Type a unique, six-digit device ID for the new device and click OK. The
Device dialog box appears. The General tab displays the parameters for the
device being copied.
4. If you are copying a Series 400 device, select a target Series 400 device or a
Copying devices
5. Change the collection method, the device name, and its description, if you
want.
6. Change the IP address or telephone number for the device. (Mandatory)
7. If you are copying to a Series 4000 terminal, select the Protocol.
8. If appropriate, change the time zone and specify the configuration options, the
download options, and the application options. For more information about
configuration options, see “Configuring Devices” on page 137. For more
information about the download options, click Help in the Download Options
dialog box, or see “Events and download options” on page 250. For more
information about the application options, click Help in the Application
Options dialog box.
9. When you finish making changes, click OK.
appears.
You can assign the updated device to a different device group. For information
about assigning devices, see “Device groups” on page 67.
Copy To function
You can copy a device to an existing device of the same model. Because the target
devices are already defined. The following configuration settings are not copied
when you use the Copy To function:
• Device ID and description
• Communication type (Ethernet, serial, or modem)
• IP address or telephone number
• Communications channel assignment
• Time zone and setting to automatically adjust time for daylight saving time
• Language
• Communication method and communication PC

• Collection method
• Collecting and assigning groups
Note the following important information about the Copy To process:
• The device ID, communication type, and the communication method for the
target device cannot be changed, and the communication channel assignment
must be the same as the communications type.
• If the device that you copy to is running a different version that you copy
from, some configuration settings for the target device may be lost. For
example, if you copy from a Series 4000 version 2.1 to a Series 4000 version
1.3, some function key settings may be lost on the target device.
• The Series 400 device supports three function key functions for displaying
information about the most recent punch that was performed by the employee.
These functions are:
– Display Last Punch: Displays the employee’s most recent punch.
– Display Elapsed Time: Displays the elapsed time since the employee’s
last punch.
– Display Status: Display the employee’s punch status (IN, OUT, etc.)
In the Series 4000 terminal, the functionality provided by these three separate
functions are combined into one function, View Punch Status. When an
employee performs the View Punch Status transaction at a Series 4000
terminal, the terminal displays all the following information:
– The last punch type, for example Punch, Labor Transfer, Start Work Rule
Transfer, and so on.
– The time and date of the last punch.
– The elapsed time since the last punch.
– For home employees, the current status of the employee (IN, OUT, etc.)
For a Series 400 device, you would need to configure three separate function
keys to provide all the supported functionality for viewing last punch
information. If this Series 400 device is ever converted by using DCM to a
Series 4000 terminal, each of the three function keys will be converted to the
Series 4000 View Punch Status transaction, since that one transaction contain'
the functionality of the three Series 400 device functions. After the
Copying devices
conversion, three Series 4000 soft keys are configured with the same
transaction.
To use the Device Manager to copy a device to another device of the same model:
2. Select the device to copy and click Copy To.
3. Select the device that is to receive the configuration and click OK.
appears.
You can assign the updated device to a different device group. For information
about assigning devices, see “Device groups” on page 67.

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
“Setting Up Labor Level Information” on page 181.
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.
Deleting a device by using the Device Manager

To use the Device Manager to delete a device:
Groups. The Assign Group devices dialog box appears.
Deleting devices
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.

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 selected 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 soft key at a Series 4000 terminal to enable a Manager to
display all bell schedules assigned to the device, to ring the bell, or to silence the
bell. For more information about bell schedules and soft keys, see “Soft Key tab”
on page 171.
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, click New and the bell schedule dialog box
appears.
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 #
The OK button becomes active when you enter the bell schedule name.
3. To enable the bell to ring for this bell schedule, select the Enable Bell check
box. This 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
Bell schedules
on Memorial Day the bells are shut off, clear the Enable Bell check box for
the Monday bell schedule and initialize each device 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 bell’s ring. Valid durations are from one to
nine seconds.
6. Select the days that the primary bell is to ring.
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 147. 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 device, you must initialize the device with the Device
Configuration Download option enabled in order for the changes to take effect at
the device.
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.
2. Select a bell schedule and click Edit, Copy, or Delete.
Note: A bell schedule cannot be deleted if it is assigned to one or more devices.

To delete the bell schedule, unassign the bell schedule from the device.

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.
• A gate open schedule defines a period of time for specified days of the week
during which the gate remains unlocked so that 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 manager-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. You may assign up to seven gate open schedules and seven gate
off schedules to a single Series 4000 terminal.
You can configure a Series 4000 terminal soft key to enable a manager to:
• Display all gate schedules assigned to the device by using the assigned View
Gate Times soft key
• Open a gate for a length of time by using the assigned Gate Override -
Duration soft key
• Open a gate for an employee by using the assigned Gate Override -
Employees soft key
For more information about assigning a soft key, see “Soft Key tab” on page 171.
In addition to gate open and off schedules, you can configure the following gate
related functions at Series 4000 terminals:
• 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
Gate schedules
are accept any valid employee badge format, which includes home and
non-home employees, and accept home employee badges only, in which
case only managers can open the gate for non-home employees.
• For Manager transactions, either of the following transactions opens the gate
and does so without validation:
– Open gate for individual employee by using the assigned Gate Override -
Employee soft key
– Open gate for specified length of time by using the assigned Gate
Override - Duration soft key
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 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.
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 ;
The OK button becomes active when you enter the gate schedule name.
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 each device with the
Device Configuration Download Option enabled prior to Memorial Day.
5. Specify the time of day that the gate schedule starts. Specify the time in 24-
hour 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.
To assign one or more gate schedules to a specific Series 4000 terminal, see “Gate
Schedules tab” on page 161. 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
Note: A gate schedule cannot be deleted if it is assigned to one or more devices.

To delete the gate schedule, unassign the gate schedule from the device.
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.

Soft key schedules
Soft key schedules

A soft key schedule specifies the time range that employees can perform a
transaction on a Series 4000 terminal. For example, you can prevent employees
from performing a View Timecard transaction during busy shift changes when it is
important that employees punch in or out quickly to reduce the time that other
employees need to wait before they can punch in or out. You can use a soft key
schedule to allow employees to view their time cards only during breaks or other
acceptable times.
You can configure a Series 4000 terminal soft key to enable employees to display
transactions assigned to the device. For more information about assigning a soft
key, see “Soft Key tab” on page 171.
Creating a new soft key schedule

To create a soft key schedule:
1. From the Device Manager, select Setup > Soft Key Schedules to specify
active time periods. The Soft Key Schedules dialog box appears.
If no soft key schedules were created, the Soft Key Schedule dialog box
appears, where you can create a soft key schedule.
If soft key schedules were created, the Soft Key Schedules dialog box
appears.
2. Click New. The Soft Key Schedule dialog box appears.
3. Enter the name of the schedule in the Schedule Name text box. A soft key
schedule is a schedule of time periods (up to 8) in which employees are
allowed to view transactions. This soft key schedule specifies when
employees can perform a transaction, such as Allow During Breaks or
Disallow During Shift Change.
4. Kronos recommends that the Enable Schedule check box remain selected.
Clear it when it is necessary for testing purposes.
5. Click Add. The Soft Key Schedule - Active Time Period dialog box appears.
6. Specify the start time, the end time, and the days of the week that the
transaction is to be active.

7. To add another time period to this soft key schedule, click Add and repeat
step 6. For example, you can create a soft key schedule called Breaks and
specify a time period in the morning and a time period in the afternoon for the
same soft key schedule.
8. When finished specifying the soft key schedule, click OK. The Soft Key
Schedules dialog box appears. You can specify another schedule by repeating
step 2.
Editing a soft key schedule

To edit a soft key schedule:
2. Select the soft key schedule that you want to edit.
3. Click Edit. The Soft Key Schedule dialog box appears.
4. To change the soft key schedule name, edit the entry in the Schedule Name
text box and click OK.
5. To change the time specified, select the Active Time Period to be edited and
click Edit.
6. Change the times or the days and click OK.
7. Click OK.
Copying a soft key schedule

To copy a soft key schedule:
2. Select the soft key schedule that you want to copy and click Copy. The Soft
Key Schedule dialog box appears.
3. Enter a new schedule name in the Schedule Name text box
4. Click OK.

Soft key schedules
Assigning a soft key schedule to a soft key

After you add, edit, or copy a soft key schedule, assign the soft key schedule to a
soft key by using the Soft Key tab. See “Soft Key tab” on page 171.
When you download the Device Configuration, all soft key assignments are sent
to the device.
Deleting a soft key schedule

To delete a soft key schedule:
1. From the Device Manager, select Setup > Soft Key Schedules from the
Device Manager. The Soft Key Schedules dialog box appears.
2. Select the soft key schedule that you want to delete.
3. Click Delete.

Proximity badge formats

You can import one or more proximity badge formats from a proximity format file
to assign to the Series 4000 terminals with proximity badge readers that are
included in the DCM system.
Proximity badge files that contain the proximity formats for the company's
Proximity badges are typically provided by the Kronos Representative. If you are
using standard Kronos-supplied (ADFP) standard format proximity badges, you
do not need to import a format. You may instead use the existing format named
Standard 2601 format. When you assign this format to the Series 4000 device, it is
named 2601 and 31-bit standard formats.
To import a proximity badge format:
1. From the Device Manager, select Setup > Proximity Reader Formats. The
Manager Proximity Reader Formats dialog box appears.
2. Select the appropriate format and click Import. The Import Proximity Format
File dialog box appears.
3. Navigate to a directory that contains the appropriate proximity badge file,
select the file (for example, filename.XML), and click Open. The Device
Manager opens the file and imports the format definitions.
After you import badge formats, you can assign them to a Series 4000 terminal by
using the DCM Configuration Badge Reader tab. For more information about the
Badge Reader tab, see “Badge Reader tab” on page 142.
Note: A proximity format cannot be deleted if it is assigned to one or more

devices. To delete the proximity format, unassign the format from the device.
To delete a proximity badge format:

1. From the Device Manager, select Setup > Proximity Reader Formats. The
Manager Proximity Reader Formats dialog box appears.
2. Select the appropriate format and click Delete.
You cannot permanently delete the Kronos standard 2601 format.

Smart View transactions

A Series 4000 terminal that uses Ethernet communication can provide Smart
View™ transactions. Smart View 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, Smart
View 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. For more information about transaction
records, see “Understanding and Accessing Punch/Transaction Data” on page
427.
All Smart View transactions are identified in the DCM Soft Key configuration tab
with the [Smart View] designation displayed following the transaction name.
Smart View transactions are sent to Series 4000 terminals as part of an initialize
that includes Device Configuration. If you add, edit, or delete Smart View
transactions or change which Smart View transactions are assigned to a particular
Series 4000 terminal, you must initialize the device with the Device Configuration
Download option enabled in order for the changes to take effect at the device.
Data Collection Manager provides one or more predefined Smart View
transactions. You may edit these Smart View transactions to change the Web
server or transaction name, but no other changes should be made. You cannot
delete predefined Smart View transactions. Click Delete to return the transactions
to their predefined Web server and transaction name.
The Workforce Central system provides the following Smart View transactions:
• Approve Timecard
• Read Messages
• Request Time Off
• Schedule Override
• View Accruals Online
• View Schedules Online
• View Timecard Online
• View Totals Online

Workforce Central applications including the Workforce Timekeeper application

and Workforce Activities provide Smart View transactions that are available after
installation, and may add additional Smart View transactions based on user
actions. These Smart View transactions are displayed in the DCM configuration
Soft Key tab to allow assignment to specific Series 4000 terminals. They may or
may not be available for editing in the Smart View dialog box as explained in the
following sections.
Note: The Schedule Override Smart View transaction is not supported if the
Smart View application server is a Unix server. The Smart View application server
must be a Windows server to support the Schedule Override Smart View
transaction.
Multi-language Smart View transactions

Each Smart View definition contains a single URL. When a Smart View
transaction is executed on the device, the language is determined by the host
application instance that is specified in the URL. Smart View definitions cannot
be shared across devices that are set to display different languages.
The following Smart View transaction support multiple languages:
• Approve Timecard
• Schedule Override
• View Accruals Online
• View Timecard Online
• View Totals Online
Use one of the following procedures to configure Smart View transactions when
managing devices that display in different languages:
• Use a separate DCM communication PC for each device language that is
required. Group all devices for a given language together on a single DCM
communication PC.
• If you use a single DCM communication PC to manage all the devices,

a. Make a copy of each default Smart View definition for each device
language that must be supported.
b. Modify the copy to refer to the appropriate application instance, and
configure the correct Smart View definition for a device based on its
target language.
Note: DCM does not filter the list of choices for Smart View transactions based
on the device’s language during device configuration. All Smart View definitions
are available to all devices. Ensure that you name the new Smart View definitions
appropriately, using the intended target language in the name, because this makes
it easier to select the correct definition when configuring a device.
Creating a Smart View transaction

To create a Smart View transaction definition:
1. From the Device Manager main menu, select Setup > Smart Views.
If no Smart View transactions were created previously, the Smart View dialog
box appears.
If Smart View transactions were created, the Smart Views dialog box appears.
Click New. The Smart View dialog box appears.
2. Enter the Smart View name.
The Smart View name is a user-defined name that DCM can include in the
available functions list for soft key assignments.
The maximum number of valid characters is 50. Do not use the following
characters: \, /, *, ‘, “, ?, <, >, :, ;, and #. DCM lists the Smart View transaction
name in the device configuration options user interface for soft key functions
assignment with [Smart View] appended to the name, such as Begin Activity
[Smart View].
3. Enter the Smart View code.
The Smart View code is a unique name for the Smart View transaction, such
as VCH. Usually the code name is three characters. The maximum is 5
characters. The Smart View code name is unavailable when you edit the
Smart View name.

4. Enter the Smart View URL.

Enter the URL of the Web server that will execute the Smart View transaction.
For example, http://MYSERVER/viewcorporateholiday.jsp.
The setting is global.
Enter the URL in Web-permissible format, beginning with either http:// or
https://. The maximum number of combined Smart View 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 Smart View transaction is assigned (refer
to the Series 4000 Terminal 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 Smart View 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 Smart View
transaction.
6. Specify the timeout in seconds that the transaction is to wait while invoking
the URL to the server. The minimum is 0 seconds. The maximum value is
1800 seconds. The default is 30 seconds.
7. If the employee is to swipe or enter the employee badge immediately after
selecting the Smart View soft key, select Prompt for Employee Badge so that
the Web server can look up employee-specific information before starting the
Smart View transaction.
8. Select Biometric Verification if all employees must verify their identification
by using the Kronos Touch ID finger scan identification device when they
select this Smart View transaction. This option is available if the Prompt for
Employee Badge check box is selected.
9. Click OK.

Smart View transactions in a Network Address Translation environment
If the target web server in a Smart View transaction URL is behind a firewall that
performs Network Address Translation (NAT), it may be necessary to perform
additional configuration. There are two scenarios to consider:
1. Series 4000 terminals are configured to support DNS and you are not using
any Workforce Activities Smart Views.
2. Series 4000 terminals are not configured to support DNS or you are using one
or more Workforce Activities Smart Views
Series 4000 terminals are configured to support DNS and you are not using
any Workforce Activities Smart Views
1. Configure the Firewall/NAT server to map an outside legal IP address to the

"inside" private IP address of the Workforce Central web server (by static
address mapping or port forwarding).
2. Configure Series 4000 terminals outside the firewall to point to DNS servers
that resolve the Workforce Central web server host name to the outside, legal
IP Address used by the Firewall/NAT server.
Series 4000 terminals are not configured to support DNS or you are using one
or more Workforce Activities Smart Views
1. Configure the Firewall/NAT server to map an outside legal IP address to the

inside private IP address of the Workforce Central application server (by static
address mapping or port forwarding).
2. For each 4500 device outside the firewall using NAT, add the following lines
to the krdcm.ini file:
alias_name=outside IP address on NAT server mapped to the internal DCM server IP
address
DeviceID=alias_name
where:
The DeviceID is the six-digit device identifier for each terminal outside the
internal-protected local area network that DCM must communicate with. Add
each device identifier on a different line and set equal to the alias_name.

Entries are not required for devices that communicate with DCM on the inside
internal-protected local area network.
The alias_name can be any text other than the DCM server's
HOSTNAME.
NAT=158.228.65.187
111111=NAT
http://158.228.65.140/wfc/URLDispatcherServlet=http://158.228.65.214/wfc/
URLDispatcherServlet
Editing a Smart View transaction

To edit a Smart View transaction:
1. From the Device Manager main menu, select Setup > Smart Views. The
Smart View dialog box appears.
Note: Any edits you make for a Smart View transaction is global. Changes
affect all DCM installations that use the same database server. Changes also
impact any Series 4000 terminals to which that Smart View transaction is
assigned the next time that device is Initialized with the Device Configuration
Download option enabled.
2. Select the appropriate Smart View transaction and click Edit.

3. Edit any of the text boxes except the Transaction Code and click OK.
To edit Workforce Central Smart View transaction definitions, see “Making
changes to Smart View transaction definitions” on page 112.
Copying a Smart View transaction

To copy a Smart View transaction:
2. Select the appropriate Smart View transaction and click Copy.

3. Enter the new Smart View name and its Smart View Code.
4. 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 Smart View
transaction.
5. Specify the timeout in seconds that the transaction 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.
6. If the employee is to swipe or enter the employee badge before selecting the
Smart View soft key, select the Prompt for Employee Badge check box.
7. Click OK.
Deleting a Smart View transaction

To delete a user-defined Smart View transaction:
2. Select the appropriate Smart View transaction and click Delete.
Note: You can not delete Smart View Transactions that were predefined by
Workforce Timekeeper, Workforce Activities, or other Workforce Timekeeper
applications. If you click Delete when a predefined transaction is selected,
DCM prompts you to return the transaction to its default configuration. If you
click Yes, any edits that were made to this transaction are lost and is returned
to its default configuration. If you click No, no changes are made.
Assigning a Smart View transaction to a soft key

After you add, edit, or copy a Smart View transaction, assign the Smart View
transaction to a soft key by using the Soft Key tab, see “Soft Key tab” on page
171.

The Soft Key tab’s Assign Soft Key dialog box contains both local and Smart
View transactions.When you download the Device Configuration, all soft key
assignments are sent to the device.
Making changes to Smart View transaction definitions

DCM 6.0 includes several pre-defined Smart View transactions for use with the
Workforce Central 6.0 product suite. The URL and parameter settings for these
Smart View transactions cannot be edited.
To make changes to these settings, you must make a copy of the Smart View
transaction and edit the copy. Use the following procedure to copy and change the
URL or parameters settings for a Workforce Timekeeper Smart View transaction:
1. From Device Manager, select Setup > Smart Views, select the Smart View
that you want to change, and click Copy.
2. Enter a unique Name and Code for the new transaction.
3. Make the appropriate modifications to the URL or URL Parameters or both,
and Click OK.
4. Assign the newly created transaction to the appropriate Series 4000 devices.
From Device Manager, select Device > Configuration and select the Soft
Key tab.
The following list describes some reasons to make changes to these settings:
• You may want to change the URL of a Smart View transaction if you do not
want the Smart View transaction at the Series 4000 device to use the same
Web server that DCM uses to communicate with Workforce Central. To do
this, enter the host name or IP address in the appropriate location of the URL
field. For example, you could change the URL from
http://wfcserver1.MYCOMPANY.COM/kronos/URLDispatcherServlet
to
http://wfcserver2.MYCOMPANY.COM/kronos/URLDispatcherServlet.

• You may want to change the URL Parameter for the Request For Time Off
Smart View transaction if you want to use a specific Process Manager
template. For example, you could change the URL parameter from
&url=/applications/m8m/
html4500RequestController.jsp&filename=TimeOff&
to
&url=/applications/m8m/html/
4500RequestController.jsp&filename=TimeOff
&templateName=TimeOffRequest_4500AddVacation.template&
to specify a template used solely for vacation requests.
• You may want to change the number of shifts displayed for the Supervisor
Override Smart View transaction from the default value of 3 to a maximum of
14. For example, you could change the URL parameter from
&url=/applications/m8m/html/4500RequestController.jsp&filename=
OverrideSchedules&schedules=3&
to
&url=/applications/m8m/html/4500RequestController.jsp&filename=
OverrideSchedules&schedules=14&.

System Settings
You can specify DCM system settings for the following DCM properties:
• General settings for transaction output files, 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
• The Workforce Central system connection to a Workforce Activities
application server or additional Workforce Timekeeper application servers
when DCM is installed for the Workforce Timekeeper application
All the System Settings, with the exception of those on the Global Values tab,
apply only to the DCM communication PC on which Device Manager is running.
To make changes to system settings other than Global Values, you must run
Device Manager on each DCM communication PC and make the appropriate
System Settings changes. Changes to settings on the Global Values tab affect the
operation of all DCM communication 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
and, if they are running, Communication Monitor and Event Manager. You can
disable and enable Sentinel Service from the Sentinel Service tray icon.

System Settings
To specify the system settings, from the Device Manager, select Setup > System
Settings. The System Settings dialog box appears.
Note: Click OK only after you are finished configuring all tabs that are to be
changed.

General settings
To specify the general system settings:
1. From the Device Manager, select Setup > System Settings. The System
Settings dialog box appears.
2. Click the General tab.
3. Specify transaction output file rollover size, in KB. This is the file size that will
trigger a rollover. The minimum supported value is 0. The default value 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 rollover size, 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.out as a transaction output file and
Group1_0725200253102.out as a rollover file:
trx\
Group1.out 300K
Group1_0725200253102.out 503K
4. To specify that the Device Manager displays 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.

General settings
5. 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.
6. To maintain an active connection to the database if the database has an idle
time disconnect feature, set the Database keep alive interval to a value in
minutes. For example, if you are using an Oracle database, specify a value
that exceeds the SQLNET EXPIRE TIME setting of the Oracle database
server. Batch collect events and DCM communication channels then are not
interrupted.

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:
• ERROR—The ERROR message reports a serious discrepancy within DCM.
System stability or data integrity may be compromised.
• WARNING—The 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.
• INFO—The INFO message reports a normal DCM operation.
• DEBUG—For internal use only.
DEBUG is the highest logging level and includes all levels. Enabling this setting
may significantly reduce DCM performance, and you should enable it only if
directed to do so by the 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, which 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.

Log File settings
3. Specify the log file rollover size, in KB. This is the file size that will trigger a
rollover. The minimum supported value is 500. The default value 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 approaches the maximum size, the existing file is renamed to
the next available slot in the file names. For example, logname.log
becomes logname_1.log. The new log becomes logname.log. When
the new log file reaches the rollover 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.
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 300K
DCM_1.log 502K
DCM_2.log 501K
DCM_3.log 502K
DCM_4.log 502K
DCM_5.log 500k
DCM_6.log 500k
DCM_7.log 501K
DCM_8.log 502K
DCM_9.log 500K
DCM_10.log 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; enabling 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
drop-down menus. The default is INFO, which is the recommended setting
for all.

Device Download settings
Device Download settings

To specify the device download settings:
2. Click the Device Download tab.
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.
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
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 “Communication Channels” on page 37.
To specify the communication settings:
2. Click the Communication tab.
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 Window XP, DCM uses the following path:
\Documents and Settings\All Users\Application
It is possible for PCs to have multiple RAS phone books. You can locate the
phone book by making an entry (see “About dial-up networking” on page 47)
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 2003 communication PC, DCM uses the default path:
X:\Documents and Settings\All Users\Application

Communication settings
On one machine however, the RAS System phone book is located in:
X:\WINNT\system32\ras\rasphone.pbk
4. If the 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.
5. The Collection Agent uses two listens ports for its HTTP communications.
Port1 8888 and Port2 8889 are the default ports. Port1 is used for FIFO
collection as well as transaction file processing. All remaining DCM HTTP
communications use Port2. Only change the port numbers if you are required
to do so; for example, another application is using the default ports.
If you use IIS and change the Collection Agent 8888 and 8889 ports in Device
Manager, IIS is automatically updated. Stop and restart the Sentinel after you
make the changes.
If you use Apache and change the Collection Agent 8888 and 8889 ports in
Device Manager, Apache is not automatically updated. You must stop and
restart Apache after you make the changes. Also, stop and restart the Sentinel
after you restart Apache.
Note: In a secure installation, the Web server uses a DCM proxy to forward
requests to the DCM Collection Agent.
6. If DCM is running in a secure installation, the Web Servers Settings is

included on the Communication tab. The Web Server Setting uses default port
80 for HTTP and default port 443 for HTTPS. The DCM Web server settings
default to the same values.
If the Web server listen port setting must be changed, first edit the IIS or
Apache Web server setting, and then update the DCM Web setting on the
Communication tab. Stop and restart Sentinel after you make the changes.
Also stop and restart IIS or Apache.

Configuring the ports used by the Apache web server

To configure an Apache port, edit the
c:\kronos\apache\conf\httpd.conf and ssl.conf files to
change the listen lines to specify the correct HTTP and SSL ports to use.
Restart Apache.
If you change the TCP (HTTP) and SSL ports used by the Web server, a
message appears telling you that you need to manually configure the web
server and restart the Web server.
The Apache proxy components are unaffected when the Web server’s TCP
(HTTP) and SSL ports are changed.
Configuring the ports used by the IIS Web server on Windows 2003
or Windows XP Professional
To configure an IIS port on Windows 2003 Server or Windows XP Professional,
access the Internet Information Services control panel by selecting Start >
Administrative Tools > Internet Information Services (IIS) Manager. In the
tree view in the left pane of the window, select Internet Information Services >
name of the computer > Web Sites > Default Web Site. Right-click, select
Properties, and on the Web Site tab, specify the new TCP Port and SSL Port
values. Restart IIS.
The IIS proxy components are unaffected when the Web server’s TCP (HTTP)
and SSL ports are changed.

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 communication PCs, regardless of
which DCM communication PC is running Device Manager when the changes are
made.
File-based communication requests

Certain DCM device communication functions require access to files that were
created externally from DCM, or requires DCM 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:
• Load Firmware—Firmware is the software that resides in a device. For more
information about loading device firmware, see “Upgrading Series 4000
Terminals” on page 280.
• Load Parameter File—You 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 294.
• Extract Device Parameters—The 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 the 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 296.
• Get Device Report—A device report lists a Series 4000 terminal’s hardware
properties. For more information about device reports, see “Series 4000
terminal and configuration reports” on page 302.

• Get Device Configuration—A device configuration report lists a Series 4000

terminal’s configuration data. To view device configuration, you need an
XML file that specifies the information to be retrieved. For more information
about device configuration reports, see “Retrieving Series 4000 terminal
configuration data” on page 303.
By default, DCM looks for or creates these files on the DCM communication PC
that is processing the communications request. If the installation has more than
one communication 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.
To specify the file-based request configuration, use the following steps:
2. Click the Global Values tab.
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. 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 shared. 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 network administrator must assign the appropriate access rights to
the user who logs onto the DCM communication PCs that initiate or process
the request.
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:
a. That location is used to copy Load Parameter File and Load Firmware file
requests.
b. 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.
Timeframe for totals and accruals

To specify when totals and accruals are compiled:
2. Click the Global Values tab.
3. Select 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 “Totals and Accruals” on page
195.

E-mail notification settings

You can specify that error notifications 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. When processing DCM events, information about failed events is sent in
e-mail notifications.
You can enable notifications for system errors, device errors, event errors, or all
three. You can 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 communication 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 sends its own e-mail notifications, and the PC's name is
included.
System error notification

System error notifications are sent in the following monitoring conditions:
• 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
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.

Device error notification

Device error notifications are sent in the following conditions:
• 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 device error notification messages includes the PC data and time of the
failure, the communication PC name, and a general message about the failure.
Event error notification

Event error notifications are sent in the following conditions:
• An event request could not be launched to a specific communication PC
• An event could not be processed by a specific communication PC
The event error notification is sent to recipients on the server where the failure
occurs. If a communication PC requests an event be run and the Sentinel Service
is not running, the event error notification is sent to the communication PC that
requested the event. If a communication PC requests an event be run on another
communication PC where the event processing fails, the event error notification is
sent by the communication PC that could not run the event.
The event error notification message includes the name of the PC where the event
failure occurred, the time that the Task Scheduler launched the event, the device
or group identification, and the error message.
E-mail notification specifications

To specify e-mail notification:
2. Click the E-mail tab.
3. Select the Enable E-mail Notification check box to enable notification.

4. Enter the URL for the Simple Mail Transfer Protocol (SMTP) server. SMTP
protocol is used to send e-mail messages between mail clients and mail
servers, such as 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,
using the semicolon as a separator character.
6. Specify the e-mail sender name that is to appear as the sender of the e-mail
notification.
7. Specify the time interval after which DCM checks for system and device 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 messages is five minutes
(00:05) and the maximum length of time to check for messages is twenty-four
hours (24:00). The default is 1 hour. Each time DCM checks for error
conditions, it sends notification if the errors exist, even if the error existed the
last time DCM sent an error notification. For this reason, you should set the
notification interval so that the recipients are not sent notifications faster than
they can respond to them, but often enough that errors are detected and
corrected quickly.
Note: The time interval does not apply to event error notifications, which are
sent when the event completes.
8. To specify the type of e-mail notification to be sent, select System error

notification, Device error notification, or Event error notification. You
can select all three.
9. To test the 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.

Server Connection settings

The application server instance that was named during the initial configuration
connects DCM to the that application server instance and is used for
authentication. DCM supports connections to multiple WFC application server
instances in a single-database environment. You can define additional server
connections to improve data processing performance.
Multiple connections are helpful at times of peak loads of data transactions if the
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.
You can define:
• Multiple connections to one application server instance—If you have one
powerful server running the application server instance and are processing
thousands of punches in collect events, you can somewhat increase the
throughput from the DCM client PC to the application server instance.
• Multiple connections to multiple application server instances—This is the
most efficient method.
Both methods are limited by the throughput capacity of the database.
When configuring host names or application instances, use the following
formatting rules:
• The maximum number of alphanumeric characters for the host name is 301
(250 for the host name, 1 for the semicolon, and 50 for the port number).
Spaces are not allowed. The host name is not case-sensitive. The semicolon
and port number are optional and are used only together only for configuring
to application server.
• The maximum number of alphanumeric characters for the application instance
is 50. The application instance name is case-sensitive. The first character can
be a forward slash (/). Spaces are not allowed.

To define multiple server connections:

2. Click the Server Connections tab.
Default application server connections

The default connection to the application server instance defaults to the
application server instance to which the communication PC is connected.
To specify or change the default application server instance:
1. From the Device Manager main window, select Setup > System Settings and
click the Server Connections tab.
2. In the Default connection to Application Server area, click Edit. The
Application Server dialog box appears.
The current host name and application instance is listed in the Current
Selection area.
3. Select one of the other available configurations and click Select.
The Current Selection area is updated.
4. Click OK.
Default activities server connections

If the Workforce Central installation includes Workforce Activities, the Default
connection to the activities server defaults to the application server to which the
communication PC is connected. You can change the default activities server
connection.
To change the default application server connection to the communication PC:
2. In the Default connection to Application server and click Edit. The

Selection area.
The Current Selection area is updated.
4. Click OK.
Additional server connections for transaction processing

You can have up to three connections to an application server.
Note: Multiple connections are available only when bulk processing is enabled in
DCM.
Adding additional application server connections
To add additional application server connections to the communication PC:

2. In the Additional connections to Application Server(s) for transaction
processing area, click Add. The Application Server dialog box appears.
3. In the Current Selections area, enter host name. For example,
WFC_WebServer.
4. Enter an application instance. For example, WFC_WebServer1.
5. Select https or http as the protocol type for the default connection to the
Activities server.
used by the application server and be consistent with other protocol selections
made for that server.
6. Click OK.
7. To add another activities server connection, click Add again.

Editing additional server connections
To edit an additional application server:

processing area, select the server to be edited and click Edit. The Application
Server dialog box appears.
3. In the Current Selection area, edit the host name or the application instance or
both.
4. Select https or http as the protocol type for the default connection to the
Activities server.
used by the application server and be consistent with other protocol selections
made for that server.
5. Click OK.
Deleting an additional server
To delete an additional application server:

processing area, select the server to be deleted and click Delete.
3. Click OK.
Default biometric server connections
The biometric server connection specifies the Workforce Central application

server that is used to provide biometric templates for non-home employees and
Smart View transaction biometric verification. This application server must have
Kronos Touch ID administration software installed.

To change the default biometric server connection to the communication PC:

2. In the Default connection to Biometric Server area, click Edit. The
Selection area.
The Current Selection area is updated.Click OK.
What to do 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 “Configuring Devices” on page 137.

Chapter 5
Configuring Devices
This chapter explains how to configure devices. It also includes information about
testing and viewing the device configuration.
• “Configuring device parameters” on page 138
• “Loading basic configuration parameters to a device” on page 177
• “Viewing and enabling devices” on page 180
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 with “AFT commands tab”
on page 141. The tabs are described in alphabetical order.
The tabs that are available are determined by the device that you select. For
example, when you configure a Series 4000 terminal, no AFT tab is available.
To access the Configuration Options, use the Device Manager. 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.)
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 76.
On each Configuration Options tab, you can:
• 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.
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 “Collecting Data and Managing Transactions” on page 221.

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.
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.
Kronos recommends 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 or punch 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 or 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.
Series 4000 terminals retain all employee information during all initialization,
unless you select the Clear All Employee Information Load in the Load
Configuration option is selected. Clear All Employee Information does not delete
employee punches from Series 4000 terminals.
Note: If you select Clear All Employee Information, employees who have
punched in may not be able to punch out.
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.
If the Retry pending message appears, you can track the progress and the success
or failure of initialization retry attempts from the Communications Monitor or the
DCM.log file.
For more information about initializing a configuration, see “Loading basic

configuration parameters to a device” on page 177.
Update
An initialized device should be updated regularly to reflect changes made at the
host application, which must be current at the device. The Update command sends
information that has changed since the last update, 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
existing information from the DCM or the host application database. Update does
not load device configurations.
Caution: Series 400 serial devices cannot complete an update that contains non-
English 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, the biometric data may or may not be deleted from the device when a
device update is performed. Also, Employee badge data may not be updated
immediately when a device update is performed.
AFT commands tab

Use the AFT Commands tab to enter one or more AFT commands that are not
available on 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 device’s keypad commands to enter values for device
procedures on this tab.
Caution: This tab enables you to enter potentially risky commands; for example,
setting time and date, or deleting FIFO records.
The AFT Commands entry is freeform—there 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 Series 400 Terminal
Configuration Guide.

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, specify bar code, magnetic card reader, or
proximity card parameters. You can also enter a location code, which is encoded
on standard employee and supervisor badges only.
The features that are visible and enabled are specific to the device that you are
configuring.
Reader configuration
Each device has only one type of badge reader. Configure the device to use one of
the following types:
• Bar code
If you are configuring a bar code reader, click Bar code symbologies and
select which symbologies to accept for all 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.
Bar code symbology is a bar code label that is formatted according to a
standard set of specifications. Some of these symbologies are familiar because
they are found on the packaging of consumer products. Encoding a badge
with a bar code label ensures that different devices can read the same badge.
A device with a bar code reader accepts badges that are encoded with bar code
symbologies for employee punches and labor transfers. You can also attach
external devices, such as lasers and CCD scanners, for reading bar code
symbologies.
• Magnetic stripe
If you are configuring a magnetic stripe reader, click Magnetic stripe tracks
and select which track to accept.
Series 4000 terminals can use a magnetic badge (card) reader instead of a bar
code reader or a proximity badge reader. A device with a magnetic badge
reader accepts badges with a magnetic strip that encodes employee

information for employee punches and labor transfers. The standard and
generic badge formats used for magnetic badges are the same as the standard
and generic formats used for a bar code reader.
• Proximity
Series 4000 terminals can use a magnetic badge (card) reader instead of a bar
code reader or a magnetic stripe badge reader.If you are configuring a
proximity reader, click Proximity formats and specify the proximity badge
format configuration. Click Assign to assign the selected proximity format to
a device, or click Unassign to unassign the selected proximity format from a
device.
If the proximity format that you need is not in the Proximity formats list, you
can import the format by selecting Device Manager > Setup > Proximity
Reader Formats. For more information about importing proximity formats,
see “Proximity badge formats” on page 104.
A device with a proximity badge reader accepts badge transactions that
involve a no-contact read of the badge. That is, the badge is held near the
device, but does not come in contact with it.
If you are configuring a proximity badge:
– The Series 4000 terminal can accept up to five Proximity Badge formats.
One of these formats is always the 2601 standard format that is used for
supervisor and maintenance proximity badges. The total number of user-
defined proximity badge formats that can be accepted by the device
depends on whether or not you assign the 2601 and 31-bit standard
formats for employee badges.
If you assign the 2601 and 31-bit standard formats to the Series 4000
device, you can assign up to two user-defined proximity badge formats. If
more than two user-defined formats are assigned to a device, only the first
two are downloaded to the device at the time of device initialization.
If you do not assign the 2601 and 31-bit standard formats to the Series
4000 device, you can assign up to four user-defined proximity badge
formats. If more than four user-defined formats are assigned to a device,
only the first four 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, manager, or maintenance badges.
Note: If the 2601 and 31- bit standard proximity badge formats are not
assigned, you can assign up to four user-defined proximity badge formats to
the device. If the 2601 and 31- bit standard proximity badge formats are
assigned, you can assign up to two user-defined proximity badge formats to
the device.
External proximity reader
Series 400 devices support external proximity readers as local readers only. You
cannot configure a Series 400 device external proximity reader as a remote reader.
Series 4000 terminals version 2.1 or later support the use of an external proximity
reader that can be used either as a remote reader or as a local reader. Configure an
external proximity reader as a remote reader when it is mounted remotely from the
Series 4000 terminal where users cannot see the Series 4000 terminal display nor
use its keypad—for example, at a doorway for a simple gate entry. Configure an
external proximity reader as a local reader if it is mounted next to the Series 4000
terminal and is used to perform functions that require the user to see the display or
use the keypad.
• When configured as a Remote reader, the external proximity reader performs
only the transactions assigned to the Remote Reader in the Device >
Configuration > Default Transactions tab. The external proximity reader
does not interact with the Series 4000 terminal's display, indicator lights,
keypad, or beeper. Only functions that do not require display or keypad input
can be performed at the external proximity reader when it is configured as a
remote reader.
• When configured as a Local reader, the external proximity reader performs
functions assigned to the Local reader in the Device > Configuration >
Default Transactions tab. It can also be used to provide badge input when it
performs transactions initiated by pressing soft keys at the Series 4000
terminal. The external proximity reader interacts with the Series 4000
terminal display, indicator lights, keypad, and beeper.

If a Series 4000 terminal is connected to a remote proximity reader that displays

data at the device, you can select Use as local reader. For more information about
using a remote proximity reader as a local proximity reader, see the Series 4000
Terminal User’s Guide.
Local reader display for a Series 400 device
If you are configuring a Series 400 device, you can:

• 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 reads using the megabeeper option.
• Select the Enable remote indicator check box if you want the device to
accept badge reads using the remote indicator lights option.
Employee badges
Specify the badge type, and if appropriate, the configuration for the standard
badges or both the standard and generic badges.
Select the badge type:
• 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.
Note: To allow use of the keypad to enter a badge ID, select the Allow keying
in Badge ID entries check box on the Punch Rules tab.
• 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
location 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 device to read
badges that differ from the standard badges.
If you specify generic badges, you must also configure 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. The reader ignores the last 2 characters, which it reads first, going from
right to left.
If you edit the generic badge format:
– 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 0 to 32 numeric characters. Do not specify a badge length of 17 or
18 numeric characters because these lengths are reserved for standard
badges.
– Specify the number of numeric characters in the data field, which
represents the ID number.
For generic employee badges, the data field is the employee identification
number. The device recognizes employee ID numbers in the range of 0 to 18
digits for Series 4000 terminals with v2.1 firmware, and 9 digits for all other
devices. Specify the location of the data field by defining the number of
trailing digits in a generic badge for the reader to ignore, starting from the
right, in the Characters to ignore text box. You can enter a value from 0 to 30.
For employee badges, the data field is the employee identification number.
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 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:
• Bar code, magnetic stripe, and proximity formats for all maintenance badges
• Bar code, magnetic stripe, and proximity formats for all manager badges
• Bar code and magnetic stripe formats for standard employee badges if
standard employee badges are enabled on the Badge Reader tab
• Bar code and magnetic stripe formats for generic employee badges if generic
employee badges are enabled on the Badge Reader tab
• Bar code and magnetic stripe formats for labor badges for standard or generic
labor badges if they are enabled on the Labor Transfer tab
• Bar code and magnetic stripe formats for standard or generic job badges if
they are enabled on the Job Transfer tab
• Proximity formats for employee badges for each proximity badge that is
defined and assigned on the Proximity Card Format Configuration dialog box
Proximity badges support only maintenance, manager, and employee badges.
They do not support labor or job badges.
Because maintenance and manager functions require access to the Series 4000
terminal’s keypad and display, remote readers do not accept maintenance or
manager badges.
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 96. You can also configure a soft key to
enable a Manager or Supervisor to display a bell schedule, ring a bell, or silence a
bell. For more information about assigning functions to device keys, see “Punch
Rules tab” on page 170.

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.

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.
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 badge
ID. Under specified conditions, the default transaction can perform a function
other than punch an employee in or out You can assign the default transaction
used by home and by non-home 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 read or badge ID 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 start-of-shift badge read to Job Transfer.
In addition to defining different default transactions for home and non-home
employees, you can 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
terminal that called a remote reader.

Note: An attached reader such as a bar code 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 Soft Key tab,
see “Soft Key tab” on page 171.
The five default reader transactions are:
• Home employee default—Performs 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 badge read opens the gate without
clocking the employee in or out. You can assign any transaction that can be
assigned to a soft key.
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 Soft Key tab and home employees must use this soft key to
punch in or out.
• Home employee shift start—Performs 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 device 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 device 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 shift—Performs 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 end—Performs 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.
• Non-home employee default—Performs a specific transaction after a non-
home employees swipe a badge or enters their employee badge ID. 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 Soft 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 manager or 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.

If you are configuring a local reader home employee default or the local
reader non-home employee default for a Series 4000 version 2.1 or greater
device, the Enter a Punch First check box is available. Select the check box
if the selected transaction is a Smart View transaction or a transaction that
does not generate a punch.
For some selections, such as a Labor Transfer, you may enter more details by
clicking Detail. Detail 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

badge reads at the device 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.
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.
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.
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 employee’s name or badge ID. 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 Manager, Supervisor, or Maintenance mode without any activity
before the device returns to Employee mode. Valid values are 5 through 150,
in seconds and in increments of 5. 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 then
require additional time for the employee to read, and possibly to 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 a 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. From the Format drop-down list, select the day, month, and year order.
2. From the Delimiter drop-down list, select the character that is to be used to
separate the day, month, and year.
3. Select the 2-digit year or four-digit year format for the display.
To set the format for the time that appears on the device:
1. From the Delimiter drop-down list, select the character that is to be used to
separate the day, month, and year.
2. Select the 12-hour format or 24-hour format for the display. The 12-hour
format displays the hours and minutes and AM or PM. The 24-hour format
displays the hours and minutes.
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 to the device that you configure,
based on the options you selected.
Use the Employee tab to:
• Specify whether to display the employee’s name or badge ID when an
employee punches in or out.
• Specify whether to use punch interpretation rules or schedule shifts to
calculate an employee's next in-punch when an out-punch is omitted.
• 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. The default is 38.

For optimum performance, set the number of individual schedules and the
number of days ahead to the lowest values that will ensure that the needed
schedules are available at the terminal. For example, if all the employees
assigned to a device work one shift five days a week and need to view their
schedules for this week and next week, specify 10 individual schedules per
employee and 14 days for the Number of days to look for future schedules.
FIFO tab
FIFO (first-in, first-out) is the data storage buffer in the device’s 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 soft keys that are assigned employee and manager or supervisor functions
“look into the past” for data. Setting the FIFO scan interval properly helps to
avoid the 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 soft key functions “look into the past” for data.
Setting the FIFO scan interval properly helps to avoid the use of older, obsolete
data. Valid settings are 0 to 72 hours. The default setting is 12.
When configuring a Series 400 device, you can use the FIFO tab to set the
following options:
• Scan Interval for Reviewing Punches (in hours)—The scan interval defines
the number of hours that certain soft key functions “look into the past” for
data. Setting the FIFO scan interval properly helps to avoid the use of older,
obsolete data.
Valid settings are 0 to 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 8-
hour 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 employee’s shifts. Entering a value of 0 results in no offset of the
FIFO scan interval.
Valid settings are 0 to 7 hours. The default setting is 0.
Free FormXML tab

You can send XML files to specify additional Series 4000 terminal configurations
that are not available in the Device Manager.
Although you can use the Load Parameter File command and event to load XML
configuration commands, these commands 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 the device
configuration set in DCM Device Manager is sent, and they may overwrite some
device settings, depending on the 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 verb-
object 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 will cause the desired behavior of the Series 4000 terminal.
To add XML files to the DCM initialization process:

1. If no file names are listed, click 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 Add Before or Add After.
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.
Function Key Tab

A function key is a programmable button on a Series 400 device that allows
employees and supervisors to perform functions quickly. Each key has the
following settings:
• Unassigned.
• A function to a function key for use by all employees, including supervisors,
is assigned.
• A command to a function key for use by supervisors only is assigned.
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 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, such as 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
Note: If you configure a function key with a transaction that includes a pay code,
device work rule, comment code, or total, be sure to select the corresponding item
in the Download options and to 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 transaction.
To assign tasks to a Series 400 function key:

1. Expand the function key and highlight No function assigned, which is applied
to a function key that all employees use, or No supervisor command assigned,
which is applied to a function key that only supervisors can use.
Series 400 devices support up to 12 function key assignments.
2. Click Assign. The Assign Function window opens.
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 apply
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.

4. For some selections, such as Add Punch, you may need to enter more details
by clicking Detail. Detail dialog boxes vary according to the function. For
example, if you selected Start Work Rule Transfer, the Detail 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
select it or clear it. If one or more default values are assigned for which the
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 is cleared and unavailable.
When you finish, click OK.
After you click Details, the Function Key Settings that may appear are Device
Work Rules, Labor Levels, and Comment Codes. For more information about
device work rules and comments codes, see “Device Work Rules, Comment
Codes, and Pay Code Edits” on page 203. For more information about labor
levels, see “Setting Up Labor Level Information” on page 181. For more
information about totals definitions (pay codes or accrual codes), see “Totals
and Accruals” on page 195.
For more information about the Function Key tab and all available options,
press Help.
5. Click OK in the Assign Function dialog box.
6. For function key mapping, 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 you selected Labor Account Transfer in the No function assigned function
key assignment, selected Details, and specified the function key text, you can
select the Display function key text for labor transfers check box. This
causes the text that is assigned to a function key to appear when the employee
presses that function key.
8. 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 in-punches and out-
punches, but labor account transfers are still available.

9. You can select the Allow negative tips check box to enable employees to
enter negative decimal tips.
10. You can select the Enable tips shortcut keys check box to enable employees
to use the + (plus) and - (minus) keys to enter tips.
11. To add, delete, or edit totals for Totals configuration, click Configure Totals.
For more information about Totals, see “Totals and Accruals” on page 195.
Gate Entry tab

Use the Gate Entry tab to set up the device to manage employee entry. The device
can use an attached universal contact relay to electrically open an entry
mechanism, such as a door, turnstile, or swing gate.
You can configure the Series 4000 terminal to interpret a badge read or badge ID
entry as either of the following types of transactions:
• Entry and a simple in or out-punch transaction.
When an employee swipes a badge or enters a badge ID at the device or uses a
remote reader, the device generates the punch, triggers the door latch, and
unlocks the door. The punch can also be subject to schedule enforcement and
biometric verification at Kronos Touch ID devices.
• Entry only with no punch transaction.
When an employee selects a Gate Entry soft key and then swipes a badge or
enters a badge ID at the device or a remote reader, the device triggers the door
latch and unlocks the door. The Series 4000 terminal does not interpret this as
a punch. For more information about assigning a soft key to a function, see
“Soft Key tab” on page 171.
Managers and supervisors can unlock the door for individual employees without
generating a time and attendance punch, and they can unlock the door for a
specified length of time, whenever necessary. Managers and supervisors perform
these functions at the device with the terminal in Manager mode or Supervisor
mode.

both.
To specify a gate entry setting in response to a badge read of a valid employee

badge on a Series 4000 terminal:
1. If the device supports gate entry, enable gate support by selecting the Enable
gate support check box.
2. Specify the Gate passback interval. This is the number of minutes after a
swipe that the device accepts another swipe from the same badge without
executing two punches. It is useful when 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 a
second punch execution, specify a value 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. In the Gate open duration text box, specify in seconds the length of time that a
gate can remain open after access is given and before being considered a
break in security. Allow enough time for employees to swipe their badges 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, select Employee badge format, which accepts any badge
format, or Home employees only, which accepts home-employee badges only.
5. If a soft key is assigned for Gate Entry, you can enable the device to store gate
entry punch transaction records by selecting or clearing any of the following
options:
– Select Entry to store a record that contains the badge IDs of employees
who are granted entry.
– Select Violation to store a record that contains the badge ID of an
employee who is not granted entry.
– Select Override to store a record that contains the badge ID of an
employee who are granted access as the result of a manager or supervisor
override.

Note: The Workforce Timekeeper application does not support the Gate Entry
records and discards the records if they are stored. DCM places selected Gate
Entry records in a transaction output file. For more information about transaction
output files, see “Transaction output files” on page 263 and “Setting up a
transaction output file for a device group” on page 233.
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 98.
You may assign up to seven gate open schedules and seven gate off schedules to a
single Series 4000 terminal.
both.
To specify gate schedules for a Series 4000 terminal:

1. Select the Enable gate schedules check box if the device supports gate entry.
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.
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 the Workforce Timekeeper application and
downloads that data to the device. DCM also collects job transfer transactions
from the device and submits these transactions to the Workforce Timekeeper
application.
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
the Workforce Timekeeper application. 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 device are the
device job set and employee job sets. Any job transfer set that is defined in the
Workforce Timekeeper application may be selected to be the device job set, using
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
the Workforce Timekeeper application. 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 one
or more 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
device 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 device,
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.
Specifying job transfer settings

When a Series 4000 terminal soft 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 soft keys.
To specify job transfer settings:
1. To use badges to enter job values, select 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, select Allow a non-home employees to enable employees to
perform job transfers at the device.
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 non-
home employee job transfers.
3. Select 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. Select Allow keypad entries to allow employees to use the keypad when
entering a job value at the device, 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 device when home employees
perform job transfers. Select Employee job transfer set to restrict home
employee transfer to jobs that are contained in their employee job transfer sets.
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 transfers to jobs
in the device job set.

If you selected Employee job transfer set, the job entered by a home employee
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 device.
Job transfer soft 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 soft
key to the device. Use the Soft Key tab to select a soft key, to assign job transfer to
the key, and to specify soft key settings in the Detail dialog box. For more
information about the soft key details, see “Soft Key tab” on page 171.
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 manager-initiated labor transfers 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 selecting labor level
options for a device, see “Configuring labor transfer settings” on page 187.
Note: 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 Soft Key tab to
enable ad hoc entries for a labor level. If Ad hoc is enabled, a labor level list is
downloaded only if the list is needed for validation of a transaction. The labor
level list is needed for validation when both of the following circumstances exist:
• The labor level is enabled in the Labor Options dialog
• At the terminal that allows the user to enter a value for the labor level, at least
one function is configured that does not allow ad hoc entries.

The ad hoc flag must be set first in the Access Profile and Labor Level
Maintenance options of the Workforce Timekeeper Setup Applications.
The labor level list is not sent for a given labor level if any of the following
conditions exist:
• The labor level is not enabled in the Applications Options dialog box or is not
included in the selected labor level set.
• A function is assigned to the device that prompts the user to enter labor level
data.
Note: If a Labor Transfer function is configured so that all enabled labor

levels are assigned with values that cannot be overridden, the user is not
prompted for labor level data.
• Every function that prompts for a labor level is configured to allow ad hoc
entries.
For a Series 4000 terminal version 2.0 or higher, this setting to allow ad hoc
entries includes the configuration of any default transactions that prompt for
labor levels.
For a Series 400 device, this setting to allow ad hoc entries also applies to the
configuration of a labor level for the # key and supervisor transfers that are
configured on the Labor Level tab of the Configuration Options dialog box.
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 and specify
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.
If you are configuring a Series 400 device, you can also specify whether or not to
perform a labor transfer as part of a punch. If a labor transfer is performed as part
of a punch, you can specify whether the transfer is optional or mandatory.

If you are configuring a Series 400 device, you can also specify whether or not to
accept leading zeros. If you use labor level values that contain leading zeros, for
example 000123, you may can configure a Series 400 device to not require the
user to enter the leading zeros. That is, if you configure the device to skip leading
zeros, the user can enter 123 for the labor level. In the device report, the value as
000123 and this is how it appears in Workforce Timekeeper.
You can configure a Series 400 device to skip leading zeros if labor level values
are numeric only, and if all the values in any given labor level contain the same
number of digits. The number of digits in each value must be the maximum length
that is specified in Workforce Timekeeper.
For example, if the maximum length of Labor Level 2 is set to 8 in Workforce
Timekeeper, the following values support skip leading zeros:
• 00000123
• 00012345
• 12345678
The following values do not support skip leading zeros:

• 123
• 12345
• 12345678
To configure a Series 400 terminal to skip leading zeros:

1. Select Device > Configuration > Labor Levels, clear the Allow
alphanumeric values check box, and click Apply.
2. Select Device > Configuration > Labor Transfer, check the Skip leading
zeros check box, and click Apply.
3. Initialize the device to resend Device Configuration and the Labor Level lists
to the device. The configuration settings affect how the Labor Level list
values are stored in the device. Changing these settings without resending the
Labor Level lists can result in unpredictable behavior.
For more information about configuring labor level transfers, see “Configuring
labor transfer settings” on page 187, or click Help.

Manager tab
Series 4000 version 2.1 devices have the following two options for identifying
users as managers and allowing them to enter Manager mode and perform
Manager mode functions:
• Identifying home employees as managers based on their badge IDs and their
license levels in Workforce Central. When configured to use managers’ badge
IDs, Series 4000 terminals generate an audit trail for Workforce Timekeeper
to identify which manager performed edits at the Series 4000 terminal. The
devices can also perform biometric verification prior to allowing entry into
Manager mode.
• Recognizing a specially formatted badge as a supervisor badge. When
configured to use supervisor badges, Series 4000 terminals cannot generate an
audit trail for Workforce Timekeeper and cannot perform biometric
verification prior to allowing entry into Manager mode.
Use the Manager tab to specify which way is used to identify a user as a manager
or an employee with a manager’s license. You can use only one way for a given
Series 4000 terminal. In addition, if the manager badge ID is used, use this tab to
configure how the Series 4000 terminal behaves when managers swipe their
badges.
Note: Series 400 devices and Series 4000 version 2.0 devices and earlier support
only the use of supervisor badges. These devices do not support the use of
manager badge IDs.
To prompt managers for a device work rule when they add, edit, or delete a
transaction, see “Soft Key tab” on page 171.

Supervisor badge use
If you select Use supervisor badge, Series 4000 users use an employee badge for
Employee mode functions and a supervisor badge to enter Manager mode. When
a user swipes a supervisor badge at the Series 4000 terminal, the Manager Log On
screen appears. The user must enter the Supervisor badge password to enter
Manager mode. The Manager mode password defaults to 00000 and can be reset
by using the Change Supervisor Badge Password function in Manager mode at the
Series 4000 terminal. This is not the password that can be configured in the
Manager tab. This password is used only if Use manager badge ID is selected.
Manager badge use

If you select Use manager badge ID, Series 4000 users may use their badges for
both Employee mode functions and to enter Manager mode. Two configuration
options exist to define what happens when a user swipes a badge at the Series
4000 terminal when the user is both a home employee at the device and is
designated as a Manager in Workforce Central:
• Log into Manager mode
When users who is also managers swipe their badges, the device displays the
Manager Log On screen. The only way that a manager can punch in or out at
the device is by having a soft key (in Employee or Manager mode) configured
with a Simple Punch transaction.
• Perform default employee transaction
When users, who are also managers, swipe their badges, the device performs
the Employee mode default transaction according to the configuration on the
Default Transactions tab. The only way that a manager can log on to Manager
mode is by having an Employee mode soft key configured with the Manager
Log On transaction.
If you select Use manager badge ID, managers who are biometrically enrolled are
required to verify prior to entering Manager mode. Employees who are not
biometrically enrolled are required to enter the manager badge password
configured for this device by using the Password setting on the Manager tab. This
password cannot be changed at the Series 4000 terminal.

Note: If you change from Supervisor mode to Manager mode and have the
Change Password transaction assigned to any soft key, you are prompted to
confirm the mode change. If you confirm the change, the assignment to the soft
key is removed. If you change from Manager mode to Supervisor mode and have
the Manager Log On transaction assigned to any soft key, you are prompted to
confirm the mode change. If you confirm the change, the assignment to the soft
key is removed.
Manager tab configuration

To enable only supervisors to perform Manager mode transactions at a Series
4000 terminal:
1. Select Use supervisor badge.
2. Select Allow manager to use keypad to enter employee ID to allow managers
to be able to type in employee badge IDs. This allows managers to perform
edits or overrides without an employee's badge.
To enable Workforce Managers who have Managers’ licenses to use their

employee badges to perform Manager mode transactions at a Series 4000
terminal:
1. Select Use manager badge ID.
2. From the After entering badge ID drop-down list, select one of the following
options:
– Log into manager mode—The manager can access Employee or
Supervisor mode only by pressing a soft key. If this option is selected and
managers need to punch, a soft key must be configured with a Simple
Punch.
– Perform default employee transaction— A manager badge read results
in the default transaction for an Employee, including a manager. If this
option is selected and managers need to access Manager mode at the
device, a soft key must be configured with a Manager Log On.
3. Enter the numeric password that the Manager is to use at the Series 4000
terminal. The password must be from 1 to 6 numeric characters. If you accept
the default, 000000, the user must enter 000000.

You can change the password after clicking OK, by clicking Restore, clicking
Use manager badge ID, resetting the After entering badge ID is necessary,
and entering the new numeric password.
4. Select Allow manager to use keypad to enter employee ID to allow

managers to be able to type in employee badge IDs. This allows managers to
perform edits or overrides without the employee's badge.
To prompt supervisors or managers for a device work rule when they add, edit, or
delete a transaction, see “Soft Key tab” on page 171.
Punch Rules tab
Use the Punch Rules tab to change the settings that control home employee and
non-home employee punching.
To specify the punch rules, you can:
• Set general functions.
For Series 400 terminals, the Validate badge type check box specifies that the
badge type that an employee uses for punching in and out is to be verified at
the terminal.
For all terminals, the Enable display punch status check box specifies that the
punch’s statuses to appear at the terminal.
For all Series 4000 v 2.1 or higher biometric terminals, the verification
threshold determines how closely the finger scan image for an employee
punching at the terminal must match the employee’s biometric template for
successful biometric verification. Possible settings are Normal, Low, and
None. The threshold that you select sets the threshold for each device. The
system looks at the higher of the employee biometric verification threshold or
the device biometric verification threshold.
• Set the repunch interval for home employees.
A repunch interval setting of zero for a Series 4000 terminal allows multiple
punches by the same employee in the same minute.

A repunch interval setting of zero for a Series 400 device does not allow a
repunch within the same minute. The interval before a repunch is allowed can
vary from 1 to 59 seconds, depending on the point within the minute that the
original punch was made.
• Instruct the device to accept punches from non-home employees, specify the
repunch interval, and enable biometric verification if appropriate.
A repunch interval setting of zero for a Series 4000 terminal allows multiple
punches by the same employee in the same minute.
A repunch interval setting of zero for a Series 400 device does not allow a
repunch within the same minute. The interval before a repunch is allowed can
vary from 1 to 59 seconds, depending on the point within the minute that the
original punch was made.
Select Enable biometric verification if non-home employees must verify their
identification by using the Kronos Touch ID finger scan identification device.
Note: Biometric verification for all transactions also must be enabled in the
Global Features section of the Soft Key tab so that non-home employee
biometric verification is active.
• Enable employees to enter their badge IDs at a Series 4000 terminal or by

using the * (asterisk) key and entering badge IDs at all other devices. When
you use a Series 4000 terminal, it is not necessary to use the * key before you
enter a badge ID.
• Enable employees to enter or mask their badge IDs, or both, at a Series 4000
terminal version 2.1 or higher during employee entry and device display.
For more information about the Punch Rules tab options, see the online Help.
Soft Key tab

Soft keys are used on Series 4000 terminals and function keys are used on Series
400 devices. A soft key or function key is a programmable button on a device that
allows employees and manager or supervisors to perform transactions quickly.
Each key has the following settings:

• Unassigned
• Assigning a function to a soft key for use by all employees, including
managers or supervisors
• Assigning a command to a soft key for use by managers or supervisors only
Use the Soft Key tab to assign tasks to the soft keys. Examples of soft key
assignments include canceling an automatic meal deduction, labor level transfer,
start and stop an activity, view totals, and enter tips. You can assign tasks to soft
keys for employee and manager or supervisor use, or only for manager or
supervisor use. The options that are available are determined by the model of the
selected device. For more information about the Function Key tab, see “Function
Key Tab” on page 156.
Manager soft key function
A manager soft key function is available only to users while the device operates in
Manager mode. After you assign a manager function to a soft key and download
device configuration to the device, a manager can perform the function by
entering Manager mode and pressing the associated soft key on the device.
Employee soft key function
An employee soft key function is available to users while the device operates in
Employee mode. After you assign an employee function to a soft key and
download device configuration to the device, a user can perform the function by
pressing the associated soft key on the device.
Note: If you configure a soft key with a transaction that includes a pay code,
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 transaction.
To assign transactions to a soft key:

1. Expand the soft key and highlight one of the following selections:

– No function assigned. This is applied to a soft key that all employees’ use,
– No manager command assigned or No supervisor command. This is
applied to a soft key assignment that only managers or supervisors can use.
Series 4000 terminals support up to 28 soft key assignments. All other devices
support up to 12 soft key assignments.
2. Click Assign. The Assign Function window opens.
3. Select the transaction that you want to assign to the soft key. Not all
transactions are applicable to the application in which the device is connected.
Some transactions enable you to define which actions can be performed at the
device.
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 Soft 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 work rule transfers, you may need to enter more
details by clicking Detail. Detail dialog boxes vary according to the function
selected. For example, if you selected Start Work Rule Transfer, the Detail
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 select it or clear it. If at least one default value with Allow override is
assigned, the Must prompt user for Labor Account check box is selected
and unavailable. If no usable labor levels has Allow override, you cannot
change any labor values, and the Must prompt user for Labor Account check
box is cleared and unavailable. When you finish, click OK.
Note: If you select Add Punch and click Detail, you can specify that
managers be prompted for a device work rule when they add a transaction on
a Series 4000 terminal.
After you click Detail, the Soft Key Settings that may appear are Device
Work Rules, Labor Levels, Job Transfers, and Comment Codes.
For more information about device work rules and comments codes, see
“Device Work Rules, Comment Codes, and Pay Code Edits” on page 203. For
more information about labor levels, see “Setting Up Labor Level
Information” on page 181. For more information about job transfers, see “Job

Transfer tab” on page 161. For more information about totals definitions (pay
codes or accrual codes), see “Totals and Accruals” on page 195.
5. Click OK in the Assign Function dialog box.
Note: The available functions 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 Move
Amount and Pay Code Hours Edit in Manager mode or Supervisor mode.
6. If it is available, you can select the Always require soft key press check box
to require employees to press a soft key before swiping their badges or
entering a badge IDs to initiate a transaction.
7. If it is available, you can select the Tips and soft keys only to enable
employees check box to perform tip and soft key entries only. When this
option is selected, the device does not accept simple punches, such as in-
punches and out-punches, but labor account transfers are still available.
8. You can select the Allow negative tips check box to enable employees to
enter negative decimal tips.
9. If it is available, you can select the Enable tips shortcut keys check box to
enable employees to use the + (plus) and - (minus) keys to enter tips.
10. Use the Enable biometric verification for all transactions check box to
specify which transactions require biometric verification at Series 4000
terminals with the Kronos Touch ID finger scan device. This check box is
available for Series 4000 terminals, version 2.1 and later.
If this option is selected, all Employee mode transactions, including those that
generate a punch record and those that are view-only and excluding Smart
View transactions, require biometric verification at the device.
If this option is not selected, transactions that generate a transaction record

require biometric verification. View-only transactions do not require an
employee to biometrically verify. The following transactions require
verification when this option is not selected:
– Cancel Meal Deduction
– Clear Activity Record
– Delayed Job Transfer

– Delayed Labor Transfer

– End Activity
– Enter Tips
– Gate Entry
– Job Transfer
– Labor Transfer.
– Manager Log On
– Pay Code Hours Edit
– Pay Code Money Edit
– Pay Code Transaction
– Punch
Note: After Manager mode is entered, biometric verification is not required

for any transaction, regardless of this setting. Also, Smart View transactions
are not effected by this setting. Each Smart View transaction may be
independently configured to enable or disable biometric verification in Setup
> Smart View Transactions.
For more information about verification for Smart View transactions, see
“Creating a Smart View transaction” on page 107.
11. To add, delete, or edit totals for Totals configuration, click Configure Totals.
For more information about Totals, see “Totals and Accruals” on page 195. For
more information about the Soft Key tab and all available options, click Help.
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.
Note: The Supervisor tab is for use with Series 400 devices and with Series 4000
terminals running firmware version 2.0 or lower. The Manager tab is available for
configuring Series 4000 terminals running firmware version 2.1 or higher.

For Series 4000 terminals, specify whether or not to allow supervisors to use the
keypad to enter an employee’s ID or badge ID.
For Series 400 devices, the supervisor tasks available on the Soft Key tab may
vary according to device that you are configuring. For example, some devices do
not use Guard mode.
You can specify the following configuration options:
• Allow supervisors to use the keypad to enter an employee’s badge ID. For
some devices, if this function is enabled, the supervisor must press the
asterisk (*) key and then enter the badge ID.
• Allow supervisors and guards to perform specific commands at the device.
Select the commands in the Supervisor command list.
• Allow supervisors to edit a punch or transaction. The edits include adding a
punch, deleting a punch, adding hours to a pay code, moving hours to a
different pay code, and adding monetary amounts to a pay code.
• Prompt supervisors for a device work rule when they add or delete a
transaction. The Allow punch and transaction edits check box must be
selected first.
• Prompt supervisors to enter a comment code for commands where comments
are supported. This check box appears only for devices where comments are
supported and enabled for individual soft keys.
• Specify the commands that are to be available to supervisors and guards.
Note: To prompt supervisors for a device work rule when they add a transaction
on a device, see “Soft Key tab” on page 171.

Loading basic configuration parameters to a device

After you use the configuration tabs to set device parameters, 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, extract your Series 400 device configuration before you enter
the first initialize command. Otherwise, you will lose your customized device
configuration.
Load configuration data to devices by using one of the following methods:

• 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 from the host application the
employee information 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.

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 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 or 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 139. For
information about loading device parameters that are not included in the
Configuration Options tabs, see “Loading Files and Data to and from a Device”
on page 279.
Using the Device Manager to load basic configurations

You can use the Device Manager initialize to load basic configurations to a device
or 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).

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 “Troubleshooting” on page 301 for help.
Using the Communication Monitor to load basic configurations

You can use 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.

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

Chapter 6
Setting Up Labor Level Information
This chapter explains how to set up labor level information and how to load it to
devices.
• “Selecting labor level options for the device” on page 184
• “Defining labor transfer options” on page 185
• “Configuring labor transfer settings” on page 187
• “Assigning labor levels to a soft key” on page 190
• “Removing labor levels from a device” on page 192
• “Downloading labor levels to a device” on page 193
Chapter 6 Setting Up Labor Level Information
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 employee’s time with cost centers that have a
hierarchical relationship to each other. For example:
• 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:
• 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.

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 “Downloading labor levels to a device” on page 193 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.

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 the appropriate Device work rule profile, Tips, and Job set from the
drop-down lists.
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 select neither labor
levels nor 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 Soft Key tabs on the Data Collection Manager Configuration
Options dialog box to make 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” on page 193 later in this chapter, for
information about loading configuration to the device.

Defining labor transfer options
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.
3. Select a transfer badge type to allow a labor transfer.
– Select None to reject 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.
– 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 reject 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.
– 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.
7. Specify when an entry is required for labor levels that are prompted when an
employee performs a simple punch.
– Select None to specify that no 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.

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 in “Selecting labor level options for the device” on page 184.
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.
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 drop-
down 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. 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 device 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.
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 the box is cleared, only numeric values are
allowed.
8. If you are configuring a Series 400 device, the default order for the Labor
Levels that were configured in the Application Options appears 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.
If you are configuring a Series 4000 terminal, the labor levels are specified on
the Soft Key tab. For more information assigning labor levels, see “Assigning
labor levels to a soft key” on page 190.
For more information about setting labor levels, see “Selecting labor level
options for the device” on page 184.
9. 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.
If you are configuring a Series 4000 terminal, partial labor level transfers are
specified on the Soft Key tab. For more information about configuring partial
labor level transfers for a Series 4000 terminal, see “Assigning labor levels to
a soft key” on page 190. Go to step 15.
10. 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.
11. 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.
12. 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.
13. Click OK.

14. Repeat steps 9 through 12 until you have assigned the appropriate labor
levels.
15. Click OK to return to the Device Manager main window.

Assigning labor levels to a soft key

Use the Soft Key tab to assign tasks to soft keys. You set up soft keys to perform
tasks—for example: list the employee’s last punch, request a tip amount, or cancel
an automatic meal deduction. You assign tasks to soft keys for employee and
manager use, or only for manager use. You can also assign labor levels to soft
keys so that an employee can charge time to one or more labor accounts.
To assign labor levels to a soft key:
soft keys.
2. Select Device > Configuration and click the Soft Key tab. The Configuration
Options dialog box appears.
Note: The options available are determined by the device that you are
configuring.
3. If it is available, you can select the Perform soft key activity on out-punch
check box, which allows employees to perform a soft key transaction when
they punch out from a shift.
4. In the Soft Key mapping list, expand a Soft Key, select one of the following
options, and click Assign:
a. For Series 4000 terminals, select No function assigned or No manager
command assigned.
b. For Series 400 devices, select No function assigned.
The Assign Function dialog box appears.
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 Soft Key Settings dialog box appears.
5. 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. Select the appropriate labor level entry from the Labor Level dialog box.

Assigning labor levels to a soft key
If you select Allow Override, 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.
7. Repeat steps 5 through 7 until you have assigned the appropriate labor levels
to the soft key.
8. If you are configuring a Series 400 device, enter the text that is to appear on
the device for that soft key and click OK.
9. If you are configuring a Series 4000 terminal and selected No function
assigned in step 4, select the appropriate Soft Key schedule, enter the Soft
Key label that is to appear on the terminal, and click OK.
10. If you are configuring a Series 4000 terminal and selected No manager
command assigned in step 4, enter the Soft Key label that is to appear on the
terminal and click OK.
For more information about the Soft Key tab, see “Soft Key tab” on page 171.
After a labor level is assigned to a soft key, you need to load the labor level
assignment to your device or devices. See “Downloading labor levels to a device”
on page 193.

Removing labor levels from a device

Before you remove labor levels from a device, you need to remove any labor level
assignment to a soft key, a number (#) key, or a labor level transfer that is assigned
to that device. You cannot delete a labor level 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.
5. Click OK.
6. Download the option to the device by using the Initialize command from the
Device Manager or the Communication Monitor application.

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.
box appears.
6. From the drop-down list, select Device Configuration and click OK.
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 or 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.

Chapter 7
Totals and Accruals
This chapter explains how to define soft keys to display totals and accruals.
It contains the following sections:
• “Creating a totals definitions” on page 197
• “Assigning totals definitions to soft keys” on page 200
• “Downloading totals definitions and accruals to a device” on page 201
Chapter 7 Totals and Accruals
Overview
Certain devices display totals and accrual balances for employees. A device is
configured to list a number of totals definitions for home employees. Users
display device totals from totals definitions by using a soft key. A totals definition
contains the sum of a specific calculation, such as hours worked or sick time
earned.
DCM supports these totals definitions with pay codes or accrual codes. Each
totals definition has one setting system-wide; totals definitions are not device-
independent. 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 totals
definitions to soft keys to display the totals at that device. You can configure
different soft keys to show different totals 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 soft 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 “Device Work Rules,
Comment Codes, and Pay Code Edits” on page 203.

Creating a totals definitions

Totals definitions are system-wide and are not device-specific.
In DCM, you can define a totals definition for a selected pay code or accrual code.
Use the Totals Configuration dialog box, which you access from the Soft Key tab
on the Configuration Options dialog box, to create totals definitions.
To create a totals definition:
the totals definitions.
3. Select Device > Configuration. The Configuration Options dialog box
appears.
4. Click the Soft 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 totals definition. It is empty by default.
5. Click Add to add a new totals 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. Select Pay Code or Accrual Code as the total type.
– 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 totals definition

To edit a totals definition:
1. From the Device Manager main window, select the device for which to edit
appears.
3. Click the Soft Key tab.
4. Click Configuration Totals. The Totals Configuration dialog box appears.
5. Select the name of the totals definition to edit.
6. Click Edit. The Totals dialog box appears.
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 totals definition

DCM allows a maximum of seven totals definitions. Delete a totals definition
when that total is no longer necessary. For example, salaried employees no longer
need to keep track of their overtime.
To delete a totals definition:
1. From the Device Manager main window, select the device for which to delete
appears.
4. Click Configuration Totals. The Totals Configuration dialog box appears.

5. Select the name of the totals definition.

6. Click Delete and Yes to confirm.
7. Click OK.

Assigning totals definitions to soft keys

To assign totals definitions to soft keys, define the soft key assignment and then
specify the totals that you want to display at the device.
For more information about defining a soft key assignment, see “Soft Key tab” on
page 171.
To specify the totals that are to appear on the device:
1. On the Soft Key tab, click the plus sign before the soft key name to display
the list of functions assigned or not assigned.
2. Select the assigned soft 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 Soft 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 device-
specific.
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 closes.
7. Click OK. The Soft Key tab reappears.
8. Click Apply to apply the changes and continue to display the Soft Key tab, or
click OK to apply the changes and close the Configuration Options dialog
box.

Downloading totals definitions and accruals to a device
Downloading totals definitions and accruals to a device

To download totals definitions and accruals to a device, set the proper download
options from the Device Manager.
Downloading totals definitions and accruals

To download totals and accruals:
1. From the Device Manager main window, highlight the appropriate device.
box appears.
3. Select Employee Totals.
Note: To download soft 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 soft key assignments and save the
device configuration.
To reflect the proper soft key assignments for totals definitions at the device, you
need to send the device configuration to the device.
4. Click OK.
Sending totals and accruals to a deviceWhen 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, device work rules, pay codes, and punch interpretation rules from the
application connection library.
The Workforce Timekeeper connection library provides employee totals data lists
to the configuration service and devices only during initialization, not during an
update request.

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 or 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.
Individual totals are part of the employee totals record that depend on the total
number of configured totals definitions.
With the Workforce Timekeeper application, totals and accruals are downloaded
with vested balances in the current pay period.

Chapter 8
Device Work Rules, Comment Codes,
and Pay Code Edits
This chapter describes how to configure device work rules, comment codes, and
pay code edits.
• “Device work rules and profiles” on page 204
• “Comment codes” on page 212
• “Pay codes and pay code edits” on page 216
Chapter 8 Device Work Rules, Comment Codes, and Pay Code Edits
Device work rules and profiles

This section explains how to create and use device work rules and device work
rule profiles to allow employees to perform a work rule transfer at a device. The
following procedures are explained:
• Creating device work rules
• Creating device work rule profiles
• Assigning device work rule profiles to a device
• Assigning Start and End Work Rule Transfer transactions to device soft keys
Work rules, device work rules, and device work rule profiles
A pay rule is 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.
Work rules are used in Workforce Timekeeper to apply specific payroll rules to
shifts that determine how an employee accrues hours. All employees have a default
work rule assigned to them as part of their pay rule, and some employees may be
allowed to change their work rule when they perform a specific type of work.
For example, an employee's default work rule might specify that the employee
begin to accrue overtime after the employee works eight hours in a single shift. If
an employee is called back to work after just completing a shift, that employee
may be allowed to transfer to a different work rule that accrues a minimum of four
hours towards overtime, even if the employee did not work eight or more hours in
the original shift.
A device work rule is used to allow employees to perform a work rule transfer at
a device. Device work rules map work rules to pay rules, allowing a single device
work rule to be used at a device to transfer different employees to different work
rules, based on the employee's pay rule assignment in Workforce Timekeeper.

For example, a device work rule named "Call back" could be used to transfer
employees with pay rule A to work rule A, and employees with pay rule B to work
rule B, if these employees accrue hours differently for a "Call back". This allows
all employees to use a single device soft key, which could be labeled "Call back",
to perform a work rule transfer, even though each is transferred to a different work
rule. If all employees, regardless of their pay rule, accrue hours the same for a
"Call back", the device work rule may be configured with a single default work
rule.
To create device work rules, use the DCM Device Work Rules application’s
Device Work Rule Definition dialog box. A device work rule definition includes
the following information:
• The default work rule. This is the work rule that the employee is transferred to
in Workforce Timekeeper when none of the pay rules in the device work rule
match the employee's pay rule.
• Pay rule and work rule associations. These associations are used to define
which work rule an employee is transferred to based on the pay rule assigned
to the employee in Workforce Timekeeper. If the device work rule does not
contain any pay rule to work rule associations, all employees are transferred
to the default work rule, regardless of their pay rule assignment.
Device work rule profiles are the means that you use to assign device work rule
definitions to devices. You may have many device work rules defined, but
employees that use a particular device may only need to use a subset of them.
Work rule profiles are also used to assign a numeric value to each device work
rule, which may be used at devices with numeric-only keypads to specify the
device work rule.
A device work rule profile consists of a list of device work rules and
corresponding device work rule numbers.
Employees or managers use Start and End Work Rule Transfer functions at
devices to perform work rule transfers. A Start Work Rule Transfer changes the
employee's work rule based on the device work rule assigned to the soft key or
selected by the employee after pressing the soft key. An End Work Rule Transfer
returns the employee to the work rule specified in the employee’s Pay Rule
assignment in Workforce Timekeeper.

Creating device work rule definitions

To create device work rule definitions:
1. From the Start menu, select Programs > Data Collection Manager > Device
Work Rules. The Device Work Rule Configuration window opens.
2. From the drop-down list, select Device Work Rule Definition if it is not
already selected.
3. Select File > New. The Device Work Rule Definition - Create New dialog box
appears.
4. Enter a unique name for the new device work rule, such as Global Service.
Note: Do not use the following special characters in the device work rule
name: \ / * ” ’ ? < > | : ; #
5. Select a default work rule for the device work rule. The default work rule goes
into effect when the pay rule in the device work rule definition does not match
the pay rule assigned to the employee in Workforce Timekeeper.
You have the option to select a default work rule for this device work rule by
using the Default Work Rule drop-down box.
Note: If you select None and the pay rule in the device work rule definition
does not match the employee's pay rule, the work rule transfer is rejected by
Workforce Timekeeper and the rejected work rule transfer request appears in
the Transaction Data Editor with an error message.
6. To associate pay rules with 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.
A pay rule can be listed only one time in each device work rule. However, you
can associate a single work rule with many different pay rules.
As you link pay rules to work rules, the associations appear in the Pay Rule/
Work Rule Associations area of the window.
7. When you have finished, click OK to save the new device work rule.

Creating device work rule profiles

To create device work rule profiles:
2. From the drop-down list, select Device Work Rule Profiles if it is not already
selected.
3. Select File > New. The Device Work Rule Profile - Create New dialog box
appears.
4. Enter a unique name for this profile—for example, Tech Support.
5. Map an available device work rule definition to a device work rule number:
a. Select an available device work rule definition in the left window pane.
b. Select a device work rule number in the right window pane.
The device work rule numbers do not correspond to soft key numbers.
You can specify up to 20 device work rules for Series 400 devices. You
can specify up to 40 device work rules for Series 4000 terminals.
c. Click Assign to map the available device work rule definition to the
device work rule number.
6. Optionally, you can repeat step 5 until you map all the device work rule
definitions to the device work rule numbers that are to be entered at the device.
Specify the device work rule profile before you initialize the device.
Deleting pay rule/work rule associations from a device work rule

Do not delete a pay rule/work rule association that has been used in transactions.
Wages from unlocked or unsigned pay periods that use that association disappear.
If you have only one pay rule/work rule association assigned, add another pay
rule/work rule association after removing the first one. At least one pay rule/work
rule association must be assigned to a device work rule definition.
To delete a pay rule/work rule association from a device work rule:
1. Select Start > Data Collection Manager > Device Work Rules.

2. In the Device Work Rule Configuration window, select Device Work Rule
Definition from the list box.
3. 3. Select File > Edit.
4. 4. In the Device Work Rule Definition dialog box, select the pay rule/work
rule association from the Pay Rule/Work Rule Associations list box.
5. Click Remove. The pay rule/work rule association is deleted from the Pay
Rule/Work Rule Associations list. The pay rule is displayed in the Available
Pay Rules list and can be used in association with any work rule in the
Available Work Rules list.
Deleting a device work rule profile from the database

To delete a device work rule profile:
2. From the drop-down list, select Device Work Rule Profiles if not already
selected.
3. Select File > Delete.
Assigning a device work rule profile to a device

Before you configure soft keys that perform work rule transfers at a device, you
must assign a work rule profile in the device’s application options:
1. From the Data Collection Manager main menu, select Device Manager. The
Device Manager window opens.
2. Select the device for which the device work rule profile is to be assigned.
appears.
4. From the Device work rule profile drop-down list, select a profile and
click OK.
5. Use the Initialize command to download device work rule profiles to devices.

After you assign device work rule profile to a device, perform an initialize
with Device Work Rules enabled in the download options. Initialization
downloads your device work rule profiles to devices. Initialize whenever you
make changes to device work rules or device work rule profiles. For more
information about initialization and cautions when using initialization, see
“Initialization” on page 139 and “Loading basic configuration parameters to a
device” on page 177.
You can also program a soft key to prompt for device work rules. Employees enter
a device work rule after pressing the soft key. For more information about
assigning a device work rule to a soft key, refer to the next section.
Assigning a device work rule to soft keys

To assign a device work rule to a soft key:
1. From the Device Manager main window, select the device.
appears.
4. In the Soft Key mapping list, expand the Soft Key to which to assign a device
work rule, and select one of the following:
– No function assigned, to select a start work rule transfer or an end work
rule transfer for an employee
– No manager command assigned, to select a start work rule transfer or an
end work rule transfer for manager use only
5. Click Assign.
6. In the Assign Function dialog box, scroll until you find Start Work Rule
Transfer or End Work Rule Transfer and select it.
Start Work Rule Transfer marks the start of a shift or a change within in the
current shift where the employee accrues time based on a Work Rule different
than that employee's default Work Rule. End Work Rule Transfer returns
employees to their default Work Rule as specified in Workforce Timekeeper.

7. If you selected End Work Rule Transfer, go to step 8. If you selected Start
Work Rule Transfer, click Detail. The Soft Key Settings dialog box appears.
a. To assign a device work rule to the soft key, select a device work rule
from the list.
b. To automatically transfer to this work rule when the soft key is pressed,
clear the Allow override check box.
The user is not prompted to enter a device work rule and the default
device work rule that you assigned to the soft key is included in the
transaction data.
c. If you want employees to be able to modify the selected work rule, check
the Allow override check box.
The user is prompted to enter a device work rule and is required to accept
the default value or to enter a different value.
d. Select options on other tabs as appropriate.
8. Click OK until you return to the Device Manager main window. For more
information about the Soft Key tab, see “Soft Key tab” on page 171.
After you assign device work rule to a soft key, perform an initialize with
the Device Configuration download option enabled. For more information
about initialization and cautions when using initialization, see
“Initialization” on page 139 and “Loading basic configuration parameters to
a device” on page 177.
Unassigning a device work rule profile from a device

You cannot delete a device work rule profile if it has been assigned to a device.
First unassign the device work rule profile from the device.
To unassign the device work rule profile from devices:
1. From the Device Manager window, select the device whose device work rule
profile you are unassigning.
appears.
3. In the Device work rule profile list box, select <None> and click OK.

You are also prompted for configuration options to unassign soft keys.
4. Download the option to the device by using the Initialize command. For more
information about initialization and cautions when using initialization, see
“Initialization” on page 139 and “Loading basic configuration parameters to a
device” on page 177.
After unassigning the device work rule profile from the device, delete the device
work rule profile from the Device Work rule Configuration application.

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 soft 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 manager functions or commands
and only for Full models, such as the 480 Full model.
If you configure a soft key with a function or transaction that includes a pay code,
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 managers 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.
appears.
3. In the Configuration Options dialog box, click the Soft Key tab.
4. Select the soft key to which to assign a function.
5. Click the + (plus) sign to expand the soft key options.

Comment codes
6. Select No function assigned or No manager command assigned.
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 current date plus one day. For example, if the date
is March 15, the user can enter any day from 1to 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 on February 17.
If you selected No manager command assigned, some options, such as delete

a punch, can be deleted by a manager for any day from the first day of the
current month to the current date plus one day. For example, if the date is
March 15, the user can enter any day from 1to 16 for a punch delete within the
first 16 days of March. If the manager enters 17 or above, the deleted punch is
entered for the previous month on February 17.
7. Click Assign. The Assign Function or the Assign Manager Command dialog
box appears.
8. Select the function to assign to the soft key.
In the Function List, select Add Punch, Delayed Labor Transfer, Delete
Punch, End Work Rule Transfer, Job Transfer, Labor Transfer, Pay Code
Move Amount, Pay Code Hours Edit, Pay Code Money Edit (Decimal
Transaction), or Start Work Rule Transfer.
Note: If you select Add Punch, you can specify that managers be prompted
for a device work rule when they add a transaction on Series 4000 terminals
with firmware version 2.1 or higher.
9. Click Detail. The Soft 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.
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 Soft 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.
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 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, select it. The Function Key Settings dialog box that
appears is specific to the function that you selected. 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 Detail
dialog box options, refer to the online Help.
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

Comment codes
of the current month to the current date plus one day. For example, if the date
is March 15, the user can enter any day from 1to 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 on February 17.
If you selected No supervisor command assigned, 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 current date plus one day. For example, if the
date is March 15, the user can enter any day from 1to 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 on February 17.
10. Click OK twice.

Pay codes and 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 the Workforce Timekeeper application.
The configuration service supports pay codes from 1 to 32767 for Series 4000
terminals and from 1 to 999 for a Series 400 device. If the Workforce Timekeeper
application provides pay codes outside these ranges, such as 0, the pay code is not
included but instead is written to an error log.
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. Managers and, in some cases, employees may perform pay code edits at
Series 400 devices. Managers and employees may perform pay code edits at 4000
devices. The edits are initiated by pressing a soft key or function key, which 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 soft key with a function or transaction that prompts the
user to enter a pay code, device work rule, 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.

Enabling pay code edits for a Series 4000 terminal

You can configure pay code edits for a Series 4000 terminal by using the Soft Key
tab in the Configuration Options dialog box. The functions that are available are
specific to the host application and 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 Move Amount and Pay Code
Hours Edit in Manager mode and Supervisor mode.
To enable pay code edits for a Series 4000 terminal:
1. Open the Device Manager main window and select the device to configure.
appears.
4. Select the soft key to which to assign a function.
5. Click the + (plus) sign to expand the soft key options.
6. Select either No function assigned or No manager command assigned and
click Assign.
From the Function list, select Pay Code Hours Edit.
If you selected No manager command assigned, the Assign Manager
Command dialog box appears. From the Function List, select Pay Code Move
Amount, Pay Code Hours Edit, or Pay Code Money Edit.
7. Click Detail. The Soft Key Settings dialog box appears.
Only pay codes that have a pay code ID number are displayed in the Soft 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. Select the pay code to be used as the default that is associated with the soft
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 Soft Key
Settings dialog box to associate the transaction with a specific pay code. You
may also specify a number of default hours and you can prevent employees
from overriding this default setting.
9. If it is 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 the
Workforce Timekeeper application.
If you select Pay Code Move Amount and the default values for the From and
To selections, and also do not allow these to be overridden, the soft 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 Soft Key Settings dialog box,
click Help.
10. Click OK.
11. To change the label that appears on the device for the soft key, enter the new
label text in the Soft 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.
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 No function assigned or No supervisor command assigned.

7. Click Assign.
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 Function 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 have selected. 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 it is 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 the
Workforce Timekeeper application.
10. Select the Pay code to be the default that is associated with the soft 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. The Workforce Timekeeper

application 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 manager
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:
• ENTER DAY 10—The employee can press Enter to accept the default (today,
the 10th day of the month) 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 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:00—The 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.
• 301201101—The employee can press Enter to accept the default (301 201
101), or change the pay code number for labor level and then press Enter.

Chapter 9
Collecting Data and Managing Transactions
This chapter explains how to start data collection, manage transactions, and
schedule events.
• “Enabling data collection” on page 222
• “Monitoring transactions and device communications” on page 225
• “Collecting transaction input files” on page 229
• “Processing a transaction input file” on page 230
• “Viewing transactions” on page 234
• “Correcting invalid transactions” on page 235
• “Scheduling events” on page 237
• “DCM command events” on page 245
• “Centralized log file” on page 260
• “Transaction output files” on page 263
• “Data backups” on page 266
Chapter 9 Collecting Data and Managing Transactions
Enabling data collection

Online data collection allows for continuous data collection from the device when
the device is initiated. Online devices can also use scheduled collections. Batch
collection sends data when a scheduled collect event is initiated. Modem devices
use batch. Serial and Ethernet devices may use either online or batch collection.
If online data collection is selected for a device configuration, Automatic Data
Collection is also selected for the device group.
You can set up data collection to run automatically for a device group. You can
also manually perform a one-time data collection from a device or a device group.
Devices need to be set up with the Online collection method specified, so that the
automatic data collection method or the start data collection method will 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.
If a Series 4000 device configuration is set to the Online Data Collection method
and Start Collection is executed, DCM ensures that data collection is continuous
until the data collection is stopped manually, the data collection is stopped when a
Stop Collection event is processed, or the collection method is changed to batch.
Note: For updating, the date and time for the 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, the biometric data may or may not be deleted from the
device when a device update is performed. Also, Employee badge data may not be
updated immediately when a device update is performed.

Enabling data collection
Automatic data collection

To start automatically collecting data from a device group, use one of the
following two methods:
• Use the Device Manager application to collect data from a device group. 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.
If you clicked Edit, click the Automatic Data Collection check box and
click Update.
c. Click Close.
d. Reboot. Data collection restarts automatically on the device group.
• 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” on page 237.
Starting and stopping data collection

You can use the Device Manager or the Communications Monitor to start or stop
data collection.
From the Device Manager, select the device or group of devices from which
collection is to begin or stop, and select Communications > Data Collection >
Start Data Collection or Stop Data Collection.
From the Communications Monitor, select the group of devices, and select Device
> Start Data Collection or Stop Data Collection.

One-time data collection from the Device Manager

To start collecting data from a single device or a device group, you can use the
Device Manager’s 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.
2. From the Device Manager’s main window, select the device or group for the
collection.
3. From the Device Manager’s main menu, select Communications > Data
Collection > 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 your support group to determine how to configure
your anti-virus software to balance protection versus performance.
One-time data collection from the Communications Monitor

To start collecting data from a device group, you can use the Communication
Monitor’s Collect command. This is a manual process to perform a one-time
collection of data from 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 Monitor’s 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 your support group to determine how to configure
your anti-virus software to balance protection versus performance.

Monitoring transactions and device communications

The Communication Monitor enables you to monitor devices and device groups.
It 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.
Communication Monitor window

To access the Communication Monitor window, from the Data Collection
Manager main menu, select Communication Monitor. You can also select Tools to
access the Communication Monitor from the Device Manager and Event Manager
applications.
The Communication Monitor window lists the following information for each
interaction between a device and the host application:
• 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
You can select View > Filter to activate viewing status messages for the local PC
only or for all PCs. The default is to view the status of all devices on all PCs that

are assigned to the communication channels. Because the database is queried for
the status, a 15-second delay occurs before the status is posted.
To view the real-time status for all requests to devices that are assigned to
communication channels that are running only on the local PC, select View >
Filter and click on Local Status. The local memory cache is queried for the
status.
Communication Monitor message types
The following table describes the different types of messages that appear in the
Communication Monitor:
Message Type Display

Transactions Lists all the device transactions.
Application errors Lists error responses to the device transactions.
Application responses Lists all the application responses to device
transactions, including the successes and failures.
Requests and results Lists the application requests and the responses to
those requests.
Device errors Lists the errors on a particular device.
Communication errors Lists the errors that occur during device
communications.
Communication activity Lists all the traced communications messages.
If communication to the device has not been requested, there is no status.

Communication Monitor drop-down menus and icons
The following table lists the Communication Monitor window drop-down menus
and icons:
Drop-
down
Menu Function/Icon Action
File Exit Exits the Communication Monitor.
View Toolbar Displays or hides toolbar.
Status Bar Displays or hides status bar.
Filter Displays all system status messages or local PC status
messages only
Refresh Sends registration messages to active communication
channels and device groups, and updates displays.
Device Initialize Downloads the configuration settings to the selected device
or device group. Clears any settings that were already in the
device.
Collect Polls the devices in a selected device group and collects data.
This starts a manual data collection process.
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 Updates a selected device or selected device groups by
downloading changes.
Set Date and Sends the date and time of the communication PC to the
Time 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 Starts the data collection process for devices in a selected
Collection device group. This initiates the automatic data collection
process.

Drop-
down
Menu Function/Icon Action
Stop Data Stops the data collection process for devices in a selected
Collection device group. This stops the automatic data collection
process.
Tools Transaction Data Enables you to edit a selected transaction. For more
Editor information about the Transaction Data Editor, see
“Correcting invalid transactions” on page 235.
View Displays punch data. For more information about viewing
Transactions transactions, see “Viewing transactions” on page 234
View Transaction Displays the total number of successful transactions and total
Statistics number of failed transactions for communication PCs that are
configured and running DCM. For more information about
viewing transaction statistics, see “Viewing transaction
statistics” on page 236
View Log Displays a centralized log. For more information about log
files, see “Centralized log file” on page 260.
Device Manager Accesses the Device Manager.
Event Manager Accesses the Event Manager.
Help Help Topics Enters the online Help system.
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, or
until a processing error occurs.

Collecting transaction input files
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 with
verification that the file exists. The results appear in the Communication
Monitor.

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 237.
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 preparations that you
need to make before loading transactions to the device are described in the
following sections, “Formatting a transaction input file” on page 231 and
“Location of a transaction input file” on page 232.

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 Length Enter Value

1 1 #
2 20 This position contains the device group name for the source
device.
22 15 This position contains the device ID or password.
37 1 This position contains the letter for the device type: D=Direct;
P=Periodic.
38 1 This position contains the record type identifier for the
application.
39 3 This position contains the transaction code for the application.
(See the table in “Transaction codes” on page 232.)
42 8 This position contains the date of the transaction using the format
MMDDYYYY.
50 6 This position contains the time of the transaction using the format
HHMMSS.
56 1 This position contains a value that designates whether the
transaction was created during DST (Daylight Saving Time)?
1=Yes; 0=No.
57 5 This position contains the time zone ID: 13011 Eastern Standard
Time.
62 1 This position contains the online response value from the
application? 1=Yes; 0=No.
63 1 #
64 This position contains raw transaction data.
A sample file that uses the preceding format is as follows:

1234567890123456789012345678901234567890123456789012345678901234567890
#WFC Application000001 DAA 070420021054001130110#1001###

Transaction codes
The following table lists transaction codes that are listed in a transaction input file.
Record Identifier FIFO Record Type

A Punch
B Department/Labor Transfer
C Supervisor Record
D Daylight Saving
E Add a Punch
F Function Key or Soft Key
G Guard Record
H Delete a Punch
I Pay Code Transaction
J Pay Code Move Amount
K Quantity Transaction
L Tips
M Maintenance Record
S Entry Manager Event
T Time Stamp and Individual Message Audit Trail
V Work Rule Code Punch
W Gate Punch
Y Report Count
Z 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.

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.
Transaction files are located on the local communication PC, where the event is
launched, and are found 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.
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.
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.

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.
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 235.
Note: When the Communication Monitor is shut down, the Transaction Viewer
window is shut down automatically.

Correcting invalid transactions
Correcting invalid transactions

When data is collected from devices, the Workforce Timekeeper application
server validates each transaction. If a transaction, such as an employee’s in-punch
or out-punch, contains incorrect data, the Workforce Timekeeper application 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.
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 “Understanding and
Accessing Punch/Transaction Data” on page 427.
5. When the invalid transaction is correct, click Re-submit.
6. The transaction is resubmitted to the DCM application queue for
reprocessing.

Viewing transaction statistics

Transaction Statistics retrieves the count of the successful, failed, and total
transactions that were processed by each of the active communication PCs.
To view the transaction statistics, from the Communication Monitor, select Tools
> View Transaction Statistics. The Transaction Statistics dialog box appears.
The Transaction Statistics dialog box displays:
• The count of the successful, failed, and total transactions that were processed
by each of the active communications PCs. For example, if a single
Workforce Central database and six DCM instances are installed to six
different communication PCs pointing to that single database, the list includes
all those communication PCs.
• The date and time that the totals were last updated for the selected
communication PC.
• The date and time that the totals were last reset for the selected
communication PC.
DCM retrieves from the database the total values every minute and refreshes the
statistic values in that appear on the Transaction Statistics dialog box. To
manually retrieve the total values and reset the one-minute timer, click Refresh.
To reset the count values for one communication PC to zero, select a
communication PC and click Reset. To reset the count values for all
communication PCs to zero, click Reset All.
To schedule an automatic reset of the count value to zero for a particular
communication PC, use the Reset Communications PC Transaction Statistics
event. This event causes the Total Counts in the Total Count Window to be
updated appropriately.
To schedule an automatic reset of the count values to zero for all communication
PCs, use the Reset All Transaction Statistics event. This event resets the Totals
counts in the Total Count Window.
If the total count reaches 2 billion, all count values are reset to zero
For more information about DCM events, see “DCM events and the Task
Scheduler” on page 238.

Scheduling events
Scheduling events
An event is a DCM task, such as a data collection, a device update, or a program
execution, that you configure and schedule to be launched. When you configure
events in the Dcommunication PCCM Event Manager, you create actions for
DCM to perform at specific date and time. To configure a DCM command event,
refer to “Defining a DCM command event” on page 239. To configure a program
event, refer to “Defining a program event” on page 254.
the DCM communication PCs. For all events except Disable Sentinel and Enable
Note: Event failure e-mail notifications are sent for events that are launched after
the Disable Sentinel event is launched. The e-mail notification states that the
Sentinel Service is not running. All events that are successfully launched after the
Enable Sentinel event is launched execute as scheduled.
You can access DCM Event Manager from the Data Collection Manager main
menu by selecting Event Manager. You can also select Tools to access the DCM
Event Manager from the Device Manager and Communication Monitor
applications.
Events are listed in the Event Manager main window in alphabetical order by
default. You can click any column heading to change the sort order.
The Event Manager window lists the events, the launch schedule, and the next and
previous run times. The Schedule column lists the event’s launching
configuration. If the event is to launch in the future, the Next Run Time column
lists the future run time. If the event was launched, the Last Run Time column lists
the time that the event launched.
The first time the Event Manager is opened, the DCM Event Manager - Events
window, in which no event commands are loaded to the DCM Event Manger,
appears by default. After an event is launched, the status of the event is written to
the DCM log file.
Event commands are stored in event sets, which are files with the .evt extension.
For more information about event sets, see “Event sets” on page 258.

If your DCM 6.0 system is an upgrade from a previous DCM system, your event
list files are converted to individual DCM events and stored in an event set with
the same name. The new event set files have the .evt extension.
Note: If the command line for a Run Program event contains the executable name
and parameters, the event cannot be converted. You must recreate the Run
Program event.
Schedule events for present and future times only. If you define a one-time event
for a past time, the event does not run until you manually run events. To manually
run the events, select Tools > Run Event Now.
You can stop events from launching. For example, you may want to suspend
events while you perform an upgrade or while you resolve a network or device
problem. To suspend events or resume events, select Tools > Suspend or Tools >
Resume.
DCM events and the Task Scheduler

The Event Manager monitors the total number of tasks currently set up with the
Microsoft Task Scheduler. The Task Scheduler can run 1023 tasks. When the
number of tasks reaches 1000, the Event Manager warns you that the total number
of tasks is approaching the limit of 1023 tasks. When the number of tasks reaches
1023, the Event Manager warns you that no more DCM events can be created.
These messages appear on the bottom of the Event Manager main window.
The two numbers on the bottom, right of the Event Manager main window are the
DCM task count and the total task count. For example, 362/1021 indicates that of
the 1021 scheduled tasks, 362 tasks are DCM event tasks.
You can store events in event sets. Storing event sets when the events are not in
use enables you to create more than 1023 event tasks. Before the Event Manager
loads an event set, it checks the list of events in the event set and the existing
scheduled tasks. If the total number of tasks exceeds the 1023 limit, an error
message is returned and the event set is not loaded. Remove some of the existing
system tasks and reload the event set.

Scheduling events
Defining a DCM command event

The two event types are command events and program events. A command event
runs an event action to run at a specified time. A program event runs an external
file to run at a specified time. Program events are described in “Defining a
program event” on page 254.
You can use the Disable Sentinel Service and Enable Sentinel Service command
events to stop and start the Sentinel.
You can start or stop the Sentinel Service via a DOS command. The command line
interface is:
srvmntr -enable|-disable
The location of the srvmntr.exe executable must be given to DOS by a fully
qualified path name, current working directory, or searchlist.
Note: Because Sentinel Service must be running when a program event is to be

launched, you cannot create a run program event to start the Sentinel.
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. On the General tab:
a. In the Event Name text box, specify a brief description of the event, for
example Collect first shift.
Note: Do not use the following special characters <, >, :, /, \, |, *, ‘, “, or ?.
b. From the Event Type drop-down menu, select Execute DCM Command.
c. Select the Enabled (scheduled task runs at specified time) check box to
allow the event to occur. Clear the check box to save the confutation but
not run the event.

4. On the Schedule tab:

a. Choose how often and when this event occurs. Select the frequency from
the Schedule drop-down menu, You can run the event once, or every few
minutes, every few hours, daily, or on specified days.
Select One Time to run the event once. Specify the start time and date.
After the event runs, you can run it again when you select Tools > Run
Event Now.
Select Minutes to specify the cycle of when and how often the event is to
run. Specify the start time and date. Specify the number of minutes that
the event is to wait before it runs again. If you specify 60 minutes, the
event is changed to run hourly.
Select Hourly to run an event at a specific time during every hour, for
example fifteen minutes after every hour changes. Specify the start time
and date.
Select Daily to specify that the event runs days and time that you specify.
Specify the start time and date. To select multiple days, hold down the
CTRL key and select the appropriate days.
Note: If you schedule events to run at a time that falls within a DST (Daylight
Saving Time) change, the event runs twice if the time is set backward due to
the change, or does not run at all if the time is set forward due to the DST
change on the day of the DST change. For example, any event that is
scheduled to run between 1 a.m. and 2 a.m. on the day of a backward DST
change that sets the time backward 1 hour will run twice because the hour
between 1 a.m. and 2 a.m. occurs twice on that day. Any event that is
scheduled to run between 2 a.m. and 3 a.m. on the day of a forward DST
change that sets the time ahead 1 hour will not run on that day because the
hour between 2 A.M. and 3 A.M. does not occur at all on that day.
5. On the DCM Event tab:

a. From the DCM Event drop-down list, select a DCM command event.

Scheduling events
b. From the Device ID drop-down list, select the device ID.

For the Connect to Modem Device at Phone Number command, enter
the exact telephone number of the device as specified in the device
configuration when the device was created. For example, 555-1212 does
not equal 5551212. 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.
For information specific to DCM commands, see “DCM command events”
on page 245.
The following windows show completed configuration tabs for an event with
these actions:
• The event is enabled to collect all device data from the devices in the device
group called Headquarters.

• The event occurs every Thursday at 12:33 PM, starting on Monday,

September 12, 2005.
• The event collects data from the Ethernet device group called Headquarters.
Deleting a command event

You can multi-select events to be deleted. If you delete an event from an event list,
you are asked to confirm the delete. If you click Yes, the event is deleted and the
delete cannot be undone. The event list is saved without the deleted event. To
replace the event, create it again.

Scheduling events
Editing, copying, or renaming a command event

To edit, copy, or rename a command event:
1. From the DCM event Manager main window, select an event.
2. From the Edit drop-down menu, select Edit, Copy, or Rename. Use Edit
enables to change all options except the name of the event. Use copy and
paste to copy an event. Use Rename to change the name of the event.
Note: When renaming an event, you cannot change a letter from one case to
another case in the existing event name. For example, if the name of the event is
Collect first shift, you cannot rename it to Collect First Shift.
Testing an event
To test an event:
1. If necessary, from the Event Manager window's event set, select the event set
that contains the event to be tested.
2. Select the event.
3. Select Tools > Run Event Now.
The time at which the event was fired appears at the bottom of the window.
A record that the event was run before its scheduled time appears in the
DCM.log file and does not affect the next scheduled time for the event. You
can view the log file from the Event Manager by selecting Tools > View Log.
Event Manager refresh interval

Use the Event Manager Options dialog box to specify how often the Event
Manager application refreshes the event list.
To specify Event Manager timing:
1. From the Event Manager window, select Tools > Options. The Event
Manager Options dialog box appears.

2. Specify, in seconds, the event set refresh interval. The minimum is 2 seconds.
The maximum is 64000 seconds. The default is 5 seconds.
3. Click OK
E-mail notification of a command event failure

If a command event cannot be launched and the e-mail notification option is
active, the e-mail notification states that the launch was unsuccessful.
If the command event was launched but could not be processed, the e-mail states
that the event could not be processed.

DCM command events
DCM command events

The following table lists the DCM command events and their corresponding
specification formats. Select the Group or Device, or enter Connect Name entry.
the DCM communication PCs. For all events except Disable Sentinel and Enable
Device, Group, or
DCM Event Connect Name Description
Check for Series 4000 Sends an e-mail notification if uncollected
devices with uncollected transactions are on a Series 4000 device. The
transactions e-mail message includes:
• The device ID
• The device name
• The date and time that the uncollected
transactions were found in the device.
• The collection state
• The communications state
If no uncollected transactions are on a Series

4000 device, no e-mail notification is sent, but
an entry is written to the dcm.log file.
Collect Device Device ID Retrieves data from one or more devices. 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.
Collect Device Transaction Device ID Sends a request to the DCM Collection Agent
File running on the local DCM communication PC
to process a transaction input file for the
specific device.

Device, Group, or
Collect Group Device Group name 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.
Collect Group Transaction Device Group name Sends a request to the DCM Collection Agent
File on the local DCM communication PC to
process a transaction input file for the
specified group.
Connect to Modem Device The Device telephone Retrieves data from one or more devices
at Phone Number number that is specified connected to a single modem by using the
in the device modem’s telephone number. For example, you
configuration; for collect data from all devices connected to a
example, modem whose telephone number is 1-222-
1-222-555-1212. 555-1212 daily at 9:00 A.M.
Disable Sentinel Service Stops the Sentinel Service.
Enable Sentinel Service Starts the Sentinel Service.
Initialize Device Comment Device ID Sends only Comment Codes to the specified
Codes device.
Initialize Device Employee Device ID Sends the employee and biometric data to the
Biometric Data specified device.
Initialize Device Employee Device ID Sends all employees without their schedules to
List with no Schedules the specified device.
Initialize Device Employee Device ID Sends all employee-specific data to the
List with Schedules specified device.
Initialize Device Employee Device ID Sends employee totals to the specified device.
Totals
Initialize Device Labor Device ID Sends Labor Levels to the specified device.
Accounts
Initialize Device Labor Device ID Sends only Labor Levels with No Reference
Accounts with no Text to the specified device.
Reference Text

DCM command events
Device, Group, or
Initialize Device Pay Codes Device ID Sends pay codes to the specified device.
Initialize Device Punch Device ID Sends Punch Interpretation Rules to the
Interpretation Rules specified device.
Initialize Device with Device ID Sends only device configuration data to the
Device Configuration specified device.
Initialize Device with Device ID Sends the device configuration data selected in
Device Download Options download options to the specified device.
Initialize Device with Device ID Sends the device job transfer set to the
Device Job Transfer Sets specified device.
Initialize Device with Device ID Sends only Device Work Rules to the specified
Device Work Rules device.
Initialize Device with Device ID Sends the employee job transfer set to the
Employee Job Transfer Sets specified device.
Initialize Group Comment Device Group name Sends the Comment Codes to all devices in the
Codes specified group.
Initialize Group Employee Device Group name Sends the employee and biometric data to all
Biometric Data devices in the specified group.
Initialize Group Employee Device Group name Sends employees with no schedules to a group
List with no Schedules of devices.
Initialize Group Employee Device Group name Sends all employee-specific data to all the
List with Schedules devices in the specified device group.
Initialize Group Employee Device Group name Downloads totals and accruals for all
Totals employees for the specified device group.
Initialize Group Labor Device Group name Sends Labor Levels to all devices in the
Accounts specified group.
Initialize Group Labor Device Group name Sends only Labor Levels with No Reference
Accounts with no Text to all devices in the specified group.
Reference Text
Initialize Group Pay Codes Device Group name Send Pay Codes to all devices in the specified
group.
Initialize Group Punch Device Group name Sends only Punch Interpretation Rules to all
Interpretation Rules devices in the specified group.

Device, Group, or
Initialize Group with Device Group name Sends device configuration data to all devices
Device Configuration in the specified group.
Initialize Group with Device Group name Sends the device configuration data selected in
Device Download Options download options to all the devices in the
specified device group.
Initialize Group with Device Group name Sends the device job transfer set to all devices
Device Job Transfer Sets in the specified group.
Initialize Group with Device Group name Sends Device Work Rules to all devices in the
Device Work Rules specified group.
Initialize Group with Device Group name Sends employee job transfer sets to all devices
Employee Job Transfer Sets in the specified group.
Load Device Firmware Device ID and File name Sends the specified file that contains the
firmware to the specified device.
Load Device Parameter File Device ID and File name Sends the specified AFT or XML file to the
specified device.
Load Group Firmware Device Group name and Sends the specified version of firmware to all
File name devices in the specified group.
Load Group Parameter File Device Group name and Sends the specified AFT or XML file to all
File name devices in the specified device group. The
group must contain compatible devices; for
example, all Series 4000 or all Series 400.
Reset All Transaction Resets the count values of successul and failed
Statistics transactions for all communication PCs to
zero.
Reset Communication PC Communication PC Resets the count values of successul and failed
Transaction Statistics transactions for one communication PC to
zero.
Resubmit All Failed None
Transactions
Set Device Date and Time Device ID Sends the date and time of the DCM
communication PC to the specified device.

DCM command events
Device, Group, or
Set Group Date and Time Device Group name Sends the date and time of the DCM
communication PC to all devices in the
Start Data Collection Device Group name Starts online data collection for 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.
Stop Data Collection Device Group name Stops online data collection for all devices in 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.
Update Device Employee Device ID Sends the changed employee and biometric
Biometric Data data to the specified device.
Update Device Employee Device ID Sends changed employee data for employees
List with no Schedules without their schedules to the specified device.
Update Device Employee Device ID Sends changed employee data, including
List with Schedules schedules, to the specified device.
Update Device with Device Device ID Sends changed application data specified in
Download Options the download options to the specified device.
Update Group Employee Device Group name Sends changed employee and biometric data to
Biometric Data all devices in the specified device group.
Update Group Employee Device Group name Sends changed employee data for employees
List with no Schedules without their schedules to all devices in the
Update Group Employee Device Group name Sends changed employee data, including
List with Schedules schedules, to all devices in the specified device
group.
Update Group with Device Device Group name Sends the changed application data specified
Download Options in download options to all devices in the

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.

DCM command events
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 Initialize Events Download Options
Initialize Device with Device Download Options Employees*
Initialize Group with Device Download Options Biometric Data*
Schedules*
Punch Interpretation Rules*
Totals*
Labor Levels*
Device Work rules*
Device Configuration*
Comments*
Pay Codes*
Device Job Transfer Set*
Employee Job Transfer Sets*
Initialize Device Employee List with Schedules Employees
Initialize Group Employee List with Schedules Schedules
Punch Interpretation Rules
Initialize Device with Device Configuration Device Configuration
Initialize Group with Device Configuration
Initialize Device with Device Work Rules Device Work Rules
Initialize Group with Device Work Rules
Initialize Device Employee Biometric Data Employees
Initialize Group Employee Biometric Data Biometric Data
Initialize DeviceEmployee List with no Schedules Employees
Initialize GroupEmployee List with no Schedules Punch Interpretation Rules
Initialize Device Employee Totals Employees
Initialize Group Employee Totals Punch Interpretation Rules
Totals

DCM Initialize Events Download Options

Initialize Device with Employee Job Transfer Sets Employee Job Transfer Sets
Initialize Group with Employee Job Transfer Sets
Initialize Device with Device Job Transfer Set Device Job Transfer Sets
Initialize Group with Device Job Transfer Set
Initialize Device Labor Accounts Labor Levels
Initialize Group Labor Accounts
Initialize Device Labor Accounts with no Reference Text Labor Levels (No text)
Initialize Group Labor Accounts with no Reference Text
Initialize Device Punch Interpretation Rules Punch Interpretation Rules
Initialize Group Punch Interpretation Rules
The following tables list the Initialize (download) and 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.
Update Device with Device Download Options and Update Group with Device
Download Options use the download options configuration for each device. If no
download options are selected that can be updated, the events do not update the
configurations. When you specify the Update Device with Device Download
Options or Update Group with Device Download Options event, you must also set
the appropriate download options.
Update Device Employee List with Schedules and Update Group Employee List
with Schedules update the employees with schedules, regardless of the download
options. By specifying the Update Device Employee List with Schedules and
Update Group Employee List with Schedules s event, you do not need to set the
download options.

DCM command events
Update Device Employees with no Schedules and Update Group Employee with
no Schedules update the employees without schedules, regardless of the download
options.
DCM Update Events Download Options

Update Device with Device Download Options Employees*
Update Group with Device Download Options Schedules*
Punch Interpretation Rules*
Biometric Data*
Update Device Employee List with Schedules Employees
Update Group Employee List with Schedules Schedules
Punch Interpretation Rules
Update Device Employees with no Schedules Employees
Update Group Employees with no Schedules Punch Interpretation Rules
Update Device Employee Biometric Data Employees
Update Group Employee Biometric Data Biometric Data
The following commands are supported by previous versions of the Data

Collection Manager. If you upgrade from a previous version of DCM, these
commands are available to provide backward compatibility.
A domain is a device group. These commands are mapped to the updated
commands listed in the Event Manager—for example CollectDomain maps to
CollectGroup. Commands cannot be edited.
Event Description
CollectDomain 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
LoadDomain Sends all device configuration data to all the devices
in the specified domain.
LoadDomainActvityCodes Sends only Device Work rules to all devices in the
specified domain.

Event Description
LoadDomain Configuration Sends only device configuration data to all devices in
the specified domain.
LoadDomainEmployees Sends all employee-specific data to all the devices in
LoadDomainEmployees Totals Downloads totals and accruals for all employees for
LoadDomainFile Sends the specified AFT or XML file to all devices in
the specified domain. The domain must contain
compatible device— for example all Series 4000 or
all Series 400.
LoadDomainLaborLevels Sends Labor Levels to all devices in the specified
domain.
LoadDomainLaborLevels Sends only Labor Levels with No Reference Text to
NoRefText all devices in the specified domain.
LoadDomainRestrictionProfiles Sends only Punch Interpretation Rules to all devices
SetDateTimeDomain Sends the date and time of the DCM communication
PC to all devices in the specified domain.
UpdateDomain Sends changed application data to all devices in the
specified domain.
UpdateDomainEmployees Sends changed employee-specific data to all devices
UpdateDomain Sends changed employee data for employees without
EmployeesNoSchedules their schedules to all devices in the specified domain.
Defining a program event

The two types of events are command events and program events.A program
event runs an external file at a specified time. A command event runs an event
action to run at a specified time. Command events are described in “Defining a
DCM command event” on page 239.

DCM command events
Note: Because Sentinel Service must be running when a program event is to be

launched, you cannot create a run program event to start the Sentinel.
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. On the General tab:
a. In the Event Name text box, specify a brief description of the event.
Note: Do not use the following special characters <, >, :, /, \, |, *, ‘, “, or ?.
b. From the Event Type drop-down menu, select Run Program.

c. Select the Enabled (scheduled task runs at specified time) check box to
allow the event to occur. Clear the check box to save the confutation but
not run the event.
4. On the Schedule tab:
a. Choose how often and when this event occurs. Select the frequency from
the Schedule drop-down menu, You can run the event once, or every few
minutes, every few hours, daily, or on specified days.
Select One Time to run the event once.Specify the start time and date.
After the event runs, you can run it again when you select Tools > Run
Event Now.
Select Minutes to specify the cycle of when and how often the event is to
run. Specify the start time and date. Specify the number of minutes that
the event is to wait before it runs again. If you specify 60 minutes, the
event is changed to run hourly.
Select Hourly to run an event at a specific time during every hour, for
example fifteen minutes after every hour changes. Specify the start time
and date.
Select Daily to specify that the event runs days and time that you specify.
Specify the start time and date. To select multiple days, hold down the
CTRL key and select the appropriate days.

5. On the Run Program tab:

a. In the Program text box, enter a path name to the program, such as
C:\DMscripts\runscript.exe.
b. In the Parameters text box, enter the full path name for the file, such as
C:\DCMscripts\backupemployees, whose data is passed to the program.
c. In the Startup Directory, enter the path name from where the program is
to run, such as C:\DCMscripts.
d. From the Run Style drop-down list, select the run style. Normal runs the
program as it normally would in the host application, Minimized
minimizes the program window while it is running, and Maximized
maximizes the program window while it is running so that it occupies the
full screen.
The following windows show completed configuration tabs for a program event
with these actions:
• The event is enabled to execute a backup program.

DCM command events
• The event occurs every Thursday at 10:29 AM, starting on Friday,

September 9, 2005.
• The event executes the update program in the scripts directory. When the
program is run the program icon appears in the task bar.
Deleting a program event

If you delete an event from an event list, you are asked to confirm the delete. If
you click Yes, the event is deleted and the delete cannot be undone. The event list
is saved without the deleted event. To replace the event, create it again.

Editing, copying, or renaming an program event

To edit, copy, or rename an program event:
1. From the DCM event Manager main window, select an event.
2. From the Edit drop-down menu, select Edit, Copy, or Rename. Use Edit
enables to change all options except the name of the event. Use copy and
paste to copy an event. Use Rename to change the name of the event.
Note: When renaming an event, you cannot change a letter from one case to
another case in the existing event name. For example, if the name of the event is
Collect first shift, you cannot rename it to Collect First Shift.
E-mail notification of a run program event failure

If a run program event cannot be launched and the e-mail notification option is
active, the e-mail notification states that the launch was unsuccessful. The e-mail
does not include any program errors.
Event sets
You can store groups of DCM events in one event set file. You can select the
location for event sets or you can select the default location, which is the events
subdirectory in the DCM data directory. You can create copies of an event set and
copy it to other DCM communication PCs that are running an Event Manager.
After you configure an event, it is added to the working event set. If no other event
set has been created, the Event Manager displays that event set when you log on to
the Event Manager. After another event set is created, the Event Manager displays
the last event set that was opened.
Creating an event set
To create an event set:

1. Select File > New.

DCM command events
2. Select Save As.

3. Enter a event set file name and click Save.
4. From the DCM Event Manager - new event set file name, add events.
5. Select File > Save.
Opening an event set
To open an event set into Event Manager, select File > Open and select the
appropriate .evt file. Editing and saving an event set
Caution: The system saves event set files every five minutes. When editing an
event set file, changes may be saved without warning. If you want to save an event
file as is, select the event set and click Save As and edit the new event set file.
To add, edit, d3e to save the edited event set.
Copying an event set
To copy an event set file, from the DCM Event Manager window:
1. Select File > Open and open the event set to be copied.
2. Click File > Save As. The Save As dialog box appears.
3. Specify the name of the new event set. The .evt extension is added by default
when you save the event set.
4. Click Save. The Event Manager dialog box appears with the event set name
included in its heading.
Removing event set files from the system
To remove event set files, delete files from the folder where the event set files are
stored. The default is C:\kronos\wfc\dcm\data\events. When you
open the Event Manager, all the event sets are deleted except the last-opened
event set.

Centralized log file

DCM provides and maintains a centralized log message file that provides an audit
trail that acts as a useful diagnostic tool. 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. 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 118.
A 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 118.
To view the log messages in the DCM log file:
1. In the Device Manager, Event Manager, or Communication Monitor, select
Tools > View Log. The Log Viewer dialog box appears:
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:
– Date and Time
– Log Context
– Log Level

Centralized log file
– Caller Identifier
– Log Message
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 a 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. Log Context and Log
Level entries must be in capital letters. Caller Identifiers are mixed capital and
lower-case letters. If the Caller Identifier is DevMgr.exe, a search on
devmgr.exe does not find the Device Manager Caller Identifier. You can enter
any unique consecutive letters in your search. For example, for a Log Context
search, you can type API in the Look for text box and display all
DCM.APILIBRARY log messages. You can type ION or CONN to display all
DCM.CONNECTIONLIBRARY log messages.
You can abbreviate the date search. For example, if the filter is Date, you can
enter 09/04 to display all 09/04/2004 log messages.
3. Click Find Now. The log file displays the filtered information. Caller
Identifier for Sentinel displays DCM.SENTINEL log messages and Context
for Sentinel displays DCMUTILITYLIBRARY log messages.
4. To filter another search, change the Filter Column text box, specify your
search criteria in the Look for text box, and click Find Now.
5. To clear the search results and return to view the entire log, click Clear
Search.
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:
123456789012345678901234567890123456789012345678901234567890123456789012
3456789012345678901234567890123456789012345678901234567890........
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
A log file contains the following entries:
Entry Description
Date Time 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.
Source of The DCM module identifier (application or library) from which this
Message message is being logged.
Log Level Log level setup for the calling application (INFO, WARNING, ERROR,
or DEBUG).
Caller Identifier The 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).

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, a
transaction output file grows 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 70 or the description of using the Device Wizard in
“Adding devices” on page 76. For more information about setting the transaction
output file rollover size, see “System Settings” on page 114.
A transaction output file contains the following information for each transaction:
• Date and Time
• Source
• Type String- type of message
Because the file records all transactions, you can 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 that 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.

Transaction output file format

The following table defines the format of transaction output files:
Offset Length Field Comments

0 1 cStatus Character number
1 20 Domain Domain (Group) for source device
21 15 DeviceId Native 6-digit address of device
36 1 DeviceType Type of device (P)eriodic, (D)irectConnect, and so on
37 1 Type Record type identifier (implementation defined)
38 3 Key Transaction Key (previously, Transaction Code)
41 8 Date Trx Date MMDDYYYY
49 6 Time Trx Time HHMMSS
55 1 DST Trx created during DST (1 or 0)
56 5 Timezone Timezone ID
61 1 Online Online indicator (1 or 0)
62 1 Delimiter Field delimiter for Data
63 - Data Beginning of Data (format depends on Type and Key)
Transaction output file example format

01234567890123456789012345678901234567890123456789012345678901234567890
|| | ||| | | || |||
#CA: Plant 132 10456 DAA 122519951530121 43950#|<--- Data begins here
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
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

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 system and is included in the host application
backup.
For more information on backing up data in your application, see your application
documentation.

Chapter 10
Using the Sentinel
This chapter provides an overview of the Sentinel and its functions.

• “Sentinel status monitoring” on page 271
• “Providing enhanced database connection support” on page 277
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 one 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 2003 and Windows XP Professional can launch the Sentinel as a
Windows 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 277.
The Sentinel performs the following tasks:
• Manages all the communication channels configured for processing on the
given system. The Sentinel Service starts, monitors, and stops the
communication channels.
• Manages all the application connections configured for processing on the
given system. The Sentinel Service establishes, monitors, and disconnects
application connections.
• Provides enhanced 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.

Overview
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.
• Monitors the DCM State Manager, which is a troubleshooting tool designed
for Kronos Global Support personnel.
• 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.
Sentinel startup
The Sentinel application starts the following processes:
• 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.
Communication channels
The Sentinel 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 terminals. Communication channel
executables run in the background and do not present any user interface.
Note: Before any of the DCM applications can run, the Workforce Central server
must be running. If you start the Sentinel too soon, DCM applications send a
warning and wait for the Web server to start.
The Sentinel establishes all the application connections configured for the local
system.
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 client’s database.
The application client, which is managed by the Sentinel, requires access to the
Workforce Central server during startup. If the server is not available, the
application client keeps punches in a .q or .qin file.

Sentinel status monitoring

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

• Establishes the application connections
• Monitors the application connections
• Disconnects the application connections
Monitoring communication channels and application connections

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

– 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. When 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.
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:
• 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.
• 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.
• Application Server configuration has not been
complete appears when the Workforce Central application server
connection has not been configured.
Editing the Sentinel Service properties

You can change the Sentinel Service database properties and the Sentinel Service
application server connection.
Editing the Sentinel Service database properties
To change the database that DCM uses to collect and store data:
1. Right-click the Sentinel icon and click Status. The Sentinel Service Status
window appears.
2. Click Properties. The Sentinel Service Properties dialog box appears.
3. Click the Database tab.

4. On the Database tab, edit the database Data Source Name, the user name, and
the password for an SQL Server database connection, or edit the database
Data Source Name, the System Identifier, the database server, and the port
number for an Oracle database connection.
5. Enter the password again to confirm it.
6. Click OK.
Editing the Sentinel Service application server properties
Caution: Collect all data before changing the information in the application
connection. Do this to avoid routing information to the wrong destination.
1. To change the application server connection properties: Right-click the

Sentinel icon and click Status. The Sentinel Service Status window appears.
2. Click the Application Server tab.
3. Select one configuration from the Available Configurations list box.
4. Click Select. The information in the Current Selection area of the screen
changes to reflect your selection.
5. Click OK.
You may use the Device Manager to change the name or the description of the
default application connection, create additional application connections, and
delete application connections.
Disabling the Sentinel

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 the
Sentinel, not a communication channel nor a DCM application.

Viewing the Sentinel log

To view the other Sentinel messages that appear in the DCM centralized log, click
View Log.
Sentinel shutdown
When the Sentinel shuts down, it shuts down all the communication channels that
it started on the local system, following this 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.
Shutting down and restarting the Sentinel Service

Avoid shutting down the Sentinel Service except for database conversions,
database backups, and software updates. When you back up your database:
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.
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 Central 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 wait for the Web server to start.

Providing enhanced database connection support
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.
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.


Chapter 11
Loading Files and Data to and from a Device
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 293.The upgrade process is a communication
operation that uses 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 device’s first-
in-first-out (FIFO) punch memory before the download process begins.
• “Upgrading Series 4000 Terminals” on page 280
• “Troubleshooting Series 4000 terminal softload problems” on page 291
• “Performing a Series 400 firmware upgrade” on page 293
• “Re-initializing after performing a softload” on page 294
• “Loading a device parameter file” on page 295
• “Extracting a parameter file” on page 296
• “Importing a parameter file” on page 297
• “Exporting a parameter file” on page 298
• “Synchronizing the date and time on the communication PC with all devices”
on page 299
Chapter 11 Loading Files and Data to and from a Device
Upgrading Series 4000 Terminals

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.
Kronos recommends that you upgrade your terminals whenever a new version of
the terminal firmware is released. Terminal firmware is packaged in a file whose
name indicates the version number of the firmware:
• Terminal firmware files for firmware versions 2.1.x and earlier have the file
extension .krm.
• Terminal firmware files for firmware versions 2.2.x and later have the file
extension .krl.
Note: The upgrade procedures apply to customers who use Workforce
Timekeeper as their Kronos host application. If you are using Timekeeper Central
or iSeries Central, contact your Service Representative or Kronos Global Support
for assistance with this procedure.This section contains the following topics:
• “Smart View functionality” on page 280
• “Preparing to upgrade Series 4000 terminals” on page 281
• “Performing a Series 400 firmware upgrade” on page 293
Smart View functionality

To upgrade Series 4000 terminals to version 2.2, softload the version 2.2
firmware. The Series 4000 firmware version 2.0 introduced the optional ability to
perform Smart View™ transactions (transactions that must access information
that is not resident at the terminal). To perform Smart View transactions, the
terminal must be equipped with a special flash disk and memory that holds the
firmware for Smart View capability.
• If the part number of the terminal is 8602000-xxx, you must order a Memory
Upgrade Kit that includes the required flash disk and memory. For more
information, contact your Kronos Representative.
• If the part number of the terminal is 8602004-xxx or 8602800-xxx, the flash
disk is already installed on the board.

To obtain the part number of the Series 4000 terminal, do either of the following
steps:
• Look at the bar code label on the bottom of the terminal (the underside of the
terminal as you look at the display and keypad). The part number is directly
above the bar codes.
• If the Series 4000 terminal uses firmware version 2.0 or higher, access
Maintenance mode at the terminal and run the Hardware Report. The part
number of the terminal is included in the report output on the screen.
Preparing to upgrade Series 4000 terminals

Before you begin upgrading Series 4000 terminals, note the following
information:
• 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 Device Manager in Data Collection Manager (DCM) to perform the
softload process.
Important: If you are not using DCM version 6.0, refer to the Series 4000
version 2.2 Release Notes to see the minimum release numbers of DCM
versions 4.8, 5.0, and 5.1 that you can use to load .krm or .krl terminal
firmware files.
• 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 information at the terminal while the softload is in progress.
• 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 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.

• To upgrade a Series 4000 terminal from a firmware version lower than 1.3 to
version 2.2, you must first softload firmware version 1.3. Then, softload
version 2.2.
• If you upgrade a Series 4000 terminal from firmware version 1.3 to version
2.2, the Telnet-FTP setting on the Comm Settings screen is set to “No”
regardless of what the setting was before you performed the upgrade. For
example, if the Telnet-FTP setting for your terminal was “Yes” before the
upgrade, the setting after the upgrade changes to No. After you upgrade the
terminal, change the Telnet-FTP setting to Yes.
If you upgrade a Series 4000 terminal from firmware version 2.0 to version
2.x, the Telnet-FTP setting does not change as a result of the upgrade.
Complete the following steps before softloading new firmware to your Series
4000 terminal:
1. Verify which firmware version your Series 4000 terminals are currently using.
Do this in either of the following ways:
– With the terminal in Maintenance mode, run the Device Status Report.
– If your host application is Workforce Timekeeper, use Device Manager
(DCM) to run Get Device Report.
Important: If the terminals are using a version of firmware lower than 1.3,
the upgrade procedure requires you to softload version 1.3, and then softload
version 2.2.
2. Contact your Service Representative or refer to the customer support section

of www.kronos.com to ensure that you obtain the latest version of the
firmware. If you are upgrading from a version of firmware lower than 1.3, you
also need to obtain the 1.3 firmware from your Service Representative.
3. If you want to upgrade a Series 4000 terminal that uses modem
communication, follow the instructions in this step. Otherwise, go to step 4.
– If you are using Data Collection Manager 5.1 or later, enable FTP on
the terminal. The FTP user name and password at the Series 4000
terminal must match the FTP user name and password that is specified for
that terminal in Device Manager > Setup > Device > Edit > Device
Password.

Series 4000 terminals with firmware versions 1.3.x and earlier have FTP
enabled and use the default user name and password. The Use Default
User ID and Password box should be checked.
Series 4000 terminals with firmware versions 2.0.x and later versions
have FTP disabled by default. You must access Maintenance mode at the
Series 4000 terminal and enable FTP using the Telnet-FTP setting on the
Comm Settings screen. You may also change the user name and password
from their default values. User names and passwords that you enter at
Series 4000 terminals can be only numbers and uppercase alpha
characters (if the terminal has an alpha-numeric keypad). Ensure that the
same user name and password that are set at the terminal, are also set in
DCM for that terminal.
4. Verify that the DCM Sentinel has been launched and that all Series 4000
communication channels are running.
5. Plan the best time to upgrade the terminal firmware with the following
information 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. Also, the softload process takes significantly
longer for terminals using modem communication than it does for
terminals using Ethernet communication. If the terminals are equipped
with the Kronos® Touch ID® verification devices, the process may take
longer. After the firmware is softloaded, the terminals restart themselves.
The restart process for each terminal generally takes 3 to 5 minutes to
complete. If a biometric verification device is attached to a Series 4000
terminal, the terminal takes 6 to 9 minutes to restart.
– 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

6. Use DCM to collect data from the terminal.

7. After you successfully complete this procedure, go to “Performing a Series
400 firmware upgrade” on page 293.
Series 4000 terminal upgrade procedures

Procedures include:
• “Upgrading Series 4000 terminals from version 1.3 firmware to version 2.2”
on page 284
• “Upgrading Series 4000 terminals to include Smart View functionality
(optional)” on page 286
• “Initializing Series 4000 terminals after you softload the firmware (required)”
on page 288
• “For Kronos 4500 Touch ID version 1.x users only: Sending biometric
templates to the Series 4000 terminals” on page 289
Caution: To ensure a successful softload, do not restart the terminal while it is in

Softload mode, and ensure that a constant network connection is established with
the terminal to which you will softload the firmware.
Upgrading Series 4000 terminals from version 1.3 firmware to version 2.2
Important: You cannot upgrade directly to firmware version 2.2 from a firmware
version lower than 1.3. If the terminal is currently using a firmware version lower
than 1.3, you need to perform two softloads: one to upgrade to version 1.3, one to
upgrade to version 2.2.
To upgrade from version 1.3 firmware to version 2.2, read and perform the
following steps carefully:
2. If your Series 4000 terminals are equipped with Kronos Touch ID verification
devices, you must collect the biometric templates from the terminals.

Note: If you are using a version of Kronos Touch ID software that is earlier
than 2.0, collect the biometric templates using the Kronos Touch ID version
1.x application according to instructions in the Kronos Touch ID Enrollment
Kit Installation and User’s Guide.
If you are using Kronos Touch ID version 2.0 or higher, use Data Collection
Manager (DCM) to collect the biometric templates from the terminals. Be
sure to select the Employee Biometric Data option as one of the download
options in DCM.
When you collect the biometric templates from the terminals, the template
information also remains resident in the finger scan verification devices so
that the terminals can perform biometric verification.
3. Access the DCM Device Manager application.
4. Select one or more Series 4000 terminals or device groups in the left pane of
the Device Manager window.
Note: If you select a device group that consists of a combination of Series

4000 and Series 400 terminals, you must select only the Series 4000 terminals
within the device group.
5. Select Communications > Advanced > Load Firmware. The Load

Firmware Name dialog box appears.
6. Browse to select the terminal firmware file that you received from your
Kronos Representative or from the Customer Support Web site. Use the
following guidelines:
– If the terminal currently uses a firmware version lower than 1.3, select the
version 1.3 .krm file. (You must load the 1.3 firmware before loading the
2.2 firmware.)
– If the terminal currently uses firmware version 1.3 or higher, select the
version 2.2 .krl file.

Important: If you are performing the softload using Microsoft Terminal

Services (Windows 2003) or Remote Desktop (XP Professional) client or
console session, the terminal firmware file must be located on a local,
unmapped drive on the DCM communication PC — for example, C:\. The
softload fails if the terminal firmware file is located on a network drive.
7. Click Open. DCM begins softloading the firmware to the selected Series
4000 terminal or device group. The screen on the Series 4000 terminal
displays text indicating the progress of the softload function.
8. After the firmware loads successfully:
– If you loaded the version 1.3 .krm file, go back to step 5 to perform
another softload. This time, select the version 2.2 .krl file.
– If you loaded the version 2.2 .krl file, proceed to the next step.
9. To upgrade the terminals to use the Smart View functionality, go to
“Upgrading Series 4000 terminals to include Smart View functionality
(optional)” on page 286.
To upgrade the terminals without the Smart View functionality, go to
“Initializing Series 4000 terminals after you softload the firmware (required)”
on page 288.
Upgrading Series 4000 terminals to include Smart View functionality (optional)
If you have upgraded Series 4000 terminals to firmware version 2.2, and want to
add Smart View functionality:
1. If you upgraded the terminal to 2.2 firmware and the terminal part number is
8602000-xxx:
a. Order the Memory Upgrade Kit that contains an M-SYSTEM flash disk
and 32 Mb SDRAM memory chip needed to support Smart View
functionality.
b. Follow the instructions that come with the Memory Upgrade Kit to install
the disk and memory chip.

If you purchased a terminal with version 2.2 firmware already installed, the
terminal is already equipped with the M-SYSTEM flash disk and SDRAM
memory chip necessary to support Smart View functionality.
3. If Series 4000 terminals are not equipped with Kronos Touch ID finger scan
verification devices, go to step 4.
If Series 4000 terminals are equipped with Kronos Touch ID finger scan
verification devices, you must collect the biometric templates from the
terminals.
Note: If you are using a version of Kronos Touch ID software that is earlier
than 2.0, collect the biometric templates using the Kronos Touch ID version
1.x application according to instructions in the Kronos Touch ID Enrollment
Kit Installation and User’s Guide.
If you are using Kronos Touch ID version 2.0, use Data Collection Manager
(DCM) to collect the biometric templates from the terminals. Be sure to select
“Employee Biometric Data” as one of the download options in DCM.
When you collect the biometric templates from the terminals, the template
information also remains resident in the finger scan verification devices so
that the terminals can perform biometric verification.
4. Using DCM Device Manager, select one or more Series 4000 terminals or
device groups in the left pane of the Device Manager window.
Note: If you select a device group that consists of a combination of Series

4000 and Series 400 terminals, you must select only the Series 4000 terminals
within the device group.
5. Select Communications > Advanced > Load Firmware.

6. In the Load Firmware Name dialog box, complete the following steps:
a. Browse to select the .krl file that you received from your Kronos
Representative or from the Customer Support Web site.

Important: If you are performing the softload using Microsoft Terminal

Services (Windows 2003) or Remote Desktop (XP Professional) client or
console session, the terminal firmware file must be located on a local,
unmapped drive on the DCM communication PC — for example, C:\. The
softload fails if the terminal firmware file is located on a network drive.
b. Click Open. DCM begins softloading the firmware to the Series 4000
terminal or device group you selected. The screen on the Series 4000
terminal displays text indicating the activities being performed by the
softload function.
7. Initialize the terminal. For instructions, go to “Initializing Series 4000
terminals after you softload the firmware (required)” on page 288.
Initializing Series 4000 terminals after you softload the firmware (required)
After you softload the firmware to the Series 4000 terminals, you must reinitialize
the terminals to restore configuration and employee information. To initialize the
Series 4000 terminals:
1. Ensure that you do not initialize terminals during the times when many
employees are performing transactions at those terminals (for example,
punching in or out for shifts). This ensures that the initialization process will
not adversely affect the results of those transactions.
2. Test the communications to the terminals 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 terminals, wait a few minutes
and try to communicate again.
3. From the Device Manager, select Communications > Set Date and Time
(optional for Series 4000 terminals).
4. Use the Device Manager to initialize the terminals, specifying device
configuration and other information that needs to be restored to the terminals
(for example, employees, labor level entries, and schedules).

Note: If the Kronos 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 intialization.
5. From the Device Manager, select Communications > Set Date and Time.
6. If the terminals you upgraded were configured for online data collection, the
terminals do not continue performing online data collection after the softload
process finishes. Use DCM to restart online data collection for those
terminals.
7. If your system uses Kronos 4500 Touch ID version 1.x, proceed to the next
section, “For Kronos 4500 Touch ID version 1.x users only: Sending
biometric templates to the Series 4000 terminals” on page 289.
For Kronos 4500 Touch ID version 1.x users only:

Sending biometric templates to the Series 4000 terminals
If any of the terminals that you upgraded are equipped with Kronos Touch ID
finger scan verification devices, you must send the biometric templates to the
verification device so that the terminal prompts employees for biometric
verification when they swipe in and out.
Note: You can perform this procedure for only one terminal at a time.
If you are using Kronos Touch ID version 1.4 or earlier:
To mark employees as enrolled and to send their biometric templates to the

terminal:
1. Using the Kronos Touch ID enrollment software, access Administration mode
and click the Services tab.
2. In the Service column, select the Kronos 4500 communication service.
3. Click Properties.
4. In the Clocks tab on the 4500 Communications screen, right-click the terminal
to which you want to send biometric templates.
5. On the shortcut menu, click Send templates.

6. Repeat this procedure for each upgraded terminal that is equipped with a
finger scan verification device.
If you are using Kronos Touch ID version 1.5:
To mark employees as enrolled and to send their biometric templates to terminals

that are equipped with finger scan verification devices:
1. Using the Kronos Touch ID enrollment software, access Administration mode
and click the Devices tab.
2. Do one of the following:
– In the list that appears, select one or more of the terminals that you
upgraded with new firmware.
or
– Use the Show devices for group drop-down list to select a device group.
Then, from the list that appears, select one or more of the terminals that
you upgraded with new firmware.
3. Click Download.
4. To send the finger scan templates to the selected terminal now, click Send
Now.
To wait to send the finger scan templates during the next scheduled
communication with the terminal, do not click Send Now from the list.
If you are performing this procedure by selecting device groups, repeat this
procedure for each device group.

Troubleshooting Series 4000 terminal softload problems
Troubleshooting Series 4000 terminal softload problems

This section presents information about Series 4000 terminal softload failures,
and hardware/firmware incompatibility.
Softload failure
If a communications or other error occurs during a Load Firmware operation to a

Series 4000 terminal, DCM eventually stops the Load Firmware operation and
displays or logs an error message, such as Softload failure while
file loading was in progress. The Series 4000 terminal displays the
Softload waiting for client message. From Device Manager, retry
the Load Firmware request to the terminal.
Caution: Do not remove power from the Series 4000 terminal while it displays
the Softload waiting for client message. This could result in the
inability to complete the Load Firmware operation, and require the Series 4000
terminal to be returned for repair.
Hardware/firmware incompatibility
If the hardware configuration of the terminal you are trying to upgrade is not
compatible with the firmware version you are loading, DCM displays error
messages. “Hardware configuration” refers to the version of the main board the
terminal uses, and the memory and flash disk that is installed.
An example of a hardware/firmware incompatibility error message is:
-906#Load Device#Softload failed preparing file activity
list for softload (011D8015), 770 - Incompatibility between
Device Hardware(SUPPORTED_400_SDRAM16M_0F8M_1F8MMIN) and
Requested Software(02.02.00.xx)##
where xx represents the build number of the terminal firmware.
The message states that the firmware you are trying to load to the terminal
(02.02.00.xx) is not compatible with the hardware configuration represented by:
SUPPORTED_400_SDRAM16M_0F8M_1F8MMIN

The following list describes the hardware configuration information that is

contained in the message:
• SUPPORTED indicates that the hardware configuration is valid.
• 400 is the model number of the main board of the terminal. (Other model
numbers are 407 and 415.)
• SDRAM16M indicates that there is 16MB of SDRAM.
• 0F8M indicates that flash disk 0 has 8MB of space.
• 1F8MMIN indicates that flash disk 1 is installed and has the minimum 8Mb of
space.
The hardware configuration is not valid for the terminal firmware version you are
trying to load.
When error messages pertaining to hardware/firmware incompatibility occur:
• Check and verify the memory configuration at the terminal.
• If you are unsure of which memory configuration is required for the firmware
version you want to load to the terminal, contact your Kronos Representative
for assistance.

Performing a Series 400 firmware upgrade
Performing a Series 400 firmware upgrade

DCM enables you to load firmware to a device.
Firmware always has one of the following extensions, based on the type of device:
• .kre—186 mainboard device program
• .krs—handheld device program
• .krn—177 mainboard device program
• .kra—Ethernet 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 DCM’s attempt to load the program was
unsuccessful, note the message number and check it in “Troubleshooting” on page
301 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.

Re-initializing after performing a softload

After you finish softloading the firmware to the devices, complete the following
steps:
1. From the Device Manager, select Communications > Test Device
Communications to 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). For more
information about Initializing, see “Initialization” on page 139.
Note: If the Kronos 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.

Loading a device parameter file
Loading a device parameter file

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.
Using parameter files, you can:
• 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, the device does not collect these punches. The parameter file
that you load to the device overrides the configuration that is stored in the device.
Use this load parameter file utility only if you are an advanced user.
To load a file to a device or group of devices:

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 DCM’s attempt to load the file was unsuccessful, note the message
number and check it in “Troubleshooting” on page 301 for help.

Extracting a parameter file

If you upgrade and 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:
2. From the hierarchical tree in the Device Manager main window, select the
device to extract the device configuration.
3. Select Communications > Advanced > Extract Device Parameters.
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 114.
Note: 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.
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
named of deviceID.imp. The Device Manager displays the return status
when processing is complete, including complete file locations.

Importing a parameter file
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 device configurations
that are stored in the database. Importing XML files is not supported.
To import a parameter file to the database:

2. From the hierarchical tree in the Device Manager main window, select the
device for which to import the configuration to the database.
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.

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

Synchronizing the date and time on the communication PC with all devices
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
DCM communication PC. DCM uses the date and time on the DCM
communication 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 DCM communication PC before sending this information to the devices.
Note: Before changing the date or the time on your DCM communication 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:
• Select all device groups as a shortcut to sending the date and time to all
communication channels and devices connected to the DCM communication
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 by using 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 and Time. The
Select Target to Set Date and Time dialog box appears.
2. Select All devices, Device group devices, or Device groups from the drop-
down list.
3. Select an individual device or device group, and click Set Date and 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 DCM’s attempt to send the date and time was unsuccessful,
see “Troubleshooting” on page 301 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.

Chapter 12
Troubleshooting
This chapter provides instructions to view software and hardware properties and
the procedures for solving problems that you encounter while using the Data
Collection Manager system. It describes the transaction output file and lists and
explains error messages.
• “Series 4000 terminal and configuration reports” on page 302
• “Troubleshooting procedures” on page 306
• “Optimizing Ethernet timeouts on busy networks” on page 321
• “Viewing application connections and communication channels” on page 322
• “Reading a transaction output file” on page 323
• “Labor level settings” on page 325
• “Troubleshooting with the Communication Monitor” on page 326
Chapter 12 Troubleshooting
Series 4000 terminal and configuration reports

You can capture Series 4000 terminal reports that contain certain information
about a device’s software configuration. A device report contains general
information about the hardware configuration and operating status of the Series
4000 terminal. A device configuration report provides specific information about
how the device was configured by the host application.
Viewing the Series 4000 terminal report

A device report lists the software versions, hardware configuration, database
information, and if applicable, biometrics information for a Series 4000 terminal.
To view or save the report:

1. From the Device Manager main menu, select a Series 4000 terminal. You may
run a device report for multiple devices by selecting a Device group or
Communications Channel.
2. Select Communications > Advanced > Get Device Report.
3. To view and save the device configuration file, click Yes. To save the device
configuration file without viewing it now, click No.
Note: If you selected multiple devices, you are not prompted to view the
reports.
You may also view reports by opening them in a text editor program from the
DCM\data\reports folder.
Note: Each time you run a device report, any previous device report for that
device is overwritten.
Resetting the Series 4000 terminal biometric report data

To set up a baseline for troubleshooting a Series 4000 terminal with biometric
hardware, you can reset the report data.

To reset the biometric report:

1. From the Device Manager main menu, select a Series 4000 terminal.
2. Select Communications > Advanced > Reset Device Biometric Report
Data.
3. Click Yes to confirm the reset or click No to cancel the reset.
Retrieving Series 4000 terminal configuration data

A device configuration report lists a Series 4000 terminal’s configuration data. To
view device configuration, you use a file that contains the required XML
command file to retrieve the configuration information from the Series 4000
terminal.
You can retrieve the following data by using the XML files located in the
\dcm\data\GetDeviceConfiguration directory:
• Employee information—getHomeEmployee.xml
Before you can get employee information, edit the
getHomeEmployee.xml file to specify the badge ID of the employee for
which you want to retrieve information. See the example on the next page.
• Labor level information—getLaborLevel.xml
Before you can get employee information, edit the getLaborLevel.xml
file to specify the badge ID of the employee for which you want to retrieve
information. See the example on the next page.
• Punch interpretation rules—getAllPunchInterpretationRules.xml
• Comment codes—getAllCommentCodes.xml
• Pay codes—getAllPayCodes.xml
• Device Work rules—getAllDeviceWorkRules.xml
• Bell schedules—getAllBellSchedules.xml
• Gate open schedules—getAllGateOpenSchedules.xml
• Gate off schedules—getAllGateOffSchedules.xml
• Accruals—getAllAccrualBuckets.xml

• Maintenance Mode Password—getMaintenanceModePassword.XML

• Supervisor Password—getSupervisorPassword.XML
To view device configuration data:
1. From the Device Manager main menu, select a Series 4000 terminal.
2. Select Communications > Advanced > Get Device Configuration. The Get
Device File Name dialog box appears.
3. Select the file that contains the required XML to retrieve the configuration
information from the Series 4000 terminal and click Open.
4. To view and save the device configuration file, at the prompt click Yes. To
save the device configuration file without viewing it now, click No.
The location of where the file is saved appears in the message area of the
Device Manager main window. The displayed report includes the location of
where the file is saved in the Address text box. For example,
C:\kronos\wfc\dcm\data\reports.
Note: Each report name includes the device ID of the specified device. If you
have previously run the same configuration report for that device, the new report
overwrites the previous report.
To specify the employee for the getHomeEmployee report:

1. Use a text editor such as notepad.exe and open the
getHomeEmployee.xml file.
2. Edit the text line that contains Record id = "1" to include the badge number of
the employee. For example, if the employee badge number is 123456789, edit
the line as follows:
Record id = "123456789"
3. Save the file as plain text with the .xml extension.
Note: Each XML file can contain return information for one employee only.
To specify the labor level entry for the getLaborLevel report:

1. Use a text editor such as notepad.exe and open the
getLaborLevel.xml file.

2. Edit the text line containing: Record llid="1" value="100" to include the labor
level number and labor level entry name of the labor level entry. For example,
if the labor level entry name is 301 and the labor level is level 3, edit the line
as follows:
Record llid="3" value="301"
3. Save the file as plain text with the .xml extension.
Note: Each XML file can contain return information for one labor level entry
only.

Troubleshooting procedures
The following sections provide troubleshooting procedures to solve common
problems within DCM:
• “Setup and configuration” on page 307
• “Operation/data collection modes” on page 315
• “System faults and recovery” on page 318
These sections list error information and the solutions using the following format:
• Problem—Description of problem
• Environment—Client PC (local device), network, host applications
• Solution—Client PC (local device), Ethernet, modem, and serial

Setup and configuration

PROBLEM: My client PC does not communicate with a device that I just created
and added to a device group.
Environment Solution
Serial device Check the following items concerning the serial communication channel
connection to the device:
1. Is the port set up properly?
• Is the baud rate/COM port set properly in the Device Manager?
• Is there a port conflict? Is another resource is trying to use the port at
the same time?
• Is the cable plugged in?
• Is the Smart Converter (if used) set up properly?
• Is the device ID correct in the Device Manager?
• Does the device model setting match the physical device?
2. Are the device/device settings set up properly?
• Does the baud rate match PC settings?
• 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:
• Check the boot prom and application firmware at the device.
• Test the device in the Device Wizard. If the test is successful, the
device has the correct boot prom and application firmware.

Ethernet device Check the following items for the Ethernet communication channel
connection to the device:
1. Is the Ethernet connection set up properly?
• Is there a conflict/error with the configuration of the Ethernet
interface on the PC? Verify that your Windows network settings are
configured correctly.
• In the Device Manager:
• Is the IP address correct? Make sure you are able to ping the device
by using that IP address.
• Is the cable plugged in?
• 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 set up properly?
• Is the IP address set at the device?
• Is the IP address being used by another network device?
Sentinel? If they are not running, restart them. Also, try stopping and
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:
• Check the boot prom and application firmware at the device.
• Test the device in the Device Wizard. If the test is successful, and
then the device has the correct boot prom and application firmware.

Modem device Check the following items for the Series 400 modem communication
channel link connection to the device:
1. Is the modem set up properly?
• In the Device Manager, check the following:
• Is the phone number where the device is located 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?
• Is the modem configured correctly? Refer to the modem manual.
• Is the telephone network functioning properly?
• Is the dial-up delay is excessive?
• Is the modem string correct?
Sentinel? If they are not running, restart them. Also try stopping and

Network, Serial Use an administrator’s PC to configure the settings for one or more
communication PCs.
1. Is the communication PC for the devices configured correctly for
network operation?
• Is there a conflict/error with the configuration of the Ethernet
interface on the PC?
• Are the Windows network settings configured correctly?
• Is the data collection computer name correct?
• Ensure that the proper computer name is assigned in the Windows
settings.
2. Is the communication PC functioning?
• Use Microsoft networking utilities to confirm that the
communication PC is in operation.
3. Is the administrator’s PC configured correctly?
• Is the computer name correct?
Ensure that the proper name is assigned in Windows settings at
the administrator’s PC.
4. Are the database location and/or location settings correct?
5. 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.
6. Is the administrator’s PC functioning properly?
• Use the Windows utilities to confirm general network operation.
PROBLEM: I get an error message such as “Comm driver error code [-4].”
Biometric device When you initialize two or more Series 4000 biometric devices with
only the download command “Employee with (or No) Schedules"
option selected, you may see a download failure for one or more of the
clocks if they are using firmware Version 1.3.3.2 or earlier.
If you observe this problem, upgrade the firmware for your Series
4000 terminals to Version 2.0.

PROBLEM: I get an error message such as “Comm driver error code [-6].”
Serial 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” on page 56 and “Registering a new communication
PC” on page 424.
PROBLEM: Since I installed a modem in my Series 4000 terminal, I am having

problems accessing my e-mail, browser, or other applications.
Series 4000 Check the configuration of the TCP/IP and redialing properties in your
terminal with a dial-up connection. Your dial-up connection may have the Use as
modem default gateway check box selected. For more information, see
“About dial-up networking” on page 47.
PROBLEM: During initialization of a Series 100 device, a communication

failure occurred.
Modem 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 56.

PROBLEM: I get database error messages whenever one of my DCM

applications attempts to read or write information.
Client PC 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. The DSN may not be correct. Check the ODBC settings in the
Control Panel.
3. The database that is a component of your system may exist in the
wrong location or may not exist.
Caution: The application database file contains application-specific
records. Unless you are 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
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. The connection may be broken. Use the Test Connection function
in the ODBC setup to check connectivity.
Network 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.
• The ODBC DSN is not configured to point to the proper location of
the database on the remote system.
• The database on the remote system is set as Read-Only.
• The database file is corrupted.

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.
Setup 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.
Database To enhance performance, do one of both of the following:
• If a segment of the network is particularly slow, move the database
to another location in the system.
• If the server PC is not fast enough, change servers.
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.
Database When the system tried to build an employee without schedules list for
download to the device, the database error message indicates:
• 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.
Setup 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 118.
PROBLEM: An attempt to process trx.in files by copying OUT files and re-
naming them results in all files being marked with a .failed extension on the
files. No punches are processed through the system.
Setup 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:
• 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.

Operation/data collection modes

PROBLEM: My log file contains messages that I am not familiar with. What do
these error messages mean?
Application Some error messages are logged for the WFCAPI integration into the
connection connection library (krdcmwfc4.dll). These error messages do not
appear on the user’s display. The following error messages are written
to the centralized log file in the data\logs\commpc subdirectory.
• 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 Smart Views
• Application Server failure or Network failure occurred
• Failed to add invalid transaction - Device ID

PROBLEM: I do not see any particular error messages but the application does
not appear to be receiving any transactions.
Environment Solutions
Application To verify that transactions are being collected at the device and
processing 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.
Application Use the Windows network tools (for example, Microsoft Explorer) to
processing 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.
PROBLEM: I am receiving error messages similar to the following:

Unable to post to transaction output file...

Unable to post to output queue file...
Application These errors usually indicate faults in the following areas:
processing • The application is not registered with the data collection system.
• The computer name is not correct. For more information, see
“Communication Channels” on page 37 and “Setup and
configuration” on page 307.
Do the following:
• 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.
• Be sure each PC in your data collection environment is accessible
and has sufficient disk space.
• Be sure each PC or server used for data collection has been set up
with access rights to the other PCs. See the Workforce Central Data
Collection Manager Installation Guide for more detailed
information.
• Use the Microsoft Windows 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.
System In the Communication Monitor, use the Device menu to enable or
monitoring disable the transactions to list.

System faults and recovery

PROBLEM: I 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.
Application On the Sentinel Service Status window, click Properties, correct the
processing 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.
Application Do the following:
processing 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.
Host Verify that the ...\kronoscm\dcm entry is in your path.
applications 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.
DCM Restart the application from the DCM menu to update the Workforce
applications Timekeeper cross-launch information properly.

PROBLEM: I received a socket notification sync error message and Windows

aborted the program that is running.
System In a system operating with one or more NIC cards, a socket notification
sync error may be generated and Windows aborts the program that is
running or waits to shutdown the computer.
Complete the following steps in order until the problem is corrected.
Do not complete more steps than are necessary to eliminate the error:
1. Update the application or service that is generating the error.
2. Update your computer's NIC device drivers and any other network
adapter drivers you may have on your computer. For more
information on updating device drivers, refer to Window's online
help about using the Device Manager or consult the documentation
that came with your hardware.
3. Check the TCP/IP setup of the computer and make sure that it is
installed and properly configured.
4. Update as many as possible of the services installed and running on
your computer. See the list of these services at Start > Settings >
Control Panel > Administrative Tools > Services.
5. Download and save the latest NIC driver. Go to Start > Settings >
Control Panel > Administrative Tools > Computer
Management > Device Manager > Network Adaptors.
6. Remove the NIC/network devices from the network device list and
then complete the following steps:
a. Shut down and turn off your computer and physically remove
your NIC/network hardware.
b. Reboot your computer and reinstall the drivers for the hardware
even though the hardware is not attached.
c. Shut down and turn off your computer.
d. Re-attach your network hardware in the computer.
e. Turn on your computer and follow the instructions for new
hardware in the configuration wizard.

PROBLEM: The device behaves unpredictably during updates or initialization.

The cause could be the use of non-ASCII characters.
Devices 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: I received an error message for a download after an initialization or

update, such as such as "Failed#Load Device#Error building the configuration
file(s)(01131008), -800##."
Application The Workforce Central application server was restarted and it is not yet
server fully running.
Wait several minutes to be sure the application server is running before
you initialize or update again.
PROBLEM: My softload failed.
Devices If a communications or other error occurs during a Load Firmware
operation to a Series 4000 terminal, DCM eventually stops the Load
Firmware operation and displays or logs an error message, such as
Softload failure while file loading was in
progress. The Series 4000 terminal displays Softload
waiting for client. From Device Manager, retry the Load
Firmware request to the terminal.
Caution: Do not remove power from the Series 4000 terminal while it
displays Softload waiting for client. This could result in
the inability to complete the Load Firmware operation, requiring the
Series 4000 terminal to be returned for repair.

Optimizing Ethernet timeouts on busy networks
Optimizing Ethernet timeouts on busy networks

When a PC is communicating with a device over an Ethernet network, the
standard Ethernet timeout setting 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.

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 “Collecting Data and Managing Transactions” on page 221.
For more information on the Sentinel, see “Using the Sentinel” on page 267.
If transactions are not picked up by the device, check the Sentinel to make sure
that the following components are operational for the device:
• 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.

Reading a transaction output file
Reading a transaction output file

The following example is a connect request that was posted to the transaction
output file:
123456789012345678901234567890123456789012345678901234567890123456789012
3456789012345678901234567890
(Date/Time) (Source) (Type String) (Type) (Pwd) (Data)
| | | | | |
04/17/1998 17:15:21 Ethera:SYSTEM12NT Connect 116 000001 555-
5555
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.
A transaction output file contains the following entries:
Entry Description
Date/Time 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 transaction output file.
Source Device group or communication channel that created and posted the
message to the transaction output 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.

Entry Description
Type String The type string consists of the different types of messages posted to the
transaction output file; they include the following types:
• 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 Numeric message type ID.
Pwd Device ID and password of the device.
Data 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

Labor level settings
Labor level settings

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 control this behavior globally or for specified
devices. For more information about .ini files, see “Modifying INI File Values”
on page 419.
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

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 “Collecting Data
and Managing Transactions” on page 221.
You track the following types of information when an event is processing:
• 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.

Chapter 13
Error Codes and Messages

• “Error messages” on page 328
• “Error messages from connecting to Workforce Timekeeper” on page 390
• “Error messages from a Series 4000 terminal” on page 392
• “Device error messages from a Series 400 device” on page 393
Chapter 13 Error Codes and Messages
Error messages
This section contains lists of error codes and messages for the Data Collection
Manager and their resolutions.
The following list provides a quick synopsis. For more information or further
assistance, contact your service representative.
Error Numbers Explanation

-1 to -22 Serial and Modem Error Codes
-23 to -29 Modem Error Codes
-30 to -65 Communication Driver/Type Independent Error Codes
-80 to -99 Polled Ethernet Error Codes
-100 to -240 Diagnostic Communication Channel Error Codes
-800 to -845 Configuration Service Error Codes
-900 to -905 Softload Error Codes
-1000 to -1200 Data Collection Manager Generic Error Codes
00000000 to 011DA803 Data Collection Manager Series 4000 Error Codes
Format
Communication channel error messages have the following format:
<error code>#{device}#<text>{optional text}#{file
name}#{phone number}{IP address}
Where:
<error code> is the error code.

{device} is the optional device ID.
<text> is the error text.
{optional text} is the optional error-specific text.
<file name> is the optional path and file name associated with the command that
was processed when the error occurred.

Error messages
<phone number> is the optional telephone number of the remote device(s) that is related
to the error.
<IP address> 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.
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, take one or more of the following actions:
• 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: In the following table, “See list above.” refers to these five actions.

Error
Code Text Description/Action
-1 No DSR (check cable) See list above.
-2 RTS ON; unable to transmit See list above. Check Smart Converter or hub
configuration.
-3 No DCD (receiver timeout) See list above. Check Smart Converter or hub
configuration.
-4 No STX (receiver timeout) See list above.
-5 Bad check-sum See list above.
-6 Bad sequence number See list above.
-7 Receiver timeout See list above.
-8 Short I-Frame (receiver See list above.
timeout)
-9 Bad character received See list above.
-10 No CTS (hand-shake timeout) See list above.
-11 DCD ON timeout See list above.
-12 Transmit failed See list above.
-13 No comm port Verify that the port exists and is enabled on the
communication channel PC. Also, see list above.
-14 I-Frame too long See list above.
-15 Status check failed See list above.
-16 Wrong device responded See list above.
-17 Attempt to send before device See list above.
EOT
-18 Device is not selected See list above.
-19 Receiver overrun See list above.
-20 Attempt to read device after See list above.
EOT
-21 Bad packet size See list above.
-22 Bad ETX See list above.

Error messages
Modem error codes
Modem devices generate the following error codes:
Error
-23 Modem fault; echoing Verify that the modem is properly configured and
connected to the telephone line. Retry the operation.
-24 Modem not ready Verify that the modem is properly configured and
-25 Modem dial failed 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.
-26 Carrier lost Verify that the modem is properly configured and
-29 Unrecognized error code Contact your service representative; <code> contains
[<code>] the unrecognized error code.
Communication driver error codes
Communication drivers generate the following error codes:
Error
-30 Model not initialized The comm driver does not determine the host
command offset because it was not initialized with
the device model family. Verify that there is only one
copy of DCM program files and libraries on the 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 the device model
family.

Error
-32 FIFO file not supported The comm driver does not drain the 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 the
PC. Reinstall everything, if necessary.
-33 Opening FIFO file The comm driver does not drain the FIFO of the
specified device because it does not open the
temporary punch file. Retry the operation; if
unsuccessful, contact your service representative.
-34 Device application not The comm driver does not perform a parameter save
running on the device in boot mode. Run the application in
the specified device and retry the operation.
-48 Host report not enough The comm driver tried sending a host report to a
memory 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.
-49 Host report invalid file The comm driver attempted to send a host report
with invalid characters (null, STX, or ETX).
Communication type independent error codes
Softloads generate error codes that are independent of communication type.
Error
-40 Unable to erase flash memory Retry; need to restart device.
-41 Unable to set softload mode Retry; need to restart device.
-42 Unable to read boot PROM ID Retry; need to restart device.
-43 Incorrect firmware file The improper firmware file was specified for
extension device model.
-44 Invalid firmware file extension The firmware file is *.kre, *.krn, *.krs,
or *.kra.

Error messages
Error
-45 No accessory board You can load *.kra files only to a device that
has an Ethernet port.
-46 Too many firmware blocks The program file (*.kre, *.krn, or *.krs)
contains more than 2 blocks. DCM does not
soft-load this program file.
-47 Unable to exit softload mode Send a parameter file to the device. If necessary,
cold-start the device.
File downloads generate error codes that are independent of communication type.
Error
-50 Unable to allocate AFT Shut down the Sentinel and restart.
memory
-52 Unable to open output file Verify write access to the indicated path.
-53 Unable to write to output file Verify write access to the indicated path.
-54 Unable to open <device- Verify write access to the indicated path.
id>_ERR.log file
-55 Unable to write to <device- Verify write access to the indicated path.
id>_ ERR.log file
-61 Too many reports specified 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.
-62 Comm unreliable, transfer Retry the operation.
aborted
-63 File contains invalid Check devicename_ERR.log.
commands For an explanation of the error codes in this file,
refer to “Device error messages from a Series
400 device” on page 393 later in this chapter.

Error
-64 Empty file The download file contains no commands or
report requests.
-65 Did not release all AFT Shut down the Sentinel and restart.
memory
Communication channel error codes

The communication channel generates error codes that are independent of
communication type.
Error
-100 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.
-101 Invalid argument The components of the DCM installation are
incompatible. Verify that you have proper versions
of all DCM components. Reinstall DCM, if
necessary.
-102 Invalid device ID Specify a valid six-digit device ID and retry the
operation.
-103 A device ID must be An operation was attempted that requires a device
specified ID to be specified. Verify that you have proper
versions of all DCM components. Reinstall DCM, if
necessary.
-104 Unable to open port Verify that the port exists and is enabled in
communication channel PC.

Error messages
Error
-105 Port is already open 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.
Shut down the Sentinel and restart.
-106 Transport is not available The device cannot send data via modem or Ethernet.
Try the following solutions:
• 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.
• Open the Sentinel Status window. Stop and then
start the device.
• 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.
-108 File does not exist Verify the location of the file at indicated path, and
that it has at least read access.
-109 Unable to delete The DCM system automatically retries and recover
transaction from this error. If this error persists or occurs
frequently, it indicates a problem with
communication or the device hardware.

Error
-110 Invalid transaction format This error is caused by one of the following:
• The device firmware version is incompatible
with DCM.
• DCM is attempting to collect “old” FIFO data
from the device.
• The device firmware versions (boot and app)
may not be compatible with DCM. If this is the
case, flush the device FIFO, reinitialize the
device configuration, and retry the operation.
Note: This results in loss of punch data.
-111 Invalid XML or syntax Validate the XML data file format, using a standard
error in XML data browser.
-112 Empty HTTP response or Retry the request.
no response from device
-113 Unable to load XML file to Verify that the device is operating and the
device communication channel is working.
-114 Error reported by series Retry the operation. Reboot if the retry fails.
4000 OS
4000 application
4000 communication
4000 configuration
services
4000 database processing
4000 diagnostics
-120 Unable to open data Verify ODBC configuration and drivers.
source/database
-121 Domain/device group not Shut down all DCM components and restart.
defined

Error messages
Error
-122 No devices in specified Use the Device Manager to add devices to the
domain/device group device group.
-123 Unable to add device to Shut down the Sentinel and restart.
communication channel
-124 Invalid port specified The components of the DCM installation are
incompatible. Verify that you have proper versions
of all DCM components. Reinstall DCM, if
necessary
-125 Unable to get required Shut down the DCM module that you are running,
value from DCM database and restart. If the problem persists, contact your
database administrator.
-126 Invalid DCM home path Stop and restart DCM.
-127 Invalid command The communication channel does not recognize the
specified command. Verify that there is only one
copy of DCM program files and libraries on the PC.
-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.
-129 Selected device is disabled Enable the device for communication.
-130 Error during data Refer to the centralized log file.
collection
-131 Invalid Transaction Refer to the centralized log file.
message
-132 Unable to reset mailbox Stop and restart DCM.
-135 Starting DC The communication channel does not start the data
collection thread. Exit DCM and application; reboot
and retry the operation. If unsuccessful, contact
your service representative.

Error
-136 Opening FIFO file for read 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.
-137 Writing bulk transaction Check the disc space and the DCM network
file during data collection settings.
-140 STATUS: Device Information only.
responding
-141 Device not responding Verify that the device exists on the network and is
running. Verify communication configuration
(serial parameters or IP address).
-142 Unable to download; Run data collection to retrieve all data from device,
device contains data and then retry the download.
-143 FAULT: Device put out of Too many comm errors have caused the
service communication channel to stop attempting to collect
data from the device.
-145 ERROR: Transport not The phone line is in use. The device with telephone
available. ##nnnnnnn number ##nnnnnnn is using the line to do a
currently has exclusive use collection. The device with telephone number
of line. Does not allow yyyyyyy cannot use the modem until the first device
yyyyyyy to hang it up. has finished the collection. Let the collection
complete and try again later.
-160 DCM post message The communication channel does not post messages
to DCM; as a result, data collection stops. Exit
DCM and the application; reboot and retry the
operation. If unsuccessful, contact your service
representative.
-161 FATAL: Output Multiple processes in the communication channel
Reentrancy 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.

Error messages
Error
-162 Connecting to config The communication channel loaded but does not
service completely connect to the configuration service
DLL to load a configuration or import an AFT file.
Verify that there is only one copy of DCM program
files and libraries on the PC. Reinstall everything, if
necessary.
-163 Loading config service The communication channel does not load the
configuration service DLL to load a configuration
or import an AFT file. Verify that the configuration
service file (KrCfgSvc.dll) exists.
-170 Invalid URI Error reported Stop the communication channel and the Data
by series 4000 Collection Agent. Reboot the device.
communication
-171 No Parser Memory Stop the communication channel and the Data
reported by series 4000 Collection Agent. Reboot the device.
communication
-172 XML Parse error reported Stop the communication channel and the Data
by series 4000 Collection Agent. Reboot the device.
communication
-173 No root object in XML Stop the communication channel and the Data
reported by series 4000 Collection Agent. Reboot the device.
communication
-175 Invalid END in XML Retry the operation.
document reported by
series 4000
communication
-176 Application protocol error Retry the operation.
reported by series 4000
communication
-178 Invalid XML tag name Retry the operation.
communication

Error
-179 Invalid XML packet Retry the operation.
communication
-180 Invalid session header Retry the operation.
communication
-181 No client buffers left Retry the operation.
communication
-182 Web client buffers Retry the operation.
exhausted reported by
series 4000
communication
-183 Client take resource failed Retry the operation.
communication
-184 Client give resource failed Retry the operation.
communication
-186 Flash write error reported Retry the operation.
by series 4000
communication
-187 Flash read error reported Retry the operation.
by series 4000
communication
-188 Wrong packet type error Retry the operation.
communication
-189 Client invalid request Retry the operation.
communication
-190 Client buffer overflow Retry the operation.
communication

Error messages
Error
-191 Client no server reported Reboot and retry the operation.
by series 4000
communication
-192 Client file error reported Reboot and retry the operation.
by series 4000
communication
-193 Client abort connection Reboot and retry the operation.
error reported by series
4000 communication
-194 Client abort general error Reboot and retry the operation.
communication
-195 Client queue request Reboot and retry the operation.
failure error reported by
series 4000
communication
-196 Client syntax error Retry the operation.
communication
-197 Client protocol error Reboot and retry the operation.
communication
-198 Client no resources error Reboot and retry the operation.
communication
-202 Failed to read COMM Retry the operation.
request reported by series
4000 application
-203 Missing attribute tag Retry the operation.
application
-204 Invalid verb reported by Retry the operation.
series 4000 application

Error
-205 Invalid object name Retry the operation.
application
-207 Invalid XML record Retry the operation.
application
-208 Failed to update Retry the operation.
configuration reported by
-209 Invalid configuration data Retry the operation.
application
-210 Transaction not supported Retry the operation.
application
-211 COMM aborted operation Retry the operation.
application
-212 Failed to lock database Retry the operation.
application
-213 Record not found reported Retry the operation.
by series 4000 application
-214 Failed to update FIFO Reboot and retry the operation.
status reported by series
4000 application
-215 Value out of range reported Check configuration parameters and retry the
by series 4000 application operation.
-216 Database full reported by Run a data collection operation on the device and
series 4000 application wait 5 to 10 minutes.
-217 Internal database error Contact your service representative.
application

Error messages
Error
-218 Client busy reported by Retry the operation.
-219 Failed to spawn task error Reboot and retry the operation.
-220 Message Queue send error Retry the operation.
-221 Message queue receive Retry the operation.
error reported by series
4000
-222 Out of memory error Run a data collection operation, and then retry the
reported by series 4000 OS original operation.
-223 Exceeded buffer size error Retry the operation.
-224 Unrecognized object error Retry the operation.
-225 Invalid parameter error Retry the operation.
-226 Symbol not found error Retry the operation.
-227 Symbol not found error Retry the operation.
-228 Device ID unknown error Check the device setup to validate the device ID.
-229 Invalid List error reported Retry the operation.
by series 4000
-230 Invalid packet type error Retry the operation.
-231 Invalid XML version ID Retry the operation.
communication

Error
-232 Series 4000 terminal has Consult your Series 4000 documentation and follow
reached set database the procedure to clean the database.
memory capacity
-233 Failed to read COMM Retry the operation.
request reported by series
4000
-234 Previous Load Firmware Verify that the agent is running. It the error persists,
request is still pending, stop the communication channel and retry the
please wait for that request operation.
to complete first.
-235 Boot cycle for the Wait at least three minutes for the device to boot
specified device has not before attempting any operation.
completed.
-236 Incompatible Series 4000 Use the proper vendor-specific device.
terminal type detected.
-240 XML files for series 4000 Retry the operation.
terminals cannot exceed
32K
Configuration service error codes

The configuration service generates the following error codes:
Error
-800 Unknown structure 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 the PC.

Error messages
Error
-801 Not app struct The configuration GUI requested information from
the host application for a data structure that the
host application does not recognize. Verify that the
are installed. Verify that there is only one copy of
-802 No app data Contact your service representative.
-805 Errors in building download The configuration service requested application
file with application data data to build the file, but received an error from the
application connection library. Look for error in
deviceID_ERR.log.
-806 Not implemented in The configuration service requested an application
application data item that is not supported by the application in
the connection library.
-810 Invalid argument The host application or configuration GUI failed to
supply one or more required arguments to a
configuration service API function. Verify that the
are installed.Verify that there is only one copy of
-811 No cfg session 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

Error
-812 Getting model info The configuration service was unable to obtain the
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 the PC.
Verify that the DCM database is current and
properly referenced. Reinstall everything, if
necessary.
-813 Cannot determine device ID The configuration service was unable to determine
the device ID (password) by querying the DCM
database with a device name. Use the Device
Manager to verify that a device exists in the DCM
database with a given device name.
-814 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.
-815 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.
-816 Connecting to model DLL The configuration service loaded but was unable to
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.
-817 Model DLL does not support An incorrect model DLL was loaded for the
model specified device. Verify that there is only one copy
of the DCM program files and libraries on the PC.
necessary.

Error messages
Error
-818 Model DLL not accessible 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.
-819 Freeing model DLL 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.
-820 Opening DB 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.
necessary.
-821 ERR:Writing to DB 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
necessary.
-832 Writing cfg file The configuration service was unable to write to
the AFT output file. Exit DCM and the
application: reboot, and retry. If the error persists,
-833 Opening input file The configuration service was unable to open the
AFT input (import) file. Verify that the import file
exists. If it does, exit DCM and the application;
-834 Reading Input File 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,

Error
-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.
-841 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;
-842 Cannot add lab field to list 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.
-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.
-844 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.

Error messages
Error
-845 Labor entries list size The configuration service returned an error while
exceeded 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.
-850 kErrMemoryException The configuration service returned an error while
building a download file. Retry the operation.
-851 kErrCreatingExportObject 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.
-852 kErrCreatingAppAwareObje The component of the configuration service that
ct defines how to build a configuration that is
compatible with the host application could not be
loaded into memory. There may not be enough free
memory on the PC.
-853 kErrCreatingStdProximity 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.
-854 Config service error in The configuration service returned an error while
building download building a download file. Retry the operation.

Softload error codes

The Softload application is available with Series 4000 terminals. It generates the
following error codes:
Error
-900 Invalid reply XML file format Make sure communication is working, and try
the softload again.
-901 Invalid manifest file format The *.krm file is not correctly formatted.
Replace the file with a new copy.
-902 Incompatible file version The *.krm file is not correctly formatted.
Replace the file with a new copy.
-903 Error during file upload Make sure communication is working, and try
the softload again.
-904 Authentication failed Make sure communication is working, and try
the softload again.
-905 Device cannot reboot Unplug the device and reboot. If you need
further assistance, contact your service
representative.
For more information about the Softload application, see “Loading Files and Data
to and from a Device” on page 279.
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
-1000 Error adding the application to Internal error. Retry the operation. If the error
the Data Collection Manager reoccurs, contact your service representative.
registration table

Error messages
Error
-1001 Error removing the application Internal error. Retry the operation. If the error
from the Data Collection reoccurs, contact your service representative.
Manager registration table.
-1002 The selected application has not Internal error. Retry the operation. If the error
been registered for use with the reoccurs, contact your service representative.
Data Collection Manager.
-1003 An invalid application handle Internal error. Retry the operation. If the error
has been specified. reoccurs, contact your service representative.
-1004 Invalid data field received Internal error. Retry the operation. If the error
reoccurs, contact your service representative.
-1005 No records found in the Internal error. Retry the operation. If the error
application input queue reoccurs, contact your service representative.
-1006 The application has not properly Internal error. Retry the operation. If the error
initialized with Data Collection reoccurs, contact your service representative.
Manager
-1007 An unregistered Comm Channel Internal error. Retry the operation. If the error
was found in the Data Collection reoccurs, contact your service representative.
Manager database.
-1008 Error opening the Data Check that the database is connected, that the
Collection Manager data source ODBC System DSN for the Data Collection
Manager is correct, and that the database user
name and password are correct.
-1009 This application has already Internal error. Retry the operation. If the error
initialized the connection with reoccurs, contact your service representative.
Data Collection Manager.
-1010 An invalid group name has been Enter a valid device group name and retry the
specified. operation.
-1011 An invalid application name has Internal error. Retry the operation. If the error
been specified. reoccurs, contact your service representative.
-1012 Only one group per application. Internal error. Retry the operation. If the error

Error
-1013 No devices found in the given Assign devices to the specified group or
group specify another device group and retry the
operation.
-1014 An invalid device ID has been Specify a valid six-digit device ID and retry
specified the operation.
-1015 No database has been specified. Internal error. Retry the operation. If the error
-1016 An invalid message type has Internal error. Retry the operation. If the error
-1017 The specified group is already Internal error. Retry the operation. If the error
being accessed. reoccurs, contact your service representative.
-1018 The specified file does not exist. Ensure that the file name is correct and that
the file is in the specified location, and retry
the operation.
-1019 Unable to copy the specified file Check the following:
for download. • Available disk space
• Share rights to the directory
-1020 An invalid path has been Internal error. Retry the operation. If the error
specified. reoccurs, contact your service representative.
-1021 No message read procedure has Internal error. Retry the operation. If the error
-1022 Error starting the specified Disable and enable the Sentinel. Contact your
Comm Channel service representative if this problem
reoccurs.
-1023 An invalid Comm Channel has Internal error. Retry the operation. If the error
-1024 Error stopping the specified Internal error. Retry the operation. If the error
Comm Channel reoccurs, contact your service representative.
-1025 The specified phone number Specify a telephone number that matches the
does not exist in the Data number assigned to one of the devices that
Collection Manager database. you are attempting to connect to, and retry the
operation.

Error messages
Error
-1026 The Data Collection Manager Check that the database is connected, that the
database is not open. ODBC System DSN for the Data Collection
-1027 The specified device already Internal error. Retry the operation. If the error
exists. reoccurs, contact your service representative.
-1028 The current program is not set up Internal error. Retry the operation. If the error
with Data Collection Manager as reoccurs, contact your service representative.
an application.
-1029 Unable to write to the transaction Check the following:
output file • Available disk space
• Access rights to the DCM\data directory
-1030 Unable to open the queue file Check the following:
• Available disk space
-1031 Unable to mark the current Check the following:
record for delete • Available disk space
-1032 Unable to write empty records to Check the following:
the queue file • Available disk space
-1033 Unable to access the required Check the following:
location in the queue file • Available disk space
-1034 Unable to write to the queue file Check the following:
-1035 Unable to read from the queue Check the following:
file • Available disk space
-1036 No queue name specified Internal error. Retry the operation. If the error

Error
-1037 Error allocating required Internal error. Retry the operation. If the error
memory reoccurs, contact your service representative.
-1038 Error locking required memory Internal error. Retry the operation. If the error
block reoccurs, contact your service representative.
-1039 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
-1040 Error accessing tables in the Check that the database is connected, that the
-1041 Error editing records in the Data Check that the database is connected, that the
Collection Manager database ODBC System DSN for the Data Collection
-1042 Error adding records in the Data Check that the database is connected, that the
Collection Manager database ODBC System DSN for the Data Collection
-1043 Error updating records in the Check that the database is connected, that the
-1044 Error deleting records from the Check that the database is connected, that the
-1045 No records found in the given Internal error. Retry the operation. If the error
database table reoccurs, contact your service representative.
-1046 End of the current record set has Internal error. Retry the operation. If the error
been reached. reoccurs, contact your service representative.

Error messages
Error
-1047 Unable to rename the given file Check the following:
name • Available disk space
• Access rights to the DCM/data directory
• Specification of the input path
-1048 Unable to open the given file Check the following:
-1049 The requested application is Internal error. Retry the operation. If the error
already being used. reoccurs, contact your service representative.
-1050 Invalid type specified for PC Internal error. Retry the operation. If the error
name validation reoccurs, contact your service representative.
-1051 Invalid location specified for PC Internal error. Retry the operation. If the error
name validation reoccurs, contact your service representative.
-1052 Error writing to log file Check the following:
-1053 Invalid destination key specified Internal error. Retry the operation. If the error
for message reoccurs, contact your service representative.
-1054 Invalid input path has been Internal error. Retry the operation. If the error
specified reoccurs, contact your service representative.
-1055 Invalid output path has been Internal error. Retry the operation. If the error
-1056 Duplicate message found in Internal error. Retry the operation. If the error
message queue reoccurs, contact your service representative.
-1057 No message found in message Internal error. Retry the operation. If the error
queue reoccurs, contact your service representative.
-1058 Invalid request type specified Internal error. Retry the operation. If the error
-1059 No list items found in the given Internal error. Retry the operation. If the error
list reoccurs, contact your service representative.
-1060 No more items left in the given Internal error. Retry the operation. If the error

Error
-1061 Invalid device group specified Enter a valid device group name and retry the
operation.
-1062 Specified device is not assigned Assign the devices to an specified device
to any group. group or specify another device group, and
retry the operation.
-1063 Specified device is not assigned If the device that you specified is not assigned
to any device group. to any device group, check the configuration
of the device groups and assign the device to
an appropriate device group.
-1064 Unable to open registry key Internal error. Retry the operation. If the error
-1065 Unable to set registry value Internal error. Retry the operation. If the error
-1066 Unable to get registry value Internal error. Retry the operation. If the error
-1067 Error starting the application Stop and start the Sentinel Service. Contact
connection your service representative if this problem
reoccurs.
-1068 Error stopping the application Internal error. Retry the operation. If the error
connection reoccurs, contact your service representative.
-1069 Unable to remove existing file Check the following:
-1070 Input buffer size is too large for Internal error. Retry the operation. If the error
the request reoccurs, contact your service representative.
-1071 The specified device group still Internal error. Retry the operation. If the error
has devices assigned to it. reoccurs, contact your service representative.
-1072 The specified group still has Internal error. Retry the operation. If the error
devices assigned to it. reoccurs, contact your service representative.

Error messages
Error
-1073 Unable to connect with the Validate that the following items are included
specified application connection in the DCM communication PC system path:
library \kronoscm\dcm
\kronoscm\lib directory
-1074 Invalid device name specified Specify a valid device name and retry the
operation.
-1075 Invalid device ID specified Specify a valid six-digit device ID and retry
the operation.
-1076 Invalid model ID specified Internal error. Retry the operation. If the error
-1077 Specified communication Internal error. Retry the operation. If the error
channel already exists reoccurs, contact your service representative.
-1078 No IP address specified 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.
-1080 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.
-1081 No port name specified 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.
-1082 No baud rate specified 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.

Error
-1083 No modem name specified A modem name is required when you add a
the Device Manager. Select a modem name
from the Modem string list.
-1084 No modem string name specified A modem string is required when you add a
the Device Manager. Specify a modem string.
-1085 No group specified 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.
-1086 Invalid communication method If the communication method you specified is
specified not the correct one for the added device,
select the correct communication method:
Ethernet, modem, or serial.
-1087 No transaction table specified Internal error. Retry the operation. If the error
-1088 Device cannot be removed, it is The device is the only device assigned to a
still being used by the group that still has employees assigned to it.
application. Please check to see Reassign employees to another device group,
if employees are still assigned to and then try removing the device again.
it.
-1089 The specified device does not Select a device that has a printer attached to
have a printer attached to it. it, or add a printer to the specified device, and
then try printing again.
-1090 Unable to connect to the Validate that the following items are included
Configuration Service library in the DCM communication PC system path:
\kronoscm\dcm
\kronoscm\lib directory
-1091 No application update state Internal error. Retry the operation. If the error
found for specified device group reoccurs, contact your service representative.

Error messages
Error
-1092 The selected group still has All employees must be removed from this
employees assigned to it. All group before it can be deleted. Make sure that
employees must be removed the device group that you remove is not the
from this group before it can be last device group associated with the host
deleted. application. Also, make sure that all devices
have been removed or reassigned before
attempting to remove the device group.
-1093 The model types cannot be You are unable to copy the device settings
different when editing or from a device of one model type to a device
copying a device. of a different model type. Make sure that the
model types are the same when copying
device settings from one device to another.
-1094 The specified host PC name was Internal error. Retry the operation. If the error
not found in the database. reoccurs, contact your service representative.
-1095 A local host PC cannot be You have specified a local PC for a network
specified in a network installation of the Data Collection Manager.
environment. Enter a network path to a DCM
communication PC.
-1096 A network host PC cannot be You have specified a network host PC for a
specified in a local environment. local installation of the Data Collection
Manager. Enter the name of the local PC.
-1097 Invalid application user The user does not have DCM access rights
defined for the specified application. See your
supervisor.
-1098 Invalid library handle specified Internal error. Retry the operation. If the error
-1099 Unable to retrieve database The database information is inaccessible.
information Check the database connection or the ODBC
setup.
-1100 Invalid password specified The password that you entered is not correct.
Enter the correct password.
-1101 User does not have the proper The user does not have DCM rights to
DCM access rights. perform the operation. Modify the user’s
access profile and retry the operation.

Error
-1102 Improper application licensing The host application that you are trying to run
does not have a proper license.
-1103 Invalid application code DCM internal error.
specified
-1104 Initialization error on the The connection library is unreacheable.
connection library Check the database connection. If the
database is running, DLLs are missing.
Contact your service representative.
-1105 XLaunch request failure Internal error. Retry the operation. If the error
-1106 Instance of XLaunched DCM internal error.
application already exists
-1107 Invalid device group specified Specify a valid device group and retry the
operation.
-1108 Specified group contains devices 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.
-1109 Authentication service failure The information in the Service.Properties file
is invalid.
-1110 Invalid Oracle MERANT driver The MERANT drivers are not properly
license licensed. Update the license.
-1111 Invalid communication status Internal error. Retry the operation. If the error
-1112 Transaction posted to invalid The transaction received from the device
transaction table contains incorrect information. View and
correct the invalid transaction by using the
Transaction Data Editor accessed from the
Tools menu in the Communication Monitor.

Error messages
Error
-1113 Invalid Download Options You have specified an Update command in
specified for Device Update. The the Communication Monitor or the Device
download options for this device Manager with device configuration specified
must be modified to specify as the only download option.
more than just the device If you send device configuration information
configuration for an update to the device, use the Initiate command in the
request. Communication Monitor or the Device
Manager. To send information other than
device configuration to the device, use the
Update command.
-1114 Transaction record exceeded A transaction record was longer than 2048
maximum length and was not characters and could not be successfully
processed. collected. Contact your service
representative.
-1115 Invalid MERANT driver license Contact your service representative.
-1116 Transaction record less than A transaction record was less than 64
minimum length and was not characters and could not be successfully
processed. collected. Contact your service
representative.
-1117 An invalid IP address has been Verify the IP address format. Do not use
specified. IP address octets must leading zeroes for Series 4000 terminals.
be a valid number between 0 and
255
-1118 The specified IP address has Enter a different IP address.
been used by another device,
please enter a different IP
address.
-1119 Exceeded the maximum number Consult the DCM documentation for device
of serial devices limits.
of modem devices limits.
of peer devices limits.

Error
of Ethernet devices limits.
-1125 Queue Message is null Internal error. Retry the operation. If the error
-1126 Queue Message is internal Internal error. Retry the operation. If the error
-1127 Invalid installation information The system registry has been edited or
(Product ID) corrupted. Reinstall Data Collection Manager
Software.
-1128 Hard failure partially through Internal error. Retry the operation. If the error
processing Bulk. reoccurs, contact your service representative.
-1129 General SecDLL error Internal error. Retry the operation. If the error
-1130 Requested API was not found Internal error. Retry the operation. If the error
-1131 Unsupported Encryption Type Internal error. Retry the operation. If the error
-1132 Overflow of string buffer. Internal error. Retry the operation. If the error
-1133 Error starting the Collection Stop and start the Sentinel Service. Contact
Agent your service representative if this problem
reoccurs.
-1134 Device is incompatible with Verify the compatibility of devices on the
Communication Channel type communication channel.
-1135 Critical authentication failure Internal error. Retry the operation. If the error
-1136 Logon authentication failure Internal error. Retry the operation. If the error
-1137 Incompatible DCM database If you are using the Workforce Central
version system, upgrade your DCM installation to
match the current version of WFC. If using
DCM Standalone, ensure all DCM
installations are at the same revision.

Error messages
Error
-1138 UpdateClients, unsuccessful Internal error. Retry the operation. If the error
viewer request to Collection reoccurs, contact your service representative.
Agent, unable to convert status
-1139 Database Error: Unable to find Internal error. Retry the operation. If the error
the SEQ_NAME record for this reoccurs, contact your service representative.
application in the SEQUENCE
table
-1140 ODBC Error(08002): Contact your database administrator to check
Connection is in use on the maximum number of connections
available to the database.
-1141 Internal error. Retry the operation. If the error reoccurs,
-1142 Internal error. Retry the operation. If the error the reoccurs,
-1144 Application server failure. Ensure that the Workforce Timekeeper
application server is running.
-1145 No dial-up network connection Ensure that Series 4000 modem
is specified for a Series 4000 Communication Channels have a valid dial-
modem terminal Communication up network connection specified in Device
Channel. Manager > Setup > Communication
Channels.
-1146 No dial-up network connection Create a dial-up network connection for
found in the phone book Series 4000 modem devices as specified in
specified for Series 4000 modem “Communication Channels” on page 37.
terminals.
-1147 No Host Name specified for this Specify a valid Host Name or IP address for
device. the device in Device Manager > Setup>
Device Wizard.
-1148 Duplicate Host Name specified Ensure that each device has a unique Host
for this device. Name or IP address specified in Device
Manager > Setup > Device Wizard.

Error
-1149 Host Name for this device The IP address returned for this device based
resolves to an IP Address on its DNS name is already assigned to
assigned to another device another device in DCM. Contact your
network administer to determine which
device should have this IP address.
-1151 Unable to connect to database. The specified database was created using
The specified database is an Workforce Record Manager and cannot be
Archive. used with DCM. Contact your system
administrator to change the DCM data source
DSN to point to the production database.
-1153 Unable to validate DCM Reboot the DCM communication PC. If the
Standalone license - Vendor error persists, contact your service
daemon not running. representative.
-1154 Unable to validate DCM Reboot the DCM communication PC. If the
Standalone license - License error persists, contact your service
server not running. representative.
-1155 Missing properties file for a Language properties files for the selected
specific language. language is not in the properties directory.
-1156 Improper language file Properties files may have been deleted or
configuration. moved. Reinstall DCM to restore properties
files.
-1157 Unable to read from the The DCM Comm client was unable to find a
requested file. 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.

Error messages
Error
-1158 Unable to open the requested A properties files may have been deleted or
DCM properties file. moved. Reinstall DCM to restore properties
files.
-1159 Unable to read information from A property file read error was encountered.
the requested DCM properties Reinstall DCM to restore properties files.
file.
-1160 Internal error. Property file read error was encountered.
Reinstall DCM to restore properties files.
-1161 Unable to open the Data Verify that the database server is running and
Collection Manager database. that the Data Collection Manager data source
Please verify that the data base has been properly configured. Be sure that
server is running and the Data sufficient database connections are
Collection Manager data source configured.
has been properly configured. It
is also possible that there are
insufficient database connections
configured.
-1162 Specified device is not assigned Internal error. Retry the operation. If the error
to the specified group. reoccurs, contact your service representative.
-1163 Invalid Syntax. Internal error. Retry the operation. If the error
-1164 Error writing to properties file. A property file write error was encountered.
Reinstall DCM to restore properties files. If
the error reoccurs, contact your service
representative.
-1165 Error backing up the properties Internal error. Retry the operation. If the error
file. reoccurs, contact your service representative.
-1166 Error setting the value for the Internal error. Retry the operation. If the error
key. reoccurs, contact your service representative.
-1167 Error getting the value for the A property file error was encountered.
key. Reinstall DCM to restore properties files.
-1168 Firmware file is incompatible Use the proper firmware and retry the
with device type. operation. If the error reoccurs, contact your

Error
-1169 Unable to write out requested Check access rights on all DCM-related disk
Device Report file drives. If the error reoccurs, contact your
-1170 Requested DCM process not Internal error. Retry the operation. If the error
found reoccurs, contact your service representative.
-1170 Requested DCM process not Internal error. Retry the operation. If the error
found reoccurs, contact your service representative.
-1171 Error posting request to DCM Internal error. Retry the operation. If the error
Message Processing Agent reoccurs, contact your service representative.
-1172 Request object is not found in Internal error. Retry the operation. If the error
-1173 Specified device was not found Internal error. Retry the operation. If the error
-1174 Error adding a device state Internal error. Retry the operation. If the error
-1175 Error removing a device state Internal error. Retry the operation. If the error
-1176 Device state list is full Internal error. Retry the operation. If the error
-1177 Error retrieving a device state Internal error. Retry the operation. If the error
-1178 Unable to access the Device Internal error. Retry the operation. If the error
State server reoccurs, contact your service representative.
-1179 Error reading FIFO file Internal error. Retry the operation. If the error
-1180 Error accessing allocated Internal error. Retry the operation. If the error
required memory reoccurs, contact your service representative.
-1181 Invalid collection method Internal error. Retry the operation. If the error
-1182 Invalid key value was provided Internal error. Retry the operation. If the error
for search reoccurs, contact your service representative.

Error messages
Error
-1183 Internal DCM Error Internal error. Retry the operation. If the error
-1184 Specified Communications port Internal error. Retry the operation. If the error
is unavailable reoccurs, contact your service representative.
-1185 Specified Communications port Internal error. Retry the operation. If the error
is being used by another reoccurs, contact your service representative.
communications Channel
-1186 Invalid Communications Port Internal error. Retry the operation. If the error
-1187 Sentinel Service is not running Start the Sentinel Service. Retry the
operation. If the error reoccurs, contact your
-1188 Message Processing Agent A request was made to the collection agent,
returned error for the given which could not process the request. Use
command. details of error message to take further action.
You can also disable and enable the Sentinel
and retry the operation.
-1189 Message Processing Agent Use the DCM Collection Agent transport log
returned non-200 HTTP status to get details about the error:
code. 1. In the krdcm.ini file, add or edit the
following lines:
[dcm collection agent]
transportlog=1
2. Disable and enable Sentinel.
3. The transport log is in the dcm ..\data\logs
directory.
-1190 Message Processing Agent The server, while acting as a gateway or
returned got a 502 HTTP status proxy, received an invalid response from the
code (some error in upstream server that it accessed in attempting
proxyservlet...can’t get to CA?) to fulfill the request. Disable and enable the
Sentinel and retry the operation.

Error
-1191 FIFO file was corrupted FIFO processing detected invalid punch data.
If the error reoccurs, contact your service
representative.
-1192 DCM WebServer type (secure Reinstall DCM.
install) is not IIS or Apache.
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
00000001 Communication error Unable to communicate with Series 4000
terminals. 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 communication PC. Retry the
operation.
00000002 Series 4000 HTTP server Retry the operation. If the error reoccurs,
error contact your service representative.
00000003 DCM file error 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.
00000004 Series 4000 Message 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 392.

Error messages
Error
00000005 Unable to determine DCM Contact your network administrator to ensure
PC IP Address that the DCM communication PC has a valid
IP address or DNS name assigned to it.
00000007 DCM internal error Internal Error. Retry the operation. If the error
the reoccurs, contact your service
representative.
00000009 DCM unknown error Internal Error. Retry the operation. If the error
the reoccurs, contact your service
representative.
00000029 Comm Channel is not A required communication channel was not
running, attempting to running and will be started by the DCM
restart Sentinel Service. If the communication
channel is not restarted successfully, and
additional error message is displayed, contact
your service representative.
0000002D Unable to Softload device - The krm file contains an invalid entry. Check
bad line in Softload the format for each line in the file.
manifest file
0000002E Communication Error A communication failure occurred between
DCM and a Series 4000 terminal. A
connection to the devices cannot be opened.
00000101 Device not found in device Retry the operation. If the error reoccurs,
list contact your service representative.
00000102 DNS lookup failed and no This device is configured to use a DNS name
saved IP for this device 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 Communication PC and the
DNS server are properly configured.
00000103 Device model is The specified device is not compatible with
incompatible with installed Workforce Timekeeper. Contact your service
application representative to replace the device.

Error
00000104 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.
00000107 Device model does not The selected device model does not support
support Load Firmware 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.
00000109 Invalid file or filename The specified file does not exist. Check the file
path and name and retry the operation.
0000010A File does not exist The specified firmware file does not exist.
Check the file path and name and retry the
Load Firmware operation.
0000010B Unable to connect to Contact your database administrator to ensure
database that the DCM database source, name, and log
on settings are correct and that the database
server is operating properly.
0000010C Error occurred trying to An internal error occurred. Retry the
start or access application operation. If the error reoccurs, contact your
0000010D Error occurred trying to An internal error occurred. Retry the
access device list operation. If the error reoccurs, contact your
0000010E Error occurred trying to An internal error occurred. Retry the
create the Device List operation. If the error reoccurs, contact your
Object service representative.
0000010F Error setting the An internal error occurred. Retry the
configuration session operation. If the error reoccurs, contact your
00000110 Error closing the An internal error occurred. Retry the
configuration session operation. If the error reoccurs, contact your

Error messages
Error
00000111 Failure trying to derive a An internal error occurred. Retry the
class from a base class operation. If the error reoccurs, contact your
00000112 Device is disabled The specified device is disabled. Enable the
device by using Device Manager > Setup >
devices or select an enabled device and retry
the operation.
00000113 File access denied (check The current user does not have rights to access
permissions) the selected firmware download file. Contact
your network administrator to provide the
appropriate access rights, and retry the
operation.
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.
00000115 API Error: Required file An internal error occurred. Retry the
specification was not operation. If the error reoccurs, contact your
provided in API call service representative.
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
00000117 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.
00000118 Error occurred trying to An internal error occurred. Disable and Enable
create the Group List the DCM Sentinel Service, and retry the
Object. operation. If the error reoccurs, contact your
00000119 Error retrieving An internal error occurred. Disable and Enable
Communications PC IP the DCM Sentinel Service, and retry the
Address from database. operation. If the error reoccurs, contact your

Error
0000011A Sentinel Service request An internal error occurred. Disable and Enable
error. Restart the Sentinel the DCM Sentinel Service and retry the
Service or reboot. operation. If the error reoccurs, reboot the
DCM Communication PC. If the error
0000011B Sentinel Service response An internal error occurred. Disable and Enable
error. Restart the Sentinel the DCM Sentinel Service, and retry the
0000011C Sentinel Service finish An internal error occurred. Disable and Enable
0000011D Sentinel Service mutex An internal error occurred. Disable and Enable
00000121 Sentinel Service is not A database connection could not be made.
ready.
00000122 Unable to establish a Verify that the application server is running.
connection to the Start it if it is not running.
application server. Please
verify that the application
server has been started, and
is running.
00000123 Error opening the specified Retry the operation; if unsuccessful, contact
file your service representative.
00000125 Error getting a handle to the Reboot the system.
event status mutex.
event status request event.

Error messages
Error
event status response event
event status finished event
00000129 Unable to retrieve the Verify that the Task Scheduler is running. Start
requested task it if it is not running. Stop and restart the Event
Manager.
0000012A Error running the requested Verify that the Task Scheduler is running. Start
task it if it is not running. Stop and restart the Event
Manager.
0000012B Unable to initialize the Stop and restart the Event Manager.
COM library
0000012C Unable to create Task Verify that the Task Scheduler is running. Start
Scheduler interface it if it is not running. Restart the Event
Manager.
0000012D Unable to retrieve task list Verify that the Task Scheduler is running. Start
from Task Scheduler it if it is not running. Restart the Event
Manager.
0000012E Specified task already exists Enter a unique task name.
in Task Scheduler
0000012F Unable to delete the Verify that the Task Scheduler is running. Start
specified task from Task it if it is not running. Restart the Event
Scheduler Manager.
00000130 Unable to create a new task Verify that the Task Scheduler is running. Start
in Task Scheduler it if it is not running. Restart the Event
Manager.
00000131 Unable to save task Verify that the Task Scheduler is running. Start
it if it is not running. Restart the Event
Manager.
00000132 Error setting the task Verify that the Task Scheduler is running. Start
properties it if it is not running. Restart the Event
Manager.

Error
00000133 Access rights failure Check the user name and password for
launching DCM Events to ensure that the user
has the required access rights.
00000134 Error removing the Verify that the file properties is not write-
specified file protected.
communications request
status cache server mutex
status item request event
status item response event
status item finished event
event status item request
event
event status item response
event
event status item finished
event
01001002 Path or other error occurred A Path setting required by DCM is incorrect.
trying to initialize the comm Contact your service representative.
driver
01001003 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

Error messages
Error
01001004 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
occurred building that the DCM database source, name, and log
configuration files on settings are correct and that the database
01001006 Error committing the update Disable and Enable the DCM Sentinel Service,
states and retry the operation. If the error reoccurs,
occurred building the that the DCM database source, name, and log
configuration file(s) using on settings are correct and that the database
the manifest file server is operating properly.
01001008 Error building the Contact your database administrator to ensure
configuration file(s) that the DCM database source, name, and log
on settings are correct and that the database
01001009 Error importing parameter Ensure that the imported parameter file is
file properly formatted, and retry the import.
0100100A Communication channel or An internal error occurred. Disable and Enable
database error trying to the DCM Sentinel Service, and retry the
createLoadConfigObject() operation. If the error reoccurs, contact your
to perform device service representative.
configuration
0100100B Communication channel or Contact your database administrator to ensure
database error occurred that the DCM database source, name, and log
trying to create the on settings are correct and that the database
CCommRequestProcessor server is operating properly.
Object

Error
0100100C Communication channel or Contact your database administrator to ensure
database error occurred that the DCM database source, name, and log
trying to initialize the on settings are correct and that the database
CCTools DLL server is operating properly.
0100100D Another instance of this An internal error occurred. Retry the
CommChannel is already operation. If the error reoccurs, disable and
running enable the DCM Sentinel Service, and retry
the operation. If the error persists, contact your
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.
0100100F Comm channel startup Internal error. Retry the operation. If the error
cancelled reoccurs, contact your service representative.
occurred trying to build the that the database server is operating properly.
Device List
01001011 Error occurred trying to An internal error occurred. Retry the
create the operation. If the error reoccurs, disable and
CommClientDialog Object enable the DCM Sentinel Service, and retry
01001012 Error occurred trying to An internal error occurred. Retry the
create the operation. If the error reoccurs, disable and
CCommClientDebugDlg enable the DCM Sentinel Service, and retry
Object the operation. If the error persists, contact your

Error messages
Error
01001013 Comm channel name not An internal error occurred. Retry the
specified operation. If the error reoccurs, disable and
enable the DCM Sentinel Service, and retry
01001014 Database lookup failed for Contact your database administrator to ensure
Comm channel named that the database server is operating properly.
01001015 Path, Sentinel Service, or A Path setting required by DCM is incorrect.
other error occurred trying Contact your service representative.
to initialize the DCMAPI
library
01001016 Error occurred while Contact your database administrator to ensure
reading a database value that the database server is operating properly.
01001017 The comm channel Verify that the comm channel configuration is
configuration is invalid valid. Retry the operation. If the error
01001018 Cannot create the Disable and enable the DCM Sentinel Service,
CCommChannel object and retry the operation. If the error persists,
01001019 Unable to retrieve An internal error occurred. Retry the
download data to build operation. If the error reoccurs, contact your
device configuration files service representative.
0100101A Unable to load the DCM An internal error occurred. Retry the
configuration service to operation. If the error reoccurs, disable and
perform device enable the DCM Sentinel Service, and retry
configuration the operation. If the error persists, contact your
0100101D Error trying to update the An internal error occurred. Disable and Enable
device state - restart the DCM Sentinel Service, and retry the
Sentinel Service operation. If the error reoccurs, contact your

Error
0100101E Cannot find the State An internal error occurred. Disable and Enable
Manager process - restart the DCM Sentinel Service, and retry the
Sentinel Service operation. If the error reoccurs, contact your
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.
01001021 Error retrieving DCM Contact your network administrator to ensure
Collection Agent IP that the DCM communication PC has a valid
Address for use in IP address or DNS name assigned to it.
collection request to device
01001022 Device state1 value Wait for operation to complete and retry.
indicates a softload is in
progress
indicates an Initialize is in
progress
indicates an Update is in
progress
indicates a LoadFile is in
progress
01001026 Error extracting specified Verify that the krm file is valid. Check the file
file from krm file protection in the DCM data temp directory.
Retry softload operation.
01122001 Error trying to stop data DCM is unable to successfully complete a
collection StopDC command. Perform a StartDC
command followed by a Stop DC command.
1132001 XML file for Series 4000 The specified file is empty. Edit or specify a
terminal is empty different file and retry the operation.

Error messages
Error
1132002 XML file for Series 4000 The specified file is larger than 32 KB. Divide
terminal exceeded 32K the file into multiple files less than 32 KB, and
1132003 DCM Configuration An internal error occurred. Retry the
Service Exception Detected operation. If the error reoccurs, contact your
on LoadConfig service representative.
1132004 Error finding Load Ensure that a valid .krm file is specified and
Firmware .krm file - retry retry the Load Firmware operation.
Load Firmware.
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.
1132006 Unable to Softload device - One or more Smart View transactions are
Smart Views must first be stored in the device. Ensure that the remote
collected by connecting to server is enabled and perform the Smart View
the remote server transaction to ensure that all Smart View
transactions are collected. Retry the Load
Firmware operation.
1132007 Unable to Softload device - The device has at least one biometric template
biometric templates must that must be collected. Retry the Load
first be collected by Firmware operation to collect any available
performing a Collect templates.
01132008 Unable to Softload device - An Initialization request to stop data collection
failed stop data collection failed. Test the device communication, check
request the network connection, and retry the softload
request.
01132009 Unable to Softload device - An Initialization request to collect request
failed primary collection failed. Test device communication, check
request network connection, and retry softload
request.
0113200A Stopped online data A batch collect was requested and the device
collection yielding to a was taken out of online collection state first.
batch collect The StopDC command was successful.

Error
0113200B FAILED to stop online data A batch collect requested and the device was
collection while yielding to taken out of online collection state first.
a batch collect StopDC was not successful. Retry the
collection request.
0113200C ReStarted online data Online collection successfully restarted after
collection after yielding to a being stopped to do a batch collection.
batch collect
0113200D FAILED to reStart online Online collection failed to restart after it was
data collection after stopped to do a batch collection. Issue start
yielding to a batch collect Data Collection on the device's collection
group.
0113200E Stopping Data Collection The StopDC command to a Series 4000
on device terminal was issued successfully.
0113200F FAILED Stopping Data The StopDC command to a Series 4000
Collection on device terminal failed.
01132010 Starting Data Collection on The StartDC command to the device was
device successful.
01132011 FAILED Starting Data The StartDC command to the device failed.
Collection on device Reissue the StartDC command.
01132012 Security state processing - The initial get capability report to device
Initial device capability failed. Review the error message log for
request failed details.
01132013 Security state processing - DCM and device security settings are not
DCM and device have compatible. Examine the mask and update the
incompatible security DCM device configuration to make it
settings compatible.
01132014 Security state processing - The HTTPS test of get capability report failed.
DCM to device Be sure that the device firmware is version 2.1
communications path test or higher. Review the error message log for
failed more details.

Error messages
Error
01132015 Security state processing - The request to test Series 4000 to DCM
DCM request instructing Collection Agent connectivity failed. Be sure
the device to test that the DCM Web server or Collection Agent
connectivity with the DCM is running. Review the error message log for
Collection Agent failed more details.
01132016 Security stte processing - The request to get results of a Series 4000 to
DCM request to retrieve the DCM Collection Agent connectivity test
results of the device failed. Be sure that the DCM Web server or
connectivity with the DCM Collection Agent is running. Review the error
Collection Agent failed message log for more details.
01132017 Security state processing - DCM successfully changed the device's
DCM request to set the security state.
security state of the device
successful
01132018 Security state processing - The device's security state was not changed.
DCM request to set the Review the error message log for more details.
security state of the device
failed
01132019 Security state processing - A request to get capability request after
Final device capability security state change failed. Check the device
request failed communication status. Review the error
message log for more details.
0113201A Security state processing - Informational message that indicates that the
FYI: The software version device is not SSL-capable. Retry the softload.
of this device does not Review the error message log for more details.
support secure
communications
0113201B Successfully reset device The request to reset the security state on the
security from secure to non- device from secure to non-secure for softload
secure state in order to was successful.
perform a softload

Error
0113201C FAILED to reset device The request to reset the security state on the
security from secure to non- device from secure to non-secure for softload
secure state in order to failed.
perform a softload
0113201D Uncollected biometric An attempt was made to initialize the device
templates found at device when it had uncollected bio templates. Issue a
collect to the device and re-initialize.
0113201E Security state processing - The DCM configured device state is the same
DCM/4500 security states as current device security state. A security
match. No need for DCM to state change is not needed.
command security state at
this time.
0113201F Security state processing - The get capability report indicates that the
Initial device capability device application is not running. This
request successful but condition is acceptable since only the state
return status indicates the mask is needed. This holds true for initial and
device application is not final get capability reports. This condition
running occurs only after a failed softload.
01132020 Waiting for collect Informational message. DCM is checking to
complete on modem comm see if the modem connection used for the
channel. The RAS collect is active.
connection watchdog timer
has fired to test if RAS
connection is still up.
01132021 Waiting for collect Informational message, which is sent when a
complete on modem comm modem collection is started for a Series 4000
channel state has been terminal (cleared on collect complete or
updated. connection timeout).
01132022 Selected device does not Upgrade the SDRAM to at least 32K or select
have 32 MB SDRAM as an earlier version of the Series 4000 firmware.
required by the specific
firmware revision

Error messages
Error
01132023 A Series 4000 batch collect After the current collect has finished, issue a
was requested while a stopDC to the device,and reissue the batch
previous request is still in collect.
progress, command
ignored.
01132025 Security state processing - A discrepancy between the DCM view of the
DCM implicit security state device security state and the device view of
transition of the device the device security state do not agree. DCM is
failed the master and sent a command to put the
device into the DCM view of the security
state.
01132026 Unable to Softload device - Verify device communications and retry
failed secondary collection softload operation.
request
01132027 Unable to Softload device - The attempt to shutdown user input on the
failed stop user input device failed. Verify device commutations and
request retry softload operation.
0113202F Collect state mismatch Because DCM detected a mismatch of one and
detected - DCM collect idle states, DCM set both to online and started
state online, Device collect data collection.
state idle - Issuing Start
Data Collection to device
01170101 DeviceId is not registered Security state of the device has been
with Host successfully changed. Indicates the device and
DCM where not in sync and the device was
commanded to the DCM held security state.
01172004 Connection from secure Initialize the device with the configuration
device on non-secure port option selected to put the device in non-secure
mode. Disable and enable Sentinel.
011A2001 Exception caught Serializing download retry to archive file
attempting to read caused an exception. Delete the archive file as
download retry archive file it may be corrupt. Re-run the device update or
to disk initialize for failed devices.

Error
011A2002 Exception caught Writing the serialized download retry archive
attempting to write file resulted in a C++ exception. Allow
download retry archive file another download retry time period to expire,
from disk and verify success. If repeated failures occur,
delete the archive file.
011A2003 Failed to post DCM Contact your service representative.
command results,
destination key is empty
011A2004 Failed to post DCM Contact your service representative.
command results
011D8001 Communications socket A communications error occurred. Retry the
error with Series 4000 operation. If the error persists, reboot the
Series 4000 terminal and retry the operation.
011D8002 Non success device status An internal error occurred at the Series 4000
received from Series 4000 terminal. Retry the operation. If the error
persists, reboot the Series 4000 terminal and
011D8003 HTTP Server error (not An internal error occurred at the Series 4000
200) from Series 4000 terminal. Retry the operation. If the error
persists, reboot the Series 4000 terminal and
011D8004 File open error for Series The specified file could not be opened. Verify
4000 related operation the file name and location, and retry the
operation.
011D8005 File access or not specified The specified file could not be accessed.
error for Series 4000 Verify that the current DCM Communication
operation PC user has the proper rights to access the file.
011D8006 File length is zero for Series The specified file was empty. Verify the file
4000 operation name and location, and retry the operation.
011D8007 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

Error messages
Error
011D8008 Unknown error type An unknown error occurred at the Series 4000
detected by driver for a terminal. Retry the operation. If the error
Series 4000 operation persists, reboot the Series 4000 terminal and
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
011D800A Series 4000 RAS DCM was unable to connect to Series 4000
connection error modem device due to a RAS connection
problem. Verify proper RAS configuration on
the DCM Communication PC, and retry the
operation.
011D800B Softload failure while Retry the softload. Device could be in a mixed
loading was in progress version.
011D800C DCM time out occurred An expected Series 4000 response was not
while waiting for a Series received. Retry the operation.
4000 response
011D800D Series 4000 xml packet A Series 4000 terminal closed the socket
terminator missing from connection before sending an XML packet
Series 4000 response terminator ("</packet>"). Retry the operation
and check the device’s communication status.
011D800E Unexpected Series 4000 Unable to get URL connection object and
driver failure unrecognized URL connection error. Disable
and Enable the DCM Sentinel Service.
011D800F Modem comm channel The modem connection for batch collects must
M8M Driver is allowing remain up until the collect is complete for the
forced hang-ups device as the punches come in to the collection
agent.
011D8010 Empty Series 4000 HTTP Retry the Softload operation.
Server response detected
during softload

Error
011D8013 Softload unable to obtain From the Device Manager, select the device
hardware profile report and select Communications > Test Device
Communications. If communication was
established, retry the operation.
011D8014 Softload unable to obtain From the Device Manager, select the device
device status report and select Communications > Test Device
Communications. If communication was
established, retry the operation.
011D8015 Softload failed preparing The hardware and software are incompatible.
file activity list for softload Contact your service representative.
011D8016 Softload FTP session failure Retry the operation. If the error reoccurs,
011D8017 Softload unable to issue Retry the operation. If the error reoccurs,
beginDownload; cannot contact your service representative.
shutdown Series 4000 host
application
011D8019 Softload Incompatibility The hardware and software are incompatible.
between Device Hardware Contact your service representative.
and Requested Software
011D801A Softload unable to connect Be sure that FTP is enabled on the device.
to the FTP Server
011D801B Softload unable to log in to Be sure that username/password are in sync
the FTP Server between DCM and the device.
011D801C Softload set for FTP Enable FTP on the device.
protocol, but Series 4000
device has FTP disabled
011D9008 Series 4000 detected an An invalid XML attribute was sent to the
invalid parameter in the device. Verify the XML of the failed file,
request which should be valid for the M8M
Application Protocol. If the error reoccurs,
011D900A A command was sent by Allow more time for device to reboot after a
DCM when the application softload. Reboot the device and allow time for
was not running. it to come up.

Error messages
Error
011D900D The Series 4000 model The device detected that the type attribute in
number does not support the the request is other than request or response.
SML data contained in the
document that was sent
011D9015 Series 4000 hardware does Use a compatible krm file and update
not support the version of hardware.
software specified in the
krm file
011D9089 Series 4000 is busy and Retry the command at a later time.
unable to process the
request at this time
011D9103 The XML file sent to the Check the XML that was sent to the device for
device is not well formatted correctness. The comm channel transport log
can be used to capture the XML that is failing.
After correcting the XML, retry the operation.
If the error persists, contact your service
representative.
011D9117 Series 4000 Incompatible The Series 4000 version does not support the
Software Module software to be loaded, or the software in the
Series 4000 device cannot be directly
upgraded or downgraded to the software to be
load and an intermediate softload is needed.
011D9118 Series 4000 URL A test is currently in process. Wait and query
connectivity test is in again.
progress
011D9251 Series 4000 Http Client The response that the Series 4000 client
Error receive buffer is too received from the server is too large to
large process.
011D9252 Series 4000 Http Client The server is not running or the network is not
Error unable to connect to connected.
server
Error unexpected connected. The termination was not graceful.
connection termination

Error
Error connection connected.
termination
011D925A Series 4000 Http Client The Series 4000 connected to the server but
Error incomplete server not response was received.
response detected
011D9304 An attempt was made to add The boimetric template on the device has
a biometric template and limited storage resources. No more templates
failed because the bio pod can be added. This error occurs when DCM is
database was full adding templates as part of a device
initialization or update and the pod memory is
exhausted. Delete employee templates to free
up space.
011D9305 Biometric delete requested Uncollected biometric templates exist on the
and uncollected templates device. Perform data collection on the device
exist on Series 4000 before deleting templates.
011D9308 The format of the bio The template data could not be processed.
template in the XML Retry the opertion. If the retry fails, delete the
document is not compatible template and re-add it.
with the biometric unit in
the Series 4000
011DA003 Series 4000 application Series 4000 terminal response. The Series
detected an invalid verb in 4000 application received a request from the
the xml document communication layer that was not a GET, SET,
or DELETE.
011DA302 No data found The requested data could not be found. This is
an informational message that indicates that
the terminal user needs to try again or request
other data. For example, if an employee name
and its biometrics template were deleted from
a terminal, a request to delete the template is
rejected by the terminal because the employee
is not in the database as a home employee.

Error messages
Error
011DA603 Series 4000 database has The Series 4000 terminal database is almost
reached watermark 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.
011DA801 A biometric template From the Device Manager, select the device
request was sent to the and select Communications > Initialize with
device for an employee that the Employee Biometric Data download
is not in the device database option selected.
01172001 Unable to successfully An informational message that indicates that
process update device state the state manager cannot be accessed. Disable
request and re-enable the Sentinel Service.
01212001 DCM HTTP Proxy The DCM proxy logged an INFO message to
properties LOADED: DCM.log that it has loaded the
port1:[%d] port2:[%d] DCMProxy.properties file.
transportlog:[%s]
01212002 DCM HTTP Proxy shutting The DCM proxy logged an INFO message to
down. DCM.log that it is shutting down.

Error messages from connecting to Workforce

Timekeeper
The following error messages may occur when users try to use DCM to log on to
the Workforce Timekeeper application:
Error Message Meaning Solution

Failed before A fatal error. The web/application server is
completion. unavailable. Make sure the application
is running and completely started.
Password is about to The user’s 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 The user account is Verify that the application server is
rejected. rejected. running. Also, verify that you entered
the user name and password correctly.
Password expired. The user’s password has When your password has expired, the
expired. Enter a New Password dialog box
appears. Enter a new password and
confirm it.
Password expired, The user’s password has
you cannot change. expired and you cannot
change it.
DSN not found. The Data Source Name Verify that the data source is registered
cannot be found. on the application server.
Account is locked
out.
Account must The password has When a password expires, the Enter a
change password. expired. New Password dialog box appears.
Enter a new password and confirm it.
This account is not a This account does not Log on as a valid DCM user.
valid DCM user. have the proper DCM
access rights.

Error messages from connecting to Workforce Timekeeper
Error Message Meaning Solution

Username or Enter your user name and password.
password is either Passwords are case-sensitive (be sure
empty or has invalid to use the same uppercase and
characters. lowercase letters).
Maximum number of The user has reached the Try again, using a valid logon.
logon attempts. maximum number of
attempts to log on that is
allowed.

Error messages from a Series 4000 terminal

The following error messages may be sent by a Series 4000 terminal:
Error Message Description

Bio DB full 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 One of the following events occurred:
transactions • A delete all on the biometric data was requested and no
unsynced biometric records are on the device.
• 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.
Device failure This generic message indicates a device failure when processing
an XML request.
Employee not in App A biometric template request was sent to the device for an
DB employee that is not in the device database.
Invalid packet The session header in the XML document that was sent from
DCM is not correct.
Invalid packet for The Series 4000 model number does not support the XML data
terminal type contained in the document that was sent.
Parse error at line x The XML file sent to the device is not well formatted.
byte offset y
Service already A request to collect data was sent to the device when collection
active was already in process.
Symbol not found 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.

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
for troubleshooting malfunctions:
• 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 Information

Series 400 Terminal Configuration Guide Procedures and steps
Series 400 Terminal Host Software Interface Guide Host commands
Series 400 Terminal Supervisor’s Reference Supervisor and guard commands
Series 400 Terminal Maintenance and Maintenance commands
Troubleshooting Guide
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 badge reading
problems, ensure that these error messages are enabled.

Error messages
Message Description/Action
Error 01: BADGE The Series 400 device is unable to read the badge correctly, or the
READ ERROR 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 The Series 400 device is set to disable “simple” time and
FUNCTION KEY attendance punches. The device accepts only punches that have a
soft 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 time
RESTRICTION 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
schedule rule (restriction profile) or a parameter in the device
program (Procedure 7, Step 1).
• Non-home employees always have the device program
parameter applied to their punches (Procedure 7, Step 2).
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.
Wait and try the punch again.
Error 05: PUNCH The Series 400 device rejected a punch because, according to the
RESTRICTED schedule enforcement information stored in the device, the
employee is not authorized to punch at this time. The schedule
rule (restriction profile) includes generic and individual
schedules to which the employee is assigned.

Error 06: The Series 400 device (not the 420 or 405 models) rejected a
UNKNOWN punch because the employee assigned to this badge or badge ID
EMPLOYEE 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 non-home
employees to punch, according to their restriction level.
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-of-week
exclusion(s) are correct. Refer to Procedure 21, Steps 1
through 4 of the device program.
• 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.
Error 08: PUNCH The Series 400 device rejected a punch because the restriction
RESTRICTED 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.
Error 09: HOME A supervisor used a home employee’s badge while executing
EMPLOYEE supervisor command 5. This command is intended for non-home
employees; supervisor command 2 is the corresponding
command for home employees.

Error 10: BADGE The badge that was read was decoded but contains invalid data.
DATA ERROR 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:
• 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.
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.
of a department generic bar code badge.
Error 11: The device rejected a punch because it is configured for entry
UNKNOWN management, and the badge that was read is not on the gate lists.
EMPLOYEE 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.
Error 12: PUNCH The Series 400 device rejected a department/labor account/labor
RESTRICTED 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 13: OUT OF Error 13 is associated with changing parameter values in the
RANGE 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.
• A value for employee, department, labor level, or labor
account generic bar code badge settings is invalid.
• The badge size of a labor level badge is set to that of the labor
account badge.
Error 14: The Series 400 device rejected a badge read because the badge
DEPARTMENT ID is on the department validation list or on one of the labor level
BADGE validation lists. The device is expecting an employee badge read.
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 Error 16 is associated with changing parameter values in the
RANGE Series 400 device. Possible reasons for this error message are:
• The generic bar code data size is longer than the maximum
possible length.
• The data size specified for the labor account badge does not
match the combined data size settings of the labor levels.
Error 18: (sent to host The Series 400 device rejected host command 90 (Set Terminal
PC) 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.
• Use host command 90 to edit the device program’s
parameters as desired.
• For details on host commands, see the Series 400 Terminal
Host Software Interface Guide.

Error 19: (sent to host The Series 400 device rejected host command 10 or 11 (Add
PC) 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.
• 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.
Error 20: LIST ITEM The Series 400 device does not find the list item you are trying to
NOT FOUND 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 specified
FOUND 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.
Error 23: (sent to host No memory is allocated for this list. Change the appropriate
PC) 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.
Error 24: ERROR 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 26: OVER Error 26 is associated with the model 405 Employee Debit
CREDIT LIMIT 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.
Error 27: WILL NOT These two error messages appear together and are associated
BE SPLIT with model 405 Employee Debit Terminal (EDT). The errors
Error 28: EMP’S indicate that an employee attempting a debit transaction has
SPLIT FULL 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.
Error 30: NEED This message appears when an employee attempts to enter a
BADGE badge ID at the Series 400 device while the badge ID entry is
disabled. The employee swipes a badge at the Series 400 device
instead.
If you enable a badge ID entry by using the device program
(Procedure 5, Step 1, Value 1), you also prevent home employees
from using badge IDs (Procedure 16, Step 3) based on their
punch interpretation rules (restriction profiles). For details on the
procedures, see the Series 400 Terminal Configuration Guide.
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.
• Use host command 110 (Clear FIFO) to flush the data from
the device.
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.

Error 41: INVALID The Series 400 device rejected a punch attempt by a home
SCHEDULE employee because the host system has not sent schedule
enforcement information to the device. Schedule information
includes punch interpretation rules (restriction profiles) and
generic schedules and allows the device to determine whether to
accept a punch.
Error 42: CONFIG This error is associated with changing parameter values in the
CONFLICT 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.
Error 43: CONFIG This error is associated with changing parameter values in the
CONFLICT 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 44: NOT This error is associated with the break enforcement feature. A
ALLOWED 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
schedule rule (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).

Error 50: ERROR 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).
Error 59: ERROR 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 60: TABLE While executing host command 65 (Create/Edit Bell Schedule
FULL 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
Error 61: INVALID The bell time specified does not exist in the bell schedule, or the
BELL TIME time entered is not a valid time of day.
Error 62: NOT The action the user attempted involves bells or gates, but they are
INSTALLED 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 63: ERROR A hardware problem was detected when the Series 400 device
was turned on. Contact your service representative.
Error 64: ERROR 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).
Error 65: RAM A fatal RAM error has occurred during execution of maintenance
FAULT command 111. Try cold-starting the device. If this fails, return the
unit for service.
Error 68: CONFIG This is a catch-all error message returned when a resource or
CONFLICT configuration conflict prevents the Series 400 device from
performing a command. Here are some situations when this error
is returned:
• 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).
Error 70: ERROR 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 flash-EEPROM
host PC) failed.
Error 74: BAD This error is associated with changing parameter values in the
DEFAULT 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 the
ENTRY validation list. Cross-check list entries in the host system, and
download the corrected list to the Series 400 device.
Error 76: DUART During a Datasave operation, the Series 400 device failed to send
ERROR all the RAM contents. This is most likely due to a host
communication failure.
Error 77: ERROR During programming of the I/O daughterboard flash chip, the
memory to be programmed was found not to be blank.
Error 78: (sent to host During the softload process, an attempt to program the flash-
PC) EEPROM failed.
Error 79: (sent to host During the softload process of programming the flash-EEPROM,
PC) the Series 400 device rejected data sent by the host software.
Error 80: NOT A user is attempting to execute a command that is disabled in the
ALLOWED 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 no
AVAILABLE memory allocated for the host report buffer or there are no reports
in the buffer.
Error 82: BAD A user is attempting to use a default department or labor level
DEFAULT 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
soft key assignment or use a value that is out of range.
Not all models support all possible soft 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.
Error 92: OUT OF A legal argument was entered with a value that is out of range, in
RANGE a command sequence. Reasons for this error message are that
non-numeric values were used for numeric-only arguments or
that required arguments are not present.
Error 94: INVALID A user entered an illegal argument. Reasons for this error
ENTRY message are that numeric values used are too large or too small or
not in an acceptable set of values.
Error 95: INVALID A user entered an illegal password. This error is returned in the
PASSWORD following situations:
• When an invalid password has been entered after attempting
to enter Maintenance mode, Supervisor mode, or Guard
mode.
• When an invalid entry code is entered (gate list or deduct list).
• 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.
• When a nonmatching password is used with command 69 to
change a supervisor or guard password.

Error 99: INVALID A user entered a nonexistent command or programming
ENTRY procedure number.
EXCEPTION nn 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
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.


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:
• “Data flow architecture” on page 408
• “Data flow in the Workforce Timekeeper system” on page 412
Appendix A Theory of Operation
Data flow architecture

The DCM 5.0 data flow architecture includes the following components:
• “Data transfer files” on page 408
• “Queue files” on page 409
• “Application client” on page 409
• “Transaction files” on page 409
• “Sentinel” on page 410
• “Communication interface components” on page 410
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.
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:
• Data Integrity—Queue 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 Transparency—Except 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.
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 118.
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; it 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:
• 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.
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:
• 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.

Data flow in the Workforce Timekeeper system

This section illustrates the flow of data between a device and a Workforce
Timekeeperdatabase. It describes these processes:
• 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:
• 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:
• The upload, or collection, event is scheduled in the DCM Event Manager.
• A request is made in the DCM Communication 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 is issued from the Communication
Monitor.
Figures in the following sections show uploading data from a Series 4000 terminal
and a Series 400 device.

Uploading data from Series 4000 terminals
Services on WTK
Application Server Step 4: The transactions
are passed to the WTK
WTK database Services Interface, which
makes an XML request to
one or more WTK app
XML data requests servers to process the
transactions.
WTK Services Interface (WFCAPI.DLL)
DCM/WTK Connection Library
DCM WTK Application Client
Step 3: The DCM WTK

Step 2: XML punch data application client reads
Application Application
from all Series 4000 terminals Q file QIN file transactions from the
is posted to the Collection application QIN file.
Agent, then directly to the
Application Connection Collection
queue file. Agent
(HTTP Server)
Communication Channel Communication Channel

Series 4000 Communication Driver Series 4000 Communication Driver
DCM HTTP Client DCM HTTP Client
Step1: The communication channel receives a request from the application client to retrieve punch
data from the Series 400 terminals. The communication channel posts the request to the device
and initiates collection.

Uploading data from Series 400 devices
Step 4: The transactions are

passed to the WTK Services
WTK database Services on WTK Interface, which makes an
Application Server XML request to one or many
WTK application servers to
process the transactions.
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 Application Application
Q file. Q file QIN file
Series 400 Comm Channel Series 400 Comm Channel

Communication Driver Communication Driver
Ethernet, serial, modem Ethernet, serial, modem
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.

Downloading data
Downloading data occurs in one of two ways:
• 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.

Downloading data to Series 4000 terminals
Step 1: Initialize and

update requests are DCM Event Manager
posted to the proper (Timed Event)
comm channel queue file.
Step 2: The comm channel

processes the request by
calling the Configuration Service Comm Channel
to build the download file. queue file(s)
Configuration Service
XML Series 4000 Communication Channel
WTK Connection Library
Series 4000 Communication Driver
Step 3: The Configuration Service builds the DCM HTTP Client

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 DCM
table in the database and the Log file
application connection log file.

Downloading data to Series 400 devices
Step 1: Initialize and

update requests are DCM Event Manager
posted to the proper (Timed Event)
comm channel queue file.
Step 2: The comm channel

processes the request by
calling the Configuration Service Comm Channel
to build the download file. queue file(s)
Configuration Service
AFT Series 400
WTK Connection Library Communication Channel
Communication Driver
Step 3: The Configuration Service builds the Ethernet, serial, modem
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 DCM
table in the database and the Log file
application connection log file.


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.
• “Setting bulk processing” on page 420
• “Setting the Sentinel Service status automatic refresh intervals” on page 421
• “Database disconnect retry wait time” on page 422
• “List size settings” on page 423
• “Registering a new communication PC” on page 424
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 system’s integrity.
Before you modify your INI file, be sure to make a backup copy.
Appendix B Modifying INI File Values
Setting bulk processing

The default for bulk transaction processing is 1 (enabled), 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

Setting the Sentinel Service status automatic refresh intervals
Setting the Sentinel Service status automatic refresh

intervals
You can modify the values for 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

Database disconnect retry wait time

The value for Database Disconnect Retry Wait time specifies the time in seconds,
between database reconnection attempts. The value is used 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 may be affected if the
database is disconnected.
Example
[Data Collection Manager]

Database Disconnect Retry Wait time=120 //data retry every
120 seconds (2 min.)

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 terminals. Depending on the physical
memory of a device, a list of maximum size may not fit.
480/470 460/450 540T

List Devices Devices Device
Employee 65535 500 500
Messages 127 127 N/A
Non-home messages 1400 1400 N/A
Gate list 65535 65535 N/A
Labor level 65535 65535 65535
Labor account 65535 65535 65535
Pay codes 999 999 999
Comment codes 999 999 N/A

Registering a new communication PC

The Communication PC Registration utility provides a simple way to change to
another communication PC in the event that the first communication PC is no
longer available.
DCM installs the CommPCReg.exe in the DCM directory when you select to
install a communication 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 communication PC:
1. Double-click CommPCReg.exe in the DCM directory. The utility detects the
new communication PC name and lists it in the communication PC
Registration dialog box for you to verify.
Note: The communication 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 communication 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
communication PC. If it is 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 one of the defined application
connections is set up in the network configuration. If at least one is set up, the
utility lists a confirmation message to change all connections to the Local
communication PC setup.
4. Click Yes to convert any application connections that are set up in the network
configuration, to run in Local configuration on the communication PC.

Registering a new communication PC
The utility checks to see whether any one of the defined communication
channels is set up in the network configuration. If at least one is set up, the
utility lists a confirmation message to continue to convert all communication
channels to the Local communication 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.


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:
• “Understanding collected transaction records” on page 428
Appendix C Understanding and Accessing Punch/Transaction Data
Understanding collected transaction records

After you configure a Series 100 device or Series 400 device (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. Transactions are stored in the database for the Series
4000 terminals.
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:
• Records that result 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 that result 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 447.
Collected transaction record identifiers and data fields

The device stores different types of records in its collected transactions buffer,
based on the activities that are 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, such as
punch, tips, daylight saving.

The following table describes the data fields in the DCM transactions formats that
are described in subsequent sections.
Collected
Transaction
Symbol Record Field Description
aa Device work rule Two-digit field. Values for the field range from 0 to 20 and correspond
to a device work rule that is associated with a period of work.
Implications such as pay code are interpreted by the host software.
b Badge reader One-digit field that indicates how the employee ID was entered for the
event. Valid values are:
• 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 a duration of time or a dollar
amount.
dddddd Simple labor Alphanumeric field of up to 20 characters. The host software uses it to
account track labor other than by pay code or by employee.
e Entry event One-digit field that indicates the device has detected an unusual entry
management event. Valid values are:
• 1 Gate forced open
• 2 Gate open too long
• 3 Gate finally closed
g Gate code One-digit, fixed-length field that indicates what type of entry
management activity was performed.
Valid gate codes are:
• 1 Entry allowed (gate opened)
• 8 Punch allowed (gate not opened)
• 9 Entry denied

Collected
Transaction
hhhhh 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).
• hhhhh can be the number of minutes from midnight (00:00) of the
collected transaction reference date.
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.
kk Function key code Two-digit fixed-length field. The device has soft keys to represent
various time and attendance and labor tracking functions.
lf3|lf2|lf1 Labor account Variable length alphanumeric field. The labor account is in fixed
or 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
lf7|lf6|lf5|
and later versions. (Pre-400.6 versions supported up to three labor
lf4|lf3|lf2| levels. Version 400.6 supports up to seven labor levels.) The maximum
lf1 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
total 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.
mmmm Minutes from Field of up to four digits. The value represents a time of day expressed
midnight in minutes.

Collected
Transaction
nnnnnn 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.
• nnnnn can be the effective date (a date since 1/1/85) for a pay code
transaction.
ooooooo Gross receipts Field of up to seven digits. The value is associated with a tips amount
(a quantity record field).
p 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:
• 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)
q Opened gate One-digit field that identifies which gate was involved with the entry
management event.
Valid values are:
• 1 First gate
• 2 Second gate
• 8 No gate

Collected
Transaction
r Direction One-character field that represents on/off, forward/backward, or plus/
minus. The possible values for this field are:
• + represents on, forward, or plus
• – represents off, backward, or minus
For example, in a pay code transaction, + can specify the addition of
hours.
ss Supervisor code Two-digit field that represents the identification number of the guard,
supervisor, or maintenance person who performed the edit, transaction,
or override. The maintenance ID is always 99. A supervisor code of 98
indicates that the record was generated through an employee edit
function.
tt Seconds Two-digit field that is part of the collected transaction record time
stamp; indicates the seconds at which the event took place. By default,
events are recorded only to the minute.
v Affect overtime One-digit field. Valid values are:
• 1 Transaction affects overtime
• 0 Transaction does not affect overtime
ww Supervisor The host interprets this field as a reason for a supervisor to generate the
comment code collected transaction record.
x 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:
• 1 Message acknowledged
• 2 Message display was not finished
• 3 Message not acknowledged
• 4 Message previously acknowledged
yyy Message index Field of up to three digits (1 through 127), indicating a particular
message in the message dictionary.
z Message age One-digit field that represents the number of days elapsed since the
individual message was assigned.
type Subrecord ID See the table of valid values in “Supervisor, Guard, and Maintenance
Transaction records” on page 447.
data Other relevant information.

Collected transaction record formats and syntax

This section presents a general description of each type of collected transaction
record. Each description is followed by the record's format and an example. The
symbols that represent the record’s data fields are described in the table in
“Collected transaction record identifiers and data fields” on page 428.
Keep the following points in mind:
• The examples of collected transaction record formats presented in this section
include line breaks caused by page format restrictions. The records are
actually reported on one line.
• Where applicable, the description indicates the one or more commands that
cause the collected transaction record to be written. The cause can be a host
command or a command you can perform at the device, or both.
• The DCM Comm client (Series 100 devices and Series 400 devices) and
Collection Agent (Series 4000 terminals) handle the 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:

0 1 cStatus Character #
1 20 Domain Domain (Device Group) for source device
21 15 DeviceId Native 6-digit address of device
36 1 DeviceType Type of device (P)eriodic, (D)irectConnect, etc.
37 1 Type Record type identifier (implementation-defined)
38 3 Key Transaction Key (Transaction Code)
41 8 Date Trx Date MMDDYYYY


49 6 Time Trx Time HHMMSS
55 1 DST Trx created during DST? (1 or 0)
56 5 Timezone Timezone ID
61 1 Online Online indicator (1 or 0)
62 1 Delimitor Field delimiter for Data
63 - Data Beginning of Data (format depends on Type and Key)
Example
012345678901234567890123456789012345678901234567890123
45678901234567890
| | | ||| | | |||||
#Group1 111111
DAA 122520031530001130110#|<--- Data begins here
The top row of numbers represents the position index for the transaction fields, to
clarify the example. The position index is not included in the transaction file. This
example shows that Transaction A (Simple Punch) was collected from device ID
111111 from group Group1 on 12/25/2003 at 15:30:00. The badge number and
other details specific to this transaction appear 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
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 device 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 it is collected by DCM.
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:
• 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).
Example
#402#1####
In this example, employee 402 punched in and the device processed the punch as
an out punch (1). The punch date and time are included in the DCM message.
Labor Transfer record (B)
A labor transfer record is generated in one of the following modes:

• The device 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 terminals).
• The device is operating in Supervisor mode, and a supervisor executes the
labor transfer function in Maintenance or Supervisor mode.
The labor transaction record is translated to a B transaction type record when it is
collected by DCM.
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#
format:
• lf3|lf2|lf1 or lf7|lf6|lf5|lf4|lf3|lf2|lf1 is the labor account (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).
• b is the employee badge-ID source (optional).
Example
#402#701|601|501|401|301|201|101##5#0#####
In this example, employee 402 was transferred to labor account
701|601|501|401|301|201|101. The function key is 5 and the punch code is
unknown. 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 soft key or using the device-supported command, it

generates a Decimal Transaction record at the device. Decimal Transactions are

translated to K transaction type records when they are collected by DCM.
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#
format:
• 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.
• kk is the optional soft key code (1 to 28, depending on version and terminal).
• aa is the device work rule (optional).
Example
#01#5155#120#402#1#701|601|501|401|301|201|101#05#16#
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 are associated with device work rule
05. The supervisor entered a comment code of 16. No soft 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 soft key that is configured as a generic soft key. The host software
program interprets this punch.
An F record in DCM transaction message format contains the following data:

#iiiiiiiii#kk#g#q#b#
format:
• kk is the soft key.
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 soft key 2, and the gate was opened (1). The punch date and time are
included in the DCM message.
Delete-a-Punch record (H)
When a supervisor performs the function of Delete Punch at the device by using
the assigned soft 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 they are collected by DCM.
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#
format:
• nnnnn is the effective date (days past 1/1/85) for the pay code transactioon.
• hhhh is the number of minutes from midnight on the effective date of the
deleted punch.

• kk is the soft 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 device work rule (optional).
Example
#01#5155#120#402#0#701|601|501|401|301|201|101###
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 soft key is
associated with the punch (0), the punch is associated with labor account
701|601|501|401|301|201|101, no device work rule was entered (aa), and the
supervisor did not enter a comment code (ww). The punch date and time are
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 soft key or using the device supported
commands, it generates a Category Transaction record at the device. Category
Transactions are translated to I transaction type records when they are collected by
DCM. A supervisor uses the assigned soft key or command 52 at the device, in
supervisor or in Maintenance mode, to add or subtract hours from a pay code for
an employee.
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#
format:
• 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.
Example
#62#5155#120#+#240#1#14#402###
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 Move Amount at the device
by using the assigned soft key or using the device-supported command, it
generates a Category Adjustment transaction record at the device. Category
Adjustment transactions are translated to J transaction type records when they are
collected by DCM.
A J record in DCM transaction message format contains the following data:
#ss#nnnnn#hhhh#r#nnnnnn#ccc#ccc#iiiiiiiii#lf7|lf6|lf5|lf4|lf3|lf2|lf1#lf7|lf6|lf5|lf
4|lf3|lf2|lf1#ww#

The following list describes data fields, in the order they appear in the record
format:
• nnnnn is the effective date (days past 1/1/85) for the pay code adjustment.
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 (the first pay code field is the “from” paycode).
• ccc is the pay code number (the second pay code field is the “to” paycode).
• lf3|lf2|lf1 or lf7|lf6|lf5|lf4|lf3|lf2|lf1 is the labor account (optional). The first
labor account field is for the “from” paycode.
• lf3|lf2|lf1 or lf7|lf6|lf5|lf4|lf3|lf2|lf1 is the labor account (optional). The
second labor account field is for the “to” paycode.
Example
#93#5155#120#+#305#14#15#402#701||||||101#708||||||101##
In this example, the device wrote a Pay Code Move Amount 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 (305 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 soft key or command 55 at the device (in
Supervisor or Maintenance mode) to add or subtract a decimal quantity (typically
a currency amount).
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#ww#
format:
• nnnnn is the effective date (days past 1/1/85) for the decimal transaction.
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.
Example
#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 a soft key, tips keys on the keyboard (+ and - keys),
or out-punch processing.
An L record in DCM transaction message format contains the following data:
#r#nnnnnn#iiiiiiii#kk#lf7|lf6|lf5|lf4|lf3|lf2|lf1#ooooooo#
format:
• 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).
• kk is the soft key code (optional).
• ooooooo is the gross receipts amount (optional).
Example
#+#500#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 is directly associated with a

punch. All represent abnormal perimeter management conditions that are detected
by monitoring attached hardware.
An S record in DCM transaction message format contains the following data:
#v#q#
format:
• v is the type of entry management event.
• q is the gate associated with the event.
Example
#3#2#
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)
If you enable this feature in the device program, the device writes an hourly Time
Stamp record to the transaction every hour on the hour. The device is unable to
write time-stamp records to the transaction during power failures.
A T record in DCM transaction message format contains the following data:
#hhhhh#
format:
• 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.
A T record in DCM transaction message format contains the following data:
#0#iiiiiiiii#x#yyy#z#x#yyy#z#
format:
• 0 distinguishes the record from a time-stamp record.
• 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.
• x is another message status (optional).
• yyy is the number of the message shown to the employee (optional).
• z is the number of days since the message was assigned to the employee
(optional).
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.
Device Work Rule record (V)
The device writes a Device Work rule record to the transaction when an employee
presses a soft key configured as an activity start or as an activity clear.
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#
format:
• aa is the device work rule number.
• kk is the soft key number.
• ss is the supervisor number (optional).
Example
#03#402#6#1#33|01|96#78#35###
In this example, the device writes a Device Work rule record (V) to the transaction
at 8:21 P.M. (2661 -1440 / 60 equals 20.35 hours). Future hours are associated
with device work rule 03 for employee 402, who pressed soft 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
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.
A W record in DCM transaction message format contains the following data:
#iiiiiiiii#p#g#q#b#
format:
• iiiiiiiii is the ID of the employee who opened the gate.
• p is the punch code.
• g is the gate code.
Example
#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
person performs at the device.
General record format

The general format of a supervisor/guard/maintenance record is:

#ss#type#data#
format:
• 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 Supervisor Guard Maintenance

Value Record Type Mode Mode Mode
0 Login X X
1 Logout X X
2 Transaction X X X
3 Single Restriction Override X X X
4 Global Restriction Override X X X
5 Non-home Employee Punch X X X
Enable/Disable
6 Security Transaction X X X
7 Open Gate for Individual X X X
8 Open Gate for Specified X X X
Duration
9 Cancel Mean Deduction X X X
• data is the remaining relevant information.
Login record (0)

The device writes a Login record to the transaction when a supervisor or guard
logs in.
A 0 record in DCM transaction message format contains the following data:
#ss#0#
format:
• 0 is the subrecord ID (0 = login).
Example
#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.
#ss#1#
format:
• 1 is the subrecord ID (1 = logout record).
Example
#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.
#ss#2#nnnnnn#iiiiiiiii#kk#lf7|lf6|lf5|lf4|lf3|lf2|lf1#
format:
• 2 is the subrecord ID (2 = transaction record).
• nnnnnn is the transaction code; six digits; maximum value 999999.
• iiiiiiiii is the employee ID (badge number) (optional).
• kk is the optional soft key (optional).
• lf3|lf2|lf1 or lf7|lf6|lf5|lf4|lf3|lf2|lf1 is the labor account to which the employee
is transferring (optional).
Example
#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 the assigned soft 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.
#ss#3#r#iiiiiiiii#
format:
• 3 is the subrecord ID (3 = single restriction override record).
• r determines if the restriction credit is given (+) or removed (-).
Example
#01#3#+#14525356#
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.
#ss#4#r#hhhhh#

format:
• 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
#01#4#+#120#
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.
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.
Normally, only home employees can punch at a device. These are employees
whose badge numbers have been sent to the device from the host. However, non-
home employees may be allowed to punch at that device if you enable the feature
in the device program.
#ss#5#r#hhhhh#
format:
• 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
#01#5#-###
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.
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.
#ss#6#nnnnnn#iiiiiiiii#
format:
• 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
#01#6#135#2468#
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.
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:
• A supervisor or guard uses the assigned soft 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.
#ss#7#g #iiiiiiii#q#b#
format:
• 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.
Example
#01#7#1#402###
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
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:
• A supervisor or guard uses either either the assigned soft 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.
An 8 record in DCM transaction message format contains the following data:
#ss#8#r#hhhhh#q#
format:
• 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).
Example
#01#8#+#120##
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.
Cancel Meal Deduction record (9)
The device writes a Cancel Meal Deduct record to the transaction in either of the
following situations:
• A supervisor uses either either the assigned soft key or command 59 at the
device (in Supervisor mode).
• An employee presses a soft 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.
#ss#9#iiiiiiiii#
format:
• 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
#01#9#402#
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 a DST change occurs.
The Series 100, 500 and 400 devices accept host command 113 to adjust the time
of day at the device and to enforce the adjustment for 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 affects future punch records, under the following circumstances:
• Punch typing is disabled in the device program for punch type in-punch
records.
• 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.

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 perform calculations for minutes worked, using the time reported on this punch
and previous punches for this employee. 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 the line of the report.
Transaction
Report Text Explanation
T 2220 Passing of 13:00
A 2220 120946 Punch at 13:00 for employee 120946
D 2340 + Forward DST change at 14:00 to 15:00
A 2401 120946 0 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 “Collecting Data and Managing Transactions” on page 221.

Appendix D
Using DCM with Series 4000 Terminals
This appendix provides information about using Series 4000 terminals with the
Data Collection Manager system.
• “Series 4000 terminal features” on page 460
• “Functional differences between Series 4000 and Series 400 devices” on page
461
Appendix D Using DCM with Series 4000 Terminals
Series 4000 terminal features

The Series 4000 terminals includes the following features:
Feature Description
Schedule enforcement Controls when specific employees can swipe badges.
Totals display Displays employee names, vacation, sick time, and other
totals at the device.
Message display Enables the devices to display messages for individual
employees.
Functions and Enables the devices to process various functions and
transactions transactions, such as labor account transfers and pay code
transactions.
Soft keys 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.

Functional differences between Series 4000 and Series 400 devices
Functional differences between Series 4000 and Series

400 devices
The following table shows the functional differences between the Series 4000 and
the Series 400 devices:
Function or
Characteristics Series 4000 Series 400
Punch status Employees can view Employees can view punch status,
information display punches, last punch, and elapsed time, and last punch.
punch status.
Individual employee Employees can display Employees can display and print
information display individual employee individual employee information.
information.
Entering a PIN Employees enter the Employees press the * key before
badge number directly. entering the badge number, except
for PIN-only devices (430, 450, or
470) or if the badge is configured on
the Badge Reader tab as None.
Supervisor functions Supervisors or managers Supervisors enter command numbers
use soft keys to initiate to initiate functions.
functions.
Device configuration Users configure devices in Users configure devices by using
DCM. DCM and AFT commands.
Installation and Performed by the Performed by a Kronos
maintenance customer. Representative.
Keys Soft keys. Function keys.
Modem configuration Users configure a dial-up Users configure the device with a
connection in Windows modem by using the Device Wizard.
first, and then configure
the device by using the
Device Wizard.

Appendix D Using DCM with Series 4000 Terminals

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.
accrual
An amount of time or money that employees earn or accumulate over time, based
on a company’s 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 is 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 employee’s 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.
Glossary
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
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 enables you to monitor
transactions between devices and the host applications that manage the
information.
communication channel
The transmission method (Ethernet, serial, or modem) that the communication 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 communication—Ethernet, serial, or modem.
Configuration Options
The DCM application that enables you to set the configuration parameters for data
collection devices.

Glossary
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 the Workforce Timekeeper application 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 employee enters a punch.
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.
default work rule

The work rule that the employee is transferred to in Workforce Timekeeper when
none of the pay rules in the device work rule match the employee's pay rule.
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.

Glossary
device work rule definition

The default work rule combined with the pay rule and work rule associations.
device work rule profile

A tool used to perform a work rule transfer. The profile is created by assigning
available device work rules to device work rule numbers. A work rule profile
maps device work rules to the function keys on devices.
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.
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 by using the Event
Manager application.
Event Manager
The DCM application that enables you to schedule events such as data collection
and device updates.
firmware
The software that resides on a device.

Glossary
function key
A programmable button on a Series 400 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.
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 to
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.

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

Glossary
monitor PC
One or more optional PCs on which DCM is installed. Monitor PCs monitor
communication between devices and the communication PC.
non-home employee
An employee not assigned to a particular device.
not responding
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.
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 move amount

A method to move hours from one set of labor levels or jobs to another, under the
same pay code.

Glossary
pay rule
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.
schedule
A series of days defined for items such as shifts and transactions.
Sentinel
The DCM application that launches communication channels for each
communication PC in the network.
shared directory
A directory that is network-accessible based on permissions assigned to the share
name by the system administrator.

Glossary
simple punch
A badge read or Badge ID entry at the device that has no associated transaction
nor requires any other action, such as using a function key.
Smart View transaction

A transaction that uses a browser in the Series 4000 terminal.
soft key
A programmable button on a Series 4000 terminal that allows employees and
supervisors to perform functions quickly.
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 employee’s 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.
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.

Glossary
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

Index
Symbols bar code 142

magnetic stripe 142
199
proximity 143
.AFT file extension 295
download 147
.KRA file extension 293
specification 142
.KRE file extension 293
badge types 145
.KRN file extension 293
badges
.KRS file extension 293
generic 146
.XML file extension 295
proximity 143
specifying acceptable badge types 142
A standard 145
accrual codes 196 to 198 bar code readers 143
ad hoc entries 189, 191 batch collection 78, 80
AFT commands, entering 141 bell schedules 96 to 97
AFT files, loading 295 configuring 147
application clients 409 biometric reports
application connections Series 4000 terminals 302
deleting 34 biometric server connections 135
editing 34 biometric verifications
overview 30 soft key enabling 174
starting 275 browsers, accessing 311
stopping 275
application servers C
connection at startup 31
clear transaction data using host commands 458
properties 274
clients
applications, problems accessing 311
application 409
communication 411
B collect transaction data using host
backups 266 commands 458
badge readers collecting device groups 68
configuration Collection Agent ports 123
Index
command events configuration, steps to configure DCM 27

copying and pasting 243 configuring a modem
editing 243 Series 4000 43
renaming 243
comment codes 157, 172, 174, 176, 212 to 215, D
216 data backups 266
definition 212 data collection 224
for a Series 400 device 214 batch 78, 80
for a Series 4000 terminal 212 enabling 222
communication channels enabling a device for 180
creating 39 online 78, 80
defining Ethernet 55 start collecting 224
definition 39 starting 222
Device Manager 53 data collection devices
error codes 334 maximum supported 39
modem 40, 57 data downloads 415
overview 38 data flow 412
serial 60 data transfer files 408
Series 400 41 data uploads 412
Series 4000 41 daylight saving time 77, 83
status 272 FIFO record 456
communication clients 411 DCM
communication drivers 411 application connection overview 30
Communication Monitor configuration steps 27
data collection information 225, 236 data flow architecture 408
loading configuration 179 DCM applications 21, 25
overview 21 accessing 25
transaction statistics 236 start menu 25
communication PCs using INI file values with 419
communication channels support 39 DCM commands 245
communication channels supported 39 default reader transactions 149
devices supported 39 default transactions
IP address 48 assigning 150
multiple 62 configuring 148
registering new 424 device communications
synchronizing date and time 299 monitoring 225 to 228
communication settings 122 device display
communications, secure 54 configuration 151
configuration parameters, loading 177 date 152
configuration service, error messages 344 messages 152

Index
time 153 creating 206

device download settings 121 definition 204
device error messages override 209
interpreting 393 overview 23
device groups devices
assigning 68, 71 adding 76
assigning a new device 83 assigning to device group 83
collecting 71 assigning to second group 85
copying 74 copying 88
creating 70 definition 66
definition 67 deleting 94
deleting 75 editing 86
displaying 72 maximum supported 39
editing 73 synchronizing date and time 299
name 70 update command 177
device IDs 77 viewing enabled and disabled 180
Device Manager viewing responding 180
adding a device 80 dial-up connections 47
adding a new device 80 Series 4000 terminal with modem 43
assigning devices to device groups 84 dial-up entry
configuring communication channel 53 creating on Windows 2003 48
copying a device 89 to 91 dial-up network
copying to a device 91 creating on Windows XP Professional 51
deleting a device 94 dial-up networking 47
description 69 direct communications IP address 123
editing a device 86 display, configuring 152
overview 22 DLL errors 318
device parameter files 295 documentation 17
device parameters download files
configuring 138 deleting 121
Device Wizard saving 121
adding a new device 76 download options, event 250
copying a device 88 downloading badge reader configuration 147
deleting a device 94 downloading data 415
description 22 downloads
editing a device 86 retry 121
device work rule profiles DSN error message 390
definition 205
device work rules 157, 172, 174, 212, 216 E
assigning to soft key 209 e-mail notifications 129

Index
command event failure 244 FIFO records 428

program event failure 258 FIFO, configuring 154
e-mail, accessing 311 file-based requests 125
employee default transactions files
changing 151 data transfer 408
disabling 151 queue 409
employee function key commands 157 transaction 230, 409
employee punches 153 firmware 293
employee soft key commands 172 upgrading 279
error messages 328, 405 upgrading Series 400 293
communication channel 334 free form XML 155
communication driver 331 function key commands
configuration service 344 employee 157
DSN 390 supervisor 157
format 328 function keys
generic 350 assigning labor levels 190
logging on 390, 392 assigning tasks to 156
missing DLL 318
password 390 G
serial and modem 329 gate entry
Series 400 Device 393 configuring 159
softload 332, 350 settings 160, 161
Ethernet channels, defining 55 gate schedules 98 to 100
Ethernet communication channels 38 configuring 161
Ethernet timeout value, increasing 56 general system settings 116
Event Manager generic badge format, editing 187
overview 23 generic badges 146
event sets, creating 259 global settings 125
events direct communications IP address 123
DCM command format 245 to 249 file-based requests 125
defining 239 to 241 global values settings
download options 250 totals and accruals timeframe 127
maximum number 238
renaming 243, 258 H
scheduling 23, 237, 245
specifying 238 hardware/firmware incompatibility, Series 4000
testing 243 terminal 291
external proximity readers 144 http devices 82
https devices 82
F

Index
I configuring 187
labor transfers
INI file values
badge types, selecting 185
using with DCM 419
editing generic badge format 187
initialization
enable # key for transfers 185
process 139
non-home employees 185
retry 140
restrict time on repunch 185
invalid transactions, correcting 235
specifying 165
IP addresses
standard badge labor level restrictions 186
changed 41
list size settings 423
DCM communication PC 48
loading configuration data 178
recommended 46
loading to a Series 400 device 293
Series 4000 modem 48
local reader options, Series 400 device 145
log file settings 118
J log files
job sets 162 centralized 118
job transfers maintenance 260
configuring 163 messages 323
function key setting 164 number 119
overview 161 severity reporting levels 118
soft key setting 164 viewer 260
log message files 118
L log messages 314, 410
labor level accounts, configuring 164 Log Viewer 260
labor level options logging on 25
selecting 184 logging on to DCM 21
labor level sets 183 logon
labor levels error messages 390, 392
assigning to function key 190 screen 25
assigning to soft key 190
definition 182 M
downloading 193 magnetic stripe readers 143
order for Series 400 device 188 manager badges
order for Series 4000 terminal 188 enabled 167
override 189 use 168
overview 182 manager soft key commands 172
removing 192 Manager tab 167
labor transfer options message display times 152
specifying 185 messages
labor transfer settings log 314, 410

Index
modem channels 40 error messages 390

defining 57 pay code edits 216 to 220
modem communication channels 38 definition 216
modems for a Series 400 terminal 218
autodetecting 22 for a Series 4000 terminal 217
configuring for Series 4000 43 pay codes 157, 172, 174, 196 to 198, 212, 216
error messages 331 definition 216
Series 4000 311 pay rules 206
Series 4000 IP address 43, 48 definition 204
softload 81 phone book
specifying the delay times 59 for dial-up connection 122
troubleshooting 307, 311 ports
undetected 57 http 123
monitor https 123
device communications 225 to 228 non-secure settings 123
transactions 225 to 228 secure settings 123
monitoring server settings 123
application connection 271 program events
communication channel 271 copying and pasting 258
defining 254
N editing 258
network checks 55, 61 renaming 258
NIC cards, multiple 63 proximity badges 143
proximity readers
O external 144
punch rules 170
online collection 78, 80
output files, size of 116 Q
P queue files 409
parameter files R
deleting 116
exporting 298 rasphone 49, 51
extracting 296 Remote Access Service 47, 122
importing 297 Series 4000 terminal with modem 43
loading 295 reports
saving 117 DCM 25
partial transfers Series 4000 terminal 302
configuring 188 Series 4000 terminal configuration 303
password

Index
S reports 302
troubleshooting 311
scan interval
server connections
FIFO 154
manually configuring 32
schedules
setting date and time
bell 96
Communication Monitor 300
gate 98
Device Manager 300
secure communications 54
Smart View transactions 105 to 112
Secure Sockets Layer
assigning to a function key 111
communication PC 55, 78
assigning to a soft key 111
device 82
copying 110
Sentinel 322
creating 107
accessing the database 277
deleting 111
disabling 274
editing 110
establishing communication with
in a NAT environment 109
applications 270
soft keys 105
monitoring
soft key commands
communication channels 272
employee 172
overview 268, 410
manager 172
shutting down 275, 276
soft key schedules
starting a communication channel 269
assigning to a function key 103
starting and stopping host application 275
copying 102
status monitoring 271
creating 101
viewing status of comm channels 272
deleting 103
Sentinel icon 272
editing 102
Sentinel Service
soft keys
application server properties 274
assigning labor levels 190
database properties 273
assigning tasks 171
overview 24
bell schedules 96
serial communication channels 38
enabling biometric verification 174
defining 60
gate schedules 98
Series 4000 modems
schedules 101
dial-up entry on Windows 2003 48
Smart View transactions 105
dial-up networking on Windows XP
uses 26
Professional 51
softload failure, Series 4000 terminal 291
IP address 43, 48
softloads 279
prerequisites 47
modem 81
troubleshooting 311
re-initializing 294
Series 4000 terminals
Series 400 device 293
biometric reports 302
Series 4000 terminal 280 to 290
configuration data 303

Index
standard badges 145 display 200, 201

status of comm channels downloading 201
using Sentinel 272 editing 198
supervisor badges naming 197
enabled 175 transaction codes 232
use 168 Transaction Data Editor 235
supervisor function key commands 157 transaction files 230, 409
system settings 114 to 136 transaction input files
communication 122 collecting 229
device download 121 extension 233
e-mail notification 129 formatting 231
general 116 loading 230
global values 125 location 232, 410
log file 118 processing 230
totals and accruals timeframe 127 transaction output files 118, 263
WFC connection 132 reading 323
system tray setting up 233
Sentinel icon 272 size 116
transaction records 428
T Add Pay Code Hours 439
Task Scheduler 237 Add-a-Punch 436
totals and accruals Cancel Meal Deduction 455
assigning to function keys 200 data fields 428
assigning to soft keys 200 Decimal Transaction 441
creating 197 Delayed Labor Transfer 436
deleting 198 Delete-a-Punch 438
display 200, 201 Device Work Rule 446
downloading 201 Entry Management 443
employee totals 196 formats 433
naming a total definition 197 Function Key 437
overview 196 Gate 446
sending to the device 201 Guard Transactions 447
specifying a pay code 197 Home Employee Global Restriction
specifying an accrual field 197 Override 451
time frame 125 Hourly Time Stamp 444
totals definitions identifiers 428
assigning to function keys 200 Individual Message Audit Trail 445
assigning to soft keys 200 Labor Transfer 435
creating 197 Login 448
deleting 198 Logout 449

Index
Maintenance Transactions 447 work rule profiles

Move Pay Code Hours 440 application options 208
Non-home Employee Global Restriction assigning 208
Override 452 creating 207
Open Gate for an Individual Employee 454 deleting 208
Open Gate for Specified Duration 454 unassigning 210
Punch 435 work rules
Punch Type and daylight saving time 456 definition 204
Security Transaction 453 linking with pay rule 206
Single Restriction Override 450 Workforce Activities server connection 133
Subtract Pay Code Hours 439
Supervisor Transactions 447 X
syntax 433 XML files, loading 295
Tips 443 XML, free form 155
Transaction 450
Transaction Statistics count 236
Transaction Viewer 234
transactions
default reader 149
monitoring 225 to 228
troubleshooting
application connections 322
communication channels 322
communication monitor 326
procedures 306
softload problems, Series 4000 terminal 291
transaction output file 323
U
update process 140
upgrading firmware
Series 400 devices 293
Series 4000 terminal 280 to 290
uploading data 412
W
Web server
port setting 123
WFC application server instance, multiple 132
WFC connection 132

Index

Sys Admin Guide Data Collection

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Sys Admin Guide Data Collection

Uploaded by

Copyright:

Available Formats

Workforce Central ®

System Administrator’s Guide

An administrator’s guide to configuring the Data Collection

Kronos Workforce Central Suite

Document Part Number: 4703955-001

Published by Kronos Incorporated

For links to information about international subsidiaries of Kronos Incorporated, go to

Document Revision History

Document Revision Product Version Release Date

A Workforce Central 6.0 June 2007

About This Guide

Chapter 1: Introducing Data Collection Manager

Chapter 2: Defining an Application Connection

Chapter 3: Communication Channels

Modem channels ....................................................................................40

Chapter 4: Device Group and Global Setup

Bell schedules ............................................................................................ 96

Workforce Central System Administrator’s Guide—Data Collection 5

Event error notification ........................................................................130

Chapter 5: Configuring Devices

Chapter 6: Setting Up Labor Level Information

Chapter 7: Totals and Accruals

Chapter 8: Device Work Rules, Comment Codes,

Workforce Central System Administrator’s Guide—Data Collection 7

What is a pay code? .............................................................................216

Chapter 9: Collecting Data and Managing Transactions

Editing, copying, or renaming an program event ............................... 258

Chapter 10: Using the Sentinel

Chapter 11: Loading Files and Data to and from a Device

Workforce Central System Administrator’s Guide—Data Collection 9

Extracting a parameter file ........................................................................296

Chapter 12: Troubleshooting

Chapter 13: Error Codes and Messages

Interpreting error messages ................................................................. 393

Appendix A: Theory of Operation

Appendix B: Modifying INI File Values

Appendix C: Understanding and Accessing

Appendix D: Using DCM with Series 4000 Terminals

Workforce Central System Administrator’s Guide—Data Collection 11

Organization of this guide

Workforce Central System Administrator’s Guide—Data Collection 15

Abbreviations and terms

Workforce Central System Administrator’s Guide—Data Collection 17

This chapter introduces the Data Collection Manager (DCM) system by

Workforce Central System Administrator’s Guide—Data Collection 21

• Edit and resubmit failed transaction data

Device Work Rules

Workforce Central System Administrator’s Guide—Data Collection 23

Accessing the Data Collection Manager applications

About the DCM integrated logon utility

Reports about DCM in the Workforce Timekeeper application

Workforce Central System Administrator’s Guide—Data Collection 25

Steps for configuring the Data Collection Manager

1. Plan implementation: communication

Workforce Central System Administrator’s Guide—Data Collection 27

Application server connections

Workforce Central System Administrator’s Guide—Data Collection 31

To configure the server connection manually:

Workforce Central System Administrator’s Guide—Data Collection 33

Editing an application connection description

Deleting an application connection

Creating a new application connection

To create a new application connection