Professional Documents
Culture Documents
System Administrator’s
Guide
Cambridge Clock, CardSaver, Datakeeper, Datakeeper Central, eForce, Gatekeeper, Gatekeeper Central,
Imagekeeper, Jobkeeper Central, Keep.Trac, Kronos, Kronos Touch ID, the Kronos logo, My Genies,
PeoplePlanner, PeoplePlanner & Design, Schedule Manager & Design, ShopTrac, ShopTrac Pro, StarComm,
StarPort, StarSaver, StarTimer, TeleTime, Timekeeper, Timekeeper Central, TimeMaker, Visionware, Workforce
Accruals, Workforce Central, Workforce Decisions, Workforce Express, Workforce Genie, and Workforce TeleTime
are registered trademarks of Kronos Incorporated or a related company. Comm.Mgr, CommLink, DKC/Datalink,
FasTrack, HyperFind, Improving the Performance of People and Business, Kronos 4500, Kronos 4500 Touch ID,
Kronos e-Central, KronosWorks, Labor Plus, Schedule Assistant, Smart Scheduler, Smart View, StartLabor, Start
Quality, Start WIP, Starter Series, Timekeeper Decisions, Timekeeper Web, VisionPlus, Winstar Elite, WIP Plus,
Workforce Activities, Workforce Connect, Workforce Employee, Workforce HR, Workforce Manager, Workforce
MobileTime, Workforce Payroll, Workforce Record Manager, Workforce Recruiter, Workforce Scheduler, Workforce
Smart Scheduler, Workforce Tax Filing, Workforce Timekeeper, and Workforce View are trademarks of Kronos
Incorporated or a related company.
All other trademarks or registered trademarks used herein are the property of their respective owners and are used
for identification purposes only.
When using and applying the information generated by Kronos products, customers should ensure that they comply
with the applicable requirements of federal and state law, such as the Fair Labor Standards Act. Nothing in this
Guide shall be construed as an assurance or guaranty that Kronos products comply with any such laws.
Chapter 1: Introduction
System Configuration Overview ................................................................1-2
Configuring Workforce Timekeeper ...........................................................1-3
Workforce Central Setup ......................................................................1-3
System Configuration ..........................................................................1-4
Logging On to Workforce Timekeeper .......................................................1-6
Logging On with Single Sign-on .........................................................1-6
Offline Mode ........................................................................................1-7
Managing a Server Remotely ..............................................................1-8
Working with Passwords ............................................................................1-9
Setting Passwords and Security ...........................................................1-9
Updating Your JRun Service Password .............................................1-11
Updating the Registry Entries ............................................................1-11
Changing the Relogon Session Timeout ..................................................1-12
Changing the JRun Session Timeout Setting .....................................1-13
Changing the Workforce Central Session Timeout Grace Period ......1-14
Working with Property Files ....................................................................1-15
Modifying Properties .........................................................................1-17
Property File Descriptions .................................................................1-19
Configuring a Multiserver Environment .................................................1-24
Configuring Group Edits for a Multiserver Environment ..................1-24
Configuring E-mail for a Multiserver Environment ..........................1-25
Configuring Event Manager for a Multiserver Environment ............1-25
Contents
iv Kronos Incorporated
Contents
Chapter 5: Reports
Overview ................................................................................................... 5-2
Terminology ........................................................................................ 5-2
Reports Directory ................................................................................ 5-4
Reports Server ..................................................................................... 5-5
Queue Performance Considerations .................................................... 5-6
Report Logs ......................................................................................... 5-7
Accessing Reports ............................................................................... 5-8
Checking Report Status ....................................................................... 5-9
Blank Reports in the Adobe Reader .................................................. 5-11
Setting Up for Totalization ................................................................ 5-11
Generating a Report ................................................................................. 5-13
Generating Custom Reports ..................................................................... 5-15
Creating a Crystal Report .................................................................. 5-17
Crystal Reports GetLabel() function ................................................. 5-30
Setting Up the Workforce Timekeeper Report Item .......................... 5-32
Creating Custom Options .................................................................. 5-35
Giving Users Access to the Report .................................................... 5-38
vi Kronos Incorporated
Contents
Index
x Kronos Incorporated
Abbreviations and Terminology
Abbreviation/Terms Meaning
ADSI Microsoft Active Directory Service Interface
API Application Program Interface
BGP Background Processor. A platform on which a Background
Totalizer application runs.
daemon A process that runs in the background and performs a
specified operation at predefined times or in response to
certain events.
DCM Data Collection Manager. A set of functions that deals
with data from data collection devices. In a multiserver
environment, the DCM can run on a dedicated server.
DNS Domain Naming Service
DSN Data Source Name
GUI Graphical User Interface
HTTP HyperText Transport Protocol. A communication protocol
between a client and a server.
HTTPS HyperText Transport Protocol Secure. A communication
protocol with encryption security, using a Secure Sockets
Layer.
IE Microsoft Internet Explorer
IP Internet Protocol address
ISO International Standards Organization
JDBC Java Database Connectivity
JRE Java Runtime Environment
JRun The application server that resides on the Workforce
Timekeeper server that provides the Java Virtual Machine
(JVM) and performs many tasks such as Java Server page
(JSP) support and Web communication.
JSP Java Server Page
Abbreviation/Terms Meaning
JVM Java Virtual Machine
LDAP Lightweight Directory Access Protocol
ODBC Open Database Connectivity
PDF Portable Document Format
RSA A public-key cryptosystem developed by RSA, Inc.
SMTP Simple Mail Transfer Protocol
SSL Secure Sockets Layer
Use the System Configuration component to manage and configure the Workforce
Timekeeper system. As system administrator, you can configure various aspects
of an application server, diagnose and correct problems, and establish database
and networking parameters.
Note: Before you move from Workforce Central Setup to the Workforce
Timekeeper System Configuration component, save the changes that you made in
Workforce Central Setup and then close the Workforce Central Setup application.
Doing this ensures that these changes will appear in the Workforce Timekeeper
System Configuration component.
You assign the profiles, rules, and labor levels that you define using Workforce
Central Setup in the Web-based People Editor.
The configuration that you can perform in Workforce Central Setup is as follows:
! Labor levels—The general categories that define an organization's job
structure.
! Labor accounts—Consist of one labor level entry for each labor level. Labor
accounts are used throughout the system as a way to organize or group people
and labor resource information.
! Pay codes—Organize time or money that people earn.
! Work rules—Combinations of work rule building blocks that apply specific
payroll rules to shifts.
! Accruals—Amounts of time or money that people earn or accrue, based on
their company's accrual policy.
! Wage calculations—The hourly rate used to calculate an employee's wages.
! Access profiles—Determine the Workforce Timekeeper components that
users can access and the types of functions that users can perform within the
Workforce Timekeeper system.
System Configuration
The System Configuration selection on the Workforce Timekeeper navigation bar
contains the following components that deal with administering the system (these
are accessible only with administrative rights):
! System Information—Displays a set of tabs representing different
characteristics of the system. Clicking each tab displays that area’s parameters
in a workspace. This component is used primarily for viewing the current
state of the application server, although several areas have some available
actions.
! Log Report—Displays a workspace that can be edited, and that enables you
to determine the information to be detailed in the log, and an action menu.
This component allows you to create a customized log report.
When the system is offline, the system configuration components are the only part
of the Workforce Timekeeper system that are accessible. For information about
offline mode, see “Offline Mode” in this chapter.
Because you can access the Workforce Timekeeper system through a Web
browser, you do not need direct access to the system console and property files to
administer the system. Instead, you can administer the Workforce Timekeeper
system from a remote location through System Configuration.
http://<server>/wfc/html/ess/logon.jsp
Users of Workforce Employee - HTML Client using Quick Time Stamp access the
system through:
http://<server>/wfc/html/ess/quick-ts.jsp
For more details about HTML Client logons, see the Workforce Timekeeper
Installation Guide for Windows.
Note: If you specify HTTPS (HyperText Transport Protocol Secure) for your
communication protocol on the Web Server Settings tab, you must use https:/
/ rather than http:// for the logon URLs.
http://{server_name}/wfc/logonWithUID
Offline Mode
As system administrator, you may need access to the administration functions of
the system, even if the database is offline.
When the database is not available or when the system is unavailable, you can
access the Workforce Timekeeper system via a special offline logon URL for
system administrators. You can also use this offline logon URL if you have single
sign-on enabled using SiteMinder. To access the system in offline mode, enter the
following URL in your browser:
http://<server>/wfc/offlineLogon
Note that this URL is case-sensitive.
If you log on to the system in offline mode, the System Information, Log Report,
and System Settings components are the only entries that appear in the navigation
bar.
Note: If you specify HTTPS (HyperText Transport Protocol Secure) for your
communication protocol on the Web Server Settings tab, you must use https:/
/ rather than http:// for the logon URLs.
You specify the offline mode user name and password using the
site.security.authentication.offline.username and the
site.security.authentication.offline.password keys on the
Security settings tab. The system encrypts the value of this password.
Database Offline
The system is configured with a predefined password for superuser. To change the
online password, click Change Password in the navigation bar and enter the new
password in the dialog box.
Client Security
You can set your users’ browsers to remember passwords so that they can log on
more quickly. You can disable Password Save using the following two methods:
! Disabling Password Save From User Desktops—If the browsers are already
on your users' desktops, you need to change this setting at each browser.
However, you cannot prevent users from altering the setting.
– For Microsoft Internet Explorer browsers, turn off AutoComplete through
the browser’s Tools > Internet Options Content tab.
– For Netscape browsers, use the Password Manager facility through the
browser’s Edit > Preferences > Privacy and Security facility.
Single Sign-On
4. Click OK.
To update the database user name and password on all other platforms, use the
Data Source tab.
Session timeouts for Workforce Central user inactivity are governed by the JRun
session timeout parameter and the Workforce Central Session Timeout grace
period. The Workforce Central Session Timeout grace period represents the
number of minutes prior to the JRun session timeout that the Workforce Central
Relogon dialog box will appear. The Workforce Central Relogon dialog box
informs the user that their session is about to timeout, and prompts them to relogin
in order to prevent timeout. If the user does not respond to the relogin request in
time, the JRun session times out, the Workforce Central application closes, and
the user must relogin through the Workforce Central logon screen.
Example 1:
Example 2:
property_name = value
For example:
site.email.batchDelivery = true
Modifying Properties
Caution: Never manual edits to any property files, as this could render your
system unusable if you modify data in them improperly.
The system automatically backs up any existing custom property file before
applying changes that you made using System Settings. The name of the backup
file is custom_xxxx.properties.nnn, where xxxx is the name of the
property file and nnn is a sequential number.
Having backup files allows you to keep multiple sets of properties. For example,
you can connect a Workforce Timekeeper server to any one of a number of
databases by creating a custom_xxxx.properties.nnn file for each
database. You can rename these files or store them in different locations until you
need them.
At startup time, the system overrides the values in the property files with
matching values in the custom property files. For example, if you modify the
site.log.loglevel property from INFO to ERROR, the
WFCSite.properties property file contains the value INFO and the
custom_WFCSite.properties property file contains the value ERROR.
The value ERROR overrides INFO when the system is started.
Caution: Do not change any of these property files. Access properties only
through the System Configuration component, which creates custom files.
Accessing the properties files directly could lead to errors in them which could
render your system unusable.
The following files reside in the properties directory, with the file extension
.properties.
File Description
WFCSite Contains most of the site-specific configurable
properties for your system.
WtkGlobalSetting Contains properties that apply to all the application
servers. These properties are maintained in the
database and are only copied to this file for use in the
offline mode.
This file is created from the WtkGlobalSettings table
when the system is started.
WFCDsnname All Workforce Timekeeper application servers share
the dsnname properties. These properties are
maintained in the database and are only copied to this
file for use in the offline mode.
This file is created from the WFCDsnname table when
the system is started.
WFCPrinter Contains the printers that are shared among the
application servers. These properties are maintained in
the database and are only copied to this file for use in
the offline mode.
This file is created from the WFCPrinter table when
the system is started.
File Description
WFCServer A list of all the application servers in your Workforce
Timekeeper system is maintained in the
WFCServer table in the database. These properties
are maintained in the database and are only copied to
this file for use in the offline mode.
This file is created from the WFCServer table when
the system is started.
SiteDsnname Contains initial properties established when your
system was started for the first time.
Contains the dsn settings returned by Workforce
Timekeeper to the BGP, Configuration applications,
and DCM when they are authenticated against the
Workforce Timekeeper server.
SitePrinter Contains the Workforce Timekeeper printer specified
during installation.
SiteServer Contains the Workforce Timekeeper server name
specified during installation.
ApplicationRegistry Lists applications installed on your application server.
WFCStrings Contains the text of all user-visible messages and data
that can be translated to other languages.
Also note internationalization files such as
WFCStrings_es.properties (for Spanish) and
WFCStrings_fr.properties (for French).
WFC Contains system properties such as the paths for
HyperText Markup Language (HTML) and JavaServer
Pages (JSP).
WFCProduct Contains Workforce Timekeeper product data.
Also note internationalization files such as
WFCProduct_es.properties (for Spanish) and
WFCProduct_fr.properties (for French).
SQL String Contains all of the SQL statements that your system
properties uses.
SQLCoverage Contains a count of how many times each SQL string
has been used by the application.
File Description
Vlslm Contains the licensing configuration information.
License Contains the license configuration options
information.
LleImportErrors Contains the labor level entries import error messages.
You can specify up to three files. You specify the files that contain these SQL
string properties as the values of the following properties, located in
WFCSite.properties:
! site.service.sql.strings.file.first
! site.service.sql.strings.file.second
! site.service.sql.strings.file.third
site.service.sql.strings.file.first =
SQLStrings.properties
site.service.sql.strings.file.second =
SQLStringsSQLSVR.properties.
You can specify other SQLString property files that are in the properties directory.
Groups of Properties
Properties are grouped based on subject matter. For example, the site.log
group contains all of the properties that are associated with system logs. Examples
of properties in this group are site.log.active, site.log.file.name,
and site.log.rollover.maxlogs.
Each tab in System Settings deals with one group of properties. Properties are
maintained in property files or in database tables. The following list shows the
property group that is associated with each System Settings tab and the location of
the property group:
If you set up multiple application servers, a user can connect to any Web or
application server. The user specifies a Uniform Resource Locator (URL) for
connecting to the Workforce Timekeeper system. This URL depends on whether
your system uses load-balancing software from a third party to balance the load of
incoming requests and determine which application server receives any specific
request.
! If load balancing is not used, each user must specify the URL for a specific
application server.
! If you use load-balancing software, all users must specify the same URL. The
software then determines which application server handles user requests.
Notifications can be configured on any server, but only the primary notification
server can initiate notification processing. You must reconfigure other keys on the
E-mail settings tab.
If you have a multiserver environment, you must configure the e-mail function:
! By default, the site.email.primary_server value is set to true for all
application servers. Determine which is your primary Notification server and
set this property to false for all other application servers.
! For the primary Notification server, set the site.email.smtp.url value
to the URL of your e-mail server.
! For the primary Notification server, set the site.email.sender value to
an e-mail address; for example, System@host.com.
! By default, the site.email.enable value is set to false. You must set
this value to true on all application servers if e-mail is supported.
Note: Before you designate a server as the primary Scheduler, you must install
Microsoft Task Scheduler, part of the Microsoft Internet Explorer (IE) 5.5
application. To install the Task Scheduler, install IE 5.5 and select the Offline
Editing Tools option. Install Task Scheduler as a service that starts automatically.
Note: For UNIX platforms, fill in the value of with the name of the
companion Windows server. Set other values to false.
If you are setting up the primary server and your site is configured for Secure
Sockets Layer (SSL) communications, set
site.eventmanager.hostname to the fully-qualified domain name,
for example, sslserver.kronos.com.
For all application servers, where you set
site.eventmanager.enabled to false, set the value of
site.eventmanager.hostname to the name of the Scheduler server.
Notification Types
Several types of notifications are available. Each type is a template that you use to
set up a specific notification request. There are two categories of notification
types, automatic, and those initiated by an event.
! Automatic notification types are activated at a predefined period of time
before or after the end of a pay period, and provide a mechanism for sending
an automatic reminder to a manager or an employee. These types include pay
period based for both managers and employees.
For these notification types, select a HyperFind query from the Recipients
drop-down list to obtain a list of e-mail recipients.
To notify managers, select the employees listed in the notification by selecting
a HyperFind query from the Employees drop-down list. Because the recipient
list and the list of people returned from the HyperFind query can be large and
unstable, you may modify the lists returned in either HyperFind query.
For more information about notification types, see the online Help for Workflow
Notifications.
Available Notification
Several types of notifications are available.
! For managers, pay period based—Sent to managers based on the number of
days and/or hours before or after the end of a pay period for various reasons,
such as all employees whose timecards contain missed punches.
! For employees, pay period based—Sent to employees based on the number
of days and/or hours before or after the end of a pay period for various
reasons, such as all employees whose timecards contain missed punches.
! Server Notification—Sent when a user-selected event occurs on a user-
selected Workforce Timekeeper service.
! Event status—Sent whenever a change in status is recorded for a Workforce
Timekeeper event.
! Database server unavailable—Sent when the database server becomes
unavailable.
! Application server booted—Sent whenever the Workforce Timekeeper
application server is started or restarted.
For more details and specific configuration instructions, see the online Help for
the notification that you are setting up.
! You can find records of people who are candidate e-mail recipients and
determine whether e-mail addresses are present for these people using the
People Editor. You can add any addresses not present.
If you set up a recurring notification, be sure to update each Person record
accordingly as new people are added or deleted from the list of recipients.
! Determine access, as explained in the following section.
Access
Notification depends upon access, determined by the following:
Although System Information functions are primarily for viewing only, you can
do the following:
! Update the display with the most current information by clicking Refresh in
the Workforce Timekeeper header.
Note: You cannot update the workspace using your browser’s Refresh button.
Caution: Clicking the Restart Server button causes the system to shut down
immediately. Users receive no advance warning.
! Delete application servers that are no longer connected to the database in the
All Servers tab.
! Generate database reports on the Database tab if you have a SQL Server or
ORACLE database.
Applications Information
The Applications workspace allows you to view the name and version number of
the products that are currently installed on the application server. This list of
products can also be found in {WFC.rootdir}\wfc\applications.
Some components of Workforce Timekeeper appears as products, such as Event
Manager.
Click Resubmit All Employees for Totals Calculation to submit all of the
employees that qualify for totalization without going to the Totals Calculation -
Excluded Employees workspace.
Click Resubmit All Employees for Historical Edits to resubmit all of the
employees that qualify for retroactive totalization without going to the Historical
Edits with Retroactive Pay Calculation - Excluded Employees workspace.
Note: Submitting one or more employees for totalization means that they become
eligible for retotalization. This attempt to retotalize an employee does not happen
until a background processor is available.
! A check box that indicates if the employee has been selected for submittal to
totals calculation
! Name
! Person ID from Database
! ID Field from People Editor
! Last Totals Update
! A check box that indicates if the employee has been selected for submittal to
totals calculation
! Name
! Person ID from Database
! ID Field from People Editor
Database Information
The Database information tab has different workspaces.
! Database workspace—Allows you to view the status and details about the
database that the Workforce Timekeeper server is currently connected to, and
run and view various database reports.
! Database Report Status workspace—Allows you to view the current list of
database reports.
! Database Report Display workspace—Allows you to view a database
report that you selected in the Database Report Status workspace
Database Workspace
The Database workspace allows you to view the status and details about the
database that the Workforce Timekeeper server is currently connected to, and run
and view various database reports.
! Database Product
! Product Version
! Available Database Reports—For SQLServer or ORACLE databases only.
This functionality is not available for DB2 databases.
If you have a SQLServer or ORACLE database, you can run database reports that
provide statistical and diagnostic information. The Available Database Reports list
box contains four predefined reports (Space allocation, Object Reconciliation
Information, Schema Reconciliation Information, and Tuning Parameters). You
can create and list custom reports here by building your own Database Report
Definition (DRD) files. For more information, see “Creating Database Report
Definition Files.”
Click View Report Status to access the Database Report Status workspace. The
View Report Status link is active even if there are no reports listed in the Database
Report Status workspace. When there are no reports, an empty list appears.
Click Run Report to run a report. When you run a report, the Database Report
Status workspace appears automatically.
Clicking the Database tab or the Database link returns you to the Database
Information workspace.
Click Refresh to update the workspace with any new or updated data.
Note: You cannot update the workspace using your browser's Refresh button.
The system periodically deletes reports from this workspace if you do not
manually delete them. You can configure the length of time that it takes for a
report to be automatically deleted using the
site.database.all.dbreport.Report.RepTimeToLive key on the
Database settings tab. The value is expressed in hours and the default is 72 hours.
Clicking the Database link returns you to the Database information workspace.
The DRD file must contain all four attributes that the database reporting
framework needs to execute the report: name of the report, database platform ID,
SQL type, and SQL string. The attributes are expressed using Key and Value
pairs. The Key and Value pairs are:
! Name of the report
– The first key component can be anything, but the user must use it as the
first component for each of the four keys that comprise the DRD file.
– The second key component can be anything, but the user must use it as
the second component for each of the four keys that comprise the DRD
file. It must be unique among other DRD files. If the system detects a
duplicate value in more than one DRD file, then only the first DRD file is
displayed in the report list and any duplicates are ignored.
– The third key component must be reportName.
The entire key must be followed by the “ = ” string. Thereafter, the user may
specify any value as the reportname, for example Person Report.
Kronos recommends that you name the DRD file the same name as the report
to easily associate a report with its DRD file. For example,
sqlServerPersonReport.drd.
! Database platform ID
– The first component is the same as the first key component for the report
name attribute.
– The second component is the same as the second key component for the
report name attribute.
– The third key component must be dbPlatformID.
The key must be followed by the “ = ” string. Thereafter, the user may specify
either of the valid values SQLSERVER or ORACLE.
! SQL Type
– The first component is the same as the first key component for the report
name attribute.
– The second component is the same as the second key component for the
report name attribute.
– The third key component must be sqlType.
The key must be followed by the “ = ” string. Thereafter the user may specify
either of the valid values STANDARD or STORED. Since our hypothetical
example uses SQL, not a stored procedure, the value paired with this key is
STANDARD.
! SQL String
– The first component is the same as the first key component for the report
name attribute.
– The second component is the same as the second key component for the
report name attribute.
– The third key component must be sqlString.
The key must be followed by the “ = ” string. Thereafter the user may specify
either the executable SQL or the name of the stored procedure.
! Kronos recommends that you not use stored procedures, especially when
SELECT statements can be used instead. A stored procedure against a SQL
Server database will likely return a result set, but will not return report column
headers. As stored procedures become more complex, the result set(s) become
less predictable. A stored procedure against an Oracle database does not even
return a result set, so it does not produce a report at all.
If you specify a stored procedure (as opposed to actual SQL) to produce the
report, you must ensure that the compiled procedure resides in the database.
You can create a SQL Server stored procedure through Query Analyzer, or
you can pass a script file containing the Create Procedure statement to an
Open Database Connectivity (ODBC) or Java Database Connectivity (JDBC)
connection to build the procedure. In either case, you must have the
appropriate permissions to create objects in the database. Stored procedures
are compiled by issuing the Create Procedure command. Once compiled, they
reside in the database.
! If your Create Procedure statement has no syntax problems and is correctly
referencing existing DB objects, then the statement creates and compiles the
procedure. If there are problems that will not let the procedure be created in a
valid state, be aware that the procedure gets created but is in an INVALID
(un-compiled) state.
! You should test your SQL or stored procedure prior to executing it from the
feature. The application is not responsible for the correctness of the SQL, so
you must ensure that the SQL works as intended. Executing a bad DRD file
may or may not return anything in the way of a results set. Therefore, there is
no guarantee that you will see anything that will be helpful if you view the
report. The report appears in the Report Status page with a status of Failed.
! The application does not check to ensure that there is adequate disk space for
the report results file since there is no way to know in advance what the size
of the results file will be.
! You must be logged on as a user who has access rights to the System
Configuration features as well as full-access rights to the database. This logon
includes the user name that was specified at installation time, as well as the
username “SuperUser” and the usual password associated with that username.
! The purpose of the feature is to generate reports, not to perform updates (such
as inserts, changes, and deletes).
Licenses Information
The Licenses workspace allows you to view the current licensing information for
Workforce Timekeeper on the application server. You can view your license limit,
licenses in use, and the resulting license availability for each product.
Click Reread License Files to update the workspace with any new or updated data
from the license files.
The notification threshold at the top of the workspace specifies the number of
licenses left available before a notification is sent warning that the number of
available licenses is getting low. The threshold value is a percentage of the total
number of licenses. For example, if you have licenses for 1000 employees, and
the percent is set to 90, an e-mail notification is sent out when the number of
licenses in use reaches 900. You can edit the notification threshold by changing
the value in site.email.license.percent in E-mail Settings. You define
the notification e-mail address during the notification configuration process.
If you have multiple servers, you must install license update files on each server
and each server's license workspace must be refreshed for the additional licenses
to be available for that server.
Click Restart Server to restart the application server. You receive a confirmation
message before the restart occurs.
Caution: Clicking Restart Server causes the system to shut down immediately.
All user sessions are terminated with no warning.
Meters Information
The Meters workspace allows you to view the performance utilities that are
installed on the application server. By studying the results of running these meters,
you can assess the performance of your system and analyze peak usage periods.
To open a specific meter to view its results, click the blue triangle next to the
meter.
Click Reset to restore a meter to its initial state before the system collects any
data. The Reset feature is intended for debugging when you are working with a
Kronos Representative.
After you manually update any employee’s primary labor accounts, click
Resubmit All People for Account Update to submit all employees that qualify for
primary labor account updates. For information about updating employees
primary labor accounts in People Editor, see the online Help.
! A check box that indicates if the employee has been selected for primary labor
account updates
! Name
! Person ID from Database
! ID Field from People Editor
After you manually update any employee’s primary labor accounts, submit them
for primary labor account updates. For information about updating employees
primary labor accounts in People Editor, see the Help topic “Changing a person’s
profile.”
Clicking Primary Labor Account Update returns you to the Primary Labor
Account Update workspace.
Threads Information
The Threads workspace allows you to view, restart, and stop the long-running
Workforce Timekeeper daemons that are currently running on the application
server. Keep track of these daemons to see that they run as expected.
Each row shows information about one thread. Columns display information
about each thread:
! Restart—Click this button to Restart a thread that is Stalled or Stopped.
Works with an entry in the State column.
– Restarting a Controller thread restarts all the Worker threads that are
associated with it.
– Restarting a Worker thread has no effect on any other thread.
! User Name—Identifies the user who started the thread. If the system started
the thread, the value of User Name is blank.
! Description—Contains short definitions of each thread.
User Information
The User workspace identifies users who are currently logged onto the application
server. Information for each user appears in a separate row.
You can use this workspace to see who has logged on to the application server.
Users should have a separate system ID and should not all use superuser as a
login.
In addition to the logon time, the following information appears for each user:
! The Last Access column shows the last time that each user took an action in
the session. It also identifies users whose sessions have remained inactive for
a period of time.
! The Elapsed Time column shows how long a user session has lasted. This
column can also identify unusually long-running sessions.
! The Remote User column identifies the Internet Protocol (IP) address of the
user’s PC. If multiple users have the same User Name, the Remote User
column distinguishes between them.
Click Refresh to receive up-to-date values for Last Access and Elapsed Time.
This chapter explains the Log Report section of the System Configuration
component and describes the tasks that you use to work with log reports. This
chapter contains the following sections:
! Log Reports
! Log Files
! Log File Report
! Filtering and Running Log Reports
! Archiving System Log Reports
Chapter 3 Log Report
Log Reports
Use the Log Report workspace to specify parameters for a log report based on
information in the system log files. You can:
! Arrange this information into customized reports.
! Generate reports by using the default values or by specifying a log filter to
produce a more concise report.
! Distribute the reports by e-mail, by first highlighting, copying, and pasting the
log report output to a file, then e-mailing the log report file as an attachment.
Though you can access any log file with a text editor such as Wordpad, log files
can be large and unwieldy. You can create a customized log report using the Log
Report workspace. The default location for log reports is
{WFC.rootdir}\logs for Windows platforms and [installation
directory]/wfc/logs for UNIX platforms.
The Workforce Timekeeper system records system events for one application
server in one or more system log files. If you have a multiserver environment,
each application server has its own set of log files.
If you use the log for analysis and troubleshooting, you can print the report using
the print function in your browser.
! In Internet Explorer, click Print or right-click on the report page and select
Print.
! In Netscape, select File > Print.
Click Run Report to run a log report after you have selected filter criteria.
Click Refresh to restore the report defaults and update the server list with any new
servers attached to the same database.
Note: If you have multiple servers attached to your database, consider selecting a
subset of the entire list of servers instead of all servers. Selecting a subset of
servers lessens the possibility of memory errors. If you select a subset, you need to
run the log report several times with different servers listed each time in order to
get data from all of the servers. The extent to which you might have to select a
subset depends on multiple factors, such as the amount of memory on the host
server, the number of servers connected to the same database, as well as the
filtering criteria supplied for the log report.
Start Date and End Date—The Start Date and End Date specify a range of dates
and an optional time. The first value is always the Date. The report includes any
messages that were generated during the specified date and time ranges.
The purpose of this entry is to reduce the amount of information used for a report.
If you know that a specific context is involved with a problem, specify that
context to significantly reduce the amount of data that you read.
User Name—A User Name is a user session name associated with a message.
The log includes the system as a user. The default is All. Set this variable to a
specific user name to find all log entries associated with this user. To enter
multiple User Names, put a comma (,) between each user. A space is not required
between the comma and the next User Name.
Priority—This value determines the severity level display of the system log.
Severity levels are not inclusive, so you can request one level, several levels, or
All. The default value is All. Specifying All includes all available log levels.
You set the value of the site.log.loglevel property in the Log File tab of
the System Settings component.
You cannot use the percent sign (%) or the single quote (‘) in the text string.
Sort By—The Sort By filter arranges the report in the order of the selected
criteria. If a report is sorted by DATE, PRIORITY, and CONTEXT, the messages
in the report are ordered first by date, followed by priority order of ERROR,
WARN, INFO, DEBUG, and then the messages are sorted by selected context
groups. The default sort order is DATE.
Log Files
A system log can span multiple servers. The Server drop-down list shows all
application servers that are connected to the database that you are using.
Note: Log files might contain error messages that do not require you to take any
action. If you see error messages, but the system is in online mode and the task
that you are doing completes correctly, ignore the error messages. These error
messages are for tracking purposes only.
When your Workforce Timekeeper system was installed, the value of the property
site.log.file.name was set to WFC.log. The name WFC.log is used for
the first log file name in the drop-down list. While WFC.log has no number
associated with it, the remaining list entries have numbers. The WFC.log file is
the file currently being written. When WFC.log reaches its maximum size, the
file is renamed WFC.log.1, the names of all existing log files are incremented
by 1, and a new WFC.log file is created.
The number of log files available from the drop-down list depends on the number
of log files that you specified in the site.log.file.rollover.maxlogs
property. This property is available in the Log File tab of the System Settings
component.
! If you specified 0 (zero), the only log file written is WFC.log. When that file
is completed, it is emptied and rewritten.
! If you specified a number other than zero, you can have as many completed
log files as that number specifies.
The oldest log file in the system has the highest number. When all of the log files
specified in site.log.file.rollover.maxlogs are written, the oldest
log file is cycled out.
Note: Do not modify a log file using a text editor, as the log report expects a
certain format, and changes may prevent the report from displaying properly.
Note: These log report facilities are only available for the system log and do not
include information recorded in specialized logs for the Event Manager or
Reports.
You might see an Event Manager or a Reports exception in the system log.
However, you should examine the logs for those components, rather than relying
on the system log to inform you of a problem.
The oldest log file has the highest number. When all of the logs have been used,
the oldest one is recycled.
This chapter explains the System Settings section of the System Configuration
component and describes the tasks that you use to work with System Settings.
This chapter contains the following sections:
Overview
System Settings displays a set of tabs representing different characteristics of the
system that relate to your application server. Clicking each tab displays properties
for that area in a workspace that can be edited, and an action menu. This
component allows you to change the values for system properties and save the
changes in a custom property file.
System Settings are the configuration files that contain the properties and
parameters for configuring a server at the site. Typically, configuring a server is
done at installation.
If you have an administrator access profile, you can edit the system settings. After
the initial configuration, avoid editing settings except to fine-tune or adjust the
system for a different environment.
When you modify a property using System Settings, the system automatically
writes to the appropriate custom property file. You cannot inadvertently modify
the wrong file.
Most of these properties are site-specific and pertain to a single application server.
These properties are maintained in property files at the application server site.
Some properties are global in nature and pertain to all application servers in the
system. These properties are maintained in the database.
After editing a configuration value, verify that any changes that you make return
the correct results. This verification is important because the values that you enter
are not verified for appropriateness of the entry, spelling, or the number or type of
characters.
Changes that you make do not take effect until you restart the server. Click Restart
Server on each system settings tab to restart the Workforce Timekeeper server.
You receive a confirmation message before the restart occurs.
Caution: Clicking Restart Server causes the system to shut down immediately.
All user sessions are terminated with no warning.
Note: Restoring defaults has no effect on properties that are maintained in the
database. Modified database values remain modified.
! Restart Server—Click Restart Server to start the server again so that the
changes that you made can take effect. Restart Server causes the Workforce
Timekeeper server to shut down immediately. All user sessions are terminated
with no warning. Then, the server restarts.
! Add—The Printers and Data Source tabs contain multiple instances of one
property type. You can add one or more entries to describe a new instance of
the property.
To add another instance of a property, click Add. This creates a new empty
instance of the property name with the next sequential number attached to the
name. Then type the value of the new property. For example, you can add
another printer on the Printers tab. If printer.1 through printer.6 are already in
use, click Add to get the new property printer.7 and type the qualified name
for the seventh printer.
You can leave property instances empty. For example, if your list included a
property instance, printer.8, with the value MyPrinter;\\printer\print, and then
you removed this printer, you can delete the value and leave printer.8 empty.
If it has no value, the system ignores this property instance.
Some property instances are described by multiple properties. If you click
Add for an instance that requires multiple properties, you receive multiple
new properties for the new instance. For example, if you click Add on the
Data Source tab, you get new property names for dsnname.n.name,
dsnname.n.pwd.rsa, and dsnname.n.usr, where n is the next sequential object.
To add a new dsnname instance, you must provide values for all three
properties.
! Refresh—Click Refresh to update the workspace with any new or updated
data.
Note: If you make any changes to any of the system settings, you must restart the
Workforce Timekeeper server for the changes to take effect.
If you enter an invalid value, you receive an error message when you click Save.
The error message indicates the key and a general description of what is wrong.
All entries are saved at the same time. No property changes are saved for that page
if any validation errors occur, even if a single entry only fails. All errors must be
corrected and the page must be saved again.
Keys in each of the settings’ key and value details contain the following
information, where applicable:
! Whether the key is required
! A minimum value
! A maximum value
! A default value
Performance problems can occur when you start up the system with multiple
Callable Totalizers installed. This problem occurs because, when each Callable
Totalizer starts up, it loads a list of rules (pay rules, work rules, limit rules, and so
on) into its internal cache for better performance when running. On a large system
with many rules, this process can take 10 minutes or more.
A site can opt to run more than one Callable Totalizer. Each Callable Totalizer is
launched in sequence, and each one loads its cache of rules. Therefore, it takes
four times as long to start four Callable Totalizers. Thus, if it takes 10 minutes per
Callable Totalizer, it may take 40 minutes to start up four of them.
Once the system is running, we can expect four times faster throughput of
totalization requests, since four Callable Totalizers do the work. The operating
system performs delegation at runtime, plus any other load-balancing that might
have been specified at the site by the customer.
Value: required; minimum=1; installed default=1
If the application server and the database server are in different time zones, the
system ignores the difference in the time zones. The delta is calculated as if both
servers are in the same time zone.
Since clocks time can change as time passes, you can specify this synchronization
process to occur at multiple intervals throughout a day.
You can also synchronize the application server time and the database server times
by restarting the Clock Synchronize daemon on the Threads tab.
Database Settings
Database information shows values that are established during installation or
configured immediately after installation. These values are not likely to change
unless you switch databases or upgrade your system.
Different application servers can access different databases for different purposes.
For example, one server can connect to a test database, while other servers can
connect to a production database. This tab only reflects the database that this
application server is connected to.
If you modify a database property for one application server, be sure to make the
same modifications to all application servers that connect to the same database.
When you are restarting the server and your database is extremely busy, set this
key to a higher number to give your system the extra time it needs to make the
connection.
Value: required; minimum=1; maximum=30; installed default=5
site.database.all.dbutility.cleanUpThreadWakeUpInterval—Specifies how
often the DB Utility Clean Up Worker thread should wake up to check for
outdated records in the database utility temp tables. This value is specified in
seconds.
Switching Databases
You may need to switch databases at times; for example, from production to
test.
One database was identified when your system was installed and this is probably
your production database. Configuration settings for this database appear in the
WFCSite.properties property file.
Note: Use the database name in the URL when referring to a SQL Server
database and the database SID when referring to an Oracle database.
Note: Remember to reconfigure the application server after you are done
accessing the archive database.
10. Restart the Workforce Timekeeper server using the Start Workforce
Timekeeper icon.
11. In Workforce Timekeeper, select System Configuration > System Settings >
Data Source and change the values of the dsnname.1.usr and
dsnname.1.pwd.rsa properties to the user account name and the
associated password for the new database.
Note: Remember to reconfigure the application server after you are done
accessing the archive database.
Note: Properties with global scope across application servers are maintained in
database tables. If you switch databases, you must copy these properties to the
new database. For more information about properties in the database, see
“Working with Property Files” in Chapter 1.
When your Workforce Central application server was installed, the installer
provided the data source name, user ID, and password for an ODBC connection to
the database. This information was captured in the following properties:
! Dsnname.name
! Dsnname.usr
! Dsnname.pwd.rsa
Note: For SQL databases, the data source name must match exactly the data
source name in the computer’s ODBC setting.
Note: All DSN names must be unique. There is no validation on DSN names;
therefore, you must verify that there are no duplicate DSN names. If you find a
duplicate DSN name, edit the name and click Save.
Do not modify any properties in this setting unless you want the change to be
applied to all of the application servers in the system that are connected to the
same database.
After you click Save, any changes that you made are permanent. There is no way
to restore or reload the previous settings.
This DSN must also be configured in Workforce Central Setup, which is done at
the installation of the Workforce Central Setup application client.
Note: All DSN names must be unique. There is no validation on DSN names;
therefore, you must verify that there are no duplicate DSN names.
dsnname.<dsn number>.usr—The user name associated with the DSN used for
database access.
Note: All DSN names must be unique. There is no validation on DSN names;
therefore, you must verify that there are no duplicate DSN names.
When you click Add, the system adds the three property names, and you enter the
values. When you click Save, the three new properties are added to the
WFCDsnname table. There is no limit to the number of DSN entries that you can
add. The Data Source tab lists all the dsnnames in your system.
Note: An ODBC Data Source needs to be added any time that Workforce Central
Setup is installed on a PC and the DSN provided during installation is not the
same as any DSNs already listed on this tab.
All dsnname password properties are encrypted with RSA encryption standards.
The system automatically handles this type of encryption. If you add or modify a
dsnname password, you must enter the value using this tab and let the system
encrypt it.
Do not modify any properties in this tab unless you want the change applied to all
application servers in the system.
Note: Properties with a global scope across application servers are maintained in
database tables. If you switch databases, you must copy the appropriate properties
to the new database.
Properties with global scope belong to the property groups global, printer,
servers, and dsnname. For more information about properties, see “Working
with Property Files” in Chapter 1.
E-mail Settings
E-mail (also known as Workflow Notifications) settings enables you to establish
parameters for all notification e-mails that Workforce Timekeeper generates. For
more information, see “Working with Workflow Notifications” in Chapter 1.
Note: If you use Windows Code Page 1252 for your character set, you must
change the character set for e-mail to ISO-8859-x.
Note: During installation, you were prompted to enter a user name and password
for the application server to launch events. If you did not enter values, you will not
be able to schedule reports. You can enter the values into
site.eventmanager.NT.user and site.eventmanager.NT.pwd.
The time base for a scheduled event is the primary event manager server. It is
the master clock. The implications of this are especially important when using
multiple servers.
For example, if the application server that you are using is in Eastern Standard
Time (EST), but the Task Scheduler is on the primary event manager server
which is located in Pacific Standard Time (PST), the events that you schedule
are based on PST time, which is the time on the primary event manager
server.
! The Event Manager log—The Event Manager and the Microsoft Task
Scheduler do not use the system log. If an exception occurs, the event might
be reported to the system log. Event Manager exceptions are always reported
in the Event Manager log.
Specify properties for the Event Manager log in the Event Manager tab as
follows:
– site.eventmanager.logEnabled—Set to true. (For UNIX
platforms, set this value to false.)
– site.eventmanager.logPriority—Enter a priority.
– site.eventmanager.logName—Enter a log and path name.
The Event Manager log does not use parameters that are set for the system
log. Unlike the system log, you must manage the Event Manager log directly.
If a problem develops, your Event Manager log file can grow quickly. The
Event Manager writes log messages to a single file with no size limit. Monitor
this file on a regular basis to determine if you need to delete information.
Report facilities are not available for the Event Manager log. You must
browse the complete log using a text editor.
! Severity level—The value of the severity level for the Event Manager log is
set in the site.eventmanager.logPriority property as 1, 2, or 3;
where the levels are equivalent to system severity levels of ERROR,
WARNING, or DEBUG, respectively. See “Log File Settings” in this chapter
for a description of the severity levels in the system log.
Note: You should keep the Event Manager log enabled most of the time. If Event
Manager is running normally, little information is written to this log. However, if
a problem develops, the initial log entries are invaluable in diagnosing and
correcting the problem. The recommended severity level is ERROR; that is,
site.eventmanager.logPriority = 1. Kronos Global Support might
ask you to set a different level for a short time.
4. Start the Workforce Timekeeper server using the Start Workforce Timekeeper
icon.
5. For Windows NT only, stop and restart the Task Scheduler Service:
a. Select Start > Settings > Control Panel > Services.
b. Select Task Scheduler in the list of services.
c. Click Stop.
d. Click Start.
6. Wait 15 minutes.
7. Repeat steps 4 - 6 until all events are rescheduled on the MS Task Scheduler.
Caution: Do not modify any properties in this setting unless you want the
change applied to all of the application servers in the system.
Properties with global scope across application servers are maintained in database
tables. If you switch to a new database, you get the global value settings that relate
to that database. You can copy properties settings to a new database. See
“Working with Property Files” in Chapter 1 for more information.
After you click Save, any changes that you made are permanent. There is no way
to restore or reload the previous settings.
If your database server and application server are located in different time zones
than some or all of your employees, set this property to the database servers’ time
zone. If time zones are not an issue, set the property to the Default value.
Value: required; installed default=DEFAULT
global.wfc.html.framework.tableNavigatorDefaultMaxPages—Defines the
number of sections that each table navigation element will display at once.
Value: required; installed default=10
global.wfc.html.framework.tableNavigatorDefaultPagesize—Defines the
number of rows that will display per table selection.
Value: required; installed default=25
global.LongList.ManagerSummaryEmployeeThreshold—Maximum number
of employees that can be displayed in a Detail Genie.
Value: required; minimum=1; installed default=1000
global.LongList.ScheduleSummaryEmployeeThreshold—Maximum number
of employees that can be displayed in a Scheduling Genie.
Value: required; minimum=1; installed default=200
Note: If you change this setting, you must restart the Workforce Timekeeper
server for the change to take effect.
global.TransactionAssistant.StartDateTime.DefaultNumberOfHours—The
number of hours in the past for setting the default start date and time used for
displaying errors in the Transaction Assistant.
Value: required; minimum=1; maximum=8784; installed default=72
global.Wtk.MaxDaysToDisplayPayChecksInEarningHistory—The maximum
number of days to display paychecks in earnings history.
Value: required; minimum=1; maximum=365; installed default=365
global.WtkScheduler.MaxDaysToMarkScheduleOutOfDate—Informs the
background processor the maximum number of days in the future that schedule
changes do not need to be totalized. This keeps the background processor from
recalculating totals needlessly. For example, if you add a shift to an employee
three months in the future, there is no need to inform the background processor
since the shift addition does not affect any current totals.
Value: required; minimum=1; maximum=365; installed default=31
global.WtkScheduler.MaximumDaysInFutureToCreateShifts—Scheduled
shifts that follow a pattern are populated into the future. Since a pattern could be
forever, the system must limit their population and, from time to time, populate
them further into the future. This value limits how far in the future shifts are
created at any one time. The default value is 270 days. Approximately every week
the system populates these forever patterns out to 270 days from that date.
Increasing this value allows users to see shifts further into the future, while
decreasing this value decreases the amount of disk space needed to hold all of the
shifts.
Value: required; minimum=0; installed default=270
global.WtkScheduler.MaximumNoOfRuleViolatsionsSentToClient—The
maximum number of rule violations sent to the client from the server. If a
threshold is not defined, the system uses 50 as the maximum number of rule
violations. When the rule violation translator attempts to get the rule violations, it
stops at the maximum defined. If the maximum is exceeded, a message displays
on the rule violations tab indicating that it exceeded the display limit of x.
Value: required; minimum=1; maximum=100000
0 = off
1 = on
Value: required; installed default=0
global.WtkTotalizer.ApplyScheduledAccountsInNonPfsWorkedAmounts—
Controls whether or not scheduled transfers are applied to Worked Amounts in
Project View, on days for which Pay-From-Schedule is not in effect.
Possible values are:
global.WtkTotalizer.getEmpToTotalizeInactiveBGPMinutes—The
background processor (BGP) uses this key to determine whether to select
employees who are already undergoing background processing on another BGP. If
the specified amount of time has not passed, the BGP will not pick up the
employee. The value of this key is multiplied with the value in
global.WtkTotalizer.getEmpToTotalizeChunkSize. The resulting
number is the number of minutes that the system uses to evaluate whether to
collect an employee. If an employee has remained in the In Process state for the
resulting number of minutes, the system determines that the other BGP has failed
to process that employee and thus collects them for reprocessing.
global.WtkTotalizer.IdleMinutesBeforeRetroTotalization—The number of
minutes that the background processor has to be completely idle before it can start
the retrototalization processes.
global.WtkTotalizer.MaxDaysInFutureEventAffectsTotalization—The
maximum number of days in the future that events, such as punches, affect the
range of totalization. The background processor ignores timecard or scheduled
events that are greater than this number of days in the future. This minimizes the
load to the background processor, which improves system performance. If you
need to project certain data far into the future, such as accrual balances, make sure
that you set this key sufficiently high to accommodate the desired window.
Value: required; minimum=0; installed default=365
global.WtkTotalizer.MinimumDaysInFutureForActualTotals—Minimum
number of days in the future that the database contains actual totals. This setting
specifies how far out in the future that the background processor will totalize
actual data for an employee.
Value: required; minimum=1; maximum=366; installed default=3
global.WtkTotalizer.MinimumDaysInFutureForScheduledTotals—Minimum
number of days in the future that the database contains scheduled totals. This
setting works with the Store Scheduled and Projected Totals check box in pay
rules. The background processor calculates scheduled and projected totals for
employees. The global.WtkTotalizer.MinimumDaysInFutureForScheduledTotals
setting specifies how far out in the future that totalization is performed.
Value: required; minimum=1; maximum=366; installed default=3
global.WtkTotalizer.MinimumInactiveDaysWithoutTotalingActuals—
Minimum number of days that the Callable Totalizer can view without retotaling
an employee with no activity.
Value: required; minimum=1; maximum=60; installed default=7
global.WtkTotalizer.MinimumInactiveDaysWithoutTotalingSchedule—
Minimum number of days that the Callable Totalizer can view without retotaling
the schedule for an employee with no schedule changes.
Value: required; minimum=1; maximum=60; installed default=7
global.WtkTotalizer.PaycodeMovesAreContributingShifts—Determines
whether pay code moves contribute to holiday calculations. It specifies whether
moving hours from one pay code to another has an impact on the shift history for
holidays with Work History Qualifiers. Set to yes to have pay code moves
contribute to holiday calculations.
Value: required; installed default=no
Note: A system error occurs if you do not configure your multiserver environment
properly.
Because Group Edit data is maintained in the database, any application server can
perform the delete and recovery functions. The application server with the
site.groupedit.primaryServer property set to true is the one
specified to run the Delete and Recover threads.
site.groupedit.RequestHandler.numberOfGroupEditThreads—Number of
Groupedit Threads used for processing (in numbers).
Value: required; minimum=0; installed default=20
site.groupedit.RequestHandler.ReusableHandlerController.pollingInterval—
Polling interval for ReusableHandlerController thread (in minutes). This interval
must be less than the polling interval for ReusableGroupThread.
Value: required; minimum=0; installed default=60
site.groupedit.RequestHandler.ReusableGroupThread.pollingInterval—
Polling interval for ReusableGroupThread (in minutes).
Value: required; minimum=0; installed default=300
The numbers in the Java Plugin installer, version, and CLSID multi version match
the JRE version. Some example of values are:
Locale Settings
The Locale settings determine how the date, times, and language appear in
Workforce Timekeeper components. These settings are an expansion of the basic
regional settings on the Web server.
Note: You must restart the Workforce Timekeeper system using the stop and start
Workforce Timekeeper icons in order for new values of any language or country
keys to take effect.
Note: The order of the day and month must match that of the natural order of the
Locale.
Note: The order of the day and month must match that of the natural order of the
Locale.
site.local.DAY_MONTH—The display format for the date when only the month
and day of the month are displayed.
Value: required; installed default=M/dd
Note: You must specify the same value for this property on every application
server associated with one database.
Note: You must restart the Workforce Timekeeper system in order for a new value
of site.local.charset.encoding to take effect.
You must change the code page if your database contains text in a language that
Windows Code Page 1252 does not support.
If you do not use Windows Code Page 1252 for your character set, you must
change the character set for e-mail to the appropriate ISO-8859-x in the
site.email.language.charset key. For more information about the
site.email.language.charset key, see “E-mail Settings” in this
chapter.
Value: required; installed default=Western European (Windows Cp1252)
You can specify to use a single log file or multiple log files, and a maximum log
file size for your server.
If you specify using a single log file, WFC.log is rewritten when it reaches its
maximum size. If you specify multiple log files, WFC.log is renamed to
WFC.LOG.n, where n is the number of the next available log (1, 2, and so on).
When the last log that you specify is filled, the oldest log is reused.
You do not have to click Restart Server to start the server again so that the changes
you made can take effect. The change takes place when you save the new value.
Caution: When you save the value, the system shuts down immediately. All user
sessions are terminated with no warning.
site.log.file.name—Name and path of system log file. If the name is a simple file
name, then the log file is located relative to the Workforce Timekeeper root
directory.
Value: required; installed default=WFC.log
Caution: Do not change any parameters on this page without direction from
Kronos Global Support since the parameters are for debugging purposes only.
This information represents contexts that you want to make available for the
system log. Any site.loggingContext property that you specify here
appears in the Context drop-down box of the Log Report component.
Portal Settings
The Portal settings establish the way that elements appear on the user interface.
0 = no handle
1 = image handle
2 = character handle
Printers Settings
The Printers setting workspace lists all the printers that have been defined for your
system. Each printer must be visible to the server. The system uses these printers
when Print is selected when running Reports. If a report is viewed first, then the
printer selection comes from the browser, not this list. You can add or remove a
printer from this list. As printers are added to your system, their names are added
to the WFCPrinters table.
Anything that you print using your browser’s print command is not printed to a
server-based printer. Instead, it is printed to the printer that is associated with your
PC.
As part of the installation process, the installer provided the name of one printer to
be used for server-based printing such as reports scheduled in Event Manager. The
system captures this information and writes it to a temporary property file
SitePrinter.properties. When the system is started for the first time, it
reads the SitePrinter.properties file, updates the database with that
information, and then renames the SitePrinter.properties file with .1
appended to the name so that it does not get processed again.
Click Add to add a new printer to the current list. When you add a server-based
printer, enter its virtual name, path, and a comment. Use a semicolon (;) to
separate the names; for example:
where WFC Printer 1 is the name that appears in print dialog boxes.
Properties with global scope across application servers are maintained in database
tables. If you switch databases, you must copy the appropriate properties to the
new database. See “Working with Property Files” in Chapter 1 for more
information.
Caution: Do not modify any properties in this setting unless you want the
change applied to all of the application servers in the system.
After you click Save, any changes that you made are permanent. There is no way
to restore or reload the previous settings.
! The first part is the printer name to appear in the printer selection list.
! The second part is the path that maps to the printer.
! The third part is the printer group.
Example: WTK Printer 1;\\printserver\printer; Group1
JRun is installed under a Windows NT user account. That user must have access
rights to all printers listed in the Printers tab. When you add a printer to the
system, someone with Full Control access rights for the print server must log onto
Windows NT to make the printer accessible to the JRun user account.
Reports Settings
The Reports settings establish the reporting properties. Before users can create
and schedule a report, you must establish the reporting properties using this
information.
Note: For UNIX platforms, reports are on the companion Windows server.
Security Settings
Security settings establish an offline environment and specify the authentication
mode that your application server uses.
When the system is in offline mode and the database is not accessible, the user
must log on using the offline URL.
An authentication of the user name and password occurs. The user ID and
password must match those in Workforce Timekeeper's records.
Examples:
! LDAP://<your LDAP server name>/ou=<your organizational unit>, o=<your
organization name>
! WinNT—support for multiple Windows NT domains
! WinNT://<your NT Domain name>—support for a single Windows NT
domain
! OTHER://provider=<Authentication Module>;property=<Authentication
Module property file>
site.security.html.ess.global.QTS.confirmationTimeout.Seconds—Sets the
redirect timer on the Quick Time Stamp - Time Recorded page within Workforce
Employee - HTML Client. This value determines the display length of the results
page prior to redirection back to the Quick Time Stamp page.
Value: required; minimum=1; maximum=60; installed default=10
The default authentication model for the URLDispatcher is device only requests.
If you want the URLDispatcherServlet to default to accept requests from any
browser, not just the browser on the 4500, substitute DeviceOnlyAuthentication
with AnyBrowserAuthentication.
For example:
site.security.authentication.urldispatcher=com.kronos.wfc.wfp.urldispatcher.secur
ity.AnyBrowserAuthentication
Understanding Authentication
Authentication is the validation of a user name and password by a trusted
authority. The system makes different kinds of authentication modules available.
Note: Regardless of the type of authentication that you specify here, the following
accounts always use Kronos authentication: SuperUser, Totalizer, TaskRunner,
and DCM’s user accounts.
Note: This is the local and default authentication scheme. The user must exist
in the database to which the server is attached. Changing databases when
using PROPRIETARY authentication may cause authentication problems.
The authentication source must be the same across domains.
! WinNT
If you use a WinNT value without specifying a domain, Workforce
Timekeeper proxies the authentication request to a Windows domain server as
specified as part of the user name at logon. Windows validates the user ID and
password.
This setting is used for supporting authentication against multiple Windows
NT domains. Workforce Timekeeper user names must be specified as
<domain name>\<user id>; for example, CORPORATE_DOMAIN\dgormley.
This entire value is the full user name value stored in the Workforce
Timekeeper user account table and shown in all views, Genies, and reports.
When users log on to Workforce Timekeeper, they enter their full user name
in the logon screen; for example, CORPORATE_DOMAIN\dgormley. The
corresponding Windows user “dgormley” must exist in the
“CORPORATE_DOMAIN” domain.
Some additional Windows domain configuration may also be required. The
Workforce Timekeeper Server machine is defined as a member of some
domain, for example, the A domain. If the Workforce Timekeeper server
needs to authenticate users that are defined in domains B and C, then domains
B and C must be configured to be trusted by domain A.
! WinNT://<your_NT_domain> (not available for UNIX platforms)
For example, WinNT://CORPORATE_DOMAIN
If you use a WinNT value, Workforce Timekeeper proxies the authentication
request to a domain server. Windows validates the user ID and password. For
WinNT authentication, the user name must match the Kronos user name
recorded in the Workforce Timekeeper database.
This setting is used for supporting authentication against a single Windows
NT domain where all of the Workforce Timekeeper users have Windows
accounts in one domain.
! LDAP://<your_LDAP_server_name>/ou=<your_organizational_unit>,
o=<your_organization_name>
For example, LDAP://tdyernt/ou=people, o=kronos.com
If you specify LDAP, Workforce Timekeeper proxies the authentication
request to a Lightweight Directory Access Protocol (LDAP) server. LDAP
validates the user ID and password.
See your WinNT or LDAP documentation for information about these
processes. Regardless of which process you use, the user ID must match the
recorded ones in the Workforce Timekeeper system’s database tables. For
LDAP authentication, the LDAP user id (uid) attribute must match the Kronos
user name recorded in the Workforce Timekeeper database.
! OTHER://provider=<Authentication Module>;property=<Authentication
Module property file>
This uses a custom authentication method. This custom authentication method
uses the module identified by <Authentication Module> to validate the
Workforce Timekeeper user’s credentials, which is usually a username and
password. This module is configured using the <Authentication Module
property file> properties file.
One use of custom authentication is for custom LDAP authentication. This is
implemented in a module installed with Workforce Timekeeper, and can be
used as an alternative to the default Workforce Timekeeper LDAP
authentication method. This custom LDAP authentication module can
accommodate a wide range of LDAP configurations.
See Appendix F, “Custom LDAP Authentication Method” to configure
Workforce Timekeeper to use Custom LDAP module.
Service Settings
Service settings establish properties related to the application server.
A number of property files contains templates for SQL statements that the system
uses. When your system was initially configured, files containing SQL statements
that conform to your requirements were selected. These files do not change and
are specified as the following:
site.service.sql.strings.file.{first, second, third}
site.service.business.LL.MAX_MOST_RECENT_USED_ITEMS—Number
of most recently used transfer settings available for reuse.
Value: required; minimum=1; installed default=5
site.service.business.LL.MAX_LABOR_LEVEL_ENTRIES—Maximum
number of named entities displayed at the client, such as labor level entries, non-
organizational jobs, labor level sets, and HyperFind queries.
Value: required; minimum=1; installed default=1000
site.service.ShiftBuilderController.MaxTriesBeforeGivingUp—Defines how
many times the ShiftBuilderControllers should try a thread before giving up.
Value: required; minimum=1; maximum=5; installed default=5
site.service.ShiftBuilderController.MaxShiftBuilderControllers—The
maximum number of concurrent shift builder controllers. To optimize the memory
and speed of an import, adjust the maximum number of controllers. The specific
setting depends on the available memory and the memory requirements of each
import item. More ShiftBuilderControllers use more memory, but may improve
speed. Use zero (0) to suppress the shift builder.
Value: required; minimum=0; maximum=20; installed default=2
site.service.business.type.TimePeriodType.MAX_DAILY—The maximum
standard hours for daily time period.
Value: required; minimum=0; maximum=24; installed default=24
site.service.business.type.TimePeriodType.MAX_WEEKLY—The maximum
standard hours for weekly time period.
Value: required; minimum=0; maximum=168; installed default=168
site.service.business.type.TimePeriodType.MAX_PAY_PERIOD—The
maximum standard hours for pay period time period.
Value: required; minimum=0; installed default=744
Startup Settings
The Startup settings control how the Workforce Timekeeper system starts up.
! If test.startup.offline is set to true, the offline services are started
(ExtensionDiscoveryService, PropertiesExtensionLoaderService,
PluginService, PlatformManagerService, PreLoadServletsService, and
ApplicationInstaller). If any of these offline services fail to start, the system
becomes unavailable. No online services are started, the system starts in
offline mode, and users must log on using the offline logon mode.
! If test.startup.offline is set to false, the system starts in online
mode. False is the default and means the system attempts to start the online
services, including ServiceSphere, which attempts a database connection.
Timekeeping Settings
The Timekeeping settings deal with timekeeping information.
To change the settings, click in the text box of a property and type the new entry.
site.timekeeping.optimistic_lock_buffer_size_in_minutes—Specifies the
amount of time, in minutes, to add to the end of the time period to verify that there
are no conflicting edits to the employee’s timecard before performing a save
function. The system automatically verifies that no other changes have been made
in the same time frame. This key lengthens the time period to be checked.
Value: required; minimum=0; installed default=0
site.timekeeping.historicalEditsIncludeInCurrentTotals—Determines if the
Include in totals for effective date check box is selected by default in the
Historical Amount dialog boxes when creating historical edits.
Value: required; installed default=false
site.timekeeping.retroHistoricalEditsIncludeInCurrentTotals—Determines if
the Include in totals for effective date check box is selected by default in the Add
Historical Amount with Retroactive Pay dialog box when creating historical edits
with retroactive pay.
Value: required; installed default=false
site.timekeeping.cacheSizeForTimesheetItemSeqNums—Number of sequence
numbers obtained by the application server at one time for use in updating the
TIMESHEETITEM table. This key is used for performance tuning.
Value: required; minimum=0; installed default=1000
site.timekeeping.cacheSizeForPunchEventSeqNums—Number of sequence
numbers obtained by the application server at one time for use in updating the
PUNCHEVENT table. This key is used for performance tuning.
Value: required; minimum=0; installed default=1000
Transformation Settings
The Transformation settings is used as a data transformation service for any
services, such as reports.
Value Definition
http Standard mode
https Secure mode
system Applets will use the protocol determined from the HTTP
request, which is the protocol used to request the applet.
site.webserver.QTS.maxRoundTripNetworkLatency.seconds—Defines the
maximum network latency time for the Quick Time Stamp (QTS) result page
requests. You can select an alternate network latency time for the QTS in the event
the round trip from client to server exceeds 1 second. You might use this setting in
situations such as if you are using the QTS application across a satellite
connection and the one-way transfer time is equal to or greater than 500
milliseconds. Possible values for this key are 1, 2, 3, 4, and 5.
Value: required; installed default=3
This chapter contains information about working with reports in the Workforce
Timekeeper system. This chapter contains the following sections:
! Overview
! Generating a Report
! Generating Custom Reports
Chapter 5 Reports
Overview
The Workforce Timekeeper system works with a runtime version of Crystal
Reports v9.0 to deliver reports that can provide complex information to users. You
can use the complete Crystal Reports v8.5 or v9.0 software to create custom
reports.
Note: You must use the drivers appropriate for your database that are supplied by
Crystal Reports v8.5 or v9.0 to create a custom report. You cannot use the drivers
used by the Workforce Timekeeper application.
For UNIX installations, Reports and Event Manager are run on the companion
Windows server. Reports are generated on the companion Windows server, and
after they are complete, they are copied back to the UNIX server. If you are
logged on to the UNIX server, any access to a previously completed report
originates from the UNIX server’s cache of these reports in the directory as
specified.
Adobe Acrobat Reader 4.05 or 5.0 must be installed on all browser clients that are
used to access reports.
Terminology
The following terms are used in connection with reports:
Term Description
background options or Other options set up to display information in the report header.
parameters You can set up background options to identify selected option
values, display calculated totals, display a HyperFind query
name, specify security for wages data, display the name of the
person who runs the report, and format time values.
Background options are specified in the Crystal Reports
definition and in the Report Setup component of Workforce
Timekeeper. Users cannot select or modify these options or
option choices when they request a report.
Term Description
custom options Additional report options in addition to the standard report
options. An identifier of a runtime question that allows users to
enter values to qualify the results that appear on a report.
custom report A report created specifically for your organization. You can use
the Workforce Timekeeper system with Crystal Reports software
to generate these additional reports for users.
foreground options or Choices selected when users request a report in the Reports
parameters component and passed to Crystal Reports to control the result set
of a report query. These options are established for any report
definition in Crystal Reports and then in the Report Setup
component of the Workforce Timekeeper system.
options Workforce Timekeeper settings that indicate viewable items or
report selection criteria.
option or parameter A selectable value for an option or a parameter. For example, if
choice the option or parameter is Absences, then the choices are
Unexcused, Excused, or Both.
parameters Crystal Reports report definition settings that indicate viewable
items or report selection criteria.
The Workforce Timekeeper options and the report definition
parameters must match exactly.
report The combination of a report item and a report definition.
report definition A Crystal Reports file that, with a report item, creates a report.
Crystal Reports always have an .rpt file extension.
report instance Generated by the system when a user requests a report.
report item An object in the Workforce Timekeeper database that specifies
the report name, options, and other information, and provides a
link to the Crystal Reports report definition file.
standard report A report provided by the system. See the Reports component
online Help for descriptions of standard reports.
Reports Directory
Report definitions are stored in the directory that you specify in the
site.reporting.rpt.files property.
This directory contains standard report definitions. The definitions are in .rpt
format; you cannot view them directly without Crystal Reports software. Do not
modify the contents of this directory. (Windows platforms only)
Directory Description
DBReports Directory used by the Database Reports feature. Contains two
subdirectories:
! DRD—repository for the database report definition (drd) files
! results—repository for the database report result files
OtherReports Directory for custom report definitions. Like the reports in
KronosReports, they are in .rpt format; you cannot view them
directly without the complete Crystal Reports software.
(Windows platforms only)
reportoutput Subdirectory for report instances. You can format these instances as
.pdf, .htm, .xls, .doc, or .rtf files.
other files, such as Other files in this directory are for the internal use of the system.
exceptions.pdf Do not modify them.
Reports Server
The process that Workforce Timekeeper uses to generate a report depends on your
selection in the Reports user interface:
! If you run a report to view on the screen, the request is handled by the reports
engine of the application server that you are logged into, if the application
server supports reports.
! If you print, e-mail, or schedule a report, Event Manager processes the
request. Event Manager searches for a list of available report servers, chooses
a server at random, and submits the report request to that server as an HTTP/
XML request.
If you run many reports to view on the screen, you can improve system
performance by creating one or more application servers dedicated to generating
reports. You do this by disabling the report service on the primary application
server that handles user authentication and enabling the report service on the
application server where you want to run reports:
1. Log on to the primary application server or the application server where you
want reports to run.
2. Select System Configuration > System Settings > Reports on the
navigation bar.
3. On the site.reporting.engine.enable key, click true or false
according to the type of server that you are setting up.
When the primary application server receives a report request from a client, it
either runs the report itself (if the report service is enabled), or it delegates the
request to other servers (if the report service is disabled). It does not have the
discretion to run the report at certain times and to relay the request elsewhere at
other times.
If you disable the reports service on the primary application server and enable it
on one reports server only, the primary application server directs all requests to
run reports to the reports server.
If you set up more than one reports server, the primary application server gives
every report server an equal opportunity of receiving report requests by doing the
following:
1. When an application server starts, it registers itself in the database. The server
is added to a list of servers in the ServerInfo service, and the report server
receives that list of servers via the ServerInfo service.
2. When you run a report to view on the screen, the request goes to the
application server to which you are logged in.
! If the application server’s report engine is enabled, it generates the report.
! If the report engine is disabled, the report request is passed to another
server.
When a report request has to go to another server, the request searches the list
of servers in the ServerInfo service and sends the report request to the first
report server on the list. If that server is not online, the request goes to the next
server in the list.
Subsequent report requests go to the next available report server on the list,
and the process goes on until all report servers have run a report. Two
consecutive reports do not go to the same report server unless it is the only
report server.
Report Logs
The Reports function does not use the system log. By default, a reports log is
generated for each agent that you specify in the following property:
site.reporting.MaxNumRepAgents
Accessing Reports
The following factors determine how the Workforce Timekeeper reporting facility
is used:
! The Reports component on the Workforce Timekeeper navigation bar enables
a general user to select and run an existing report. The report can be a standard
report or a previously created custom report. For more information, see
“Generating a Report” in this section.
! The Report Setup component under Common Setup on the navigation bar in
combination with Crystal Reports software enables you to create custom
reports. After you create a report, it is available to general users through the
Reports component. For more information, see “Generating Custom Reports”
in this section.
! The Reports tab in the System Settings component allows you to establish
properties that are in effect for all reports. For further information, see
“Reports Settings” in Chapter 4.
Note: Although reports for a UNIX application server are generated on the
companion Windows server, the results are stored on the UNIX server in a
subdirectory.
The system provides a runtime-only version of Crystal Reports; you do not need
to purchase a copy to view, print, or e-mail a report instance of any standard
report.
Access reports from the Reports component on the navigation bar or by clicking
the Reports icon where available from the launch bar of any Workforce
Timekeeper component, including Genie, the Timecard editor, or the individual
schedule. Users can run a report immediately for online viewing, printing, or
inclusion in an e-mail; or set up a scheduled event to produce the report at a
specific time or scheduled interval, in a specified output format, and to a specified
destination.
Double-click the report or select View Report to view a report online that has a
screen output. The PDF-formatted report opens unless you selected a different
output option.
! site.reporting.totalizer.threshold and
site.reporting.totalizer.threshold.megaproblem—If the number of retries
specified in site.reporting.totalization.retries is exhausted
and totals for all employees have not been calculated, the values of these
properties determine how the system handles the report:
– If the number of employees with uncalculated totals is less than or equal
to the value of site.reporting.totalizer.threshold, then
the system produces the report, listing the failed employees.
– If the number of employees with uncalculated totals is greater than the
value of site.reporting.totalizer.threshold, but less than
the value of site.reporting.totalizer.threshold.
megaproblem, the report does not list the failed employees, but simply
contains a count of them.
– If the number of employees with uncalculated totals is equal to or greater
than the value of site.reporting.totalizer.threshold.
megaproblem, the report is not run. Instead, the system generates a
failure message.
Generating a Report
Use the Reports component on the Workforce Timekeeper navigation bar to
generate a report. The Reports workspace lists all reports, both standard reports
and custom reports that you can create. When you select a report from the list, a
description appears to the right of the report list.
When you select a report and click Set Options, the Options list appears. You can
use the Options list to do the following:
! Identify any options for which the user can select choices or accept the default
values.
! Specify the format of a report instance if it is being e-mailed.
Initiate a report job by clicking Run Report. The report job combines a report item
and a report definition to create a report instance.
In a multiserver environment, a user can initiate a request for a report from any
Workforce Timekeeper application server, and the system can run the report on
any Windows server designated as a Workforce Timekeeper report server. The
system automatically copies the report instance to the server that initiates a
request to access it. The user can then log on to any application server via a
browser to see the completed report, which always appears to reside on the local
application server.
For a multiserver environment, you need access paths and write access
permissions for all of the Windows servers designated as a Workforce Timekeeper
report server in your environment. The standard report definitions are installed in
the KronosReports directory. You must install any custom report definitions to the
kronos/wfc/reports/OtherReports directory on each of these report servers.
Note: If you fail to add a custom report definition to every Windows application
server, the user sees the report listed in the Reports component, but may not be
able to run it.
Although you can query the Workforce Central database with other reporting
tools, the integration of Crystal Reports and the Workforce Timekeeper system
allows you to use a number of facilities not available with other reporting tools.
Using Crystal Reports and the Workforce Timekeeper system allows you to do the
following:
! Use the Event Manager component to schedule a report instance to run at a
specific time or at specified intervals.
! Send your completed report instance to a printer, your browser, or to an e-mail
recipient from within Workforce Timekeeper.
! Use the HyperFind query to select people or the location chooser to select
locations for a report instance.
Note: Standard Scheduler reports which use the report accelerator process can
only be customized by duplicating and modifying a report item that has the Uses
Accelerator(s) check box selected. You cannot select the Uses Accelerator(s)
check box since it is unavailable.
Standard or other views, or tables may be joined to the original accelerated report
views if additional information not on the original report view is required.
However, since this additional information is not an accelerated view, report
performance could be impacted.
Standard Scheduler reports that use the report accelerator process can only be
customized by duplicating and modifying a report item that has the Uses
Accelerator(s) check box selected. You cannot select the Uses Accelerator(s)
check box since it is unavailable.
Note: When you open duplicated reports in Crystal Reports to customize, the
database and password assignments from the original Kronos development
database are retained in the Set Location preferences. You need to set the
datasource location to your database in order to run the report in the Crystal
Reports development application.
A report file name must be unique. To see the file name of an existing report,
access Common Setup > Report Setup on the navigation bar, and click a report
in the Name column. The file name appears in the Report File Name text box.
Many reports display totals calculated by the system. Calculations are usually
needed for the following:
! Pay codes and amounts
! Accruals and amounts
! Absences and exceptions
! Schedules
! Sign off
! Holiday credit data
If your report contains calculated totals, the report definition and the report setup
item must reflect this.
The report item for a report that requires totaled data contains a flag that identifies
this requirement. The system passes any report item with this flag to the Totalizer,
a background process that the system periodically activates to run for a specific
period of time and calculate totals.
When the system generates a report instance that uses totaled data, each employee
record in the HyperFind result set is examined to see if the totals are up to date. If
they are up to date, the report is run. Otherwise, the report is queued for a
Totalizer session. If, after the Totalizer session, employee records remain with
totals that are not up to date, the system returns the report to the queue and waits
for another Totalizer session.
The number of times that the system can return a report to the queue depends on
the value in site.reporting.totalization.retries and the length of
time that it waits depend on the value in
site.reporting.totalization.interval. For more information, see
“Reports Settings” in Chapter 4
To determine whether your report needs totals, consider the following situations:
! A report that does not use employee-specific data does not need totals; for
example, Break Rules report.
! A report that displays only the names of people does not need totals; for
example, a report about users who are unable to log on to the system.
Reports that do not need totals can include:
– People
– Accrual Pool Balances
– Badge Numbers
– Zone Rules
To determine whether an existing report uses totals, access the Report Setup
component. On the navigation bar, select Common Setup > Report Setup and
then click a report. If the report uses totals, the Contains Totals Data check box is
selected.
The requirement for totals is retained in the totalsw column of the reports
table in the database, where a value of 1 means that totals are used and a value of
0 means that they are not.
If your report contains employee data, using a HyperFind query simplifies your
report request. To determine whether an existing report uses a HyperFind query,
access the Report Setup component. On the navigation bar, select Common Setup
> Report Setup and then click a report in the list. If the report uses a HyperFind
query, the Requires HyperFind Query check box is selected.
Because only employee data is totaled, you cannot have a report that displays
totals without also using a HyperFind query. However, your report can use a
HyperFind query, but not require totals.
If the report displays calculated totals, set up the Crystal Reports report definition
to accept a HyperFind query. Do this using the Crystal Reports Record Selection
Formula, and include the following statement:
Otherwise, if the report does not display calculated data, the Record Selection
Formula of the report must include:
<table or view name>.personid = -411,
where table or view name is replaced by a table or view name in your
query that has a personid column.
When a report instance is run, the employee or person IDs in the HyperFind query
result set replace the –411 marker, thereby limiting the resulting report instance to
those employees or people whom the HyperFind query returns.
The HyperFind replacement string must be the first selection criteria, and the
format must be <table.column> = -411
This replacement works because of the integration between the Crystal Decisions
software and the Workforce Timekeeper system, and does not work unless the
report is linked within the Workforce Timekeeper system.
Caution: Never enter this Selection Formula directly into the WHERE clause of
the report. Workforce Timekeeper does not support any modifications to the SQL
statement made in the Show SQL Query option in Crystal Reports.
If your report displays employee data, it is likely to have a time period option in
effect so that you can limit results to a specific time period. Time period can be for
pay periods or nonpay periods. Pay periods can be different for each employee on
a report. Nonpay period time periods contain the same date range for all
employees.
Many of the Workforce Timekeeper database views include employee pay period
dates. When you request both pay period and non pay period time periods, the
Record Selection Formula uses a special formula.
The following code example illustrates a time period Record Selection Formula
for the report definition:
If you select a time period for any non pay period type, the Timeframe Type
passed to the report file is a number between 3 and 11. If you select a Pay Period,
the Time period Type passed is as follows:
When you select a pay period time period, the From Timeframe and To
Timeframe parameters receive datetime values. The Workforce Timekeeper
system calculates the earliest From Timeframe value and the latest To Timeframe
value for every employee in the report, and passes those values to the report
parameters, thereby providing optimum performance for the report query.
When you select a non pay period time period, the From Timeframe and To
Timeframe parameters get the dates pertinent to the time period selected. The
system ignores pay period portions of the formula.
Users of Workforce Timekeeper who are not employees do not have pay periods
assigned to them.
Identify the Workforce Timekeeper Report options needed for the report, which
are specified in Report Setup. Respective Crystal Reports options are specified as
part of the report definition.
You can select foreground options values when generating a report instance, but
not background options. Background options are used to display foreground
option values selected for a report instance, or to pass a value to a report to control
formatting, or for us in calculations. Options selected for a report item must also
be configured on the Crystal Reports definition, otherwise errors might result
when creating a report instance. The only allowable difference between these
options is that the Crystal Reports option names can be written in uppercase,
lowercase, or mixed case.
Report Options
Background/
Option Name Description Foreground
Absences Select Unexcused, Excused, or both F
Absences hd Displays the selected Absence types B
Actual/Adjusted Select Actual or adjusted amounts F
Actual/Adjusted hd Displays the selected Actual/Adjusted B
choice
Db timezone Displays the timezone of the database B
server
Decimal Format Formats time format to hh:mm or hh.hh B
Employee page break Select No or Yes to page break on each F
employee
Employee page break hd Displays the selected page break choice B
Exceptions Select one, multiple, or all types of F
Exceptions
Exceptions hd Displays the selected Exception Types B
From Timeframe Passes starting date for timeframe F
selection
Function Access Profiles Select one, multiple, or all function access F
profiles
Function Access Profiles hd Displays the function access profiles B
selected
Gmt server offset Returns the time difference, in seconds, B
between the timezones of the database
server and the reporting server
Holiday Credit Type Select Credited, Denied, or both F
Holiday Credit Type hd Displays the selected Holiday Credit B
Types
Import Type Select one, multiple, or all Import Types F
Background/
Option Name Description Foreground
Import Type hd Displays the selected Import Types B
Import Batch Select one import batch or latest F
completed batch
Import Batch hd Displays the selected Import Batch B
Labor level count Displays the number of labor levels B
defined in the database
Not Updated Emp List hd Passes list of employee/person IDs that B
are not up to date
Not Updated Emp Count hd Passes count of employee/person IDs that B
are not up to date
Pay Codes Select one, multiple, or all pay codes F
Pay Codes hd Displays the selected Pay Codes B
Printed For Displays the user name who ran the report B
Query Name Displays Hyperfind Query name B
Request Time hd Displays the time that all calculated totals B
are up to date
Timecard Audit Type Select one, multiple, or all audit types F
Timecard Audit Type hd Displays the Audit Types selected B
Timeframe hd Displays the timeframe selected B
Timeframe Type Passes the selected timeframe type B
To Timeframe Passes ending date for timeframe F
selection
Wage Permission Determines if wages appear on report B
based on function access profiles
The last column identifies all available choices for an option and the internal
values that the system passes to Crystal Reports for these option choices.
! An entry of the form name:number identifies a named choice and the
internal code that represents it; for example, Unexcused:0.
! An entry of the form name:[..same] identifies entries that have the same
internal and external values; for example, Adjusted:1. Only string or
datetime entries have the same values internally and externally.
! An entry of the form count:name1|2... identifies a count of the number of
choices for that option followed by each option name; for example,
Count:PayCode name 1|PayCode name 2.
! An entry of the form name:n/m identifies an external value of name and an
internal value of n/m. Two internal values are separated by a comma (,).
Multiple/
Discrete Column Available Choice:
Option Name Type Values? Typically Linked Internal Value Passed
Absences Number Multiple Excusedsw Unexcused:0
Excused:1
Both:0,1
Absences hd String Discrete -- Unexcused, Excused, Both:[--same]
Actual/ Number Discrete Actual:0
Adjusted Adjusted:1
Actual/ String Discrete -- Actual, Adjusted:[--same]
Adjusted hd
Db timezone String Discrete -- “GMT +/- hrs: DB Timezone Name”:[--
Same]
Decimal Number Discrete -- Hh:mm:1
Format Hh.hh:0
Employee page Number Discrete -- No:0
break Yes:1
Employee page String Discrete -- No, Yes:[--same]
break hd
Multiple/
Discrete Column Available Choice:
Option Name Type Values? Typically Linked Internal Value Passed
Exceptions String Multiple absentexcepttypeid Cancelled Deduct:0/1,1/1
Early In:1/2
Late In:1/3
Long Break:1/4
Holiday Skipped:0/5
Min. Days Active Violation:0/6
Min. Days Empl. Violation:0/7
Missed In Punch:1/8
Missed Out Punch:0/9
Short Break:1/10
Unscheduled:0/11,1/11
Very Early In:1/12
Late Out:0/3
Work History Violation:0/14
Long Interval:0/4
Short Shift:0/10
Early Out:0/2
Very Late Out:0/13
Exceptions hd String Discrete -- Count:exception name1|2…:[--same]
From Datetime Discrete Any datetime Datetimevalue:[--same]
Timeframe column
Function Number Multiple Vp_accessprofile. Accessprofile.profilenm:
Access Profiles accessprofid accessprofile.accessprofid
or
Accessprofile.
accessprofid
Function String Discrete -- Count:function access profile 1|2….
Access Profiles
hd
Gmt server Number Discrete -- Seconds:[--same]
offset
Holiday Credit Number Discrete Exceptionsw Exceptions Only:0
Type Credits Only:1
Both:2
Holiday Credit String Discrete -- Exceptions Only, Credits Only, Both [--
Type hd same]
Multiple/
Discrete Column Available Choice:
Option Name Type Values? Typically Linked Internal Value Passed
Import Type Number Multiple importcntnttypeid Labor Level Entries:1
Labor Level Set:2
People:3
Accrual Dates:4
Accruals:5
Punches:6
Pay Code Edits:7
Sched. Pay Code Edits:8
Schedules:9
Import Type hd String Discrete -- Count:Import Type Name1|2…:--
Import Batch Number Discrete Importbtchstatid Specific batch: importbtchstatid\0
Latest completed batch: importbtchstatid\1
Import Batch String Discrete -- Batch Name and Date:[--same]
hd
Labor level Number Discrete -- Number:[--same]
count
Not Updated Number Multiple employeeid’s:[--same]
Emp List hd
Not Updated Number Discrete Number of employeeid’s:[--same]
Emp Count hd
Pay Codes Number Multiple paycodeid Paycode.name:paycode.paycodeid
Pay Codes hd String Discrete -- Count:Pay Code name1|2…:
Printed For String Discrete -- Logged in user name:[--same]
Query Name String Discrete -- Hyperfind query name:[--same]
Request Time Datetime Discrete Max datetime all employees on report have
hd up to date calculated totals:
[--same]
Multiple/
Discrete Column Available Choice:
Option Name Type Values? Typically Linked Internal Value Passed
Timecard String Multiple Vp_timecardaudit. Add Duration:-1/0/30/1/, -1/0/30/0/,
Audit Type audittimesheetid -1//30/0/0
Edit Duration: -1/6/30/0/, -1/6/30/1/
Add Punch: -1/0/-1/0/, -1/0/-1/1/,
-1//-1/0/0,-1/0/4/0/0,-1//4/0/0/,-1/0/2/0/0,
-1/0/1/0/0,-1//2/0/0/
Edit Punch: -1/0/40/0/, -1/6/-1/1/, -1/6/-1/1/
, -1/6/-1/0/, 1/5/-1/1/,-1/5/4/1/1,-1/5/2/1/1
Add Pay Code: -1/0/20/1/, -1/0/20/0/,
-1/0/22/0/, -1/0/21/0/, -1//20/0/0,
-1/0/23/0/,12/-1/-1/-,-1/0/55/0/
Edit Pay Code: -1/6/20/1/, -1/6/20/0/,
-1/1/20/0/
Delete Pay Code: -1/5/20/1/
Timecard String Discrete -- Count:Audit Type 1|2…
Audit Type hd
Timeframe hd String Discrete -- Timeframe Name or Specific Dates:
Wage Permissions
The wage permission option grants report and system display access, where some
people can view the wage information and others cannot. This option is generally
passed directly to a formula or field on a report that prints wage amounts, and
does not display the formula or field to those users who do not have this
permission in their function access profile.
The function access profile of the person preparing the report determines the value
of this option, using a setting in Workforce Central Setup > Access Profiles >
Function Access Profiles. For any function access profile, wage permissions are
in Workforce Manager System Configuration > Setup (Windows client) >
Wage Profiles Setup.
Background Options
Most background header options have names ending in hd and are generally
placed on the report as headers for foreground options. Other similar appearing
background options are the Query Name, Printed For, Db timezone, and Labor
level count hd.
! If you use a HyperFind query, the Query name parameter in the report header
displays the name of the HyperFind query.
! The Printed For parameter appears on all standard reports in the header to
indicate the user who requested the report. However, if the report is
scheduled, the User Name that is associated with the scheduled job appears
instead.
The employee group that is associated with the user who is logged on
determines the employees that can be seen on the report.
Decimal Format
This option determines if time appears in hh:mm or hh.hh format, and the format
is passed directly to formulas that display time. The function access profile of the
person preparing the report determines the value of this option, using a setting in
Workforce Central Setup > Display Preferences > Display Profiles > Time
Display Tab > Duration display group.
After you set up and test a custom report file, copy it to the
{WFC.rootdir}/wfc/reports/OtherReports folder for each Workforce Timekeeper
application server in your system that is configured as a report server.
To avoid errors, you must know the network or physical location of every
application server. If a user selects a report that is not on the application server
that executes a report instance request, an error results.
Standard reports use a special function named GetLabel() that allows the labels
and strings that appear on Crystal Reports to be stored in an external file named
u2li18n.ini. This allows one Crystal Report file to be able to display strings in
other languages without modifications to the report file. The GetLabel() formula
accesses keys in the ini file to find a specific text string and retrieve it to a report.
The same key can be used on multiple reports.
When creating custom reports, you should hard code the strings directly on the
Crystal Report file. This keeps any changes to the .ini file with version upgrades
from affecting your report labels. To hard code strings directly, modify the report
file by replacing any GetLabel() functions with strings.
Note that you can continue to use the GetLabel() function and .ini file to supply
the strings for custom reports, but be aware that labels or keys can change or be
deleted after a version upgrade, which could require modifications to custom
reports. Modifying the u2li18n.ini file is not recommended as it will be deleted
during a version upgrade. The GetLabel() function will return ‘null’ if it is unable
to retrieve a string for any reason.
If you duplicate and modify a standard Crystal Report and choose not to delete all
references to the GetLabel() function, the report will not run until your pc is
modified for Crystal Reports to recognize this function. This function is specific
to Kronos applications and is not included in the Crystal Reports software.
To set up the GetLabel() function on the pc where you are running the Crystal
Reports software so that the report can be run and strings displayed:
1. On a WFC reporting server, copy {WFC.rootdir}\wfc\bin
directory\U2LI18N.dll to \\Program Files\Common
Files\Crystal Decisions\2.0\bin.
This allows Crystal Reports to see the GetLabel() function.
2. On a WFC reporting server, copy
{WFC.rootdir}\wfc\applications\wtk\properties directory\U2LI18N.dll to
\\Program Files\Common Files\Crystal
Decisions\2.0\bin.
This allows the GetLabel() function to access the strings in the .ini file.
3. On your pc where Crystal Reports is installed, add an environment variable to
Windows named UFLINIFILE with path: \\Program
Files\CommonFiles\CrystalDecisions\2.0\bin\u2li18n.
ini.
This also allow the GetLabel() function to access the strings in the .ini file.
Note: Standard Scheduler reports that use the report accelerator process can only
be customized by duplicating and modifying a report that has the Uses
Accelerator(s) check box selected. You cannot select the Uses Accelerator(s)
check box since it is unavailable.
6. Select the Contains Totals Data check box if your report displays employee
totals.
If selected, then the Requires Hyperfind Query check box is automatically
selected; you cannot have totals data without also having the HyperFind query
in your report file.
7. In the Time Periods drop-down list, select time periods from the drop-down
list that relates to the Time Periods in the report definitions. Choices include
the following:
– None: The report does not use timeframes.
– Specific Date: The report accepts a single date. If you select a specific
date timeframe, the .rpt file still contains the From Timeframe and To
Timeframe parameters; the application passes two dates. For example,
1/1/2001 12:00:00 A.M. and 1/1/2001 11:59:59 P.M.
– Date Range Only: The report accepts exactly two dates. You cannot
specify Pay Periods or Week to Date.
– All: All timeframes selections are available, including pay period
selections.
– Schedule Periods: All time frame selections are available, except for pay
periods.
If you duplicated and modified a report file, you can also duplicate the report item
shown in the Report Setup component. To do this:
1. Select Common Setup > Report Setup.
2. Select the report to be duplicated, and click Duplicate.
Except for the Name, Description, and Report File Name entries, all attributes
of the selected report item are duplicated, including Categories.
Note: Standard Scheduler reports which use the report accelerator process can
only be customized by duplicating and modifying a report item that has the
Uses Accelerator(s) check box selected. You cannot select the Uses
Accelerator(s) check box since it is unavailable.
3. Specify a unique name to identify the new report in the Name text box.
4. Type any descriptive text such as a description of the report in the Description
text box.
5. In the Report File Name text box, type the unique file name of the crystal
report that you placed in the OtherReports directory of every application
server.
The file type extension is not necessary.
6. To be able to select employees whenever you run this report, select the
Requires HyperFind Query check box.
Remember that the Crystal .rpt file must also be configured to use HyperFind.
7. To include totalized data, select the Contains Totals Data Totals check box.
8. Select the appropriate time periods for use with this report from the Time
Periods drop-down list.
Remember that the Crystal .rpt file must be configured to use these same time
periods.
9. To assign this report to a category, click Categories and select one or more
categories.
Note: Custom reports can use either standard Workforce Timekeeper Reports
options or custom options that you create. For information about creating
custom options, refer to “Creating Custom Options.” The options you select
for the custom report item must also be configured as part of the Crystal .rpt
file.
Note: Custom options only work with custom reports. For information about
creating custom reports, see “Generating Custom Reports” in this section. For
information about adding custom report items to Workforce Timekeeper Reports,
see “Setting Up the Workforce Timekeeper Report Item” in this section. The
Workforce Timekeeper documentation does not describe creating parameters
within Crystal Reports.
Note: At runtime, users have the ability to enter values not included in the
Pick List using the Ad Hoc Value text box.
The new custom option and its header option, if you have chosen to create one,
now appear in the same list of available options within the Report Setup
workspace as the standard options and any custom options that were previously
created. This option can now be selected and saved along with the particular
report item(s) for which it was created.
Note: After configuring a custom option, you may have to refresh the workspace
in order to see the new option in the list.
! Workforce Timekeeper does not support the ability to set default values for
custom options.
! When selecting a custom option for a custom report in Report Setup, make
sure that you select both the main option and the corresponding header option,
if applicable.
! The option name in Workforce Timekeeper and the parameter name in Crystal
Reports must be the same.
! The properties, such as value type and multiple value setting, applied in the
Custom Options setup must match those entered as part of the definition of
the parameter in Crystal Reports.
! You can use a custom option with one or more custom reports as long as the
report definition file for the custom report contains the matching custom
parameter.
! If a custom report using custom options is scheduled, the custom option
values set before scheduling are the values that are used for the scheduled
report.
! When creating a header parameter in Crystal Reports, you must give it the
same name as the main parameter followed by a space and then “hd.” For
example, a header parameter corresponding to a main parameter named
“Labor Level 1” would be named “Labor Level 1 hd.” The value type for
header parameters must be “string” and header parameters should be set to
receive one value.
! Custom options of type date and time are not intended to override the standard
time period selection for a report. Instead, use date and time options to further
define criteria for selecting data from an already qualified time period or in
reports that do not rely on a time period selection.
The Workforce Timekeeper system provides predefined data to simplify the task
of configuring your system. These values help you to configure your system
quickly. You can modify some predefined data; for example, the default logon
profile. You cannot modify other predefined data, such as labor levels. See the
online Workforce Central Setup Help for information about working with the
predefined data, such as adding data access profiles.
Note: Before you move from Workforce Central Setup to the Workforce
Timekeeper System Configuration component, save the changes that you made in
Workforce Central Setup and then close the Workforce Central Setup application.
Doing this ensures that these changes will appear in the Workforce Timekeeper
System Configuration component.
Appendix A Predefined Data
The system does not provide predefined labor levels and, therefore, does not
provide predefined roll-up Genies. You define roll-up Genies during initial
configuration. All predefined Genies are either Detail Genies or Schedule Genies.
Workforce Genies
To access Workforce Genies:
1. Start Workforce Central Setup.
2. Double-click the Display Preferences icon.
3. Expand the Workforce Genies.
4. Double-click one of the Workforce Genies predefined entries:
Display Profiles
To access the Display Profiles:
1. Start Workforce Central Setup.
2. Double-click the Display Preferences icon.
3. Select Display Profiles.
4. To access one of the following predefined Display Profiles, double-click the
name on the right side of the workspace.
You can edit predefined Display Profiles.
Kronos Global Support uses the Super Access profile, which provides access
to all settings.
The settings for the Default predefined display profiles are:
Tab Settings
Time Display ! The duration display is specified as HH:mm.
! Display Time is in 12-hour format.
! Scheduled shift display is shift start and stop times.
Labor Account ! The Show Labor Level Entry description on mouse-over
in Timecard Editor is selected.
! The Use Shorthand Labor Account notation entry is
selected for all labor levels.
Job ! The Show Job and Location description in tool tips on
mouse over is selected.
Timecard ! The project-view start day is Monday.
! The Edit future timecards box is not selected.
! Timecard Editor Totals are displayed by labor account.
Manager Selections ! The Schedule Period is set to weekly.
! No default Workforce Genie Profile is provided.
! No default Custom URL Profile is provided.
! No Workload Planner Profile is provided.
To add a new labor level or to edit an existing label level, click the Labor Level
Transfer Set drop-down list in the Workforce Manager or the Workforce
Employee group and select an entry from the list. Then click New or Edit.
HyperFind Query
To access the HyperFind query:
1. Log onto the Workforce Timekeeper system.
2. Expand the Common Setup component in the navigation bar.
3. Select HyperFind Queries.
You can edit predefined HyperFind Queries.
To add a new HyperFind query or to edit an existing query, select an entry from
the list. Then click New or Edit.
People
The SuperUser person is not accessible. However, to access people other than the
SuperUser:
1. Log onto the Workforce Timekeeper system.
2. Use QuickFind to select an existing Workforce Employee or Workforce
Manager.
3. With the person selected in the QuickFind workspace, click the People launch
button to access the People Editor.
Kronos Global Support uses the Super Access profile, which provides access
to all settings. You cannot edit the Super Access profile.
Logon Profiles
To access the Logon profiles:
1. Start Workforce Central Setup.
2. Double-click the Access Profiles icon.
3. Select Logon Profiles.
4. To see a predefined logon profile, double-click the name on the right of the
workspace.
You can edit predefined logon profiles.
Function Access Profiles are the mechanism with which Workforce Timekeeper
defines what different types of users can see and do in each area of the Workforce
Timekeeper system. The following predefined Function Access Profiles define
access for typical Workforce Timekeeper users:
! Super Access—This profile provides access to all settings. Kronos Global
Support uses the Super Access profile.
! IS—This profile is for technical IS personnel who are involved with all
aspects of the system. Predefined data for the IS profile includes access to
most functions, including Application Program Interface (API), System
Configuration component, and Workforce Central Setup. This profile does not
include access to wage information.
! IS Using Organizational Maps—This profile is the IS profile with the
ability to use jobs effectively within the system.
! Payroll Manager—This profile is for managers who are involved with
various aspects of the payroll function. Predefined data for this profile
includes access to most functions, including Timecard Editor, Workforce
Genies, Scheduler, Workforce Central Setup, and access to wages for others
and oneself. This profile does not include access to the APIs or the System
Configuration component.
! Payroll Manager Using Organizational Maps—This profile is the Payroll
Manager profile with the ability to use jobs effectively within the system.
Appendix B Function Access Profiles
! Other Manager—This profile is for managers who are not involved with
payroll, for example, department or scheduling managers. Predefined data for
this profile includes access to all timecard and scheduling functions. It does
not include access to the APIs, the System Configuration component,
Workforce Central Setup, or any wage information.
! Other Manager Using Organizational Maps—This profile is the Other
Manager profile with the ability to use jobs effectively within the system.
! Professional Employee—This profile is for non-management personnel who
can enter their own timecard information, using an hourly or project view, and
produce selected reports. This profile includes access to My Timecard, My
Schedule, and My Reports. It does not include access to any manager
functions.
! Professional Employee Using Organizational Maps—This profile is the
Professional Employee profile with the ability to use jobs effectively within
the system.
! Salaried Professional Employee—This profile contains most of the same
settings as the Professional Employee profile, and is used primarily for
demonstration purposes. This profile is included only in kdemo databases.
! Scheduling Manager—Intended for managers using Workforce Scheduler.
Predefined data for this profile includes access to schedule functions, such as
availability, schedule rules, and Workload setup.
! Time Stamp and Hourly Employee—This profile is for non-management
personnel who can enter their own timecard information, using a Time Stamp
view, and produce selected reports. This profile includes access to My
Timecard, My Schedule, and My Reports. It does not include access to any
manager functions.
! Time Stamp and Hourly Employee Using Organizational Maps—This
profile is the Time Stamp and Hourly Employee profile with the ability to use
jobs effectively within the system.
You can modify these predefined profiles or create new profiles by defining
individual access control points that make up each Function Access Control
profile.
Note: The function access point tables in the “Function Access Profile Tables”
section contain the base set of function access points. Asterisks (*) in the function
access point columns followed by a new abbreviation code indicate settings that
are different when organization maps are used.
Note: The gold function access profiles for use with Organizational Maps and
Jobs are not installed automatically for upgrade installations, but are
automatically installed for new installations.
Table Conventions
For the tables in the remainder of this appendix, abbreviations for access rights
settings are:
Table Legend
For the tables in the remainder of this appendix, the table legend is:
! IS=Technical IS personnel
! PM=Payroll Manager
! OM=Other Manager
! PE=Professional Employee
! SPE=Salaried Professional Employee
! SM=Scheduling Manager
! TSHE=Time Stamp and Hourly Employee
! TSE=Time Stamp Employee
! Asterisks (*) in the function access point description columns indicate
settings that are not available for the Workforce Employee - HTML Client
application.
! Asterisks (*) in the function access point columns followed by a new
abbreviation code indicate settings that are different when organization maps
are used.
Everyone Category
These access control points control access to functionality available to manager
users and employee users.
APIs Category
These access control points control the ability to log onto the XML interface.
This chapter contains information about the registry keys that were set up when
your Workforce Timekeeper system was installed. This appendix contains
information about:
! Windows Registry Keys
! UNIX Registry Keys
Appendix C Registry Keys
! [HKEY_LOCAL_MACHINE\SOFTWARE\Kronos\WFC\Cross
Launch\WTK]
Access profile column=none
Executable=nodialog.exe -iconfigApps.icx
Function description=Foo
Function identifier=TKCS
Function name=Timekeeper CS
Home directory=C:\Kronos\wfc\Config
Icon Preference=LAUNCHER
Launcher icon file=
Product latitude=
Product name=
Toolbar icon file=none
By default, Workforce Timekeeper uses regional settings that are appropriate for
most North American English-language environments. However, if you install the
French or Spanish version of Workforce Timekeeper, or if you are in an
environment where you want to modify the default regional settings, you need the
information in this appendix.
French and Spanish versions are available as part of the product suite, and you can
select these versions when you install the product. For information, see the
Workforce Timekeeper Installation Guide for Windows or the Workforce
Timekeeper Installation Guide for UNIX.
The user’s operating system must match the locale version of the Workforce
Timekeeper installation.
At any time after you install Workforce Timekeeper, you can use the Local Values
section of System Settings to set regional formatting information for date and
currency displays for the application server. Workforce Timekeeper records this
information in the WFCSite.properties file.
When you have multi language environments, you would use one or more URLs
for each application server that you have configured for each language. Individual
users can then display a GUI with the correct language by entering the appropriate
URL for that language’s application server.
When you define text strings, Workforce Timekeeper reads those strings from the
database and displays the strings as you defined them, regardless of the GUI
language of the application server. Language settings within the browser do not
affect any displays.
The text for online Help is in a set of HTML files in the Help directory and its
subdirectories.
Date and Time Data and Display—Date and Time data associated with a punch
that was entered using the Web originates from the application server. Depending
on context, Workforce Timekeeper uses either the time zone associated with the
user’s People record or the time zone in the WFCSite.properties file.
Date and Time data associated with all other actions (for example, audit trail
information) originates from the regional settings of the application server’s
operating system.
For the Time display, Workforce Timekeeper uses the employee’s Display Profile
to determine whether to display the time in 12-hour or 24-hour format. The
default values for Time and Date display are determined by the country selected
during the installation. This information, which you can modify at any time, is
stored in the WFCSite.properties file.
Use the 24-hour format or two-letter time markers if the time markers have the
same first letter. For example, in English, you can type 8a to indicate 8 o’clock in
the morning, and 8p to indicate 8 o’clock in the evening. In Hungarian, you must
enter 8de or 8 to indicate 8 o’clock in the morning, and 8du or 20 to indicate 8
o’clock in the evening.
The currency setting determines the view and entry format. For example, a
Canadian user who has a currency setting of United States views and enters
currency in the U.S. format (for example $8.50) and not in the Canadian format
(8,50$). For additional information about currency settings, see “Currency
Support” later in this chapter.
The amount formats for time (for example, durations) is based on the user’s
Display Profile for displaying durations (either HH:MM or HH.hh).
Text Display—Report file sets (.rpt files) are installed in English, French, and
Spanish language versions on the application server. The language that Workforce
Timekeeper displays is determined by the language that you selected during
installation.
The display format for dates in reports is determined by the country settings for
date display in the application server’s operating system.
Text and Online Help—The language of the text in the GUI and the online Help
are based on the language selected in the PC’s operating system.
The display format for dates in Windows applications on client PCs is determined
by the country settings for date display in the PC’s operating system.
The amount formats for time (for example, durations) is based on the user’s
Display Profile for displaying durations (either HH:MM or HH.hh).
Note: The Kronos 4500 Terminal v1.2 supports English, French, or Spanish
languages and the Latin 1 character set.
Text Display—Data collection devices display text that is already included in the
product, such as error messages, only in English.
Text that you have entered in the database (for example, employee names or labor
level entries) is displayed as you entered it. However, only ASCII fixed characters
can display at the terminal.
Date and Time Data and Format for Punches Using a Timekeeper terminal—
The Date and Time associated with a punch entered using a Timekeeper terminal
is based on the time zone set for the terminal in Data Collection Manager (DCM).
The display format for the Date and Time is set for the terminal in DCM.
Database Servers
A single database can serve all users. The users see the text exactly as it was
entered into the system. For example, assume a company with English- and
French-speaking employees uses a French application server and an English
application server. If all pay codes are entered in English, they appear in English,
even when viewed in the French user interface.
While multiple languages within a single character set can use a single database, a
database can only use one character set. For example, a company that uses English
and French can use the same database for both languages since they are both
Latin-1 languages. A company that uses English and Romanian languages would
need to have two databases since English is part of the Latin-1 character set and
Romanian is part of the Latin-2 character set.
Application
Database Server
Windows Platforms Platforms
Character Set ISO Series Code Page Supported Supported
Latin 1 (Western European) ISO-8859-1 1252 Oracle, Windows NT,
SQL Server, Windows 2000
DB2 UDB Solaris, AIX
Latin 2 (Central European) ISO-8859-2 1250 Oracle Windows NT,
Windows 2000
Latin 9 (Western European ISO-8859-15 1252 Oracle, Windows NT,
with Euro Symbol) SQL Server Windows 2000
If you use a language other than English, Spanish, or French, you may need to
modify the code page setting. For more information, see “Locale Settings” in
Chapter 4.
If you do not use Windows Code Page 1252 for your character set, you must
change the character set for e-mail to the appropriate ISO-8859-x in the
site.email.language.charset key. For more information about the
site.email.language.charset key, see “E-mail Settings” in Chapter 4.
Currency Support
The Workforce Central database supports a single currency. The display format is
determined by the currency, country, and language settings specified in System
Settings. If no format is specified in System Settings, then the currency setting is
based on the country that you selected during installation. The currency setting
determines the display format and entry format.
For example, a company that has English-speaking U.S. employees and French-
speaking Canadian employees will use two application servers (one English, one
French) that connect to a common database. Since the database only supports one
currency format, the company has decided to enter all monetary units in U.S.
dollars. Users who are connected to the French Canadian application server will
view and enter currency in the U.S. format. (for example, $8.50) and not in the
Canadian format (8,50$).
Kronos recommends that all applications servers be set to support the same
currency format. If application servers are set to support different formats, users
on different servers may become confused about the monetary information they
view and enter, and the monetary amounts might be misconstrued.
You can modify the text of many of these predefined names. However, if you do,
the French or Spanish version displays only the modified name and not the
translated name.
Preconfigured names in reports are not translated. For more information, see
“How Workforce Timekeeper Displays Data and Text: Browser Applications.”
If you change the preconfigured names within one of the predefined elements
without changing the name of the predefined elements, the translation of the
predefined element name remains intact. For example, if you modify the name of
one of the fields in the Time Detail Report, the name “Time Detail Report” is still
correctly translated in the French or Spanish versions.
The following table shows the predefined names and whether you can modify
them.
Kronos recommends that customers who use multilanguage environments, use the
following procedures:
1. For pay codes, work rules, and reports, create duplicate data in the alternate
language.
2. Then, assign data access profiles to each user with the appropriate data in the
appropriate language (assign data access profiles that use English terms to
English-speaking employees, assign data access profiles that use French terms
to French-speaking employees, and so on).
You can set up Single Sign-on by performing the following three procedures:
! Configuring Workforce Timekeeper
! Configuring JRun with Netegrity/SiteMinder
! Configuring SiteMinder
Appendix E Single Sign-On
Configuring SiteMinder
To configure SiteMinder, do the following:
1. Create SiteMinder Policy Server schemes for Workforce Timekeeper (WTK).
a. Create an anonymous authentication scheme named WFCAnon.
For example, WFCAnon contains “ou=People, dc=Kronos, dc=com” for
the User DN.
b. Create a basic or form authentication scheme named
WFCFormAuthentication
To run the LDAPConfig utility, enter the following at the command line:
! Windows:
java -classpath
"c:\kronos\wfc\lib\apihooks.jar;c:\kronos\wfc\lib\l
dapWFC.jar" LDAPConfig
! UNIX:
java -classpath "/usr/local/kronos/wfc/lib/
apihooks.jar:/usr/local/kronos/wfc/lib/ldapWFC.jar"
LDAPConfig
The properties value set in ldap.properties are set by the LDAPConfig utility in
response to your input. These properties are the following:
! ldap.ldap.url—The address and port that the LDAP server is listening on.
The address can be either a fully qualified domain name (FQDN) or an IP
address. The port is optional and the default port is used if you do not specify
one. The default port is 636 for SSL and 389 for non-SSL.
Example:
ldap.ldap.url=arius.com—LDAP server is listening on airius.com,
the default port of 389 will be used.
ldap.ldap.url=127.0.0.1:8934—LDAP server is listening on the
local system port 8934.
! ldap.protocol—The protocol used to communicate with the LDAP server.
Possible values are either ldap for non-SSL, or ldaps for SSL.
The Workforce Central diagnostic tools are designed to assist in diagnosing run
time, Workforce Central Web server, and services errors.
Note: Some of the diagnostic tools require you to have the JRE Plug-in installed
on the application server.
4. Click Send.
The diagnostic tool lists the results in the Reply box.
4. Click Start.
The diagnostic tool sends an e-mail to the address listed in the ToEmail box
and lists the results in the Results box.
Note: This tool can only be run if the Diagnostic Tools client setup is installed at
the Workforce Central server.
4. Click Launch.
The user’s e-mail client opens. If the e-mail client is displayed with the same
information that appears on the MailToTester page, then the application works
correctly.
5. In the e-mail client application, click Send.
This validates that the information is parsed correctly and that the e-mail is
being sent to the individual designated in the To: box.
Note: This tool can only be run if the Diagnostic Tools client setup is installed at
the Workforce Central server.
4. In the FTPServerName box, enter the Kronos Global Support Services FTP
server name.
5. Click Start.
The buttons at the bottom of the FTPLogFilesDiagnostic dialog box disappear
while the tool is running.
The diagnostic tool lists the results in the Message box. A restart button
appears when the tool is finished running.
For example, there are many ways to organize user information in the datastore.
The simplest method is to have all user information kept in one group, called an
organizational unit (ou) in LDAP, in the hierarchy. A more common method is to
store user information in multiple organizational units.
There are also different methods that LDAP can use to authenticate users.
Anonymous, super/root, or individual authentication can be used. Workforce
Central LDAP authentication can be used with all of these LDAP configurations.
You can use this Workforce Central properties file to test that the Workforce
Central LDAP authentication code performs as expected using the customer's
LDAP datastore.
Note: You could use the LDAP Configuration Diagnostic Tool to validate if a user
is in an organizational unit (ou) in LDAP by performing the first step only.
4. Click Save to save the file as a properties file. In the Save dialog box, save the
properties file with a .dtk extension in <WFC.rootdir>\kronos\diagnostics.
Note: To load a properties file that you previously created, click Load and
browse to select the file that you previously created.
5. Click Start.
After the LDAP Configuration Diagnostic Tool stops running, the results
appear in the LDAPDiagnostic dialog box.
! If there is an error, click Restart and Load to reload the properties file.
Correct any errors, click Save to resave the file, and then run the file
again.
! If the file ran correctly, the results window gives you information such as
where to put the resulting file.
The diagnostic tool lists the results in the text boxes as in the following table:
A configuration settings
before editing 4-3
All Servers system information 2-3
editing 4-3, 4-4
Applications system information 2-4
System Configuration 1-1, 1-2
archiving system log reports 3-8
custom LDAP authentication
authentication
configuring Workforce Timekeeper F-3
LDAP custom method F-2
understanding F-2
LDAP default method 4-67
using LDAPConfig utility F-4
OTHER 4-67
proprietary 4-65
understanding 4-65
D
WinNT, multiple domains 4-66 Data Source system settings
WinNT, single domains 4-66 adding 4-19
overview 4-18
B database
deleting a report 2-11
Background Processor
displaying a report 2-11
Background Processors workspace 2-5
report display 2-10, 2-11
employees excluded 2-5, 2-6, 2-7
report status 2-9, 2-10
system information 2-5
running a report 2-11
BGP
switching databases 4-12, 4-13
Background Processors workspace 2-5
system information 2-8
employees excluded 2-5, 2-6, 2-7
system settings 4-11
system information 2-5
viewing a report 2-11
working with reports 2-11
C database reports
Callable Totalizer system settings 4-7 available reports 2-8
Clock Synchronize system settings 4-9 creating DRD files 2-11, 2-12
configuration deleting 2-11
overview 1-3 Display workspace 2-10, 2-11
system configuration 1-4 displaying 2-11
Workforce Central Setup 1-3 DRD creation guidelines 2-13
Index
running 2-11 L
Status workspace 2-9, 2-10
LDAP authentication
viewing 2-11
custom configuration F-3
working with 2-11
custom LDAPConfig utility F-4
DRD
custom method F-2
guidelines for creating 2-13
default method 4-67
DRD files
Licenses system information 2-15
creating 2-11, 2-12
Local Server system information 2-16
Locale system settings 4-43
E log
e-mail Event Manager 4-28
available notifications 1-28 reports 5-7
multiserver environment configuration 1-24, log file
1-25 archving system log reports 3-8
notification types 1-27 enabling SQL tracing 4-70, 4-71
system settings 4-21 system settings 4-48
employees excluded log on
retroactive pay calculation 2-6, 2-7 changing the relogon session timeout 1-12
totals calculation 2-5, 2-6 overview 1-6
environments single sign-on 1-6
multiserver 1-24 Log Reports
Event Manager archiving 3-8
multiserver environment configuration 1-25 filtering 3-7
system settings 4-24 overview 3-2
working with system settings 4-26 running 3-7
Log Reports overview 3-1
G Logging Context system settings 4-51
Global Values system settings 4-31 logoff timer, changing 4-67
group edits
clearing results screen 4-39, 4-40 M
multiserver environment configuration 1-24 Meters system information 2-17
system settings 4-38 multiserver environments
configuration overview 1-24
J configuring E-mail 1-24, 1-25
Java Plugin system settings 4-41 configuring Event Manager 1-25
JRun Service configuring Group Edits 1-24
updating passwords 1-10, 1-11
O R
registry keys
offline mode 1-6, 1-7
UNIX C-4
OTHER authentication 4-67
Windows C-2
Overtime equalization
relogon
enabling in system settings 4-33
changing the JRun relogon session
overview
timeout 1-12, 1-13
System Configuration 1-1, 1-2
changing the relogon session timeout 1-12
changing WFC session timeout grace
P period 1-13, 1-14
passwords relogon session timeout
JRun Service 1-10, 1-11 changing JRun session 1-12, 1-13
Portal system settings 4-52 changing WFC session 1-13, 1-14
predefined data overview 1-12
data access profiles A-2 report terminology 5-2
display profiles A-8 reports
function access profiles A-14, B-4 accessing 5-8
HyperFind Query A-10 checking status 5-9
labor level sets A-9 concept overview 5-2
logon profiles A-13 directory 5-4
people A-12 generating 5-13
Workforce Genie building blocks A-3 server 5-5
Workforce Genie profile A-11 system settings 4-59
Workforce Genies A-6 terminology 5-2
Primary Labor Account reports, system
system information 2-18 database report display 2-10, 2-11
printers database report status 2-9, 2-10
enabling 4-57, 4-58 deleting a database report 2-11
system settings 4-56 displaying a database report 2-11
properties files Log Reports 3-1, 3-2
custom property file backup 1-17 running a database report 2-11
descriptions 1-19 viewing a database report 2-11
file types 1-15 working with database reports 2-11
groups 1-22
modifying 1-17
overview 1-15