Workforce Central

Administrator Guide

A comprehensive guide for administrators of the

Workforce Central suite of applications

Kronos Workforce Central suite version 8.0

The information in this document is subject to change without notice and should not be construed as a commitment by Kronos
Incorporated. Kronos Incorporated assumes no responsibility for any errors that may appear in this manual. This document or
any part thereof may not be reproduced in any form without the written permission of Kronos Incorporated. © 2019 Kronos
Incorporated. All rights reserved.
Altitude, Altitude Dream, Altitude Pairing, Altitude PBS, CardSaver, Gatekeeper, Gatekeeper Central, Keep.Trac, Kronos,
Kronos InTouch, Kronos Touch ID, the Kronos logo, Kronos Workforce Ready, My Genies, OptiLink, ShiftLogic, ShopTrac,
Timekeeper Central, TimeLink, Unicru, Visionware, Workforce Accruals, Workforce Central, Workforce Genie, and Workforce
TeleTime are registered trademarks of Kronos Incorporated or a related company. ACA Manager, Altitude BLISS, Altitude
Insight, Altitude MPP, Altitude MPPXpress, Altitude Rostering, Altitude VBS, CMS, Comm.Mgr, CommLink, DKC/Datalink,
eDiagnostics, FasTrack, Hireport, HR and Payroll Answerforce, HyperFind, iBid, Kronos 4500, Kronos 4500 Touch ID, Kronos
4510, Kronos Acquisition, Kronos ByDemand, Kronos e-Central, Kronos Efficient, Kronos Enterprise Archive, Kronos Essentials,
Kronos for Dining Accelerated, Kronos for Retail Accelerated, Kronos KnowledgePass, Kronos Paragon, Kronos TechKnowledgy,
KronosWorks, KVC ByDemand, KVC OnDemand, Labor Plus, MedSched, MPPXpress, Overall Labor Effectiveness, Schedule
Assistant, Smart Scheduler, Smart View, StaffEasy, Start Quality, Start WIP, Starter Series, StartLabor, Stromberg,
Timekeeper Decisions, Timekeeper Web, VisionPlus, WebStaff, webTA, webTA Mobile, Winstar Elite, WIP Plus, Workforce
Absence Manager, Workforce Acquisition, Workforce Activities, Workforce Analytics, Workforce Attendance, Workforce Auditor,
Workforce Budgeting, Workforce Central Portal, Workforce Connect, Workforce Device Manager, Workforce Dimensions,
Workforce Employee, Workforce ESP, Workforce Forecast Manager, Workforce HR, Workforce Innovation That Works, Workforce
Institute, Workforce Integration Manager, Workforce IntegrityScreen, Workforce Leave, Workforce Manager, Workforce Mobile,
Workforce MobileTime, Workforce Operations Planner, Workforce Payroll, Workforce Record Manager, Workforce Recruiter,
Workforce Scheduler, Workforce Scheduler with Optimization, Workforce Selection, Workforce Smart Scheduler, Workforce
Sourcing Analytics, Workforce Tablet, Workforce Tablet Analytics, Workforce Talent Acquisition, Workforce Task Management,
Workforce Tax Filing, Workforce TeleStaff, Workforce TeleTime IP, Workforce Timekeeper, Workforce View, and Workforce
Worksheet are trademarks of Kronos Incorporated or a related company.
For a complete list of Kronos trademarks, please visit the "trademarks" page at www.kronos.com. The source code for Equinox
is available for free download at www.eclipse.org. All other trademarks or registered trademarks used herein are the property of
their respective owners and are used for identification purposes only. All specifications are subject to change.
When using and applying the information generated by Kronos products, customers should ensure that they comply with the
applicable requirements of all applicable law, including federal and state law, such as the Fair Labor Standards Act. Nothing in
this Guide shall be construed as an assurance or guaranty that Kronos products comply with any such laws.
Published by Kronos Incorporated
900 Chelmsford Street, Lowell, MA 01851 USA
Phone: 978-250-9800, Fax: 978-367-5900
Kronos Incorporated Global Support: 1-800-394-HELP (1-800-394-4357)
For links to information about international subsidiaries of Kronos Incorporated, go to
http://www.kronos.com

Document Revision History

Document Revision Product Version Release Date

A 8.0 May 2015
B 8.0.11 July 2016
C 8.0 April 2017
D 8.0 February 2018
E 8.0 April 2018
F 8.0 September 2018
G 8.0 February 2019
Contents

Introduction 13
Infrastructure 14
IPv6 support 15
Application server support 16
System configuration overview 17
Change the session timeout 19
Change the application server timeout 20
Change the session timeout grace period 21
Change the web server SharePoint timeout 22
Work with property files 23
Modify properties 24
Groups of properties 25
Configure a multi-instance environment 26

Log on to Workforce Central 29

Log on to the navigator framework 30
Log on to the Self-Service (HTML client) interface 31
Quick Time Stamp 31
Quick Time Stamp Lite 32
 Log on with single sign-on 34
Enable Active X controls and plugins 34
Log on in offline mode 35

Work with passwords 37

Change password 38
XMLUSER 38
4500User 40
WBAUser 40
Set password expiration 42
Use the single sign-on feature 43
Set browsers to remember passwords 44
Change the SuperUser password 45
Online mode 45
Offline mode 45
Client security 47
Use the Reset Password - Security Questions feature 48
About the Forgot your password? link 48
Enable security questions 48
Use the Security Question Setup 50

System Information 51
All Servers information 53
Monitor application health 54
XML API for application response time 55
Logging 56
Dynamic logging external controls 56
XML API — Update log settings 56
XML API — Zip logs 57
Applications information 59
Background Processors information 60
Database Information 61
Database status and details 61

4
 Database reports 61
Database report status > 62
Database report display 63
Work with database reports 63
Create database report definition files 63
Guidelines for creating database report definition files 64
JMS Configuration 66
Licenses information 67
Meters information 68
Primary Labor Account Update information 69
Primary Labor Account update after changes in Organizational Map 69
Resubmit All People for Account Update 69
Threads information 71
User information 72

Logging 73
System log file 74
Component log files 75
Log reports 76
Log file report 79
Filter and run log reports 80
Archive system logs 81
Log file gathering 82
List the log files 82
Gather log information 83
Open gathered log files 83

Time Zones 85
Time zone information 86
Add or modify time zone information 87
Sample XML programs 89
Retrieve the database names of time zones 89
Retrieve complete information about time zones 89

5
 Retrieve information about a time zone by using the database name 89
Retrieve information about a time zone by using its ID number 89
Update or insert a time zone with the database name SomeTimeZone 89

System Settings 91
System settings and properties 92
Edit a system setting 93
Use system settings 94
Understand properties validation 95
Analytics settings 98
Activities 99
Attendance 101
Audit Settings 103
Auto-Scheduling 104
Background Processor 106
Batch Service 109
Brazilian Compliance 111
Budgeting 114
Business Automation 116
Clock Synchronize 119
Data Integration 121
Database 124
Device Management 128
Display 130
E-mail settings 131
Engine Controller 134
Event Manager 135
Forecasting 136
Global Values 139
Group Edits 159
JMS Configuration 161
Leave 164

6
 Locale 165
Log file 169
Logging Context 172
Messaging 174
Mobile Contact 175
Monitoring 177
Nursing Care Hours Summary 179
POS Import 180
Printers 181
Priority Scheduling Engine 183
Record Retention - Affected Databases 184
Record Retention – Database Setup 186
Reports 187
Request 189
SQL Coverage 190
Schedule Generator 191
Scheduling 193
Security 197
Service 201
Smart Operations 203
Startup 206
Timekeeping 208
Transformation 211
Web & App Server 212
Workload 214

Currency Policy 217

About currency policy 218
Base currency 219
Define currencies 219
Update rates 219
Assign currencies 221

7
 Precedence rules for currency policy 222
Assign currency to the Forecast Map 224
Supported currencies 225

Locale policies 229

Locale Policy Editor 231
Multiple languages on a single instance (MLSI) 235

Global text 237

Create global text 238
Translate global text 239

Translation support 241

Export tab 243
Import tab 244

Batch Action Sets 245

System-supplied Batch Action Sets 246
Batch Action Set editor 247
Batch Controller 247
Batch Controller Editor 248
Batch Job List 248
Batch Item List 249

Configure Feature Switch 251

Reports 253
Terminology 254
Reports setup for totalization 255
Export reports to Microsoft Excel 256
Install fonts for Activities reports 257
Manage reporting environments 258
Reports servers 258
UNIX/Linux environments 259
Queue performance considerations 259
Customize reports 261

8
 Create an RDL 262
Modify the RDL file 263
Create custom report options 264
Give users access to a custom report 265
Report options 265
Report option attributes 272
Wage permissions 284
Foreground and Background options 285
Decimal format 285
HyperFind queries 285
Time periods 286
Customize reports that use stored procedures 286
Parameters and options for reports that use stored procedures 287

System Monitoring and Troubleshooting 289

Set up the monitoring environment 290
Step 1: Select a JMX monitoring console 290
Step 2: Set the JMX Server administrative password in JBoss 292
Step 3: Connect to a JMX server 293
Monitor information with a third-party tool 294
Application server metrics 294
Web server metrics 294
Response time metrics 295
Monitor information in the suite 296
JMX Framework MBean 296
Audit MBean 296
Database Status MBean 297
Suite operations (BGP Status MBean) 298
Device Manager MBean 299
Integration Manager MBean 300
Hyperfind MBean 301
Genies MBean 306

9
 Smart View MBean 311
XML API MBean 314
Notifications 319
Troubleshoot errors 320

Process Manager 321

Configuration requirements 322
System Settings 322
Function Access Profiles 322
Set up the “Reports To” field in primary accounts 323
Use Process Administrator 325
Use the Process Profiles editor 334
Use the Process Templates editor 336
Troubleshoot Process Manager issues 339
Enhance Process Manager performance 340

Predefined Data 343

Genies 344
HyperFind queries 348
Genies profile 349
People 350
Logon profiles 351

Best Practices for Tracking and Logging 353

Logs 355
System settings 356
HyperFind queries 357
Function access profiles 358
Display profiles 359
Database settings 360

Delegate authority 361

Configure Delegate Authority 362
Step 1: Check access rights 362

10
 Step 2: Deploy and activate Delegate Authority template 362
Step 3: Create a Process Profile 364
Step 4: Create a Delegate Profile 364
Step 5: Assign Process Profile and Delegate Profile to manager 364
Step 6: Create a Role Profile 366
Use Delegate Authority 367
Step 1: Manager creates a Delegate Authority action 367
Step 2: Delegate accepts the delegation request 368
Step 3: Delegate switches roles 370

Access Microsoft Network Shares 373

Move files to the application server 374
Change the permissions on the network share 375
Create a new user account on the Windows network 377
Changes to the JBoss service account 377

Manage the notification server 379

Notification server files 380
Change the notification server password 381
Step 1: Change XMLUSER password 381
Step 2: Encrypt new password 381
Step 3: Edit openfire.xml 382
Administration console 384
Log 384
System properties 384
Sessions 384
Plugins 385

Special considerations 387

11
12
Chapter 1

Introduction

The Workforce Central suite is a comprehensive solution for managing every phase of the employee
relationship—staffing, developing, deploying, tracking, and rewarding. It consists of a number of separate,
yet tightly integrated applications that are both extensible and unified to provide a centralized data
repository and flexible self-service capabilities.
This chapter introduces the system architecture and the following topics:
l Infrastructure on page 14
l System configuration overview on page 17
l Change the session timeout on page 19
l Work with property files on page 23
l Configure a multi-instance environment on page 26
Infrastructure

The system requires the following infrastructure:

l Operating system — All applications run on Windows; most can also run on UNIX/Linux.
l Application server — Requires a J2EE-compatible application server: JBoss (delivered by the
installation program).
l Web server — All applications can use Microsoft IIS web server software. Most applications can use
Apache (delivered by the installation program). IBM HTTP Web Server, or Oracle HTTP Server.
l Notification server — Notifications are managed by an Openfire server notification server (delivered
by the installation program).
l Database — All applications support an SQL Server database; most also support an Oracle database.

14
IPv6 support
As newer versions of networking and server hardware and software become available, the use of Internet
Protocol v6 (IPv6) addressing is more prevalent. Workforce Central supports the display of IPv6 formatted
addresses along with IPv4 formatted addresses. Situations can occur where mixed mode addressing is
supported and used within a network, and Workforce Central displays addresses of both formats.

15
Application server support
Earlier versions of this product used the term application server to describe the entire application. The
term application included third-party application server software and web server software, all installed on
one machine. Although this version continues to support this configuration, it also now supports the
following configurations:
l The system and application server software can reside on one machine and web server software can
reside on a different machine.
l Multiple instances of one or more applications can be installed on the same machine. Each instance

can be independent and does not share code, runtime information, or temporary files.
This means that, in this version, the following important distinctions are made:
l The term application server is only used in reference to the third-party application server software,
such as JBoss, not the product application.
l The term instance is used to refer to one of more instances of a Workforce Central product running on
the same physical server. For example, one, two, or more instances can be installed on a machine
supported by one application server.

16
System configuration overview

You configure the system from the Setup link in the user interface. Key components include the following:
l Log Report — Determine the information to collect in the log. Use the details to create a customized
log report.
l Log Gathering — Collects all logs in one ZIP file that contains a report file that names the server
instance information and ZIP files from each server instance. Use these log files for troubleshooting.
l Time Zones — Displays the time zones currently available. They are effective-dated and are sorted by
their Greenwich Mean Time (GMT) offset.
l System Information — Displays the current state of the system. Click each tab to display details.
l System Settings — Displays system properties and values. Edit all settings here.
l Security Alerts — Displays the configured security alerts. Security alerts enable you to collect
security audit information. You can:
oSelect security actions that you consider most important
oSpecify parameters for audited items to control audit data growth and performance overhead
o Add a generic notification to the alert to enable appropriate personnel to track possible security
issues.
l Security Audit Data Export — Displays audit information for online review or export to a report.

l Workflow Notifications — Allows you to notify users about changes in the system and conditions

such as database status. For example, you can notify a manager if people have not completed their
timecards by a specific time in the pay period.
l Currency Policy — Enables you to define a list of currencies and the exchange rates used by those

currencies, in your organization.

l Feature Switches — Enables administrators to enable or disable certain features introduced in service

releases (requires service release 8.0.10 or higher). For more information, see
Use the System Configuration component to manage and configure the suite, including the following tasks:
l Set up an e-mail to inform users of specific system events or to remind them of an action for which
they are responsible. (See .)
l View system information.
l Run or view database reports to view statistical and diagnostic information.
l View or resubmit employees that have been excluded from totals calculation or have untotalized
Historical edits.
l View or resubmit employees who have changes in their primary labor account after the organizational
map process occurs. See Primary Labor Account update after changes in Organizational Map on page
69.
l Create, read, or archive log reports. See Log file report on page 79.

17
 l Define currencies and update exchange rates.
l When the system starts in offline mode, the system configuration components are the only elements in

the system that are accessible. For information about offline mode, see Log on in offline mode on page
35.
Because you can access the system through a web browser, you do not need direct access to the system
console and property files. Instead, you can administer the system from a remote location through System
Configuration.

18
Change the session timeout

After a set amount of inactivity, the system times out and prompts the user to continue or discontinue the
session. When the user clicks Yes, the system continues the session. When the user clicks No, the session
ends, and any unsaved data is lost.

Note: Activity is defined as any action that results in direct communication to the server, such as saving
or searching. Changing data on a page without saving it is not considered activity and does not reset the
system timer.

The application server Session Timeout parameter and the Session Timeout grace period govern session
timeouts for user inactivity.
The Session Timeout grace period is the number of minutes before the Session Time-Out dialog box
appears. The Session Time-Out dialog box informs the user that the session is about to time out, and
prompts for a response to prevent the application from closing. If the user does not respond, the application
server session times out and the application closes. The user must relogon through the logon screen.

Example 1:
Application server Session Timeout = 30
Session Timeout Grace Period = 1
The Session Time-Out dialog window appears after 29 minutes of inactivity; the application server session
closes after 30 minutes.

Example 2:
Application server session Timeout = 60
Session Timeout Grace Period = 10
The Session Time-Out dialog window appears after 50 minutes of inactivity; the application server session
closes after 60 minutes.

Note: If your system is configured with a single sign-on solution, such as SiteMinder, session
management is handled by the SiteMinder session manager. The active user session remains open. The
system does not expire the session or display a relogon warning.

As necessary, you can:

l Change the application server timeout on page 20
l Change the session timeout grace period on page 21
l Change the web server SharePoint timeout on page 22

19
Change the application server timeout
1. Select Setup > System Settings > Global Values.
2. Change the value of global.webserver.session.timeout. (The default is 1800 secs, or 30
mins.) Note that this value should be greater than
site.webserver.session.timeout.graceperiod.minutes (located in Setup >
System Configuration > System Settings > Web & App Server).
3. Click Save.
4. Click Restart Server to restart the application.

Caution: Do the restart at a time when no one is logged on to the system. Restarting the server ends all
user sessions immediately.

The change takes effect after you restart the application server. Because this is a global value, the session
timeout value is applied to all instances.

20
Change the session timeout grace period
To change the Session Timeout Grace Period:
1. Select Setup > System Configuration > System Settings > Web & App Server.
2. Enter a new value for the following key:
site.webserver.session.timeout.graceperiod.minutes
This value is the number of minutes that the Session Time-Out dialog box displays before the
application server session times out. The default value is 1 min.
3. Click Save to save the changes.
4. Click Restart Server to restart the application.

Caution: Do the restart at a time when no one is logged on to the system. Restarting the server ends all
user sessions immediately.

The change takes effect after you restart the application server.

21
Change the web server SharePoint timeout
1. Select Setup > System Settings > Web & App Server.
2. Set the value of site.webserver.sharepoint.session.timeout to the desired amount of
time, in seconds. For example, 180 secs for 3 mins. (The default is 1800 secs, or 30 mins.)
3. Click Save.
4. Click Restart Server to restart the application.

22
Work with property files

Property files contain specifications that enable you to configure your system. You can access properties
through the System Settings component in System Configuration. If you change information on the tabs in
System Settings, the system creates custom files. Do not modify the properties files directly.

23
Modify properties
Modify properties using the System Settings option in the Setup component of the system, where each tab
specifies a particular set of properties. To change the value of a property, access the appropriate tab, enter
the new value in the Value box, and click Save.
The system automatically copies the property name and the value that you typed to a custom property file.
At startup time, the system overrides the values in the property files with values in the custom property
files.
For example, on the Log File tab in System Settings, you change the value for site.log.loglevel
from ERROR to INFO. The existing properties file contains the value ERROR, and the custom properties
file contains INFO. When the system starts, the value INFO overrides the value ERROR.
To restore the initial values on a particular System Settings tab, click Restore Defaults on that tab. For
example, on the Database tab, specify values for a production database in the initial property file. Specify
values for an archived database in a custom property file. Then, restart the system to use the custom
property file and the archived database. To return to the production database, click Restore Defaults on the
Database tab in System Settings.

24
Groups of properties
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 System Settings
tabs. You can have additional tabs, depending on the products that are installed.

System Setting tab Property Group

Audit site.audit
Business automation site.processengine
Clock Synchronize site.clocksync
Database site.database
E-mail site.email
Event Manager site.eventmanager
Global Values global
Group Edits site.groupedit
Java Plugin site.java
Locale site.local
Log File site.log
Logging Context site.loggingContext
Messaging messaging
Portal site.portal
Printers printer
Record Retention Policy Setup WrmSetting
Record Retention Policy Affected WrmSetting
Databases
Record Retention Policy Options & Tuning WrmSetting
Reports site.reporting
Security site.security
Service site.service
SQL Coverage site.SQLCoverage
Startup test.startup
Timekeeping site.transformation
Web & App Server site.webserver

25
Configure a multi-instance environment

A Workforce Central installation includes the following software:

l Product software — The product, as well as optional products such for scheduling, time and
attendance, and activity tracking.
l Application server software — JBoss
l Web server software — Apache or Microsoft IIS, with HTTP or HTTPS communication protocol.
l Notification server software — Openfire server

Note: The term application server is used in reference to the third-party application server software,
such as JBoss, not the product application.

If your organization has more than 2,000 employees, you can set up multiple instances of the Timekeeper
product to improve performance. These instances can be set up on the same physical machine or on
separate machines.
If you set up multiple instances, a user can connect to any instance. The user specifies a URL to connect
to the system. This URL depends on whether the system uses load-balancing software 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 instance. If you use load-
balancing software, all users typically specify the same URL. The software determines which application
server handles user requests.
For more information about multiserver environments and load balancing, refer to the installation and
planning guides for this product.
In a multi-instance environment, pay special attention to the following:
l Configure group edits for a multi-instance environment
For Group Edits, one instance of the product acts as the primary Group Edit server. This instance is the
only one authorized to run the Group Edit Recovery and Delete threads. Designate one instance as the
primary Group Edit server, using the site.groupedit.primaryServer setting.
l Configure Event Manager for a multi-instance environment
For Event Manager, you can set up events on any instance, but only the primary server can schedule
the event processing. Designate one instance as the primary scheduler. This instance can be the same
one that runs other applications, or it can be a dedicated server.

26
In a multi-instance environment, configure the Event Manager function. You can configure every
instance as the primary scheduler to manage events created through the Event Manager function. By
default, the first instance that comes up that has been configured to be an event manager, is the default
Event Manager server. All other instances that come up afterward do not start up as the event manager.
If the current event manager instance goes down, it unmarks itself as the Event Manager server. The
next instance that comes up is the Event Manager.
o Windows platforms: By default, the site.eventmanager.enabled setting is set to true
for all instances. Although an event can be scheduled from any instance in the system, only the
primary Scheduler can initiate the processing of these events. The system automatically determines
which is your primary Scheduler.
o UNIX/Linux platforms: Set the value of site.eventmanager.hostname to true.

27
28
Chapter 2

Log on to Workforce
Central

Note
If you implement the use of security questions, users must select and provide answers for the security
questions immediately following their first logon. For more information, see Use the Reset Password -
Security Questions feature on page 48.
If you have multiple languages at your site and the locale policy for each language includes displaying
the language on the Logon page, you can select a language other than the default language before you
logon. The application pages will appear in the language you selected for the duration of your session.

Depending on your requirements, you can access Workforce Central in a number of ways:
l Log on to the navigator framework on page 30
l Log on to the Self-Service (HTML client) interface on page 31
l Log on with single sign-on on page 34
l Log on in offline mode on page 35
Log on to the navigator framework
The navigator framework is focused, intuitive, and tailored to provide only the information that the user
needs. Each user is assigned a navigator, which provide a highly graphical user experience for which most
Workforce Central content can be delivered.
To log on to the navigator framework, enter the following URL in your browser:
http://WebServer/instance/navigator/logon
where WebServer is the name of the Workforce Central web server machine (you may also have to
specify the port number) and instance is the name of the Workforce Central instance, which is wfc by
default.

30
Log on to the Self-Service (HTML client) interface
To access Workforce Employee - HTML Client, enter the following URL in your browser:
http://WebServer/instance/applications/wtk/html/ess/logon.jsp
where WebServer is the name of the machine where Timekeeper web server is installed (you may also
have to specify the port number) and instance is the name of the Workforce Central instance, which is
wfc by default.
Other Self-Service options include:
l Quick Time Stamp on page 31
l Quick Time Stamp Lite on page 32

Quick Time Stamp

After you add people to the system, you can also access the Quick Time Stamp component for the
Workforce Employee - HTML Client, which is similar to punching in at a data collection device. With
Quick Time Stamp, users log in and enter a punch at a shared PC.
To access Quick Time Stamp, enter the following URL in your browser:
http://WebServer/instance/applications/wtk/html/ess/quick-ts.jsp
where WebServer is the name of the machine where the Timekeeper web server is installed (you may
also have to specify the port number) and instance is the name of the Timekeeper instance. Note that
this URL is case-sensitive.
In addition to basic Quick Time Stamp, there are a number of optional parameters for Quick Time Stamp.
To access these parameters, append the URL suffix listed in the following table to the end of the basic
Quick Time Stamp URL after a question mark (?).
You can include more than one add-on by connecting them with an ampersand (&).

Optional
Parameter Description URL Suffix
Select Adds the Select Transfer text box ?transfer=yes
Transfer and search icon to the Quick Time
Stamp
Cancel Meal Displays the Cancel all meal ?cancel_deduct=yes
Deduction deductions check box in the Quick
Time Stamp

31
 Optional
Parameter Description URL Suffix
Security Sets the inactivity time period each ?s_timeout=xxx
Timeout user has prior to automatic logoff where xxx is the security
timeout in minutes
Confirmation Sets the redirect timer on the ?c_timeout=xxx
Timeout Quick Time Stamp - Time where xxx is the
Recorded page confirmation timeout in
seconds

For example:
l To display the Select Transfer text box and search icon on the Quick Time Stamp, enter:
http://WebServer/instance/applications/wtk/html/ess/quick-
ts.jsp?transfer=yes
l To display the Cancel all meal deductions check box in the Quick Time Stamp, enter:
http://WebServer/instance/applications/wtk/html/ess/quick-
ts.jsp?cancel_deduct=yes
l To display the Cancel all meal deductions check box, the Select Transfer text box, and the search
icon in the Quick Time Stamp, enter:
http://WebServer/instance/applications/wtk/html/ess/quick-
ts.jsp?transfer=yes&cancel_deduct=
l To set the Quick Time Stamp logoff timer to 5 minutes, enter:
http://WebServer/instance/applications/wtk/html/ess/quick-ts.jsp?s_
timeout=5
l To set the Quick Time Stamp redirect timer to 4000 seconds and to display the Select Transfer text box
and Search icon, enter:
http://WebServer/instance/applications/wtk/html/ess/quick-ts.jsp?c_
timeout=4000&transfer=yes

Note: You can access and change the confirmation timeout and the security timeout in two ways: by the
URL or by accessing the systems settings from the Setup link in the upper-right corner of the Workforce
Central workspace.

Quick Time Stamp Lite

Quick Time Stamp Lite (QTS Lite) is targeted to retail customers who have systems with high latency and
low band-width connections that slow communication. The application directly benefits retail employees
who use shared kiosks or POS systems for time entry.

32
Note: QTS Lite does not replace the original Quick Time Stamp; both applications can co-exist on the
same system.

To access Quick Time Stamp Lite (QTS Lite), enter the following URL in your browser:
http://WebServer/instance/applications/wtk/html/ess/quick-tslite.jsp

33
Log on with single sign-on
If you have single sign-on enabled using SiteMinder, you can access the system using the following URL:
http://web_server/instance/navigator/logonWithUID

Note: If your system is configured with a single sign-on solution, such as SiteMinder, The Log Off and
Change Password utility links are not visible. Because the SiteMinder application manages your log on
and password, these links have no effect.

Enable Active X controls and plugins

The ActiveX controls and plugins option is triggered each time you log on. The first time you log on after
installing, set the Active X control and plugins.
1. In your Internet Explorer Security Internet Options, select Custom Level.
2. In the Security Settings dialog box, set ActiveX controls and plug-ins to settings in keeping with
security policies at your site. At minimum, set the Run Active X controls and plug-ins to Prompt. This
setting prompts the user for a given server the first time. It also enables the user to add the server to a
list and avoid future prompts.
3. When you finish, click OK.

Note: Optionally, you can add servers as trusted to launch Active X controls.

34
Log on in offline mode
As system administrator, you need access to the administration functions of the system, even if the
database is offline.
When the system starts in offline mode, you can access the system via a special offline logon URL for
system administrators. You can also use the offline logon URL if you have single sign-on enabled using
Netegrity SiteMinder. To access the system in offline mode, enter the following URL in your browser:
http://web_server/instance/offlineLogon
where web_server is the name of the machine where the web server software is installed and
instance is the name of the instance. This URL is case-sensitive.
When the system starts in offline mode, only the system configuration components are accessible.
For example, the Database tab in System Configuration > System Information indicates that the
database is offline.
Specify the offline mode user name and password using the following settings on the Security tab:
l site.security.authentication.offline.username
l site.security.authentication.offline.password
The system encrypts the value of this password.

Note: If you specify HTTPS (HyperText Transport Protocol Secure) as the communication protocol, use
https:// rather than http:// for the logon URLs.

35
36
Chapter 3

Work with passwords

Passwords maintain system security. Within the system, you can perform the following tasks to manage
passwords:
l Change password on page 38
l Set password expiration on page 42
l Use the single sign-on feature on page 43
l Change the SuperUser password on page 45
l Client security on page 47
l Use the Reset Password - Security Questions feature on page 48
Change password
To change a password, click the Change Password link.
1. Enter the current password in the Old Password field.
2. Enter the new password in both the New Password and Verify Password fields.

Note: If you are a system administrator, you can see a list of system accounts, for which you can
also change the password. Use caution when changing system account passwords. The change can
interfere with system processes.

3. Change Password Now to save the changes.

Note: Depending on the configuration at your site, you can select and provide answers to security
questions after you change your password.

System passwords changed using this screen must match changes made in other system components. In
addition you must change system settings for XMLUser, 4500User, WBAUser.

XMLUSER
The XMLUSER account is the system user account that is used for server-to-server communications and
for working with the APIs. If you change the XMLUSER system account password, you must change the
value the property, global.xmlservice.login password, to match the new system account
password.
1. Log on to Workforce Central as SuperUser
2. Select Setup > System Configuration > System Settings.
3. Click the Global Values tab.
4. Enter the new system account password for XMLUser in the following property:
global.xmlservice.login.password
5. Log off Workforce Central.
6. Log on to Workforce Central as XMLUSER, using the original password (not the password you just
entered in System Settings).
7. Click the Change Password link.
8. Enter the old password, the new password, and the verification password for xmluser.
9. Log off Workforce Central.
10. Stop and restart the application server.

38
Impact of XMLUSER password change
If you change the XMLUSER password and your notification server uses the XMLUSER account, you
must also change the password for all instances of the notification server. The password must be
encrypted.
To encrypt the password, you must first identify the encryption key:
1. Open a command window as an administrator on the application server and navigate to
\\Kronos\openfire\ns\conf and open openfire.xml with a text editor.
2. Search for the <random> tag and copy the text between the <random> and </random> tags, for
example:
<random>6sefm114ntr8dmkelbuwodho2cql</random>
This is the encryption key.
3. Close the file.
Next you must run the krencryptNS tool:

Note: Workforce Central also includes a krencrypt tool, which is used when database passwords need to
be encrypted for places other than the notification server. Do not use krencrypt to encrypt passwords that
are used by the notification server.

1. With the command window still open, navigate to:

\\Kronos\configuration\boms\bin
2. Enter the following:
krencryptNS password encryptionkey
where:
password is the notification server password used by XMLUSER.
encryptionkey is the encryption key you copied from openfire.xml.
3. Save the encrypted text that the system returns.

Note: If you need to change the encryption key, it must be regenerated and system passwords must be re-
encrypted using the new key. See your Kronos Representative for a copy of the System Password
Management document.

After you have the encrypted password, edit the openfire.xml file for each notification server in your
environment:
1. Navigate to \\Kronos\openfire\nsx\conf\
where nsx is the name of a notification server, for example ns1, ns2, and so forth.
2. With a text editor, open openfire.xml and replace the password tag with the encrypted password from
previous step.

39
 <xml>
<api>
<username>XMLUSER</username>
<password>EncryptedPassword</password
</api>
</xml>
where EncryptedPassword is the password that you encrypted in step 1.
3. Save the file and restart the notification server.
4. Repeat steps 1–3 of all notification servers in your environment.

4500User
The 4500User account is the system account that is used for device-to-server communications. The user
name and new password are case-sensitive.
If you apply a change in the SuperUser account password to the 4500User system account, you must also
change the password in the property, global.m8m.login.password, to match the new system
account password.
1. In Workforce Central, select Setup > System Configuration > System Settings.
2. Click the Global Values tab.
3. Enter the new system account password for 4500User in the following property:
global.m8m.login.password
4. Click Save.

WBAUser
The WBAUser system account is used for Process Manager and Process Designer administration.
If you apply a change in the SuperUser account password to the WBAUser system account, you must also
change the password in the property, global.wba.login.password, to match the new system
account password for WBAUser.
1. In Workforce Central, select Setup > System Configuration > System Settings.
2. Click the Global Values tab.
3. Enter the new system account password for Process Manager and Process Designer in the following
property:
global.wba.login.password
4. Click Save.

Impact of password change on Process Designer

If you change the WBAUser account password, you must also change the account information at each
client PC where Process Designer is installed and loaded.

40
To change the password on each client PC:
1. Launch Process Designer, for example, select Start > Programs > Kronos > Process Designer >
Kronos Process Designer.
2. In the Process Designer Logon box, enter the URL of the Workforce Central web server as well as the
SuperUser user name and password, and then click Options.
3. In the Options box, enter the new password for WBAUser, enter it again to confirm, and then click
OK. The password changes immediately.
4. When the Process Designer Logon box returns, click Logon or Cancel.

41
Set password expiration
You can configure a message that warns users that their password will expire in a certain number of days.
The message appears when the user logs on to the system. The user has an option to either ignore the
warning for the time being or change the password. and provides the option to change the password.
To configure the password expiration warning:
1. Navigate to Setup > System Settings > Global Values .
2. Set global.warn.prior.to.expiration to true.
3. In the global.warn.prior.to.expiration.day setting, enter the number of days before the warning should
appear.
4. Click Save.

42
Use the single sign-on feature
You can set authentication so that a user who logs on to the browser can automatically log on without
having to re-enter a user name or password. This process is called single sign-on.

43
Set browsers to remember passwords
You can set browsers to remember passwords so that users can log on more quickly. You can also disable
Password Save.

Caution: Use discretion if you decide to use this capability.

Use the following methods to enable or disable Password Save:

l Setting Password Save With a Deployment Tool — Using this method, you can simultaneously
enable or disable this capability for all the browsers that use your site. Users cannot change this
setting.
l Setting Password Save From User Desktops — If the browsers are already on user desktops, change

this setting at each browser. You cannot prevent users from altering the setting.
See Client security on page 47for more information.

44
Change the SuperUser password
The Super User system user account, SuperUser, is the highest-priority system user account that the
system administrator uses. Kronos recommends that a limited number of users use this account.

Note: For a SQL Server database, SuperUser is case-sensitive in offline mode only. Online mode is
case-insensitive, for example:
l Online mode: SuperUser
l Offline mode: superuser

Online mode
To change the SuperUser password in online mode:
1. Log on at:
http://web_server/instance/navigator/logon
where web_server is the name of the machine where the web server software is installed and
instance is the name of the instance. The URL is case-sensitive.
2. Enter the default logon with the user name, SuperUser, and the applicable password.
3. Click the Change Password link. The Change Password page opens.
4. Enter the old password, then enter the new password twice.
5. You can also select one or more system accounts, such as Import and XMLUser, and change those
passwords as well.
6. Click Change Password Now to save the new password, or click Refresh to reset the page with the
password from the database.

Offline mode
To change the superuser password in offline mode:
1. Log on to the offline page at:
http://web_server/instance/offlineLogon
where web_server is the name of the machine where the web server is installed and instance
is the name of the instance, typically wfc. The URL is case-sensitive.
2. Enter the default logon with the default user name, superuser, and the applicable password.
3. Select Setup > System Configuration > System Settings.
4. Click the Security tab.

45
 5. Change the site.security.authentication.offline.password value.
6. Click Save.
Make subsequent logins as superuser, using the new password.

46
Client security
Enhance client security:
l Setting Password Save With a Deployment Tool — Simultaneously enable or disable this capability
for all the browsers that use your site. Users cannot change this setting.
For Microsoft Internet Explorer browsers, use the Microsoft Internet Explorer Administration Kit
Customization Wizard. Turn on or off the AutoComplete function, then deploy the browsers to user
desktops.
l Setting Password Save From User Desktops — If the browsers are already on user desktops, change
this setting at each browser. You cannot prevent users from altering the setting.
For Microsoft Internet Explorer browsers, turn on or off AutoComplete through Tools > Internet
Options > Content.

47
Use the Reset Password - Security Questions feature
Use the Reset Password - Security Questions feature to implement security questions for password resets.
When users forget their passwords, they can answer security questions and reset passwords without
contacting a system administrator.
Implement the Reset Password feature using settings on the Global Values tab in System Settings. You
can:
l Enable the Forgot your password? link and security questions.
l Require users who do not have questions and answers to select questions and provide answers when

they next log on to the system.

l Specify the number of security questions users must answer before they can reset their password.

l Specify the number of security questions users must select and type in answers at setup.

l Use the defaults or edit the security questions that users can select.

l Specify the number of characters that can be used in response to security questions.

l Specify the number of times users can enter a false response before their account is locked and they

must contact the system administrator.

For more information, see Global Values on page 139.

Note: Users who log on as SuperUser cannot select security questions.

About the Forgot your password? link

A new link, Forgot your password?, appears on the suite logon page. This link is enabled when the
system setting
global.security.authentication.question.RequireSecurityQuestions on the
Global Values tab is set to True.
Users with security questions and answers must enter their user name before they can use the link to reset
their password.
If users leave the User Name text box empty and click Forgot your password?, a Security Question page
opens and requires that they enter their user name. If a user does not have a valid user name, the user
cannot proceed and must contact a system administrator.
The SuperUser user cannot access the Forgot your password? link.

Enable security questions

Security questions enable users to provide answers that identify them to the system when they forget their

48
password. On the Global Values tab in System Settings, you specify the number of questions the user can
select and answer. You can use the default questions installed with the system or edit those questions. The
system encrypts the answers using the same method used for encrypting passwords. You cannot view or
decrypt the answers.
To enable and configure security questions, select Setup > System Configuration > System Settings,
click the Global Values tab, and do the following:
1. Change the following setting to true:
global.security.authentication.question.RequireSecurityQuestions
When you set this property to true, users are required to select their security questions the next time
they log on. If they do not select their security questions, they cannot log on.
Note: In versions prior to 8.0.8, you also need to set the following property to true to have the Security
Questions page open when users log on:
global.security.authentication.question.SetUpQuestionsAtNextLogon
Starting with version 8.0.8, this property was removed because setting the "RequireSecurityQuestions"
property to true requires the user to answer the security questions.
2. Set the following property to true if you also want to require users to change their security questions
when they change their passwords:
global.security.authentication.question.SetUpQuestionsAtChangePasswo
rd
3. Modify the attributes of the security questions as necessary or leave the default values:
a. Enter the number of maximum characters allowed for the response (default value is 64
characters):
global.security.authentication.question.MaxNumberOfCharactersInAS
ecurityResponse
b. Enter the number of consecutive false responses allowed before lock out (default value is 3 false
responses):
global.security.authentication.question.MaxNumberOfFalseResponses
ToASecurityQuestion
c. Enter the number of minimum characters allowed for the response (default value is 6 characters):
global.security.authentication.question.MinNumberOfCharactersInAS
ecurityResponse
d. Enter the number of security questions that will be asked if a user forgets his or her password
(default value is 1 question):
global.security.authentication.question.NumberOfQuestionsToAsk
Enter the
e. number of security questions that will be available to each user (default value is 3 questions):
global.security.authentication.question.NumberOfSecurityQuestions
PerUser
4. Click Save and close Setup.

49
 5. Run QuickFind, select the applicable group of employees, click Go To, and select People Editor.
a. Select the Person tab and navigate to User Information.
b. Select Require password change at the next logon check box.
c. Click Save.
d. Repeat step 5 for all selected employees.

Use the Security Question Setup

When the Security Question Setup page opens, the user selects the questions to answer when the user first
logs on, or changes his or her password.
Depending on the system configuration, users can select one or more questions and provide answers. Both
are stored in the system. One or more of the questions appear when the user clicks Forgot your
password?. The user must provide an answer that matches the answer in the system.
To set up security questions, the user does the following:
1. On the Security Question Setup page, select a question from one of the drop-down lists in the Questions
column.
2. Type the answer in the corresponding text box in the Answers column.
3. Repeat steps 1 and 2 until you have selected as many questions as you can.
4. Click:
o Submit Security Questions to save the changes.
o Refresh to cancel your changes and start again.

50
Chapter 4

System Information

System Information enables you to see the current state and configuration of all physical servers and
instances in your environment.
Select Setup > System Configuration > System Information to access system information. You can then
click the appropriate tab for the information that you want.
System Information functions are primarily for viewing but you can:
l Update the information by clicking Refresh.

Note: You cannot update the page using your browser’s Refresh button.

l Print the information, using your browser’s print function.

l Stop and restart threads listed in the Threads tab.
l Restart the server by clicking Restart Server on the Local Server tab.

Caution: Clicking the Restart Server button causes the system to shut down immediately. Users
receive no advance warning.

l Delete instances in the All Servers tab that are no longer connected to the database.
l Generate database reports on the Database tab, if you have a SQL Server or ORACLE database.

You use the following System Information tasks to administer the system:
l All Servers information on page 53
l Applications information on page 59
l Background Processors information on page 60
l Database Information on page 61
 l JMS Configuration on page 66
l Licenses information on page 67
l Meters information on page 68
l Primary Labor Account Update information on page 69
l Threads information on page 71
l User information on page 72

52
All Servers information
Displays information about all instances of the product that are connected to the database, on the same or
different machines.
To access All Servers information, select Setup > System Configuration > System Information, then
click the All Servers tab.
l Fetch heartbeat for all servers — Displays the last heartbeat for all active connected servers in
milliseconds.
l Application Server Hostname — Machine name of each application server that is connected to the

database.
l Instance — Instances on the application server.

l Web Server Hostname — Name of the web server machine.

l Event Manager — Instance that is the Event Manager server by looking at the database.

l Status — Indicates whether the instance is connected to the database.

Click on an application server host name to open a page that contains information about the application
server and instance combination, including:
l Application Server Hostname — Name of the application server machine.
l Application Server IP Address — Identifies the IP address of the application server machine.

l Inter Process Connection URL — Identifies the URL of the instance.

l Web Server Hostname — Identifies the web server for the application server machine.

l Status — Shows whether the instance is connected to the database and whether the instance is online.

l Last Heartbeat (ms) — Displays the last heartbeat for the selected server in milliseconds.

l Application Context — Context of the instance.

l Application Name — Name of the application.

l Application Description — (Optional) A description of the application appears if you entered a

descriptive name with the Instance Manager.

l Logon URL — Identifies the URL used to log on to the instance.

l Event Manager — Indicates whether the instance is the Event Manager server.

l Language — Shows the language of the instance.

l Reports Engine — Indicates whether the reports engine is enabled for the instance.

Click Remove from Database to remove an application server or instance that is disconnected from the
database and is no longer part of the system.
Click Refresh to receive updated values for Last Access and Elapsed Time; you cannot update the page
using your browser's Refresh button.

53
Monitor application health
Monitoring system health is an important aspect of managing enterprise applications. A simple way to
ensure that the system is “alive” is to generate heartbeats, which verify the continual operation of a
specific component or service.
You can access the suite’s heartbeat via Java Management Extension technology and managed beans
(JMX MBeans) or an XML API.You can also generate system logs.
The JMX MBean or XML API mechanisms provide an interface to the same business object, which makes
a quick call to the database. The response contains the time (in milliseconds) in the application layers. The
application health is gauged by how responsive the request is processed by the application:
l A fast response to the heartbeat indicates a healthy, functioning system
l A sluggish response indicates a degraded application

The heartbeat MBean and heartbeat XMP API support the following operations/actions:
l PingWithDB— Generates a quick heartbeat against the database
l PingWithoutDatabase— Generates a quick heartbeat without pinging the database

You can monitor the heartbeat statistics from the System Information page in the Workforce Central user
interface.
The heartbeat MBean generates a heartbeat and records the roundtrip time between the database to the
application server. You can view the heartbeat statistics for all servers connected to the database:

Note: Only the PingWithDB operation is used and recorded in the System Information page. To use
PingWithoutDatabase, you must use a system monitoring application.

1. Log on as an administrator.
2. Select System Configuration > System Information and click the All Servers tab.
If more than one instance is connected to the database, each instance is listed.
3. Click Fetch heartbeat for all servers and note the time (in milliseconds) of the heartbeat in the Last
Heartbeat column.
You can also monitor heartbeat statistics from a centralized console and a third-party monitoring tool such
as JConsole, JManage, or HP SiteScope. The monitoring console uses the JMX MBeans to extract data
and pull statistics from the database, and display this information in the monitor.

54
For example, you can access the ApplicationResourceTimeMBean in JConsole.

To control if the heartbeat is timed against the database, without the database, or both, enter any of the
following in the arg1 field:
l pingWithDB
l pingWithoutDB
l pingWithDB, pingWithoutDB

XML API for application response time

The following XML API enables you to record the heartbeat time.

Note: A new system user account called MONITORINGUSER is created by default (starting with
Workforce Central 7.0.2) to run the RetrieveResponseTime (that is, heartbeat-related) API. This user
does not consume a Workforce Central license and cannot perform any business transaction. No
functional link and no other XML APIs are exposed to this MONITORINGUSER user.

XML to record heartbeat time

<?xml version="1.0"?>
<Kronos_wfc version="1.0">
<Request Action="RetrieveResponseTime" retrieveFor="pingWithDB">
<HeartBeat/>
</Request>
</Kronos_wfc>
<?xml version="1.0"?>
<Kronos_wfc version="1.0">
<Request Action="RetrieveResponseTime" retrieveFor="pingWithDB,pingWithoutDB">
<HeartBeat/>
</Request>
</Kronos_wfc>

55
 A sample response is:
<?xml version="1.0"?>
<Kronos_wfc version="1.0" WFC Version="8.0.0.698" TimeStamp="10/15/2013 6:12PM
GMT-04:00">
<Response Status="Success" retrieveFor="pingWithDB"
Action="RetrieveResponseTime">{"pingWithDB":34}
</Response></Kronos_wfc>

Logging
You can control if and how heartbeats are sent to the wfc.log file as follows:
1. Select Setup > System Configuration > System Settings and click the Log File tab.
2. Edit the following properties as necessary:

Logging Properties Description

site.log.active Set to true to activate logging, false to turn off logging.
site.log.loglevel Set the logging level for the system: error, warning, info, or
debug
site.log.file.append Set to false to overwrite the existing log file when initializing
logging.
site.log.file.name The path name of the system log file (wfc.log).
site.log.file.rollover.maxsize Set the maximum size of the log file before rollover occurs. You
can set this value in KB, MB, or GB.
site.log.file.rollover.maxlogs Set the maximum number of saved log files to keep.
site.loggingContext.WFC.{...} Set the logging level for the logging context specified.

You can also modify the logging properties from the XML API and MBean.

Dynamic logging external controls

Using the MBean/XML API to get the response time, an external tool can be used to analyze the system
health and take actions, for example, log properties can be changed by an external tool using MBean/XML
API.

XML API — Update log settings

Sample request:
<?xml version="1.0" encoding="UTF-8" ?>
<Kronos_wfc version="1.0">
<Request action=UpdateLoggingProperties "
PropertyName="site.log.file.rollover.maxsize" PropertyValue="500MB" >

56
<Logging/>
</Request>
</Kronos_wfc>
<?xml version="1.0" encoding="UTF-8" ?>
<Kronos_wfc version="1.0">
<Request action="Load" KeyNames="site.log.file.rollover.maxsize">
<Logging/>
</Request>
</Kronos_wfc>
Sample response:
<?xml version="1.0"?>
<Kronos_wfc version="1.0" WFC Version="8.0.0.132" TimeStamp="3/13/2014 5:54AM
GMT-04:00">
<Response Status="Success" KeyNames="site.log.file.rollover.maxsize"
action="Load">
<SystemSettings Key=" site.log.file.rollover.maxsize" Value="500MB"/>
</Response></Kronos_wfc>

XML API — Zip logs

Sample request:
<?xml version="1.0" encoding="UTF-8" ?>
<Kronos_wfc version="1.0">
<Request action="LogZip" SourceUrl="pltsaf-2k864-36/wfc" TargetUrl="pltsaf-
2k864-36/wfc" TargetLogArchiveDirectory="C:/">
<Logging/>
</Request>
</Kronos_wfc>
Sample response:

57
58
Applications information
To access Applications information, select Setup > System Configuration > System Information, then
click the Applications tab.
The Applications tab displays the names and version numbers of the products that are currently installed on
the specific instance.
Click Refresh to receive updated values for Last Access and Elapsed Time; you cannot update the page
using your browser's Refresh button.
You can also access applications information from the following directory:
Installation_directory\instance\applications

59
Background Processors information
To access Background Processors information, select Setup > System Configuration > System
Information, and then click the Background Processors tab.
The following indicates whether there are employees who have been excluded from totals calculation or
who have untotalized Historical edits.
l If all employees were included, the following information appears:
o Totals Calculations: All employees have been included in the process.
o Historical Edits with Retroactive Pay Calculation: All employees have been included in the
process.
l If there are employees with untotalized Totals Calculations, the number of employees not included

appears as a link
l If there are employees with untotalized Historical edits, the number of employees not included appears

as a link to the Historical Edits with Retroactive Pay Calculation - Excluded Employees.
Click Refresh to receive updated values for Last Access and Elapsed Time; you cannot update the page
using your browser's Refresh button.
The Historical Edits with Retroactive Pay Calculation - Excluded Employees page lists employees
who have been excluded from historical edits with retroactive pay calculation: and specifies whether the
employee has been selected for submittal to totals calculation, their name, PersonID, and the ID Field from
People Editor.
Click Resubmit Employees to re-total excluded employees.

60
Database Information
To access Database information, select Setup > System Configuration > System Information, then click
the Database tab.
The Database tab displays:
l Status and details about the database to which the server is currently connected.
l The available database reports.

Database status and details

l Database Name — The database name is the one to which the instance is currently connected. (Your
instance can connect to different databases.)
l Status — Indicates whether the database is online.
l Version — Shows the version of the database.
l Database Server — Shows the name of the database server.
l Server Time — The time of day that is the time used for all time-specific data. Synchronize your
application server’s time of day with that of the database using the Clock Synchronize tab in Setup >
System Configuration > System Settings. .
o If the database and the application server are in the same time zone, the system uses this value.
o If the database and the application server are in different time zones, the system accommodates the
different time zone.
o If employees are in time zones that do not observe Daylight Saving Time, the server should be
configured in a time zone that does not observe Daylight Saving Time.
l Database Product — The database vendor.
l Product Version — The database version.
l Available Database Reports — Lists available reports.

Database reports
If you have a SQL Server or ORACLE database, you can run database reports that provide statistical and
diagnostic information. The Available Database Reports list box contains five predefined reports:
l Object Reconciliation Information — Verifies that the database contains all the necessary objects. It
analyzes the database to detect altered indices, added columns, or extra tables that may have been
inadvertently or intentionally changed.
l Tuning Parameters

61
 l Schema Reconciliation Information — Examines the database reports on the following:
o Table columns, procedure parameters, and table column data types that do not exist or are out of
order.
o Indexes are set correctly and are on the correct segment.

o Primary and foreign keys are set correctly

l Custom Inventory — Allows customers and support personnel to easily see the following information:
o Products installed
o Custom solutions installed

o Custom reports used

o Scheduled events and their status (enabled or disabled)

o Name of the primary Event Manager server

l Space Allocation — Reports the rows, pages, and space (in Mbytes) used by each table as well as the

date of the last statistics update.

You can also create and list custom reports here by building your own Database Report Definition (DRD)
files to include details such as:
l How much space is left
l Number of extents available

l Table space definitions

l Grants and permissions

l Performance tuning parameters

Click View Report Status to open the Database Report Status page. The View Report Status link is active
even if there are no reports listed on the Database Report Status page. When there are no reports, an empty
list appears.
To run a report, select a report from the list and then click Run Report. When you run a report, the
Database Report Status page appears automatically.
Click Refresh to receive updated values for Last Access and Elapsed Time; you cannot update the page
using your browser's Refresh button.

Database report status >

Displays the current list of database reports, whether the report has been selected for deletion, its name,
status, start and finish time stamps, and user request.
l Report Name
l Status
l Start Date and Time
l Finish Date and Time
l Requested By User

62
Click the report name of a completed or failed report to view the report.
Click Refresh to receive updated values for Last Access and Elapsed Time; you cannot update the page
using your browser's Refresh button.
The system periodically deletes reports that are not deleted manually. Configure the length of time that it
takes for automatic deletion using the
site.database.all.dbreport.Report.RepTimeToLive key on the Database tab in System
Settings. The value is expressed in hours (default is 72 hours).

Database report display

Displays the database report that was previously selected
l Click View Report Status to access the Database Report Status page.
l Click the Database link to return to the Database information page.

Click Refresh to receive updated values for Last Access and Elapsed Time; you cannot update the page
using your browser's Refresh button.

Work with database reports

Runs, displays, and deletes database reports
1. Select Setup >System Configuration > System Information > Database.
2. Highlight the report.
3. Click Run Report.
To display a database report:
1. Select Setup > System Configuration > System Information > Database.
2. Click View Report Status.
3. Click the report name.
To delete a database report:
1. Select Setup >System Configuration > System Information > Database.
2. Click View Report Status.
3. Select the report.
4. Click Delete. Then click OK.

Create database report definition files

You can create custom reports that will appear in the Available Database Reports list box by building your
own Database Report Definition (DRD) files.

63
 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:
l Name of the report:
o The first key component can be anything, but you must use it as the first component for each of the
four keys that comprise the DRD file.
o The second key component can be anything, but you 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 appears in the
report list and any duplicates are ignored.
o The third key component must be reportName.

The entire key must be followed by the “ = ” string, followed by any value as the reportName, such as
Person Report.
Name the DRD file using the same name as the report to easily associate a report with its DRD file.
For example, sqlServerPersonReport.drd.
l Database platform ID:
o The first component is the same as the first key component for the report name attribute.
o The second component is the same as the second key component for the report name attribute.

o The third key component must be dbPlatformID.

The key must be followed by the “ = ” string, followed by either of the valid values SQLSERVER or
ORACLE.
l SQL Type:
o The first component is the same as the first key component for the report name attribute.
o The second component is the same as the second key component for the report name attribute.

o The third key component must be sqlType.

The key must be followed by the “ = ” string, and then by either of the valid values STANDARD or
STORED. Since our hypothetical example uses SQL, rather than a stored procedure, the value paired
with this key is STANDARD.
l SQL String:
o The first component is the same as the first key component for the report name attribute.
o The second component is the same as the second key component for the report name attribute.
o The third key component must be sqlString.

The key must be followed by the “ = ” string., and then by the executable SQL or the name of the
stored procedure.

Guidelines for creating database report definition files

A customized Database Report Definition (DRD) file must conform to the DRD file format. To ensure that

64
customized database reports execute correctly, follow these rules:
l The contents of a DRD file must be entirely in ASCII text.
l The contents of a DRD file must comply with the key and value format.
l The DRD files must reside in the folder Installation_
directory\instance\reports\DBReports\DRD
l The extension of a DRD file must be .drd (must be lowercase).
l Use SELECT statements only. SELECT statements usually return results sets.
l Do 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 sets 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 (SQL Server 2000) or
Management Studio (SQL Server 2005), 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.
After being compiled, they reside in the database.
l If your Create Procedure statement has no syntax problems and is correctly referencing existing DB
objects, the statement creates and compiles the procedure. If there are problems that prevent the
procedure from being created in a valid state, the procedure gets created but it is in an INVALID
(uncompiled) state.
l 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 can return an invalid results set. Therefore, there is no guarantee that you
will see useful information in the report. The report appears in the Report Status page with a status of
Failed.
l The application does not check to ensure that there is adequate disk space for the report results file
because it cannot determine, in advance, the size of the file.
l 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 user name “SuperUser” and the usual password associated with it.
l The purpose of the feature is to generate reports, not to perform updates (such as inserts, changes, and
deletes).

65
JMS Configuration
As part of the Java Message Service (JMS) implementation, Workforce Central creates a key store,
certificate, and trust store to secure the JMS message bus. If you are configuring an external client to
connect to the Workforce Central JMS message bus, you need to create a trust store file.
To do this, the JMS Configuration tab contains the Export Trust Store button:
1. Click Export Trust Store.
2. In the Export Trust Store dialog box, enter and confirm a password, then click OK. The password is
case-sensitive.
Make a note of this password, because you will need it when connecting external clients to the trust
store file.
3. When the File Download box opens, note that the name of the file is client.ts and then click Save.
4. In the Save As box, navigate to where you want the client.ts trust store file stored and then click Save.
5. Click Close in the Download Complete box.
You can now use this trust store file and password to configure all external clients that use the same
database to connect to the JMS message bus.

66
Licenses information
Displays the current licensing information for the instance:
l License limit
l Licenses in use

l Resulting license availability for each product

To access licenses information, select Setup > System Configuration > System Information, then click
the Licenses tab.
Click Reread License Files to update the page with any new or updated data based on the files contained
in the \drive:\installation_directory\instance\licensing and \drive:\installation_
directory\instance\lm folders.
For Timekeeper and Accruals licenses, the values in the Limit, In Use, and Available columns should
match. The number of Accruals licenses should match the number of Timekeeper licenses, regardless of
the number of Accruals licenses that are actually in use.
For proper Accruals functionality and calculations, an equal number of Timekeeper and Accruals licenses
should be purchased and installed.
The notification threshold specifies the number of licenses remaining before a warning notification is sent.
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 when the number of licenses in
use reaches 900.
To edit the notification threshold:
1. Select Setup > System Configuration > System Settings and click the E-Mail tab.
2. Change the value in site.email.license.percent. You define the notification e-mail address
during the notification configuration process.
3. Click Save.
If you have multiple servers, you must install WPKLicense update files on each server. Then, refresh each
server’s license page to make them available.
Click Refresh to receive updated values for Last Access and Elapsed Time; you cannot update the page
using your browser's Refresh button.

67
Meters information
To access Meters information, select Setup > System Configuration > System Information, then click
the Meters tab.
The Meters page lists the performance utilities that are installed on the application server or instance.
Assess the performance of your system and analyze peak usage periods by studying the results of running
these meters.
To view the results for a specific meter, click the blue triangle next to the meter name.
Click Reset to restore a meter to its initial state (before the system collected any data). The reset feature
is intended for debugging when you are working with a Kronos Representative.
Click Refresh to receive updated values for Last Access and Elapsed Time; you cannot update the page
using your browser's Refresh button.

68
Primary Labor Account Update information
To access Primary Labor Account Update information, select Setup > System Configuration > System
Information, then click the Primary Labor Account Update tab.
The Primary Labor Account Update page indicates whether users’ primary labor accounts were updated
after changes were made in the Organizational Map.
If updates have occurred for all users, the following information appears on the page:
Primary Labor Account update after changes in Organizational Map: All people have been included in
the process.
If updates have not occurred for all users, the following links appear:
l Primary Labor Account update after changes in Organizational Map — Displays the number of
people with changes in their primary labor account that need to be updated after the organizational
mapping process occurs.
l Resubmit All People for Account Update — Displays the people who have changes in their primary
labor account after an organizational mapping process occurs. This option appears only when primary
labor accounts need to be manually updated.

Primary Labor Account update after changes in Organizational Map

Lists the number of people who were included in the processing of organizational mapping that changed
their primary labor accounts. The primary labor account consists of a job and a labor account. If a change
occurs in the job hierarchy and the organizational mapping process cannot determine the logical primary
labor account, the primary labor account needs to be manually updated.
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.
Click Refresh to receive updated values for Last Access and Elapsed Time; you cannot update the page
using your browser's Refresh button.

Resubmit All People for Account Update

Lists the people who have changes in their primary labor accounts who need updating after the
organizational mapping process occurs and specifies whether the employee has been selected for primary
labor account updates, the name, Person ID, and the ID Field from People Editor.
Click Resubmit People to submit selected employees who qualify for totalization.
After you manually update employee primary labor accounts, submit them for primary labor account
updates.
Click Primary Labor Account Update to return to the Primary Labor Account Update page.

69
 Click Refresh to receive updated values for Last Access and Elapsed Time; you cannot update the page
using your browser's Refresh button.

70
Threads information
To access Threads information, select Setup > System Configuration > System Information, then click
the Threads tab.
The Threads page lists the long-running daemons that are currently running on the instance. Keep track of
these daemons to ensure that they run as expected. You can stop and restart the daemons.
l Restart — If a thread is listed as stalled or stopped in the State column, click Restart.
o Restarting a Controller thread restarts all the Worker threads that are associated with it.
o Restarting a Worker thread has no effect on any other thread.
l Stop — To stop a daemon that is currently running, and to prevent a process from running out of control
or looping, click Stop.
o Stopping a Controller thread also stops all the Worker threads associated with it.
o Stopping a Worker thread has no effect on any other thread.
l Thread — Lists each thread’s unique name.
l Type — Identifies the thread as a Controller or Worker.
o A Controller is a parent thread, and can have one or more Worker threads associated with it.
o A Worker can be a child thread that is associated with one Controller thread, or it can be launched
independently.
l State — Identifies the current status of a thread:
o Running — The thread is currently performing work.
o Stopped — The thread is not currently running.

o Stalled — The thread is not doing useful work; it has encountered a problem and is unable to
proceed.
The system activates Controller threads periodically. If a Controller thread is activated and
identifies a child Worker thread that is stalled, the Controller thread restarts the stalled Worker
thread.
o Ready and waiting for work.

l Controller — Identifies if the thread is a Controller or Worker.

o For a Worker thread, this column identifies its parent Controller thread.
o For a Controller thread, this column has a blank value.

l User Name — Identifies the user who started the thread. If the system started the thread, the value of

User Name is blank.

l Description — Contains short definitions of each thread.

Click Refresh to receive updated values for Last Access and Elapsed Time; you cannot update the page
using your browser's Refresh button.

71
User information
To access User information, select Setup > System Configuration > System Information, then click the
User tab.
The User page identifies users who are currently logged on to the instance. Users should have a separate
system ID. They should not all use Superuser as a login.
l The Last Access column shows the last time that each user took an action in the session and identifies
users whose sessions have remained inactive for a period of time.
l The Elapsed Time column shows how long a user session has lasted. This column also identifies long-

running sessions.
l 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 updated values for Last Access and Elapsed Time; you cannot update the page
using your browser's Refresh button.

72
Chapter 5

Logging

Log files contain detailed list of an application information, system performance, or user activities. A log
can be useful for keeping track of computer use, emergency recovery, and application improvement.
The system contains multiple log files, including system and component log files.
System log file
Each instance of Workforce Central contains a system log file called WFC.log, which is set in
site.log.file.name in the Log File tab of Setup > System Configuration > System Settings.
The name WFC.log is used for the first log file name in the drop-down list. The WFC.log file is the file
currently being written. When WFC.log reaches its maximum size, the file is renamed to WFC.log.1.
The names of other log files increment by 1, and a new WFC.log file is created.
The number of log files available depends on the number of log files that you specified in the
site.log.file.rollover.maxlogs property.
l If you specify 0 (zero), the only log file written is WFC.log. When that file is completed, it is emptied
and rewritten.
l If you specify a number other than zero, you can have as many completed log files as that number
specifies. The oldest log file has the highest number. When the maximum number of log files is
reached, the oldest one is recycled.

Note: Do not modify a log file using a text editor. The log report expects a certain format, and changes
can prevent the report from displaying properly.

74
Component log files
Other log files that record system activity include:
l IIS web server
\Windows\system32\LogFiles\W3SVC1\ex<date>.log
l Apache web server
\installation_directory\Apache\Logs\access<#>.log
\installation_directory\Apache\Logs\error.log
\installation_directory\Apache\Logs\install.log
\installation_directory\Apache\Logs\ssl.log
\installation_directory\Apache\Logs\mod_jk.log
/usr/local/apache2/logs (UNIX/Linux)
l JBoss application server
\installation_directory\jboss\instance\log\boot.log
\installation_directory\jboss\instance\log\server.log
l Licenses
\installation_directory\instance\logs\LicenseConversion.log
l Reports
\installation_directory\instance\logs\WFCReporting<#>.log
l Event Manager
\installation_directory\instance\logs\WFCEvtMgr.log
l Start up process
\installation_directory\instance\logs\StartupError.log
\installation_directory\instance\logs\StartupInfo.log
l Process Manager
\installation_directory\processdesigner\kpe\.log

75
Log reports
The Log Report workspace enables you to create log reports based on parameters from the system log
files.
To access the Log Report workspace, select Setup > System Configuration > Log Report. You use this
workspace to do the following:
l Arrange information into customized reports.
l Generate reports by using the default values or by specifying a log filter to produce a more concise

report.
l Distribute the reports by e-mail, by highlighting, copying, and pasting the log report output to a file, then

e-mailing the log report file as an attachment.

Although 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:
l Windows: installation_directory\instance\logs
l UNIX/Linux: installation_directory/instance/logs

The system records system events for each instance in one or more system log files. If you have a multi-
instance environment, each instance has its own set of log files.
To specify multiple items in a drop-down list, use Shift+Click to select adjacent items, or use Ctrl+Click
to select random items.
l Click Run Report to run a log report after you have selected filter criteria.
l Click Refresh to restore the report defaults and update the instance list with any new instances

attached to the same database.

You can print the report using the print function in your browser. The printout can be useful for analysis
and troubleshooting.
In Internet Explorer, click Print or right-click on the report page and select Print.

Note: You cannot update the workspace using your browser's Refresh button.

Key and value details

l Servers — All server-instance combinations that are connected to the same database are listed. The
format is:
drive:\installation_directory:port\instance
Select one or more server/instance combinations or select All. The default setting is All.
A log report can span multiple server/instance combinations.
Note: If you have multiple servers or multiple instances attached to your database, consider selecting
a subset to lessen the possibility of memory errors.

76
 If you select a subset, run the log report several times with different server and instance combinations
each time. This ensures that you get data from all of the instances.
The decision to select a subset depends on multiple factors, such as the amount of memory on the host
machine, the number of servers or instances connected to the same database, and the filtering criteria
supplied for the log report.
l Start Date and End Date — The Start Date and End Date specify a range of dates. Times are
optional. The first value is always the Start Date. The report includes messages that were generated
during the specified date and time ranges.
l Log Context — Context classifies log messages by the instance that generated them. You can filter a
report based on the context categories that you need. The default is All. If you select multiple contexts,
the report includes messages from each context in the order in which you selected them.
The purpose of this entry is to reduce the amount of information that is mined and retrieved 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.
For example, if your problem involves WFC.WFP.DAEMON, select that function from the list to see
only records related to that context. It is recommended that you use the Context option when requested
to do so by your service representative. Most of the time, select All.
l 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 name. A
space is not required between the comma and the next user name.
l 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. To set the value of the site.log.loglevel property, select
Setup > System Configuration > System Settings and click the Log File tab.
The available severity levels are:
o All = All messages
o ERROR = The most serious messages
o WARNING = Cautions that can indicate future problems on the server
o INFORMATION = Informational messages
o DEBUG = Entries you report to support personnel (not intended for general use)

Note: Use DEBUG only if requested by your service representative.

l Message Contains — (Optional) The Message Contains value is a text string typically found in
messages. The default is all message text. In the text box, you can specify any text string to get only
records containing that text.
You cannot use the percent sign (%) or the single quote (‘) in the text string.

77
 l Sort By — The Sort By filter arranges the report in the order of the selected criteria. If a report is
sorted by date, priority, or context, the messages in the report are ordered as follows:
o Date
o Priority (ERROR, WARN, INFO, DEBUG)

o Selected context groups

The default sort order is date.

78
Log file report
A log file report contains one system log message per line. The line contains information in the following
order and format:
l A time stamp of the form yyyymmddhhmmss; for example, 20020207040816.
l The name of the context for which the message was recorded; for example, WFC.STARTUP.
l The user ID of the user associated with the message.
l The log level (or severity) encountered; for example, INFO.
l The text of the message

Note: These log report facilities are only available for the system log. They do not include information
recorded in specialized logs for the Event Manager or Reports. You can see an Event Manager or a
Reports exception in the system log. Examine the logs for those components, rather than relying on the
system log to inform you of a problem.

79
Filter and run log reports
You can filter log reports to include only certain log messages. All criteria are optional. Limit the report
content by specifying content that can help you analyze server activity. Results are always in alphabetical
order, based on the sort order that you specified in the Sort By selection boxes.
To filter and run a log report:
1. Select Setup > System Configuration > Log Report.
2. Select the filter criteria from the following options:
3. Select a server/instance from the Servers box.
If you have multiple servers or instances attached to your database, consider selecting a subset of the
server list to lessen the possibility of memory errors. If you select a subset, run the log report several
times, with different servers, to obtain data from all of the servers.
Before you select a subset, consider the amount of memory on the host server, the number of servers
connected to the same database, and the filtering criteria supplied for the log report.
4. Enter the start date.
5. Enter the end date.
6. Select one or more context categories from the Log Context box.
7. Enter one or more user names. Separate multiple user names with a comma and no space before the
next user name.
8. Select one or more priorities from the Priority box.
9. Enter a [single] text string in Message Contains.
10. Choose a method for sorting the results.
11. Click Run Report.

80
Archive system logs
Log files are automatically created in the drive:\installation_directory\instance\logs
directory using the following default criteria:
l A new log file is created when the current log file is greater than 500KB.
l Up to 10 logs are kept.

l The oldest log file has the highest number. When the maximum number of log files is reached, the

oldest one is recycled.

To set your own archiving schedule, do the following:
1. Select Setup > System Configuration > System Settings > Log File.
2. In the site.log.file.rollover.maxsize key, specify the maximum size of the log file
before rollover occurs.
3. In the site.log.file.rollover.maxlogs key, specify the maximum number of logs to save.
4. Click Save.

81
Log file gathering
Use the Log File Gathering tool to gather all the log files in your system into one ZIP file. The ZIP file
contains a report file that describes the server instance information you gathered, and ZIP files from each
server instance. This information is invaluable for troubleshooting.
l List the log files on page 82
l Gather log information on page 83
l Open gathered log files on page 83

List the log files

You can list additional log files when you run the Log File Gathering tool. Select Setup > System
Configuration > System Settings > Log File, and then add the log file names to
site.log.file.gathering.list. This list is in comma-delimited format.
Do not remove any parts of the original list of files, including commas. When the Log File Gathering tool
runs, it skips over files that are not listed correctly. Removing any parts of the original list could cause the
tool to generate an incomplete list of log files.

Note:
l If you are using an IIS web server and the IIS log files are not in the default location, add the
appropriate path to site.log.file.gathering.list. The default locations for IIS logs are:
o drive:\Windows\system32\LogFiles\HTTPEERR\*
o drive:\Windows\system32\LogFiles\W3SVC1\*

l When the web server and application server are on different machines, only application log files are
collected. You must map the Web server log directories and add them to
site.log.file.gathering.list.
l If reports are stored and rendered by SQL Server Reporting Services (not RDLC), map to the SQL
Server directory and add the log files to site.log.file.gathering.list.
l Dedicated servers such as Background Processor, reports, Device Manager, and so on, do not accept
remote work. Map these servers to the network directories and add the log files to
site.log.file.gathering.list.
l IIS logs are collected regardless of the fact that the product cannot be deployed under IIS.
l If the log files are very large, you can adjust the following properties, which are in
\instance\applications\wpk\properties\custom_wpksite.properties.
l Change these settings only at the direction of a Kronos Representative.
l site.zip.manager.lock.retries.max — Indicates the number of retries in case of file locking. The
default is 3.
l site.zip.manager.lock.sleep.interval — Indicates the wait time between the retries in case of file
locking. The default is 500.

82
 l site.log.file.gathering.timeout — Indicates the timeout of the remote zip transfer (in seconds). The
default is 1200.

Gather log information

Use the Log File Gathering tool to gather all the log files in your system in one ZIP file. The ZIP file
contains a report file that describes the server instance information you gathered, and ZIP files from each
server instance.
Click Refresh to update the Servers list with any new servers.
If you gather log files for web and application servers that are on different machines, all logs except the
web server logs are collected.
To gather the logs in to one ZIP file:
1. Select Setup > System Configuration > Log File Gathering. The Log File Gathering page appears.
2. In the Servers field, select the servers from which you want to gather log files or click All.
Some of the log files can be on different machines. The name of the server in the list of Servers
includes the machine name.
3. In the Log Archive Destination field, enter or update the path of the ZIP file location. This path reflects
the location of the zip file on the server. You can specify a destination that is on another server, as long
as you have access to that server.
4. Click Gather Logs. The Log File Gathering page changes to a table that shows the application server
hostname instance for the ZIP file that you are creating.
5. Click Refresh, to update the Status field.
6. Click View Gather Log Status, to get back to the status of the current accumulation in progress.
When the log files have been gathered in the ZIP file, the Log Archive Destination field shows the server
and path where the ZIP file is located and Request done and the Status column shows Successfully
retrieved.

Open gathered log files

The ZIP file that is created when you run the Log File Gathering tool contains ZIP files that come from
each server/instance. These zip files contain in their names the server name and instance name. The server
name and the instance name are also included in the paths of the log files that are gathered. There is also a
text file in the master ZIP file that lists each server name and instance name combination, and whether the
gathering was successful.
To open the gathered log files:
1. Copy the master ZIP file to a new directory.
2. Open the master ZIP file.
3. Extract the text file and all ZIP files within the master ZIP file to the current directory you are in.
4. Open each ZIP file and extract the contents into the current folder.

83
 Note: In the Extract dialog box, clear Overwrite existing files and select Use folder names.

The Readme file contains information about what logs were gathered for the particular server and instance.

84
Chapter 6

Time Zones

A time zone is a geographic region that uses the same standard time. The system uses the current time on
the database server machine to choose an appropriate time zone for each time stamp that is saved. If your
system and the database server are in different time zones, the system converts the database server time to
your local time zone when it appears on your browser. You cannot change a time stamp time by adjusting
the time on the PC.
The Time Zones page (Setup > System Configuration > Time Zones) displays the time zones currently
available to the system. You can add a time zone or modify existing time zone information. You can also
modify time zone information with XML import programs.
The time zones are effective-dated and are sorted by their Greenwich Mean Time (GMT) offset. A time
zone GMT offset is the difference (in hours) between a particular geographic region and GMT. For
example, 6:00 AM in the Eastern time zone is 11:00 AM GMT.
If more than one time zone has the same GMT offset, the time zones are sorted by their display name, in
ascending order. If there are multiple versions of a time zone definition, the versions are sorted in
descending order by effective date (future to past).
Time zones are imported into the system by using an XML program. You can update the time zone
information with XML import programs.
The Refresh button enables you to update the page from the database.
The Filter drop-down list enables you to display:
l All — All time zones
l Active — Time zones that are active, based on the setting (false) of the “Is Inactive” switch in the
database
l Inactive — Time zones that are inactive, based on the setting (true) of the “Is Inactive” switch in the
database
Time zone information
The following table describes the information that appears on the Time Zones page. .

Column Description
Display Name The name of the time zone as it appears in the system and on reports. It can
include the GMT offset and a country name.
Time zones that are not in effect or are inactive are grayed out.
Time zones that are not in effect do not show their display name. unless there
is only one version of the time zone or unless it is a future time zone.
Time zones that are not in effect are indented.
Database Name The name of the time zone as it is stored in the database. Use the database
name when importing time zone information.
Although time zones are sorted by GMT offset, if the GMT offsets are equal,
the time zones are sorted by display name. The sort order is ascending.
GMT Offset GMT, or Greenwich Mean Time (offset zero), is the time at prime meridian.
All of the other time zones are offsets from GMT, typically in 1-hour
increments.
For example, Eastern time is an offset of -5 hours, or 5 hours earlier than the
current time at Greenwich. Amsterdam is an offset of +1 hours, or one hour
later than Greenwich time.
Time zones are sorted by GMT offset. If the GMT offsets are equal, the time
zones are sorted by display name, in ascending order.
Daylight Saving Starts The day and time on which daylight saving starts in the time zone.
Daylight Saving Ends The day and time on which daylight saving ends in the time zone.
Effective Date The time zone version that is in effect on the current date.
Note: If a time zone is inactive, the check mark does not appear, even if the
time zone is in effect on the current date.
Active Indicates (with a check mark) whether the time zone is currently active, A
check mark indicates active.
Use the Filter drop-down list to view All, Active, or Inactive time zones.

86
Add or modify time zone information
You can add a time zone or modify existing time zone information. You can also modify time zone
information with XML import programs.
l After you add a time zone, you cannot modify the Time Zone name, which is displayed in the Database
Name column. The name becomes a key for system processes accessing the TIMEZONE table in the
database.
l When you add a time zone, the system populates the Display Name column and field with the Time
Zone name, in uppercase letters. You cannot modify the Display Name on the Edit Time Zone page. To
modify the display name, edit the wpk_strings.properties file.
For example, you create a time zone called MyNewTimeZone. MyNewTimeZone appears in the
Database Name column and the system-generated name, MYNEWTIMEZONE, appears in the
Display Name column. To modify the display name, add the property
com.kronos.wfc.business.datetime.TimeZone.Config.<time zone name> to
the wpk_strings.properties file. In this example, you could add:
com.kronos.wfc.business.datetime.TimeZone.Config.MYNEWTIMEZONE=(GMT
-07:00) Another New Time Zone
When the modified properties are refreshed (or loaded), the Display Name column lists the time zone
as (GMT -07:00) Another New Time Zone. The Database Name remains MyNewTimeZone.
l You cannot delete a time zone, but you can clear the Is Active? check box so that it is not used by the

system.
l For a new time zone, the effective date is always Beginning of Time - Forever. The Create New

Version option is unavailable.

To add a time zone:
1. On the Time Zones page, click New.
2. On the New Time Zone page, enter the Time Zone name (which is displayed in the Database Name
column).
3. Enter the GMT Offset in HH:mm or HH.hh format. (The system displays the GMT Offset in HH:mm
format.)
4. The system populates the Display Name column when you save the new time zone.
5. To make the time zone active, select the Active check box.
6. Enter the Daylight Saving start and end times.
7. For information about the fields, see Time zone information on page 86.
8. When you finish, click:
o Save to save the time zone and remain on the current page.
o Save & Return to save the time zone and return to the Time Zones page.
o Save & New to save the time zone and clear the page so that you can create another time zone.
o Return to return to the Time Zones page without saving the changes.
o Refresh to update the page from the database.

87
 To edit time zones:
1. On the Time Zones page, double-click a time zone name, or select one or more time zone check boxes.
2. On the Edit Time Zone page, you can change the GMT Offset, the active status, version effective
dates, and daylight saving start and end information.
3. Select the Effective Time Zone Version area, select a Version Effective Date and do one of the
following:
o Click Delete to remove the dates.
o Select Create new Version Effective and select a date from the calendar.

o Select Update this Version.

4. Enter the Daylight Saving start and end times.

5. For information about the fields, see Time zone information on page 86.
6. When you finish, click:
o Save to save the time zone and remain on the current page.
o Save & Return to save the time zone and return to the Time Zones list page.
o Save & New to save the time zone and clear the page so that you can create another time zone.
o Return to return to the Time Zones list space without saving the changes.
o Refresh to update the page from the database.

88
Sample XML programs
The following XML examples illustrate how to retrieve and update time zone information.

Retrieve the database names of time zones

To retrieve the database names of all the time zones in the system:
<Request Action="RetrieveAllNames">
<KTimeZone/>
</Request>

Retrieve complete information about time zones

To retrieve complete information about all of the time zones in the system:
<Request Action="RetrieveAllForUpdate">
<KTimeZone/>
</Request>

Retrieve information about a time zone by using the database name

To retrieve information about the time zone that has the database name Samoa:
<Request Action="RetrieveForUpdate">
<KTimeZone Name="Samoa"/>
</Request>

Retrieve information about a time zone by using its ID number

To retrieve information about a time zone with an ID number of 13000:
<Request Action="RetrieveForUpdate">
<KTimeZone ID="13000"/>
</Request>

Update or insert a time zone with the database name SomeTimeZone

To update or insert the time zone SomeTImeZone with the following data:
l Its GMT-offset is -12:00 hours (-43200 seconds) and it is an active time zone.
l It has two versions:
The first version is in effect as of 1/1/2001. DST starts on the first Monday of March at 2 AM, and
ends the second Thursday of October at 3 AM.

89
 The second version is in effect as of 1/1/2004. DST starts on the second Sunday of March at 3AM, and
ends on the last Monday of October at 3AM.
<Request Action="Update">
<KTimeZone Name="SomeTimeZone" GMTOffset="-43200" IsInactive="false">
<KTimeZoneRules>
<KTimeZoneRule StartDate="1/1/2001" DSTDayNumber="1" DSTDayOfWeek="2"
DSTMonth="3" DSTTimeOfDay="2:00AM" StandardDayNumber="2" StandardDayOfWeek="5"
StandardMonth="10" StandardTimeOfDay="2300AM"/>
<KTimeZoneRule StartDate="1/1/2004" DSTDayNumber="2" DSTDayOfWeek="1"
DSTMonth="3" DSTTimeOfDay="3:00AM" StandardDayNumber="5" StandardDayOfWeek="1"
StandardMonth="10" StandardTimeOfDay="3:00AM"/>
</KTimeZoneRules>
</KTimeZone>
</Request>

90
Chapter 7

System Settings

System Settings are derived from files that contain the properties and parameters for configuring your
system. You use System Settings to manage and configure the system. The System Settings available to
you depend on the combination of applications installed on your system. For information about system
settings that are not described in this chapter, refer to the documentation for the products that you have
installed.
The System Settings page displays a set of tabs representing different characteristics of the system that
relate to your environment. Clicking each tab displays properties for that area that can be edited, and an
action menu bar. When you change and save the values of system properties, your changes are stored in a
custom property file.

Caution: Always access properties through System Settings in the System Configuration component,
which creates custom files. Accessing the properties files directly could lead to errors that could render
your system unusable.
System settings and properties
There are two types of properties:
l Site-specific — Properties that pertain to a single instance. These properties are maintained in property
files within the specific instance.
l Global — Properties that pertain to all instances in the system. These properties are maintained in the

database.
If you have an administrator access profile, you can edit the system settings. After the initial configuration,
avoid editing settings except to fine-tune 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.
For your convenience and for your system’s protection, the changes that you make to the system settings
are recorded in files with the following naming convention:
custom_filename.properties
where filename.properties is the name of the associated properties file that contains the default
settings.
Further changes to system settings are backed up using custom_filename.properties.nn, where
nn is the next lowest available number from one through 999. If you return the system settings to their
default values, the custom_filename.properties file contains only comments.
Settings that are not stored in properties files (for example, Global Values) are not recorded or backed up
in this manner.
After editing a system setting, verify that the changes 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 to site-specific properties do not take effect until you restart the instance. Click
Restart Server on the current system settings tab to restart the application. You receive a confirmation
message before the restart occurs. Changes to global properties take effect when you save your edit; you
do not need to restart the server.

Caution: When you click Restart Server, the system shuts down immediately. All user sessions are
terminated with no warning.

92
Edit a system setting
1. Select Setup > System Configuration > System Settings.
2. Click the tab that contains the appropriate configuration setting.
3. In the value section of the setting, select a new setting or type the new entry over the current setting.
4. Click Save.
Tips for editing configuration settings:
l You can change more than one property value on a setting tab before you click Save.
l To return to the last saved settings, click Refresh.
l To return the default configuration settings of site-specific properties, click Restore Defaults. (You
cannot restore defaults to global properties.)

93
Use system settings
From a System Settings tab, you can select the following options:
l Save — The system looks for modifications to properties in the current tab. The system behaves
differently, however, depending on the type of property that you are saving:
o When you save a change to a global property, the system modifies the value in the database
immediately. (Global properties pertain to all instances in the system and are maintained in the
database.)
o When you save a change to a site-specific property, the system saves the change, but the change
does not take effect until you restart the instance. (Site-specific properties pertain to a single
instance and are maintained in property files within the instance.)
l Restore Defaults — The system archives all visible site-specific custom properties and restores all of
the original properties for this tab.

Note: Restoring defaults has no effect on global properties that are maintained in the database.
Modified database values remain modified.

l Restart Server — Restarts the instance so that site-specific property changes can take effect.

Caution: Clicking Restart Server causes the system to shut down immediately. All user sessions
are terminated with no warning.

l Add — The Printers tab allows you to add printers.

When you click Add on this tab, a new empty instance of the property name appears, with the next
sequential number attached to the name. You can then enter the value of the new property. For
example, if printer.1 through printer.6 are already in use, click Add to get the new property, printer.7,
and enter the qualified name for the seventh printer.
l You can leave property instances empty. For example, if your list included a property instance,
printer.8, with the value MyPrinter;\\printer\print, and you remove this printer, you can delete the value
and leave printer.8 empty. If it has no value, the system ignores this property instance.
l Refresh — Updates the page with any new or changed data.

Note: If you make changes to any of the site-specific system settings, you must restart the application for
the changes to take effect.

94
Understand properties validation
The system validates changes on most properties settings when you click Save or Restore Defaults. The
following validations occur, where appropriate:
l Required fields have a value entered.
l A numerical entry is equal to or above a minimum value.

l A numerical entry is equal to or below a maximum value.

l A numerical key has a numerical value entered.

l A text value has uppercase or lowercase letters where needed.

l A text value is within a minimum and maximum string length.

If you enter an invalid value, you receive an error message when you click Save. The error message
identifies the key and provides a general description of what is wrong. Because all entries are saved at the
same time, no property changes are saved for the page, if even a single entry fails. All errors must be
corrected and the page must be saved again.
Many keys contain an option button or drop-down lists.
Keys in each of the settings key and value details contain the following information, where applicable:
l Whether the key is required
l A minimum value

l A maximum value

l A default value

The default value is the default at initial installation.

Caution: Always access properties through System Settings in the System Configuration component,
which creates custom files. Accessing the properties files directly can lead to errors that render your
system unusable.

Click the following links for information about particular System Settings tabs. You might not have all of
the tabs in the list. The System Settings tabs available to you depend on the applications installed on your
system.
l Activities on page 99
l Attendance on page 101
l Audit Settings on page 103
l Auto-Scheduling on page 104
l Background Processor on page 106
l Batch Service on page 109
l Brazilian Compliance on page 111
l Budgeting on page 114
l Business Automation on page 116

95
 l Clock Synchronize on page 119
l Data Integration on page 121
l Database on page 124
l Device Management on page 128
l Display on page 130
l System Settings on page 91
l E-mail settings on page 131
l Engine Controller on page 134
l Event Manager on page 135
l Forecasting on page 136
l Global Values on page 139
l Group Edits on page 159
l JMS Configuration on page 161
l Java Plug-in on page 162
l Locale on page 165
l Log file on page 169
l Logging Context on page 172
l Messaging on page 174
l Monitoring on page 177
l Nursing Care Hours Summary on page 179
l POS Import on page 180
l Printers on page 181
l Priority Scheduling Engine on page 183
l Record Retention - Affected Databases on page 184
l Reports on page 187
l Request on page 189
l SQL Coverage on page 190
l Schedule Generator on page 191
l Scheduling on page 193
l Security on page 197
l Service on page 201
l Smart Operations on page 203
l Startup on page 206
l Timekeeping on page 208
l Transformation on page 211

96
l Web & App Server on page 212
l Workload on page 214

97
Analytics settings
The Analytics settings are used only if the Analytics product is installed.
Key and value details
site.analytics.taskproc.internal.url —The fully-qualified internal URL to invoke tasks on a remote
Analytics Application Server from this instance. The default is
http://host:port/wfc/analytics/servlet/taskProc.
site.analytics.wfan.ssrs.external.protocol — Protocol used to access the SSRS Server for Analytics
Reporting from the client-side browser. The default is http.
site.analytics.wfan.ssrs.external.port — Port configured for access on the SSRS Server for Analytics
Reporting from the client-side browser.
site.analytics.wfan.ssrs.external.fqdn — Fully qualified domain name of the SSRS Server for Workforce
Central Analytics Reporting when accessed from the client-side browser.
site.analytics.wfan.ssrs.external.reportmgr.virtualdir — Virtual directory or resource configured in
Web Server for Report manager application on the SSRS Server for Workforce Central Analytics
Reporting from the client-side browser. The default is /Reports/Pages/Folder.aspx.

98
Activities
The Activities settings are used only if Activities is installed.

Key and value details

site.wfa.project.framework.rollup.service.rollupservice.enabled —Enables the roll-up of hours and
currency amounts associated with grants and projects. Default = true.
If this setting is set to “true,” the roll-up services run every time the system is started using the desktop
“Go” icon, regardless of other settings on this tab.
site.wfa.project.framework.rollup.worker.rollupgrand.minutestosleep — Number of minutes between
executions of the roll-up service which calculates cumulative grand totals for each activity. Default = 60
minutes.
Grand totals indicate the total labor and non-labor hours, costs, charges, and wages that are associated
with each activity up to the time of the calculation. For the Grant And Project Tracking widget, grand
totals for all activities in a project are also calculated, including all budgeted and planned metrics (for
example, budgeted cost percentage used).

Important: Do not set grand total and daily total calculations to run at the same interval. Daily totals
must be calculated first so that grand totals are up-to-date.

site.wfa.project.framework.rollup.worker.rollupgrand.priority — Batch priority for rolling up grand

totals. Select from Highest, High, Medium, Low, or Lowest.
Default = Low
site.wfa.project.framework.rollup.worker.rollupdaily.minutestosleep — Number of minutes between
executions of the roll-up service which calculates cumulative daily totals for each activity. Default = 15
minutes.
Daily totals indicate the total labor and non-labor hours, costs, charges, and wages that are associated with
each activity up to the time of the calculation.

Important: Do not set grand total and daily total calculations to run at the same interval. Daily totals
must be calculated first so that grand totals are up-to-date.

site.wfa.project.framework.rollup.worker.rollupdaily.priority — Number of minutes the Activities

Rollup Daily Total Worker Daemon will pause between executions.
Default=1 minute
site.wfa.project.framework.rollup.service.rollupservice.activitytreerollup.enabled — Enables the
roll-up of hours and currency amounts associated with each child activity in an activity hierarchy. Default
= true.

99
 If this setting is set to “true,” the roll-up services run every time the system is started using the desktop
“Go” icon, regardless of other settings on this tab.
site.wfa.project.framework.rollup.service.rollupservice.logging.enabled — Enable logging that details
when roll-up services executed, details of each run, and failure indications, if any. Default = true.
site.wfa.genies.business.employee.columnloader.idle.included — Lets you choose whether to include
idle spans in Activities Genies. Idle spans are generated by the system depending on activity punches and
other rules. Default = false which excludes idle spans.
site.wfa.genies.business.employee.columnloader.paidmealbreak.included — Lets you choose whether
to include paid meal breaks in Activities Genies. Paid meal breaks are generated by the system depending
on activity punches and other rules. Default = false which excludes paid meal breaks.
site.wfa.genies.business.employee.columnloader.unpaidmealbreak.included — Lets you choose
whether to include unpaid meal breaks in Activities Genies. Unpaid meal breaks are generated by the
system depending on activity punches and other rules. Default = false which excludes unpaid meal breaks.

100
Attendance
The Attendance settings contain settings for Attendance.

Key and value details

site.attendance.RuleProcessingEndDateForEventManager — Defines the number of days that are
subtracted from the date on which the attendance processor is scheduled to run in the Event Manager. This
value is used to calculate the End Date beyond which attendance rules will not be applied.
For example, if the value is 1 and the processor is run on January 21, it will include employee information
through January 20 and then stop processing.
Value: installed default=0
It is recommended to set this value for enough in the past to allow managers time to correct employee’s
schedules and timecards prior to processing attendance rules.
site.attendance.DocumentTemplateContentType — The file format and character set that are used for
attendance document templates.
l HTML document templates — Set this value to: text/html; charset=windows-1252
l XML document templates— Set this value to: text/xml; charset=UTF-8

Value: required; installed default=text/xml; charset=windows-1252

site.attendance.DocumentContentDisposition — Controls the content disposition used for attendance
document templates. For example, Attachment;filename=sample.xml or
Attachement;filename=sample.html that corresponds to the MIME type.
Value: required
site.attendance.timeline.historicalPCE — Controls whether the attendance processor should ignore
historical edits from the timecard, process them on the effective date, or process them on their historical
date.
Value: required; installed default=Ignore
site.attendance.timeline.defaultEventHour — Defines the time, in hours, for attendance events that do
not have a specific time.
Value: required; minimum=0; maximum=23; installed default=23
site.attendance.timeline.defaultEventMinute — Defines the time, in minutes, for attendance events that
do not have a specific time.
Value: required; minimum=0; maximum=59; installed default=59
site.attendance.timeline.startDayOfWeek — Defines the first day of the week for week-based tracking
periods.
site.attendance.timeline.IntervalBasedException — Controls how the attendance processor handles the
value of the interval-based exception. .Value: required; installed default=true
l Select true and the processor selects the entire actual amount of time for the interval-based exception.
l Select false and the processor selects only the difference between the approved and unapproved time.

101
 For example, if an employee takes a long break of 90 minutes, and the approved break time is 60 minutes:
l Select true and the system selects the entire 90 minutes
l Select false and the system selects only the 30 minutes that are not approved.

The following settings control whether specific filters appear in the View menu of the Attendance Editor.
site.attendance.editor.viewfilter.Events - Select true and the Events filter appears in the View menu.
site.attendance.editor.viewfilter.LostTimeEvents - Select true and the Lost Time Events filter appears
in the View menu.
site.attendance.editor.viewfilter.CombinedEvents - Select true and the Combined Events filter appears
in the Viewmenu.
site.attendance.editor.viewfilter.Patterns - Select true and the Patterns filter appears in the View
menu.
site.attendance.editor.viewfilter.PAawards -Select true and the Perfect Attendance Awards filter
appears in the View menu.
site.attendance.editor.viewfilter.FormulaResults - Select true and the Formula Results filter appears in
the View menu.
site.attendance.editor.viewfilter.Actions - Select true and the Actions filter appears in the View menu.
site.attendance.editor.viewfilter.Expirations - Select true and the Expirations filter appears in theView
menu.
site.attendance.editor.viewfilter.BalanceAdjustments - Select true and the Balance Adjustments filter
appears in the View menu.

102
Audit Settings
The Audit settings enable you to specify items to be audited. You can enable items to be audited on a site-
by-site basis. The settings that appear depend upon the applications installed at your site.
The installed default for the Audit settings is false, with the exception of
site.audit.logon.enabled.
Select true for each type of auditing to be performed. For site.audit.logon.enabled, select the
types of user logons to be audited. The default is ALL.

Key and value details

site.audit.session.enabled — Set to true to audit each time a user accesses any URL in the system.
Value: installed default=false
site.audit.logon.enabled — Select the user logons to be audited: none, successful, failed, or all.
Value: installed default=ALL
site.audit.logon.unknown.enabled — Set to true to audit logon attempts made by unknown users.
Value: installed default=true
site.audit.security.enabled — Set to true to audit each time a user accesses any URL in the system.
Value: installed default=false
site.audit.ACCOUNT_LOCKOUT.enabled — Set to true to audit user accounts that become locked or
unlocked.
Value: installed default=false
site.audit.PASSWORD_CHANGE.enabled — Set to true to audit password changes.
Value: installed default=false
site.audit.PASSWORD_RESET.enabled — Set to true to audit each time a password is reset.
Value: installed default=false
site.audit.PASSWORD_QUESTIONS.enabled — Set to true to audit the configuration of password
questions and answers by users.
Value: installed default=false
site.audit.PERSON_CREATE.enabled — Set to true to audit each time a new person is created.
Value: installed default=false
site.audit.RESET_PASSWORD_UNKNOWN.enabled — Set to true to audit attempts by an unknown
user to reset the password.
Value: installed default=false
site.audit.LOGON_PROFILE_CHANGE.enabled — Set to true to audit Logon profile changes.
Value: installed default=false
site.audit.LongList.SecurityDataExportThreshold — The maximum number of rows of audit data that
can be exported.
Value: installed default=10,000

103
Auto-Scheduling
The Auto-Scheduling system settings contain information about the following:
l Debugging the Auto-Scheduler
l Custom fields for sorting employees

Key and value details

site.scheduling.autoscheduler.debug — If true, each time you run Auto-Scheduler, logs will be created.
This is useful for troubleshooting with a Kronos Global Support.
Value: required; installed default=false
site.scheduling.autoscheduler.logpath — For debugging, this is the path of the location in which the
system will put the debug log file.
Value: required; installed default={WFC.externaldir)/applications/wfso/log/
site.scheduling.autoscheduler.inputpath — For debugging, this is the path of the location in which the
system will put the debug input file.
Value: required; installed default={WFC.externaldir)/applications/wfso/input/
site.scheduling.autoscheduler.outputpath — For debugging, this is the path of the location in which the
system will put the debug output file.
Value: required; installed default={WFC.externaldir)/applications/wfso/output/
site.scheduling.autoscheduler.employeesortkey — This field determines how the Auto-Scheduler sorts
qualified employees for a shift, and how it breaks a tie when more than one employee is equally suitable.
Value: required; installed default=&default
Enter the names of your custom sort fields, separated by periods, in the order in which you want the system
to consider them.
site.scheduling.autoscheduler.bumpupbudget.multiplierpercent — The additional percentage of the
budget deficit to be added to the budget if a deficit exists.
Value: required; installed default=20
site.scheduling.autoscheduler.bumpupbudget.minthresholdminutes — The minimum amount by which
to increase the budget if a deficit exists.
Value: required; installed default=10
site.scheduling.autoscheduler.zerocoverageagelog.enabled — Specifies whether the zero coverage log
from the Auto Scheduler engine is turned on.
Value: installed default=false
site.scheduling.autoscheduler.bumpupbudget.qualificationthreshold — Specifies the ratio between
Weekly Budget Hours and Weekly Forecast Limits that should be maintained before budget bump up
occurs.
Value: installed default=500

104
site.scheduling.autoscheduler.zerocoverage.postfixup.enabled — Specifies whether the zero coverage
post fix-up process in the Auto Scheduler engine is enabled.
Value: installed default=false
site.scheduling.autoscheduler.shiftsetstartstop.enabled — If enabled, specifies that the shift start and
stop times are restricted by shift sets that are assigned to the location/jobs.
Value: installed default=false
site.scheduling.autoscheduler.shiftprofiles.enabled — When enabled, shifts are restricted to shift
profiles that are assigned to rule sets.
Value: installed default=false
site.scheduling.autoscheduler.scheduletoskill.enabled — Specifies whether to account for skills and
certifications. If set to true, Auto-Scheduler evaluates skills and certifications. If set to false, they are
ignored.
Value: installed default=false
site.scheduling.autoscheduler.DynamicScheduler.usePostProcessMaxShift
Swapping — Enables or disables maximum shift swapping in final post-process.
Value: installed default=false

105
Background Processor
Use the settings on the Background Processor tab to make subtle tweaks to the performance of a BGP. If
the BGP is performing acceptably, use the default settings.

Key and value details

site.wtbgp.totalizer.maximumThreads — The maximum number of BGP threads allocated for this
application server. When the server starts, this many BGP threads will be running. A user may stop or
restart a thread, but cannot create more.
Value: required; installed default=1
site.wtbgp.updateStaleTimeStamps.enabled — Controls the creation of the Background Processor
Totalization Out Of Date process, which marks employees out of date if their scheduled totals or actual
totals are too old. If True, the process begins at startup.
Value: required; installed default=true
site.wtbgp.updateStaleTimeStamps.period.hours — Specifies how often, in hours, the BGP marks
scheduled totals and actual totals as out of date.
Value: required; installed default=24 hours
site.wtbgp.createPayPeriods.enabled — Controls the startup of the Pay Period Service Controller
process, which creates new pay periods if the existing pay periods do not extend far enough into the future.
If True, this process begins at startup.
Value: required; installed default=true
site.wtbgp.createPayPeriods.period.days — Specifies the number of days the BGP waits between
checks to create new pay periods.
Value: required; installed default=30
site.wtbgp.createPayPeriods.futurePayPeriods.days — Specifies the number of days that pay periods
must extend into the future. This value helps the Pay Period Service Controller to determine how many pay
periods to create.
Value: required; installed default=60 days
site.wtbgp.totalizer.queue.employees.max — Specifies the maximum number of employees allowed in
the totalization queue. The BGP adjusts employee reads so as not to exceed this value.
If the property, site.wtbgp.totalizer.queue.fixedReadSize.enabled is true, the BGP,
always attempts to use the read size specified in the property,
site.wtbgp.totalizer.queue.fixedReadSize.
If the property is false, the BGP attempts to keep the specified number of employees in the queue.
Value: required; installed default=250
site.wtbgp.totalizer.queue.employees.min — The minimum number of employees allowed in the
totalization queue. When the queue sizes reaches this value or goes below it, the BGP controller adds new
employees to the queue.
Value: required; installed default=20

106
site.wtbgp.totalizer.queue.fixed ReadSize — Controls how many employees are read in at a time. The
BGP attempts to read this many employees for totalization in the time specified in the property,
site.wtbgp.totalizer.heartbeat.seconds. The attempted read is smaller if the number of
employees queued for totalization reaches the number specified in the property,
site.wtbgp.totalizer.queue.employees.max.
If enabled, the BGP reads this many employees at a time for totalization.
Value: required; installed default=50
site.wtbgp.totalizer.queue.fixedReadSize.enabled — Controls whether the BGP attempts to read a fixed
number of employees or the number specified in the property,
site.wtbgp.totalizer.queue.fixedReadSize.
If True, the BGP attempts to read the number of employees in the fixed read size. If false, the BGP
attempts to keep the queue at the number of employees specified in
site.wtbgp.totalizer.queue.employees.max.
Value: required; installed default=true
site.wtbgp.totalizer.idleTimeBeforeRetro.seconds — Specifies the number of seconds that the
totalization queue can remain idle before starting retro-totalization. The wait is designed to ensure that
retro-totalization does not interfere with normal totalization.
Value: required; installed default=60 seconds
site.wtbgp.totalizer.idleSecondsBetweenRetroQueueReads.seconds — The delay, in seconds, between
reads of retro-totalization rows from the database and from the internal queue.
Value: required; installed default=60 seconds
site.wtbgp.totalizer.heartbeat.seconds — The number of seconds that the totalization queue can remain
idle before the BGP starts retro-totalization. The wait is designed to ensure that retro-totalization does not
interfere with normal totalization.
Value: required; installed default=15
site.wtbgp.totalizer.redundantExceptionsToLog.max — The maximum number of times that each
exception should be logged. This number prevents the logs from growing infinitely when there is a
catastrophic error. Currently, this setting affects only the BGPDaemonController thread. A positive number
indicates that only n occurrences of a redundant exception are logged. A negative value causes all
exceptions to be logged.
Value: required; installed default=3
site.wtbgp.totalizer.lock.minutes — The number of minutes between totalization retries if totalization is
not successful. If the BGP fails to totalize three times, this value will not be used. Instead, the BGP will
try again every 24 hours for an additional 20 days.
Value: required; installed default=5
site.wtbgp.totalizer.lock.minutes.retrototalization — The number of minutes between retrototalization
attempts.
Value: required; installed default=30
site.wtbgp.totalizer.timerMarkOutOfDate — The number of seconds that must elapse after the last
update of pay rules, work rules, or their building blocks before the Totalizer should mark affected
employees out of date.
Value: required; installed default=30

107
 site.wtbgp.totalizer.numberOfRulesThreshold — The threshold for the number of pay rules and work
rules currently in totalization. Additional totalizer processing is initiated if the number of rules becomes
higher than the threshold.
Value: required; installed default=25
site.wtbgp.enabled — Specifies whether the Java BGP starts up If True, the Java BGP starts up.
Value: required; installed default=true

108
Batch Service
The Batch Service settings contain information about times during which to allow batch processes for
scheduling or forecasting to be run. These settings apply to the server on which they are set.

Key and value details

site.BatchService.controllerPollingInterval — The system checks the batch queue at intervals of this
number of milliseconds to check whether a batch event is scheduled to run.
Value: required; installed default=60000
site.BatchService.controllerName — The name of the batch controller thread.
Value: required; installed default=BatchService Controller
site.BatchService.workerName — The name of the batch worker thread.
Value: required; installed default=BatchServiceWorker
site.BatchService.batchNotificationName — Value: required; installed default=BatchService Worker
site.BatchService.numberOfCPU — The logical number of CPUs to allocate to batch processing. If you
leave this field at zero (0), this server will not be used for batch processing schedules or forecasts.
Value: required; installed default=1
site.BatchService.maximumUtilizationPercentage — For each logical CPU, the logical percentage of
the system to allocate to batch processing.
Value: required; installed default=100
site.BatchService.retryThresholdInMinutes — At the end of this amount of time, in minutes, if the
batch is still running, the system will consider the batch event to have failed and will stop the process.
Value: required; installed default=60
site.BatchService.ControllerHOP.enabled — If true, the system looks at the next two fields, which
indicate what times of day batch processes can run. If false, batch processes can run at any time.
Value: required; installed default=false
site.BatchService.ControllerHOP.start — Time at which batch processes can start. This time is counted
in number of minutes from midnight; thus 1200, the default, is 8 P.M.
Value: required; installed default=1200
site.BatchService.ControllerHOP.end — Time at which batch processes end. This time is counted in
number of minutes from midnight; thus 240, the default, is 4 A.M.
Value: required; installed default=240
site.BatchService.notifyLaunch — When set to true, specifies that the launch of batch service is notified.
Value: required; installed default=false
site.BatchService.ThreadPoolMaxSize — The maximum number of Batch Worker Threads.
Value: required; installed default: 16 threads
site.BatchService.monitorService.enabled — Specifies whether the batch monitoring service is enabled.
Value: required; installed default=true

109
 site.BatchService.monitorControllerName — The name of the batch monitoring controller thread.
Value: required; installed default=BatchMonitorService Controller
site.BatchService.monitorWorkerName — The name of the batch monitoring worker thread.
Value: required; installed default=BatchMonitorService Worker
site.BatchService.monitorPollingInterval — The interval at which the batch monitoring service pools for
statistics gathering and e-mail notification (in milliseconds, 60000 = 60 seconds).
Value: required; installed default=300000
site.BatchService.monitorMaximumReportErrors — The maximum number of error messages that can
be reported in the notification.
Value: required; installed default=5
site.BatchService.monitorOmitReportIds — Specifies whether to include batch event/task/task item IDs
in the notification report.
Value: required; installed default=true
site.BatchService.XMLNotification.enabled —Allows a consumer to send a xml notification to all
servers requesting that newly created batch event be processed immediately.
Value: required; installed default=true

110
Brazilian Compliance
The System Settings in this workspace are used to configure Workforce Central to operate in compliance
with Brazilian rules that govern the electronic recording of timecards and the use of electronic time-
keeping systems.
site.brc.pis.customFieldName — Name Of Custom Field Label For Employee PIS number
Default = PIS
site.brc.exportFile.path — File Path For Export Audit Files Default = installation_
directory\instance\
site.brc.exportFile.defaultReason— Default Reason For Punch Correction
Default = Correction
site.brc.exportFile.dateFormat — Date Format Used For Export Audit Files
Default format = mm/dd/yyyy
site.brc.brcservice.EnableBRCService— Enable the Brazilian Compliance Controller Service.
Default = false
site.brc.brcservice.enableretrievepunchesworker — Enable the Retrieve Device Punches Worker
Default = true
site.brc.brcservice.retrievepunchesworker.SleepTime — The retrieve device punches worker's sleep
time interval before the next acknowledgment (in seconds).
Default = 900
site.brc.brcservice.retrievepunchesworker.ReferenceRunTime — The retrieve device punches
worker's start time reference.
Default = 8:00
site.brc.brcservice.retrievepunchesworker.RunFrequency — The retrieve device punches worker's
run time frequency (in seconds).
Default = 3600
site.brc.brcservice.enableprocesspunchesworker— Enable the Process Device Punches Worker
Default = true
site.brc.brcservice.processpunchesworker.SleepTime — The process device punches worker's sleep
time interval before the next acknowledgment (in seconds).
Default = 180
site.brc.brcservice.processpunchesworker.ReferenceRunTime— The process device punches
worker's start time reference.
Default = 8:05
site.brc.brcservice.processpunchesworker.RunFrequency— The process device punches worker's run
time frequency (in seconds).
Default = 600

111
 site.brc.brcservice.processpunchesworker.PunchWaitTimeInSeconds — Number of seconds to wait
before a punch stalled in process is eligible for re-processing.
Default = 3600
site.brc.brcservice.enableupdatedevicesworker — Enable the Update Devices Worker
Default = false
site.brc.brcservice.updatedevicesworker.SleepTime — The update devices worker's sleep time interval
before the next acknowledgment (in seconds).
Default = 3600
site.brc.brcservice.updatedevicesworker.ReferenceRunTime— The update devices worker's start time
reference.
Default = 8:00
site.brc.brcservice.updatedevicesworker.RunFrequency— The update devices worker's run time
frequency (in seconds).
Default = 21600
site.brc.treatment.paycode.category.day.regular.name— Individual or group pay code name for
Regular Day hours.
Default = Regular
site.brc.treatment.paycode.category.night.regular.name — Individual or group pay code name for
Regular Night hours.
Default = RegNightDay
site.brc.treatment.paycode.category.day.overtime.1.name — Individual or group pay code name for
Overtime 1 Day hours.
Default = Ovt1Day
site.brc.treatment.paycode.category.night.overtime.1.name — Individual or group pay code name for
Overtime 1 Night hours.
Default = Ovt1Night
site.brc.treatment.paycode.category.day.overtime.2.name — Individual or group pay code name for
Overtime 2 Day hours.
Default = Ovt2Day
site.brc.treatment.paycode.category.night.overtime.2.name — Individual or group pay code name for
Overtime 2 Night hours.
Default = Ovt2Night
site.brc.treatment.paycode.category.day.overtime.3.name — Individual or group pay code name for
Overtime 3 Day hours.
Default = Ovt3Day
site.brc.treatment.paycode.category.night.overtime.3.name — Individual or group pay code name for
Overtime 3 Night hours.
Default = Ovt3Night

112
site.brc.treatment.paycode.category.day.overtime.4.name —Individual or group pay code name for
Overtime 4 Day hours.
Default = Ovt4Day
site.brc.treatment.paycode.category.night.overtime.4.name — Individual or group pay code name for
Overtime 4 Night hours.
Default = Ovt4Night
site.brc.treatment.paycode.category.absent.name— Individual or group pay code name for Absent
hours.
Default = Absent
site.brc.treatment.paycode.category.totalworked.name— Individual or group pay code name for
TotalWorked hours.
Default = TotalWorked

113
Budgeting
The Budgeting systems settings are used in Budgeting.

Key and value details

site.budgeting.eventData — If true, data from special event days, for example when a store has to close
because of a snow storm, is discarded so that it does not affect the sales volume forecast.
If false, data from special event days is kept and it does affect the sales volume forecast.
Value: required; installed default=false
site.budgeting.engine.log
If true, debugging information arising from budget generation is written in a log file. In some cases, this
information can be useful to developers.
If false, no budget generation log is created.
Value: required; installed default=false
site.budgeting.engine.alwaysAutoSelectParameters
If true, the Operations Planning system automatically monitors your POS data and adjusts the four related
parameters to produce the most accurate labor forecast that it can. This occurs whether or not
Automatically set volume parameters at run time is selected in the engine option parameters setup.
If false, the system does not automatically set the volume parameters—you can either select the parameter
Automatically set volume parameters at run time in Setup > Engine Option Sets,or you can enter
volume values in Setup > Engine Option Sets.
Value: required; installed default=false
site.budgeting.engine.logpath — Enter the complete path to the budgeting engine log; for example,
{WFC.externaldir}/applications/wfop/log/.
site.budgeting.VolumeBudgetEngine.DoNegativeBudgetReadjustment
If true, the system will not generate negative volume budget because of irregular historical data.
If false, the system will generate negative volume budget because of irregular historical data.
Value: required; installed default=true
site.budgeting.VolumeBudgetEngine.runEngineInteractively
If true, the system will not distribute volume batch engine operations through the batch processing
framework.
If false, the system will distribute volume batch engine operations through the batch processing framework.
Value: required; installed default=false
site.budgeting.LaborBudgetEngine.runEngineInteractively
If true, the system will not distribute labor budget engine operations through the batch processing
framework.

114
If false, the system will distribute budget engine operations through the batch processing framework.
Value: required; installed default=false
site.budgeting.LaborBudgetEngine.useNonVolumeDistributionFactor — Account for labor standard
distribution loss while calculating labor budgets from labor standards using non-volume drivers.
Value: required; installed default=true
site.budgeting.LaborBudgetEngine.useVolumeDistributionFactor — Account for labor standard
distribution loss while calculating labor budgets from labor standards using volume drivers.
Value: required; installed default=false
site.budgeting.BudgetEngines.useConsolidatedFiscalCustomDriverData — This property sets the
source custom driver data. If true, the source is Budgeting. If false, the source is Forecasting.
Value: required; installed default=false
site.budgeting.budgetdata.exportdir — The directory path of the budget data export files (in excel or csv
format).
Value: required; installed default={WFC.externaldir}/applications/wfop/export/
site.budgeting.budgetdata.decimal — The number of decimal places, from 0 to 3, to use in displayed
budget data.
site.budgeting.Editor.NumBatchItems — The minimum number of batch items listed in each Batch Task
when committing a budget edit.
Value: required; installed default=10
site.budgeting.budgetPlanner.allocate.allocateToExactPercentage
l If true, the system restricts the allocate percentage to an exact rollup of 100.00%.
l If false, the system does not restrict the allocate percentage.

Value: Required; installed default=false

site.budgeting.budgetadjustedlaborbatch.weeksToCalculate — Number of weeks (including the current
week) of budget adjusted labor data for the Budget Adjusted Labor Calculation to generate.
Value: required; installed default=2
site.budgeting.budgetadjustedlaborbatch.numberOfSitesPerBatch — Number of sites to process the
Budget Adjusted Labor Forecast calculation through the default batch event within a single batch request.
Value: required; installed default=100
site.budgeting.BasicOperationsPlanner.weeksToSearchBack — Number of weeks to search backward
for released plans to display in Basic Operations Planner.
Value: required; installed default =26
site.budgeting.Alerts.expirationPeriod — Defines an expiration time for Operations Planner alerts.
After the specified number of weeks, the alert disappears if no action is taken on it.
Value: required; installed default=4

115
Business Automation
The Business Automation settings are used by Process Manager.

Key and value details

wba.processengine.enabled — Set to true to enable the Process Engine on your system.
Value: required; platform=Windows; installed default=true
wba.clustermanager.eligible — Set to true to enable the system as the Cluster Manager host. To optimize
performance, specify false for this setting on application servers that will never be used as a Cluster
Manager.
Value: required; installed default=true
wba.processengine.heartbeat.interval — The interval (in seconds) when the status of the Process Engine
is checked.
Value: required; minimum=0; installed default=120
wba.processengine.initialdbconnections — The number of database connections to be created at startup.
Value: required; minimum=1; installed default=5
wba.processengine.maxdbconnections — The maximum number of database connections to be created.
Value: required; minimum=1; installed default=100
wba.processengine.maxstatements — The number of cached, prepared statements per Process Engine
database connection.
Value: required; minimum=5; installed default=50
wba.processengine.threadpoolsize — The maximum number of threads the Process Engine should
generate for use in working with processes. Separate tasks can run concurrently, in separate threads.
Value: required; minimum=1; installed default=42
wba.processengine.server.maxpoolsize — The default maximum pool size per instance. You cannot save
a process template on the Process Templates page whose Max Pool Size value is greater than this Max
Pool Size value on the instance. If the Max Pool Size value on the Process Templates page and this Max
Pool Size system setting are not the same, the Pool Manager will create template pools whose size is the
lesser of the values.
Value: required; minimum=0; installed default=1000
wba.processengine.mrucachecapacity — The maximum number of processes to be held in memory.
Value: required; minimum=1; installed default=100
wba.processengine.maintainrequesttransitions — Specifies if workflows initiated via a request subtype
transition will be maintained within Process Designer after completion.
Value: required; installed default=false
wba.rmiregistry.port — The port on which to start the rmiregistry and Cluster Manager. If you change
this setting, you must restart the system.
Value: required; minimum=0; installed default=11111

116
wba.processengine.skip.aborted.tasks — Set to true to allow the Process Engine to skip workflows with
aborted tasks when starting WFC.
Value: required; installed default=false
wba.site.enginelog.active — Set to true to activate logging for Process Engine on your system.
Value: required; installed default=true
wba.site.loggingContext.WFC.WBAP.PROCESSENGINE — The default logging level for the Process
Engine. Valid entries are WARNING, INFO, ERROR, or DEBUG. For more information about the
logging level entries, see the logging level entries table in the Log file on page 169.
Value: required; installed default=WARNING
wba.processengine.taskmaster.personnum — The person number of the individual, usually an
administrator, who will receive a message if a business process encounters errors. If you do not enter a
value, only the person who initiated the process (the originator) will receive a message.
Assign more than one person, so that other administrators can act on these messages if the primary
administrator is unavailable.
wba.processengine.email.sender — The Sender field (specific to your organization) for e-mail messages
generated from the Process Engine.
Value: required; installed default={site.email.sender}
wba.processengine.exception.email.to — A comma-separated list of people to be notified when a
business process encounters errors. Note the following:
l The “originator” is the person who started the business process.
l The wba.processengine.taskmaster.personnum value is the person whom you specified to receive a

message if a business process encounters errors.

l You can also enter additional comma-separated person numbers for any other individuals that you want

to receive the error notification messages, for example:

wba.webform.timeout.wait, wba.webform.timeout.retrydelay
wba.wf.tasklist.defaulttaskdays — Specifies the number of days in the past that show in the task list.
Value: installation default=30
wba.webform.timeout.wait — The total amount of time (in milliseconds) that Process Manager will wait
for a web form.
Value: required; minimum=1; installed default=10000
wba.webform.timeout.retrydelay — The total time interval (in milliseconds) that Process Manager will
wait before checking if the requested web form
is active.
Value: required; minimum=1; installed default=200
wba.web.service.config.editor.name.maxlength
Value: required; installed default=50
wba.web.service.config.editor.wsdlurl.maxlength
Value: required; installed default=250
wba.web.service.config.editor.property.value.maxlength

117
 Value: required; installed default=250

118
Clock Synchronize
The Clock Synchronize settings establish the general parameters for synchronizing the instance’s date and
time (which may be drawn from the physical server’s machine time) with that of the database server.
When services start up, the instance retrieves the date and time from the database server.
The Clock Synchronize settings control the Clock Synchronize daemon, which is a service that runs and
keeps the instance’s time synchronized with the database server time. The Clock Synchronize daemon
keeps an internal delta between the instance and the database server times. When an application requests
the current time, the delta is applied to the current instance’s time.
If the instance 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.
You can specify this synchronization process to occur at multiple intervals throughout a day.
Using the Clock Synchronize settings tab, you can:
l Enable a clock synchronization to occur throughout the day
l Specify synchronization intervals

l Specify the times of the day that the synchronization should occur

You can also synchronize the instance’s time and the database server times by restarting the Clock
Synchronize daemon on the Threads tab.

Key and value details

site.clocksync.number_of_daily_syncs — Determine how many times a day that the instance’s clock
should synchronize to the database server clock. A zero value disables the clock synchronization process,
and the instance uses its own clock.
Value: required; installed default=24
site.clocksync.hour_of_sync — Specifies what hour of the day the clock synchronization process should
occur. Possible values are 0 to 23, with 0 being midnight. You can specify a non-critical time in a day for
the synchronization process to occur.
If you have site.clocksync.number_of_daily_syncs set to synchronize multiple times a day, the hour
specified in site.clocksync.hour_of_sync will be one of the daily synchronizations. For example, if you
have site.clocksync.number_of_daily_syncs set to 4, and site.clocksync.hour_of_sync set to 9,
synchronizations will occur at 9:00, 12:00, 3:00 and 6:00.
Value: required; minimum=0; maximum=23; installed default=1
site.clocksync.minute_of_sync — Specifies what minute of the hour the clock synchronization process
should occur. Possible values are 0 to 59. You can specify a non-critical time in a day for the
synchronization process to occur.
If you have site.clocksync.number_of_daily_syncs set to synchronize multiple times a day, the hour and
minute specified in site.clocksync.hour_of_sync and site.clocksync.minute_of_sync will be one of the daily
synchronizations. For example, if you have site.clocksync.number_of_daily_syncs set to 4,

119
 site.clocksync.hour_of_sync set to 9, and site.clocksync.minute_of_sync set to 23 synchronizations will
occur at 9:23, 12:23, 3:23, and 6:23.
Value: required; minimum=0; maximum=59; installed default=0

120
Data Integration
Use the Data Integration system settings to configure the Integration Manager application.

Key and value details

knx.engine.ThreadPoolSize — The number of threads the Integration Manager engine can generate for
working with the interfaces that have been created and deployed on the system. If you change this setting,
you must restart the Timekeeper application.
Value: required; minimum=1; installed default=5
knx.engine.GetJobTimeout — The number of seconds to block other requests while waiting for the job
status to be returned.
Value: required; minimum=1; installed default=2
knx.engine.StalledJobFrequency — The number of minutes to wait before scanning the database for
interface jobs that have stalled and will not be completed. Those jobs will be assigned a status of
ABORTED
Value: required; minimum=1; installed default=5
knx.engine.JobMaxInactiveTime — The number of minutes of inactivity before the system determines
that an interface job is stalled. The stalled job is then assigned a status of ABORTED. A value of 0
disables this setting.
Value: minimum=0; installed default=60
knx.engine.BatchProcessPollInterval
Value: required; installed default=10
knx.engine.BatchProcessPolling
Installed default=true
knx.engine.MaxInMemorySortSize — This setting determines when the Integration Manager engine uses
memory or the database to perform a sort operation on the output. The value that you specify represents the
result of the following calculation: number of rows of input * the number of fields of output.
l Values above the setting will be sorted in a database.
l Values below the setting will be sorted in memory.

Value: required; minimum=1; installed default=2000000

knx.engine.CreateSortTableSQL — Set to true if you want to specify your own DDL for the sort
database; otherwise, set to false. If you set to true, then you can specify values for the CreateSortTable
system settings that follow.
knx.engine.CreateSortTableStringDatatype — Configure this setting only if you are using your own
DDL for the sort database and have set knx.engine.CreateSortTableSQL to true. This setting defines the
String column data type (include size). Example: NVARCHAR(4000)

121
 knx.engine.CreateSortTableFloatDatatype — Configure this setting only if you are using your own DDL
for the sort database and have set knx.engine.CreateSortTableSQL to true. This setting defines the Number
column data type. Example: FLOAT
knx.engine.CreateSortTableBinaryDatatype — Configure this setting only if you are using your own
DDL for the sort database and have set knx.engine.CreateSortTableSQL to true. This setting defines the
Binary data type. Example: NTEXT
knx.engine.CreateSortTableMaxTableNameLen — Configure this setting only if you are using your
own DDL for the sort database and have set knx.engine.CreateSortTableSQL to true. This setting defines
the maximum length of a database table name (in characters).
knx.engine.TruncationThreshold — The number of duplicate errors that will appear in the error report.
Value: required; minimum=1; installed default=500
knx.engine.MaxXMLLogSize — The size in megabytes (MB) of the XML log files that the system
generates when the source is Workforce Central API Export or the output is Workforce Central Import.
The default value is 1.
l The default value of 10 indicates that there is a size limit of 10 MB for the log files.
l A value of 0 indicates that there is no limit to the size of the log files.

Specify a value for this setting only if you plan to run one or more interfaces that use a very large number
of records (for example, 100,000 records).
knx.engine.ShortDateFormat — The date format MM/dd/yy (month, day, and last two numbers of the
year) that will be used by the system for data integration operations. This is the default. For example:
04/30/08.
knx.engine.LongDateFormat — The date format MM/dd/yyyy (month, day, and all four numbers of the
year) that will be used by the system for data integration operations. For example: 04/30/2008.
knx.engine.ShortTimeFormat — The time format HH:mm (hours and minutes) that will be used by the
system for data integration operations. This is the default. For example: 10:15.
knx.engine.LongTimeFormat — The time format HH:mm:ss (hours, minutes, and seconds) that will be
used by the system for data integration operations. For example: 10:15:25.
knx.engine.TimeAMString — The A.M. time format that will be used by the system for data integration
operations. The default is am.
knx.engine.TimePMString — The P.M. time format that will be used by the system for data integration
operations. The default is pm.
knx.engine.DateSeparator — The symbol that will be used to separate the elements of a date format. The
default is a slash ( / ).
For example: 04/30/08.
knx.engine.TimeSeparator — The symbol that will be used to separate the elements of a time format.
The default is a colon ( : ).
For example: 10:15.

122
knx.engine.AllowRunCommand — If an interface contains steps with commands, this property must be
set to true to enable those commands to execute on the server whenever that interface is run. The default is
false.
knx.engine.RunCommandVarDelimiter — When designing an interface, a mapped folder may be
specified in a command for a step. A symbol, or delimiter, is required to identify that portion of the
command as a mapped folder. For example, if you specify the @ symbol for this setting, the system will
identify the following entry as a mapped folder while executing the command in a running interface:
@MAPPED_FOLDER@. The default symbol is @.
knx.engine.DecimalSeparator — The symbol that will be used as decimal separator for data integration
formatted numeric output. The default is a period (.). For example: 829.99
knx.engine.GroupSeparator — The symbol that will be used as group separator for data integration
formatted numeric output. The default is a comma (,). For example: 28,982,999
knx.engine.NegativeNumberFormat — The format to be used by the system for all data integration
formatting for negative numbers. The default is -1.1 For example: -889.78

123
Database
The Database settings show 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.
Configuration settings for this database appear in the WPKSite.properties property file.
Various instances can access different databases for different purposes. For example, one instance can
connect to a test database, while other instances can connect to a production database. This tab only
reflects the database to which this instance is connected.
An instance can only be connected to one database at a time. However, multiple instances can be
connected to the same database. Unless you switch databases, you are not likely to modify any of the
database properties in this tab. If you do need to modify a value, you can do so while the database is
running. However, your modification does not take effect until the instance is shut down and restarted.
If you modify a database property for one instance, be sure to make the same modifications to all instances
that connect to the same database.
Also note that if you switch databases, you must also make changes to the notification server in addition to
the system settings. For more information, see Switch databases on page 126.

Key and value details

site.database.ha.MULTINET_SUBNET_FAILOVER — Set this property to true if using AlwaysOn for
MS SQL Server. Requires restart.
Default = false
site.database.ha.FCF_ENABLED — Set this property to true for enabling Oracle RAC FCF. IF you set
this property to true, also set site.database.ha.ONS_CONFIG to true. Requires restart.
Default = false
site.database.ha.ONS_CONFIG
site.database.validateConnectionOnBorrow — Validate each connection on borrow from pool. The
operation may be expensive for databases other than Oracle. Requires restart.
Default = false
site.database.all.loginTimeout — The number of seconds before the connection process will abort when
the instance connects to the database.
When you are restarting the instance and the database is extremely busy, set this key to a higher number to
give the system extra time to make the connection.
Value: required; minimum=1; maximum=30; installed default=16
site.database.all.dbreport.RepTimeToLive — Defines the amount of time (in hours) that database report
files stay in the system before being automatically deleted. The Database Report Status workspace lists the
available database reports.
Value: required; minimum=0; installed default=72
site.database.names — The name of the database.
Value: required

124
site.database.dotnetDBConnection — Specifies the pathname for accessing the operational database
through the .NET framework. The connection string references database drivers that are found in the
following versions of the .NET Framework: 2.0, 3.0, and 3.5. This setting is configured properly for most
environments based on values entered during installation.
The format is:
Data Source=database_server:port_number;Initial Catalog=database_name
or SID;
Value: required
site.database.url — The value assigned to this property identifies the JDBC connection string that
connects the instance to the database. The format is:
jdbc:driver://database_server:port_number;
databaseName=database_name or SID;
site.database.usr — Identifies the database logon user ID that was set up during the initial configuration.
If you are using a different user account for the new database, change this property value.
site.database.pwd — Specifies the value of the encrypted password that was set up during the initial
configuration. If you are using a different password for the new database, change this property value.
site.database.drv — Used to connect to the database.
site.database.min — The database name with .min is the minimum database pool size.
Value required; installed default=10
site.database.max — The database name with .max is the maximum database pool size. If you get
messages in your log files that the pool size is exceeded, increase this value in increments of 10.
Value required; installed default=250, recommended value=250
site.database.oracle.pool.datasource
site.database.sqlserver.pool.datasource
site.database.all.dbreport.customDBReportDatabase.usr — Identifies the database logon user ID of
the schema for database reports (only appears if you are using an Oracle database).
site.database.all.dbreport.customDBReportDatabase.pwd — Specifies the value of the encrypted
password that is associated with the specified user name of the schema for Database Reports (only
appears if you are using an Oracle database).
site.database.all.dbutility.tempTableIDsTimeToLive — Specifies how many hours database IDs can
stay in the database utility temp tables before being purged by the DB Utility Clean Up Worker thread.
Value required; installed default=24
site.database.all.dbutility.cleanUpThreadWakeUpInterval — The interval, in seconds, when the DB
Utility Clean Up Worker thread should wake up to check for outdated records in the database utility temp
tables.
Value required; installed default=60
site.database.DeadThreadCleanInterval — The number of minutes between cleaning of dead threads in
persistence. A value of 0 indicates never.
Value required; installed default=60

125
 site.database.NotifyOnSQLError
Installed default=Off

Switch databases
The database that was identified when your system was installed is usually your production database.
Configuration settings for this database appear in the WPKSite.properties property file.
To switch databases, you must change references to the database in System Settings and in the notification
server configuration file.

Note: The system implements properties changes in a precise sequence. Do not alter the procedure for
modifying properties.

1. Select Setup > System Configuration > System Settings > Database.
2. Change the following properties:
o site.database.url — Enter the URL of the database to which you want to switch. Use the
following format:
jdbc:driver://database_server:port_number;databaseName=database_
name or SID;
For example, the database has a sqlserver driver, a port value of 1433, a name of DBTEST,
and is on a server named server_1. The property value would be:
jdbc:sqlserver://server1.company.com:1433;databaseName=DBTEST;
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.
o site.database.dotnetDBConnection— Enter the following:
Data Source=database_server:port_number;Initial Catalog=database_
name or SID;
For example, you might enter the following for a SQL Server database called DBTEST on server1:
Data Source=server1.company.com:1433;Initial Catalog=DBTEST;
o site.database.usr — User account name of the database to which you want to switch.
o site.database.pwd — Password for the user account.

3. Click Save.
4. Stop the application server using the Stop icon.
5. Stop the notification server using the Notification Server icon.
6. Encrypt the database password.
a. Open a command window as an administrator on the application server and navigate to
\\Kronos\configuration\boms\bin.
b. Enter the following:
krnencryptNS password

126
 where password is the database password used.
c. Save the encrypted key that the system returns.
7. Edit the openfire.xml file:
a. With a text editor, navigate to \\Kronos\openfire\instance\conf and open
openfire.xml.
b. Search for <database> and change the values of the database URL, user, and password using
the encrypted password produced by krnencryptNS.exe. For example:
<database>
<driver>com.microsoft.sqlserver.jdbc.SQLServerDriver</driver>
<url>jdbc:sqlserver://
server1.company.com:1433;databaseName=DBTEST;</url>
<username>SUPRKRON</username>
<password>111763610C64626&lt;</password>
<minConnections>3</minConnections>
<maxConnections>10</maxConnections>
<connectionTimeout>0.5</connectionTimeout>
<testSQL>Select 2</testSQL>
<testBeforeUse>false</testBeforeUse>
<testAfterUse>false</testAfterUse>
</database>
c. Close the file, saving your edits.
8. Restart the server using the Start icon.
9. Restart the notification server using the notification server icon.

Note: Properties with global scope across instances are maintained in database tables. If you switch
databases, copy these properties to the new database.

127
Device Management
The Device Management tab is only visible when Device Manager is installed. The settings on this tab are
specific to Device Manager.

Key and value details

site.wdm.upload.monitor.interval.inseconds — The time interval in seconds when uploaded data is
processed.
Value: required; minimum=10; installed default=20 seconds
site.wdm.upload.monitor.max.batch.size — The number of characters allowed in a batch handled by the
upload service. Each punch is approximately 150 characters long. The default value of 20,000 characters
represents approximately 130 punches. The default value is set to balance impact on performance and
scalability, so it generally should be left unchanged.
Value: required; minimum=500; installed default=20,000
site.wdm.instance.id — The instance ID that is assigned when an instance is created. This ID must be
entered on the maintenance screen of the device. On this tab, the property is read-only.
Value: required; installed default=5001
site.wdm.proxy.enabled — The setting that determines if a web server proxy is to be used for server-
initiated communications between a 4500 device and Device Manager. If the setting is True, the proxy is
enabled.
Value: required; installed default=False.

Note: If site.wdm.proxy.enabled is False, then site.wdm.proxy.use.primary.server,

site.wdm.proxy.port, and site.wdm.proxy.server.name do not apply.

site.wdm.proxy.use.primary.server — If site.wdm.proxy.enabled is True, this setting specifies

whether the proxy should use the primary server specified in the Device Communications Settings building
block as the server name to be used for the web server proxy.
Value: installed default=False
site.wdm.proxy.port — If site.wdm.proxy.enabled is True, this setting specifies the port used by
the web server proxy.
Value: installed default=80
site.wdm.proxy.server.name — If site.wdm.proxy.enabled is True, this setting is the name of
the server to be used by the web server proxy. This setting is used only if
site.wdm.proxy.use.primary.server is False
Value: installed; installed default=false
site.wdm.alternate.primary.webServers — A list of IP addresses or server names for alternate web
servers that can access Device Manager application servers. Entries are comma delimited. The servers
defined here are used in conjunction with Primary Server defined in the Communication Settings building
block. They are used for load balancing of devices. This setting is only used by devices configured with the

128
server-initiated protocol.
Value: optional; installed default=blank

Note: If you have a NAT (Network Address Translation) server IP address or a SSL terminator defined
as a Primary Server in the Communication Settings building block, than you must add the Workforce
Central web server in this alternate primary web servers list.

site.wdm.host.address — Hostname or address of network interface to be used by Device Manager.

Value; installed.
site.wdm.security.overrride.enabled — If this setting is true, Device Manager always uses secure
communication (port 443) for SSL devices configured with the server-initiated protocol. Port 80 is not
required to be open. The suite installation and all devices are assumed to be operating in secure mode.
Value: installed default=False
site.wdm.refreshInterval — The automatic refresh interval for device manager in seconds. A value of 0
disables the automatic refresh.
Value: required; maximum=600 seconds; installed default=60 seconds
site.wdm.show.single.row.per.device — Shows one row per device if set to true.
Default: false
site.wdm.device.max.groups.displayed — Maximum number of groups to be displayed on a single device
row in Device Manager. A value of 0 shows all groups.
Default: 3
site.wdm.alternate.phone.book.path— A complete path for an alternate phone book for dial-up
networking. This setting is used in device communications for a modem device when the device is defined
with a phone number. This setting only applies to devices using the server-initiated protocol.
Value: optional; installed default=blank. System phone book used.
site.wdm.perform.files.path
site.wdm.devicelogs.path—A complete path for the directory for saving logs retrieved from devices. If
the directory is not specified, it will be created. when device logs are retrieved.
Value: required, installed default= <install directory>/<instance name>/devicelogs.
site.wdm.server.list.update.log.enabled — When WDM server status changes, server information is
written to a csv log file.
Value: installed default=False
site.wdm.device.long.list.size — The maximum number of devices that can be displayed in the device
manager.
Value: required; installed default=1000
site.wdm.intouch.si.enddownload.readtimeout.sec — The maximum amount of time (in seconds) that
the Device Manager server waits for the SI InTouch to process the command.
Default: 2700

129
Display
The Display settings define the communication protocol for custom URLs and the mode to run the
application server in while customizing a theme. The site.portal.theme.name setting determines
the theme to apply to the site. A theme includes a style sheet, icons, and logos.

Key and value details

site.portal.systemconfiguration.MaxTabsInRow — The number of tabs to display on a single menu row
for System Information and System Settings.
Value: required; minimum=1; maximum=8; installed default=7
site.portal.external.communication.protocol.include — Set to true to force the communication protocol
to be included in custom URLs.
Value: required; installed default=true
site.portal.external.communication.protocol — The default communication protocol used when invoking
custom URLs.
Value: required; installed default=http
site.portal.theme.name — Specifies the visual theme to apply to the site. The theme name comes from
the name of the folder that contains the stylesheet, icons, and logos that make up the theme.
Value:required; installed default=basic

Note: If you are using the multi-language single-instance feature, you must set this value to global.

site.portal.theme.development.mode — Specifies whether the theme reloads each time the page is
refreshed. The default is to load the theme once at application startup.
Value:required; installed default=false

Note: Enabling this setting increases the load on the system. In a production environment, it is
recommended that this value be set to false.

site.portal.theme.from.server — Indicates whether the visual theme is accessed from the client or the
web server.
Value: required; installed default=false
If you use custom theming, the custom theme information is stored on the web server, rather than requiring
a custom Themes JAR on the client. Set this value to true to ensure that the custom theme information is
retrieved from the web server. If you do not use custom themes, set this value to false.
When set to true, the application uses images in <application folder><instance
name>\applications\wpk\themes
If you change this setting, you must restart the instance for the setting to take effect.

130
E-mail settings
E-mail settings enable you to establish parameters for all notification e-mails that the system generates.
You can enable batch delivery using the site.email.batchDelivery property. In cases where
multiple notifications to the same recipient result from a single function, batch delivery consolidates these
notifications into one e-mail. For example, if you import data or the system performs multiple pay code
edits, the batched e-mail includes multiple messages. When the system begins an e-mail, messages are
added to it until the notification server is triggered to send the e-mail. With the next message, another e-
mail is started.

Key and value details

site.email.enable — This indicates whether the notification is enabled or disabled in this instance. The
Simple Mail Transfer Protocol (SMTP) e-mail application program interface (API) is always available.
This setting refers to the notification engine only.
Value: required; installed default=true
site.email.availability.enable — This indicates whether to enable or disable e-mail when an employee
changes his or her availability pattern. Set to true to enable e-mail.
Value: required; installed default=true
site.email.primary_server — Set to true to indicate that this instance is the primary notification server.
This instance keeps track of all notifications and generates the appropriate e-mail when a notification
condition is initiated. Any instance can create notifications, but only the notification instance can process
them.
In a single-server environment, the notification server is the local host. In a multi-instance environment,
one instance is designated as the primary notification server. Only one primary instance exists in a multi-
instance environment.
Value: required; installed default=true
site.email.smtp_url — The URL of the SMTP mail server.
Value: installed default=mail1.<company>.com
site.email.batchDelivery — Set to true to specify batch delivery: all messages in the queue to the same
recipient will be grouped, and sent out as one e-mail.
Value: required; installed default=true
site.email.msg_queue_sleep_time — The time interval when the message delivery engine is idle if the
queue contains no messages. The maximum is 60 minutes.
Value: minimum=1; maximum=60; installed default=60
site.email.smtp_server_timeout — The time, in seconds, that the message delivery engine should wait
for the SMTP server connection before timing out.
Value: minimum=1; installed default=120
site.email.sender — The Sender field for e-mail. The e-mail must appear in the format
[email protected], even if it is not a valid address.
Value: installed [email protected]

131
 site.email.max_attempts — Maximum number of attempts for the system to send a message via e-mail.
Value: installed default=3
site.email.msg_queue_time_between_purges — The interval between the message queue purges. The
format is dd:hh:mm.
Value: installed default=00:00:60
site.email.language.charset — The character set used in encoding the subject and message body.
Value: required; installed default=site.charset.htmlxml.codepageid

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.

site.email.includeStartupInfoLog — Set to true to attach the StartupInfo.log to the instance booted

notification.
Value: required; installed default=true
site.email.includeStartupErrorLog — Set to true to attach the StartupError.log to the instance booted
notification.
Value: required; installed default=true
site.email.license.percent — The number of licenses left available before a notification is sent to a
specified e-mail address, warning that the number of available licenses is getting low. The 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. The
notification is sent to the e-mail address that was specified during the notification configuration process.
Value: installed default=90
site.email.addresses.delimiter — The character that separates e-mail addresses when multiple e-mail
addresses are used.
Value: maximum=1; installed default=;
site.email.SMTP.port — SMTP Port
Default = 25
site.email.secureSMTP — if set to true, Enable the Secure SMTP feature
Default = false
site.email.authSMTP — if set to true, Enable the SMTP Authentication.
Default = false
site.email.SMTP.username — SMTP Authentication Username
site.email.SMTP.password — SMTP Authentication Password
site.email.language.delimiter.subject — One or more characters that separate Subject translations in a
localized e-mail message
Default = |
site.email.language.delimiter.body — Optional text line that separates translated sections of a localized
e-mail message

132
site.email.chunkSize — Set to zero; the number of e-mail records that can be processed at one time. Zero
indicates no limit.
Value: installed default=0
site.email.genericNotificationLog.tableCleanup.interval — The polling interval that they system uses
for clearing the Generic Notification log database table.
Value: installed default=24 (in hours)
site.email.genericNotificationLog.tableCleanup.timestamp — The interval in days between cleanups of
Generic Notification log information in the database.
Value: installed default=60 (days)

133
Engine Controller
The Engine Controller system settings contain information about times during which you do not want to
allow users to run the Auto-Scheduler or Forecaster. These settings apply to the server on which they are
set.

Key and value details

site.EngineController.numberOfCPU — The logical number of CPUs to allocate to interactive engine
processing.
Value: required; installed default=1
site.EngineController.maximumUtilizationPercentage — For each logical CPU, the logical percentage
of the system to allocate to interactive schedule or forecast generation.
Value: required; installed default=100
site.EngineController.blackOutPeriods.MONDAY,...,SUNDAY — For this CPU, you can specify one
or more times of day for each day of the week when users cannot run the
engine.site.EngineController.useLowPriorityThread — The default setting of false is optimal.
site.EngineController.useLowPriorityThread — Use a lower priority thread for running the interactive
engine processing.
Default = false

134
Event Manager
The Event Manager settings are used to establish the general parameters for handling events. A system
event is task automated and scheduled to run at a predetermined time or periodically. Examples of events
are importing data or generating a report.
The configuration of the Event Manager settings includes identifying:
l The application server logon user name and password necessary for running events
l The list size that can be returned by an Event Manager user search

l Whether Event Manager adjusts for Daylight Saving Time

site.eventmanager.enabled — Indicates whether this instance is the Event Manager scheduler server. If
this value is true, this instance is responsible for reading events from the database. Only one instance per
installation can be marked true. This key is not used on UNIX/Linux servers.
Value: required; platform=Windows; installed default=true
site.eventmanager.hostname — Specifies the name of the Event Manager host machine. This key is not
used on UNIX/Linux servers.
Value: platform=Windows; installed default=localhost
site.eventmanager.startup — If this value is true, when the instance is started, the Event Manager enters
a startup process that synchronizes the database and scheduled jobs. If this value is false, the
synchronization is not done. This key is not used on UNIX/Linux servers.
Value: required; platform=Windows; installed default=true
site.eventmanager.recovery — If scheduled events are out of sync with the database, set this property to
true. Then, when the instance is started, the Event Manager will enter a more aggressive startup process
that rewrites all of the jobs. This key is not used on UNIX/Linux servers.
Value: required; platform=Windows; installed default=false
site.eventmanager.maxUserListSize — Specifies the largest list that may be returned by an Event
Manager user search. This key is not used on UNIX/Linux servers.
Value: minimum=1; maximum=100; platform=Windows; installed default=100
site.eventmanager.business.daemon.EventManagerDSTAdjustment.Enabled—Specifies whether the
Event Manager Daylight Saving Time (DST) Adjustment Daemon is enabled.
Value: installed default=true

135
Forecasting
The Forecasting system settings contain information about the following:
l Import files for forecasting
l The forecast map
l Traffic patterns

Key and value details

site.forecasting.volumeimport.timegranularity — The granularity, in minutes, with which volume data is
imported:
l For quarter hour, enter 15
l For half hour, enter 30

l For hourly, enter 60

Value: required; installed default=15

site.forecasting.volumeimport.sourcedirectory — The location of the XML files that contain the volume
data to be imported from the Event Manager, Volume Import Event.
Value: required; installed default=c:\
site.forecasting.budgetimport.volume.sourcedirectory — The location of the XML files that contain the
volume budget to be imported from the Event Manager.
Value: required; installed default=c:\
site.forecasting.budgetimport.labor.sourcedirectory — The location of the XML files that contain the
labor budget to be imported from the Event Manager.
Value: required; installed default=c:\
site.forecasting.forecastmap.levelstoload — When a user clicks a plus sign (+) next to a node on the
forecast map, this setting determines how many sub-levels to load from the server. Values can be 1, 2, or
3.
Value: required; installed default=2
site.forecasting.trafficpattern.numyearstosearch — The number of years of point-of-sale (POS) history
that the system will search for traffic pattern data. The default of 1 is optimal.
Value: required; installed default=1
site.forecasting.trafficpattern.minacceptablescore — The minimum score that a historical day must
receive to be considered by the engine for a forecasted traffic pattern. The default of 85 is optimal.
Value: required; installed default=85
site.forecasting.laborforecaster.debug — If true, this is the path of the location in which the system will
put the labor forecaster debug output file.
Value: required; installed default=false

136
site.forecasting.laborforecaster.logdir — The location on the system of the labor forecaster debug log
file.
Value: required; installed default={WFC.externaldir}/applications/wfso/log/
site.forecasting.laborforecaster.customDriver.countContinuousIntervalsAcrossDayDivide
If true, when the labor period extends across the day divide and labor is driven by a custom driver, the
system calculates the labor using the custom driver volume from the previous day and the current day as
one day.
If false, when the labor period extends across the day divide and labor is driven by a custom driver, the
system treats the volume data as two separate days, as they fall, on the day before and the day after the
day divide.
Value: required; installed default=True
site forecasting.laborforecaster.enablesalesgoalhourcalculation — If true, the system calculates the
hours toward meeting the sales goal for a job.
Value: required; installed default=false
site.forecasting.volume.edit.restrictVolumeAdjustments — If true, the system does not allow edits for
the volume forecast that change a negative value to a positive value, or vice versa, or a rollup value that
contains both positive and negative values.
Value: required; installed default=false
site.forecasting.volumeforecaster.debug
If set to true, logs the volume forecaster debugging information.
Value: required; installed default=false
site.forecasting.volumeforecaster.logdir — The location of the volume forecaster debug log file.
Value: required; installed default={WFC.externaldir}/applications/wfso/log/
site.forecasting.volumeforecaster.inputdir — The location of the volume forecaster debug input file.
Value: required; installed default={WFC.externaldir}/applications/wfso/input/
site.forecasting.volumeforecaster.outputdir — The location of the volume forecaster debug output file.
Value: required; installed default={WFC.externaldir}/applications/wfso/output/
site.forecasting.scheduleplanner.show.hoursofoperation — Use this settings to show the hours of
operation on Schedule Planner.
Value: required; installed default=false
site.forecasting.totalconsolidation.waitInterval — The interval for the forecaster background processor
to wait before processing any POS import consolidation requests.
Value: required; installed default=0
site.forecasting.laboritem.maxNumberToSelect — Specifies the maximum number of labor items
selected.
Value: required; installed default=500
site.forecasting.labor.standard.batch.import.separator.character — The character that separates
information in batch imports.
Value: required; installed default=~

137
 site.forecasting.trafficpatternbatch.numberOfSitesPerBatch — Specifies the maximum number of
stores used to calculate traffic patterns per batch in batch processing. This is also known as the chunk
sized and can be tweaked for performance tuning.
Value: required; installed default=100
site.forecasting.trafficpatternbatch.weeksTo Calculate — Specifies the number of weeks ahead that
traffic patterns should be forecasted during traffic pattern batch calculations.
Value: required; installed default=1
site.forecasting.maximum.precision
Value: required; installed default=0.00001
site.forecasting.volumeforecaster.adaptivemodel.optimalModelSelection — Allows the volume engine
to select an optimal calculation model if the engine is using the adaptive forecast algorithm.
Value: required; installed default=true
site.forecasting.volumeforecaster.adaptivemodel.daily.numyearstosearch — The number of years of
POS history used to compute the daily volume forecast.
Value: required; installed default=2
site.forecasting.volume.business.engine.dailyadaptive.usetrafficpattern
If true, (default) apply the daily traffic pattern distribution to each category when calculating volume
forecasts in both forecasting and budgeting products using the Adaptive Forecasting model.
If false – If you use adaptive forecasting and have a complex forecast map structure with more than 150
forecast categories below the selected site and many special events, generation of the volume plan can be
slow. Select false to speed processing but with less-precise data. The Forecast Manager will not calculate
the traffic pattern for each category but instead will use an average.
site.forecasting.volume.business.engine.retrending.useeventvariable — Apply special event variable in
re-trending model.
Default: true
site.forecasting.retrending.alerttracing.debug
Default: false
site.forecasting.volumeforecaster.adaptivemodel.optimisationMethod — Select from HeuristicMethod
(default) or Optimal Method.

138
Global Values
The Global Values settings specify properties that remain constant for all instances in the system. Global
properties are maintained in the WtkGlobalSettings table in the database.

Caution: Do not modify any properties in these settings unless you want the change applied to all of the
instances in the system.

Properties with global scope across instances 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.

Key and value details

global.address.book.hyperfind.filtering.enabled — Enables filtering of Address Book contacts by
HyperFind.
Default = false
global.address.book.hyperfind.query.selection — Prefix for names of HyperFind queries that are used
for Address Book filtering.
Value=required; installed default = Addressbookhf_
global.address.book.hyperfind.visible — Enables displaying HyperFinds in the Address Book contact
list.
Default = true
global.AdjacentShifts.ScheduleMergeSetting — Combine adjacent scheduled shifts; pay overlapping
time based on the earlier or later shift.
Value=required; installed default=Disabled
global.AdjacentShifts.ScheduleMergeSetting.AllowAdjacentShifts —
When enabled, the adjacent shifts will appear in timecard. When disabled, the "ScheduleMergeSetting"
will be used.
Default = Disabled
global.AdjacentShifts.TotalNearbyShifts — When enabled, if two scheduled shifts are close to each
other but not adjacent, both shifts affect totals. Value=required; installed default=Enabled
global.analytics.authentication.interval — Time interval (in seconds) defining how frequently the user is
authenticated against the Application Server. Default = 60.
global.analytics.configured — Controls loading of Analytics tab; if true, display the top-level tab and
menu items, else hide them. Default = false.
global.analytics.core.dashboard — Enter URL parameters to load the standard or custom Analytics
dashboard on the Analytics Application Server.

139
 global.analytics.customerid — Enter customer identifier, as defined by the customer; must match the
"Tenant ID" value in the Analytics database.
global.analytics.databaseid — Enter database identifier, as defined by the customer; must match the
"Source ID" value in the Analytics database.
global.analytics.hc.dashboard — Enter URL parameters to load the standard or custom Analytics for
Healthcare dashboard on the Analytics Application Server.
global.analytics.hc.vip.url — Enter fully-qualified URL to access the Variance Improvement Planning
application from the browser
global.analytics.mfg.dashboard — Enter URL parameters to load the standard or custom Analytics for
Manufacturing dashboard on the Analytics Application Server.
global.analytics.retail.dashboard — Enter URL parameters to load the standard or custom Analytics for
Retail dashboard on the Analytics Application Server.
global.analytics.ssrs.reportsexist — Controls display of Analytics Reports. Default = false. If set to
"true," display the users may have access to the SSR Server from the client-side browser.
global.attendance.attendanceEditor.useEditAttendanceEventsFAPForMarkers — A switch to turn on
or off the validation against the Edit Attendance Events function access control point for deleting markers
in Attendance Editor.
Default = false.
Global.audit.INTEGRATION_AUDIT_SUCCESS.enabled — Controls whether audit integration
success messages appear in the Audit log. Default = false.
global.audit.XForwardLookup.enable — Enables auditing features to extract client IP from X-
Forwarded-For HTTP header.
Value: installed default=false
global.audit.XForwardLookup.ShowInternalProxies — Show internal proxies in auditing.
Value: installed default=true
global.AuthenticationType.default — Set the default value for assigning Authentication Types.
Value: installed default=Kronos
global.AutoScheduler.enforceMinimumHours — Specifies that the system enforces minimum hour
requirements.
Value: installed default=false
global.AutoScheduler.preventZeroCoverage — Enables the Prevent Zero Coverage property.
Value: installed default=false
global.BatchService.BatchRecordsTimeToLive — Specifies how many days batch service records stay
in the system before they are purged.
Value=required; installed default=7
global.currency.currencyAmount.apiUseDouble — Set to true if APIs treat currency amounts as
Double formatted in conjunction with the system currency locale.
Value: installed default=false

140
global.currency.exchangerate.numberofyearsinfuture — Specifies the number of years in the future
that currency exchange rates are populated in the database.
Value=required, installed default=2
global.currency.exchangerate.numberofyearsinpast — Specifies the number of years in the past that
currency exchange rates are held in the database.
Value=required, installed default=10
global.customFields.count — Specifies the maximum number of custom fields that a user can add to the
list of custom fields.
Value=required; minimum=10; maximum=30; installed default=10
global.database.timezoneid — The time zone ID of the database server. If the database server and
instance are located in a different time zone from the employees’ time zone, some features could be
reported or generated incorrectly, as early or late. For example:
l Absence reporting in the Timecard Editor and in Reports may be incorrect by the number of hours
equal to the difference between the time zone of the database server and the time zone of the
employee. For example, if the database server is in the Eastern time zone, and the employee is in the
Central time zone, then the employee might be considered absent an hour too early.
l Missed Out exceptions might be reported inappropriately as early or late.

l System-generated persistent events might be generated inappropriately as early or late.

If your database server and instance are located in different time zones from some or all of your
employees, set this property to the database server’s time zone. If time zones are not an issue, set the
property to the default value.
Value: required; installed default=DEFAULT
global.emphoto.enable — Enable employee photographs to appear in the user interface. Default = false.
global.ems.AuditReadEvents.enabled — Enables audit logging of Inbox message.
Value: required; installed default =false
global.forecasting.labor.renableSaveLaborStandardForecast— Enables saving raw labor standard
forecast when labor forecast is run.
Value: Required; installed default = false
global.forecasting.labor.standard.components.acp.enabled — Enables access control points for labor
standard components.
Value: required; installed default = false
global.forecasting.labor.standard.effectivedate.enable — Allows the user to enable or disable the Labor
Standard Effective Date.
Value: required; installed default= false
global.forecasting.laborforecaster.laborstandardpurgebatchsize— The batch size of the purged labor
standards.
Default: 100
global.forecasting.laborforecaster.laborstandardpurgedays— The number of days before the current
date to purge the system of labor standards.
Default: 365 days

141
 global.forecasting.starttime.businessday.offset— The time that the business day begins is this number of
minutes after midnight.
Default: 0 (0:00)
global.forecasting.labor.enableSaveLaborStandardForecast — Enables saving raw labor standard
forecast when labor forecast is run.
Value: required; installed default=false
global.forecasting.volume.enableZeroForecastOnNullHistory — Enables generation of zero volume
forecasts for categories with insufficient historical volume data.
Default = false
global.formentry.activityquery.enabled —Enables access to Activity queries in Activity web forms.
global.html.framework.tableNavigatorDefaultMaxPages — Defines the number of sections that each
table navigation element will display at once.
Value: required; installed default=10
global.html.framework.tableNavigatorDefaultPagesize — Defines the number of rows that will display
per table selection.
Value: required; installed default=25
global.integration.absence.paycode— Set the global absence pay code for integration (requires
Workforce Central 8.0.4 or higher).
global.integration.camel.routecontext.click— Set to true to enable the Camel route context. You must
restart the application server for this change to take effect (requires Workforce Central 8.0.4 or higher).
Value: required; installed default = false
global.integration.camelservice— Enables or disables Camel Integration service. Default = false. If you
change this setting, the Workforce Central server must be restarted for the change to take effect (requires
Workforce Central 8.0.4 or higher).
global.integration.camelservice.servers— If the Camel Integration service is enabled, indicate the server
names with which the Camel Service should interact. Use the following format: server1,server2,server3
(Requires Workforce Central 8.0.4 or higher.)
global.integration.click.endpoint— Enter the the URL of the target service (requires Workforce Central
8.0.4 or higher).
global.integration.click.endpoint.password— Enter the authentication password for a specific endpoint
(requires Workforce Central 8.0.4 or higher).
global.integration.click.endpoint.username — Enter the authentication username for a specific endpoint
(requires Workforce Central 8.0.4 or higher).
global.integration.click.idm.auth.password— Sets the IDM authentication password for Click. (requires
Workforce Central 8.0.4 or higher).
global.integration.click.idm.auth.username— Sets the IDM authentication username for Click (requires
Workforce Central 8.0.4 or higher).

142
global.integration.click.idm.endpoint— Sets the IDM authentication endpoint for Click (requires
Workforce Central 8.0.4 or higher).
global.integration.click.idm.user.dummy.password— Sets the IDM user dummy password for Click.
global.integration.email.address — Set the email address for error message notification, use "," symbol
to separate multiple addresses (requires Workforce Central 8.0.4 or higher).
global.integration.errorhandling.recoverTimeIntervalInMinutes— Enter the time interval for each
recover operation for error handling. Minimum time is one minute (requires Workforce Central 8.0.4 or
higher).
global.integration.errorhandling.retryDurationInMinutes— Enter the maximum duration time in
minutes of retry attempts for error handling. Minimum time is five minutes (requires Workforce Central
8.0.4 or higher).
global.integration.errorhandling.retrytimes— Enter the number of times for the system to try to
reconnect to the network. Minimum value is one time.
global.integration.errorhandling.timeinterval— Enter the time interval between each attempt to
reconnect. Minimum value is 30 seconds (requires Workforce Central 8.0.4 or higher).
global.integration.eventmanager.numberOfEmployeesPerBatch— Sets chunk size for employee and
schedule batch export (requires Workforce Central 8.0.4 or higher).
global.integration.eventmanager.numberOfEmployeesPerBatch— Enter the number of employee
entries that the system should include in each Employee Batch Export (requires Workforce Central 8.0.4 or
higher).
Default = 100.
global.integration.numberOfRequestBatch— Sets the batch chunk size limit for an integration request
(requires Workforce Central 8.0.4 or higher).
global.integration.partner.hyperfind— Enter the partner HyperFind query for integration (requires
Workforce Central 8.0.4 or higher).
global.integration.person.synchronization.customField— Enter the customField exactly as it appears in
the Custom Field Label (requires Workforce Central 8.0.4 or higher).
global.kiosk.login.password — Password for logging in the URL Dispatcher Service that is used by a
kiosk
global.kiosk.login.username — User name for logging in the URL Dispatcher Service that is used by a
kiosk
global.KnowledgePass.auto.URL — Enter the URL to automatically log users in to KnowledgePass. If
this is blank, automatic login is disabled. The URL must begin with https://
global.KnowledgePass.CountryCode — Enter the country code to use when automatically logging in to
KnowledgePass.
global.KnowledgePass.manual.URL — Enter the URL to send user to the KnowledgePass widget if
automatic login is disabled.
global.KnowledgePass.SolutionId — KnowledgePass solution ID.

143
 global.knx.engine.EnableGDAPForLookupTables — Controls the access of lookup tables based on the
GDAP assigned to individual users. If this property is set to false, the GDAPs associated with the lookup
tables is not considered for access checking.
Default = false
global.knx.engine.InterfaceRunSummaryReportsInHTML — If you change the setting from the default
of False to True, interfaces that run will now produce a second copy of the log files that can be viewed
outside of Workforce Central.
Create Interface Run Summary Reports in HTML. By default this flag is false. If this property is set true,
system will create Run Summary logs in HTML format also.
global.knx.engine.RunHistoryLogsFolderFullPath — Fully qualified directory path (Application
server/Network drive) where KNX Run History logs will be generated. Proper directory access
permissions must be granted.
global.knx.engine.UseBatchProcessingFramework — Batch Processing for all Data Integration
Interfaces (Default is false).
global.knx.purge.RunHistory.Logs.MaxRunHistoryPurgePerEvent — Specifies the maximum Run
History logs that will be deleted through event Purge Data Integration Run History Logs
Default = 1000
global.labelicon.displaySetting— Display options for labels and icons (requires Workforce Central 8.0.4
or higher)
global.logon.token.expiration.time.employee — Logon token expiration time (in hours) for employee
(requires Workforce Central 8.0.3 or higher).
global.logon.token.expiration.time.manager — Logon token expiration time (in hours) for manager
(requires Workforce Central 8.0.3 or higher).
global.LongList.LaborAccountThreshold — The maximum number of valid labor accounts that can be
displayed in the Labor Level Set Editor.
Default = 100
global.LongList.LLMaintLongListThreshold — The long list warning limit for labor level entry
maintenance.
Value: required; minimum=1; installed default=100
global.LongList.ManagerSummaryEmployeeThreshold — Maximum number of employees that can be
displayed in a Detail page.
Value: required; minimum=1; installed default=1000
global.LongList.ScheduleSummaryEmployeeThreshold — Maximum number of employees that can be
displayed in a Scheduling page.
Value: required; minimum=1; installed default=200; recommended value range=1-1,000
global.LongList.TransferListThreshold — The maximum number of authorized accounts shown in the
employee’s transfer drop-down list.
Default = 10

144
global.m8m.login.password — The password for logging in the URL Dispatcher Service that is used by
4500 devices.
Value: required
global.m8m.login.username — The user name for logging in the URL Dispatcher Service used by 4500
devices.
Value: required; installed default=4500User
global.navigator.default.assignment.enabled — Controls the automatic assignment of navigator templates
to users who do not have a navigator assigned via their Display Profile. If set to true, navigator templates
are automatically assigned to users based on their license assignments. If set to false, navigators are not
assigned automatically.
Default = true
global.navigator.enabled — Navigator must be set to true to be enabled. The server must be restarted for
this change to take effect.
Default = true
global.notification.cache.UseJMS — Enable use of JMS for SYSNOTIFYTYPE CACHE. JMS is the
default delivery behavior starting with v7.0. Use false to revert to pre 7.0 delivery via database.
Default = true
global.notification.message.delivery — Enable notification message delivery
Default = true
global.notification.message.expiration — The number of days until a notification expires and is removed
if the recipient of the notification does not retrieve the notification and act on it in some other way.
Default = 30
global.notification.touchid_notification_update.UseJMS — Enable use of JMS for SYSNOTIFYTYPE
TOUCHID_NOTIFICATION_UPDATE. JMS is the default delivery behavior starting with v7.0. Use
false to revert to pre v7.0 delivery via database.
Default = true
global.notification.wba.UseJMS — Enable use of JMS for SYSNOTIFYTYPE WBA. JMS is the default
delivery behavior starting with v7.0. Use false to revert to pre v7.0 delivery via database.
Default = false

Note: The three settings (global.notification.*.UseJMS) determine how internal notification

events are transported: by the JMS mechanism or by the legacy database mechanism. Contact Kronos
before modifying these settings. If you change these settings, you must restart the instance for the change
to take effect.

global.NumberToString.RoundingMode — Controls how decimal POS import amounts are rounded.

HALF_EVEN rounds to the nearest even whole number (for example: 2.5 rounds to 2, 3.5 rounds to 4),
HALF_UP rounds up to the nearest whole number, HALF_DOWN rounds down to the nearest whole
number.
global.OvertimeEqualization.enabled — Set to true to enable overtime equalization. When this is set to
true, the Overtime menu appears on Time and Attendance Tab menus.
Value: required; installed default=false

145
 Note: If you change this setting, you must restart the instance for the change to take effect.

global.peopleEditor.allowAddBadgeNumbrBeforeCurrentDate — If set to true, the user can add a

badge number before the current date.
value: installed default=false
global.ProductivityMonitor.excludeTodayFromWeekToDateTotals — Excludes the current day from
weekly totals.
Value=required; installed default=false.
global.reporting.accruer.lookbackdays — Specifies the number of days in the past that Accruals reports
look for a starting balance transaction.
global.Reporting.Engine — Specifies the reporting engine used to generate reports.
Value: required; installed default=SQL Server Reporting Services 2008
global.reporting.prefetchwdmjobs — Include WDM data when prefetching report options.
Value=required; installed default=false
global.reporting.totalizer.threshold — If the number of untotalized employees is less than this setting,
the individual employee names are sent to the report for display. If the number of untotalized employees is
greater than or equal to this setting, just the total number of employees is sent to the report. For more
settings that could affect reports, see Reports on page 187.
Value: required; installed default=100
global.reporting.totalizer.threshold.megaproblem — If the number of untotalized employees exceeds
this threshold, the Totalizer does not retry and the value of this property is sent to the report as the
untotalized employee count. For more settings that could affect reports, see Reports on page 187.
Value: required; installed default=10000
global.RequestReviewers.NonValidReviewerNotification.EventInstID — The Generic Notification to
send when a non-valid reviewer is encountered.
Value: not required; installed default=None
global.scheduling.scheduleEditors.RangeOfDates.duration.limit — The number of days that a user can
select for the range of dates in the Schedule Editor or the Schedule Planner.
Default is 0 (no limit).
global.security.allowedRedirectDomains — Restricts redirects for logon to a valid list of domains to
which the redirection is allowed. Valid settings are “default” or a comma-separated list, which can include
wildcards. Examples: myhost.example.com, *.example.com
Value: required; installed default=default.
global.security.authentication.question.MaxNumberOfCharactersInA
SecurityResponse — Specifies the maximum number of characters that a user can enter in their response
to a security question.
Value: installed default=64
global.security.authentication.question.MaxNumberOfFalseResponsesToA
SecurityQuestion — Specify the number of times users can submit a false response to a security question
before their account is locked and they must contact the system administrator.

146
Note: This setting works only if the Lockout option in Access Profiles is enabled.
Value: installed default=3
global.security.authentication.question.MinNumberOfCharactersInA
SecurityResponse — Specify the minimum number of characters that a user must enter for a response to a
security question.
Value: installed default=6
global.security.authentication.question.NumberOfQuestionsToAsk — Specify the number of security
questions users must answer before they can reset their password.
Value: installed default=1
global.security.authentication.question.NumberOfSecurityQuestionsPerUser — Specify the number
of security questions that users can select and answer during setup.
Value: installed default=3
global.security.authentication.question.RequireSecurityQuestions — When set to true, users are
required to select security questions, which they can use if they forget their password or, optionally, when
they change their password.
Value: installed default=false
global.security.authentication.SetUpQuestionsAtChangePassword — When set to true, users must
change their security questions when they change their password.
Value: installed default=false.
global.security.authentication.question.SetUpQuestionsAtNextLogon — When set to true, users are
prompted to select security questions at their next logon.
Value: installed default=false.

Note: This setting was removed in Workforce Central 8.0.8.

global.security.disable.login.autocomplete — Disable/Enable auto complete feature for logging in to the

system. By default, this property is set true, which disables the password auto-complete. Users must enter
their complete credentials when logging on to the system.

Important: Even when this property is set to disable auto-complete, most popular browsers now have the
capability to override this setting. So you should check your browser settings and make sure you also set
up your browser password manager to disable auto-complete.

If you change this setting to false, auto complete is enabled and the system displays the message “Do you
want the browser to remember this password?” when the user logs on.
Default = true
global.security.termination.date.meaning — Starting with Workforce Central 8.0.11, this setting controls
when a terminated employee’s schedule is deactivated (deleted). Two options are available:
l The last full day an employee works for the company — Shifts will be deleted starting from the next
day after the termination day (default).

147
 l The first full day an employee no longer works for the company — Shifts will be deleted starting from
the termination day.

Note: This setting was introduced in Workforce Central 8.0.11 and replaces the
global.security.termination.effectiveatmidnight setting.

global.ServerInfo.Heartbeat.Interval — The heartbeat interval (in seconds) for each instance to notify
the database that the instance is active.
Value: required; minimum=1; maximum=86400; installed default=120
global.site.audit.System.Settings.Audit.Types.toExclude - Audit Types to exclude in MBean Operations.
The values of the types are in AuditItem table.
Default: Login
global.site.audit.System.Settings.enabled - Select 'true' to enable the auditing of changes made to the
system setting values.
Default: true
global.site.Message.Center.XMPP.enabled - Select 'true' to enable the alert and notification messages to
send to Message Center
Default: false
global.site.scheduling.ScheduleThroughDate— Specifies how many days in advance the schedule is
rolled-out when Schedule Through Date event is executed (requires Workforce Central 8.0.11 or higher)
global.Socket.Connection.Timeout — Sets the timeout value for Socket connections. Default = 3600
global.taskmanagement.assignemployees.ShowAllScheduled — Allows store managers to view all
scheduled employees, instead of getting filtered employees per engine suggested spans.
Default: false
global.TaskManagement.autoTaskAllocation.enabled
Default = true
global.taskmanagement.labor.categorizeHoursByReportingDriver — The labor forecast engine
categorizes hours based as on reporting driver.
Default: false
global.Timecard.AlwaysValidateTransferField.enabled — The flag indicates whether or not to validate
transfer values that have not been modified when other changes have been made.
Default:false.
global.TimeCard.ToolTipDetailsAllowed — If set to true, tool tips appear in the timecard when you
cursor over a cell or feature. If set to false, tool tips do not appear.
Value: not required; installed default=false
global.timekeeping.api.managers.access.payperiod.transferredemployee.check — Allows taking and
losing managers to access transferred employees within the transition pay period.
l If you select 0, the transferred employee feature is disabled.
l If you select 1, the transferred employee feature is enabled.

148
 l If you select 2, more than two managers can access transferred employees within the transition pay
period.
Default: 0
global.timekeeping.payrolllockwrapper.archivepolicydays —Sets the number of days to archive.
Default: 1095days
global.timekeeping.payrolllockwrapper.payrollrequireddays — Sets the number of days for payroll to
be locked before archiving.
Default: 180 days
global.toke.enable — When set to true, Toke BGP processing is enabled. Users must have a Tokes
license to enable this processing.
Value: installed default=false
global.totalization.accrualValidationForCascadedEnabled
global.TotalizeOnTimecardSave.enabled — When set to True, forces the Callable Totalizer to be called
when a Timecard is saved.
Value: installed default=false
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.warn.prior.to.expiration — Enable or disable the password expiration warning.
Value: not required; Default: false
global.warn.prior.to.expiration.day — Number of days until the password expiration warning is
displayed.
Value: not required; Default: 0
global.wat.includeHistoricalCorrectionsInWatProcessing — Adjust Start Day for Attendance
processing to include historical corrections when applying rules (requires Workforce Central 8.0.10 or
higher)
global.watDocforward.DWE_WORKFLOWS_UNIQUE_KEY — Unique key of the Process Manager
workflow used to automatically forward documents when an attendance action occurs.
Value: required; installed default=0
global.wba.login.password — The Process Manager password, WBAUser. Note that this setting does not
change the password. You can change the password by logging into the system as WBAUser and then
using the Change Password function.The value for this setting must match the new password.
global.wdm.actionhistory.hours — Limits the number of actions (per device) that are available for
processing.
Value: required; installed default=72
global.wdm.dataCollection.allow.transactions.after.timecard.approval — Allows processing
transactions to the timecard after the timecard has been approved.
Default = true
global.wdm.dataCollection.enabled — Enable Data Collection for the devices across the system.
Value: required; installed default=true

149
 global.wdm.device.OnDemandTimeSync.enabled — Enable Time Synchronization for the devices
across the system on demand basis.
Default = false
global.wdm.downloadretention.days —Number of days worth of download data to retain when purging
Default = 3
global.wdm.instance.management.enabled — Enable ability to limit installation of Device Manager to
specific instances.
Value: required; installed default=false
global.wdm.punchsync.hours — Number of hours to synchronize punches for multi-clock schedule
enforcement.
Recommended value: 24
global.wdm.recordretention.days — The number of days in the past that Device Manager data is
preserved in the database. The minimum value is one. There is no maximum limit. Data is purged from the
WDMDEVFILES, WDMDEVTRXDATA, WDMDEVACTIONS, WDMDEVPACKAGE, and
WDMDEVPKGDEVFILEMM tables.
Value: required; installed default=15
global.wdm.transaction.status.pendingtimeout.minutes — Sets the timeout (in minutes) for a transaction
to be in a pending state before it can be resubmitted. Recommended value(s) : 120
Default = 120
global.webserver.session.timeout — Sets the session timeout, in seconds. This should be greater than
site.webserver.session.timeout.graceperiod.minutes
Default = 1800
global.wfa.knx.EnableIntegration — Activity requires integration with external systems using Integration
Manager.System must be restarted for this change to take effect.
Default: false
global.wfa.knx.InterfaceName — Name of the interface to be executed for integration with external
system.
global.wfl.CommitTaking sDayByDay — Commit takings day by day (versus committing as one block of
time based on the dates on which takings are being committed. When this is set to false and a failure
occurs, takings are not committed for any of the days in the date range being committed. When set to true
and an accrual validation error occurs, takings are committed but stop on the day of the failure and
subsequent days will not be committed. This setting is especially helpful for customers whose employees
will receive additional accrual grants during the date range, but those grants are not yet reflected in the
accrual balance on the first day of the range.
Value: required; installed default=false
global.wflReminder.DWE_WORKFLOWS_UNIQUE_KEY — The unique key that is used by a Leave
document forwarding to interface with the workflow template.
Value: required; installed default=0
global.wivr.batch.retry.delay.mins — The number of minutes to wait before retrying a failed TeleTime
IP upload batch job.
Default: 5

150
global.wivr.crewclock.enable
Default: false
global.wivr.upload.retention.days — The number of days that TeleTime IP upload files will be retained.
Default: 30
global.wivr.useridtype — Specifies the type of id a person will use to login to the TeleTime IP system
global.WorkedAccoutRollupGenie.MaximumNumberOfPersonCanBeRolledUp — The maximum
number of persons that can be rolled up in worked account roll-up Genie.
Value: required; installed default=15000
global.wtk.biometric.data.deletion.upon.termination.enabled — Determines if employee biometric data
is deleted when the employee is terminated. If set to true, the biometric data is deleted. If set to false, the
biometric data is not deleted (requires 8.0.18 or higher). However, to delete previous biometric data, users
should schedule a Biometric Purge Event through the Event Manager.
Installed default=false
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.availability.defaultAvailType — The default availability for all the employees in
the organization when the scheduling product is installed. Choices are unavailable, unknown, or available.
Value: required; installed default=unknown
global.WTKScheduler.CalculateOpenShifts.threshold — The coverage threshold percentage for non-
standard shifts used to calculate open shifts.
Value: required; installed default=75
global.WTKScheduler.CalculateOpenShifts.UseNonStandShifts — If true, non-standard shifts are used
to calculate open shifts.
Value: required; installed default=false
global.WTKScheduler.CalculateOpenShifts.UseShiftTemplates — If true, specifies that non-standard
shifts are used to calculate open shifts.
Value: installed default=false
global.WtkScheduler.enableAutoSchedulerLimitJobLengthByJob — Enable the limit job length by
jobs.
Default: false
global.WtkScheduler.ess.FilterOpenShiftbyShiftTemplateProfile.checkbox — Determines whether the
checkbox on the Open Shift Visibility Editor that filters open shifts according to an employee's Shift
Template Profile is selected or cleared.
global.WtkScheduler.ess.FilterOpenShiftbyShiftTemplateProfile.visible — Determines whether the
Filter Open Shift by Shift Employee Template Profile checkbox is visible in the Open Shift Visibility
Editor. When set to true, the Filter Open Shift by Shift Employee Template Profile checkbox is visible.

151
 global.WtkScheduler.hoursBelongTo — Scheduled hours belong to day. Day actually worked will split
hours across midnight day divide. This setting has no effect when hours are configured to use the totalizer
(default).
global.WtkScheduler.keepRestrictionForDeletingCertificate.flag — If true, the users will not be
allowed to delete certifications from the database.
Value: required; installed default=true
global.WtkScheduler.MaxDaysToMarkScheduleOutOfDate — Identifies for 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 3 months in the future, there is no need to inform the Background Processor, because 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. Because 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; recommended value=279
global.WtkScheduler.MaximumInListForHyperfind — The threshold of when to switch from putting
values in a SQL ‘in ( )’ list, to putting the values into an intermediate table and performing a join. A value
greater than 1,000 will result in database failures. Unless the Kronos Global Support requests you to
change the value of this key, do not change it.
Value: required; installed default=600
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 appears on the rule violations tab
indicating that it exceeded the display limit of x.
Value: required; minimum=1; maximum=100000; recommended value range=1-50
global.WtkScheduler.MinimumHoursInFutureToSwapShifts — Indicates the minimum time gap, in
hours, that must exist between now, such as when the relevant API is invoked, and the start time of a shift
that is the subject of a swap.
Value: required; installed default=72
global.WtkScheduler.notifyWarningRuleViolations — Indicates if the user should get a warning when
saving the schedule with warnings involved.
Value: required; installed default=False
global.WTKScheduler.OverrideAllShiftsForFullScheduledDayEdit — Select True to override all
shifts during a day only if Schedule Day is selected. If False, add all shifts that day to calculate the amount
for the pay code edit, but remove only the selected shift and replace it by one open shift. Whether True or

152
False, if shifts are selected, calculate the amount for the pay code edit amount only for the selected shift,
remove that shift and replace it by one open shift.
global.WTKScheduler.ScheduleGroups.api.DefaultEditLevel — Determines whether actions taken at
the Schedule Group level through an API will be treated as an edit to the group schedule or and edit to
employee’s schedules. When operating on a group (such as adding a shift to a day), the action can be either
at the group level (“At Group Level”) meaning the shift is a group shift or at the level of the individual
employees in the group (“At Employee Level”) meaning the shift is an ad-hoc shift.
Value: required; installed default = At Employee Level
global.WtkScheduler.ShiftBuilderGovernor.Active — Use to activate the Shift Builder Governor.
When the governor is on, Shift Builder populates shifts for only 30 days each time. When the governor is
off, the Shift Builder populates shifts for the number of days in the future defined by the setting,
global.WtkScheduler.MaximumDaysInFutureToCreateShifts.
Value: required; installed default=false
global.WtkScheduler.ShiftBuilderGovernor.Days — Use to limit the number of shifts that the periodic
shift builder will stamp out. Typically, the periodic Shift Builder runs once a week and stamps out shifts for
a week. If you need to change this value temporarily due to the system being shut down for a prolonged
length of time, or you want to lengthen the number of days in the future that the shifts should be stamped
out, this key value limits the building of shifts to prevent system memory issues. However, increasing this
value can cause system errors due to the system trying to build shifts for too large a time.
Value: required; minimum=0; installed default=30; recommended value=30
global.WtkScheduler.ShiftBuilderResultsTimeToLive — Used to purge the data from the
SHIFTBUILDERDTL table. The SHIFTBUILDERDTL table contains the business errors that were
generated from the Shift Builder runs and the number of days those errors can live in the database. Error
messages that are older than this number of days will be purged by the purge process.
Value: required; installed default = 7
global.WTKScheduler.ShiftCoverageCounting.RequireExactMatch — Indicates whether coverage
includes only those shifts that exactly match start and end times of the planned shifts.
If set to false, coverage also counts any combination of schedule shifts that provide coverage for the
complete planned shifts. If set to true, only matching shifts are included in the scheduled shifts.
Value: required; installed value = false
global.WtkScheduler.ShiftPattern.Update.PopulateSchedulePatternsForInactiveEmployees — Allow
Schedule Patterns for inactive employees. (Default is false)
global.WtkScheduler.ShiftPattern.Update.PreserveExistingShifts — After changing an effective date,
preserve existing shifts within the shift pattern.
Default = false
global.WtkScheduler.totalizer.service.evaluatedhours.enabled — Controls whether the BGP service
for calculating evaluated hours is enabled
Default: false
global.WtkScheduler.totalizer.service.evaluatedhours.historicaldays — The number of days in the past
to generate evaluated hours through the BGP service.
Default: 7 days

153
 global.WTKScheduler.TransferToPrimary.SaveAsRegular — Defines a shift that is transferred to an
employee's primary job as either a transfer or a regular shift.
Value: required; installed value=true
global.WtkSetup.MarkEmployeesToBeTotalizedChunkSize — Specifies the number of employees in a
query that are marked as out of date. To mark all employees out of date in one query, set this to zero (0).
When a pay rule, pay rule building block, accrual rule, accrual rule building block or wage profile is
modified, only employees assigned (directly or indirectly) to that rule are marked out of date. If a work rule
or work rule building block is modified, all active employees are marked out of date. In both cases, the
update is done in one large query, unless you specify a number.
Value: required; installed default = 0
global.WtkSetup.OrgSets.MaximumNumberOfOrgSetsVisible — The maximum number of items that
can be displayed in the Organizational Sets setup page.
Value: required; installed default = 1000
global.WtkTotalizer.AllowExpirationsToCrossZero — This global setting affects the behavior of grant
expirations. With the setting turned off, grant expirations will never cause balances to cross zero. With the
setting turned on, grant expirations can cause balances to cross zero.
Value: required; installed default = false
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:
0 = Do not apply scheduled transfers to Worked Amounts in Project View.
1 = Apply scheduled transfers to Worked Amounts in Project View.
global.WtkTotalizer.ApproveAllUnapprovedOvertimeInRetroEditor —Automatically approve
unapproved overtime during Add Historical.
Value: required; installed default=true
global.WtkTotalizer.BalanceLimitsPostAtBeginningOfNextDay — Indicates that the limit transactions
are processed at the beginning of the next day instead of at the end of the limiting day.
Value: installed default=false

Note: Changing this setting to No does not mark employees out of date. As a result, the Accruals
displayed in reports and the Accruals displayed in Timecards will not match until the employees are
retotalized. (This happens if an event occurs, such as a punch, or the employees are signed off, or
enough time elapses that the BGP automatically retotalizes.)

global.WtkTotalizer.BreakExceptionLimits — Default=True: Exceptions are generated on the specified

minute.
global.WtkTotalizer.cascadingTotalizer.optimize-enabled — In the Cascading Totalizer, controls
whether to enable optimization I.
Default: true

154
global.WtkTotalizer.cascadingTotalizer.optimize-II-enabled — In the Cascading Totalizer, controls
whether to enable optimization II.
Default: true
global.WtkTotalizer.CoreHoursApplyOnlyWithinScheduledShifts — Core hours apply only within
scheduled shifts.
Value: installed default=false
global.WtkTotalizer.DeductOverlappingOnCallOnly — Indicates whether the worked time is deducted
from the on-call pay. Set to 0 to indicate that the entire callback shift is deducted from on-call pay, or set
to 1 to indicate that only the portion that overlaps the on-call shift should be deducted.
Value: installed default=false
global.WtkTotalizer.EndAccrualCalendarMonthOnFirst — Controls when a calendar month accrual
expiration ends. If No, it ends on the last day of the month. If yes, it ends on the first day of the next month.
Default = No
global.WtkTotalizer.Extensibility Enabled — Enables the use of extensible features.
Value: default=True.
global.WtkTotalizer.holiday-work-history-qualifier.future-standin-value — In the Holiday Credit
Work History qualifier, this setting controls how far into the future to look for past work history. Use this
value (true/false) for holiday work credit qualification when number of days has been exceeded.
Default: true
global.WtkTotalizer.holiday-work-history-qualifier.optimize-enabled — In the Holiday Credit Work
History qualifier, this setting controsl how far into the future to look for past work history. Enable this
function to optimize totalization.
Default: true
global.WtkTotalizer.holiday-work-history-qualifier.use-future-standin-value-after-num-days — In
the Holiday Credit Work History qualifier, this setting controls how far into the future to look for past work
history. For days past this number of days, use the stand-in value instead.
Default: 15
global.WtkTotalizer.IncludeCurrentShiftInProjected - Indicates that the system should include the
current shift, with no In or Out punches in the past as part of the projected totals calculation. A current
shift is a shift with a start time in the past and end time in the future.
global.WtkTotalizer.IncludeUnapprovedOvertimeInCarryforward - Include unapproved overtime in
overflow contributing hours and store them in carryforward. Default = true.
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, set this key high enough to accommodate the desired window.
Value: required; minimum=0; installed default=365
global.WtkTotalizer.MaxDaysInFutureForAccrualProjections — The maximum number of days into
the future that accruals will be totaled. The Accruer will not compute beyond this value. It is possible that
grant expiration transactions and user edits, such as resets, updates, and transfers, may appear in an

155
 employee’s accrual detail report for some date or dates beyond the end of the maximum date specified.
Value: installed default=365; maximum=731
global.WtkTotalizer.MaxLatencyForApproverNotification — This value determines the number of
seconds between an approval and totalization during which changes to totals do not trigger a notification
for the approver.
Default = 0
global.WtkTotalizer.MinDaysInFutureForAccrualProjections — The minimum number of days into
the future that accruals will be totaled. The Accruer will always compute at least to this value.
Value: required; 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 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. 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 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 Totalizer can view without retotaling the schedule for an employee who has no schedule changes.
Value: required; minimum=1; maximum=60; installed default=7
global.WtkTotalizer.NumberDaysAddedToInMemoryScheduleTotalizationRequest — The number of
days added to the end date of all requests for in-memory schedule totalization.
Default: 40
global.WTKTotalizer.OptimizedLookbackForHolidayEligibility — Currently not used.
global.WtkTotalizer.PaidBreakMayApplyToPrecedingWorkSpan — If set to 1, paid breaks that are
followed by a work rule transfer can be paid as part of the preceding work span. If set to zero (0), they are
always paid as part of the following work span.
Value: installed default=false
global.WtkTotalizer.PaycodeMovesAreContributingShifts — Determines whether pay code moves
contribute to event calculations; specifies whether moving hours from one pay code to another affects the
shift history for events with Work History Qualifiers. Set to yes to have pay code moves contribute to event
calculations.
Value: required; installed default=false
global.WtkTotalizer.PayHolidayCreditsToScheduledDays — If set to 1, holiday credits are paid to the
date of a scheduled shift. If set to zero (0), holiday credits are paid to the holiday date.
Value: installed default=false

156
global.WtkTotalizer.ProcessScheduledPayCodeEditComments — Indicates whether comments entered
in Scheduled Pay Code Edits can be linked to timesheet items.
Value: installed default=false
global.WtkTotalizer.RoundPunchesToQualifyForZones — Indicates whether punches are rounded for
purpose of evaluating the “must start work” and “must end work” qualifiers of daily shift differential rules
and weekend differential zone rules.
Value: required; installed default=true
global.WtkTotalizer.ScheduledTransfersCanBeDelayed — Controls handling of scheduled transfers. If
set to 1, a scheduled transfer is delayed if the same transfer occurs explicitly at a later time within the
shift. If set to 0, a scheduled transfer is not delayed.
Value: required; installed default=true
global.WtkTotalizer.SequencerVersionBehavior — Controls the interaction between combining limit
rules, via LimitCombination rules, and the order in which worked time is processed, via Sequencer rules.
This interaction can affect how worked time is paid. The value indicates the version of the product whose
sequencing behavior is desired. In version 5.0.5 and beyond, you can chose to revert to the sequencing
behavior exhibited by version 4.3 or 5.0.
Value: installed default=5.0.5
global.WtkTotalizer.ShowGuarantees — Indicates whether guaranteed time appears as a separate
workspan in the timecard.
Value: required; installed default=false, guaranteed time is included in previous work span; value of 1
indicates guaranteed time appears as separate work span.
global.WtkTotalizer.TakingsCanAffectGrantsThatOccurAfter — Controls the effect of takings on
accrual grant expiration amounts. If No, a taking that occurs before a grant will not affect that grant's
expiration amount. If yes, it will affect the amount.
Value: installed default=yes
global.WtkTotalizer.UseMissedOutLimitForOnCallShifts — Use missed-out limit when working an on-
call shift. Do not assume employee continued to work after the end of on-call time.
Value: installed default=false
global.WtkTotalizer.UseRoundedTimeforInvalidNameDurationExceptions For Invalid Duration
exception, use rounded time of nearby punches when determining if there is overlap.
Value: installed default=true
global.xmlservice.crypt — The value that is used to generate an encrypted password. Kronos
recommends that you change the default value of this setting if you plan to deploy Process Manager
templates that contain web services tasks.
Value: required; installed default=3G273C3@3<213026
global.xmlservice.login.password — XML service password used by one server to communicate with
another server.
Value: required
global.xmlservice.login.username — XML service user name used by one server to communicate with
another server.
Value: required; installed default=XMLUSER

157
 Note: If you change either global.xmlservice.login.password or
global.xmlservice.login.username in the Global Values tab workspace, you must make the
same change in the properties file, WPKGlobalSetting.properties.

158
Group Edits
The Group Edits settings enable you to optimize the Group Edit Results component in the system.
The default value for the site.groupedit.primaryServer setting is automatically set to true
for all instances in your system. If you have a multi-instance environment, you must determine which
instance functions as the primary server and set this property to false for all other instances in your
system.

Note: A system error occurs if you do not configure your multi-instance environment properly.

Several editing threads run in the background on the primary instance. The Delete thread is activated
periodically and removes any editing threads beyond the specified time period. The Recover thread is
activated periodically to poll the editing threads. The Recover thread restarts any editing thread that has
stalled.
Because Group Edit data is maintained in the database, any instance can perform the delete and recovery
functions. The instance with the site.groupedit.primaryServer key set to true is the one
specified to run the Delete and Recover threads.

Key and value details

site.groupedit.enabled — Set to true for enabling Group Edit functionality.
Value: required; installed default=true
site.groupedit.primaryServer — Set to true to specify that this instance is the primary instance used to
run the persistent threads.
Value: required; installed default=true
site.groupedit.DaysCleanup — Number of days until items are deleted from group edit history.
Value: required; minimum=0; installed default=7
site.groupedit.deletethread.pollingInterval — Polling interval, in minutes, for the Delete thread. This
interval must be longer than the delete execution time.
Value: required; minimum=0; installed default=30
site.groupedit.recoverthread.pollingInterval — Polling interval, in minutes, for the Recover thread. This
interval must be longer than the recovery execution time.
Value: required; minimum=0; installed default=30
site.groupedit.RequestHandler.pollingInterval — Polling interval for RequestHandler to wait until a
thread is available from the Group thread pool (in seconds).
Value: required; minimum=0; installed default=5
site.groupedit.RequestHandler.numberOfGroupEditThreads — Number of Groupedit Threads used
for processing (in numbers).
Value: required; minimum=0; installed default=20

159
 site.groupedit.RequestHandler.ReusableHandlerController.pollingInterval — Polling interval, in
minutes, for ReusableHandlerController thread. 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
site.groupedit.employeeCountThreshold — Specifies the number of employees that will be accumulated
before the entries appear in the Groupedit log.
Value: required; minimum=0; installed default=500
site.groupedit.groupEditLogFailureCountThreshold — Defines the number of Group Edit log failures
that will be accumulated before the entries appear in the Group Edit log.
Value: required; minimum=0; installed default=500

Clearing Group Edit Results

You can specify how often the system should clear the Group Edit Results.
1. Select Setup > System Configuration > System Settings > Group Edits.
2. Set site.groupedit.DaysCleanup to a specific number of days. The default is 7 days.
3. Click Save.

160
JMS Configuration
Alerts and notifications in Workforce Central rely on the Java Messaging Service (JMS) to send and
receive messages. This service uses the JMS NIO SSL Port, which is different from the ports used by the
application server and web server.
The Workforce Central installation program assigns numbers to these ports as required by the JMS bus to
work properly. If you add instances to the machine, Configuration Manager also assigns the correct port
numbers.
l If all instances of Workforce Central on the same machine point to the same database, Configuration
Manager assigns the same port number to all the instances.
l If multiple instances of Workforce Central are configured on one machine and the instances use

different databases, each set of instances, using different databases, must use a unique JMS NIO SSL
port number. Configuration Manager automatically assigns unique port numbers.
If required, you can change the port number from the JMS Configuration tab in the System Settings for this
port assignment. (This port number must be unique and greater than 0 but less than 65535.)
To change the port number, modify the port number for one instance and then manually restart each
instance on that machine using the same database.
To change the port numbers for one or more instances on a machine that are connected to same database:
l If the machine contains one instance of Workforce Central, modify the port numbers, save the edits,
and restart the instance.
l If the machine contains multiple instances of Workforce Central, do the following:
a. Stop all instances on that machine except one.
b. Modify the port numbers for the running instance, save the edits, and then stop the instance.
c. Restart all the instances, on that machine, (in any order) to propagate the change to all the
instances.

Note: You only need to restart the instances that are connected to the same database. If the machine
also contains instances connected to other databases, these instances do not need to be restarted. You
also do not need to restart the instances on other machines that are connected to the database being
updated.

For example, consider the case where you have six instances: wfc, wfc1, wfc2, and wfc3 are on machine
A and wfc4 and wfc5 are on machine B:
l wfc, wfc1, wfc2, and wfc4 all point to the production database
l wfc3 and wfc5 point to the test database

Perhaps there is a port conflict on machine A. To change the port numbers for the production instances on
machine A:

161
 1. Stop wfc1 and wfc2.
2. Modify the port number for wfc, save the edits, and then stop wfc.
3. Restart wfc, wfc1, and wfc2 to propagate the change to all instances on machine A.
4. Because wfc3 points to a different database and wfc4 and wfc5 are on machine B, there is no need to
restart them (even though wfc4 points to the production database).

Key and value details

site.JMSConfiguration.jmshttpport — JMS HTTP Port
Default = 61616

Java Plug-in
The Java plug-in settings control the version of the Java Runtime Environment (JRE) to install on client
machines, and the name of the JRE installer. These settings only affect applets in the product.

Key and value details

site.java.plugin.location — The path of the client-side JRE plug-in; for
example, {WFC.context.external}/plugins
site.java.plugin.installer — The version of the Java plug-in installer. This value is the exact name of the
executable in the path of the client-side JRE plug-in.
Value: required
site.java.plugin.version.minimalVersion — The lowest supported version of a JRE plug-in patch.
Value: required
site.java.plugin.installer.mac — The version of the Apple Macintosh Java plug-in installer.
Value: required
site.java.plugin.version.minimalVersion.mac — The minimal supported version of the Apple Macintosh
Java plug-in up to patch level.
Value: required
site.java.plugin.CLSID.familyVersion — The minimal versions of the CLSID, based on the selected
family version, that supports applets in Internet Explorer.
Value: required to support Internet Explorer
site.java.plugin.type.familyVersion — The minimal family version of the CLSID, based on the selected
family version, that supports applets in Mozilla FireFox.
Value: required
site.java.plugin.version.installVersion — The version of the Java plug-in this is installed, for all
browsers supported by. If multiple versions are installed, the most recent version is used with the product.
Value: required
site.java.plugin.explicitCookie.active—Specifies whether the applets will explicitly set HTTP session
cookies.
Value: required

162
site.java.plugin.http.keepAlive—Specifies whether product applets will explicitly set HTTP connections
to be persistent.
Value: Default = True
site.java.plugin.applet.autodownload.enabled — When set to true, enables the automatic download and
installation of the Java Plug-in version located on the server. Note: It forces the download and installation
to the current browser if enabled.
Value: default=true

163
Leave
The Leave settings contain settings for the Leave application.

Key and value details

site.leavemanagement.MaxDaysToAddProjectedLeaveTime — Defines the maximum length of time in
the future that the system will project to when adding projected leave time.
Value: required; minimum=7; maximum=365 (recommended); installed default=365
site.leavemanagement.DocumentTemplateContentType — The file format and character set that are
used for leave document templates.
l HTML document templates — Set this value to: text/html; charset=windows-1252
l XML document templates— Set this value to: text/xml; charset=UTF-8

Value: required; installed default=text/xml

site.leave.DocumentContentDisposition — Controls the content disposition used for leave document
templates. For example, Attachment;filename=sample.xml or
Attachement;filename=sample.html that corresponds to the MIME type.
Value: required

164
Locale
The Locale settings determine how the date, times, and language appear. These settings are an expansion
of the basic regional settings on the web server.
Under typical circumstances, these settings do not change.

Note: You must restart the instance using the stop and start icons in order for new values of any
language or country keys to take effect.

Key and value details

site.local.useWFCSettings — Indicates whether to use the default settings or to use local settings.
Value: required, installed default=true
site.local.TIMEZONE — The time zone of the instance.
Value: required; installed default=(GMT -05:00) Eastern Time (USA; Canada)
site.local.DefaultWeekStartDay — The starting day of the scheduling week. This value defines the start
of the week for schedule patterns. These patterns include shift, availability, and pay code patterns. This
value has no impact on the layout of the Scheduler. You can independently define the starting day for
employee and organizational rules.
Value: required; installed default=Sunday
site.local.DateFormat — The display format for dates:
FULL — day, month DD,YYYY AD
LONG — month DD,YYYY
MEDIUM — abbreviated month DD,YYYY
SHORT — MM/DD/YY, completely numeric
Value: required; installed default=LONG
site.local.TimeFormat — The display format for times:
FULL — HH:MM:SS AM/PM Time zone
LONG — HH:MM:SS AM/PM
MEDIUM — HH:MM:SS AM/PM
SHORT — HH:MM AM/PM
Value: required; installed default=SHORT
site.local.timestamp.ServerDateFormat — The display format for the Time Stamp server date and time.
Value: required; installed default=EEEE, MMMM dd, yyyy
site.local.SHORT_DATE — The display format for the short date. A hyphen or period separator can
replace the slash separator.

165
 E M/dd — displays as Thurs 4/01 [default]
E MM/dd — displays as Thurs 04/01
EEEE MM/dd — displays as Thursday 04/01
E M/d — displays as Thurs 4/1
EEEE M/d — displays as Thursday 4/1
EEEE M/dd — displays as Thursday 4/01
E dd/MM — displays as Thurs 01/04
E dd/M — displays as Thurs 01/4
EEEE dd/MM — displays as Thursday 01/04
E d/M — displays as Thurs 1/4
E d/MM — displays as Thurs 1/04
EEEE d/M — displays as Thursday 1/4

Note: The order of the day and month must match that of the browser locale.

Value: required; installed default=E M/dd

site.local.LONG_DATE — The display format for the long date. The year must be four digits; for
example, M/dd/yyyy.
A hyphen or period separator can replace the slash separator, provided the same character is used
throughout the format.

Note: If you change the default language or country, and the long date format of the language or country
you specified is different from the system default, you must also change the Long Date valueto the long
date format of the specified language/country.

M/dd/yyyy — displays as 4/01/2001 (system default)

MM/dd/yyyy — displays as 04/01/2001
M/d/yyyy — displays as 4/1/2001
d/MM/yyyy — displays as 1/04/2001
dd/MM/yyyy — displays as 01/04/2001
d/M/yyyy — displays as 1/4/2001

Note: The order of the day and month must match that of the browser 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

166
site.local.LANGUAGE — The display language of the instance. Identifies the language based on the
standard two-letter language codes that the International Standards Organization (ISO) established in ISO
639-1. Text and messages in French, Spanish, and English are provided. For other languages, use the
Translation and Customization Toolkit CD. The language code is stored in the properties file, and the UI
displays the ISO 639-1 description of the language code.
Value: required; installed default=English

Note: If you change the default language, and the long date format of the language you specified is
different from the system default, you must also change the Long Date value (site.local.LONG_
DATE)to the long date format of the specified language.

site.local.COUNTRY — Identifies the country based on the standard two-letter country code established
by ISO 3166. Examples are MX for Mexico, CA for Canada, and US for the United States. The country
code is stored in the properties file, and the UI displays the ISO 3166 description of the country code.
Value: required; installed default=United States

Note: If you change the default country, and the long date format of the country you specified is different
from the system default, you must also change the Long Date value (site.local.LONG_DATE)to the long
date format of the specified country.

site.local.VARIANT — This setting is no longer used.

site.local.currency.LANGUAGE — The currency language on the instance. Identifies the language
based on the standard ISO 639-1 two-letter language codes associated with the currency that your site
uses; for example, a value of en identifies English as the language associated with the currency. The
language code is stored in the properties file, and the UI displays the ISO 639-1 description of the language
code.
Value: required; installed default=English
site.local.currency.COUNTRY — The display currency country code of the instance. Identifies the
country based on the standard two-letter country code established by ISO 3166 associated with the
currency; for example, a value of US identifies U.S. dollars. The country code is stored in the properties
file, and the UI displays the ISO 3166 description of the country code.
Value: required; installed default=United States

Note: You must specify the same value for this property on every instance associated with one database.

site.local.VARIANT — This setting is no longer used.

site.local.quickTimestamp.HourMode — Set to true to display the time mode in the Quick Time Stamp
running clock.
Value: required; installed default=12 Hour Mode (1 -12 AM/PM)
site.local.PhoneticFullNameField.enable — Adds a field named Phonetic Full Name in People Editor
that enables you to add a phonetic spelling to help employees pronounce unfamiliar names in multi-national

167
 environments. Phonetic Full Name is also available as a column heading to display the phonetic spellings in
summary pages.
Value: installed default=false
site.local.RomanizedFullNameField.enable — Adds a field in People Editor that enables you to add a
name using the Roman alphabet to help employees recognize unfamiliar names in multi-national
environments. Romanized Full Name is also available as a column heading to display spellings using the
Roman alphabet in summary pages.
Value: installed default=false
site.local.SuccessIndicator.timestamp.format — The date and time format for the success indicator.
Value: required; installed default=h:mm a

Note: It is recommended that time format match the time format of the locale determined by the
application country as specified in site.local.COUNTRY and the language specified in
site.local.LANGUAGE. If the formats differ, there might be unexpected results in the time display in the
headings of pages.

168
Log file
Log files contain all the log information recorded for an instance of. The log file messages record the
instance activities and contain the message priority.
You can specify whether to use a single log file or multiple log files, and a maximum log file size for your
instance.
If you specify 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 maximum number of log files is reached, the oldest log is deleted to
accommodate the new WFC.log.
Each entry in the log files contains:
l The event date and time
l The context in which the event occurred
l The event priority — numeric and alpha
l The user session that registered the event
l The logging levels are:

Severity Level Description

ERROR Reserved for serious errors. The logged event might compromise system stability or
data integrity.
This level produces the fewest number of records and is used for normal
operations.
WARNING An unexpected condition has occurred that probably is an error, but is not serious
enough to compromise system stability or data integrity.
When this level is requested, WARNING and ERROR events are recorded.
INFO Records normal events that you or the Kronos Global Support may need to see.
When this level is requested, INFO, WARNING, and ERROR events are
recorded.
DEBUG Provides information for the Kronos Global Support. Use this log level only when a
Kronos Global Support requests it because it produces a large number of records
and can affect system performance. Do not use this log level any longer than
necessary to find the needed information.
When this level is requested, DEBUG, INFO, WARNING, and ERROR events
are recorded.

Key and value details

site.log.active — Set to true to activate logging, or false to deactivate logging.
Value: required; installed default=true

169
 site.log.loglevel — Logging level for all contexts. Valid entries are ERROR, WARNING, INFO, or
DEBUG.
Value: required; installed default=ERROR
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 instance shuts down immediately. All user sessions are
terminated with no warning.

site.log.file.append — Specifies whether to overwrite or append to the existing file when initializing
logging:
true = appends to the existing file
false = overwrites the existing file
Value: required; installed default=true
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 root directory.
Value: required; installed default=WFC.log
site.log.file.rollover.maxsize — Maximum size of the log file before rollover occurs. You can use the
suffixes KB, MB, or GB.
Value: required; installed default=10MB
site.log.file.rollover.maxlogs — Maximum number of saved log files to keep. If the value is 0, the main
log file is overwritten when the rollover criteria are satisfied.
Value: required; minimum=0; installed default=10
site.log.format.multiline — Specifies how to write messages with embedded new lines to the log file.
flat = write multiline messages as one long line
normal = write multiline messages as separate lines
Value: required; installed default=normal
site.log.ucp.file.name — The name of the UCP log file.
Default: UCP.log
site.log.ucp.active — Set to true to activate UCP logging, false to turn off UCP logging.
Default: true
site.log.ucp.loglevel — The default logging level for the UCP. Select from SEVERE, WARNING, INFO,
CONFIG, FINE, FINER, FINEST.
Default: SEVERE
site.log.ucp.file.rollover.maxlogs — The maximum number of saved UCP log files to keep.
Default: 1

170
site.log.ucp.file.rollover.maxsize — The maximum size of the UCP log file before rollover occurs. (KB,
MB, or GB).
Default: 500KB
site.log.ucp.file.append — Set to false to overwrite the existing UCP log file when initializing logging.
Default: false
site.log.file.gathering.list — Add new log file names to the end of the comma-delimited list that is to be
collected when the Log File Gathering tool is run. Change this setting only if you have a non-default IIS
installation location or if you are directed to do so by a Kronos Global Support.
Value: required
site.log.file.gathering.remote.transfer.threads.max — Maximum number of remote transfer threads in
the system. Change this setting only upon the direction of a Kronos Global Support.
Value: required; minimum=1; installed default=5
site.log.file.gathering.requests.threads.max — Maximum number of gathering request threads in the
system. Change this setting only upon the direction of a Kronos Global Support.
Value: required; minimum=1; installed default=3
site.log.file.gathering.recursion — This value should be appended to the end of any log path to do a
recursive directory search.

171
Logging Context
The Logging Context settings provide a filtering mechanism used for logging error messages for specific
components.
The Logging Context settings contains properties for a selected number of applications and enable you to
set individual severity levels for them. The Logging Context settings are used for debugging purposes.

Caution: Do not change any parameters on this page without direction from a Kronos Global Support.
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.

Key and value details

site.loggingContext.WFC.APP.WDM — Logging context settings that are specific to Device Manager.
Value: required; installed default=ERROR
site.loggingContext.WFC.APP.WDM.DEVICELOG
Value: required; installed default=ERROR
site.loggingContext.WFC.APP.WDM.DEVICELOG.APP
Value: required; installed default=ERROR
site.loggingContext.WFC.APP.WDM.DEVICELOG.BIO
Value: required; installed default=ERROR
site.loggingContext.WFC.APP.DEVICE4500.COMMUNICATION — Device Manager specific
logging for device communications
Default = ERROR.
site.loggingContext.WFC.BUSINESS.TOTALIZER.REPORT— Totalizer specific logging context
value.
Default is ERROR.
site.loggingContext.WFC.BUSINESS.BGP — Logging context values for Background Processor.
Value: required; installed default=INFO
site.loggingContext.WFC.BUSINESS.BGP.TIMING — Background Processor totalizer timer.
Default =ERROR
site.loggingContext.WFC.BUSINESS.CALLABLETOTALIZER.REPORT — This Callable Totalizer
Report logging context system setting helps prevent performance issues related to logging activity. You can
change the setting to standard logging levels (INFO, WARNING, DEBUG), but if you do so, you must
restart Workforce Central.
Default is ERROR.

172
site.loggingContext.WFC.BUSINESS.CASCADE — Logging context values for cascading accruals.
Value: required; installed default=INFO
site.loggingContext.WFC.BUSINESS.DBDIFFERENCING
Value: required; installed default=INFO
site.loggingContext.WFC.BUSINESS.WIM— Logging context values that are specific to Integration
Manager.
Value: required; installed default=INFO
site.loggingContext.WFC.BUSINESS.WIM.SVC— Logging context values that are specific to the
Integration Manager Runtime Engine.
Value: required; installed default=INFO
site.loggingContext.WFC.APP.DBMANAGER — Logging context values that are specific to
DBManager.
Value: required; installed default=INFO
site.loggingContext.WFC.PERSISTENCE.SQLTRACING — SQL Tracing specific logging context
values.
Value: required; installed default=DEBUG
site.loggingContext.WFC.dynamic — Enabling logging context without restarting of the server. Specifies
the complete logging context (ex. "site.loggingContext.WFC.BUSINESS.CASCADE"). The log level is
DEBUG.
site.loggingContext.WFC.APP.IVR — Default is ERROR.
site.loggingContext.WFC.BUSINESS.IVR — Default is ERROR
site.loggingContext.WFC.PERSISTENCE.IVR — Default is ERROR
site.loggingContext.WFC.APP.IVR.INQUIRY — TeleTime IP inquiry specific logging context values,
default is ERROR
site.loggingContext.WFC.APP.IVR.WEBSERVICE — TeleTime IP web services specific logging
context values, default is ERROR.
site.loggingContext.WFC.BUSINESS.SECURITY.PRODUCTS — Notification listener. Default is
ERROR.
site.loggingContext.WFC.PERSISTENCE.CONNECTIONPOOL — Database connection pool.
Default is ERROR.
site.loggingContext.WFC.WFP.DAEMON.PING — State of daemon. Running, stalled, or stopped.
Default is ERROR.
site.loggingContext.WFC.WFP.NOTIFICATION — Event notifications. Default is ERROR.
site.loggingContext.WFC.WFP.SERVERINFO — Application server information including but not
limited to server name, IP address, communication option, report engine status, and language preference.
Default is ERROR.
site.loggingContext.WFC.WFP.SERVERINFO.CACHE — Cache holding ServerInfo objects for all of
the application servers. Default is ERROR

173
Messaging
The Messaging settings are used to configure and enable the messaging service for your site. Process
Manager and the vacation bidding application both use Messaging.

Key and value details

messaging.global.SendMessagingByEmail — Controls whether the Messaging system can send messages
using the corporate external e-mail server.
l On — Allows Messaging to use the corporate external e-mail server to send messages. This is the
default.
l Off — Disallows Messaging from using the corporate external e-mail server to send messages. The
Messaging system will send messages and notifications only to the product Inbox.

Note: Many process templates contain an Inbox task that is affected by this setting. For example, if
you specify “off” for this setting, but your organization implements a particular process designed to
send messages to external e-mail as well as to the product Inbox, employees will not receive the
external e-mail message.

Value: required; installed default=on

messaging.global.server.enable — Set to enable to activate the Messaging system.
Value: required; installed default=enable

174
Mobile Contact
Key and value details
site.MobileContact.EnableAccess — Controls whether Mobile Contact is enabled or not. In addition to
configuring Mobile Contact, service provider communication settings must be configured. Contact support.
Default is False.
site.MobileContact.SMS — Select the field (in People Editor > Person tab > Contacts) that stores the
phone number for SMS (Short Message Service).
site.MobileContact.IVR — Select the field that stores the phone number for IVR (Interactive Voice
Response).
site.MobileContact.email — Select the field that stores the email address. To receive notifications,
managers and employees must have an email address configured.
site.MobileContact.CommunicationMethod — Select the order of methods to communicate with
employees:
l SMS then IVR
l IVR then SMS

site.MobileContact.alerts.sms.EnableCancelRequestEmailEmployeeMessages — Specifies which

employee will be sent email cancellation notifications.
Default: Never
site.MobileContact.alerts.sms.EnableCancelRequestSmsEmployeeMessages — Specifies which
employee will be sent SMS cancellation notifications
Default: Never
site.MobileContact.controllerThreadName — Displays the name of the controller thread that manages
the interaction of the Mobile Scheduler with the communication account; configured by Kronos support.
Default = Mobile Contact Controller. The thread manages Mobile Contact Thread and Mobile Provider
Thread.
site.MobileContact.defaultSequentialCallingWaitTime — Default wait time in minutes between
contacting employees using the sequential calling strategy.
site.MobileContact.handlecallback.internal.cutOffMinsBeforeShiftStart - Specifies the time before
shift start for employees to accept shifts.
site.MobileContact.senders - Specifies the phone numbers to be used for Mobile Contact.
site.MobileContact.sendersNumberCustomURL — Specifies the phone number callback URL for the
mobile provider (required with Proxy Server Support).
site.MobileContact.CommunicationProviderService.enabled - Enable SMS mobile provider access.
Default is false.
site.MobileContact.callback.handler

175
 site.MobileContact.provider.factory
site.MobileContact.alerts.sms.enable — Controls whether alerts SMS feature is enabled or not. Set this
to true to enable SMS messaging on mobile devices.
site.MobileContact.alerts.senders - Specifies the phone numbers to be used for Alerts SMS.
site.MobileContact.alerts.provider.factory — The service provider class. For example: com.kronos.
wfc.platform.externalmessaging.business.internal.XYZFactory
site.MobileContact. handlecallback.internal.TwilioCallbackHandler.security.enabled - Twilio: Set to
false False when using a proxy server.
site.MobileContact.business.mobileprovider.factory.class — Specifies the class used to generate
messages
site.MobileContact.mobileprovider.account.userName — Displays the user name of the communication
account; up to 256 characters long; configured by support.
site.MobileContact.mobileprovider.account.password.rsa —Displays the password to the
communication account; configured by support .
site.MobileContact.platform.externalmesssaging.business.internal.Twilio.sid - Twilio: The mobile
provider account SID (34 characters long).
site.MobileContact.platform.externalmesssaging.business.internal.Twilio.token - Twilio: The mobile
provider account authentication token.
site.MobileContact.AllowOverlaps — Specifies whether to allow shifts being accepted to overlap
employee's existing shifts
site.MobileContact.CommunicationProviderService.class
site.MobileContact.CommunicationProviderService.depends
site.MobileContact.NotificationService.class
site.MobileContact.NotificationService.depends
site.MobileContact.useShiftStartStopTime.enabled — Use shift start stop time or label in open shift
message.
site.MobileContact.OverridenText — Override the open shift message.
Recommended value(s):
#@#AVAILABLE_SHIFTS#@# Open Shift(s) at #@#LOCATION#@# from #@#START_TIME#@# to
#@#END_TIME#@# on #@#START_DAY_OF_WEEK#@#, #@#START_DATE#@#.
site.MobileContact.NumberOfOrgNodes — Specify the number of org nodes that may constitute the
message if 0 means this setting will not affect the open shift message otherwise wil strip off the org nodes.
site.MobileContact.OverrideAcceptanceString — Override the acceptance message
site.MobileContact.OverrideShiftUniqueCodeNotification — Shift unique code notification message

176
Monitoring
The Monitoring settings are used to configure and enable the Performance Monitoring service for your site.
Performance Monitoring uses system MBeans to keep track of the performance of the system. There are
two types of system settings for monitoring:
l General settings that apply to all MBeans.
l Mode Settings (Real Time Mode and Forensic Mode) that apply only to specific MBeans

Key and value details

General Settings
site.monitoring.performance.PerformanceBatchRecordsTimeToLive_day — In Forensic Mode,
duration (in days) after which performance monitoring tables data will be purged. This is used for Forensic
mode only.
site.monitoring.performance.timeToLiveInCache_minute — In RealTime Mode, duration (in minutes)
to store performance monitoring data in cache. This number should be set higher than the query interval
duration for MBean queries. Set this duration low to minimize memory footprint. Set this duration higher to
allow a wider query range.
site.monitoring.performance.MBeanQueryIntervalSystemSetting_minute — The default MBean query
interval duration (in minutes). This setting is the duration for MBean attributes that return component
attributes over a look back window.
site.monitoring.performance.xmlApi.allowXMLWithNames — Contains comma separated list of XML
APIs that will be included in performance monitoring. Regular expressions can also be used: for example,
*WORKRULE* means "include xml api with name containing WORKRULE string in its name." Values
such as *WORKRULE and WORKRULE* can also be specified.
site.monitoring.performance.BGPPerformance.enable — Turns on real-time mode for capturing
Background Processor performance monitoring data.
Default = false

RealTime Mode Settings

site.monitoring.performance.hyperFind.enable — Determine whether to persist Hyperfind performance
monitoring data. This is essentially an ON/OFF switch for monitoring HyperFinds. This setting must be set
to True for HyperFind performance monitoring (of any kind) to occur. Real Time Mode is on when this
setting is True and the corresponding Forensic Mode setting is False.
site.monitoring.performance.genies.enable — Determine whether to persist Genie performance
monitoring data. This is essentially an ON/OFF switch for monitoring Genies. This setting must be set to
True for Genie performance monitoring (of any kind) to occur. Real Time Mode is on when this setting is
True and the corresponding Forensic Mode setting is False.

177
 site.monitoring.performance.xmlAPI.enable — Determine whether to persist XML API performance
monitoring data. This is essentially an ON/OFF switch for monitoring XML APIs. This setting must be set
to True for XML API performance monitoring (of any kind) to occur. Real Time Mode is on when this
setting is True and the corresponding Forensic Mode setting is False.
site.monitoring.performance.SmartView.enable — Determine whether to persist Smart View
performance monitoring data. This is essentially an ON/OFF switch for monitoring Smart Views. This
setting must be set to True for Smart View performance monitoring (of any kind) to occur. Real Time
Mode is on when this setting is True and the corresponding Forensic Mode setting is False.

Forensic Mode Settings

site.monitoring.performance.forensicMode.batchInsert — In Forensic Mode, number of records to
accumulate before writing data to database in a single batch operation. Set this batch size higher to
minimize database impact. Setting this batch size low forces more frequent save operations. This is used
for Forensic mode only.
site.monitoring.performance.forensicMode.genies — Determine whether to save Genie performance
monitoring data in database. This setting works with the
site.monitoring.performance.genies.enable setting. Both of these must be True to
enable the Forensic Mode monitoring of Genies.
site.monitoring.performance.forensicMode.hyperFind — Determine whether to save HyperFind
performance monitoring data in database. This setting works with the
site.monitoring.performance.hyperFind.enable setting. Both of these must be true to
enable the Forensic Mode monitoring of HyperFinds.
site.monitoring.performance.forensicMode.xmlApi — Determine whether to save XML API
performance monitoring data in database. This setting works with the
site.monitoring.performance.xmlApi.enable setting. Both of these must be True to
enable the Forensic Mode monitoring of XML APIs.
site.monitoring.performance.forensicMode.SmartView — Determine whether to save Smart View
performance monitoring data in database. This setting works with the
site.monitoring.performance.SmartView.enable setting. Both of these must be True to
enable the Forensic Mode monitoring of Smart Views.
site.monitoring.performance.forensicMode.BGPPerformance — Turns on Forensic Mode for capturing
Background Processor performance monitoring data and writing to database.

178
Nursing Care Hours Summary
Use these system settings to specify:
l Basis for hours calculation (for example, whether to total actual or scheduled hours)
l Other information to include (for example, whether to list employees’ contract type)

Key and value details

site.nchs.report.use.fulltime.equivalent — Specify whether to use the full time equivalent or scheduled
zone spans to determine the full time span. If set to true, the full time equivalent is used. If set to false,
scheduled zone spans are used. Default setting is true.
site.nchs.report.fulltime.equivalent.hours — This setting applies only if the system setting called
site.nchs.report.fulltime.equivalent is set to true. Specify the full time equivalent in hours. Default setting is
8 (hours).
site.nchs.employee.contract.types —Allows you to specify which employee contract types to include in
the Nursing Care Hours Summary data export. Enter the contract type names separated by commas (for
example, Contract1,Contract2).
This list must correspond to the contract types specified for employees in People Editor (Worker Type
field).
site.nchs.registered.nurse.job.group — Allows you to specify which jobs in the job group for registered
nurses to include in the Nursing Care Hours Summary data export. Enter the job names, separated by
commas (for example, RN,RN1,RN2). The default setting is RN.
site.nchs.licensed.practical.nurse.job.group — Allows you to specify which jobs in the job group for
licensed practical nurses to include in the Nursing Care Hours Summary data export. Enter the job names,
separated by commas (for example, LPN,LPN1,LPN2). The default setting is LPN.
site.nchs.unit.assistive.personnel.job.group — Allows you to specify which jobs in the job group for unit
assistive personnel to include in the Nursing Care Hours Summary data export. Enter the job names,
separated by commas (for example, UAP,UAP1,UAP2). The default setting is UAP.
site.nchs.export.calculation.basedon.employees.actual.hours — Specify whether actual or scheduled
hours should be totaled and exported. If set to true, actual hours are exported; if set to false, scheduled
hours are exported.

179
POS Import
The following system setting is in the POS Import tab of the System Settings workspace:
site.posimport.volumeimport.calculateoccurenceratioonposimport — Specifies if occurrence ratio
should be calculated on POS import. When set to True (default), this setting enables the running of the
occurrence ratio engine during a Point of Sale (POS) Import.
When set to False, this setting prevents the recalculation of occurrence ratios during import. This will
improve the performance of the POS Import. Note however, that you will have to schedule the batch task
“Occurrence Ratio” to run regularly. It is recommended that this be run at least once a week to keep Event
Ratios up to date.
Occurrence ratio is used to predict possible impact of an event in future. The ratio tracks the historical
impact of an event on a volume driver.

180
Printers
The Printers settings identify all the printers that are defined for your system. Each printer must be visible
to the server. The system uses these printers when you select Print when running reports. If you view a
report first, then the printer selection comes from the browser, not from 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.
Note the following information regarding printers:
l Printers are a global resource for the system. In a multi-instance environment, all instances have the
same list of printers.
l Printer properties are maintained in the database.

l There is no limit to the number of printers that can be defined.

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:
printer.p1 = name_Printer1;\\\\APOGEE\\LochNess;Group 1
where name_Printer1 is the name that appears in print dialog boxes.
Properties with global scope across instances are maintained in database tables. If you switch databases,
you must copy the appropriate properties to the new database. For more information, see Work with
property files on page 23.

Caution: Do not modify any properties in this setting unless you want the change applied to all of the
instances in your environment.

Key and value details

printer.<printer number> — This string represents the server printer information. This information is in
three parts, separated by semicolons.
l The first part is the printer name that appears in the printer selection list.
l The second part is the path to the printer driver.
l The third part is the printer group.

181
 Example: System Printer 1;\\printserver\printer; Group1

Enable a server-based printer

To add a server-based printer to the system, follow these steps:
1. Define the printer in the System Settings component in the Printers tab.
2. Provide the default application server (JBoss, for example) user account with access to the printer.
3. Provide the server with access to the printer.
The default application server—JBoss—is installed under a Windows NT user account. This 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 user account.
To determine if a printer is accessible from the server, log on to Windows NT using the JBoss user
account. Now use standard Windows NT facilities to add a printer. If the printer appears in the list of
printers available for selection, it is accessible from your server. You do not need to actually add the
printer. Seeing it on the list indicates its availability to the system.

182
Priority Scheduling Engine
The Priority Scheduling Engine settings enable you to assign open shifts to employees according to sorting
and matching rules.
You can configure the Priority Scheduling Engine (PSE) system settings to process log, input, and output
files. By default, all of these files are disabled.
The following system settings are in the Priority Scheduling Engine tab of the System Settings workspace.
Select any of the following options:
l Enabling the PSE logs
l Enabling the PSE input and output files

For engine controller settings that can affect the operation of the PSE, see System settings for the engine
controller.

Key and value details

site.scheduling.pse.debug — Specifies if debugging the Priority Scheduling Engine is turned on.
Value: default=false
site.scheduling.pse.logpath — The location of the Priority Scheduling Engine debug log file.
Value: required, installed default={WFC.externaldir}/applications/wfs/log
site.scheduling.pse.generateinputoutput — Specifies if the input and output XML files generation is
turned on.
Value: default=false
site.scheduling.pse.inputpath — The location of the Priority Scheduling Engine debug input file.
Value: required, installed default={WFC.externaldir}/applications/wfs/input
site.scheduling.pse.outputpath — The location of the Priority Scheduling Engine debug output file.
Value: required, installed default={WFC.externaldir}/applications/wfs/output

183
Record Retention - Affected Databases
The Record Retention - Affected Databases settings provide connection information for all databases for
which you want to define retention policies and all source and target databases that are used by the
archiving application for record management.
A default Retention Policy named DEFAULT_RETENTION_POLICY is provided with the host
application.
If you want to implement a Retention Policy, using the default policy is recommended. After the Retention
Policy has been activated, you can update any of the Record Types settings to accommodate data retention
for a particular data type. All settings for each Record Type are provided as guidance and can be used as
is or modified based on the company data retention strategy.
To activate the Retention Policy, the default information in the settings in the Affected Databases tab must
be updated with the actual Production database connection information. After you enter the correct
database information (JDBC, username and password, and database driver) and the database can be
accessed by the suite application, the policy appears in the Record Retention Policies workspace and you
can select it.
In some cases, the policy is visible but does not show the pre-set default values and cannot be selected. If
this is the case, select a different policy from the drop-down menu and then select the default policy to see
the updated values. If the default policy is the only policy, and the cache does not get updated by
reselecting a policy, you may need to logon again to see the updated values.

Important: More than one policy can be associated with a database. Be sure that you are using the
correct policy, which may have been created previously. Choosing the wrong policy may produce
unexpected results.

Note: If you created a Retention Policy prior to this release and intend to use it after upgrading to the
current release, you do not have to activate the default policy. However, the default policy settings will
appear in the Affected Databases tab and a message stating that the database is inaccessible will be
displayed in the Record Retention Policies workspace. This is an information-only message and does not
affect any retention processing on a database that has been correctly set up for the retention process.

Key and value details

jdbcconnector.1.drv — The JDBC driver name
jdbcconnector.1.max — Maximum number of JDBC connections. Default is 50.
jdbcconnector.1.min — Minimum number of JDBC connections. Default is 10.
jdbcconnector.1.name — Name of the retention policy.
jdbcconnector.1.pwd — Database owner password.
jdbcconnector.1.url — jdbc:sqlserver://SERVERNAME:1433;databaseName=DATABASENAME;

184
where SERVERNAME is the database server name and DATABASENAME is the name of the database.
jdbcconnector.1.usr — Database owner user name

185
Record Retention – Database Setup
The Retention Policy Database Setup settings contain information that the Record Retention Policy
component uses to connect to your production database.
l If the instance points to your production database, use the default values.
l If the instance points to a non-production database, such as a test database or an archive database, edit
the values to match your production database.

Key and value details

site.master.url — The JDBC connection string used to connect to the production database.
Value: required
site.master.usr — The name of the user account that is used to access the production database.
Value: required
site.master.pwd — The password of the user account that is used to access the production database.
Value: required
site.master.drv — The JDBC driver to use with your respective Relational Database Management
System (RDBMS).
Value: required
site.master.min — The minimum database pool size. The value is 10. Do not change this setting.
Value: required
site.master.max — The maximum database pool size. The value is 50. Do not change this setting.
Value: required

186
Reports
The Reports settings establish the reporting properties for standard reports, which use RDL report
templates and the Reports Definition Language Client (RDLC) engine. Before users can create and
schedule standard reports, you must establish the reporting properties using this information.

Note: For UNIX/Linux platforms, reports are on the companion Windows server.

Key and value details

site.reporting.GenerateRepsToDir — Specifies the location where the generated reports are stored.
Value: required; platform=Windows; installed default= installation_
directory\instance\reports\site.local.LANGUAGE\reportoutput
site.reporting.executable.log — Name and the path of the report agent log file (Windows Only)
Default: c:\Kronos\wfc\logs\WFCReporting
site.reporting.rpt files — Path to the report template files (Windows only)
Default = reports
site.reporting.rpt.otherfiles2008
Default=OtherReports2008
site.reporting.RepTimeToLive — The number of hours before the generated reports are cleaned up from
the disk.
Value: required; minimum=0; platform=Windows; installed default=72
site.reporting.RepCleanUpDaemon.enable — Set to true to enable the report server’s cleanup process,
which deletes both the reports entry from the Check Run Status tab and the report file. The deletion is
based on the report’s request date and time and the length of time designated in the
site.reporting.RepTimeToLive key.
Value: required; platform=Windows; installed default=true
site.reporting.MaxNumRepAgents — Maximum number of Report Agents running in the background.
(Windows Only).
Default: 2
site.reporting.totalization.interval — Interval of time in seconds in between attempts by the reporting
engine to check that data on all employees on a report has been totalized. (Windows Only)
Default: 30
site.reporting.totalization.retries - Number of attempts the report engine makes to check that data on all
employees on a report has been totalized. (Windows Only)
Default: 7
site.reporting.importbatchrange - Date range in days being used to extract a list of table import batches
run from current day to x number of days back in time. (Windows Only)
Default: 3

187
 site.reporting.engine.enable - Flag to indicate if the report engine is enabled in this server. (Windows
Only)
Default: true
site.reporting.preprocesswebservice.timeout - Number of minutes that report pre-processing will run
before timing out.
Default: 7
site.reporting.status.refresh.timer.seconds — Time interval (in seconds) that the auto-refresh waits to
retrieve fresh data on the Check Report Status page.
Value: required; installed default=5
site.reporting.check.report.status.chunksize — Specifies the pagination size (number of rows) in the
Check Report Status page.
To improve the time required for reports to render in Internet Explorer, this setting controls the pagination
functionality on the Check Report Status tab.The Status column displays the status of the reports. When
multiple reports are run simultaneously, this value controls the number of reports that are displayed on the
Check Report Status tab. The higher the number of reports , the more time it takes to render this page.
Value: required; installed default = 500
site.reporting.viruscan.command — Command line with parameters for scanning Excel Template files.
{0} represents the file to be scanned. For example, c:/Program Files (x86)/McAfee/VirusScan
Enterprise/x64/scan64.exe {0} /AUTOEXIT /ALWAYSEXIT
site.reporting.virusscan.failonfiledeleted — Some virus scanners don't return exit codes when detecting
a virus. Set this item to true if the scanner deletes the file when it detects a virus.
Value: required; installed default: false
site.reporting.virusscan.exitcode.success — This is the success return code (no virus found) from the
command line used for scanning Excel Template files.
Value: required; installed default: 0

188
Request
The Request settings enable you to specify the parameters for the display of employee schedule requests.

Key and value details

site.scheduling.request.help.topic — Displays the online Help topic that describes schedule requests.
site.scheduling.request.calendar.name — Displays the name of the My Requests calendar. If you
change the name, it must be unique, can be up to 50 characters long, and must not include the following
characters: &_*%?:;=()/[]\|#@<>.
Value=optional; installed default=My Requests
site.scheduling.request.openShifts.period.limitation — Enter the maximum number of days that open
shifts can be requested.
Value=optional; installed default=42
site.scheduling.request.requests.period.limitation — Enter the maximum number of days that
employees can see their requests.
Value=optional; installed default=42
site.scheduling.request.expired.requests.submission.period.limitation —Enter the maximum number of
days that a manager can see requests from expired submission periods.
Value=optional; installed default=7
site.scheduling.request.view.actions.on.requests.page — Display all My Actions in the My Requests
workspace.
Value: required; default=false

189
SQL Coverage
The SQL Coverage settings provide a debugging tool that tracks the number of times each SQL statement
is executed. You should need this information only for debugging.

Key and value details

test.SQLCoverage.enabled — Set to true to perform SQL coverage tracking.
Value: required; installed default=false; recommended value: false
test.SQLCoverage.writebackcount — The number of changes to the SQL Coverage properties entries
between rewriting the file.
Value: required; minimum=1; maximum=100; installed default=25
test.SQLCoverage.refresh — Set to true to re-create the SQL Coverage properties from the
WPKSQLStrings*.properties file.
Value: required; installed default=false
test.SQLCoverage.traceback — The list of statements to be backtraced. You can find out where a SQL
statement is invoked by entering its name in this field. A complete traceback is written to the log. You can
add multiple statements, separated by spaces.
test.SQLCoverage.driverLogging — Set to true to create a log of all JDBC driver communications. This
can be helpful when you debug driver problems. The JDBCdriver.log file contains the output.
Value: required; installed default=false

Enable SQL tracing

To enable SQL tracing:
1. Select System Configuration > System Settings > Log File.
2. Set site.log.loglevel to DEBUG.
3. Click Save.
4. Select System Configuration > System Settings > Service.
5. Set site.service.sql.trace.on.off to on.
6. Click Save.
7. Select System Configuration > System Settings > SQL Coverage.
8. Set test.SQLCoverage.enabled to true.
9. Click Save.

190
Schedule Generator
The Schedule Generator system settings control log, input, and output files; and Schedule Generator,
optimizer, and workload settings.

Key and value details

site.scheduling.schedGen.logpath — Sets the location of the Schedule Generator log file.
Value: required; installed default={WFC.externaldir}/applications/wfs/log/
site.scheduling.schedGen.generateinputoutput — Enables or disables the generation of input and output
XML files.
Value: required; installed default=false
site.scheduling.schedGen.inputpath — Sets the location of the Schedule Generator input file.
Value: required; installed default={WFC.externaldir}/applications/wfs/input/
site.scheduling.schedGen.outputpath — Sets the location of the Schedule Generator output file.
Value: required; installed default={WFC.externaldir}/applications/wfs/output/
site.scheduling.schedGen.blockAccess — Enables or disables the Schedule Generator.
Value: required; installed default=true
site.scheduling.schedGen.LpSolver.NodeLimit — Sets the maximum number of sub-iterations.
Value: required; installed default=10000
site.scheduling.schedGen.LpSolver.RelOptimalityGapPerMil — Sets the per mil of the optimality gap.
Value: required; installed default=30
site.scheduling.schedGen.EmployeeDivider.MaxSize — Sets the number of employees to process in
each iteration.
Value: required; installed default=30
site.scheduling.schedGen.HorizonDivider.Reference —Sets the reference day for iterations.
Value: required; installed default=Sunday
site.scheduling.schedGen.HorizonDivider.Step — Sets the offset (in days) between consecutive
iterations.
Value: required; installed default=7
site.scheduling.schedGen.HorizonDivider.Length — Sets the number of days to process in each
iteration.
Value: required; installed default=7

191
 site.scheduling.schedGen.engine.ExcludeExternalEmployees — Restricts or allows selection of
transferred employees.
Value: required; installed default=true
site.scheduling.schedGen.shiftenumerator.EnumeratedShiftLimit — Limits the daily number of shift
templates to create from shift profile sets
Value: required; installed default=5000
site.scheduling.schedGen.business.protocol.AllowWorkloadUnderCoverage
Allows or disallows workload undercoverage.
Value: required; installed default=false
site.scheduling.schedGen.business.protocol.AllowWorkloadAtZeroToBe
Covered — Allows or disallows workload at zero to be covered.
Value: required; installed default=true
site.scheduling.schedGen.business.protocol.ThresholdSpanForWorkloadAt
ZeroAnalysis — Sets the threshold span (in minutes) for workload at zero analysis.
Value: required; installed default=1440
site.scheduling.schedGen.business.protocol.ExcludePayCodesFromBudget
Balance — Excludes initial pay codes from budget balance.
Value: required; installed default=false

192
Scheduling
The Scheduling system settings contain information about the following:
l Job display in coverage areas of the scheduler.
l Defining the color of cells in the Daily Coverage area of the Scheduler.
l Minor rules
l Which Employee Self-Service functions are available
l Viewing the Daily Coverage information by default

Key and value details

site.scheduling.schedulePlanner.summaryTabs.orgPathLevelsToDisplay — The level of organizational
job that will be displayed in the list of jobs and job drop-down list in the Daily Coverage table, and on the
Coverage tab in the Scheduler.
For example, an organizational job of RN in a hospital can have the following full path:
Hospitals/GeneralHospital/Floor1/Maternity/RN
If you define this setting as 3, when you display the job using the drop down controls in the Daily Coverage
table and on the Coverage tab in the Schedule Editor and Schedule Planner, the job will be displayed only 3
levels up, such as Floor1/Maternity/RN
Value: required; installed default=4.
site.scheduling.minorrules.requirebirthdate — If true, the Birth Date field in the General Information
workspace in the People Editor is a required field.
If this setting is false, the Birth Date field is not required.
Value: required; installed default=false

Caution: If a person whose birthday indicates that he or she is a minor does not have both a minor rule
set and a school calendar assigned to him or her in People, the Scheduler will not schedule him or her to
any shifts.

site.scheduling.selfscheduling.requestcategory — Select All to specify that all of the Process Manager

functions in Employee Self-Service are available to employees or select Scheduling Workflow to limit the
process templates available in self scheduling to the ones of that category.
Value: required; installed default=ALL
site.scheduling.weekendsOff.identifyWeekendsOff — Defines how the Scheduler and Auto-Scheduler
interpret Weekends Off.
Value: required; installed default=false
site.scheduling.schedulePlanner.hppd.hoursStatistic.paidHoursPerVolume
If true, specifies if hours per volume is paid time instead of actual time.
Value: required; installed default=false

193
 site.scheduling.schedulePlanner.hppd.useFirstScheduleZoneForDayStart — If true, uses a location's
first Schedule Zone to determine when a day starts and ends on the Hours/Volume tab.
Value: required; installed default=false
site.scheduling.schedulePlanner.hppd.budgetHPPD.useImportedValue.locationTypes — List of
comma-separated Location Types that import Budget Hours/Volume rather than calculate.
site.scheduling.schedulePlanner.hppd.budgetHours.deriveHoursFromHPPDValue.locationTypes —
List of comma-separated Location Types that define Budget Hours as Budget Hours/Volume times
Volume.
site.scheduling.schedulePlanner.hppd.budgetVolume.useImportedValueOnly.locationTypes — List
of comma-separated Location Types that always display stored values of Projected Volume for Target and
Scheduled rows.
site.scheduling.schedulePlanner.hppd.budgetVolume.useLargestChild.locationTypes — List of
comma-separated Location Types that use the largest value of the Budget Volume of its children location
instead of using the sum of the values.
site.scheduling.schedulePlanner.hppd.budgetVolume.useSumOfSelfAndChildrenValues.locationTyp
es — List of comma-separated Location Types that define Budget Volume as the sum of the location's
stored value and children location values.
site.scheduling.schedulePlanner.hppd.scheduleVolume.useImportedValueOnly.locationTypes — List
of comma-separated Location Types that always display stored Projected Volume values for Target and
Scheduled rows.
site.scheduling.schedulePlanner.hppd.scheduleVolume.useLargestChild.locationTypes — List of
comma-separated Location Types that use the largest Projected Volume value of its children locations for
the Target and Scheduled rows instead of using the sum of the values.
site.scheduling.schedulePlanner.hppd.scheduleVolume.useSumOfSelfAndChildrenValues.locationTy
pes — List of comma-separated Location Types that define Projected Volume as the sum of the location's
stored value and children location values.
site.scheduling.schedulePlanner.hppd.actualVolume.useImportedValueOnly.locationTypes — List of
comma-separated Location Types that always use stored Actual Volume values.
site.scheduling.schedulePlanner.hppd.actualVolume.useLargestChild.locationTypes — List of
comma-separated Location Types that use the largest value of the Actual Volume of its children location
instead of using the sum of the values.
site.scheduling.schedulePlanner.hppd.actualVolume.useSumOfSelfAndChildrenValues.locationType
s — List of comma-separated Location Types that define Actual Volume as the sum of the Location's
stored value and children location values.
site.scheduling.schedulePlanner.hppd.volume.useAverage.locationTypes — List of comma-separated
Location Types that use average volume for the day instead of largest volume for the day.
site.scheduling.schedulePlanner.hppd.hoursPerVolume.decimalPlaces — Number of decimal places to
display for hours per volume.
Value: required; installed default=2

194
site.scheduling.schedulePlanner.metrics.strategies.maxItems — The maximum number of Rollup
Strategy groups which can be included in a Metrics Setup definition.
Value: required; installed default=5
site.scheduling.schedulePlanner.metrics.indicators.maxItems — The maximum number of Indicators
which can be included in a Metrics Setup definition.
Value: required; installed default=20
site.scheduling.schedulePlanner.metrics.hourscategory.maxItems
The maximum total number of Jobs and Pay Codes which can be included in an Hours Category Setup
definition.
Value: required; installed default=20
site.scheduling.schedulePlanner.metrics.hourscategoryset.maxItems
The maximum number of Hours Categories which can be included in an Hours Category Set Setup
definition.
Value: required; installed default=5
site.scheduling.schedulePlanner.export.exportCoverageData
Specifies if the schedule coverage information is exported when a user attempts to export a schedule's
data.
Value: required; installed default=false
site.scheduling.schedulePlanner.skillcertificationcoverage.proficiencylevelmatchingmode.Reference
— Defines how to compare the skill or certification proficiency levels of employees to the required
proficiency levels in the skill and certification profiles of shift segments.
Value: required; installed default=ignored
site.scheduling.workWeek.useOutsideOfWorkWeekHours — If true, specifies whether hours outside
of work week are excluded when validating weekly employee schedule rules.
Value: required; installed default=false
site.scheduling.shiftlabels.overridewidth — If true, specifies if the default column width for shift labels
(which allows 28 days to be viewed at once) should be overridden.
Value: required; installed default=false
site.scheduling.shiftlabels.overridenwidth— Defines the column width of the Shift Labels view in the
schedule. The range is from 28 to 105 pixels. You must restart the server for the changes to take effect.
Default = 28
site.scheduling.selfscheduling.postedScheduleNotification — If true, specifies whether an e-mail is sent
to all employees and managers involved in the posting.
Value: required; installed default=true
site.scheduling.scheduleplanner.dailycoverage.showViewAll — Specifies if the default view for spans
is View All (true) or Total Shifts (false).
Value: required; installed default=false
site.scheduling.reportsWithCoverage.ShowZeroRows — Default = true.

195
 site.scheduling.schedulePlanner.transfertools.business.transfers.ignoreOverCoverage — Defines
whether shifts that do not have overcoverage can be transferred from the Assignments tab.
Value: required; installed default=false
site.scheduling.minorConsecutiveDaysRule.applyWithinWeekOnly — Apply the Maximum
Consecutive Days rule in Minor Rule Set to the calendar week only.
Value: required; installed default=true
site.scheduling.ruleevaluation.countNightShiftsOnDayStarted — For Schedule Rule Sets. If True,
designates that night shifts apply to the day on which they start. If False, designates that night shifts apply
to the day on which the designated night period starts.
site.scheduling.fatiguemanagement.ruleevaluation.logging
site.scheduling.fatiguemanagement.ruleevaluation.logdir
site.scheduling.metrics.rollup.filters.enabled — This setting enables rollup filters for Metrics in the
Schedule Planner Widget

196
Security
Security settings establish an offline environment and specify the authentication mode that your instance
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 the system’s records.

Key and value details

site.security.authentication.offline.username — Logon user name for offline mode.
Value: required; installed default=superuser
site.security.authentication.offline.password — Logon password for offline mode. Passwords are stored
encrypted.
Value: required
site.security.authentication.logoff.restartTimer.seconds — Specifies the number of seconds allotted for
the server to restart, before the user is redirected back to the logon page after logging off.
Value: required; minimum=0; installed default=480
site.security.SSL.FQDN — Fully-qualified domain name of the local server used for SSL-enabled
connections. For example, myserver.<company_name>.com.
site.security.authsrc — Authentication type: The definition of your server security method.
Examples:
l WinNT — support for multiple Windows NT domains
l WinNT://your NT Domain name — support for a single Windows NT domain

l OTHER://provider=Authentication Module;property=Authentication Module property file

Value: installed default=PROPRIETARY

site.security.authsrc.winnt — Specifies the provider of NT authentication.
site.security.authsrc.ldap — Specifies the provider of LDAP authentication.
site.security.authentication.ldapautherrordetail — Specifies whether LDAP error message will be
displayed on the logon page when authentication failed.
Default = true.
site.security.authsrc.other — Specifies the provider of customized authentication.
site.security.singlesignon— Set to true to enable single sign-on.
Value: required; installed default=false
site.security.singlesignon.aoid — Set to true if single sign-on accepts AOIDs.
Value: required, installed default=false

197
 The API Authentication feature requires that users must have a COID (Company Identifier) as well as an
AOID (Associate Identifier) when they log on for an XML API transaction.
Each employee across all companies has a unique AOID. All employees working in the same company
have the same COID. No support is provided for the same person working at two different companies.
The COID has been added as a required field to the PersonIdentity XML element. The AOID and COID
key pair is associated to employees in the PRSNCMMNIDENTASSIGN database table.
System accounts, such as SuperUser and Import, do not require an AOID/COID pair. The user can
continue to use the Username and Password for authentication.
site.security.singlesignonoverride.enable - Switch to turn on Mobile employee's single sign-on validation.
Default is false.
site.security.singlesignon.logoffurl— Specifies the logoff URL. This property is used to designate the
logoff URL for single sign-on and non-single sign-on environments.
Value: required; installed default={WFC.context}/logoff/logonWFC.html
site.security.ESSsinglesignon.logoffurl — Specifies the SSO timeout redirect URL if ESS single sign-on
is enabled. If you use a non- Workforce Central URL, you must enter the full URL, for example,
http://www.google.com
Default = {WFC.context}/applications/wtk/html/ess/logoff.jsp
site.security.singlesignon.module — The name of the module, such as Java class file, that implements
single sign-on for the system. This is only used when the system integrates with a third-party single sign-on
solution.
Value: installed default =
com.kronos.wfc.platform.security.business.authentication.ssoplugin.SSO
SiteMinderSubject
site.security.singlesignon.module.properties — The name of the property file that contains configuration
information used in the single sign-on module. This is only used when the system integrates with a third-
party single sign-on solution.
Value: installed default=
{WFC.externaldir}/applications/wcb/properties/SSOSiteMinder.properties
site.security.SSOTimeoutRedirectURL — Specifies the SSO timeout redirect URL. If you use a non-
Workforce Central URL, you must enter the full URL, for example, http://www.google.com
Default = /wfc/logonWithUID
site.security.sso.saml.attribute.name— Name of the Security Assertion Markup Language (SAML) IdP
attribute as returned in the SAML Response.
site.security.sso.saml.lib.path— Path of the directory containing the SAML IdP certificate and metadata
file
site.security.sso.saml.certificate.file.path— Name and path of the SAML IdP certificate file. The path is
relative to the library path.
site.security.sso.saml.IdPmetadata.file.path— Name and path of the SAML IdP metadata file. The path
is relative to the library path
site.security.sso.saml.encryption.enable — Enable/disable SAML-encrypted SSO service.

198
site.security.sso.saml.decryption.privateKey.file.path — Name and path of the privateKey file for
SAML assertion decryption. The path is relative to the library path.
site.security.sso.saml.authentication.request.privateKey.file.path — Name and path of the privateKey
file for SAML assertion decryption. The path is relative to the library path (requires Workforce Central
8.0.11 or higher).
site.security.sso.saml.splogon — Enable/disable SAML SP-initiated SSO service (requires Workforce
Central 8.0.11 or higher).
site.security.sso.saml.idpendpoint — IDP endpoint for SAML request in SP-initiated SSO process
(requires Workforce Central 8.0.11 or higher).
site.security.sso.saml.spendpoint — SP endpoint for SAML request in SP-initiated SSO process (requires
Workforce Central 8.0.11 or higher).
site.security.sso.saml.providername — Provider name for SAML request in SP-initiated SSO process
(requires Workforce Central 8.0.11 or higher).
site.security.sso.saml.issuer — Issuer name for SAML request in SP-initiated SSO process (requires
Workforce Central 8.0.11 or higher).
site.security.sso.saml.splogon.exception.logonurl — Target URL link that will be redirected to (requires
Workforce Central 8.0.11 or higher).
site.security.sso.saml.splogon.exception.url.param.name — Parameter name to check if the request
needs to be redirected to the specific target URL or not (requires Workforce Central 8.0.11 or higher).
site.security.singlesignon.timeout — Set to true to enable session time out when single sign-on is
enabled.
site.security.singlesignon.show.timeout.warning — Set to true to display timeout warning message when
single sign-on is enabled.
site.security.ESSsinglesignon.timeouturl — Enter a non-Workforce Central URL for when the session
times out from the classic user interface. Note that you must enter the full URL, for example,
http://www.google.com.
site.security.singlesignon.hide.logoff — Set to true to hide the log off or sign out link on top of page.
site.security.ssl.termination.on — Set to true if you use an SSL terminator device.
Value: required; installed default=false
site.security.ssl.termination.host — The name of the external SSL terminator device.
site.security.ssl.termination.port — The port number used by the SSL terminator device. If using the
default SSL port 443, this setting can be blank.
site.security.ssl.termination.userequesthost — Set this to true if the host that is responsible for SSL
Termination should be derived from the http request instead of site.security.ssl.termination.host.
Value: required; installed default=false
site.security.forbiddenwords.file — The name of the file that contains words that cannot be used as
passwords.

199
 site.security.unembeddable.logonPage - When set to true, the logon pages will not be allowed to be
embedded in any page served from a different web site.
site.security.external.product.HRMS.ServerName — The server where the HR/Payroll application is
installed.
site.security.external.product.HRMS.NewLogonSetup — When set to True, the link on the logon page
for new user logon setup is displayed.
site.security.external.product.HRMS.protocol — The protocol used by the HR/Payroll server for all
communication. This value is either http (standard mode) or https (secure mode).
Value: required; installed default=http
site.security.html.ess.global.securityTimeout.Minutes — Sets the logoff timer on all the pages within
the employee self-service application. This value determines the inactivity time period each user has prior
to automatic logoff.
Value: required; minimum=1; maximum=30; installed default=25
site.security.html.ess.global.QTS.securityTimeout.Minutes — Sets the Quick Time Stamp logoff timer
for all the pages within the employee self-service application. This value determines the inactivity time
period that triggers automatic logoff for users who logged in via Quick Time Stamp
Value: required; minimum=1; maximum=30; installed default=5
site.security.html.ess.global.QTS.confirmationTimeout.Seconds — Sets the redirect timer on the Quick
Time Stamp - Time Recorded page within the employee self-service application. 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
site.security.external.product.HRMS.HeartBeat.interval — The time interval that the system or the
employee self-service application should wait before refreshing the HR/Payroll session. This ensures that
the HR/Payroll session is active as long as the employee self service application session is active. This
value should be less than the HR/Payroll session timeout value.
Value: minimum=1; maximum=25; installed default=10
site.security.authentication.urldispatcher — The name of the module that implements authentication for
the URL Dispatcher Service that is used by a 4500 device.
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 a 4500 device, substitute DeviceOnlyAuthentication with AnyBrowserAuthentication.
For example: site.security.authentication.urldispatcher=com.installation_
directory.instance.wfp.urldispatcher.security.AnyBrowser Authentication
site.security.proxy.enabled — Use a web eerver proxy.
Default = false.
site.security.proxy.protocol — Communication protocol.
Default = https
site.security.proxy.server.name — The web server proxy server name.
site.security.proxy.port — The port for the web server proxy.

200
Service
Service settings establish properties related to the instance.
A number of property files contain 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 site.service.sql.strings.file.xwherex is
first, second, third, fourth, or fifth.
Use the property site.service.sql.trace.on.off with a setting in the SQL Coverage tab to
enable SQL tracing.

Key and value details

site.service.sql.strings.file.first — First SQL Strings properties file.
Value: required; installed default=WPKSQLStrings.properties
site.service.sql.strings.file.second — Second SQL Strings properties file.
site.service.sql.strings.file.third — Third SQL Strings properties file.
site.service.sql.strings.file.fourth — Fourth SQL Strings properties file.
site.service.sql.strings.file.fifth — Fifth SQL Strings properties file.
site.service.sql.trace.on.off — This setting works with the new logging package, which means the
site.log.WFC.PERSISTENCE.SQLTRACING key must be set to DEBUG.
l Set this to off to disable SQL tracing.
l When this setting is set to on, SQL is added to the log.

Value: required; installed default=off

site.service.sql.trace.on.off.filter — Specifies key used to filter tracing statements.
Default: * (ex. totalizer.persistence.*)
site.service.business.LL.MAX_MOST_RECENT_USED_ITEMS — The number of most recently
used transfer settings that are available for reuse.
Value: required; minimum=1; installed default=5
site.service.business.LL.MAX_LABOR_LEVEL_ENTRIES — The maximum number of named
entities that are 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.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

201
 site.service.business.type.TimePeriodType.MAX_PAY_PERIOD — The maximum standard hours for
pay period time period.
Value: required; minimum=0; installed default=744

202
Smart Operations
System settings for Smart Copy and Smart Move of Forecast Manager enable you to:
l Change the location of the log file
l Customize names by defining the automatic naming of Auto-Scheduler options sets, task groups, tasks
and labor standards

Change the location of the log file

smartoperations.globalsetting.log.path
The location of the Smart Operations log files
By default, the Smart Operations log file is stored at:
{directory}/Kronos/wfc/applications/wcb/log/
To change the location, enter a valid path to the directory where you want to save the log file for Smart
Copy and Smart Move.

Customize names
Default naming: Because Auto-Scheduler option sets, and store-specific forecast category task groups,
tasks, or labor standards must have unique names, Smart Copy automatically changes the site (store)
numbers that it copies. The new items at the destination have the same names as at the source except that
the number of the destination replaces that of the source.
For example, if you copy option set Store 21 FrontEnd Cashiers from the source location Store
21 to the destination location SuperStore 88, Smart Copy duplicates the option set but changes the name to
Store 88 FrontEnd Cashiers. Note: Only the number changes, not the name.
Also Smart Copy changes only the first number in the name. For example, Store 21 FrontEnd 1
Cashiers becomes Store 88 FrontEnd 1 Cashiers.
However if the naming convention for your locations does not use numbers or uses numbers in a different
arrangement, Smart Copy copies the other parameters of the location but does not copy the option set, task
group, task, or labor standard.
How automatic naming works: Smart Copy uses 2 regular expressions (regex) and a flag. The default
regular expression parses the first pattern of numbers or characters that Smart Copy finds in the name of
the source and destination locations:
1. Smart Copy searches the source store name for the source regex pattern.
2. If Smart Copy finds the source pattern, it searches the destination store name for the destination regex
pattern.
3. If Smart Copy finds the destination pattern, it searches the name of the item for the value from the
matched pattern of the source, and replaces it with the value from the matched pattern of the

203
 destination. Smart Copy replaces the first match if replaceall is false, or all matches if
replaceall is true.
4. If any step fails, Smart Copy raises an error and stops copying.
Customized naming: You can customize Smart Copy to copy Auto-Scheduler option sets, and store-
specific forecast category task groups, tasks, or labor standards if the locations use a different naming
convention.

Caution:Kronosstrongly recommends that only qualified administrators edit these settings.

l The number of the destination location must be unique. For example, if the source is
Org/Region1/District 1 “Store 1”, and the destination is Org/Region1/District
2 “Store ASOS 1”, Smart Copy cannot copy the item because “1” already exists.
l The name can have only one number, because only the first number is replaced.

Automatic naming – Auto-Scheduler option sets

smartoperations.globalsetting.autoscheduler.options.set.regex.source.
pattern
l The regular expression that parses the first pattern of numbers or characters in the name of the source
locations
l Default: (\\d+)

smartoperations.globalsetting.autoscheduler.options.set.regex.target.
pattern
l The regular expression that parses the first pattern of numbers or characters in the name of the
destination locations
l Default: (\\d+)

smartoperations.globalsetting.autoscheduler.options.set.regex.replaceall
l True – Change all matched numbers or characters in the option set names.
l False (default) – Change only the first matched number or character.

Automatic naming – Forecast categories

smartoperations.globalsetting.forecast.category.store.specific.task.group.regex.source.pattern
The regular expression that parses the first pattern of numbers or characters in the name of the source
locations
Default: (\\d+)
smartoperations.globalsetting.forecast.category.store.specific.task.group.regex.target.pattern
l The regular expression that parses the first pattern of numbers or characters in the name of the
destination locations
l Default: (\\d+)

smartoperations.globalsetting.forecast.category.store.specific.task.group.regex.replaceall

204
 l True – Change all matched numbers or characters in the task group names.
l False (default) – Change only the first matched number or character.

smartoperations.globalsetting.forecast.category.store.specific.task.regex.source.pattern
The regular expression that parses the first pattern of numbers or characters in the name of the source
locations
Default: (\\d+)
smartoperations.globalsetting.forecast.category.store.specific.task.regex.
target.pattern
l The regular expression that parses the first pattern of numbers or characters in the name of the
destination locations
l Default: (\\d+)

smartoperations.globalsetting.forecast.category.store.specific.task.regex.replaceall
l True – Change all matched numbers or characters in the task names.
l False (default) – Change only the first matched number or character.

smartoperations.globalsetting.forecast.category.store.specific.labor.
standard.regex.source.pattern
l The regular expression that parses the first pattern of numbers or characters in the name of the source
locations
l Default: (\\d+)

smartoperations.globalsetting.forecast.category.store.specific.labor.
standard.regex.target.pattern
The regular expression that parses the first pattern of numbers or characters in the name of the destination
locations
Default: (\\d+)
smartoperations.globalsetting.forecast.category.store.specific.labor.
standard.regex.replaceall
l True – Change all matched numbers or characters in the labor standard names.
l False (default) – Change only the first matched number or character.

205
Startup
The Startup setting controls the system startup.

Key and value details

test.startup.offline — The system will not attempt a database connection when the value of this key is set
to true. False is the normal startup mode that attempts to start the online services and a database
connection. If this setting is marked as true, no online services are started, no database connection is
attempted, and the offline services are started. Users must then log on using the offline logon mode.
l 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 fails 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.
l If test.startup.offline is set to false, the system starts in online mode, and attempts to start
the online services, including ServiceSphere, which attempts a database connection.
Value: required; installed default=false

Task Management

Key and value details

site.wtm.project.recurrence.frequency.duration.WEEKLY — In a recurring project, specifies the
number of days for Weekly frequency.
site.wtm.project.recurrence.frequency.duration.BIWEEKLY — In a recurring project, specifies the
number of days for Bi Weekly frequency.
site.wtm.project.recurrence.frequency.duration.SEMIMONTHLY — In a recurring project, specifies
the number of days for Semi Monthly frequency.
site.wtm.project.recurrence.frequency.duration.MONTHLY — In a recurring project, specifies the
number of days for Monthly frequency.
site.wtm.project.recurrence.frequency.duration.QUARTERLY — In a recurring project, specifies the
number of days for Quaterly frequency.
site.wtm.project.recurrence.frequency.duration.HALFYEARLY — In a recurring project, specifies
the number of days for Half Yearly frequency.
site.wtm.project.recurrence.frequency.duration.YEARLY — In a recurring project, specifies the
number of days for Yearly frequency.
site.wtm.project.status.threshold — Specifies the threshold value for project status.
site.wtm.issue.resolved.threshold — Specifies the threshold days limit to view resolved issues in system.
site.wtm.taskhourdistribution.laborforecast_valley_extension_period — Default limit to extend valley.

206
site.wtm.taskhourdistribution.laborforecast_valley_distribution_direction — Default extend valley
policy.

207
Timekeeping
Key and value details
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.signOffGracePeriodDeltaInMinutes — Specifies the amount of time, in minutes, in
which punches can be added at the boundary of a signed off region. When an employee works over a day
divide and the previous pay period is signed off, the user loses access to the in-punch of the first shift of
the current pay period. This key lengthens the current time period into the previous pay period to gain
access to the in-punches that fall into the previous pay period.

Note: This setting does not affect system generated punches. For example, you cannot edit Pay From
Schedule punches within a signed-off pay period, even when they occur within the grace period.

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 (requires Workforce Central 8.0.10 or higher).
Value: required; installed default=false
site.timekeeping.historicalCorrectionsIncludeInTotals — Specifies whether totals for corrections are
included by default. True (the default) specifies that corrections are included (requires Workforce Central
8.0.10 or higher).
site.timekeeping.historicalEditsImpactsAccruals — Specifies whether the check box to impact accruals
is selected by default when creating Historical Edits.
Value: required; installed default=false
site.timekeeping.timecardRefresh — Refresh timecard automatically.
site.timekeeping.retroHistoricalEditsImpactsAccruals — Specifies whether the check box to impact
accruals is selected by default when creating Historical Edits with Retroactive Pay.
Value: required; installed default=false

208
site.timekeeping.managerAccessToEmployee — Limit manager access to employee to time frames
where employee reports to manager.
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
site.timekeeping.cacheSizeForMAMgrApprovalSeqNums — Number of sequence numbers obtained in
one time for use in updating the MAMGRAPPROVAL table.
Default = 1000
site.timekeeping.removeEmployeeFromExistingScheduleGroups — Specifies the default value for the
check box used to remove the employees from their other schedule inheritance groups for the date range.
Value: required; installed default=true
site.timekeeping.PayPeriodService.Enabled — Specifies whether the pay period service is enabled.
Value: required; installed default=true
site.timekeeping.payrules.maxNumberOfSearchResults
Value: installed default=500
site.timekeeping.signOffCurrentPayPeriodAllowed — Specifies whether the user can sign off on the
current pay period. This setting accommodates changes in time zones and is also useful during a holiday
week, for example, to sign off on employees before leaving for the week.
Value: required; installed default=false; recommended value: false
site.timekeepingaccrualPayOutBeIncludedAsNonCancellingPayCodeEdit — If True, accrual payouts
should be treated as non-canceling pay code edits.
Value: required; installed default=true
site.timekeeping.displayScheduledPCEStartTime — Display start time of scheduled hours-type pay
code edits in timecard editor.
Value: required; installed default=true
site.timekeeping.recordTimestampAfterApproval — Specifies whether employees can record
timestamp if their timecard is approved.
Default = false
site.timekeeping.deductUnpaidTimeFromOnCall — Specifies whether non-worked segments are
deducted from On Call.
Value: required; installed default=true
site.timekeeping.PayCode.EditExcusesCoreViolation.Enabled — If pay codes are configured to excuse
absences, core violations will also be excused if true.

209
 Value: required; installed default=true

210
Transformation
The Transformation settings control the data transformation service for any services, such as reports.

Key and value details

site.transformation.controllerPollingInterval — The polling interval for the TranformerController thread
(in milliseconds).
Value: required; minimum=1; installed default=2000
site.transformation.MaxNumTransformerThreads — The maximum number of transformer threads that
can be run simultaneously.
Value: required; minimum=1; installed default=2
site.transformation.transformerManagerSleepInterval — The sleep interval (in milliseconds) for the
TransformerManager thread before it checks the transformation queue for requests.
Value: required; minimum=1; installed default=5000
site.transformation.keepSharedDataDaysInPast — The number of days that data should be kept in the
shared transformer tables.
Value: required; installed default=30

211
Web & App Server
The Web & App Server settings control the communication component that receives requests from users
and returns responses to them.
The default communication protocol is HTTP. However, much of the data between users and the system is
text-based and, therefore, easily readable. If you require a more secure protocol, you can configure your
Web server to use HTTPS instead, which uses a Secure Sockets Layer (SSL) to encrypt the data with a
digital certificate technique.

Key and value details

site.webserver.session.timeout.graceperiod.minutes — The length of time that the user has to respond
between the time that the Session Time-out dialog box appears and the time that the web server session
timeout occurs. The client-side Logon Again timer calculation is based on the web server’s own session
timeout interval and this grace period value.
Value: required; minimum=1; installed default=1
site.webserver.applet.communication.protocol — The protocol used by applets for communication with
the application server.
Value: required; installed default=system

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.applet.communication.port — The port used for applet communication. Specify only if

also you are also specifying the protocol and it is using a non-standard port (standard ports are 80 for http
and 443 for https).
site.webserver.QTS.maxRoundTripNetworkLatency.seconds — 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 that the round trip from client to server exceeds 1 second. You might use this
setting in situations such as using the QTS application across a satellite connection, when 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
site.webserver.communication.protocol — The protocol used by the web server for all communication.
This value is either http (standard mode) or https (secure mode).
Value: required; installed default=http
site.webserver.appserver.communication.protocol – The protocol used by the application server for all
communication. This value can be either http (standard mode) or https (secure mode).

212
site.webserver.appserver.IpcPort — The port through which the application server receives
communication requests.
Value:required; installed default=8080
site.webserver.webServerHostName — The fully-qualified domain name (FQDN) of the computer
where the web server resides.
Value: required; installed default=fully-qualified domain name of the computer that was specified at
installation
site.webserver.appserver.jspcompression — Set to true to turn on HTTP compression for all JSPs
system wide.
Value:required; installed default=true
site.webserver.messaging.url.server — Replacement prefix used for URLs that are included in external
e-mail messages in employee messaging service.
Value:required; installed default=user-defined prefix.
site.webserver.appserver.cachePort.start
Device Manager is built on a distributed cache mechanism. The cache is replicated across servers using
Remote Method Invocation (RMI). This setting is used with the
site.webserver.appserver.cachePort.end setting to specify the range within which an RMI
port is selected for use to support cache replication. The setting can be changed to any value between 1024
and 65535, and must be less than or equal to site.webserver.appserver.cachePort.end.
Value:required; installed default=11200
site.webserver.appserver.cachePort.end
Device Manager is built on a distributed cache mechanism. The cache is replicated across servers using
Remote Method Invocation (RMI). This setting is used with the
site.webserver.appserver.cachePort.start setting to specify the range within which an
RMI port is selected for use to support cache replication. The setting can be changed to any value between
1024 and 65535, and must be greater than or equal to
site.webserver.appserver.cachePort.start.
Value:required; installed default=11400
site.webserver.appserver.suite.domain — The domain value that enables the URL to access this server
from the client-side browser.

213
Workload
There are settings under the Workload tab in System Settings that affect the Workload Generator. You can
customize Workload Generator terms to better describe your business. Additional settings are specific to
the staffing matrix: one setting enables a warning dialog box to display when a gap exists, and another
setting defines the decimal rounding mode.
An example of a customized (or configurable) Workload Generator term is volume. The Workload
Generator enables a third tab in the Workload Planner. This tab is used to define the volumes that drive the
Workload Generator. In a health care operation, the volume is the number of patients needing care. This
number is referred to as “patient census.” In a health care operation, you could define the system setting
site.workload.configurableterms.volume as Census. The third tab in the Workload Planner will then be
labeled Census.

Note: If you change any of the configurable terms, make sure you restart your server before continuing.

Configurable terms
The configurable terms settings are listed here.

Note: If you change any of these configurable terms, make sure you restart your server before
continuing.

site.workload.configurableterms.volume — The number used by the staffing matrix to generate

workload. In a health care operation, volume is often referred to as Census; the number of patients needing
care. The definition defined in this setting appears in the following places in the user interface:
l The label of the third tab in the Workload Planner
l The label of the Add option under the Actions menu item in the Workload Planner (for example, “Add

Volume” or “Add Census”)

l The label of the Add/Remove Range menu options used in the staffing matrix portion of workload setup

(for example, “Add Volume Range” or “Add Census Range”)

l The label of the configuration and calculation settings of the weight sets.

site.workload.configurableterms.volumetype — The term used to refer to the type of workload volume.

site.workload.configurableterms.addvolume — The term for add volume.
site.workload.configurableterms.weight — The factor that modifies the volume number. In a health care
operation, weight is often referred to as acuity, which is the level of care needed by patients in different
areas. The definition defined in this setting appears as the label of the factoring set in Workload Setup (for
example “Acuity Set” or “Weight Set”).
site.workload.configurableterms.weightedvolume — The label of the view option in the Workload
Planner which reflects a modified volume (or census) number.

214
site.workload.configurableterms.budgeted — The term used to refer to a workload generated in
advance, creating the baseline staffing plan. This term is used in the following areas in the user interface:
l The Generate Workload dialog box (accessed by selecting
Actions > Generate Workload from the Calendar tab in the Workload Planner)
l The View option under the third tab in the Workload Planner

l A data label in the grid under the third tab in the Workload Planner

site.workload.configurableterms.projected — The term used to refer to a workload generated for the

current day, creating the adjusted staffing plan. This term is used in the following areas in the user
interface:
l The Generate Workload dialog box (accessed by selecting
Actions > Generate Workload from the Calendar tab in the Workload Planner)
l The View option under the third tab in the Workload Planner

l A data label in the grid under the third tab in the Workload Planner

site.workload.configurableterms.actual — The term used to refer to actual workload, which is used for
reports and will be used in future features. This term is used in the following areas in the user interface:
l The View option under the third tab in the Workload Planner
l A data label in the grid under the third tab in the Workload Planner

site.workload.configurableterms.scheduled — The term used to refer to scheduled Hours/Volume, hour,

and volume on the Hours/Volume tab.
site.workload.configurableterms.target — The term used to refer to target Hours/Volume, hour, and
volume on the Hours/Volume tab.
site.workload.configurableterms.hppd — The term used to refer to Hours/Volume on the Hours/Volume
tab.
site.workload.configurableterms.hppdtablabel — The term used to refer to the Hours/Volume tab.

Additional system settings

site.workload.staffingmatrix.gapwarning — Setting this to True will cause a warning dialog box to be
displayed if you are creating gaps when setting up a staffing matrix volume range.
site.workload.generation.roundingmode — This sets the rounding mode used during workload generation
for decimal headcount values in the staffing matrix. Valid settings are:
l Round, which means use standard rounding conventions
(less than .5 = round down; .5 or higher = round up).
l Always Round Up

l Always Round Down

site.workload.relativeskillandcertificationworkload.roundingmode — Select the rounding mode for

decimal headcount values in the Skill & Certification Calendar of the Workload Planner:

215
 l Round – Use standard rounding conventions: less than 0.5 = round down; 0.5 or higher = round up.
l Always Round Up

l Always Round Down

site.workload.earnedplan.enabled — Default = true

216
Chapter 8

Currency Policy

A currency policy enables you to manage multiple currencies within your organization. The currency
policy feature enables you to define currency policies for your organization.
Use the Currency Policy page to:
l View the currencies currently available for use in your organization and the exchange rates used by
those currencies.
l Create, modify, or delete currencies
l Open the Update Rates tab to work with exchange rates
About currency policy
A currency policy enables you to manage multiple currencies within your organization. The currency
policy feature enables you to define currency policies for your organization, then assign currencies within
the system.

Note: To use Asian currencies, download the version of JRE that supports Asian currencies. Contact
your system administrator for assistance.

To access the currency policy workspace, select Setup > System Configuration > Currency Policy.
By defining a currency policy for your organization, you can assign currencies in the following areas:
l Employees — Currency assignments for employees appear in areas such as the timecard or dialog
boxes, and allow roll-up totals to be calculated and reported correctly.
l Forecast Map — Currency assignments to nodes in the Forecast map allow roll-up totals to be
calculated correctly. The node assignment also appears in the Operations Planner application when
planning or re-planning budgets.
l As a Manager’s Preference — Allows managers to view grand totals via reports. The UI displays the
currency they prefer in multiple currency scenarios.

Genie column
To support currency policy, you can add a Currency Locale column to Genies by adding Currency Locale
to a Detail Column Set (Schedule Group Detail, Worked Account Detail, Detail, or Accrual Detail). You
can add the column to new or existing Genies. This column enables you to sort on the currency and the
currency format.

System settings
The following settings on the Global Values tab in system settings support currency policy:
Whether APIs treat currency amounts as double-formatted with the system currency format.
(global.currency.currencyAmount.apiUseDouble)
The number of years in the future that currency exchange rates are populated in the database.
(global.currency.exchangerate.numberofyearsinfuture)
The number of years in the past that currency exchange rates are held in the database.
(global.currency.exchangerate.numberofyearsinpast)

218
Base currency
Base currency is used for exchange rate purposes in the system. It is the currency that all other currencies
are exchanged against, and it always has a value of one.
For example, the base currency is the US dollar, and exchange rates are needed for the Canadian dollar
and Mexican pesos. Because the base is defined as US dollars and has a value of 1, the exchange rate is
as follows:
l US dollar/Canadian Dollar = $1.03
l US dollar/Mexican Peso = $6.05

The Base Currency is typically the currency in which a multi-national organization reports all of their
profits and losses.
After a currency policy is in place, you can assign currencies to either employees or an operation. You can
define currencies in the Currency Policy page of the System Configuration module in Setup. To assign
currencies to employees, use the People Editor.
To take advantage of these capabilities you must define a currency policy and assign currencies to either
employees or an operation. You can define currencies on the Currency Policy page of the System
Configuration module in Setup. To assign currencies to employees, use the People Editor.
The Currency Policy page enables you to define a list of currencies available for use in your organization
and the exchange rates used by those currencies. For exchange rate purposes, define one currency as the
base currency, which is used when the system calculates the exchange rate between currencies.
The page contains two tabs that enable you to define currencies and update exchange rates.

Define currencies
Use the Define Currencies tab to define currencies that are available for assignment to employees,
Forecaster, and manager display preferences in different locations. For example, if a corporation has stores
in Buffalo, New York, and Toronto, Canada, currencies can be assigned according to the location of the
store.
To define a currency policy:
1. Select a currency from the Base Currency drop-down list.
2. Select one or more currencies from the Select Currency drop-down list.
3. Enter the exchange rate that you want for each currency.
4. When you finish, click Save.

Update rates
Use the Update Rates tab to update the exchange rate for a selected currency for a specified time.
To update the exchange rate:

219
 1. Select the currency to update.
2. Select a start date and an end date for the updated exchange rate.
3. Enter the new exchange rate.
4. When you finish, click Save.
The updated exchange rates appear in the table below the Exchange Rate As of Date drop-down list.

220
Assign currencies
After you have defined a currency policy, only the defined currencies are available for assignment. The
recommended practice is to assign a currency and formatting code to all employees, managers, and, when
using Forecaster, the Forecast Map.
Currency assignment ensures that:
l Employee-summarized money data (grand totals) is correct. Any totals that are added to the grand total
have had the exchange rate applied before the addition.
l Money values are entered in the correct format.

l Roll up totals in the Forecast Map and Operations Planner have the exchange rates applied before

summarization.
Assigning a currency to an employee ensures that the system can:
l Correctly display the format of the currency when a user enters a money type pay code.
l Correctly calculate grand totals when viewing multiple employees that have mixed currencies on

reports. Subtotal amounts have the exchange rate applied before they are added to the grand total.
Assigning a currency preference to managers enables managers to work across all operations that have
different currencies. It also enables managers to view summarized information (grand totals) in their
preferred currency.
For example, there is a district manager who oversees US and Mexican operations, but has a budget done
in US dollars. The manager can see all employee grand totals in the preferred currency display of USD.

Note: Individual employee totals appear in the employee's assigned currency. Only grand totals have the
exchange rate applied.

Assigning a currency to any category node (above the site level) on the Forecast map enables you to create
physical locations that have their own currency assignment. For example, a district manager handles the
New England stores of the U.S., but is also responsible for two stores on the Canadian border.
By assigning currencies to the stores, the manager sees the totals in the assigned currency of the store. At
the district level, the US currency is assigned. When the manager views the totals, the Canadian stores
have had the exchange rate applied before being added to the district level.
You can assign a currency to any Forecast Map node, with the exception of the Department level. The
lowest node that can have a currency assigned is the Site level.

221
Precedence rules for currency policy
The recommended practice is to always have a currency assigned if you use currency in the system. There
can be times when currency assignment has not occurred. The system then uses precedence rules.

Rules for the user interface

The following precedence rules apply to the user interface in the Timekeeper and Scheduler applications:
l When an employee has an assigned currency, money pay codes appear in the currency format assigned
to the employee.
l If an employee does not have an assigned currency, and the manager has a currency display preference
assigned, all money pay codes appear in the manager’s preferred display currency.
l When the employee does not have an assigned currency, and the manager does not have a currency
display preference, currency and formats appear as defined for the instance server in system settings.

Rule for groups of employees

Groups of employees must have the same assigned currency and formatting. If they do not, the system does
not allow money pay codes to be applied.
This rule applies to all Detail Genies, Multi-line Genies, Roll-up Genies, and the By Group tab in the
Scheduler.

Rules for reports

The following precedence rules apply to reports:
l If an employee’s assigned currency has more than one format, the displayed currency symbol includes
the two-letter country code associated with the employee’s assigned currency.
l For example, an employee’s assigned currency is CAD (Canadian Dollar) and the logon user’s
assigned currency is USD (US Dollar). The currency symbol CA$ appears in the employee’s reports.
l If an employee’s assigned currency and the logon user’s assigned currency have the same format, no
country code appears.
l If an employee has an assigned currency that is different from the logon user’s assigned currency, the
currency amount appears in the employee’s assigned currency.
l If an employee does not have an assigned currency, the currency amount appears in the logon user’s
assigned currency and format.
l If the currency amount is a grand total amount (multiple employees amounts added), the amount
appears in the logon user’s assigned currency and format.

Rules for the Forecast Map

The following precedence rules apply to Forecast Maps:

222
l In a multiple-currency map, all nodes must have an assigned currency or inherit an assigned currency.
l If the location of a store with an assigned currency changes, it uses the currency of the country to
which it relocates.

223
Assign currency to the Forecast Map
You can assign one or more currencies to the Forecast Map. The lowest category level to which you can
assign a currency is a store level. Rollup totals have the currency exchange applied.
To assign a currency:
1. In the Forecaster Setup module of Setup, select Assign Currency. The Forecast Category Currency
Assignment window opens.
2. Select the category to which you are assigning a currency.
3. Select a currency from the Assign Currency drop-down list.
4. If appropriate, select a format for the currency.
5. Click Save. The assigned currency appears in the Currency text box.
Note:
l When you assign a currency to a site in Forecast Categories, child sites inherit the currency
assignment. You can select a different currency when the Assign Currency drop-down list is
available.
l When different site levels, such as stores, are rolled up into a district total, the exchange rate is based
on the currency assigned at the highest category level.
l Any entry below the site level shows only the currency, with no drop-down options.
l Anything in the map below site level inherits the assigned currency; you cannot change it.

224
Supported currencies
The following currencies are currently supported.

Note: To use Asian currencies, download the version of JRE that supports Asian currencies. Contact
your system administrator for assistance.

Currency
Code Currency Name Country
AED Dirham (UAE) United Arab Emirates (AE)
ALL Lek Albania (AL)
ARS Nueva Peso Argentina (AR)
AUD Dollar (Australian) Australia (AU)
BAM Convertible Mark Bosnia & Herzegowina (BA)
BGN Bulgarian Lev Bulgaria
BHD Dinar (Bahraini) Bahrain (BH)
BOB Boliviano Bolivia (BO)
BRL Real Brazil (BR)
BYR Ruble (Belarusian) Belarus (formerly Byelorussia) (BY)
CAD Dollar (Canadian) Canada (CA)
CHF Franc (Swiss) Liechtenstein (LI), Switzerland (CH)
CLP Peso (Chilean) Chile (CL)
CNY Yuan China (CN)
COP Peso (Colombian) Colombia (CO)
CRC Colón (Costa Rican) Costa Rica (CR)
CYP Pound (Cypriot) Cyprus (CY)
replaced by the euro
CZK Koruna (Czech) Czech Republic (CZ)
DKK Krone (Danish) Denmark (DK), Faroe Islands (FO), Greenland (GL)
DOP Peso (Dominican Dominican Republic (DO)
Republic)
DZD Dinar (Algerian) Algeria (DZ)
EEK Kroon Estonia (EE)

225
 Currency
Code Currency Name Country
EGP Pound (Egyptian) Egypt (EG)
EUR Euro Euro zone (22 countries)
GBP Pound (Sterling) (United British Indian Ocean Territory (IO), British Virgin Islands
Kingdom Pound) (VG), South Georgia and the South Sandwich Islands (GS),
United Kingdom (GB)
GTQ Quetzal Guatemala (GT)
HKD Dollar (Hong Kong) Hong Kong (HK)
HNL Lempira Honduras (HN)
HRK Kuna Croatia (local name: Hrvatska) (HR)
HUF Forint Hungary (HU)
IDR Rupiah Indonesia (ID)
ILS Shekel Israel
INR Rupee India
IQD Dinar (Iraqi) Iraq (IQ)
ISK Króna (Icelandic) Iceland (IS)
JOD Dinar (Jordanian) Jordan (JO)
JPY Yen Japan (JP)
KRW Won (South Korean) Republic of Korea (South Korea) (KR)
KWD Dinar (Kuwaiti) Kuwait (KW)
LBP Pound (Lebanese) Lebanon (LB)
LTL Litas Lithuania (LT)
LVL Lats Latvia (LA)
LYD Dinar (Libyan) Libyan Arab Jamahiriya (LY)
MAD Dirham (Moroccan) Morocco (MA), Western Sahara (EH)
MKD Dinar (Macedonian) The Former Yugoslav Republic of Macedonia (MK)
MTL Maltese Lira
MXN New Peso (Mexican) Mexico (MX)
MYR Dollar (Malaysian, also Malaysia (MY)
known as Ringgit)
NIO Cordoba Oro Nicaragua
NOK Krone (Norwegian) Antarctica (AQ), Bouvet Island (BV), Norway (NO),
Svalbard and Jan Mayen Islands (SJ)

226
Currency
Code Currency Name Country
NZD Dollar (New Zealand) Cook Islands (CK), New Zealand (NZ), Niue (NU), Pitcairn
Island (PN), Tokelau (TK)
OMR Rial (Omani) Oman (OM)
PAB Balboa Panama (PA)
PEN New Sol Peru (PE)
PHP Peso (Philippines) Philippines (PH)
PLN New Zloty Poland (PL)
PYG Guarani Paraguay (PY)
QAR Riyal (Qatari) Qatar (QA)
RON New Leu Romania
RSD Dinar (Serbian) Serbia
RUB Ruble (Russian Russian Federation (RU)
Federation)
SAR Riyal (Saudi) Saudi Arabia (SA)
SDG Pound (Sudanese) Sudan (SD)
SEK Krona (Sweden) Sweden
SGD Dollar (Singapore) Singapore (SG)
SKK Koruna (Slovak) Slovakia (Slovak Republic) (SK)
SVC El Salvador Colon El Salvador
SYP Pound (Syrian) Syrian Arab Republic (SY)
THB Baht Thailand (TH)
TND Dinar (Tunisian) Tunisia (TN)
TRY New Lira (Turkish) Turkey (TR)
TWD Dollar (Taiwan, New) Taiwan, Province of China (TW)
UAH Hryvna Ukraine (UA)
USD Dollar (US) American Samoa (AS), British Virgin Islands (VG), Ecuador
(EC), El Salvador (SV), Federated States of Micronesia
(FM), Guam (GU), Marshall Islands (MH) Northern Mariana
Islands (MP), Palau (PW), Panama (PA) (with Balboa),
Puerto Rico (PR), Turks and Caicos Islands (TC), United
States of America (US), United States Minor Outlying
Islands (UM), US Virgin Islands (VI)
UYU Peso (Uruguayan) Uruguay (UY)

227
 Currency
Code Currency Name Country
VEB Venezuelan Bolivar
VND Dong Viet Nam
YER Rial Yemen
ZAR Rand South Africa

228
Chapter 9

Locale policies

Locale policies contain regional settings (language locale, date format, and number format) that can be
assigned to users. The users’ settings take precedence over the default setting for the Workforce Central
application server. Users see the user interface (UI) in the language and regional settings assigned to them
in their locale policy. The locale policy is assigned in the People Editor.

Note: Users can change their locale profile by clicking one of the options on the logon screen. The new
locale profile is valid only during the logon session.

Use Locale Policies (Setup > System Configuration > Locale Policy) to view and manage the sample
locale policies, which are installed during system installation. Sample locale policies appear for the
languages supported in Workforce Central.

Note: If you do not see sample policies the first time you open Locale Policies, select the All or Inactive
filter. Make each of the policies you plan to use active.

On the Locale Policies page you can:

l View the sample locale policies in the system.
l Make policies active if you plan to use them. (Policies are inactive by default.) If you want to activate
a policy at a later time, select Filter > Inactive to view the Inactive policies.
l Clear the Display on Logon Page check box if you do not want a language to be available when users
log on.
l Select a policy, change its Order Number, and then click Save. The order number controls the order in
which languages appear on the Logon page.
l Select a policy, and then click Duplicate or Edit to modify it.
 Notes
l Kronos recommends that you do not delete sample locale policies. If you do not need a particular
policy, make it Inactive.
l Assign Locale policies on the Access Profiles page of the People Editor. (Select Setup > Common
Setup > New Person > Job Assignment > Access Profiles, or select a user in the timecard or a
Genie, then select People.) Users can override this assignment by selecting another language on the
logon page.
l The system loads the logon user’s settings if the user has a locale policy assigned. Otherwise, the
system loads the settings from the Locale tab in System Settings, or the settings for the language
selected on the Logon page.
l The settings from a language chosen on the Logon page apply only during the user’s logon session.
When the user logs out, the settings are lost.
l If the language is set to something other than English, but your web browser’s language is English,
the logon page will appear in English. However, after you log on, the non-English language appears
throughout the UI. Unless the user you logon with has a Locale Policy assigned to them in the people
record, you must select a language on the Logon page.

230
Locale Policy Editor
Use the Locale Policy Editor to add or duplicate and modify the details of a locale policy. You can also
modify locale policies with APIs.

Note: If you add or duplicate a locale policy, the name and display name of the new policy must be
unique.

In addition to the name and description, locale policies include the following information. Click Legend for
formatting information.

Display on Login Select to have the language available for selection on the Logon page.
Page
Display Name The language name that appears on the Logon page. This name must be
unique among the locale policies.
Language The language for the policy. Only supported languages appear in the
Language drop-down.
Country The country for the policy.
Long Date Format The display format for the long date. The system shows the current date in the
specified format. Formats include:
M/dd/yyyy = 7/05/2011
MM/dd/yyyy = 07/05/2011
M/d/yyyy = 7/5/2011
d/MM/yyyy = 5/07/2011
dd/MM/yyyy = 05/07/2011
d/M/yyyy = 5/7/2011
Short Date The display format for the short date. The system shows the current date in the
Format specified format. Formats include:
E M/dd = Tue 7/05
E MM/dd = Tue 07/05
EEEE MM/dd = Tuesday 07/05
E M/d = Tue 7/5
EEEE M/d = Tuesday 7/5

231
 EEEE M/dd = Tuesday 7/05
E dd/MM = Tue 05/07
E dd/M = Tue 05/7
EEEE dd/MM = Tuesday 05/07
E d/M = Tue 5/7
E d/MM = Tue 5/07
EEEE d/M = Tuesday 5/7
Es represent the day of the week. Use one E to display the abbreviated name
(Wed) and EEEE to display the full name (Wednesday).
Day Month The format for day/month display. For example, MM/d, which displays as
Format 09/29, or dd/MM which displays as 29/09.
Success Indicator The format of the Timestamp server. When a user performs a successful
Time Format punch, the date is displayed in this format. For example, a Recorded Time
message with the time 11:15 AM has the following format:
h:mma
Click Legend for additional formatting information.
Server Date The format used whenever the server date is part of the displayed date.
Format In Process Administrator setup, this is the format displayed in the Start Date
and End Date columns on the Process Detail tab in the Process Administrator
window (Setup > Process Management > Process Administrator).
For example, to display the server date as Wednesday, September 21, 2011,
enter the following format in the Server Date Format field:
EEEE, MMMM dd.yyyy
Click Legend for additional formatting information.
Timeclock Time The format in which time appears on devices. Unlike users, device time
Format formats cannot be assigned through Display Preferences.
Click Legend for formatting information.

Data Integration
When Integration Manager is installed on your system, the following Data Integration fields appear in the
Locale Policy Editor:

Long Date Format The date format MM/dd/yyyy (month, day, and all four
- numbers of the year) that will be used by the system for
data integration operations.

232
 For example: 04/30/2008.
Short Date Format The time format HH:mm (hours and minutes) that will be
used by the system for data integration operations. This is
the default.
For example: 10:15.
Long Time Format The time format HH:mm:ss (hours, minutes, and
seconds) that will be used by the system for data
integration operations.
For example: 10:15:25.
Short Time Format The time format HH:mm (hours and minutes) that will be
used by the system for data integration operations. This is
the default.
For example: 10:15.
Time AM The A.M. time format that will be used by the system for
data integration operations. The default is am.
Time PM The P.M. time format that will be used by the system for
data integration operations. The default is pm.
Data Separator The symbol that will be used to separate the elements of
a date format. The default is a slash ( / ).
For example: 04/30/08.
Time Separator The symbol that will be used to separate the elements of
a time format. The default is a colon ( : ).
For example: 10:15.
Decimal Separator The symbol that will be used as decimal separator for
data integration formatted numeric output. The default is
a period (.).
For example: 829.99
Group Separator The symbol that will be used as group separator for data
integration formatted numeric output. The default is a
comma (,).
For example: 28,982,999
Negative Number The format to be used by the system for all data
Format integration formatting for negative numbers. The default
is -1.1
For example: -889.78

233
 Note: The default values for these fields are specified on the Data Integration tab in System Settings
during system configuration.
If you enter values for the fields in the Locale Policy Editor, the values you enter will override the Data
Integration system settings for any interface that uses this locale policy.
Before you enter values in the Locale Policy Editor, check the settings on the Data Integration tab. You
might not want to change them.

234
Multiple languages on a single instance (MLSI)
MLSI supports multiple languages, locales, and date formats in a single instance of Workforce Central.
MLSI implementation includes:
l Defaults determined by using the java defaults for language and country.
l Support for multiple languages and regional settings on a single data collection device with Smart
View.
l Locale policies that contain languages, countries, date formats, and display names. A default locale
policy is available for each language installed. You can add, delete, or modify locale policies in the
Locale Policy Editor. You can also edit locale policies with an API.
l Assigning locale policies in the People Editor (Job Assignment > Access Profiles) or by using an API.
Notes
l The user’s assigned language setting overrides the instance language setting.
l Users can select a language from links on the logon page. The selection overrides the logon page,
which defaults to the browser settings. The language change only applies to the session.
l For Quick Time Stamp users, the system overrides the locale policy assigned to the user. The system
selects the language to display in the following order: browser setting, instance default, and the first
language in the list of active locale policies.
l Language selections are tied to a date format, so that users do not have to configure a date format
separately for the session if they select a different language when they log on. The language change
applies only to the session.
l Online Help is displayed in the user’s language, unless the locale policy uses a language for which
Help was not translated.
l Reports use the logged on user’s language setting instead of the instance language setting.
l Reports can run on any instance with any language setting. The Report Run Status indicates the
language.
l System Administrators can assign a locale profile to each Smart View on a data collection device.
The locale settings remain in effect for the Smart View at all times until it is reconfigured with a
different locale. To use this feature the device must have support for the chosen language.
l Transaction data displays according to the user's locale policy. For example, if the user's locale
policy is Spanish, the transaction data appears in Spanish. If another user's locale policy is French,
their transaction data appears in French and so on. Both of these transactions can be viewed in the
Transaction Assistant but will appear in the languages of the user's locale policy.
l Users can use the Translation Support feature to have configured data, such as pay codes and accrual
codes, translated into the supported languages or languages added through the Translation
Customization Tool.

235
236
Chapter 10

Global text

Use Global Text to specify values for global properties, such as security questions. Global text was
designed to support MLSI (Multiple Language Single Instance). The system uses values stored in the
database rather than values entered in system settings, which are instance-specific.
For example, security questions entered in Global Text can be retrieved from the database, translated, and
then displayed in the language in a user’s locale policy. In prior releases, security questions could be
displayed in the instance language only.
Create global text
To create global text:
1. Select Setup > System Configuration > Global Text.
2. Select the Category.
3. Enter the appropriate text.
4. Click Save.

238
Translate global text
Use the Translation Support feature to have global text translated;
A Global Text check box has been added on the Export tab on the Translation Support page. For
information about using Translation Support, see the online Help.

239
240
Chapter 10

Translation support

Translation Support enables you to extend the translations in language packs. Language packs, in general,
provide translation of application pages and system data. Translation Support enables you to translate
certain data that you created during setup.
Use the Translation Support page (Setup > System Configuration > Translation Support) to select
configured data to be translated. You can translate the names and, in some cases abbreviations, in the
following entities:
l Accrual codes
l Bonus/Deduction rules
l Break rules
l Comments
l Global Text
l Holidays
l Workflow Notifications
l Pay codes
l Widgets
l Widget Parts
l Work rules
l Workspaces

Important: When translating content such as Workflow Notifications, the custom tag text should never
be copied from the User Interface for translation. Instead, use the custom tag text in the “Original
Message” column of the .xls translation file, ensuring that the text is entered exactly as it is found.
 The default, or base language is typically English, but can be any language installed on the Workforce
Central application server. You can export the setup data to an Excel file, and send the file to a vendor for
translation or have the translation done in-house. Following translation, import the file into Workforce
Central with the translated values. The system creates a separate spreadsheet for each language.
Example
The base language on the system is French.
All entity columns are exported for translation to English, Spanish, and Chinese using three separate Excel
spreadsheets; one for each language.
When the spreadsheets are returned, import the translated data from each spreadsheet.
Users can then log on using a locale profile specific to one of the available languages; French, English,
Spanish, or Chinese.
When users log on to the system using the Spanish locale profile, they see pay code names or other
translated data in the Timecard or Genies in Spanish. Names that were not translated appear in the base
language.
Use the Export tab on page 243 to specify languages, countries, and entities to be translated. Use the
Import tab on page 244 to select the file names of data to be imported.

242
Export tab
Setup > System Configuration > Translation Support
The Export tab is active when you open the Translation Support page.
On the Export tab, you can:
l Select the language to which you want the setup data translated. The data is translated from the default
language on your system.
l Select a country to make the translation specific to a country when there are variants in the language.
Examples
Selecting Chinese might not be adequate for use in Hong Kong, Taiwan, and China. Hong Kong and
Taiwan identify the translation as Traditional Chinese, where China identifies it as Simplified Chinese.
You must specify the country to create the correct Chinese translation.

Note: There will be no Chinese translations of configured data, Traditional or Simplified until you
create them using the Translation Support feature.

If you have a language pack installed for the French translations for Canada, you might want to have a
different translation for a French word in France. You can select the language French and the country
France to create a translation specific to France in French.

Notes:
There will be no French translations of configured data, Canadian or otherwise, until you create them
using the Translation Support feature.
You can import French translations that apply to all French locales using French as a language and
not selecting a country when you create the export file.
You can import translations that vary locally using French as a language and specifying the particular
country.
Locales for the same language are separate. Translations imported as Canadian French are not see by
a user who logs on as France French. The only exception is Taiwan Chinese, which falls back to
Hong Kong Chinese.

l Select one or more entity types to be translated. To select all types, click the check box next to Entity
Type.
l Click Export to create the Excel spreadsheet that contains the data to be translated. In the File
Download dialog box, you can open the file, save the file, or cancel the transaction.
l To start again, click Refresh.

243
Import tab
After the data on the exported Excel spreadsheet has been translated, use the Import tab to import it into
the system.

Notes
Any item that is not translated is not added to the translation database during an import.
When imported translations are displayed, a localized translation takes precedence over a translation of
the same language that does not have a country selected. If neither has been imported, the base language
appears

On the Import tab, click Browse to find the appropriate Excel spreadsheet, and then click Import.

Notes
For best results, import the file that was created during the export function.
Modify only the translated text column after an import.

244
Chapter 11

Batch Action Sets

A batch processor filter allows you to configure the batch processing framework so that background
processor instances can be designated to run specified batch action types (Auto-Scheduler, Group Edits,
Tokes).
You can:
l Group one or more batch action types into batch action sets.
l Assign the batch action sets to specific application instances so that the user can control which
application instance can process which types of batch action requests.
l View the Batch Jobs List and Batch Items List to see what is in the queue and what application
instances are processing which batch jobs.
l Set a system setting on the Batch Service tab that controls the number of threads on each application
instance (0 –16):
site.BatchService.ThreadPoolMaxSize
System-supplied Batch Action Sets
Batch Action Sets are made up of batch action types. They determine which batch action types can be
processed on which application instances. Four batch action sets come with the system:
l Empty — Contains no batch actions
l All — Contains all batch actions

l Device Manager — Contains the three Device Manager batch actions

l Integration Manager — Contains the Integration Manager batch action

l TeleTime IP — Contains the TeleTime IP batch action

You can also create your own batch action sets.

Note: You cannot modify the batch actions selected for the batch actions sets that are provided with this
enhancement.

One batch action set is designated as the default. It remains the default until you select another default.
The default is automatically assigned to an application instance when a new application instance is added
to the system. The default stays in effect until you create an assignment in the Batch Controller for that
application instance. Resetting the assignment reinstates the default.
The Batch Action Sets window lists the existing batch action sets. The default batch action set is selected
in the Default column.
To create or modify a batch action set, select Setup > System Configuration > Batch Action Sets.
To create a new batch action set, click New.
To modify an existing batch action set, select the set and click Edit.
The Batch Action Set Editor appears.

246
Batch Action Set editor
To create or modify a batch action set:
1. Select Setup > System Configuration >Batch Action Sets
2. Do one of the following:
o To create a new batch action set, click New.
o To modify an existing batch action set, select the set and click Edit.

3. Enter a Name and an optional Description for the batch action set.
4. If you want this to be the default batch action set to which any new application instance is assigned,
select Default. Note that the batch controller excludes the batch action types in the default set (see
Batch Controller Editor).
5. Use the arrow key [>] to move the selected batch action types to include in your batch action set from
the Available list to Selected list.
6. Use [<] to remove selected batch action types from the Selected list.
7. When the list is complete, click Save & Return.

Batch Controller
Use this function to
l Change the batch action set assignment for an application instance
l Select whether action types in the batch action sets are Excluded or Included from processing on the

application instance. By default, batch action types in the default batch action set are excluded.
To modify a batch action set assignment, select Setup > System Configuration > Batch Controller.
The Batch Controller Configuration page displays a list of current Application Server Hostnames and the
following columns:
l Instance — The application instance name. All application instances are listed.
l Selection Mode — Indicates whether jobs listed in the batch action sets are either
l Excluded — Batch action types listed in the batch action set will not be processed by the application
instance.

Note: If you exclude the Empty Batch Action Set, all batch action types are processed. In other
words, you are excluding nothing.

l Included — Batch action types listed in the batch action set are processed by the application instance.

247
 Note: If you include the Empty Batch Action Set, no batch action types are processed. In other
words, you are including nothing.

l Selected Batch Action Sets — Batch action sets assigned to the application instance.
Do one of the following:
l To modify a batch controller, double click the Application Instance Hostname you want.
l To create a new batch controller, click New.

The Batch Controller Editor appears.

Batch Controller Editor

To create or modify a batch action set assignment:
1. Select Setup > System Configuration > Batch Controller. Double click the Application Instance
Hostname you want.
2. You can change the Selection Mode:
oExcluded — Batch action types listed in the Selected batch action sets are not processed by the
application instance.
o Included — Batch action types listed in the Selected batch action sets are processed by the
application instance.
3. Use [>] and [<] to add or remove batch action sets from the Selected area.
4. Optionally, to return the application instance to the default batch action set, click Reset.
5. Click Save & Return.

Batch Job List

In the Batch Job List, all application instances are included for the Launch Date that you select. You can
narrow the list by processing Status and Launch Date. By default, the Status is waiting.
Each batch work request is displayed as a row.
Information displays in the following columns:
l Batch Job — Batch task name
l Launch Date and Time — Date and time on which the request was made
l Start Date and Time — Actual date and time on which the request started
l End Date and Time — Actual date and time on which the request completes running
l User Account Name — ID of the account under which the batch was submitted
l Server List — Name of the server that most recently attempted to run the batch
l Priority — Lowest, Low, Medium, High, Highest
l Status — Waiting, In Process, Success, Failure, Retry

248
 l Total Tasks — Total number of tasks in the job
l Successful Tasks — Total number of tasks that completed without issues
l Failed Tasks — Total number of tasks that did not complete

Batch Item List

Batch items are the smallest unit of the job; for example, in a Group Edit, the employee is the batch item.
In the Batch Item List, the specific items in the batch job are listed with the name of the application
instance on which they were run. When there are more than one Action Type, the Order Number column
shows the order in which they were processed.
Click an item on the Batch Job List to see the list of items.
Information displays in the following columns:
l Batch Item — Specific item processed in the batch job
l Action Type — Type of action being performed
l Order Number — Order of the batch item in the process
l Start Date and Time — Actual date and time at which the batch item started
l End date and Time — Actual date and time at which the batch item completed
l Server — Name of the server that is processing the item
l Resource Rating — Part of the calculation for the number of concurrent batch item processors. The
Resource Rating score is calculated as
100/Maximum number of concurrent batch items = Resource rating
l Retry Count — Number of times that processing this action type has been attempted; 1 is the
minimum for a successful run
l Status — Waiting, In Process, Success, Failure, Retry
l Error Text — Latest known error for the batch action type

249
250
Chapter 12

Configure Feature Switch

The “Feature Switch” capability enables administrators to enable or disable certain features introduced in
service releases.

Prerequisite
By default, access to the Feature Switch capability is not enabled. To enable the Feature Switch capability
for specific people, you must modify their Function Access Profile:
1. Select Setup > Access Profiles > Function Access Profiles.
2. Select the applicable Function Access Profile and click Edit.
3. Expand Workforce Manager - System Configuration.
4. Expand Setup and locate Feature Switch Configuration.
5. Depending on your requirements, change the View column to Allowed, change Edit column to
Allowed, or change both columns.
6. Click Save & Return.

Use “Feature Switch”

Administrators with the necessary Function Access Profile can enable or disable certain features:
1. Select Setup > System Configuration > Feature Switches. The features that can be enabled are
displayed with the following information:
o Name
o Description
o Version — The service release version that introduced the feature.
o Tracking Issue — Issue number.
o Is Enabled — By default, all features are set to false.
 2. To enable a feature:
a. Select the feature and click Edit.
b. Select the Is Enabled check box and click Save.
3. If you later decide to disable the feature:
a. Select the feature and click Edit.
b. Clear the Is Enabled check box, click Save, and then click Return.

252
Chapter 13

Reports

Workforce Central provides integrated reporting capabilities that enable you to complete a number of tasks
that are not available with other reporting tools:
l Use the Event Manager component to schedule a report to run at a specific time or at specified
intervals.
l Send your completed report instance to a printer, your browser, or to an e-mail recipient from within

the application.
l Use the HyperFind query to select people or the location chooser to select locations for a report.

l Browse the report instance online.

l Determine who can access specific information, such as wages data, within a report.

l Include the most current totalized data from the database.

Reports are generated from the reports selection tab (Select Report) in the Reporting workspace. The
interface uses standard RDL files and a built-in Report Viewer control to generate reports. It requires no
additional installation or configuration.
Reporting requires a Windows companion server when used in a UNIX or Linux environment.
Terminology
The following terms are used in connection with reports:

Term Description
Background options or Options that control how information appears in the report header. You can set
parameters 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.
Companion server When the system is used in a UNIX/Linux environment, it requires one
Windows companion server.
Custom options Non-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.
Foreground options or Choices that are selected when users request a report in the Reports
parameters component. These options are established in the report definition file and in the
Report Setup component.
Options Settings that indicate viewable items or report selection criteria.
Option or parameter A selectable value for an option or a parameter. For example, if the option or
choice parameter is Absences, then the choices are Unexcused, Excused, or Both.
Report The combination of a report item and a report definition.
Report definition An RDL file that, with a report item, creates a report.
Report instance Generated by the system when a user requests a report.
Report item An object in the database that specifies the report name, options, and other
information, and provides a link to the RDL file.

254
Reports setup for totalization
When the system calculates totals for some reports, the following properties are involved:
l site.reporting.totalization.interval — A report that requires totals is placed in a queue. If totalization
for all the employees selected for that instance of a report is not completed during the first Totalizer
session, the report is returned to the queue. The value that you specify here is the number of seconds
that the report waits in the queue. After the time has elapsed, the reports server checks for the
totalization results again.
l site.reporting.totalization.retries — The value that you specify here determines the maximum
number of times that a reports server checks for the totalization results.
l 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 selected for that instance of a report have not been calculated, the values of
these properties determine how the system handles the report:
o 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
employees whose totals are still not up to date.
o 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 employees that are not up to date, but simply contains a
count of them.
o 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.

255
Export reports to Microsoft Excel
The system is delivered with a number of reports that are optimized for exporting to Microsoft Excel.
Reports optimized for Excel appear in the Report Selection Tree with “Excel” appended to the report
name.
Depending on how a report definition file is written, some of the data does not export, and instead displays
one of the following messages in the Excel output: “Subreports within table/matrix
cells are ignored” or “Data Regions within table/matrix cells are
ignored”. Therefore, by default, the ability to export to Excel is blocked for reports that will not export
completely to or are not optimized for Excel. The default list of reports that cannot be exported to Excel is
stored in the following directory on the Workforce Central application server:
Installation_directory\wfc\reporting\WFCExcelReports.txt
You can block your custom reports from exporting to Excel by using a custom Excel blocking file named
custom_wfcExcelReports.txt.
To use the custom Excel blocking file for standard reporting, add the names of your customized reports to
custom_wfcExcelReports.txt by following the steps below.
1. Navigate to the directory on the system where Workforce Central is installed; for example:
Installation_directory\wfc\reporting
2. Create custom_WFCExcelReports.txt.
3. If you want to block the Excel export of your custom report, add the names of the reports that you have
customized to custom_WFCExcelReports.txt.
4. If you have multiple instances of Workforce Central, follow this procedure for each instance or copy
the file to the same location on each instance.
5. Restart Workforce Central.

256
Install fonts for Activities reports
Some Activities reports require the Code 39 Barcode font. This font must be installed on both server and
client machines.

257
Manage reporting environments
Reporting uses Report Definition Language (RDL) formatted files. When a report is selected to be run, the
Kronos.Reporting.ProduceRDLC2010Report.exe process executes the report. Report
processing occurs on an application server that is configured as a reporting server. There is no additional
server installation or configuration required.

Reports servers
The process that the system uses to generate a report depends on your selection in the Reports user
interface:
When you run a report for viewing only, the request is handled by the reports engine of the instance into
which you are logged, if the instance supports reports; otherwise, the request is handled by the appropriate
reporting server.
When you print, e-mail, or schedule a report, Event Manager processes the request. Event Manager
searches for a list of available report servers, chooses an instance at random, and submits the report
request to that report server as an HTTP/XML request.
When you run many reports for viewing only, you can improve system performance by creating one or
more instances that are dedicated to generating reports. You make this improvement by disabling the report
service on the primary instance that handles user authentication, and enabling the report service on the
instance where you want to run reports:
1. Log on to the primary instance or the instance from which you want to run reports.
2. Select Setup > System Configuration > System Settings > Reports.
3. On the site.reporting.engine.enable key, click true or false according to the type of
server that you are setting up. For example, click true if you are setting up a dedicated reports server.

Note: The site.reporting.engine.enable setting is not available in UNIX/Linux

environments.

If you disable the reports service on the primary instance and enable it on one report instance only, the
primary instance directs all requests to run reports to the report instance.
If you set up more than one report instance, the primary instance gives every report instance an equal
opportunity of receiving report requests by doing the following:
l When an instance starts, it registers itself in the database. The instance is added to a list of instances in
the ServerInfo service, and the report instance receives that list of instances via the ServerInfo service.
l When you run a report for viewing only, the request goes to the instance to which you are logged on.
o If the instance’s report engine is enabled, it generates the report.
o If the report engine is disabled, the report request is passed to another instance.

258
 When a report request has to go to another instance, the request searches the list of instances in the
ServerInfo service and sends the report request to the first report instance on the list. If that instance is not
online, the request goes to the next instance in the list.
Subsequent report requests go to the next available report instance on the list, and the process continues
until all report instances have run a report. Two consecutive reports do not go to the same report instance,
unless it is the only report instance.
When a user makes a request to view a report, the system automatically copies the report to the instance
that initiated the request. Therefore, the user can log on to any instance to see the completed report, which
always appears to reside on the local instance.

UNIX/Linux environments
The reporting engine is disabled by default in UNIX/Linux environments. All reports for a UNIX/Linux
instance are forwarded to a required Windows companion server that is configured as a report server.
The Report system settings for Windows are not available in UNIX/Linux environments.

Queue performance considerations

A number of properties that you can set in the Reports tab affect how quickly reports can be completed and
removed from the queue. Factors that affect the server’s throughput include:
l site.reporting.MaxNumRepAgents — The number of agents that you can specify. Each agent
represents a separate thread. If you have a long-running report and a single agent, you block other
reports that are waiting to be processed. However, each agent incurs overhead, and too many agents
can adversely affect the performance of the server.
l site.reporting.totalization.retries — The number of times that a report waits for the Totalizer
application to update the employee's totals before the report runs. The more retries that you allow, the
longer a report can remain in a queue.

Report logs
By default, a reports log is generated for each agent that you specify in the following property in the
System Settings Reports tab: site.reporting.MaxNumRepAgents.
The location of reporting log files is determined by the following property:
site.reporting.executable.log.
The system names each log file WFCReportinglogn.log, where n represents an agent. For example,
if you specify the following, you have two log files named WFCRportinglog0.log and
WFCRportinglog1.log:
site.reporting.MaxNumRepAgents = 2
Each log file has a default size of 100KB, which you can change by following these instructions:

259
 1. Go to: C:\Kronos\instance_
name\reporting\Kronos.Reporting.ProduceRDLCReport.exe.config:
2. Change the log size value from:
<add key= "log size" value="102400" />
to:
<add key= "log size" value="10485760" />

260
Customize reports
The instructions for customizing a report depend on the type of report file you are customizing. This section
contains instructions for customizing RDL reports.
If you are creating a new report definition file without a template, use the RDL format and customization
instructions.
To customize report definition language (RDL) files and prepare them to run:
1. Create an RDL file by copying and renaming an existing RDL report or creating a new one in
Microsoft Visual Studio. Refer to Create an RDL on page 262 for more information.
2. Modify the RDL file in accordance with instructions found in the section Modify the RDL file on page
263.
3. Save the custom RDL file to installation_directory\instance_
name\reports\otherReports2008. Remember to copy the file to all the application servers.
4. In the Report Setup component, create a report item that references the RDL file. Refer to the online
Help for more information.
Note: 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, because it is unavailable.)
Standard or other views or tables may be combined with the original accelerated report views. However,
since this additional information is not an accelerated view, report performance could be affected.
Multiple accelerated views used on different reports cannot be combined into one accelerated report.

5. Give users access to the custom report by modifying Data Access Profiles. Refer to Give users access
to a custom report on page 265 for more information.
To complete these steps, you need:
l Access to Microsoft Visual Studio 2008 with Service Pack 1 or later installed to modify the RDL file.
l Any custom report developed on Visual Studio 2008 (RDL 2008) requires RDLC 2010.
l An understanding of the tables and views in the database. For detailed information, see the Database
Tables Reference Guide and the Database Views Reference Guide for this product. A Kronos service
resource can also help you to prepare custom reports. Please contact your sales representative for more
information.
l The ability to write to the following directory on the application server:
installation_directory\instance_name\reports\OtherReports2008
l Access to the Report Setup component.

Note: This access is granted in your Function Access Profile under Workforce Manager -
Department Manager > Reports > Report Setup > Report Setup Access.

l Access to Data Access Profiles to assign the report item to the appropriate Data Access Profile.

261
 Set up Visual Studio to create Workforce Central reports

Note: Ensure that the Visual Studio is running with administrative permissions.
To run Visual Studio with administrative permissions on Windows 7 or Windows Server 2008 R2
1. On the Start menu, choose All Programs.
2. In the Microsoft Visual Studio 2008 folder select Microsoft Visual Studio 2008, open the shortcut
menu, and then choose Run as administrator.
When Visual Studio starts, (Administrator) appears after the product name in the title bar.

Before you can run Workforce Central custom RDL report files in Visual Studio, the Visual Studio
environment must be set up with the following steps:
Working with custom RDL report files requires the installation of the following products:

Workforce Central with RDLC 2010

Business Intelligence Development Studio (which is fully integrated with the Microsoft Visual Studio 2008
development environment) with Service Pack 1, from the Microsoft SQL Server 2008 Express Edition
Toolkit or installed from the SQL Server 2008 CD.

Note: Users can create custom reports for both 2005 and 2008/2010 RDL formats. However, users
are encouraged to switch to the 2008/2010 RDL format because Microsoft no longer officially
supports 2005 report format.

Create an RDL
There are two ways to create a custom RDL file:
l You can duplicate an existing file by opening the file in Microsoft Visual Studio and saving the file
with a new name.
l You can create a new file in Microsoft Visual Studio.

Note: You must assign unique file names to custom reports. The name cannot be the same as any other
custom or standard report.

Working with custom RDL files requires the installation of the following product:
l Microsoft Visual Studio 2008 with Service Pack 1, and SQL Server 2008 SP1, as well as Business
Intelligence Development Studio for SSRS 2008

Duplicating an existing RDL

Duplicating an existing report definition file is the easiest way to create a custom report. When you
duplicate a report, you can use as much of the original report design as needed. For example, you can
change only a single field or edit a single heading in the report.

262
 The standard report definitions files are installed in a Reports directory that is associated with each
application area. To duplicate a file, open it in Microsoft Visual Studio and save the file with a new name.

Creating a new RDL file

Creating a new report file involves more knowledge of RDL and the database tables and views. However,
you may find it easier to create a new file if the report you are creating is unlike any of the standard
reports that are provided.

Modify the RDL file

1. Refer to the following instructions when working with reports in Microsoft Visual Studio.
2. Add the report to a Report Server Project in Microsoft Visual Studio.
3. Define the following shared data sources for the project:
The database: The shared data source from which reports retrieve data.
Name: kronos or ReportingDataSource
Type: Microsoft SQL Server or Oracle
Connection Properties: Enter the name or net service name (for Oracle) of the database server and
the appropriate logon information.

Note: When connecting to SQL Server 2012 or 2014, ensure that data provider .Net Framework
Data Provider for OLE DB is selected, as shown in the following screen capture.

4. Modify the datasets used by the report for your requirements.

Datasets called by “kronos” or “ReportingDatasource” generally return system data shown on the
report output.

263
 Note: If you are creating a report, rather than modifying an existing report, refer to an existing report
definition file to learn about the construction of these datasets.

Refer to the following requirements and best practices when modifying RDL files:
l All custom functions are implemented in a custom assembly, using C# as the programming language.
The name of the assembly is Kronos.Reporting.RDLUtilities.dll.
l To test and use functions from Kronos.Reporting.RDLUtilities.dll while writing custom
reports, copy the .dll from installation_directory\reporting to Program
Files\Microsoft Visual Studio 8\Common7\IDE\PublicAssemblies.
l Labels on reports can either be text that is specific to one language or they can be externalized to use
the system's localization capabilities. To externalize labels, use the label localization function, which is
contained in the Kronos.Reporting.RDLUtilities assembly. The signature of the function is
Kronos.Workforce.CommonApp.Reporting.
Framework.Utils.RDLUtilities.Localization.GetLocalizedLabel (String
key, String culture).
l Sub-reports should use the following file naming convention: ReportName_subreportname_
subreport.rdl
where subreportname is any readable string that explains the function of the sub-report.
l A parameter should be marked as “internal” if its value is not passed to the report, but supplied from
within the RDL itself.
l Conditional expressions in SQL statements are not supported. Conditional expressions in dataset
formulas are supported.
l Cascading parameters are not supported. For example, the selected value from one parameter cannot
impact possible selections for a sub-parameter, as in the case of selecting from a list of cities contained
within a selected country or state.

Create custom report options

You can create custom report options, in addition to the standard options, on custom reports. Custom report
options allow you to pass additional data or selection criteria to a custom report.

Note: Along with an understanding of the database tables and views, creating custom report options
requires that you know how to create parameters within Microsoft Visual Studio. Report parameters in
Microsoft Visual Studio correspond to report options on the application server.

To add a custom option:

1. In Microsoft Visual Studio, open the appropriate report.
2. Add the custom option to the report as a Report Parameter.
Reports supports the following data types for custom reports: String, Integer, and DateTime.
Indicate whether the report can support multiple values in the Multi-value check box.

264
 Set Available values to Non-queried and Default values to Null. You will populate available values in
the user interface.
3. In Report Setup on the application server, configure a custom option that has the exact same name and
properties as the custom parameter you created in Microsoft Visual Studio.

Give users access to a custom report

Decide which users you want to access the report, and then add the report item to the appropriate Report
Data Access Profiles under Setup > Access Profiles > Data Access Profiles > Reports.

Note: A Report Data Access Profile may not be available immediately to assign to a user’s profile after
it is created. If this occurs, log out of Workforce Central and log in to use the newly-created Report Data
Access Profile.

Report options
Report options allow you to pass data into a report file. Some reports use different options than others.
Identify the report options that are needed for a report by viewing the report in the Report Setup
component. If you are creating a new report, you must at least add the standard options to the report
definition file. Report options are specified as parameters in the report definition file.
When you generate a report instance, you can select foreground option values, but not background option
values. Background options are used to display foreground option values, to pass a formatting control value
to a report, or for use in calculations. Selected options for a report item must also be configured on the
Reports definition file using Microsoft Visual Studio.
Many of the report options are defined with the reports that include them. See the Reports online Help for
most option descriptions. The following subsections also describe some of the report options.

Standard options
The following table describes the standard options. Some enable user selections; others control data display
or report behavior:

Background or
Option Name Description Foreground
Absences Select Unexcused Only, Excused Only, Both or None F
Absences Heading Displays the selected Absence types B
Actions Select Actions F
Actions Heading Displays the selected choice B
Activity Complete Select Cancelled, Complete, Incomplete, Not Started F
Status

265
 Background or
Option Name Description Foreground
Activity Complete Displays the selected Completion Status B
Status hd
Activity Date Select Date range for selected date type F
Activity Date hd Displays the selected Activity Date range B
Activity Held Status Select Never Held or Released, On Hold, Released, or F
any combination.
Activity Held Status hd Displays the selected Held Status B
Activity Page Break Select No or Yes to page break on each Activity F
Activity Page Break hd Displays the Selected Page Break Choice B
Activity Runtime Value Contains a list of common label values used by Activity B
Reports pulled from the translatable files.
Activity Team Passes list of selected Activity Cells F
Activity Team hd Displays the selected Activity Cells B
Actual/Adjusted Select Actual or adjusted amounts F
Actual/Adjusted Displays the selected Actual/Adjusted choice B
Heading
Additional Trans Info Select to display Additional Transaction Information: No F
or Yes
Additional Trans Info hd Displays the Additional Transaction Selection B
Adjustments and Select one, multiple, or all Adjustments and Markers F
Markers
Adjustments and Displays the selected Adjustments and Markers B
Markers hd
Audit Action Select Add, Edit and/or Delete F
Audit Action Heading Displays the selected choice of Audit Action B
Audit Types Select Audit Types Add, Edit Delete and/or F
Add/Edit/Delete Duration, Punch, or Pay code
Audit Types Heading Displays the selected Audit Type choice B
Building Block Type Select Adjustment Rules, Bonuses/ Deductions, Breaks, F
Call-Ins, Combination Rules, Combined Pay Codes,
Contributing Pay Codes, Contributing Shifts, Core Hours,
Currency Policy, Display Order, Exceptions, Fixed Rules,
Holiday Credit Rules, Holiday Profiles, Holiday Table,
Interval Round Rules, Majorities, Overtimes, Pay Code

266
 Background or
Option Name Description Foreground
Distributions, Pay Codes, Pay Rules, Processing Order,
Punch Interpretation Rule, Punch Round Rules, Schedule
Deviations, Scheduled Hours Type, Shift Guarantees,
Sign-Off Restrictions, Time Zone Rules, Tip Compliance
Rules, Toke Pool Rules, Work History Qualifiers, Work
Rules, or Zones
Building Block Type Displays the selected Building Block Type choice B
Heading
Calculated Balances Select one, multiple, or all Calculated Balances F
Calculated Balances hd Displays the selected Calculated Balances B
Combined Events Select one, multiple, or all Combined Events F
Combined Events hd Displays the selected Combined Event B
Coverage Details Select: F
Employee name, full or short.
The start time of the data for each day in the report.
The number of hours to report.
currency locale The currency format use to format the currency B
Customer Name Selects the Starting and Ending Names for Activity F
Customer Name for filtering
Data Sources Select All Datasource or Selected Datasource F
Data Sources Heading Displays the selected Data Sources choice B
daysindecimalformat Days formats dd:hh:mm or dd.dd B
db timezone Displays the timezone of the database server B
Decimal Format Formats time format to hh:mm or hh.hh B
Device Name Selects the Starting and Ending Names for Activity Device F
Name for filtering
Display Options Select: F
Employee name, full or short.
Schedule, current or posted.
Employees, all scheduled employees, all home employees,
or all employees.
Include, any of the following options: open shifts, wages,
breaks, full-day availability, or seniority.

267
 Background or
Option Name Description Foreground
Duration Select: F
The start time of the data for each day in the report.
The number of hours to report.
Edits by Managers Select One: All Edits or Selected by Selected managers F
Edits by Managers Selected Edits by Managers choice B
Heading
Employee Name Option Select Full or Short F
Employee Page Break Select No or Yes to page break on each employee F
Employee page break hd Displays the selected page break choice B
Employee Type Option Select All Scheduled Employees, All Home Employees, or F
All
Events Select one, multiple, or all events F
Events hd Displays the selected events B
Exceptions Select one, multiple, or all types of Exceptions F
Exceptions Heading Displays the selected Exception Types B
First Day of Week Select Default, Sunday, Monday, Tuesday, Wednesday, F
Thursday, Friday, or Saturday as the first day of week
From Time Period Passes starting date for timeframe selection F
Function Access Select one, multiple, or all function access profiles F
Profiles
Function Access Displays the function access profiles selected B
Profiles Heading
GMT Server Offset Returns the time difference, in seconds, between the B
timezones of the database server and the reporting server
Group By Activity Or Select what grouping by we use for the report: Activity or F
Customer Customer
Group By Employee Select what grouping by we use for the report: Employee, F
Team Cell, or Activity
Holiday Credit Type Select Credited, Denied, or both F
Holiday Credit Type Displays the selected Holiday Credit Types B
Heading
Import Batch Select one import batch or latest completed batch F
Import Batch Heading Displays the selected Import Batch B

268
 Background or
Option Name Description Foreground
Import Type Select one, multiple, or all Import Types F
Import Type Heading Displays the selected Import Types B
Include Indirect Select No or Yes to include Indirect Activities F
Include Indirect hd Displays the Include Indirect Choice B
Include Option A set of options of Open shifts, Wages, Breaks, F
Full-day Availability and Seniority
labor level count Displays the number of labor levels defined in the database B
Labor Level Entries Select Show Name and/or Show Description F
Labor Level Entries hd Display selected Labor Level Entries B
Lost Time Events Select one, multiple, or all Lost Time Events F
Lost Time Events hd Displays the selected Lost Time Events B
Max Daily Hours User entered hour number F
Max Night Hours User entered hour number F
Max Weekly Hours User entered hour number F
Not Updated Emp Count Passes count of employee/person IDs that are not up to B
Heading date
Not Updated Emp List Passes list of employee/person IDs that are not up to date B
Heading
Number Of Hours Select the number of hours to report, from 1 to 24 F
Number of Iterations Select default, 1, 2, 3, 4 or 5 iteration F
Org Job ID Passes list of organizational job IDs that are currently B
selected
Other Policy Select one, multiple, or all Other Policy Transactions F
Transactions
Other Policy Displays the selected Other Policy Transactions B
Transactions
hd
Page Break On Select No or Yes to page break on each customer F
Customer
Page Break On Displays the Selected Page Break Choice B
Customer hd
Page Break On Date Select No or Yes to page break on each date F
Page Break On Date hd Displays the Selected Page Break Choice B

269
 Background or
Option Name Description Foreground
Page Break On Select No or Yes to page break on each Employee F
Employee
Page Break On Displays the Selected Page Break Choice B
Employee hd
Page Break On Group Select No or Yes to page break on groups F
Page Break On Group Displays the Selected Page Break Choice B
hd
Page Break On Team Select No or Yes to page break on each Cell F
Page Break On Team hd Displays the Selected Page Break Choice B
Patterns Select one, multiple, or all Patterns F
Patterns hd Displays the selected Patterns B
Pay Codes Select one, multiple, or all pay codes F
Pay Codes Heading Displays the selected Pay Codes B
Points and Occurrences Select one, multiple, or all Points and Occurrences F
Points and Occurrences Displays the selected Points and Occurrences B
hd
Printed For Displays the user name who ran the report B
Query Name Displays Hyperfind Query name B
Report Content Select Default, All or Exception Only F
Request Time Heading Displays the time that all calculated totals are updated B
Rollup Hours By Multiple selection of IDs of Division, Department, Job, F
Cost Center, Product, Item Number, and/or Work Order
options
Rollup Hours By hd Display the selected options of Rollup Hours By B
Runtime Hours Displays the Hours Allocation value for an Activity B
Allocation Type
Runtime Input Source Displays the Input Source Value for Form B
Type
Runtime Mandatory Displays the Entry Type value for Form B
Type
Runtime Trans Field Displays the Field Type value for the Form B
Type
Runtime Trans Type Displays the Form type for the form B
Runtime Validation Displays the validation for the form B

270
 Background or
Option Name Description Foreground
Type
Schedule Select schedule, current or posted F
Schedule Option Select Current or Posted F
Schedule Zone Select a zone from the Schedule Zone drop-down list F
Session ID Pass the user's session ID B
Show Dates Select what Activity Dates to Show: Actual Completion, F
Actual Start, Revised Completion, Revised Start,
Scheduled Completion, Scheduled Start, or any
combination
Show Received Select to show Quantities Received F
Show Required Select to show Quantities Required F
Show Statuses Select what Activity Status to show: Completion, Held, or F
both
Start Time Select the start time of the data for each day in the report, F
from 12:00 AM to 11:00 PM
Time Balances Select one, multiple, or all Time Balances F
Time Balances hd Displays the selected Time Balances B
Time Period Heading Displays the timeframe selected B
Time Period Type Passes the selected timeframe type B
To Time Period Passes ending date for timeframe selection F
Top Activity Name Selects the Starting and Ending Names for Activities for F
filtering
Transactions by Policies Select one, multiple, or all Transactions by Policies F
Transactions by Policies Displays the selected Transactions by Policies B
hd
Transaction Code Selects the Form Codes that are part of the report F
Transaction Code hd Displays the selected Form Codes B
Transaction Date Select Effective Date or Created Date F
Transaction Date hd Displays the Transaction Date Selection B
Transaction Status Type Select Initial, Invalid, Completed, or Error Activity F
Transaction Status types, or any combination
Transaction Status Type Displays the Selected Transaction Status Type B
hd

271
 Background or
Option Name Description Foreground
Transaction Type Selects the Form Types that are part of the report. F
Transaction Type hd Displays the selected Form Types B
Wage Permission Determines if wages appear on report based on function B
access profiles
Weekly Rest Period Select Default, 7, 14 (One rest period) or 14 (Two rest F
period)s
Work Week Length Select default or 1, 2, 3, 4, 5, 6, or 7 days F
Workload Data Type Select any of the following options: Actual, Budgeted, F
Scheduled, Target, or Variance.

Report option attributes

The following table describes attributes from the previous table. The last column identifies all available
choices for an option and the internal values that the system passes for these option choices.
l An entry of the form name:number identifies a named choice and the internal code that represents it;
for example, Unexcused:0.
l 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.
l 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.
l 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/ Column
Discrete Typically Available Choice: Internal
Option Name Type Values Linked Value Passed
Absences Number Multiple Excusedsw Unexcused:0 Excused:1 Both:0,1
None: 3
Absences Heading String Discrete Unexcused, Excused, Both, None:
[--same]
Activity Complete Number Multiple Not Started: 0,
Status Incomplete: 1,
Complete: 2,
Cancelled: 3
Activity Complete String Multiple Not Started, Incomplete, Complete,
Status hd Cancelled [same]
Activity Date Datetime Discrete Selection Option followed by start

272
 Multiple/ Column
Discrete Typically Available Choice: Internal
Option Name Type Values Linked Value Passed
date & end date
<All>, Scheduled Start, Scheduled
Completion, Actual Start, Actual
Completion, Revised Start, Revised
Completion
Activity Date hd String Discrete
Activity Held Status Number Multiple Never Held or Released: 0
On Hold: 1
Released: 2
Activity Held Status String Multiple Never Held or Released, On Hold,
hd Released [same]
Activity Page Break Number Discrete No: 0
Yes: 1
Activity Page Break String Discrete No, Yes:[--same]
hd
Activity Runtime String Values are from property files and
Value can be customized there
Activity Team Number Multiple WFAUnit.wfaunitid
Activity Team hd String Multiple WFAUnit.unitnm
Actual/ Adjusted Number Discrete Actual:0 Adjusted:1
Actual/ Adjusted String Discrete Actual, Adjusted:[--same]
Heading
Additional Trans Info Number Discrete No: 0
Yes: 1
Additional Trans Info String Discrete No, Yes:[--same]
hd
Adjustments and String Multiple BC,BR,AM,IT
Markers
Adjustments and String Multiple Show user selected Adjustments
Markers hd and Markers
Audit Action Number Multiple Add:1, Edit:2, Delete:3
Audit Action Heading String Multiple Add, Edit, Delete
Audit Types Number Multiple Add Duration: -1/0/30/0/,-1//30/0/0,
-1/0/57/0/,-1/0/58/0/,-1/0/30/1/,
Edit Duration: -1/6/30/1/,-1/6/57/0/,

273
 Multiple/ Column
Discrete Typically Available Choice: Internal
Option Name Type Values Linked Value Passed
-1/6/30/0/,-1/0/58/0/,
Delete Duration: -1/5/58/1/,
-1/5/30/1/,-1/5/57/1/,
Duration (Add/Edit/Delete):
-1/5/58/1/,-1/6/30/1/,-1/0/30/0/,
-1/6/57/0/,-1//30/0/0,-1/5/30/1/,
-1/0/57/0/,-1/6/30/0,-1/0/58/0/,
-1/0/30/1/,-1/5/57/1/,
Add Punch: -1/0/-1/1/,-1/0/2/0/0,
-1/0/1/0/0,-1//4/0/0/,-1//-1/0/0,
-1//2/0/0/,-1/0/4/0/0,-1/0/-1/0/,
Edit Punch: -1/6/-1/0/,-1/6/-1/1/,
-1/6/2/0/0,-1/6/4/0/0,-1/0/40/0/,
Delete Punch: -1/5/-1/1/,-1/5/4/1/1,
-1/5/2/1/1,
Punch (Add/Edit/Delete): -1/0/-1/1/,
-1/6/2/0/0,-1/6/4/0/0,-1/0/40/0/,
-1/5/-1/1/,-1//-1/0/0,-1//4/0/0/,
-1//2/0/0/,-1/5/2/1/1,-1/6/-1/0/,
-1/6/-1/1/,-1/0/2/0/0,-1/0/1/0/0,
-1/5/4/1/1,-1/0/4/0/0,-1/0/-1/0/,
Audit Types Number Multiple Add Pay Code: 12/-1/-1/-,-1/0/55/0/,
(continued) -1/0/24/0/,-1/0/21/0/,-1//20/0/0,
-1/0/23/0/,-1//23/0/0,-1/0/27/0/,
-1/0/22/0/,-1/0/28/0/,-1/6/21/0/,
-1//22/0/0,-1/0/20/1/,-1/0/25/0/,
-1/0/25/1/,-1/0/54/0/,-1/0/20/0/,
-1/6/24/0/,
Edit Pay Code: - -1/1/20/0/,
-1/6/20/1/,-1/6/27/0/,-1/6/25/0/,
-1/6/23/0/,-1/6/20/0/,-1/6/28/0/,
-1/6/22/0/,
Delete Pay Code: -1/5/20/1/,
-1/5/25/0/,-1/5/25/1/,-1/5/28/1/,
-1/5/22/1/,-1/5/21/1/,-1/5/27/1/,
-1/5/23/1/,
Pay Code (Add/Edit/Delete):
-1/6/20/1/,-1/1/20/0/,-1/0/24/0/,
-1/6/28/0/,-1/0/27/0/,-1/5/27/1/,
-1/0/28/0/,-1//22/0/0,-1/5/25/1/,
-1/6/23/0/,-1/6/25/0/,-1/0/25/0/,

274
 Multiple/ Column
Discrete Typically Available Choice: Internal
Option Name Type Values Linked Value Passed
-1/0/20/0/,-1/6/24/0/,-1/5/21/1/,
-1/0/55/0/,12/-1/-1/-,-1/0/21/0/,
-1/0/23/0/,-1//20/0/0,-1/5/28/1/,
-1//23/0/0,-1/6/22/0/,-1/0/22/0/,
-1/5/20/1/,-1/6/21/0/,-1/6/27/0/,
-1/5/25/0/,-1/5/22/1/,-1/0/20/1/,
-1/0/25/1/,-1/6/20/0/,-1/0/54/0/,
-1/5/23/1/,
Audit Types Heading String Multiple Add Duration, Edit Duration,
Delete Duration, Duration
(Add/Edit/Delete), Add Punch, Edit
Punch, Delete Punch, Punch
(Add/Edit/Delete), Add Pay Code,
Edit Pay Code, Delete Pay Code,
Pay Code (Add/Edit/Delete)
Audited By
Audited By hd
Audited Field
Audited Field hd
Building Block Type Number Multiple Building Block IDs of the Building Block Type
Type ID
Building Block Type String Multiple Adjustment Rules, Bonuses /
Heading Deductions, Breaks, Call-Ins,
Combination Rules, Combined Pay
Codes, Contributing Pay Codes,
Contributing Shifts, Core Hours,
Currency Policy, Display Order,
Exceptions, Fixed Rules, Holiday
Credit Rules, Holiday Profiles,
Holiday Table, Interval Round
Rules, Majorities, Overtimes, Pay
Code Distributions, Pay Codes, Pay
Rules, Processing Order, Punch
Interpretation Rule, Punch Round
Rules, Schedule Deviations,
Scheduled Hours Type, Shift
Guarantees, Sign-Off Restrictions,
Time Zone Rules, Tip Compliance

275
 Multiple/ Column
Discrete Typically Available Choice: Internal
Option Name Type Values Linked Value Passed
Rules, Toke Pool Rules, Work
History Qualifiers, Work Rules,
Zones
Calculated Balances Number Multiple
Calculated Balances String Multiple Show user selected Calculated
hd Balances
1(fell to default)
Combined Events Number Multiple
Combined Events hd String Multiple Show user selected Combined
Events
Coverage Details Number Discrete Full:0 Short:1
Time
Hours
currency locale String Discrete Currency language (two letter)-
currency country (two letter)
Customer Name String Multiple 0:Starting Customer Name,
1:Ending Customer Name
Data Source Number Multiple Datasource ID Datasource ID
Data Sources
Heading
Daysindecimalformat
Db timezone String Discrete "GMT +/- hrs: DB Timezone
Name":[-- same]
Decimal Format Number Discrete Hh:mm:1 Hh.hh:0
Device Name String Multiple 0:Starting Device Name,
1:Ending Device Name
Display Options Number Multiple Full:0 Short:1
Current:0 Posted:1
All Scheduled Employees:0 All
Home Employees:1 All:2
Open Shifts:0|1 Wages:0|1
Breaks:0|1 Full-Day
Availability:0:1 Seniority:0|1
Duration Number Discrete Time

276
 Multiple/ Column
Discrete Typically Available Choice: Internal
Option Name Type Values Linked Value Passed
Hours
Edits by Managers Number Multiple All or selected managers ID
Edits by Managers String Multiple All Managers, selected managers
Heading
Employee Name
Option
Employee Page Break Number Discrete No:0
Yes:1
Employee page break String Discrete No, Yes:[--same]
hd
Employee Type Number Discrete All Scheduled Employees:0
Option All Home Employees:1 All:2
Events Number Multiple Actual, Budgeted, Scheduled,
Target, Variance:-[--same]
Events hd String Multiple Show user selected Events
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 Heading String Discrete Count:exception name1|2…:[--
same]
First Day of Week Number Discrete Default:0, Sunday:1, Monday:2,
Tuesday:3, Wednesday:4.
Thursday:5, Friday:6, Saturday:7
From Time Period Datetime Discrete Any datetime Datetimevalue:[--same]

277
 Multiple/ Column
Discrete Typically Available Choice: Internal
Option Name Type Values Linked Value Passed
column
Function Access Number Multiple Vp_accessprofile. Accessprofile.profilenm:
Profiles accessprofid or accessprofile.accessprofid
Accessprofile.
accessprofid
Function Access String Discrete Count:function access profile
Profiles Heading 1|2….
GMT Server Offset Number Discrete Seconds:[--same]
Group By Activity Or Number Discrete 0: Activity
Customer 1: Customer
Group By Employee Number Discrete 0: Employee
Team 1: Cell
2: Activity
Holiday Credit Type Number Discrete Exceptionsw Exceptions Only:0 Credits Only:1
Both:2
Holiday Credit Type String Discrete Exceptions Only, Credits Only,
Heading Both [-- same]
Import Batch Number Discrete Importbtchstatid Specific batch: importbtchstatid\0
Latest completed batch:
importbtchstatid\1
Import Batch Heading String Discrete Batch Name and Date:[--same]
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 Heading String Discrete Count:Import Type Name1|2…:--
Include Indirect Number Discrete No: 0
Yes: 1
Include Indirect hd String Discrete No, Yes:[--same]
Include Option Number Multiple Open Shifts:0|1 Wages:0|1
Breaks:0|1 Full-Day
Availability:0:1 Seniority:0|1

278
 Multiple/ Column
Discrete Typically Available Choice: Internal
Option Name Type Values Linked Value Passed
labor level count Number Discrete Number:[--same]
Labor Level Entries Number Discrete Show Name: 0, Show Description:1
Labor Level Entries String Discrete Show Name or Show Description
hd
Lost Time Events Number Multiple
Lost Time Events hd String Multiple Show user selected Lost Time
Events
Max Daily Hours Number Discrete Passes User entered hour number
Max Night Hours Number Discrete Passes user entered hour number
Max Weekly Hours Number Discrete Passes user entered hour number
Not Updated Emp Number Discrete Number of employeeid's:[--same]
Count hd
Not Updated Emp Number Multiple employeeid's:[--same]
List hd
Number Of Hours Number Discrete Number:[--same]
Number of Iterations Number Discrete Default: 0, 1:1, 2:2, 3:3,4:4, 5:5
Org Job ID Number Multiple Organizational job ID
Other Policy Number Multiple
Transactions
Other Policy String Multiple Show user selected Other Policy
Transactions hd Transactions
Page Break On Number Discrete No: 0
Customer Yes: 1
Page Break On String Discrete No, Yes:[--same]
Customer hd
Page Break On Date Number Discrete No: 0
Yes: 1
Page Break On Date String Discrete No, Yes:[--same]
hd
Page Break On Number Discrete No: 0
Employee Yes: 1
Page Break On String Discrete No, Yes:[--same]
Employee hd
Page Break On Group Number Discrete No: 0

279
 Multiple/ Column
Discrete Typically Available Choice: Internal
Option Name Type Values Linked Value Passed
Yes: 1
Page Break On Group String Discrete No, Yes:[--same]
hd
Page Break On Team Number Discrete No: 0
Yes: 1
Page Break On Team String Discrete No, Yes:[--same]
hd
Patterns Number Multiple
Patterns hd
Pay Codes Number Multiple paycodeid Paycode.name:paycode.paycodeid
Pay Codes Heading String Discrete Count:Pay Code name1|2…:
Points and Number Multiple -1,1,2,3,4,5,6,7,8,9,10
Occurrences
Points and String Multiple Show user selected Points and
Occurrences hd Occurrences 1(fell to default)
Printed For String Discrete Logged in user name:[--same]
Query Name String Discrete Hyperfind query name:[--same]
Report Content Number Discrete Default: 2, All: 0, Exception Only:
1
Request Time Datetime Discrete Max datetime all employees on
Heading report have up to date calculated
totals: [--same]
Rollup Hours By Number Multiple ID of Division, Department, Job,
Cost Center, Product, Item Number
and/or Work Order options
Rollup Hours By hd String Multiple Division, Department, Job, Cost
Center, Product, Item Number
and/or Work Order options
Runtime Branch Type
Runtime Hours String Discrete 0: Even
Allocation Type 1: All
2: Zero
3: Quantity Complete
4: Standard Time To Complete
5: Weighting Factor

280
 Multiple/ Column
Discrete Typically Available Choice: Internal
Option Name Type Values Linked Value Passed
6: Extended Standard
7: Quantity Ordered
Runtime Input Source String Discrete 0: Any
Type 1: Keypad
2: Reader
Runtime Mandatory String Discrete 0: Optional
Type 1: Required
2: Read Only
3: Hidden
Runtime Tracking
Status Type
Runtime Trans Field String Discrete 0: Alpha Numeric
Type 2: Date
3: Floating Decimal
4: Numeric
5: Time
6: Alpha Numeric with Slash
Runtime Trans Type String Discrete 0: Activity Start
1: Activity Stop
2: Report Results
5: Activity Delete
6: Activity Insert
7: Activity Hold
8: Activity Release
9: Override Standard Hours
10: Override Standard Rate
11: Join Cell
12: Leave Cell
13: Start Cell
14: Stop Cell
18: Clock In
19: Clock Out
20: Labor Level Transfer
21: Cancel Auto Meal
22: Move Quantity
23: Activity Duration
24: Log Off All Activities
25:Start Last Activity
26: Override Weighting Factor
27: Start Resource
28: Stop Resource

281
 Multiple/ Column
Discrete Typically Available Choice: Internal
Option Name Type Values Linked Value Passed
31: Resource Report Results
32: Cell Report Results
33: Join Cell For Resource
34: Leave Cell For Resource
Runtime Validation String Discrete 0: None
Type 1: In List
2: Not In List
3: In Range
4: Not in range
Schedule Number Discrete Current:0 Posted: 1
Schedule Option Number Discrete Current:0 Posted: 1
Schedule Zone Number Discrete [1: The total number of schedule
zones]
SessionID String Discrete
Show Dates Number Multiple 1: Scheduled Start
2: Scheduled Completion
3: Actual Start
4: Actual Completion
5: Revised Start
6: Revised Completion
Show Received Number Discrete No: 0
Yes: 1
Show Required Number Discrete No: 0
Yes: 1
Show Statuses Number Multiple 0: Completion
1: Held
Start Time Number Discrete 12:00 AM -> 0, 1:00 AM -> 1,
11:00 PM -> 23
Starting Labor Level
Starting Labor Level
hd
Time Balances Number Multiple
Time Balances hd String Multiple Show user selected Time Balances,
1(fell to default)
Time Period Heading String Discrete Timeframe Name or Specific
Dates:

282
 Multiple/ Column
Discrete Typically Available Choice: Internal
Option Name Type Values Linked Value Passed
Time Period Type Number Discrete Prev. Pay period:0
Curr. Pay period:1
Next Pay period:2
Prev. Schedule period:3
Curr. Schedule period:4
Next Schedule period:5
Week to Date:6
Last Week:7
Yesterday:8
Range of Dates:9
Range of Relative Dates:10
Specific Date:11
To Time Period Datetime Discrete Any datetime Datetimevalue:-[--same]
column
Top Activity Name String Discrete 0:Starting Activity Name,
1:Ending Activity Name
Transactions by Number Multiple
Policies
Transactions by String Multiple Show user selected Transactions by
Policies hd Policies, 1(fell to default)
Transaction Code Number Multiple WFATRANS.wfatransid
Transaction Code hd String Multiple WFATRANS.transcd
Transaction Date Number Discrete Effective Date: 1
Created Date: 2
Transaction Date hd String Discrete Effective Date, Created Date
[same]
Transaction Status Number Multiple Initial: 0,
Type Invalid: 1,
Completed: 2,
Error: 3
Transaction Status String Multiple Initial, Invalid, Completed, Error
Type hd [same]
Transaction Type Number Multiple 0: Activity Start
1: Activity Stop
2: Report Results
5: Activity Delete
6: Activity Insert
7: Activity Hold

283
 Multiple/ Column
Discrete Typically Available Choice: Internal
Option Name Type Values Linked Value Passed
8: Activity Release
9: Override Standard Hours
10: Override Standard Rate
11: Join Cell
12: Leave Cell
13: Start Cell
14: Stop Cell
18: Clock In
19: Clock Out
20: Labor Level Transfer
21: Cancel Auto Meal
22: Move Quantity
23: Activity Duration
24: Log Off All Activities
25:Start Last Activity
26: Override Weighting Factor
27: Start Resource
28: Stop Resource
Transaction Type Number Multiple 31: Resource Report Results
(continued) 32: Cell Report Results
33: Join Cell For Resource
34: Leave Cell For Resource
Transaction Type hd String Multiple List Above without indexes
Wage Permission Number Discrete ‘Show wages’:1
‘Don't show wages’:0
Weekly Rest Period Number Discrete Default: 0, 7:1, 14
(One rest period): 2, 14
(Two rest period):3
Work Week Length Number Discrete Default: 0, 1:1, 2:2, 3:3,4:4, 5:5,
6:6, 7:7
Worked Accounts
Workload Data Type String Discrete Actual, Budgeted, Scheduled,
Target, Variance:-[--same]

Wage permissions
The wage permission option is typically used to display or not display wage data on a report, based on the
logged-on user’s ability to view wage data, which is determined by the function access profile. This option
is generally passed directly to a formula or field on a report that prints wage amounts, and does not display

284
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 generating the report instance determines the value of this option,
using a setting in Access Profiles > Function Access Profiles in the Setup workspace. For any function
access profile, wage permissions are in Workforce Manager - System Configuration > Setup > Wage
Profiles Setup.
For reports that are scheduled to run via the Event Manager, the ability to view wage data is determined by
the person selected in the User Name field in the Report > Schedule Report tab.

Foreground and Background options

Foreground options are values that the user selects to control the data that appears on the report. Most
background header options have names ending in hd and are generally placed on the report as headers for
foreground options. Other similarly appearing background options are the Query Name, Printed For, Db
time zone, and Labor level count hd.
l If you use a HyperFind query, the Query name parameter in the report header displays the name of the
HyperFind query.
l 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.

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 display profile of the person generating the report instance determines the
value of this option, using a setting in Display Preferences > Display Profiles > Display Format tab >
Duration display group, in the Setup workspace.

HyperFind queries
If your report contains employee data, incorporating the results of a HyperFind query simplifies your
report. The HyperFind query selects the employees to include in the report and simplifies the process of
adding a time period to your report definition.
To determine whether an existing report uses a HyperFind query, access the Report Setup component.
Select Setup > 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.
Use the following guidelines to configure a report definition file to use a HyperFind query:
1. Use the MYWTKEMPLOYEE table in the query for the report. This table stores the HyperFind query
employees and time period values for the report request.
2. Create the WTKSESSIONID parameter to pass the correct HyperFind query identifier to the report
query.

285
 3. The MYWTKEMPLOYEE.SESSIONID is linked to the WTKSESSIONID parameter in the report
definition file, to properly pass the HyperFind query results to the report SQL.
When a report instance is run, the employee or person IDs in the HyperFind query result set replace the
?wtksessionid parameter value, thereby limiting the resulting report instance to those employees or people
whom the HyperFind query returns.
This replacement works because of the integration between the Reporting definition software and the suite;
and does not work unless the report is linked within the suite.

Time periods
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. A time period can be for pay periods or non-pay periods. Pay periods can
be different for each employee on a report. Non-pay period time periods contain the same date range for all
employees.
If the report is using a HyperFind query, it is combining with the data in the MYWTKEMPLOYEE table.
This table also has date columns, which are populated by the system automatically. The report query
should reference these dates to limit the results appropriately.

Customize reports that use stored procedures

The following table is a partial list of reports that use stored procedures:

Report Name Stored Procedure(s)

Absent Employees PREPROC_TotalizationNew
Accrual Balances and Projections accrual_bal_proj
PREPROC_TotalizationNew
Accrual Debit Activity Summary PREPROC_TotalizationNew
Accrual Detail RPTSP_AccrualDetails
PREPROC_TotalizationNew
Accrual Summary Accrual_summary
Actual vs. Schedule by Job RPTSP_ActualScheduleByJob
PREPROC_TotalizationNew
Actual vs. Schedule by Labor RPTSP_ActualScheduleByLabor
Account PREPROC_TotalizationNew
Employees Currently Earning Time PREPROC_TotalizationNew
Employee Hours by Job RPTSP_HoursTotals
PREPROC_Totalization
Employee Hours by Job (Excel) RPTSP_HoursTotals
PREPROC_Totalization

286
Report Name Stored Procedure(s)
Employee Hours by Labor Account RPTSP_EmpHoursTotals
PREPROC_Totalization
Employee Hours by Labor Account RPTSP_EmpHoursTotals
(Excel) PREPROC_Totalization
Employee Signoff PREPROC_TotalizationNew
Employee Transactions and Totals RPTSP_EmpTransTotals
PREPROC_Totalization
Employee Transactions and Totals RPTSP_EmpTransTotals
(Excel) PREPROC_Totalization
Exceptions absent_exception
PREPROC_TotalizationNew
Holiday Credits PREPROC_TotalizationNew
Hours by Job RPTSP_HoursTotals
PREPROC_TotalizationNew
Hours by Job (Excel) RPTSP_HoursTotals
PREPROC_TotalizationNew
Hours by Labor Account RPTSP_HoursTotals
PREPROC_TotalizationNew
Missing Employees PREPROC_Totalization
Timecard Audit Trail Timecard_audittrail
Time Detail Time_details

To modify the data returned by a stored procedure for a particular report, you must make a copy of the
stored procedure and edit the copy rather than edit the original version in the system database.
Duplicate the stored procedures according to Oracle or SQL server instructions and name the stored
procedure with a prefix of CUST_. For example, CUST_Time_details.

Parameters and options for reports that use stored procedures

The Key input parameter is the sessionid from the mywtkemployee table, which is passed to the report
using the "wtksessionid" parameter with the employeeids for that HyperFind query.
In addition to supplying the employee IDs for a report, the MYWTKEMPLOYEE.SESSIONID value can
also be used to provide the start and end dates of the selected time frame for each employee, so that the
Timeframe Type, To Timeframe, and From Timeframe options are not needed.
The wtksessionid parameter does not appear in the list of available options in report setup. It is passed
internally by the system report engine to the report query.
The Actual_adjusted parameter also does not appear in the list of available options in report setup. It
is passed internally by the system report engine to any report queries that use it. The

287
 Actual/adjusted parameter, visible in the options list, is different. This can be used in the report file
itself, such as on Time Detail, as well as in the stored procedure equivalent.

288
Chapter 14

System Monitoring and

Troubleshooting

Key system monitoring features include:

l System Status and Health Data — Provides suite run-time status and health data which enables you to
view and create thresholds, and to use notifications based on the health status of specific suite
processes.
l Performance Assessment Monitoring — Provides suite activity profiles that use the behavior in the

profile to predict potential future performance and response time problems. It also issues early warning
indicators of performance problems.
System monitoring and troubleshooting includes a centralized console and a third-party monitoring tool such
as JManage. Users have the ability to monitor systems and use notifications that provide information on
various background processes running behind the suite. The monitoring console uses Java Management
Extension (JMX) technology and managed beans (MBeans) to extract data and pull statistics from the
database, and displays this information in the monitor.

Note: It is recommended that you install JManage on a machine that does not run Workforce Central.
Configure this in the JManage properties.

System monitoring is the ability to oversee the various systems within your network.
l Set up the monitoring environment on page 290
l Monitor information with a third-party tool on page 294
l Monitor information in the suite on page 296
l Troubleshoot errors on page 320
Set up the monitoring environment
To begin the monitoring process, complete these steps:
l Step 1: Select a JMX monitoring console on page 290
l Step 2: Set the JMX Server administrative password in JBoss on page 292
l Step 3: Connect to a JMX server on page 293

Step 1: Select a JMX monitoring console

The monitoring console consists of a network device or workstation that implements a third-party
monitoring tool. The monitoring console is capable of retrieving information from any number of managed
resources within the system.
The system monitoring aspect of the suite can be managed by JMX. You can use any JMX monitoring tool,
such as JManage, to retrieve information about servers, databases, and operating system processes.
Information about suite-specific application operations are exposed within the monitoring console by using
MBeans.
The following components can be monitored:
l Application servers
l Databases

l Device Manager

l Integration Manager

l Timekeeper

The recommended approach for monitoring is to use a client that can connect directly to the application
server’s JMX server. The monitoring tool in use must support your current application server.
When selecting a monitoring tool, note that Workforce Central only supports monitoring tools that follow
the JMX 1.2 standards. To determine if your monitoring tool follows JMX 1.2 standards, and to determine
connectivity instructions, consult the documentation for your monitoring tool.

Note: Workforce Central v6.3 used JBoss EAP v5.1 and the following consoles were available: JMX
Console (http://hostname:8080/jmx-console); Web Console
(http://hostname:8080/web-console); and Admin Console (http://hostname:9990).

Workforce Central v7.0 and above, which uses JBoss EAP 6.0, only supports the Admin Console, which
can be used for general administrative tasks, but not for JMX monitoring. JMX monitoring tools such as
jdk\bin\jconsole.exe, jdk\bin\jvisualvm.exe, or other third-party JMX monitoring
tools, such as JManage, or HP SiteScope, can be used. As an example, see Set up HP SiteScope on page
291for more information.

290
Set up HP SiteScope
HP SiteScope is agentless monitoring software focused on monitoring the availability and performance of
distributed IT infrastructures, including servers, operating systems, network and Internet services,
applications, and application components.
HP SiteScope tests a web page or a series of web pages using synthetic monitoring. However, it is not
limited to web applications and can be used to monitor database servers, UNIX/Linux servers, Microsoft
Windows servers and many other types of hardware and software. It can export the collected data in real
time to HP LoadRunner or it can be used in standalone mode. HP SiteScope collects data using agentless
data collection. Using the collected data, HP SiteScope can send automated alerts and create monitoring
reports showing status over time in graphical and tabular formats.
After you install SiteScope on the same machine as the Workforce Central application server, do the
following to configure the JMX MBeans with SiteScope:
1. Open a browser and enter the SiteScope URL:
http://localhost:8090/SiteScope
2. Create a new group and create JMX Monitor within the group.
3. Specify the host, port (and optionally user name and password) and click OK.
The default JMX URL is:
service:jmx:remoting-jmx://<host>:9999
You also need to provide the user name and password.
4. Make the following class path entry:
C:\Kronos\jdk\lib\jconsole.jar;C:\Kronos\jdk\lib\tools.jar;C:\Kronos
\jmx-client\jboss-as-cli-7.1.2.Final-redhat-1.jar;C:\Kronos\jmx-
client\jboss-as-controller-7.1.2.Final-redhat-1.jar;C:\Kronos\jmx-
client\jboss-as-controller-client-7.1.2.Final-redhat-
1.jar;C:\Kronos\jmx-client\jboss-as-protocol-7.1.2.Final-redhat-
1.jar;C:\Kronos\jmx-client\jboss-dmr-1.1.1.Final-redhat-
1.jar;C:\Kronos\jmx-client\jboss-logging-3.1.1.GA-redhat-
1.jar;C:\Kronos\jmx-client\jboss-marshalling-1.3.14.GA-redhat-
1.jar;C:\Kronos\jmx-client\jboss-marshalling-river-1.3.14.GA-redhat-
1.jar;C:\Kronos\jmx-client\jboss-remoting-3.2.8.GA-redhat-
1.jar;C:\Kronos\jmx-client\jboss-sasl-1.0.1.Final-redhat-
1.jar;C:\Kronos\jmx-client\jboss-threads-2.0.0.GA-redhat-
1.jar;C:\Kronos\jmx-client\remoting-jmx-1.0.3.Final-redhat-
1.jar;C:\Kronos\jmx-client\staxmapper-1.1.0.Final-redhat-
1.jar;C:\Kronos\jmx-client\tools.jar;C:\Kronos\jmx-client\xnio-api-
3.0.4.GA-redhat-1.jar;C:\Kronos\jmx-client\xnio-nio-3.0.4.GA-redhat-
1.jar;

Note: Depending on your environment, you may see an error similar to the following:

291
 Error receiving browse data: java.util.ServiceConfigurationError:
org.xnio.XnioProvider: Provider org.xnio.nio.NioXnioProvider could
not be instantiated: java.lang.NoSuchMethodError:
org.jboss.logging.Logger.tracef
(Ljava/lang/String;Ljava/lang/Object;)
If this occurs, navigate to C:\SiteScope\WEB-INF\lib and do the following:
1. Stop the HP-SiteScope service.
2. Remove the jbossall-client.jar.
3. Remove the existing log4j.jar and copy the log4j-1.2.17.jar.
4. Start the HP-Sitescope service.
5. In the JMX Monitor Settings area, click Get Counter.
6. Click Reload Counters to display the new counters.
7. Select the counters to display or monitor., then click OK.
8. Set the threshold settings.
9. Click Save.

Step 2: Set the JMX Server administrative password in JBoss

Contact your Kronos Representative for the password that ships with JBoss. If you want to change or reset
the password, create an encrypted password and then enter the hash code into the mgmt-
users.properties file:
To set the administrative password for the JMX Server:
1. Create the encrypted password — Use the following command to determine the hash code for a
password for the administrator user:
\installation_directory\jdk\bin\java.exe -classpath \installation_
directory\jboss\modules\org\jboss\sasl\main\jboss-sasl-1.0.1.Final-
redhat-1.jar;c:\Kronos\configuration\deployGen\tools_deploygen_
framework.jar
com.Kronos.wfc.tools.deploygen.framework.PasswordHashUtil admin
ManagementRealm <password>
where <password> is the password that you are creating for the JMX Server.
2. Modify the property file — Edit the following properties file and add the password string generated
from the encryption process in step 1:
installation_directory\jboss\wfc\configuration\mgmt-users.properties
3. Start the Workforce Central server.
4. Test the password
a. Run jconsole by double-clicking following bat file: \\Kronos\jmx-client\kronos_
jconsole.

292
 b. Select Remote Process radio button.
c. Enter following URL service:
service:jmx:remoting-jmx://<MachineName>:9999
d. Enter admin as UserName and new password, and click Connect.

Step 3: Connect to a JMX server

There are several ways to establish a connection to the JMX server. The connection process varies
depending on the application server that is in place.

Connection Host Name and Port Number of

TYpe the Server User Credentials
RMI (JConsole) For example: jnp://<yourhostname>:1099 A user name and password is required.
HTTP (JBoss) For example: http://<yourhostname>:8080 A user name and password is required.
HTTP For Example: http://<yourhostname>:9090 A user name and password is required.
(JManage)

For example, if the Workforce Central server is called "ABC" on port 9999, then the connection URL from
the console to ABC is:
service:jmx:remoting-jmx://ABC:9999
If the JMX console is jManage hosted out of a server named “jmanage-console” on port 9090, then the
URL to jmanage would be:
http://jmanage-console:9090
Also, several JBoss JAR files are must be in the classpath before invoking the JMX monitoring tools. So
all monitoring tools such as JDK\bin\jconsole.exe, JDK\bin\jvisualvm.exe, JManage, HP
SiteScope, and so forth must start with these JBoss JAR files in the classpath.These JBoss-jars can be
found in:
<installation_directory>\jboss\jmx-client
To show how these JBoss’ JAR files can be included in the classpath of the JMX-monitoring tool, refer to
the sample scripts such as kronos_jconsole.bat and kronos_jvisualvm.bat in
<installation_directory>\jmx-client to invoke jconsole and jvisualvm tools respectively.

293
Monitor information with a third-party tool
This section explains how to monitor application servers, web servers, and response time information by
using a monitoring tool. Refer to your software monitoring tool’s product documentation for other
capabilities regarding the metrics listed in this section.
To access all the available metrics:
1. Open the monitoring tool application.
2. Access the monitoring agents.

Note: The names of monitoring agents vary for different monitoring tools.

3. Configure the monitoring tool workspace to view the metrics listed in the following tables.

Application server metrics

Metric Description Attributes

CPU Utilization The percentage of CPU time that is Percentage processor time
currently being used on the server.
Memory Consumption The amount of memory currently in use. Total size
Free megabytes
Percentage used
Percentage free
Java Virtual Machine Free The amount of free memory allocated in the Free memory
Memory JVM.
Java Virtual Machine The amount of total memory allocated for Total memory
Total Memory the JVM to run. Max memory

Web server metrics

Metrics Description Attributes

Web server software error
Web server not running The current status of the web server. Name
Status

294
Response time metrics

Metrics Description Attributes

HTTP 404 responses per minute The standard response code that Units or number of responses.
indicates a client was not able to
communicate with the server.
Servlet response time: The length of time it takes for the
Min. application server to respond.
Max.
Avg.
URL response time The length of time it takes for the web
Min. server to respond.
Max.
Avg.

295
Monitor information in the suite
This section explains how to monitor components of the suite. These components are Timekeeper, Device
Manager, and Integration Manager. There is also information available about the suite’s application
servers, databases, and JMX Framework.
To access all the available metrics:
1. Open the monitoring tool application.
2. Access the monitoring agents.

Note: The names of monitoring agents vary for different monitoring tools.

3. Configure the monitoring tool workspace to view the suite’s MBeans.

JMX Framework MBean

The JMX Framework MBean is used for internal troubleshooting, and provides information about the
health of the JMX framework.

Audit MBean
The Audit MBean is used to track changes to Workforce Central System Settings.

MBean Name: AuditMBean

Audit System Settings MBean

Audit MBean attributes

Attribute Getter/Setter Description

isSystemSettingAuditTurnedOn isSystemSettingAuditTurnedOn Returns the current enabled/disabled
status of the Audit System Settings
property.
Value:
True = Enabled
False = Disabled

Audit MBean operations

Operation Results Description

doGetAuditForTheDay The following values are Returns all of the audits for
returned: today.
After Value of last change

296
 Operation Results Description
Associate ID
Attribute Name
Audit Action name
Audit Entered time
Audit Type name
Before value of the change
Begin time of audit
doGetAuditForPast24Hours After Value of last change Returns all of the audits in the
Associatge ID past 24 hours starting from
Attribute Name NOW
Audit Action name
Audit Entered time
Audit Type name
Before value of last change
Begin time of audit
doGetAuditForLastWeek After value of last change Returns all the audits in the
Associated ID last week
Attribute Name
Audit Action name
Audit Entered time
Audit Type name
Before value of last change
Begin time of audit
doGetAudit After value of last change Returns all the audit items for
Associated ID a specified audit type.
Attribute Name
Audit Action name
Audit Entered time
Audit Type name
Before value of last change
Begin time of audit
isSystemSettingAuditTurnedOn Is auditing for System Settings Is auditing for System Settings
enabled? enabled
values:
True = Enabled
False = Disabled

Database Status MBean

MBean Name: DBStatusMBean
Database Status MBean

297
 DBStatus MBean attributes

Attribute Getter/Setter Description

DatabaseName getDatabaseName() Returns the current database name.
isDatabaseOnline isDatabaseOnline() Returns the current database status.
Value:
True = online
False = offline

DBStatus MBean operations

Operation Results Description

doGetLatestSchemaReconciliationReportDate Shows the date in a The date that the
localized format or indicates reconciliation report was
if the report has never been last run.
run.
doRunSchemaReconciliationReport Generates the report. Launches the schema
reconciliation report.
To view the report status,
click the View Report
Status tab.
To view the report, click
the report name of a
completed or failed report.

DBStatus MBean notifications

Name Type
WFP-01412 connection lost CRITICAL
WFP-01172 connection pool exceeded CRITICAL

Suite operations (BGP Status MBean)

MBean Name: BGPStatusMBean
Background processor status MBean

BgpStatus MBean operations

Operation Results Description

doGetStuckEmployees() Returns a comma- Displays the list of

298
 Operation Results Description
separated string of person PersonIDs for stuck
IDs for "stuck" employees. employees.
doShowHowLongTotalizerInputQueueWasEmpty Returns a string Shows how long the
() representation of the totalizer input queue has
amount of time that the been idle.
queue was idle.
doShowTheStateOfBgpThreads() Returns a table with a Shows the name, status,
variable number of rows and description of each
(one row per thread); BGP thread.
column headers are Thread
Name, Status, and
Description.
doShutdownBGP() Attempts to stop all Attempts to shut down
running BGP threads and BGP threads.
returns a value of true if
successful.
doStartupBGP() Attempts to start all BGP Attempts to start BGP
threads and returns a value threads.
of true if successful, of
false if unsucessful.

Note: There are no notifications associated with the BGP Status MBean.

Device Manager MBean

MBean Name: DeviceManagerMBean
Exposes Device Manager monitoring capabilities to JMX clients.

Device Manager MBean attributes

Attributes Getter/Setter Description

SystemStatus getSystemStatus() The status of the system in terms of all the device groups in
it. The status indicator is RED, YELLOW, or GREEN. If
the status indicator is either RED or YELLOW, view the
status of individual device groups by invoking the operation
doRetrieveAllDeviceGroupsStatus.

299
 Device Manager MBean operations

Operation Results Description

doRetrieveAllDeviceGroupsStatus Returns a table showing the The status of each device
“status,” "Group ID,” and "Group group in the system. For
Name" for each device. The status device groups with either
indicator is RED, YELLOW, or RED or YELLOW status,
GREEN. view individual devices by
invoking the operation
doRetrieveAllDevicesStatus.
doRetrieveAllDevicesStatus Returns a table showing the The status of each device that
"Status,” "ID,” "Last Action Time,” belongs to one or more device
"Last Action Name,” "Last Action groups. For devices with
Status,” "Last Action Source,” either RED or YELLOW
"Group Name,” and “Configuration status, use their IDs to look up
Profile Name" for each device. their detail status and actions.
doRetrieveDeviceDetail(String Returns the following information The configuration detail for
deviceID) for the specified device: "Name,” the device specified by the
"ID,” "Description,” "Device "deviceID.”
Address,” "Primary Server,”
"Firmware Revision,”
"Configuration Profile Name,”
"Device Severity Level,” and
"Current Device Status.
doRetrieveDeviceActions(String Returns the following information The status of each action
deviceID) for the specified device action: performed or is being
"Action,” “Status,” "Action Status," performed on the specified
“Update Source,” and “Update device.
Time.”

Note: There are no notifications associated with the Device Manager MBean.

Integration Manager MBean

MBean Name: WIMStatusMBean
Integration Manager MBean

WIMStatus MBean attributes

Note: There are no attributes associated with the WIM MBean.

300
 WIMStatus MBean operations

Operation Results Description

doGetCurrently RunningIfc Displays the username, start date, Retrieves information about
and elapsed time of each currently currently running interfaces.
running interface.
doGetCompletedIfc Displays the username, interface Retrieves information about
name, minimum, maximum, and completed interfaces.
average run times, and start date for
each completed interface.
doGetFailedIfc Displays the username, interface Retrieves information about
name, and start date of each failed failed interfaces.
interface.
doShowWimPerformanceProfile Displays the following performance Displays performance profile
statistics: information.
Composite type
Max number of processing threads
Number of currently running
interfaces
Number of submitted interfaces
currently running

Note: There are no notifications associated with the WIM MBean.

Hyperfind MBean
MBean Name: HyperFindMBean
The Hyperfind MBean allows you to monitor the performance impact of Hyperfinds in the system.
Monitoring can be set up for Hyperfinds in one of two modes:
l Real Time Mode — This mode runs as a constant monitor that does not write and retain the
information in the database. The typical use of this mode is to set up a notification when a certain
threshold is reached. RealTime is the recommended mode for day to day monitoring.
l Forensic Mode — In Forensic mode, monitoring data is retained and saved in the database. You can
set up time periods to sample, the interval at which the data is written to the database, and how long to
retain the information in the database.This mode allows for advanced analysis as to the causes of the
performance impacts of Hyperfinds.

301
 How to set up Real Time Mode for the Hyperfind MBean
Real Time Mode is set up through the Workforce Central System Settings. To turn on and set up Real-
Time Mode, access the System Settings workspace from the Workforce Central home screen and proceed
as follows:
1. Click the Monitoring tab.
2. Do the following:
o Enable Real-Time mode by setting the following item to True:
site.monitoring.performance.hyperFind.enable
o Disable Forensic mode by setting the following item to False:
site.monitoring.performance.forensicMode.hyperFind
3. Set the time (in minutes) to keep the monitoring data in cache memory by setting the following item:
site.monitoring.performance.timeToLiveInCache_minute
4. Click Save.

How to set up Forensic Mode for the Hyperfind MBean

Forensic Mode is set up through the Workforce Central System Settings. To turn on and set up Forensic
Mode, access the System Settings workspace from the Workforce Central home screen and proceed as
follows:
1. Click the Monitoring tab.
2. Set both of the following settings to True to enable Forensic Mode:
o site.monitoring.performance.forensicMode.hyperFind
o site.monitoring.performance.hyperFind.enable
3. Set the number of records to accumulate before triggering a write to the database by setting the
following item:
site.monitoring.performance.forensicMode.batchinsert
4. Set the number of days to retains the batch data in memory before purging by setting the following item:
site.monitoring.PerformanceBatchRecordsTimeToLive_day
5. Click Save.

HyperfindMBean attributes

Attribute Description
MBeanName The name of the MBean.
TypeID System generated identifier for the MBean.
DataSource Data Source is the monitoring mode. Value can be RealTime
Mode or Forensic Mode.
MBeanQueryIntervalSystemSetting The default MBean query interval duration (in minutes). This
setting is the period of monitoring time for MBean attributes

302
Attribute Description
that return component attributes (such as counts, averages, and
maximums).
The value is set from the system setting
site.monitoring.performance.MBeanQueryInt
ervalSystemSetting_minute

AccessCountWithSystemSettingInterval The number of times the Hyperfind component has been run
for the time interval contained in
MBeanQueryIntervalSystemSetting.

RecordCountWithSystemSettingInterval The number of Records counted for the time interval contained
in MBeanQueryIntervalSystemSetting.
AverageRecordCountWithSystemSettingI The average number of records returned per Hyperfind for the
nterval time interval contained in QueryIntervalSystemSetting.
MaxRecordCountWithSystemSettingInter The maximum number of records returned in any one
val Hyperfind for the time interval contained in
QueryIntervalSystemSetting.
MonitorStatForMaxRecordCountWithinSy The statistics returned from the execution of operations that
stemSettingInterval triggered the MaxRecordCountWithSystemSettingInterval.
Contains the following statistical information:
TypeID
Name
Start Time
End Time
User ID
Response Count
Workforce Central Server ID
Context
IPC Port
AverageDurationMillisWithSystemSetting The average duration (in milliseconds) per Hyperfind for the
Interval time interval contained in QueryIntervalSystemSetting.

303
 Attribute Description
MaxDurationMillisWithSystemSettingInte The maximum duration (in milliseconds) of any one Hyperfind
rval for the time interval contained in QueryIntervalSystemSetting.
MonitorStatForMaxDurationWithinSyste The statistics returned from the last execution of operations
mSettingInterval associated with MaxDurationMillisWithSystemSettingInterval.
Contains the following statistical information:
TypeID
Name
Start Time
End Time
User ID
Response Count
Workforce Central Server ID
Context
IPC Port

HyperfindMBean operations

Operations Description
getMBeanName Returns the name of the MBean.
getTypeID Returns the system generated Type Identifier for the
Hyperfind MBean.
getDataSource Returns the current monitoring mode for the MBean. Values
can be RealTime or Forensic.
getMBeanQueryIntervalSystemSetting Returns current default query interval from the Workforce
Central system setting:
site.monitoring.performance.MBeanQueryIn
tervalSystemSetting_minute
Access Count:
getAccessCount (with argument) Returns the number of times the Hyperfind component has
been run for the time interval (in minutes) contained in the
argument field.
getAccessCountWithSystemSettingInterval Returns the number of times the Hyperfind component has
been run for the time interval (in minutes) contained in
MBeanQueryIntervalSystemSetting.
Record Count:
getRecordCount (with argument) Returns the record count for the time interval (in minutes)

304
Operations Description
contained in the argument field.
getRecordCountWithSystemSettingInterval Returns the record count for the time interval contained in
MBeanQueryIntervalSystemSetting.
Maximum Record Count:
getMaxRecordcount (with argument) Returns the maximum record count for any one Hyperfind for
the time interval (in minutes) contained in the argument field.
getMaxRecordCountWithSystemSettingInt Returns the maximum record count for any one Hyperfind for
erval the time interval contained in
MBeanQueryIntervalSystemSetting.
getMonitorStatForMaxRecordCountWithin Returns the statistics from the last execution of operations
SystemSettingInterval associated with MaxRecordCountWithSystemSettingInterval.
Captures the following statistical information:
TypeID
Name
Start Time
End Time
User ID
Response Count
Workforce Central Server ID
Context
IPC Port
Average Record Count
getAverageRecordCount (with argument) Returns the average record count per HyperFind for the time
interval (in minutes) contained in the argument field.
getAverageRecordCountWithSystemSettin Returns the average record count per HyperFind for the time
gInterval interval contained in MBeanQueryIntervalSystemSetting.
Maximum Duration:
getMaxDurationMillis (with argument) Returns the maximum duration (in milliseconds) of any one
Hyperfind during the time interval (in minutes) contained in
the argument field.
getMaxDurationMillisWithSystemSettingIn Returns the maximum duration (in milliseconds) of any one
terval Hyperfind during the time interval contained in
QueryIntervalSystemSetting.
getMonitorStatForMaxDurationWithinSyst Returns the statistics from the last execution of operations
emSettingInterval associated with

305
 Operations Description
MaxDurationMillisWithSystemSettingInterval.
Captures the following statistical information:
TypeID
Name
Start Time
End Time
User ID
Response Count
Workforce Central Server ID
Context
IPC Port
Average Duration:
getAverageDurationMillis (with argument) Returns the average duration (in milliseconds) per Hyperfind
during the time interval (in minutes) contained in the
argument field.
getAverageDurationMillisWithSystemSetti Returns the average duration (in milliseconds) per Hyperfind
ngInterval during the time interval contained in
QueryIntervalSystemSetting.

Genies MBean
MBean Name: Genies MBean
The Genies MBean allows you to monitor the performance impact of Genies in the system. Monitoring can
be set up for Genies in one of two modes:
Real Time Mode – This mode runs as a constant monitor that does not write and retain the information in
the database. The typical use of this mode is to set up a notification when a certain threshold is reached.
RealTime is the recommended mode for day to day monitoring.
Forensic Mode – In Forensic mode, monitoring data is retained and saved in the database. You can set up
time periods to sample, the interval at which the data is written to the database, and how long to retain the
information in the database.This mode allows for advanced analysis as to the causes of the performance
impacts of Genies.

How to set up Real Time Mode for the Smart View MBean
Real Time Mode is set up through the System Settings. To turn on and set up Real-Time Mode, access the
System Settings workspace from the Workforce Central home screen and proceed as follows:

306
1. Click the Monitoring tab.
2. Do the following:
a. Enable Real-Time mode by setting the following item to True:
site.monitoring.performance.SmartView.enable
b. Disable Forensic mode by setting the following item to False:
site.monitoring.performance.forensicMode.genies
3. Set the time (in minutes) to keep the monitoring data in cache memory by setting the following item:
site.monitoring.performance.timeToLiveInCache_minute
4. Click Save.

How to set up Forensic Mode for the Genies MBean

Forensic Mode is set up through System Settings. To turn on and set up Forensic Mode, access the System
Settings workspace from the Workforce Central home screen and proceed as follows:
1. Click the Monitoring tab.
2. Set both of the following settings to True to enable Forensic Mode:
o site.monitoring.performance.forensicMode.genies
o site.monitoring.performance.genies.enable
3. Set the number of records to accumulate before triggering a write to the database by setting the
following item: site.monitoring.performance.forensicMode.batchinsert
4. Set the number of days to retains the batch data in memory before purging by setting the following item:
site.monitoring.PerformanceBatchRecordsTimeToLive_day
5. Click Save.

Genies MBean attributes

Attribute Description
MBeanName The name of the MBean.
TypeID System generated identifier for the MBean.
DataSource Data Source is the monitoring mode. Value can be RealTime
Mode or Forensic Mode.
MBeanQueryIntervalSystemSetting The default MBean query interval duration (in minutes). This
setting is the period of monitoring time for MBean attributes
that return component attributes (such as counts, averages, and
maximums).
The value is set from the system setting
site.monitoring.performance.MBeanQueryInt
ervalSystemSetting_minute
AccessCountWithSystemSettingInterval The number of times the Genie component has been run for
the time interval contained in

307
 Attribute Description
MBeanQueryIntervalSystemSetting.

RecordCountWithSystemSettingInterval The number of Records counted for the time interval contained
in MBeanQueryIntervalSystemSetting.
AverageRecordCountWithSystemSettingI The average number of records returned per Genie for the
nterval time interval contained in QueryIntervalSystemSetting.
MaxRecordCountWithSystemSettingInter The maximum number of records returned in any one Genie
val execution for the time interval contained in
QueryIntervalSystemSetting.
MonitorStatForMaxRecordCountWithinSy The statistics returned from the execution of operations that
stemSettingInterval triggered the MaxRecordCountWithSystemSettingInterval.
Contains the following statistical information:
TypeID
Name
Start Time
End Time
User ID
Response Count
Workforce Central Server ID
Context
IPC Port
AverageDurationMillisWithSystemSetting The average duration (in milliseconds) per Genie for the time
Interval interval contained in QueryIntervalSystemSetting.

308
Attribute Description
MaxDurationMillisWithSystemSettingInte The maximum duration (in milliseconds) of any one Genie for
rval the time interval contained in QueryIntervalSystemSetting.
MonitorStatForMaxDurationWithinSyste The statistics returned from the last execution of operations
mSettingInterval associated with MaxDurationMillisWithSystemSettingInterval.
Contains the following statistical information:
TypeID
Name
Start Time
End Time
User ID
Response Count
Workforce Central Server ID
Context
IPC Port

Genies MBean operations

Operation Description
getMBeanName Returns the name of the MBean.
getTypeID Returns the system generated Type Identifier for the Genies
MBean.
getDataSource Returns the current monitoring mode for the MBean. Values
can be RealTime or Forensic.
getMBeanQueryIntervalSystemSetting Returns current default query interval from the Workforce
Central system setting:
site.monitoring.performance.MBeanQueryIn
tervalSystemSetting_minute
Access Count:
getAccessCount (with argument) Returns the number of times the Genie component has been
run for the time interval (in minutes) contained in the
argument field.
getAccessCountWithSystemSettingInterval Returns the number of times the Genie component has been
run for the time interval (in minutes) contained in
MBeanQueryIntervalSystemSetting.
Record Count:
getRecordCount (with argument) Returns the record count for the time interval (in minutes)

309
 Operation Description
contained in the argument field.
getRecordCountWithSystemSettingInterval Returns the record count for the time interval contained in
MBeanQueryIntervalSystemSetting.
Maximum Record Count:
getMaxRecordcount (with argument) Returns the maximum record count for any one Genie
execution for the time interval (in minutes) contained in the
argument field.
getMaxRecordCountWithSystemSettingInt Returns the maximum record count for any one Genie
erval execution for the time interval contained in
MBeanQueryIntervalSystemSetting.
getMonitorStatForMaxRecordCountWithin Returns the statistics from the last execution of operations
SystemSettingInterval associated with MaxRecordCountWithSystemSettingInterval.
Captures the following statistical information:
TypeID
Name
Start Time
End Time
User ID
Response Count
Workforce Central Server ID
Context
IPC Port
Average Record Count:
getAverageRecordCount (with argument) Returns the average record count per Genie for the time
interval (in minutes) contained in the argument field.
getAverageRecordCountWithSystemSettin Returns the average record count per Genie for the time
gInterval interval contained in MBeanQueryIntervalSystemSetting.
Maximum Duration:
getMaxDurationMillis (with argument) Returns the maximum duration (in milliseconds) of any one
Genie execution during the time interval (in minutes)
contained in the argument field.
getMaxDurationMillisWithSystemSettingIn Returns the maximum duration (in milliseconds) of any one
terval Genie execution during the time interval contained in
QueryIntervalSystemSetting.
getMonitorStatForMaxDurationWithinSyst Returns the statistics from the last execution of operations

310
 Operation Description
emSettingInterval associated with
MaxDurationMillisWithSystemSettingInterval.
Captures the following statistical information:
TypeID
Name
Start Time
End Time
User ID
Response Count
Workforce Central Server ID
Context
IPC Port
Average Duration:
getAverageDurationMillis (with argument) Returns the average duration (in milliseconds) per Genie
during the time interval (in minutes) contained in the
argument field.
getAverageDurationMillisWithSystemSetti Returns the average duration (in milliseconds) per Genie
ngInterval during the time interval contained in
QueryIntervalSystemSetting.

Smart View MBean

MBean Name: Smart View MBean
The Smart View MBean is used for Smart Views.

Note: A Smart View is a custom page intended to run on the Kronos 4500 Timeclock. Due to the fact
that a Smart View is a custom, these MBeans can only extract a limited amount of information, such as
the time and the number of times a Smart View is called. Some attributes common to other MBeans,
such as durations and record counts, are not captured for Smart Views.

The Smart View MBean allows you to monitor the performance impact of Smart Views in the system.
Monitoring can be set up for Smart Views in one of two modes:
l Real Time Mode — This mode runs as a constant monitor that does not write and retain the
information in the database. The typical use of this mode is to set up a notification when a certain
threshold is reached. RealTime is the recommended mode for day to day monitoring.

311
 l Forensic Mode — In Forensic mode, monitoring data is retained and saved in the database. You can
set up time periods to sample, the interval at which the data is written to the database, and how long to
retain the information in the database.This mode allows for advanced analysis as to the causes of the
performance impacts of Smart Views.

How to set up Real Time Mode for the Smart View MBean
Real Time Mode is set up through the Workforce Central System Settings. To turn on and set up Real-
Time Mode, access the System Settings workspace from the Workforce Central home screen and proceed
as follows:
1. Click the Monitoring tab.
2. Do the following:
o Enable Real-Time mode by setting the following item to True:
site.monitoring.performance.SmartView.enable
o Disable Forensic mode by setting the following item to False:
site.monitoring.performance.forensicMode.SmartView
3. Set the time (in minutes) to keep the monitoring data in cache memory by setting the following item:
site.monitoring.performance.timeToLiveInCache_minute
4. Click Save.

How to set up Forensic Mode for the Smart View MBean

Forensic Mode is set up through the Workforce Central System Settings. To turn on and set up Forensic
Mode, access the System Settings workspace from the Workforce Central home screen and proceed as
follows:
1. Click the Monitoring tab.
2. Set both of the following settings to True to enable Forensic Mode:
osite.monitoring.performance.forensicMode.SmartView
osite.monitoring.performance.SmartView.enable
3. Set the number of records to accumulate before triggering a write to the database by setting the
following item: site.monitoring.performance.forensicMode.batchinsert
4. Set the number of days to retains the batch data in memory before purging by setting the following item:
site.monitoring.PerformanceBatchRecordsTimeToLive_day
5. Click Save.

Smart View MBean attributes

Attribute Description
MBeanName The name of the MBean.
TypeID System generated identifier for the MBean.
DataSource Data Source is the monitoring mode. Value can be RealTime

312
Attribute Description
Mode or Forensic Mode.
MBeanQueryIntervalSystemSetting The default MBean query interval duration (in minutes). This
setting is the period of monitoring time for MBean attributes
that return component attributes (such as counts, averages, and
maximums).
The value is set from the system setting
site.monitoring.performance.MBeanQueryInt
ervalSystemSetting_minute
AccessCountWithSystemSettingInterval The number of times the Smart View component has been run
for the time interval contained in
MBeanQueryIntervalSystemSetting.
RecordCountWithSystemSettingInterval These attributes do not contain valid captured data. If data is
AverageRecordCountWithSystemSettingI present, it is invalid.
For more information, refer to the note in the “MBean for
nterval
Smart Views” section.
MaxRecordCountWithSystemSettingInter
val
MonitorStatForMaxRecordCountWithinSy
stemSettingInterval
AverageDurationMillisWithSystemSetting
Interval
MaxDurationMillisWithSystemSettingInte
rval
MonitorStatForMaxDurationWithinSyste
mSettingInterval

Smart View MBean operations

Operation Description
getMBeanName Returns the name of the MBean.
getTypeID Returns the system generated Type Identifier for the Smart
View MBean.
getDataSource Returns the current monitoring mode for the MBean. Values
can be RealTime or Forensic.
getMBeanQueryIntervalSystemSetting Returns current default query interval from the Workforce
Central system setting:
site.monitoring.performance.MBeanQueryIn
tervalSystemSetting_minute
getAccessCount (with argument) Returns the number of times the Smart View component has

313
 Operation Description
been run for the time interval (in minutes) contained in the
argument field.
getAccessCountWithSystemSettingInterval Returns the number of times the Smart View component has
been run for the time interval (in minutes) contained in
MBeanQueryIntervalSystemSetting.
getRecordCount (with argument) These operations are not actually capturing data. If data is
getRecordCountWithSystemSettingInterval present, it is invalid.
For more information, refer to the note in the “MBean for
getMaxRecordcount (with argument) Smart Views” section.
getMaxRecordCountWithSystemSettingInt
erval
getMonitorStatForMaxRecordCountWithin
SystemSettingInterval
getAverageRecordCount (with argument)
getAverageRecordCountWithSystemSettin
gInterval
getMaxDurationMillis (with argument)
getMaxDurationMillisWithSystemSettingIn
terval
getMonitorStatForMaxDurationWithinSyst
emSettingInterval
getAverageDurationMillis (with argument)
getAverageDurationMillisWithSystemSetti
ngInterval

XML API MBean

MBean Name: XmlApiMBean
The XmlApi MBean allows you to monitor the performance impact of running XML APIs in the system.

Note: For a single request that contains multiple XML APIs, each API shows up as one event, but all
have same duration.

Monitoring can be set up for XML APIs in one of two modes:

l Real Time Mode — This mode runs as a constant monitor that does not write and retain the
information in the database. The typical use of this mode is to set up a notification when a certain

314
 threshold is reached. RealTime is the recommended mode for day to day monitoring.
l Forensic Mode — In Forensic mode, monitoring data is retained and saved in the database. You can
set up time periods to sample, the interval at which the data is written to the database, and how long to
retain the information in the database.This mode allows for advanced analysis as to the causes of the
performance impacts of XML APIs.

How to set up Real Time Mode for the XML API MBean
Real Time Mode is set up through the Workforce Central System Settings. To turn on and set up Real-
Time Mode, access the System Settings workspace from the Workforce Central home screen and proceed
as follows:
1. Click the Monitoring tab.
2. Do the following:
o Enable Real-Time mode by setting the following item to True:
site.monitoring.performance.xmlApi.enable
Disable Forensic mode by setting the following item to False:
o
site.monitoring.performance.forensicMode.xmlApi
3. Set the time (in minutes) to keep the monitoring data in cache memory by setting the following item:
site.monitoring.performance.timeToLiveInCache_minute
4. Click Save.

How to set up Forensic Mode for the XML API MBean

Forensic Mode is set up through the Workforce Central System Settings. To turn on and set up Forensic
Mode, access the System Settings workspace from the Workforce Central home screen and proceed as
follows:
1. Click the Monitoring tab.
2. Set both of the following settings to True to enable Forensic Mode:
o site.monitoring.performance.forensicMode.xmlApi
o site.monitoring.performance.xmlApi.enable
3. Set the number of records to accumulate before triggering a write to the database by setting the
following item: site.monitoring.performance.forensicMode.batchinsert
4. Set the number of days to retains the batch data in memory before purging by setting the following item:
site.monitoring.PerformanceBatchRecordsTimeToLive_day
5. Click Save.

XmlApiMBean attributes

Attribute Description
MBeanName The name of the MBean.

315
 Attribute Description
TypeID System generated identifier for the MBean.
DataSource Data Source is the monitoring mode. Value can be RealTime
Mode or Forensic Mode.
MBeanQueryIntervalSystemSetting The default MBean query interval duration (in minutes). This
setting is the period of monitoring time for MBean attributes
that return component attributes (such as counts, averages, and
maximums).
The value is set from the system setting
site.monitoring.performance.MBeanQueryInt
ervalSystemSetting_minute
AccessCountWithSystemSettingInterval The number of times and XML API has been run for the time
interval contained in MBeanQueryIntervalSystemSetting.
AverageDurationMillisWithSystemSetting The average duration (in milliseconds) per XML API for the
Interval time interval contained in QueryIntervalSystemSetting.
Note that for a single request that contains multiple XML
APIs, each API shows up as one event, but all have same
duration.
MaxDurationMillisWithSystemSettingInte The maximum duration (in milliseconds) of any one XML API
rval for the time interval contained in QueryIntervalSystemSetting.

316
Attribute Description
MonitorStatForMaxDurationWithinSyste The statistics returned from the last execution of operations
mSettingInterval associated with MaxDurationMillisWithSystemSettingInterval.
Contains the following statistical information:
TypeID
Name
Start Time
End Time
User ID
Response Count
Workforce Central Server ID
Context
IPC Port
RecordCountWithSystemSettingInterval These attributes do not contain valid captured data. If data is
AverageRecordCountWithSystemSettingI present, it is invalid.
nterval
MaxRecordCountWithSystemSettingInter
val
MonitorStatForMaxRecordCountWithinSy
stemSettingInterval

XmlApiMBean operations

Operation Description
getMBeanName Returns the name of the MBean.
getTypeID Returns the system generated Type Identifier for the
XMLAPI MBean.
getDataSource Returns the current monitoring mode for the MBean. Values
can be RealTime or Forensic.
getMBeanQueryIntervalSystemSetting Returns current default query interval from the Workforce
Central system setting:
site.monitoring.performance.MBeanQueryIn
tervalSystemSetting_minute
getAccessCount (with argument) Returns the number of times an XML API has been run for
the time interval (in minutes) contained in the argument field.
getAccessCountWithSystemSettingInterval Returns the number of times an XML API has been run for
the time interval (in minutes) contained in

317
 Operation Description
MBeanQueryIntervalSystemSetting.
getMaxDurationMillis (with argument) Returns the maximum duration (in milliseconds) of any one
XML API during the time interval (in minutes) contained in
the argument field.
getMaxDurationMillisWithSystemSettingIn Returns the maximum duration (in milliseconds) of any one
terval XML API during the time interval contained in
QueryIntervalSystemSetting.
getMonitorStatForMaxDurationWithinSyst Returns the statistics from the last execution of operations
emSettingInterval associated with
MaxDurationMillisWithSystemSettingInterval.
Captures the following statistical information:
TypeID
Name
Start Time
End Time
User ID
Response Count
Workforce Central Server ID
Context
IPC Port
getAverageDurationMillis (with argument) Returns the average duration (in milliseconds) per XML API
during the time interval (in minutes) contained in the
argument field.
Note that for a single request that contains multiple XML
APIs, each API shows up as one event, but all have same
duration.

318
 Operation Description
getAverageDurationMillisWithSystemSetti Returns the average duration (in milliseconds) per XML API
ngInterval during the time interval contained in
QueryIntervalSystemSetting.
Note that for a single request that contains multiple XML
APIs, each API shows up as one event, but all have same
duration.
getRecordCount (with argument) These operations are not actually capturing data. If data is
getRecordCountWithSystemSettingInterval present, it is invalid.
getMaxRecordcount (with argument)
getMaxRecordCountWithSystemSettingInt
erval
getAverageRecordCount (with argument)
getAverageRecordCountWithSystemSettin
gInterval
getMonitorStatForMaxRecordCountWithin
SystemSettingInterval

Notifications
The MBeans that are exposed by the suite may provide notifications that can be subscribed to. The
notifications that can be subscribed to are listed after the MBean operation sections, as shown in the
following table. Refer to your monitoring console's documentation for detailed instructions on subscribing
to MBean notifications.

Notification types
There are six types of MBean notifications in the suite.

Type Description
FATAL Non-recoverable events
CRITICAL Critical or failure events
MAJOR Major or severe events
ERROR Minor, marginal, or error events
WARNING Warning events
INFO Normal, cleared, or informative events

319
Troubleshoot errors
If the JMX monitoring service fails to start, an error message should appear in the StartupError.log file,
stating “JMXMonitoringStartupService failed to start properly”. Users can contact technical support for
assistance. The StartupError.log file can be found at: installation_
directory\instance\logs\StartUpError.log

320
Chapter 15

Process Manager

Process Manager provides software components and XML-based templates that enable users to implement
online, automated business processes in areas such as time and labor, scheduling, and attendance
management.

Note: Business analysts and IS professionals use Process Designer, which is the visual process design
tool installed on client machines, to modify preconfigured process templates. These templates are then
deployed to the Workforce Central server and managed by Process Manager.

Process Manager consists of the following components. All components are installed on the server.
l Process Engine — The underlying software on the server that executes the automated business
processes created with Process Designer.
l Cluster Manager — The tool that you use to allow multiple Process Engine instances to
simultaneously access and monitor the same set of processes.
l Process Administrator — The tool that you use to monitor and manage all business processes running
in the system.
l Process Profiles editor — The tool that you use to add process templates to process profiles. You can
then use the People Editor to assign those profiles to appropriate employees and managers in your
organization.
l Process Templates editor — The tool that you use to activate business process templates in the
system.
Configuration requirements
Before you use Process Manager, configure the following:
l System Settings on page 322
l Function Access Profiles on page 322
l Set up the “Reports To” field in primary accounts on page 323

System Settings
To set up and maintain the Process Manager system, you use System Configuration > System Settings to
configure the following tabs:
l E-mail (Be sure that standard e-mail settings are enabled including the URL of your SMTP server in
site.email.smtp.url.)
l Messaging

l Business Automation

l Global Values

To give access rights to people who will be using Process Manager, you use Setup > Access Profiles >
Function Access Profiles to allow Everyone, Employee, or Manager access to the various Process
Manager components.

Note: You must have administrator privileges to perform these tasks.

Function Access Profiles

To allow access to Process Manager, messaging, and vacation bidding functions, specify access control
points for Everyone, Employees, and Managers. Complete the following steps:
1. Select Setup > Access Profiles > Function Access Profiles.
2. Allow access to functions based on guidelines in the following table:

Process Manager
Everyone Open an online form
Everyone Start a business process
Everyone View the Inbox
Everyone Access to Task List
Workforce Employee Employee access to Actions list

322
 Workforce Manager-Department Manager Manager access to Actions list
Workforce Manager-Common Setup Process Manager setup
Workforce Manager -Common Setup Process Administrator access
Workforce Manager-Common Setup Add templates to process profiles:
Add
Edit
View
Delete
Workforce Manager-Common Setup Activate process templates
Workforce Manager -Common Setup Assign process profiles
People Editor > Person Tab
APIs > API Beans Access to Process Manager data (required for
Process Designer)
Messaging
Everyone View the Inbox
Everyone Messaging Access:
Create a message
Reply to a message
Open a message
3. Repeat for other profiles as necessary, and then click OK.

Set up the “Reports To” field in primary accounts

The process templates that you implement use certain predefined attributes that automatically direct tasks
or messages to managers, as defined in the database. This feature reduces the need to manually specify
individual managers in the templates.
To ensure that these attributes work correctly, the primary accounts for employees and managers must
include an appropriate individual in the Reports To field. If a participant, or resource, in a process does not
have an assignment in the Reports To field, the associated task in that process fails, and a failure
notification message is sent to the process administrator.

Use a HyperFind Query

You can use a HyperFind query to find all employees and managers who do not have assignments in the
Reports To field:

323
 1. Select Setup > Common Setup > HyperFind Queries.
2. Click Edit on the menu bar in the HyperFind page.
3. On the Select Conditions tab, under Filters, select Process Manager > Reports To.
4. Select the exclude option.
5. Click Add Condition.

Update the “Reports To” Information

You can update the Reports To information in two ways:
l Import the “Reports To” information for a group of people.
l Use the People Editor to update the “Reports To” information individually:
a. Select a name and open the People Editor.
b. Click the Job Assignment tab.
c. Click Primary Account.
d. In the Reports To field, select an appropriate name.

324
Use Process Administrator
Process Administrator enables you to manage the processes that you implement with Process Designer and
the system across the organization.
To start the Process Administrator, select Process Management > Process Administrator from the Setup
workspace.
You use Process Administrator to:

Manage processes
Use Process Administrator to manage all the processes that are active in your system.

View the status of processes

To view the status of all processes, filtered groups of processes, or a specific process:
1. From the Process Administrator, click the All Processes tab.
2. Select or clear one or more of the check boxes to filter the list of processes that is displayed:

Filter Description
Ready Shows all processes that are activated and available but have not been
started by a user. Processes and tasks cannot be both assigned to a person
and in a Ready state. These processes can be generated with the Event
Manager’s pool builder.
Activated-All Shows all processes that have been activated.
Activated-w/Aborted Shows all processes that have be activated and have one or more aborted
Tasks tasks.
Aborted Shows all processes whose root task has a state of ABORT.
Completed Shows all processes that have completed.
Templates Shows all process templates

3. To search for specific processes, use the following additional filters:

o Template ID — Use the drop-down list box to select all templates or a specific template.
o Resource ID — Enter the Person ID of an individual who is associated with one or more processes.
You cannot use wildcard characters or enter more than one ID in this field.
o Process ID — Enter the ID of a specific process. You cannot use wildcard characters or enter
more than one ID in this field.
o Process Start Date — Use the From: field to enter a date and time (use any of the standard date
and time formats that are valid in the Timekeeper suite). The system will display all processes that
started on or after that date and time. If you also enter a date and time in the To: field, the system
will display all processes that started during that range of dates.

325
 4. Click the Refresh button on the tab. The system displays the following data in the tab workspace based
on the filters that you specified:

Column Description
ID The ID of the process.
Process Name The name of the process.
App. Unique Key The unique key that is assigned to process templates of the same type. It is
used when the process is designed to reference templates that are included as
subprocesses. It is also used to ensure that templates of the same type do not
have overlapping effective dates.
State The state of a process in the system:
ACTIVE — The process has been started in the system.
READY — The process template is activated and available but has not been
started by a user, because the process has an earliest start date that has not
yet arrived, or the process has an instance in the pool.
DONE — The process has finished.
ABORT — The process has been stopped, or aborted. Note that any aborted
task in a process will cause the entire process to move to the ABORT state.
Aborted Tasks Indicates whether the process contains aborted tasks.
Template ID The ID of the template that was used to initiate the process.

5. To perform an action on a process, select the process and then click one of the following button options
(some options may not be available depending on the state of the process):
o Abort
o Delete
o Restart
o Process Detail (to change the status of tasks in a process)

Abort a process
If a process is not working properly or if it needs to be halted, you can use Process Administrator to abort
that process. When the process is ready to resume, you can use Process Administrator to restart it.
Note that the availability of certain functions depends on the state of the process.
To abort a process:
1. From the Process Administrator, click the All Processes tab.
2. Select the appropriate filtering check boxes and click Refresh.
3. Select the process that you want to stop, or abort.
4. Click Abort and then click Yes in the confirmation message box if you are sure that you want to abort
that process. The screen automatically refreshes to display the change in status for the process.

326
Delete a process or template
You may want to delete a process or template from the system for one of the following reasons:
l The process has been completed or aborted.
l The process or template is no longer needed because of some change in your organization’s business

processes.
l The process or template has been replaced by a revised version.

You can use Process Administrator to delete the unneeded process. (Note that the availability of certain
functions depends on the state of the process.)
You can also delete a template or delete all aborted or completed processes in an automated way.

Delete one or more processes

To delete one or more processes:
1. From the Process Administrator, click the All Processes tab.
2. Select the appropriate filtering check boxes and click Refresh.
3. Select the process or processes that you want to delete.
4. Click Delete and then click Yes in the confirmation message box if you are sure that you want to
delete that process. The screen automatically refreshes to display the change in status for the process
or processes.

Delete a process template

To delete a process template:
1. Select Setup > System Configuration > Process Management.
2. Click Process Profiles.
3. Under Profile Name, select the profile that you want to edit.
4. From the Process Profiles menu bar, click Edit.
5. Use the Remove button to delete the template from the profile.
6. Click Process Templates.
7. Delete the process template from the Template List.

Note: If a process template is deleted and the processes that use the template exist in the database, the
template is logically deleted. This means that the template will no longer appear in the Process
Templates editor and cannot be included in a Process Profile.

To delete a logically deleted process template:

1. In Process Administrator, delete all the processes using the template.
2. Delete the process template.

327
 Restart a process
When a previously aborted process is ready to resume, you can use Process Administrator to restart it.
Note that the availability of certain functions depends on the state of the process.
To restart a process:
1. From the Process Administrator, click the All Processes tab.
2. Select the appropriate filtering check boxes (include Aborted) and click Refresh.
3. Select the process that you want to restart.
4. Click Restart. The screen automatically refreshes to display the change in status for the process.

View process reports

Reports can provide the following kinds of information to help you manage processes on your system:
l The number of activated, unactivated, completed, and aborted processes.
l How many processes have been run within a certain period of time, which indicates how many people

are using the system.

l How many tasks are assigned to employees, so you can adjust an employee’s workload by reassigning

the tasks to other employees.

To view process reports from the Process Administrator, click the Reports tab and select the check box to
indicate which data you want to see:

Report Description
Summary A count of all processes, by status, and a count of all
resources associated with the processes.
Processes Processed The activation status, along with a count, for all
processes.
Resource Workload A list of resource IDs and names along with the
corresponding tasks and statuses: active, completed, or
assigned.

Manage tasks in a process

Use Process Administrator to manage the following tasks within processes that are active in your system.

View and change the status of tasks in a process

To view or change the status of tasks in a specific process:
1. From the Process Administrator, click the Process Detail tab.
2. Select the process name.

328
3. Select one of the following views. Note that you can make changes to tasks in a process only through
the Tabular Details view.

View Description
Tabular Detail A table of all process tasks and their properties. This is the only view in which
you can use the available functions to change the status of certain tasks.
SeeTabular Detail view on page 329 for more information.
Graphical Detail A read-only graphical representation based on the process template in use. See
Graphical Detail view on page 330 for more information.
State Analysis A read-only view of the process in plain text. Each line represents a task and
Detail contains the following information:
Name and ID of the task.
The state of the task and a brief explanation about that status.
See State Analysis Detail View on page 330 for more information.
XML Detail A read-only view of the process in XML.
.Use the XML Detail view to, for example, isolate a problem that is causing a
particular task in the process to fail.
Process Resources A read-only list of resources who are participating in the process. Use the
Process Resources view to, for example, identify a resource to whom you want
to send a message about a particular task.

Tabular Detail view

The Tabular Detail view provides the following task information:

Field Description
Task ID ID of the task as assigned by the Process Engine.
Name Name of the task.
State One of the following states:
ACTIVE — A resource is currently working on that task.
READY — The task is ready but a resource has not yet begun work on it.
DONE — The task has been completed.
ABORT — The task has been aborted.
PASSIVE — The task is passive in the sense that it will not execute, by design,
because it is the false (“No”) condition of a Branch task.
Duration Amount of time it took for the task to finish, in milliseconds.
Start date The time at which the task began.
End date The time at which the task finished.

329
 Field Description
Earliest SD The earliest start date (ESD) at which the task can begin.
Predecessors A list of IDs for tasks that must finish before this task can begin.
Parent ID The ID of the parent task in the task hierarchy within the process.
Template ID The ID of the process template that contains the task.

Graphical Detail view

In the Graphical Detail view, color-coded bars on the tasks indicate the following:
l Blue — The task is ready but a resource has not worked on it.
l Brown/Black — The task is done.
l Red — The task has been aborted.
l Green — The task is active. A resource is currently working on the task.

State Analysis Detail View

Use the State Analysis Detail view to, for example, determine why a particular task has not been
completed.
If any tasks have a status of ABORTED, the errors for that task are displayed at the top of this view.

Change the status of tasks in a process

To change the status of tasks in a specific process, you use the Tabular Detail view on the Process Detail
tab:
1. From the Process Administrator, click the Process Detail tab.
2. Select the process name.
3. Select the Tabular Detail view.
4. From this view, you can perform the following actions:

Action Description
Set Done Changes the state of any active task (except a root task) to
DONE
Force Done Changes the state of any aborted task (except a root task) to
DONE
Force Ready Changes the state of any aborted task (except a root task) to
READY
Reassign Allows you to reassign the task to a different resource ID
Properties Displays the properties of the task

330
Reassign a task to another resource
To balance resource workloads and remove bottlenecks from a process, or to resolve an issue with an
aborted task, you may need to reassign a task from one resource to another. You may also be asked by an
authorized employee or manager to reassign a task if a process template has been configured to prevent
individuals from reassigning their tasks from the Tasks tab of their Inbox during that particular business
process. (See the Process Manager Programmer’s Guide for specific information about modifying a
process template to control the reassignment of tasks.)
For example, if a resource in a process does not have an assignment in the Reports To field, the associated
task in that process will fail. If you are the administrator who was assigned in the Business Automation
system setting to receive Process Manager error notifications, you will receive a message about this failed
task. You can then use Process Administrator to reassign the task to an appropriate individual.
To reassign a task:
1. From the Process Administrator, click the Process Detail tab.
2. Select the process name.
3. Select the Tabular Details view.
4. Select the row that contains the task.
5. Click Reassign. (If the Reassign function is not active, it means that you cannot reassign a task in that
state; for example, if the task is ACTIVE.)
6. Enter the ID for the resource that you want to reassign the task to.
7. Click Submit.

Mark a task as done

If an aborted or active task is no longer necessary for the completion of a particular process and you do not
want that task to impede the progress of the process, you can mark that task as DONE so the process can
continue to the next task.
1. From the Process Administrator, click the Process Detail tab.
2. Select the process name.
3. Select the Tabular Details view.
4. Select the row that contains the task and then click one of the following:
oForce Done — Changes the state of any aborted task (except a root task) to DONE
o Set Done — Changes the state of any active task (except a root task) to DONE

Process Administrator automatically refreshes the screen to display the status of that task in the State
column as DONE.

Change the status of a task to READY

If a problem with a previously aborted task has been solved and you want to make that task available again
in the process, you can change the status of that task to READY.
1. From the Tabular Details view of Process Detail tab, select the row that contains the task that you
want to mark as READY.

331
 2. Click the Force Ready button on the menu bar. Process Administrator automatically refreshes the
screen to display the status of that task in the State column as READY.

View the properties of a task

You can view the properties of a task to help resolve problems with a process. For example, if a task has
aborted, you can use this view to see if there is an error message.
1. From the Tabular Details view of the Process Detail tab, select the row that contains the task that you
want to examine.
2. Click the Properties button on the menu bar. Process Administrator displays the properties of that task
as set in the Process Designer template.

View task statistics for a process

To identify bottlenecks in a process or other problem areas, you can view statistics for tasks in a specific
process. For example, if the statistics show that a particular task took significantly more time to finish than
was originally planned for, you can modify that task in the process template to either increase the amount
of allotted time or reduce the scope of that task.
To view statistics for tasks in a specific process:
1. From the Process Administrator, click the Process Analysis tab.
2. Select a process from the Template drop-down list on the menu bar.
3. In the table displayed on the tab, you can view the following statistics to help identify bottlenecks in the
process:

Column Description
Task Template ID The ID of the task template.
Task Name The name of the task.
Planned Duration The amount of time allotted to this task when the process template was
designed. This is specified in Process Designer, on the General Properties tab
of the task in the template.
Avg % Time Average percentage of the process execution time it took for this task to
finish.
Avg Time (ms) Average number of milliseconds it took for this task to finish.
Min Time (ms) Minimum number of milliseconds it took for this task to finish.
Max Time (ms) Maximum number of milliseconds it took for this task to finish.

Monitor resources
You can monitor and manage the workloads for all resources associated with the processes in your system
by using these previously described Process Administrator features:

332
 l The Reports tab.
l The Reassign function in the Tabular Detail view of the Process Detail tab,

For example, if you click the Reports tab and review the Resource Workload data, you might observe that
one resource has many more active (uncompleted) tasks than another. As a result, several processes are
not progressing because that resource’s tasks have not been completed. After conferring with a manager,
you might be asked to reassign certain tasks from the overloaded resource to a less burdened resource.
A useful tool for monitoring process resources, especially in a clustered environment, is the Engines tab.
The Engines tab displays the following statistics to help monitor process resources in a clustering
environment:

Column Description
Server Name or IP address of the application server that is running a Process
Engine.
Engine Status Status of the Process Engine on the application server: “running” or
“paused.”
Threads in Use Number of threads in use on the Process Engine.
Total Threads Total number of threads available. This number is determined by the
following system setting: wba.processengine.threadpoolsize
VM Mem Usage (KB) Kilobytes of memory in use by the Java virtual machine.
VM Total Mem (KB) Kilobytes of memory available for the Java virtual machine.
Is Cluster Manager Indicates whether the server has been designated as a Cluster Manager.

Click the column name to sort the table on that column.

The data in the columns is refreshed when you click the Engines tab or when you click the Refresh button
at the top of the page.

333
Use the Process Profiles editor
After you create, deploy, and activate a process template, you use the Process Profiles editor to add that
template to a process profile, which you can then assign to people in the organization by using the People
Editor.
Click the icon to search for more information about the People Editor.
To start the Process Profiles editor, click System Configuration > Process Profiles in the Setup
workspace. In the Setup workspace, you can do the following:

Create a new process profile

1. In the Setup workspace, select System Configuration > Process Profiles.
2. From the Process Profiles menu bar, click New.
3. In the Available Items pane, select the process templates that you want to include in this new process
profile.

Tip: If there is a long list of templates, use the Search feature to locate one or more specific
templates.

4. Click the Add button to move the selected templates to the Selected Items pane.
5. Click Save & Close.
6. In the Save As dialog box, enter a name for the new process profile and a description.
7. Click OK.
The name of your new process profile is displayed in the list on the Process Profiles main window.

Edit a process profile

1. In the Setup workspace, select System Configuration > Process Profiles.
2. Under Profile Name, select the profile that you want to edit.

Note: Do not edit All Process Templates or Empty Profile.

3. From the Process Profiles menu bar, click Edit.

4. Use the Add and Remove buttons to edit the contents of the profile.

Tip: If there is a long list of templates, use the Search feature to locate one or more specific
templates.

5. Click Save & Close.

334
Duplicate a process profile
1. In the Setup workspace, select System Configuration > Process Profiles.
2. Under Profile Name, select the profile that you want to duplicate.

Note: You cannot duplicate All Process Templates or Empty Profile.

3. From the Process Profiles menu bar, click Duplicate.

4. Click Save.
5. In the Save As dialog box, enter a name for the duplicate process profile and a description.
6. Click OK.
The name of the duplicated process profile is displayed in the list on the Process Profiles main window.

Rename a process profile

1. In the Setup workspace, select System Configuration > Process Profiles.
2. Under Profile Name, select the profile that you want to rename.
3. From the Process Profiles menu bar, click Rename.
4. In the Save As dialog box, enter the new name for the process profile and a description.
5. Click OK.
The new name of the process profile is displayed in the list on the Process Profiles main window.

Delete a process profile

1. In the Setup workspace, select System Configuration > Process Profiles.
2. Under Profile Name, select the profile that you want to delete.

Note: You cannot delete All Process Templates or Empty Profile.

3. From the Process Profiles menu bar, click Delete.

4. If you are sure that you want to delete the profile, click OK in the confirmation box.
The deleted process profile is removed from the list on the Process Profiles main window.

Print the list of process profiles

1. In the Setup workspace, select System Configuration > Process Profiles.
2. From the Process Profiles menu bar, click Print.
3. In the print dialog box, use the buttons to specify a printer and properties, set up the page, and preview
the output.
4. Click Print.

335
Use the Process Templates editor
After you create and deploy a process template, you use the Process Templates editor to activate the
template. You can also deactivate that template later on if, for example, that particular business process
will not be required for the next six months.
l Use the Process Templates editor to view the available process templates sorted by status or category.
l After you activate a process template, you use the Process Profiles editor to add that template to a

process profile.
With the Process Templates editor, you can do the following:

View process templates

The Process Templates editor displays the list of processes that you implement with Process Designer and
suite application across the organization.
To view the list of process templates, click System Configuration > Process Templates in the Setup
workspace. The Process Templates editor displays the following information about each process template:

Column Description
Display Name Name of the process template.
ID ID of the process template.
Start Effective Effective start date for the process template.
End Effective Effective end date for the process template.
Status Status of the process template.
In Use Yes — the process template is in use.
No — the process template is not in use.
Action List Yes — the process template will appear in the employee’s or
manager’s My Actions list.
No — the process template will not appear in the employee’s or
manager’s My Actions list.

To view the process templates sorted by status, select a status type from the Status drop-down list.
To view the process templates sorted by category, select a category from the Category drop-down list.

Activate a process template

To activate a deployed process template in the system:
1. In the Setup workspace, select System Configuration > Process Templates.
2. Select the template that you want to activate.
3. Click Edit.
4. Fill in the fields that indicate the start and end dates for the template.

336
 Note: Process templates of the same type (even with a different name) cannot have overlapping
effective dates. Use File > Save As in Process Designer to change the type.

1. In the Status column, select the Active button.

2. In the Action List column, select Show. (This ensures that this template will appear in the employee’s
My Actions list or manager’s Actions list.)
3. In the Max Pool Size text box, indicate the maximum pool size for the template. Use a pool to avoid the
time it takes to initiate a process. If you do not want to use a pool, enter a 0 (zero).

Note: The Max Pool Size value cannot exceed the maximum size specified for the server you are
logged on to. The server maximum size is specified in
wba.processengine.server.mapxpoolsize property on the System Settings > Business
Automation tab.

4. (Optional) Add a description.

5. Assign a display name to the process template.
6. (Optional) Select a template category or categories from the Template Categories drop-down list.
7. Click Save.
After you activate a process template, you must add that template to a process profile.
If the activated process template already belongs to a process profile, then users assigned that profile will
have access to the associated form through their Actions List.

Assign a category to a process template

To activate a deployed process template in the system or assign a template category:
1. In the Setup workspace, select System Configuration > Process Templates.
2. Select the template that you want to assign a category to.
3. Click Edit.
4. Select a template category from the Template Categories drop-down list.
5. Click Save.

Note: Process template category names are not localizable.

Deactivate a process template

To deactivate a process template so that it can no longer be used by employees who have that template in
their process profile:
1. In the Setup workspace, select System Configuration > Process Templates.
2. Select the template that you want to activate.

337
 3. Click Edit.
4. In the Status column, select the Inactive button.
5. (Optional) Add a description.
6. Click Save.

338
Troubleshoot Process Manager issues
The following table summarizes some common process template issues and how to resolve them:

Problem Solution
User receives the error message “This task The user should click Refresh to update his or her task list.
may no longer be available. Click Refresh to If the error still appears, an API task has failed. Use
update your task list.” Process Administrator to locate the API failure.
Messages are not being sent to external Be sure the E-Mail and Messaging tabs in the system
SMTP e-mail addresses. settings are configured to send mail to the SMTP e-mail
address.
A process template does not appear in the Be sure that you deployed the template from Process
Process Templates editor. Designer.

Tip: You can also use the WFC.log to troubleshoot. Process Manager information has the context
WBAP.ProcessEngine for Process Engine issues, and WBAP.Process for non-Engine issues.

339
Enhance Process Manager performance
Process Manager includes two ways to enhance performance: clustering and pooling.

Clustering
Clustering allows multiple Process Engine instances to simultaneously access and monitor the same set of
processes. This is achieved by configuring the Process Engines to access the same database and coordinate
with one another through the Cluster Manager. Benefits of a cluster include scalability, simplified support
for multiple client application instances, and the ability to implement load-balancing in process applications
via Process Manager.

How clustering works

With clustering, work can be distributed on up to 8 application servers each running a process engine,
depending on how many are needed for your organization. All of the Process Engines in a cluster connect
to the same database server. Support for clustering includes a Cluster Manager system service, the ability
to start and stop Process Engines as a cluster using Event Manager, and the addition of an Engines tab to
Process Administrator to monitor each engine in the cluster.
In a clustered environment, process requests from system applications such as Scheduler are submitted to
the local Process Engine on the application server the request was made from. If a Process Engine is not
available on that server, Cluster Manager will direct the request to an engine on another application server.
Cluster Manager ensures that the request is serviced by one (and only one) Process Engine to advance the
process to the next task that requires input.
Each application server is eligible (by default) to host the Cluster Manager, based on the
wba.clustermanager.eligible Business Automation system setting. See Set up Cluster
Manager on page 340 for more information.

Set up Cluster Manager

Cluster Manager is a service that runs on one machine in the cluster. If that machine should require
scheduled maintenance or experience a system failure, Cluster Manager can run on any of the other
application servers as well; the other Process Engines will automatically register with the new Cluster
Manager without requiring you to restart a server.

Note: You must have a Cluster Manager, even in a single-server environment.

To set up Cluster Manager, you must configure the system settings on the machine that you designated as
the Cluster Manager during installation.
The Business Automation tab in System Settings contains properties that allow an administrator to
configure the Process Engine as well as the Cluster Manager. Those settings include the following:
l wba.clustermanager.eligible — The default setting is true, which provides failover
protection in that any server is automatically eligible to assume the role of Cluster Manager if there is a

340
 system failure. If you want to exclude particular servers from functioning as the Cluster Manager,
specify false for this setting on those servers.

Note: To optimize performance, specify false for this setting on application servers that will never be
used as a Cluster Manager.

l wba.rmiregistry.port — The port on which to start the Cluster Manager.

Manage the clustered Process Engines

Use the Engines tab of the Process Administrator application to monitor Process Engines, view individual
process instances, and manage the deployment and pooling of process templates.
Use an Event Manager application to schedule engine pause times and stop and restart events. An engine
pause should be scheduled during peak server loads, such as payroll processing time. The scheduled engine
stop or restart event coordinates a Process Engine shutdown for all of the Process Engines in the cluster.
Only suite applications that rely on Process Manager are affected during this period; other applications will
continue to operate normally.

Process pooling
Process pooling is the ability to configure a preallocated pool of process instances that are made available
for instant retrieval when a user initiates a request. Pooling allows the system administrator to anticipate
heavy process load periods by preallocating database space for process instances using an event scheduled
in an event manager. Pooling reduces the database CPU load.
The pool size attribute specifies the number of process instances that will be allocated in advance for this
process template when the next pool building event takes place. The pool building event should be
scheduled regularly (such as daily) during an off peak time.
During the pool building event, all actively deployed process templates with pool size greater than zero
will be instantiated in the database for future use. If the pool for a given process already exists and is
larger than the current pool specified for that process template, the pool is adjusted down.
During regular operation of the suite applications, if a request for a new process instance is made, a
preallocated process instance from the pool will be used. This reduces the response time and database
load, because the work to create a process instance has already been done. The pool is then reduced by
one. If the pool is depleted before the next pool building event, then the standard process allocation is used.

Set up process pooling

To set up process pooling:
1. Select Setup > System Configuration > Process Templates.
2. Select the template that you want to create a pool for.
3. Click Edit.
4. In the Max Pool Size text box, indicate the maximum pool size for the template. If you do not want to
use a pool, enter 0 (zero).

341
 5. Select Setup > System Configuration > System Settings > Business Automation and then set the
default maximum pool size per server in the wba.processengine.server.maxpoolsize
setting.

Note: You cannot save a process template on the Process Templates page whose Max Pool Size
value is greater than this Max Pool Size value on the application server. If the Max Pool Size value
on the Process Templates page and this Max Pool Size system setting are not the same, the Pool
Manager will create template pools whose size is the lesser of the values.

6. Use an event manager application to schedule pool building. Run the pool builder at non-peak hours to
avoid poor performance.

342
Chapter 16

Predefined Data

The suite includes the following 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, such as the
default logon profile. You cannot modify other predefined data, such as labor levels.
Genies
To access Genies:
1. Select Setup > Display Preferences > Genies. This displays the list of Genies on your system.

Note: The Genies that appear in the list depend on the suite add-on products installed at your site. For
example, if Attendance is not installed, the Activity Genies do not appear; if Attendance is not
installed, Attendance Genies do not appear, and so on

2. Click one of the following Genies. A <name> Genie window opens and lists the predefined entries.

Genie Predefined Entry

Accrual Detail Accrual Reporting Period
Averaging Genies Averaging Reporting Period
Detail Activity Employee Detail
Activity Employee Status
Activity Event Details
All WTK Exceptions
Approvals Summary
Approve Timecards
Attendance Genie
Biometric Status
Count All WTK Exceptions
Current Event Details
IS Summary
Orphaned Event Details
Pay Period Close
Reconcile Timecard
Search Genie
Shift Close
Shift Start
SignOff Issues
Schedule Group Detail Schedule Group Assignment
Roll-up Activity Event Rollup
Schedule Group Roll-up Schedule Group Roll-up
QuickFind QuickFind
Schedule Editor Schedule Editor
Schedule Assistant Schedule Assistant

344
Genie Predefined Entry
Schedule Planner Schedule Planner
Leave Case Detail Leave Cases
Leave Hours

To access one of the following predefined Genies, click the name on the list page. You can edit predefined
Genies, which are described in the following table.

Default Settings
Predefined Navbar
Values HyperFind Time Period Column Set Category Other
Accrual All Home Today Accrual Reporting Timekeeping
Reporting Period Period
Accrual Detail All Home Today Data Integration - Timekeeping
(must duplicate Accrual Review
to edit)
Averaging All Home Today Averaging Timekeeping
Reporting Period Reporting Period
Activity All Home Today Activity Employee My Activity
Employee Details Genies
Details
Activity All Home Today Activity Employee My Activity
Employee Status Status Genies
Activity Event All Home Today Activity Event My Activity
Details Details Genies
All WTK All Home Previous Pay All WTK Timekeeping
Exceptions Period Exceptions
Approvals All Home Previous Pay Approvals Timekeeping
Summary Period Summary
Approve All Home Previous Pay Approve Timekeeping
Timecards Period Timecards
Attendance All Home Previous Pay Attendance Genie Timekeeping
Genie Period
Biometric All Home Current Pay Biometric Status Timekeeping
Status Period
Count All WTK All Home Previous Pay Count All WTK Timekeeping
Exceptions Period Exceptions
Current Event All Home Today Current Event My Activity
Details Details Genies

345
 Default Settings
Predefined Navbar
Values HyperFind Time Period Column Set Category Other
IS Summary All Home Current Pay IS Summary Timekeeping
Period
Orphaned Event All Home Today Orphaned Event My Activity
Details Details Genies
Pay Period Close All Home Previous Pay Pay Period Close Timekeeping
Period
Reconcile All Home Yesterday Reconcile Timekeeping
Timecard Timecard
Search Genie All Home Current Pay Search Genie Timekeeping
Period
Shift Close All Home Today Shift Close Timekeeping
Shift Start All Home Today Shift Start Timekeeping
SignOff Issues All Home Previous Pay SignOff Issues Timekeeping
Period
Schedule Group All Home Current Schedule Group Scheduling
Assignment Schedule Detail
Period
Activity Event All Home Today Activity Event My Activity
Rollup Rollup Genies
Schedule Group All Home Current Schedule Group Scheduling
Roll-up Schedule Roll-up
Period
QuickFind None Week to Date QuickFind My Genies
Schedule All Home Current Schedule Editor Scheduling Default Interval:
Editor Schedule Daily Intervals.
Period
Schedule None None Schedule Assistant Not assigned Criteria Set: Eval
Assistant Rule Set Group
Default.
Schedule Planner All Home Current Schedule Planner Scheduling Main tab:
Schedule Employee.
Period

346
 Default Settings
Predefined Navbar
Values HyperFind Time Period Column Set Category Other
Leave Cases All Home Current Pay Leave Cases My Genies
Period
Leave Hours All Home Current Pay Leave Hours My Genies
Period

347
HyperFind queries
To access the HyperFind query, select Setup > Common Setup > HyperFind Queries on the navigation
bar. The HyperFind Queries window opens and displays a list of predefined HyperFind Queries, described
in the following table.

Predefined Values Definition

All Home This HyperFind query defaults to include a manager’s employee group
and/or Organizational group.
All Home and Scheduled Job This HyperFind query defaults to include all employees in the user’s
Transfers Employee Group and/or Organizational group, as well as those with jobs
that are scheduled in the user’s organizational group.
All Home and Transferred-in This HyperFind query defaults to include all employees in the user’s
Employee Group and/or Organizational group, as well as those who are
transferred-in to the user’s group.

To add a new HyperFind query, click New on the menu bar. To edit an existing query, select an entry from
the list, then click Edit.

348
Genies profile
To access the Genies profile, select Setup > Display Preferences > Display Profile Building Blocks >
Genies Profiles. The Genies Profiles window opens and displays the list of profiles on your system.
To access the predefined Super Access profile, click its name.
Service representatives use the Super Access profile, which provides access to all Genies in a specific
order. You can edit the predefined Super Access profile.

349
People
The SuperUser person is not accessible. However, to access people other than the SuperUser:
1. Use QuickFind to select an existing employee or manager.
2. With the person selected in the QuickFind workspace, click the People launch button to access the
People Editor.
3. Service representatives use the Super Access profile, which provides access to all settings. You cannot
edit the Super Access profile.

350
Logon profiles
To access Logon profiles, select Setup > Access Profiles > Logon Profile. The Logon Profiles window
displays predefined logon profiles.
To view a predefined logon profile, click the logon profile name. You can edit predefined logon profiles.

Predefined Values Definition

Default This profile has the following settings:
Password
The password is set to expire in 30 days.
The minimum length is at least six characters.
Reuse monitoring is set to remember the previous ten passwords.
Session Restrictions
A password change is not required at the next logon.
Account lockout is enabled and occurs after three failed logon attempts.
The lockout duration is set to one minute.
Super Access Service representatives use the Super Access profile, which provides access
to all settings.
Password
The password is set to never expire.
There is no minimum password length.
The system does not keep the password history.
Session Restrictions
A password change is not required at the next logon.
Account lockout is not used.

351
352
Chapter 17

Best Practices for Tracking

and Logging

Tracking and logging enhancements have been made to the following system components to ensure that
users are aware of best practices.
By default, the best practices enhancements are disabled, and must be enabled before they can be used.
To enable the features, add or edit the file Installation_
directory\instance\applications\wpk\properties\custom_wpk.properties to
include the following lines:
# Best Practices for System Settings
{spmanager}.bpsyssettings.enabled=false
# Best Practices for Database Settings
{spmanager}.bpdbsettings.enabled=false
# Best Practices for Hyperfind
{spmanager}.bphyperfind.enabled=false
# Best Practices for Function Access Profiles
{spmanager}.bpfap.enabled=false
# Best Practices for Display Profiles
{spmanager}.bpdisplayprof.enabled=false
Each enhancement can be enabled by setting its corresponding property to "true," as described in the
following sections.
l Logs on page 355
l System settings on page 356
l HyperFind queries on page 357
l Function access profiles on page 358
 l Display profiles on page 359
l Database settings on page 360

354
Logs
The following logs track the settings that have been enhanced for problem prevention:
l Best Practices.log — A new log that displays both current settings and best practice settings, which
can help with troubleshooting. This log rolls over just as WFC.log does. It rolls over when it reaches
the file size entered in the site.log.file.rollover.maxsize setting, and it creates the
number of logs entered in the site.log.file.rollover.maxlogs setting.
l StartupInfo.log— This log has been enhanced to record best practices information on startup.

355
System settings
The following system settings have best practice values. The descriptive text in the user interface for these
system settings has been updated to indicate recommended best practice values.
If these settings are outside of best practice values at the time of system startup, their current value is
logged in StartupInfo.log. After startup, any time these settings are changed, their value is sent to
BestPractices.log.
The nine settings whose values are now tracked appear on the following tabs in System Settings (Setup >
System Configuration > System Settings).

Background Processor
site.wtbgp.totalizer.maximumThreads

Database
site.database.max

Global Values
global.longList.scheduleSummaryEmployeeThreshold
global.WtkScheduler.MaximumNoOfRuleViolationsSentToClient
global.WtkTotalizer.MaxDaysInFutureEventAffectsTotalization
global.WtkScheduler.ShiftBuilderGovernor.Days
global.WtkScheduler.MaximumDaysInFutureToCreateShifts

SQL Coverage
test.SQLCoverage.enabled

Timekeeping
site.timekeeping.signoffCurrentPayPeriodAllowed
To enable this feature, edit the file Installation_
director\instance\applications\wpk\properties\custom_wpk.properties so
that the lines:
# Best Practices for System Settings
{spmanager}.bpsyssettings.enabled=false
are changed to read:
# Best Practices for System Settings
{spmanager}.bpsyssettings.enabled=true

356
HyperFind queries
HyperFind queries are assigned a risk value. This risk value is a measure of the performance of a
HyperFind query. HyperFind queries with high risk values are likely to take longer to run than HyperFind
queries with lower risk values.
At the time of system startup, all existing HyperFind queries are assigned a risk value, and that information
is sent to StartupInfo.log. HyperFind queries are listed in order by risk value with highest values
being listed first.
After startup, whenever a HyperFind query is edited or created, its risk value is calculated and sent to
BestPractices.log.
To enable this feature, edit the file Installation_
directory\instance\applications\wpk\properties\custom_wpk.properties so
that the lines:
# Best Practices for Hyperfind
{spmanager}.bphyperfind.enabled=false
are changed to read:
# Best Practices for Hyperfind

357
Function access profiles
There are two function access control points (FACPs) that can cause performance problems when set to
Allowed. Whenever one of these FACPs is set to either Allowed or Disallowed in a new or existing
Function Access profile, the new setting is sent to BestPractices.log.
To view the FACPs:
1. Select Setup > Access Profiles > Function Access Profiles.
2. In the Function Access Profiles workspace, click New or select an existing profile, and then click
Edit.
3. Expand Workforce Employee, and then Timecard Editor for Employees (My Timecard) to see the
FACP, Calculate Totals on-the-fly in My Timecard.
4. Expand Workforce Manager- Department Manager, and then Timecard Editor for Managers to see the
FACP, Calculate Totals on-the-fly in Timecard Editor.
To enable this feature, edit the file Installation_
directory\instance\applications\wpk\properties\custom_wpk. so that the lines:
# Best Practices for Function Access Profiles
{spmanager}.bpfap.enabled=false
are changed to read:
# Best Practices for Function Access Profiles
{spmanager}.bpfap.enabled=true

358
Display profiles
In the New, Edit, and Duplicate Display Profile workspaces, there is a check box on the Accruals tab
called Show Accrual Balances in Main Timecard. Best practices recommend that this check box be
cleared. When a new or edited Display Profile is saved with this check box selected, the information
appears in BestPractices.log.
To enable this feature, edit the file Installation_directory\
instance\applications\wpk\properties\custom_wpk.properties so that the lines:
# Best Practices for Display Profiles
{spmanager}.bpdisplayprof.enabled=false
are changed to read:
# Best Practices for Display Profiles
{spmanager}.bpdisplayprof.enabled=true

359
Database settings
Certain database settings will be sent to StartupInfo.log each time the system is restarted.
For an Oracle database, the settings are:
l CURSOR_SHARING
l DB_BLOCK_SIZE

l DB_CACHE_SIZE

l DB_FILE_MULTIBLOCK_READ_COUNT

l SHARED_SERVERS

l LOG_BUFFER

l OPEN_CURSORS

l OPTIMIZER_MODE

l PGA_AGGREGATE_TARGET

l QUERY_REWRITE_ENABLED

l QUERY_REWRITE_INTEGRITY

l SHARED_POOL_SIZ

l SORT_AREA_RETAINED_SIZE

For SQL Server databases, the settings are:

l autoshrink
l auto create statistics

l auto update statistics

l Fill Factor

l Max degree of parallelism

To enable this feature, edit the fileInstallation_

directory\instance\applications\wpk\properties\custom_wpk.properties so
that the lines:
# Best Practices for Database Settings
{spmanager}.bpdbsettings.enabled=false
are changed to read:
# Best Practices for Database Settings
{spmanager}.bpdbsettings.enabled=true

360
Chapter 18

Delegate authority

When a manager expects to be unavailable (for example, on vacation), the manager can delegate his or her
authority to another manager (delegate) to complete the manager’s tasks during the manager’s absence.
The delegate can also access the manager’s Inbox (Tasks and Messages), use the manager’s Actions list,
and receive some or all of the manager's alerts.

Note:The Delegate Authority feature does not support Activities (v6.0 - v8.0).
Configure Delegate Authority
To configure the Delegate Authority feature, complete the following steps:

Step 1: Check access rights

The Function Access Profile (Setup > Access Profiles > Function Access Profile) used by the two
managers must have the following function access control points set to “allowed”:
Everyone >
Open an online form
Start a business process
View the Inbox > Messaging Access
Workforce Manager - Department Manager >
Manager Access to Actions List
Workforce Managerr - Common Setup >
Delegate Roles and Roles Profiles

Step 2: Deploy and activate Delegate Authority template

To enable a manager to authorize a delegate, the system administrator must complete the following setup
tasks.

Note: Process Designer is required for this step. Process Designer is a client application used to modify
preconfigured process templates that are included with Process Manager, which is part of Timekeeper. If
you do not have Process Designer, install it from the Workforce Central Suite installation kit. For more
information, see theWorkforce Central Installation Guide.

To deploy the Delegate Authority template:

1. Log on to Process Designer and connect to your Workforce Central server.
2. Select File > Open and navigate to Kronos > processdesigner > kpe >xml.
3. Select Mgr_Delegation.template.xml and click Open.

362
4. Select File > Deploy To Server and confirm that you want to deploy.
5. Click OK when the Deployment Succeeded message appears.
6. Select File > Exit to close Process Designer.
To activate the template:
1. Log on your Workforce Central server as Superuser or an administrator and navigate to Setup >
Process Management > Process Templates.
2. Select Mgr_Delegation, click Edit, and enter the following information:
o Display Name — Enter something descriptive.
o Template Categories — Select Notification Templates.

o Start Effective/End Effective — Enter the appropriate dates.

o Status — Select Active.

o Action List — Select Show.

o Max Pool Size — N/A

3. Click Save.

363
Step 3: Create a Process Profile
After you create, deploy, and activate a process template, you use the Process Profiles editor in the suite to
add that template to a Process Profile, which you can then assign to people in the organization by using the
People Editor.
1. From Workforce Central select Setup > Process Management > Process Profiles.
2. Click New to create a new Process Profile.
3. Select the process template that you activated in step 2 and click Add to move it from the Available
Items box to the Selected Items box.
4. Click Save.
5. In the Save As box, enter a profile name and description, then click OK.

Step 4: Create a Delegate Profile

A Delegate Profile identifies the managers who can be used to delegate authority. To create a Delegate
Profile:
1. From Workforce Central select Setup > Common Setup > Delegate Profiles.
2. In the Delegate Profiles workspace, click New or, select a profile, and then click Edit. To create a
new profile from an exsting one, select the profile, and then click Duplicate.
3. Enter or modify the profile name and description.
4. Use the arrows to move the manager(s) who can be delegates from the Available Delegates box to the
Selected Delegates box or vice versa. Click Search to find delegates.
5. Click Save or Save & Return.

Step 5: Assign Process Profile and Delegate Profile to manager

Now you need to assign the Process Profile and Delegate Profile to the manager who will be absent.

364
1. From Workforce Central QuickFind, right-click the applicable manager's name and select People.
2. From the Person tab in the People Editor, select Process Profiles.
3. In the Employee Profile box, select the Process Profile that you created in step 3
4. In the Manager Profile box, select a Process Profile that can access the Mgr_Delegation template.
5. Click Save.

6. Click the Job Assignment tab and select Access Profiles.

7. In the Delegate Profile box, select the Delegate Profile that you created in step 4.
8. Click Save.

365
Step 6: Create a Role Profile
A Role Profile is associated with one Function Access Profile and one Display Profile to define the
functions that a person can perform. When delegating authority, you must set up a Role Profile that
identifies the manager's Function Access Profile and Display Profile.
To create a Role Profile:
1. From Workforce Central select Setup > Common Setup > Role Profiles.
2. In the Role Profile List workspace, click New or select a role profile, and then click Edit.
3. Enter a name and, optionally, a description for the Role Profile that you are creating or modifying.
4. Select one Function Access Profile and one Display Profile.
5. Click Save or Save & Return.

366
Use Delegate Authority
When the Delegate Authority feature is configured, a manager can delegate his or her authority to another
manager (delegate) to complete the manager’s tasks during the manager’s absence. Here is how it works.

Step 1: Manager creates a Delegate Authority action

The Actions workspace enables the manager to send a "delegating authority" request to another manager.
For example, Beryl Jones is going on vacation and needs to delegate authority to another manager, Mildred
Babson.
1. Beryl Jones logs on to Workforce Central and selects Actions.
2. From the Categories drop-down list, she selects the type of request or action.
3. She select the appropriate process template from the Actions area. In the example, the template is
called Mgr_Delegation_new:

4. In the Create Delegation dialog box, Beryl selects the name of the delegate (Mildred Babson in the
example), the start/end date of the time period, and the Role Profile name, then clicks Save & Close.

367
Step 2: Delegate accepts the delegation request
The delegate (Mildred Babson) receives an email that Beryl Jones wants to delegate her authority for a
few days:

To respond to the request, Mildred Babson logs on to the system, and does the following:
1. She opens her Inbox, clicks the Messages tab, and sees that she has received a delegation request
from Beryl Jones.

2. She selects the request and clicks Open. The full request is displayed.

368
 She can close the message, reply to the message, delete the message, or print the message.
3. To accept or decline the request, she clicks the Tasks tab, selects the request, and clicks Edit. The
Accept Delegation box opens.

4. She selects Accept Delegation and then clicks Save & Close.
The delegating manager (Beryl) receives a message that Mildred accepted her request.

369
 When Beryl logs in, she accesses her Inbox and sees the message that the delegate has accepted the
request.

Step 3: Delegate switches roles

When the delegate (Mildred Babson in the example) logs on to Workforce Central during the absent
manager's (Beryl Jones) time off, she can switch roles and cover for Beryl.
The delegate logs in to the navigator UI and clicks the down arrow to the left of her name.

370
To switch from "Myself," the delegate selects the DelegateAuthority, which opens the navigator for the
absent manager (Beryl Jones).

To return to her own workspace, the delegate clicks the down arrow to the left of her name and clicks
Myself.

371
372
Chapter 19

Access Microsoft Network

Shares

During Timekeeper installation on Windows operating systems, the JBoss service is installed by default
using the Windows Local_System account.
Access to network shares implemented through a shared Windows folder on a remote machine might
encounter problems because the Windows network share default permissions do not include access rights
for built-in machine accounts (such as Local_System). As a result, the application server cannot share
access files on the remote machine.
You can implement one or more of the following options to avoid network share problems:
l Move all files on to the application server machine.
l Change the permissions on the network share machine to enable access to the share from the

application server.
l Create a new user account in the Windows network, change the JBoss service account, and change the

network share to allow access to that account

l Change to the JBoss service account to one that already has access rights to network shares

The following sections describe these options. Note that, in terms of network security, these options are
ordered from most to least secure.
To implement access to a shared Windows folder on a remote machine from the Workforce Central JBoss
application server, you can:
l Move files to the application server on page 374
l Change the permissions on the network share on page 375
l Create a new user account on the Windows network on page 377
Move files to the application server
If you move all files that are currently on network shares to the application server machine, errors that
occur in processing files to and from the application server are eliminated. This option also eliminates the
risk of compromising the application server.

374
Change the permissions on the network share
You can change the permissions on the network share machine to add access to the share from the
application server. When you do this, note that you are allowing any process that is running as Local
System or Network Service on the application server machine to access the shared machine with the rights
you specify. Allow only as much access as is needed to accomplish the task. Inter-machine access to
network shares depends on trust relationships as configured in an active directory. Network share access is
generally simpler within a single domain.
To change the permissions:
1. In Windows Explorer, right-click the folder of the server machine to be shared and then select
Properties. The <folder name> Properties dialog box appears.
2. Click the Security tab.
3. Click Add. The Select Users, Computers, or Groups dialog box appears.
4. Click Object Types. The Object Types dialog box appears.
5. Select the Computers check box.
6. Click OK. The Select Users, Computers, or Groups dialog box appears.
7. Type the beginning of the name of the object in the Enter the object names to select text box and then
click Check Names.
8. Select the complete name, and then click OK.
9. Click OK to close the Add dialog box.
10. Select the newly added name, and then select the desired access permissions (for example, Full
Control, Modify, etc.).
11. Click Apply to return to the Properties dialog box.
12. Click the Sharing tab
13. If necessary, click Share this folder.
14. Click Permissions.
15. Click Add.
16. Click Object Types.
17. Select the Computers check box.
18. Click OK.
19. Type the beginning of the name of the object in the Enter the object names to select text box and then
click Check Names.
20. Select the complete name, and then click OK.
21. Click OK to close the Add dialog box.
22. Select the chosen name, and then select the desired access permissions (Full Control, Change, or
Read).

375
 23. Click OK to close the Permissions dialog box.
24. Click OK to close the Properties dialog box.

376
Create a new user account on the Windows network
To create a new user account on the Windows network to allow the remote connection with the JBoss
service:
1. Create a new account in the Windows network with appropriate permissions.
2. Change the JBoss service account to permit connection with the new user account. For instructions on
changing the JBoss service account, see Changes to the JBoss service account on page 377.
3. Change the network share to allow the JBoss service account.

Changes to the JBoss service account

During Kronos installation, a JBoss service account is installed by default using the LocalSystem account.
You can run JBoss under a user account to provide access by JBoss and all applications within it to any
network resources configured for access by that user account.

Note: Running JBoss under a user account changes the set of rights and restrictions for the JBoss server
and all applications running within it. Insufficient rights to access local files or directories could result in
application errors. Use caution with this configuration, and carefully restrict network privileges for the
user account.

Running JBoss under an account with administrator rights changes the set of rights and restrictions for
the JBoss server and all applications running within it. Administrator accounts are powerful and might
modify any file or setting on the system. If the administrator account has network privileges, any network
resources configured for access by that account is accessible by JBoss and all applications running
within it. This configuration is not recommended.

To run the JBoss application server using a non-administrative (user) account, use Microsoft Management
Console (MMC) to create a local user that enables the JBoss service to log on:
1. Select the User cannot change password option.
2. Select the Member Of tab to ensure that the Users group is listed.
3. From Control Panel, select Administrative Tools > Services.
4. Double-click the JBoss Application Server service. The JBoss Application Server Properties dialog box
appears.
5. In the Service status section, click Stop to stop the service.
6. Click the Log On tab.
7. Select This Account and browse for the user account you created in step 1.
8. When you find the user account, click OK. Enter the password for the account you created, and then
click OK.
9. In the MMC, open Local Security Settings and select Local Policies > User Rights Assignment.

377
 10. Assign the following rights to the user account under which JBoss is running:
o Deny log on through Terminal Services.
o Deny log on locally.

378
Chapter 20

Manage the notification

server

The Workforce Central notification server is based on a third-party software product, IgniteRealtime
OpenFire version 3.7.2. OpenFire is an open-source real-time collaboration server, widely used in
messaging and chat applications. Released with an Apache license, OpenFire uses the Extensible
Messaging and Presence Protocol (XMPP).
Extensive documentation about the OpenFire server is available from the following URL:
http://www.igniterealtime.org/projects/openfire/documentation.jsp
For more information, access the Jive Software community website:
http://www.igniterealtime.org/index.jsp
Notification server files
The Workforce Central installation program creates the notification server as a service called Openfire_
ns. To access the service, access the Notification Server icon or go to Administrative Tools > Services.
Although you should generally use the Administration Console to manage the notification server as
described in Administration console on page 384 the notification server files are delivered the
\\Kronos\openfire folder.
l Properties files — To verify the attributes of each notification server, check the properties files,
which are located in \\Kronos\openfire\configuration:
common.properties — Identifies the notification server host name
ns.properties — Lists the notification server properties including domain, ports, and user name
and encrypted password.
If multiple notification servers are installed on the machine, the properties of each are listed, for
example ns1.properties, ns2.properties, and so forth.
l Log files — Error, debug, warning, information, and running log files are located in
\\Kronos\openfire\ns\logs.

380
Change the notification server password
When you install the Workforce Central notification server, you assign an administrative user and
password—XMLUSER. Although other system accounts can be used, XMLUSER account is typically
used by the notification server to call the XML API on the application server for user authentication. If you
need to change the password of this account, you must encrypt the new password and then change
references to it in several places.

Note: If your notification servers do not use the XMLUSER system account, see your Kronos
Representative for more information.

l Step 1: Change XMLUSER password on page 381

l Step 2: Encrypt new password on page 381
l Step 3: Edit openfire.xml on page 382

Step 1: Change XMLUSER password

To change the XMLUSER password:
1. Log on to Workforce Central as an administrator.
2. Select Setup > System Configuration > System Settings.
3. In the Systems Setting workspace, select the Global Values tab.
4. Enter the new password for xmluser in the following property:
global.xmlservice.login.password
5. Log off Workforce Central.
6. Log on to Workforce Central as XMLUSER using the original password (not the password you just
entered in System Settings).
7. Click the Change Password link.
8. Enter the old password, the new password, and the verification password for XMLUSER.
9. Log off Workforce Central.
10. Stop and restart the application server.

Step 2: Encrypt new password

If you change the XMLUSER password and your notification server uses the XMLUSER account, you
must also change the password for all instances of the notification server. The password must be encrypted
To encrypt the password, you must first identify the encryption key:
1. Open a command window as an administrator on the application server and navigate to
\\Kronos\openfire\ns\conf and open openfire.xml with a text editor.

381
 2. Search for the <random> tag and copy the text between the <random> and </random> tags, for
example:
<random>6sefm114ntr8dmkelbuwodho2cql</random>
This is the encryption key.
3. Close the file.
Next you must run the krencryptNS tool:

Note: Workforce Central also includes a krencrypt tool, which is used when database passwords need to
be encrypted for places other than the notification server. Do not use krencrypt to encrypt passwords that
are used by the notification server.

1. With the command window still open, navigate to:

\\Kronos\configuration\boms\bin
2. Enter the following:
krencryptNS password encryptionkey
where:
password is the notification server password used by XMLUSER.
encryptionkey is the encryption key you copied from openfire.xml.
3. Save the encrypted text that the system returns.
If you need to change the encryption key, it must be regenerated and system passwords must be re-
encrypted using the new key. See your Kronos Representative for a copy of the System Password
Management document.

Step 3: Edit openfire.xml

After you have the encrypted password, edit the openfire.xml file for each notification server in your
environment:
1. Navigate to \\Kronos\openfire\nsx\conf\
where nsx is the name of a notification server, for example ns1, ns2, and so forth.
2. With a text editor, open openfire.xml and replace the password tag with the encrypted password
from previous step.
<xml>
<api>
<username>XMLUSER</username>
<password>EncryptedPassword</password>
</api>
</xml>

382
 where EncryptedPassword is the password that you encrypted in step 1.
3. Save the file and restart the notification server.
4. Repeat steps 1–3 of all notification servers in your environment.

383
Administration console
Included with OpenFire is an administration console that provides a web-based interface for administrative
tasks. To access it, enter the following URL:
http://notification_server:9090/login.jsp
After you log on as SuperUser, you can monitor the notification server, including overall system
configuration, user management, session monitoring, and plug-in management.

Log
To access the notification logs, log on to administration console, select the Server Manager tab, and click
Logs. Four types of logs are available:
l Error
l Warn

l Info

l Debug

To log debug information, you must enable the debug log and restart the notification server.

System properties
To access the system properties, log on to administration console, select the Server Manager tab, and
click System Properties.This section of the administration console lists the settings that notification server
depends on for its runtime performance. These settings are preconfigured for optimal performance of the
most likely deployment scenarios. Any changes to these properties may impact overall system performance
and/or user experience. Because of this, consult your system or network administrator or your Kronos
Representative before making any changes.
In addition to editing existing properties, you can add properties. New properties must be documented as
custom properties that can be read by refactored OpenFire server code.
If you change a property or create a new one, you must restart the notification server.
The properties are stored in a database table named ‘of Property’.

Sessions
To review the list of all client sessions currently connected to the server, log on to administration console
and select the Sessions tab.
In addition to monitoring client activity, this screen lets you end currently active client session(s). The
Tools tab enables you to broadcast a message to all users.

384
Plugins
To add custom functionality, access the plugins used by the server, log on to administration console, and
select the Plugins tab. The following plugins are used by the Workforce Central notification server:
l Hazelcast Clustering Plugin — This clustering plugin enables a multi-node setup of OpenFire servers
that can be used to share load in high-traffic installations. This plugin is developed by Ignite Realtime
community and is released with an Apache license.
l Message Forwarder Plugin — This custom plugin is for forwarding notification messages received
from the Workforce Central messaging system to users currently online.

385
386
Chapter 21

Special considerations

This section identifies special considerations that may be applicable to specific customers.

Database table purge

When you run reports, My Activity Genies, and QuickFind, the MYWTKEMPLOYEE and
MYWTKEMPSTAT database tables are populated with temporary data. Another table—
MYWFCIDLIST— is also populated with temporary data when any query is executed using the
SLQStatementWintInClause utility, which is used by the Work and Absence Summary and Payroll Editor.
This temporary data is purged automatically by a batch process that runs each day. For most customers,
this is acceptable.
In hosting environments, however, this can cause a problem when large numbers of reports are generated,
especially during payroll end.
You can configure the system to purge these tables immediately after user activity is successfully
completed. This deletion is done as a background process so that the user is not impacted. After a report is
generated, the system triggers a background thread that deletes the temporary data.
By default, these tables are purged every 8 hours. To enable the system to purge this temporary data
immediately:
1. Navigate to \\Kronos\wfc\applications\wpk\properties and open custom_wpk.properties with a text
editor. (If this property does not exist, create it.)
2. Add the following lines:
MYWTKEMPLOYEE.cleanup=true
SQLStatementWithInClause.MYWFCIDLIST.cleanup=true
3. Save the file and restart the application server.
388